Type Aliases

The following type aliases are available globally.

  • A closure used to provide status updates for a Motion object.

    Declaration

    Swift

    public typealias MotionUpdateClosure = (_ motion: Motion) -> Void

    Parameters

    motion

    The Motion object which published this update closure.

  • This notification closure should be called when the start method starts a motion operation. If a delay has been specified, this closure is called after the delay is complete.

    Seealso

    start

    Declaration

    Swift

    public typealias MotionStarted = MotionUpdateClosure

  • This notification closure should be called when the stop method starts a motion operation.

    Seealso

    stop

    Declaration

    Swift

    public typealias MotionStopped = MotionUpdateClosure

  • This notification closure should be called when the update(withTimeInterval:) method is called while a Moveable object is currently moving.

    Seealso

    update(withTimeInterval:)

    Declaration

    Swift

    public typealias MotionUpdated = MotionUpdateClosure

  • This notification closure should be called when a motion operation reverses its movement direction.

    Declaration

    Swift

    public typealias MotionReversed = MotionUpdateClosure

  • This notification closure should be called when a motion has started a new motion cycle.

    Declaration

    Swift

    public typealias MotionRepeated = MotionUpdateClosure

  • This notification closure should be called when calling the pause method pauses a motion operation.

    Declaration

    Swift

    public typealias MotionPaused = MotionUpdateClosure

  • This notification closure should be called when calling the resume method resumes a motion operation.

    Declaration

    Swift

    public typealias MotionResumed = MotionUpdateClosure

  • This notification closure should be called when a motion operation has fully completed.

    Remark

    This closure should only be executed when all activity related to the motion has ceased. For instance, if a Moveable class allows a motion to be repeated multiple times, this closure should be called when all repetitions have finished.

    Declaration

    Swift

    public typealias MotionCompleted = MotionUpdateClosure

  • A closure used to provide status updates for a MotionGroup object.

    Declaration

    Swift

    public typealias GroupUpdateClosure = (_ group: MotionGroup) -> Void

    Parameters

    group

    The MotionGroup object which published this update closure.

  • This notification closure should be called when the start method starts a motion operation. If a delay has been specified, this closure is called after the delay is complete.

    Seealso

    start

    Declaration

    Swift

    public typealias GroupStarted = GroupUpdateClosure

  • This notification closure should be called when the stop method starts a motion operation.

    Seealso

    stop

    Declaration

    Swift

    public typealias GroupStopped = GroupUpdateClosure

  • This notification closure should be called when the update method is called while a Moveable object is currently moving.

    Seealso

    update

    Declaration

    Swift

    public typealias GroupUpdated = GroupUpdateClosure

  • This notification closure should be called when a motion operation reverses its movement direction.

    Declaration

    Swift

    public typealias GroupReversed = GroupUpdateClosure

  • This notification closure should be called when a motion has started a new repeat cycle.

    Declaration

    Swift

    public typealias GroupRepeated = GroupUpdateClosure

  • This notification closure should be called when calling the pause method pauses a motion operation.

    Declaration

    Swift

    public typealias GroupPaused = GroupUpdateClosure

  • This notification closure should be called when calling the resume method resumes a motion operation.

    Declaration

    Swift

    public typealias GroupResumed = GroupUpdateClosure

  • This notification closure should be called when a motion operation has fully completed.

    Remark

    This closure should only be executed when all activity related to the motion has ceased. For instance, if a Moveable class allows a motion to be repeated multiple times, this closure should be called when all repetitions have finished.

    Declaration

    Swift

    public typealias GroupCompleted = GroupUpdateClosure

ValueAssistant protocol

  • Any easing types used by a Motion object should implement this closure.

    Declaration

    Swift

    public typealias EasingUpdateClosure = (_ elapsedTime: TimeInterval, _ startValue: Double, _ valueRange: Double, _ duration: TimeInterval) -> Double

  • A closure used to provide status updates for a MotionSequence object.

    Declaration

    Swift

    public typealias SequenceUpdateClosure = (_ sequence: MotionSequence) -> Void

    Parameters

    sequence

    The MotionSequence object which published this update closure.

  • This notification closure should be called when the start method starts a motion operation. If a delay has been specified, this closure is called after the delay is complete.

    Seealso

    start

    Declaration

    Swift

    public typealias SequenceStarted = SequenceUpdateClosure

  • This notification closure should be called when the stop method starts a motion operation.

    Seealso

    stop

    Declaration

    Swift

    public typealias SequenceStopped = SequenceUpdateClosure

  • This notification closure should be called when the update method is called while a Moveable object is currently moving.

    Seealso

    update

    Declaration

    Swift

    public typealias SequenceUpdated = SequenceUpdateClosure

  • This notification closure should be called when a motion operation reverses its movement direction.

    Declaration

    Swift

    public typealias SequenceReversed = SequenceUpdateClosure

  • This notification closure should be called when a motion has started a new repeat cycle.

    Declaration

    Swift

    public typealias SequenceRepeated = SequenceUpdateClosure

  • This notification closure should be called when calling the pause method pauses a motion operation.

    Declaration

    Swift

    public typealias SequencePaused = SequenceUpdateClosure

  • This notification closure should be called when calling the resume method resumes a motion operation.

    Declaration

    Swift

    public typealias SequenceResumed = SequenceUpdateClosure

  • This notification closure should be called when a motion operation has fully completed.

    Remark

    This closure should only be executed when all activity related to the motion has ceased. For instance, if a Moveable class allows a motion to be repeated multiple times, this closure should be called when all repetitions have finished.

    Declaration

    Swift

    public typealias SequenceCompleted = SequenceUpdateClosure

  • This notification closure should be called when a sequence’s movement has advanced to its next sequence step.

    Declaration

    Swift

    public typealias SequenceStepped = SequenceUpdateClosure

  • A closure used to provide status updates for a PathMotion object.

    Declaration

    Swift

    public typealias PathMotionUpdateClosure = (_ motion: PathMotion, _ currentPoint: CGPoint) -> Void

    Parameters

    motion

    The PathMotion object which published this update closure.
    currentPoint

    The current position of a point being animated along a path.

  • This notification closure should be called when the start method starts a motion operation. If a delay has been specified, this closure is called after the delay is complete.

    Seealso

    start

    Declaration

    Swift

    public typealias PathMotionStarted = PathMotionUpdateClosure

  • This notification closure should be called when the stop method starts a motion operation.

    Seealso

    stop

    Declaration

    Swift

    public typealias PathMotionStopped = PathMotionUpdateClosure

  • This notification closure should be called when the update(withTimeInterval:) method is called while a Moveable object is currently moving.

    Seealso

    update(withTimeInterval:)

    Declaration

    Swift

    public typealias PathMotionUpdated = PathMotionUpdateClosure

  • This notification closure should be called when a motion operation reverses its movement direction.

    Declaration

    Swift

    public typealias PathMotionReversed = PathMotionUpdateClosure

  • This notification closure should be called when a motion has started a new repeat cycle.

    Declaration

    Swift

    public typealias PathMotionRepeated = PathMotionUpdateClosure

  • This notification closure should be called when calling the pause method pauses a motion operation.

    Declaration

    Swift

    public typealias PathMotionPaused = PathMotionUpdateClosure

  • This notification closure should be called when calling the resume method resumes a motion operation.

    Declaration

    Swift

    public typealias PathMotionResumed = PathMotionUpdateClosure

  • This notification closure should be called when a motion operation has fully completed.

    Remark

    This closure should only be executed when all activity related to the motion has ceased. For instance, if a Moveable class allows a motion to be repeated multiple times, this closure should be called when all repetitions have finished.

    Declaration

    Swift

    public typealias PathMotionCompleted = PathMotionUpdateClosure

  • A closure used to provide status updates for a PathPhysicsMotion object.

    Declaration

    Swift

    public typealias PathPhysicsMotionUpdateClosure = (_ motion: PathPhysicsMotion, _ currentPoint: CGPoint) -> Void

    Parameters

    motion

    The PathPhysicsMotion object which published this update closure.
    currentPoint

    The current position of a point being animated along a path.

  • This notification closure should be called when the start method starts a motion operation. If a delay has been specified, this closure is called after the delay is complete.

    Seealso

    start

    Declaration

    Swift

    public typealias PathPhysicsMotionStarted = PathPhysicsMotionUpdateClosure

  • This notification closure should be called when the stop method starts a motion operation.

    Seealso

    stop

    Declaration

    Swift

    public typealias PathPhysicsMotionStopped = PathPhysicsMotionUpdateClosure

  • This notification closure should be called when the update(withTimeInterval:) method is called while a Moveable object is currently moving.

    Seealso

    update(withTimeInterval:)

    Declaration

    Swift

    public typealias PathPhysicsMotionUpdated = PathPhysicsMotionUpdateClosure

  • This notification closure should be called when a motion operation reverses its movement direction.

    Declaration

    Swift

    public typealias PathPhysicsMotionReversed = PathPhysicsMotionUpdateClosure

  • This notification closure should be called when a motion has started a new repeat cycle.

    Declaration

    Swift

    public typealias PathPhysicsMotionRepeated = PathPhysicsMotionUpdateClosure

  • This notification closure should be called when calling the pause method pauses a motion operation.

    Declaration

    Swift

    public typealias PathPhysicsMotionPaused = PathPhysicsMotionUpdateClosure

  • This notification closure should be called when calling the resume method resumes a motion operation.

    Declaration

    Swift

    public typealias PathPhysicsMotionResumed = PathPhysicsMotionUpdateClosure

  • This notification closure should be called when a motion operation has fully completed.

    Remark

    This closure should only be executed when all activity related to the motion has ceased. For instance, if a Moveable class allows a motion to be repeated multiple times, this closure should be called when all repetitions have finished.

    Declaration

    Swift

    public typealias PathPhysicsMotionCompleted = PathPhysicsMotionUpdateClosure

  • A closure used to provide status updates for a PhysicsMotion object.

    Declaration

    Swift

    public typealias PhysicsMotionUpdateClosure = (_ motion: PhysicsMotion) -> Void

    Parameters

    motion

    The PhysicsMotion object which published this update closure.

  • This notification closure should be called when the start method starts a motion operation. If a delay has been specified, this closure is called after the delay is complete.

    Seealso

    start

    Declaration

    Swift

    public typealias PhysicsMotionStarted = PhysicsMotionUpdateClosure

  • This notification closure should be called when the stop method starts a motion operation.

    Seealso

    stop

    Declaration

    Swift

    public typealias PhysicsMotionStopped = PhysicsMotionUpdateClosure

  • This notification closure should be called when the update(withTimeInterval:) method is called while a Moveable object is currently moving.

    Seealso

    update(withTimeInterval:)

    Declaration

    Swift

    public typealias PhysicsMotionUpdated = PhysicsMotionUpdateClosure

  • This notification closure should be called when a motion operation reverses its movement direction.

    Declaration

    Swift

    public typealias PhysicsMotionReversed = PhysicsMotionUpdateClosure

  • This notification closure should be called when a motion has started a new repeat cycle.

    Declaration

    Swift

    public typealias PhysicsMotionRepeated = PhysicsMotionUpdateClosure

  • This notification closure should be called when calling the pause method pauses a motion operation.

    Declaration

    Swift

    public typealias PhysicsMotionPaused = PhysicsMotionUpdateClosure

  • This notification closure should be called when calling the resume method resumes a motion operation.

    Declaration

    Swift

    public typealias PhysicsMotionResumed = PhysicsMotionUpdateClosure

  • This notification closure should be called when a motion operation has fully completed.

    Remark

    This closure should only be executed when all activity related to the motion has ceased. For instance, if a Moveable class allows a motion to be repeated multiple times, this closure should be called when all repetitions have finished.

    Declaration

    Swift

    public typealias PhysicsMotionCompleted = PhysicsMotionUpdateClosure