Class AnimComponentLayer

The Anim Component Layer allows managers a single layer of the animation state graph.

Accessors

activeState

get activeState(): string
Gets the currently active state name.

Returns string
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:123

activeStateCurrentTime

get activeStateCurrentTime(): number
Gets the active state's time in seconds.

Returns number
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:176
set activeStateCurrentTime(time: number): void
Sets the active state's time in seconds.
Parameters
- time: number
Returns void
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:160

activeStateDuration

get activeStateDuration(): number
Gets the currently active states duration.

Returns number
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:151

activeStateProgress

get activeStateProgress(): number
Gets the currently active state's progress as a value normalized by the state's animation duration. Looped animations will return values greater than 1.

Returns number
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:142

mask

get mask(): any
Gets the mask of bones which should be animated or ignored by this layer.

Returns any
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:270

set mask(value: any): void

Sets the mask of bones which should be animated or ignored by this layer.

Parameters

value: any

Returns void

Example

entity.anim.baseLayer.mask = {
    // include the spine of the current model and all of its children
    "path/to/spine": {
        children: true
    },
    // include the hip of the current model but not all of its children
    "path/to/hip": true
};

name

get name(): string
Returns the name of the layer.

Returns string
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:86

playable

get playable(): boolean
Returns true if a state graph has been loaded and all states in the graph have been assigned animation tracks.

Returns boolean
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:114

playing

get playing(): boolean
Gets whether this layer is currently playing.

Returns boolean
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:104
set playing(value: boolean): void
Sets whether this layer is currently playing.
Parameters
- value: boolean
Returns void
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:95

previousState

get previousState(): string
Gets the previously active state name.

Returns string
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:132

states

get states(): string[]
Gets all available states in this layers state graph.

Returns string[]
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:207

transitioning

get transitioning(): boolean
Gets whether the anim component layer is currently transitioning between states.

Returns boolean
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:185

transitionProgress

get transitionProgress(): number
Gets the progress, if the anim component layer is currently transitioning between states. Otherwise returns null.

Returns number
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:195

weight

get weight(): number
Sets the blending weight of this layer.

Returns number
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:227
set weight(value: number): void
Sets the blending weight of this layer. Used when calculating the value of properties that are animated by more than one layer.
Parameters
- value: number
Returns void
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:217

Methods

assignAnimation

assignAnimation(
    nodePath: string,
    animTrack: AnimTrack,
    speed?: number,
    loop?: boolean,
): void
Assigns an animation track to a state or blend tree node in the current graph. If a state for the given nodePath doesn't exist, it will be created. If all states nodes are linked and the AnimComponent#activate value was set to true then the component will begin playing.
Parameters
- nodePath: string
  Either the state name or the path to a blend tree node that this animation should be associated with. Each section of a blend tree path is split using a period (.) therefore state names should not include this character (e.g "MyStateName" or "MyStateName.BlendTreeNode").
- animTrack: AnimTrack
  The animation track that will be assigned to this state and played whenever this state is active.
- Optionalspeed: number
  Update the speed of the state you are assigning an animation to. Defaults to 1.
- Optionalloop: boolean
  Update the loop property of the state you are assigning an animation to. Defaults to true.
Returns void
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:354

blendToWeight

blendToWeight(weight: number, time: number): void
Blend from the current weight value to the provided weight value over a given amount of time.
Parameters
- weight: number
  The new weight value to blend to.
- time: number
  The duration of the blend in seconds.
Returns void
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:330

getAnimationAsset

getAnimationAsset(stateName: string): { asset: number }
Returns an object holding the animation asset id that is associated with the given state.
Parameters
- stateName: string
  The name of the state to get the asset for.
Returns { asset: number }
An object containing the animation asset id associated with the given state.
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:388

pause

pause(): void
Pause the animation in the current state.

Returns void
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:287

play

play(name?: string): void
Start playing the animation in the current state.
Parameters
- Optionalname: string
  If provided, will begin playing from the start of the state with this name.
Returns void
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:280

rebind

rebind(): void
Rebind any animations in the layer to the currently present components and model of the anim components entity.

Returns void
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:303

removeNodeAnimations

removeNodeAnimations(nodeName: string): void
Removes animations from a node in the loaded state graph.
Parameters
- nodeName: string
  The name of the node that should have its animation tracks removed.
Returns void
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:376

reset

reset(): void
Reset the animation component to its initial state, including all parameters. The system will be paused.

Returns void
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:295

transition

transition(to: string, time?: number, transitionOffset?: number): void
Transition to any state in the current layers graph. Transitions can be instant or take an optional blend time.
Parameters
- to: string
  The state that this transition will transition to.
- Optionaltime: number = 0
  The duration of the transition in seconds. Defaults to 0.
- OptionaltransitionOffset: number = null
  If provided, the destination state will begin playing its animation at this time. Given in normalized time, based on the states duration & must be between 0 and 1. Defaults to null.
Returns void
- Defined in submodules/engine/src/framework/components/anim/component-layer.js:402

Class AnimComponentLayer

Index

Accessors

Methods

Accessors

activeState

Returns string

activeStateCurrentTime

Returns number

Parameters

Returns void

activeStateDuration

Returns number

activeStateProgress

Returns number

mask

Returns any

Parameters

Returns void

Example

name

Returns string

playable

Returns boolean

playing

Returns boolean

Parameters

Returns void

previousState

Returns string

states

Returns string[]

transitioning

Returns boolean

transitionProgress

Returns number

weight

Returns number

Parameters

Returns void

Methods

assignAnimation

Parameters

Returns void

blendToWeight

Parameters

Returns void

getAnimationAsset

Parameters

Returns { asset: number }

pause

Returns void

play

Parameters

Returns void

rebind

Returns void

removeNodeAnimations

Parameters

Returns void

reset

Returns void

transition

Parameters

Returns void

Settings

On This Page