Interface AnimationAsset

Asset that contains multiple animation layers. Animation assets themselves do not handle playing or orchestrating animations. This is left to the animation player component to handle.

interface AnimationAsset {
    duration: number;
    fps: number;
    name: string;
    uniqueIdentifier: string;
    addLayer(layerName: string, layer: AnimationPropertyLayer): void;
    clearLayers(): void;
    createEvent(eventName: string, time: number): AnimationPropertyEventRegistration;
    deleteEvent(layerName: AnimationPropertyEventRegistration): void;
    deleteLayer(layerName: string): void;
    getLayer(layerName: string): AnimationPropertyLayer;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

duration fps name uniqueIdentifier

Methods

addLayer clearLayers createEvent deleteEvent deleteLayer getLayer getTypeName isOfType isSame

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

  • addLayer(layerName, layer): void

  • Adds AnimationPropertyLayer to Animation asset.

    Parameters

    Returns void

clearLayers

  • clearLayers(): void

  • Delete all the AnimationPropertyLayer in this AnimationAsset.

    Returns void

createEvent

deleteEvent

deleteLayer

  • deleteLayer(layerName): 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): boolean

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

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): 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

Properties
Methods