class · iOS 13.0+ · SDK 27.1
@MainActor @preconcurrency class AnimationPlaybackControllerA controller that manages animation playback. This class controls the playback of an entity animation by providing its pause, resume, or stop functions. The animation starts immediately after you call ``Entity/playAnimation(_:transitionDuration:startsPaused:)``, or ``Entity/move(to:relativeTo:duration:timingFunction:)-905k``, which both return an instance of this class. A controller invalidates after its associated animation completes or stops. To play another animation, perform an action that generates another controller. While an animation plays, you can receive notification of particular playback states by subscribing to an event. For more information, see ``AnimationEvents``.
get isComplete(): Promise<boolean>@MainActor @preconcurrency var isComplete: Bool { get }A Boolean that indicates whether the animation has finished running. After an animation completes, the playback controller becomes invalid. To play the animation again, create a new controller with the same resource.
get blendFactor(): Promise<number>@MainActor @preconcurrency var blendFactor: Float { get set }The level of influence the controller gives to its animation. You can run multiple animations on the same property, for example, walking and jumping animations that affect the same joint transforms. When multiple animations adjust the same property at runtime, the framework applies this blend factor on the animations' respective controllers to calculate a middle ground value that displays at runtime.
setBlendFactor(value: number): Promise<void>@MainActor @preconcurrency var blendFactor: Float { get set }The level of influence the controller gives to its animation. You can run multiple animations on the same property, for example, walking and jumping animations that affect the same joint transforms. When multiple animations adjust the same property at runtime, the framework applies this blend factor on the animations' respective controllers to calculate a middle ground value that displays at runtime.
stopBlendOutDuration(blendOutDuration: number): Promise<void>@MainActor @preconcurrency func stop(blendOutDuration: TimeInterval)Stops an animation with a fade-out time. - Parameters: - blendOutDuration: Time (in seconds) to fade out the animation before it stops. This method has no effect if the animation is complete. After you stop the animation, the playback controller becomes invalid. Create a new one with the same resource to play the animation again.
stop(): Promise<void>@MainActor @preconcurrency func stop()Stops an animation. This method has no effect if the animation is complete. After you stop the animation, the playback controller becomes invalid. Create a new one with the same resource to play the animation again.
get time(): Promise<number>@MainActor @preconcurrency var time: TimeInterval { get set }The animation's location within the timeline.
setTime(value: number): Promise<void>@MainActor @preconcurrency var time: TimeInterval { get set }The animation's location within the timeline.
get clock(): Promise<unknown>@MainActor @preconcurrency var clock: CMClockOrTimebase { get set }A reference clock to synchronize the animation with other events.
setClock(value: unknown): Promise<void>@MainActor @preconcurrency var clock: CMClockOrTimebase { get set }A reference clock to synchronize the animation with other events.
pause(): Promise<void>@MainActor @preconcurrency func pause()Pauses the animation. Resume a paused animation by calling the ``AnimationPlaybackController/resume()`` method. This method has no effect if the animation is already paused or complete.
get speed(): Promise<number>@MainActor @preconcurrency var speed: Float { get set }The animation's rate of playback. The animation applies the value of this property as an irrational factor of the unaltered speed. For example, a value of `2` plays the animation twice as fast, a value of `0.5` plays the animation at half speed, and a value of `1` plays the animation at the unaltered rate.
setSpeed(value: number): Promise<void>@MainActor @preconcurrency var speed: Float { get set }The animation's rate of playback. The animation applies the value of this property as an irrational factor of the unaltered speed. For example, a value of `2` plays the animation twice as fast, a value of `0.5` plays the animation at half speed, and a value of `1` plays the animation at the unaltered rate.
get entity(): Promise<(Entity) | null>@MainActor @preconcurrency weak var entity: Entity? { get }The entity to which the animation applies.
resume(): Promise<void>@MainActor @preconcurrency func resume()Resumes a paused animation. Call this method to resume an animation that you paused with the ``AnimationPlaybackController/pause()`` method. You can’t resume an animation that has finished naturally, or that you stopped by calling the ``AnimationPlaybackController/stop()`` method. This method has no effect on an animation that isn’t paused.
get isValid(): Promise<boolean>@MainActor @preconcurrency var isValid: Bool { get }A Boolean value that indicates whether the animation controller is functional. This function returns `false` for stopped animations.
get duration(): Promise<number>@MainActor @preconcurrency var duration: TimeInterval { get }The length of time the animation spans, in seconds.
get isPaused(): Promise<boolean>@MainActor @preconcurrency var isPaused: Bool { get }A Boolean that indicates whether the animation is paused.
get isPlaying(): Promise<boolean>@MainActor @preconcurrency var isPlaying: Bool { get }A Boolean value that indicates whether the animation plays.
get isStopped(): Promise<boolean>@MainActor @preconcurrency var isStopped: Bool { get }A Boolean value that indicates whether the animation stopped. This function returns `true` for stopped animations.
No declarations were skipped in this snapshot.