Class AnimationAsset

Represents animation data. Can have multiple AnimationPropertyLayers. Used in AnimationClip.

Remarks

AnimationAssets themselves do not handle playing or orchestrating animations. This is left to the AnimationPlayer component to handle.

Example

// @input Asset.AnimationAsset animAsset
const startEventName = 'animStarted';
const startTimestamp = 0;
const e = script.animAsset.createEvent(startEventName, startTimestamp);

const endEventName = 'animEnded';
const endTimestamp = script.animAsset.duration;
script.animAsset.createEvent(endEventName, endTimestamp);

Hierarchy (View Summary, Expand)

Constructors

constructor

Properties

duration fps name uniqueIdentifier

Methods

addLayer clearLayers createEvent deleteEvent deleteLayer getLayer getTypeName isOfType isSame

Constructors

Protectedconstructor

Properties

Readonlyduration

duration: number

Animation duration in seconds.

Readonlyfps

fps: number

Denotes how many key frames this animation was sampled at.

name

name: string

The name of the Asset in Lens Studio.

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

addLayer

clearLayers

  • clearLayers(): void

    Delete all the AnimationPropertyLayer in this AnimationAsset.

    Returns void

createEvent

deleteEvent

deleteLayer

  • deleteLayer(layerName: string): void

    Delete the AnimationPropertyLayer named layerName.

    Parameters

    • layerName: string

    Returns void

getLayer

getTypeName

  • getTypeName(): string

    Returns the name of this object's type.

    Returns string

isOfType

  • isOfType(type: string): boolean

    Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other: ScriptObject): boolean

    Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR