Interface Animation

Description

Used by AnimationMixer to animate a single object in the hierarchy. These are automatically added to SceneObjects when importing animated FBX files. See also: Playing 3D Animation Guide, AnimationMixer, AnimationLayer.

interface Animation {
    enabled: boolean;
    uniqueIdentifier: string;
    destroy(): void;
    getAnimationLayerByName(layerName): AnimationLayer;
    getSceneObject(): SceneObject;
    getTransform(): Transform;
    getTypeName(): string;
    isOfType(type): boolean;
    isSame(other): boolean;
    removeAnimationLayerByName(layerName): void;
    setAnimationLayerByName(layerName, animationLayer): void;
}

Hierarchy (view full)

Component
- Animation

Index

Properties

enabled uniqueIdentifier

Methods

destroy getAnimationLayerByName getSceneObject getTransform getTypeName isOfType isSame removeAnimationLayerByName setAnimationLayerByName

Properties

enabled

enabled: boolean

Description

If disabled, the Component will stop enacting its behavior.

`Readonly` uniqueIdentifier

uniqueIdentifier: string

Methods

destroy

destroy(): void
Returns void
Description
Destroys the component.

Inherited from Component.destroy

getAnimationLayerByName

getAnimationLayerByName(layerName): AnimationLayer
Parameters
- layerName: string
Returns AnimationLayer
Description
Returns the AnimationLayer under the name layerName.

getSceneObject

getSceneObject(): SceneObject
Returns SceneObject
Description
Returns the SceneObject the component is attached to.

Inherited from Component.getSceneObject

getTransform

getTransform(): Transform
Returns Transform
Description
Returns the Transform this component is attached to.

Inherited from Component.getTransform

getTypeName

getTypeName(): string
Returns string
Description
Returns the name of this object's type.

Inherited from Component.getTypeName

isOfType

isOfType(type): boolean
Parameters
- type: string
Returns boolean
Description
Returns true if the object matches or derives from the passed in type.

Inherited from Component.isOfType

isSame

isSame(other): boolean
Parameters
- other: ScriptObject
Returns boolean
Description
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Inherited from Component.isSame

removeAnimationLayerByName

removeAnimationLayerByName(layerName): void
Parameters
- layerName: string
Returns void
Description
Removes the AnimationLayer under the name layerName.

setAnimationLayerByName

setAnimationLayerByName(layerName, animationLayer): void
Parameters
- layerName: string
- animationLayer: AnimationLayer
Returns void
Description
Adds an AnimationLayer under the name layerName.

Generated using TypeDoc