AnimationResource

class · iOS 13.0+ · SDK 27.1

@MainActor @preconcurrency class AnimationResource

An animation for the properties of scenes or entities. You find animation resources in an entity’s ``Entity/availableAnimations`` array. Animation resources come bundled with an entity when you load the entity from a file. They describe an animation that’s specific to the entity to which they are attached. Use the entity’s ``Entity/playAnimation(_:transitionDuration:startsPaused:)`` method to play a particular item in its animation resource array, or the `playAnimation(named:transitionDuration:startsPaused:)` method to play all of the animations with a given name. From both methods, you receive an ``AnimationPlaybackController`` instance that lets you manage playback of the resource. If you want to loop an animation, call the resource’s ``AnimationResource/repeat(count:)`` method to create a new resource that plays a given number of times in a row, or call the ``AnimationResource/repeat(duration:)`` method to create a new resource that loops for the given duration. The latter loops indefinitely if you omit the duration parameter. You use the new animation resource that these methods return just as you would any other.

Members (8)

get definition(): Promise<SDKHandle>

@MainActor @preconcurrency var definition: any AnimationDefinition { get }

get name(): Promise<(string) | null>

@MainActor @preconcurrency final let name: String?

static group(resources: Array<AnimationResource>): Promise<AnimationResource>

@MainActor @preconcurrency static func group(with resources: [AnimationResource]) throws -> AnimationResource

store(in_: Entity): Promise<void>

@MainActor @preconcurrency func store(in: Entity)

repeatCount(count: number): Promise<AnimationResource>

@MainActor @preconcurrency func `repeat`(count: Int) -> AnimationResource

repeatDuration(duration?: number): Promise<AnimationResource>

@MainActor @preconcurrency func `repeat`(duration: TimeInterval = .infinity) -> AnimationResource

static generate(definition: SDKHandle): Promise<AnimationResource>

@MainActor @preconcurrency static func generate(with definition: any AnimationDefinition) throws -> AnimationResource

static sequence(resources: Array<AnimationResource>): Promise<AnimationResource>

@MainActor @preconcurrency static func sequence(with resources: [AnimationResource]) throws -> AnimationResource

All RealityFoundation types →