VerticalRevealAnimationConfig

@objcMembers
@objc(GSVerticalRevealAnimationConfig)
public class VerticalRevealAnimationConfig : NSObject, AnimationConfig

Vertical reveal animation configuration class.

Allows to configure the following parameters for this animation:

  • vertical speed: animation vertical speed, in meters per second. If with(verticalSpeed:) is not customized, then the drone will apply its own default value for this parameter.
  • vertical distance: distance the drone will fly vertically, in meters. Positive values instruct the drone to fly up, negative value instructs to fly down. If with(verticalDistance:) is not customized, then the drone will apply its own default value for this parameter.
  • rotation angle: angle for the panorama the drone will perform after having flown up, in degrees. Positive values make the drone rotate clockwise, negative values make it rotate counter-clockwise. Absolute value may be greater than 360 degrees to perform more than one complete rotation. If with(rotationAngle:) is not called, then the drone will apply its own default value for this parameter.
  • rotation speed: angular speed of the rotation, in degrees per second. If with(rotationSpeed:) is not called, 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 vertical speed, in meters per second. Value is nil if with(verticalSpeed:) has never been called.

    Declaration

    Swift

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

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

    Declaration

    Swift

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

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

    Declaration

    Swift

    public internal(set) var rotationAngle: Double? { get }

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

    Declaration

    Swift

    public internal(set) var rotationSpeed: 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 vertical speed.

    Declaration

    Swift

    @discardableResult
public func with(verticalSpeed: Double) -> VerticalRevealAnimationConfig

    Parameters

    speed

    custom animation speed, in meters per second

    Return Value

    self, to allow call chaining

  • Configures a custom animation vertical distance.

    Declaration

    Swift

    @discardableResult
public func with(verticalDistance: Double) -> VerticalRevealAnimationConfig

    Parameters

    verticalDistance

    custom vertical distance, in meters

    Return Value

    self, to allow call chaining

  • Configures a custom rotation angle.

    Declaration

    Swift

    @discardableResult
public func with(rotationAngle: Double) -> VerticalRevealAnimationConfig

    Parameters

    rotationAngle

    custom rotation angle, in degrees

    Return Value

    self, to allow call chaining

  • Configures a custom rotation speed.

    Declaration

    Swift

    @discardableResult
public func with(rotationSpeed: Double) -> VerticalRevealAnimationConfig

    Parameters

    rotationSpeed

    custom rotation speed, in degrees per second

    Return Value

    self, to allow call chaining

  • Configures a custom animation execution mode.

    Declaration

    Swift

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

    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 }