Skip to content

Class: AnimatorComponent

Components are used to attach functionality to object3D, it has an owner object3D. The component can receive update events at each frame.

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

new AnimatorComponent(): AnimatorComponent

Returns

AnimatorComponent

Inherited from

ComponentBase.constructor

Properties

object3D

object3D: Object3D = null

owner object3D

Inherited from

ComponentBase.object3D

Defined in

src/components/ComponentBase.ts:17


isDestroyed

Optional isDestroyed: boolean

Inherited from

ComponentBase.isDestroyed

Defined in

src/components/ComponentBase.ts:38


timeScale

timeScale: number = 1.0

Defined in

src/components/anim/AnimatorComponent.ts:8


jointMatrixIndexTableBuffer

jointMatrixIndexTableBuffer: StorageGPUBuffer

Defined in

src/components/anim/AnimatorComponent.ts:9


playBlendShapeLoop

playBlendShapeLoop: boolean = false

Defined in

src/components/anim/AnimatorComponent.ts:10


root

root: Object3D

Defined in

src/components/anim/AnimatorComponent.ts:28

Accessors

eventDispatcher

get eventDispatcher(): CEventDispatcher

Returns

CEventDispatcher

Inherited from

ComponentBase.eventDispatcher

Defined in

src/components/ComponentBase.ts:23

set eventDispatcher(value): void

Parameters

NameType
valueCEventDispatcher

Returns

void

Inherited from

ComponentBase.eventDispatcher

Defined in

src/components/ComponentBase.ts:28


isStart

get isStart(): boolean

Returns

boolean

Inherited from

ComponentBase.isStart

Defined in

src/components/ComponentBase.ts:40


transform

get transform(): Transform

Return the Transform component attached to the Object3D.

Returns

Transform

Inherited from

ComponentBase.transform

Defined in

src/components/ComponentBase.ts:47


enable

get enable(): boolean

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Returns

boolean

Inherited from

ComponentBase.enable

Defined in

src/components/ComponentBase.ts:68

set enable(value): void

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Parameters

NameType
valueboolean

Returns

void

Inherited from

ComponentBase.enable

Defined in

src/components/ComponentBase.ts:54


avatar

set avatar(name): void

Parameters

NameType
namestring

Returns

void

Defined in

src/components/anim/AnimatorComponent.ts:125


numJoint

get numJoint(): number

Returns

number

Defined in

src/components/anim/AnimatorComponent.ts:136


clips

get clips(): PropertyAnimationClip[]

Returns

PropertyAnimationClip[]

Defined in

src/components/anim/AnimatorComponent.ts:200

set clips(clips): void

Parameters

NameType
clipsPropertyAnimationClip[]

Returns

void

Defined in

src/components/anim/AnimatorComponent.ts:186


clipsState

get clipsState(): PropertyAnimationClipState[]

Returns

PropertyAnimationClipState[]

Defined in

src/components/anim/AnimatorComponent.ts:204

Methods

stop

stop(): void

Returns

void

Inherited from

ComponentBase.stop

Defined in

src/components/ComponentBase.ts:114


onEnable

onEnable(view?): any

Parameters

NameType
view?View3D

Returns

any

Inherited from

ComponentBase.onEnable

Defined in

src/components/ComponentBase.ts:115


onDisable

onDisable(view?): any

Parameters

NameType
view?View3D

Returns

any

Inherited from

ComponentBase.onDisable

Defined in

src/components/ComponentBase.ts:116


onLateUpdate

onLateUpdate(view?): any

Parameters

NameType
view?View3D

Returns

any

Inherited from

ComponentBase.onLateUpdate

Defined in

src/components/ComponentBase.ts:118


onBeforeUpdate

onBeforeUpdate(view?): any

Parameters

NameType
view?View3D

Returns

any

Inherited from

ComponentBase.onBeforeUpdate

Defined in

src/components/ComponentBase.ts:119


onCompute

onCompute(view?, command?): any

Parameters

NameType
view?View3D
command?GPUCommandEncoder

Returns

any

Inherited from

ComponentBase.onCompute

Defined in

src/components/ComponentBase.ts:120


onGraphic

onGraphic(view?): any

Parameters

NameType
view?View3D

Returns

any

Inherited from

ComponentBase.onGraphic

Defined in

src/components/ComponentBase.ts:121


onParentChange

onParentChange(lastParent?, currentParent?): any

Parameters

NameType
lastParent?Object3D
currentParent?Object3D

Returns

any

Inherited from

ComponentBase.onParentChange

Defined in

src/components/ComponentBase.ts:122


onAddChild

onAddChild(child): any

Parameters

NameType
childObject3D

Returns

any

Inherited from

ComponentBase.onAddChild

Defined in

src/components/ComponentBase.ts:123


onRemoveChild

onRemoveChild(child): any

Parameters

NameType
childObject3D

Returns

any

Inherited from

ComponentBase.onRemoveChild

Defined in

src/components/ComponentBase.ts:124


copyComponent

copyComponent(from): this

Parameters

NameType
fromthis

Returns

this

Inherited from

ComponentBase.copyComponent

Defined in

src/components/ComponentBase.ts:133


beforeDestroy

beforeDestroy(force?): void

before release this component, object refrences are not be set null now.

Parameters

NameType
force?boolean

Returns

void

Inherited from

ComponentBase.beforeDestroy

Defined in

src/components/ComponentBase.ts:200


destroy

destroy(force?): void

release this component

Parameters

NameType
force?boolean

Returns

void

Inherited from

ComponentBase.destroy

Defined in

src/components/ComponentBase.ts:207


init

init(param?): void

Parameters

NameType
param?any

Returns

void

Overrides

ComponentBase.init

Defined in

src/components/anim/AnimatorComponent.ts:36


start

start(): void

Returns

void

Overrides

ComponentBase.start

Defined in

src/components/anim/AnimatorComponent.ts:57


playAnim

playAnim(anim, time?, speed?): void

Parameters

NameTypeDefault value
animstringundefined
timenumber0
speednumber1

Returns

void

Defined in

src/components/anim/AnimatorComponent.ts:64


crossFade

crossFade(anim, crossTime): void

Parameters

NameType
animstring
crossTimenumber

Returns

void

Defined in

src/components/anim/AnimatorComponent.ts:80


playBlendShape

playBlendShape(shapeName, time?, speed?): void

Parameters

NameTypeDefault value
shapeNamestringundefined
timenumber0
speednumber1

Returns

void

Defined in

src/components/anim/AnimatorComponent.ts:114


getJointIndexTable

getJointIndexTable(skinJointsName): number[]

Parameters

NameType
skinJointsNamestring[]

Returns

number[]

Defined in

src/components/anim/AnimatorComponent.ts:140


cloneTo

cloneTo(obj): void

clone component data to target object3D

Parameters

NameTypeDescription
objObject3Dtarget object3D

Returns

void

Overrides

ComponentBase.cloneTo

Defined in

src/components/anim/AnimatorComponent.ts:208


onUpdate

onUpdate(view?): void

Parameters

NameType
view?View3D

Returns

void

Overrides

ComponentBase.onUpdate

Defined in

src/components/anim/AnimatorComponent.ts:240


updateBlendShape

updateBlendShape(attributes, key, value): void

Parameters

NameType
attributesstring[]
keystring
valuenumber

Returns

void

Defined in

src/components/anim/AnimatorComponent.ts:305


getAnimationClipState

getAnimationClipState(name): PropertyAnimationClipState

Gets the animation clip data object with the specified name

Parameters

NameTypeDescription
namestringName of animation

Returns

PropertyAnimationClipState

Animation clip data object

Defined in

src/components/anim/AnimatorComponent.ts:413


cloneMorphRenderers

cloneMorphRenderers(): Object

Returns

Object

Defined in

src/components/anim/AnimatorComponent.ts:422