TweenAnimator

public final class TweenAnimator<Target> : Tween where Target : Tweenable

Maintains the state of a tween animation while invoking animation closures to interpolate and update the properties of Tweenable targets.

Animation & State Properties


                    
                    
                    state

Declaration

Swift

public private(set) var state: TweenState

ease
Declaration
Swift

public var ease: Ease

Time Properties

delay
Declaration
Swift

public var delay: TimeInterval
duration
Declaration
Swift

public var duration: TimeInterval
elapsed
Declaration
Swift

public var elapsed: TimeInterval

Callback Properties


                    
                    
                    onUpdate

Declaration

Swift

public var onUpdate: TweenAnimator<Target>.Callback?


                    
                    
                    onStart

Declaration

Swift

public var onStart: TweenAnimator<Target>.Callback?


                    
                    
                    onStop

Declaration

Swift

public var onStop: TweenAnimator<Target>.Callback?


                    
                    
                    onRestart

Declaration

Swift

public var onRestart: TweenAnimator<Target>.Callback?


                    
                    
                    onPause

Declaration

Swift

public var onPause: TweenAnimator<Target>.Callback?


                    
                    
                    onResume

Declaration

Swift

public var onResume: TweenAnimator<Target>.Callback?


                    
                    
                    onComplete

Declaration

Swift

public var onComplete: TweenAnimator<Target>.Callback?


                    
                    
                    onKill

Declaration

Swift

public var onKill: TweenAnimator<Target>.Callback?


                    
                    
                    onRevive

Declaration

Swift

public var onRevive: TweenAnimator<Target>.Callback?

Tweening


                    
                    
                    to(_:)

Animates tweenable properties from the target’s current values to the desired values.

Declaration

Swift

@discardableResult
public func to(_ properties: Target.TweenProperty...) -> TweenAnimator<Target>

Parameters


                                properties

The properties to animate.

Return Value

The current TweenAnimator instance to allow for additional customization.


                    
                    
                    to(_:)

Animates tweenable properties from the target’s current values to the desired values.

Declaration

Swift

@discardableResult
public func to<PropType: TweenableProperty>(_ properties: PropType...) -> TweenAnimator<Target>
    where PropType.Target == Target

Parameters


                                properties

The properties to animate.

Return Value

The current TweenAnimator instance to allow for additional customization.


                    
                    
                    from(_:)

Animates tweenable properties from desired values to the target’s current values.

Declaration

Swift

@discardableResult
public func from(_ properties: Target.TweenProperty...) -> TweenAnimator<Target>

Parameters


                                properties

The properties to animate.

Return Value

The current TweenAnimator instance to allow for additional customization.


                    
                    
                    from(_:)

Animates tweenable properties from desired values to the target’s current values.

Declaration

Swift

@discardableResult
public func from<PropType: TweenableProperty>(_ properties: PropType...) -> TweenAnimator<Target>
    where PropType.Target == Target

Parameters


                                properties

The properties to animate.

Return Value

The current TweenAnimator instance to allow for additional customization.

State Control


                    
                    
                    update(by:)

Declaration

Swift

@discardableResult
func update(by deltaTime: TimeInterval) -> Bool

start()
Declaration
Swift

@discardableResult func start() -> Bool
stop()
Declaration
Swift

@discardableResult func stop() -> Bool


                    
                    
                    restart()

Declaration

Swift

@discardableResult
func restart() -> Bool

pause()
Declaration
Swift

@discardableResult func pause() -> Bool


                    
                    
                    resume()

Declaration

Swift

@discardableResult
func resume() -> Bool


                    
                    
                    complete()

Declaration

Swift

@discardableResult
func complete() -> Bool

kill()
Declaration
Swift

@discardableResult func kill() -> Bool


                    
                    
                    revive()

Declaration

Swift

@discardableResult
func revive() -> Bool