FollowPuckViewportStateOptions

 
@_spi(Experimental)
public struct FollowPuckViewportStateOptions : Hashable

Configuration options for FollowPuckViewportState.

Each of the CameraOptions-related properties is optional, so that the state can be configured to only modify certain aspects of the camera if desired. This can be used, to achieve effects like allowing zoom gestures to work simultaneously with FollowPuckViewportState.

See also

transitionsToIdleUponUserInteraction

  • The value to use for padding when setting the camera. If nil, padding will not be modified.

    Declaration

    Swift

    public var padding: UIEdgeInsets?

  • The value to use for zoom when setting the camera. If nil, zoom will not be modified.

    Declaration

    Swift

    public var zoom: CGFloat?

  • Indicates how to obtain the value to use for bearing when setting the camera. If nil, bearing will not be modified.

    Declaration

    Swift

    public var bearing: FollowPuckViewportStateBearing?

  • The value to use for pitch when setting the camera. If nil, pitch will not be modified.

    Declaration

    Swift

    public var pitch: CGFloat?

  • The duration of an animation that happens once when FollowPuckViewportState/startUpdatingCamera() is invoked.

    Note

    This option and the animation that it influences may be removed in a future update after a solution to the “moving target problem” is implemented in DefaultViewportTransition. At the moment, DefaultViewportTransition calculates its animations based on the puck location at the beginning of the transition, so the farther the puck moves while the transition is in progress, the larger the jump when it completes and control is transferred to the target state. Tune this value for your use case to reduce the visibility of that jump.

    Declaration

    Swift

    public var animationDuration: TimeInterval

  • Memberwise initializer for FollowPuckViewportStateOptions.

    All parameters have default values.

    Declaration

    Swift

    public init(padding: UIEdgeInsets? = .zero,
            zoom: CGFloat? = 16.35,
            bearing: FollowPuckViewportStateBearing? = .heading,
            pitch: CGFloat? = 45,
            animationDuration: TimeInterval = 1)

    Parameters

    padding

    Defaults to UIEdgeInsets.zero.
    zoom

    Defaults to 16.35.
    bearing

    Defaults to heading.
    pitch

    Defaults to 45.
    animationDuration

    Defaults to 1.

  • Combines all fields into hasher

    Declaration

    Swift

    public func hash(into hasher: inout Hasher)