DollySlideAnimationConfig

@objcMembers
@objc(GSDollySlideAnimationConfig)
public class DollySlideAnimationConfig : NSObject, AnimationConfig

Candle animation configuration class.

Allows to configure the following parameters for this animation:

  • speed: animation execution speed, in meters per second. If with(speed:) is not customized, then the drone will apply its own default value for this parameter.
  • angle: angle between the drone/target axis and the target/destination axis, in degrees. The drone will slide horizontally according to that angle. If with(angle:) is not customized, then the drone will apply its own default value for this parameter.
  • horizontal distance: distance the drone will slide horizontally, in meters. If with(horizontalDistance:) is not customized, then the drone will apply its own default value for this parameter.
  • mode: animation execution mode. If with(mode:) is not customized, then the drone will apply its own default value for this parameter: .once.

  • Declaration

    Swift

    public let type: AnimationType

  • Custom speed, in meters per second. Value is nil if with(speed:) has never been called.

    Declaration

    Swift

    public private(set) var speed: Double? { get }

  • Custom angle, in degrees. Value is nil if with(angle:) has never been called.

    Declaration

    Swift

    public private(set) var angle: Double? { get }

  • Custom horizontal distance, in meters. Value is nil if with(horizontalDistance:) has never been called.

    Declaration

    Swift

    public private(set) var horizontalDistance: Double? { get }

  • Custom execution mode. Value is nil if with(mode:) has never been called.

    Declaration

    Swift

    public private(set) var mode: AnimationMode? { get }

  • Configures a custom animation speed.

    Declaration

    Swift

    @discardableResult
public func with(speed: Double) -> DollySlideAnimationConfig

    Parameters

    speed

    custom animation speed, in meters per second

    Return Value

    self, to allow call chaining

  • Configures a custom animation angle.

    Declaration

    Swift

    @discardableResult
public func with(angle: Double) -> DollySlideAnimationConfig

    Parameters

    speed

    custom animation angle, in degrees

    Return Value

    self, to allow call chaining

  • Configures a custom animation horizontal distance.

    Declaration

    Swift

    @discardableResult
public func with(horizontalDistance: Double) -> DollySlideAnimationConfig

    Parameters

    horizontalDistance

    custom horizontal distance, in meters

    Return Value

    self, to allow call chaining

  • Configures a custom animation execution mode.

    Declaration

    Swift

    @discardableResult
public func with(mode: AnimationMode) -> DollySlideAnimationConfig

    Parameters

    mode

    custom execution mode

    Return Value

    self, to allow call chaining

  • true when with(mode:) has been called once. ObjC-only api. In Swift, use mode.

    Declaration

    Swift

    public var modeIsCustom: Bool { get }

  • Custom mode. Value is meaningless if modeIsCustom is false. ObjC-only api. In Swift, use mode.

    Declaration

    Swift

    public var customMode: AnimationMode { get }