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
↳
AnimatorComponent
Constructors
Properties
Accessors
Methods
- stop
- onEnable
- onDisable
- onLateUpdate
- onBeforeUpdate
- onCompute
- onGraphic
- onParentChange
- copyComponent
- beforeDestroy
- destroy
- init
- start
- playAnim
- playBlendShape
- getJointIndexTable
- cloneTo
- onUpdate
- updateBlendShape
Constructors
constructor
• new AnimatorComponent(): AnimatorComponent
Returns
Inherited from
Properties
object3D
• object3D: Object3D
= null
owner object3D
Inherited from
Defined in
src/components/ComponentBase.ts:17
isDestroyed
• Optional
isDestroyed: boolean
Inherited from
Defined in
src/components/ComponentBase.ts:38
jointMatrixIndexTableBuffer
• jointMatrixIndexTableBuffer: StorageGPUBuffer
Defined in
src/components/anim/AnimatorComponent.ts:8
playBlendShapeLoop
• playBlendShapeLoop: boolean
= false
Defined in
src/components/anim/AnimatorComponent.ts:9
root
• root: Object3D
Defined in
src/components/anim/AnimatorComponent.ts:26
Accessors
eventDispatcher
• get
eventDispatcher(): CEventDispatcher
Returns
Inherited from
ComponentBase.eventDispatcher
Defined in
src/components/ComponentBase.ts:23
• set
eventDispatcher(value
): void
Parameters
Name | Type |
---|---|
value | CEventDispatcher |
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
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
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
ComponentBase.enable
Defined in
src/components/ComponentBase.ts:54
avatar
• set
avatar(name
): void
Parameters
Name | Type |
---|---|
name | string |
Returns
void
Defined in
src/components/anim/AnimatorComponent.ts:64
clips
• get
clips(): PropertyAnimationClip
[]
Returns
Defined in
src/components/anim/AnimatorComponent.ts:129
• set
clips(clips
): void
Parameters
Name | Type |
---|---|
clips | PropertyAnimationClip [] |
Returns
void
Defined in
src/components/anim/AnimatorComponent.ts:121
Methods
stop
▸ stop(): void
Returns
void
Inherited from
Defined in
src/components/ComponentBase.ts:114
onEnable
▸ onEnable(view?
): any
Parameters
Name | Type |
---|---|
view? | View3D |
Returns
any
Inherited from
Defined in
src/components/ComponentBase.ts:115
onDisable
▸ onDisable(view?
): any
Parameters
Name | Type |
---|---|
view? | View3D |
Returns
any
Inherited from
Defined in
src/components/ComponentBase.ts:116
onLateUpdate
▸ onLateUpdate(view?
): any
Parameters
Name | Type |
---|---|
view? | View3D |
Returns
any
Inherited from
Defined in
src/components/ComponentBase.ts:118
onBeforeUpdate
▸ onBeforeUpdate(view?
): any
Parameters
Name | Type |
---|---|
view? | View3D |
Returns
any
Inherited from
Defined in
src/components/ComponentBase.ts:119
onCompute
▸ onCompute(view?
, command?
): any
Parameters
Name | Type |
---|---|
view? | View3D |
command? | GPUCommandEncoder |
Returns
any
Inherited from
Defined in
src/components/ComponentBase.ts:120
onGraphic
▸ onGraphic(view?
): any
Parameters
Name | Type |
---|---|
view? | View3D |
Returns
any
Inherited from
Defined in
src/components/ComponentBase.ts:121
onParentChange
▸ onParentChange(lastParent?
, currentParent?
): any
Parameters
Name | Type |
---|---|
lastParent? | Object3D |
currentParent? | Object3D |
Returns
any
Inherited from
Defined in
src/components/ComponentBase.ts:122
copyComponent
▸ copyComponent(from
): this
Parameters
Name | Type |
---|---|
from | this |
Returns
this
Inherited from
Defined in
src/components/ComponentBase.ts:131
beforeDestroy
▸ beforeDestroy(force?
): void
before release this component, object refrences are not be set null now.
Parameters
Name | Type |
---|---|
force? | boolean |
Returns
void
Inherited from
Defined in
src/components/ComponentBase.ts:198
destroy
▸ destroy(force?
): void
release this component
Parameters
Name | Type |
---|---|
force? | boolean |
Returns
void
Inherited from
Defined in
src/components/ComponentBase.ts:205
init
▸ init(param?
): void
Parameters
Name | Type |
---|---|
param? | any |
Returns
void
Overrides
Defined in
src/components/anim/AnimatorComponent.ts:29
start
▸ start(): void
Returns
void
Overrides
Defined in
src/components/anim/AnimatorComponent.ts:35
playAnim
▸ playAnim(anim
, time?
, speed?
): void
Parameters
Name | Type | Default value |
---|---|---|
anim | string | undefined |
time | number | 0 |
speed | number | 1 |
Returns
void
Defined in
src/components/anim/AnimatorComponent.ts:42
playBlendShape
▸ playBlendShape(shapeName
, time?
, speed?
): void
Parameters
Name | Type | Default value |
---|---|---|
shapeName | string | undefined |
time | number | 0 |
speed | number | 1 |
Returns
void
Defined in
src/components/anim/AnimatorComponent.ts:53
getJointIndexTable
▸ getJointIndexTable(skinJointsName
): number
[]
Parameters
Name | Type |
---|---|
skinJointsName | string [] |
Returns
number
[]
Defined in
src/components/anim/AnimatorComponent.ts:75
cloneTo
▸ cloneTo(obj
): void
clone component data to target object3D
Parameters
Name | Type | Description |
---|---|---|
obj | Object3D | target object3D |
Returns
void
Overrides
Defined in
src/components/anim/AnimatorComponent.ts:133
onUpdate
▸ onUpdate(view?
): void
Parameters
Name | Type |
---|---|
view? | View3D |
Returns
void
Overrides
Defined in
src/components/anim/AnimatorComponent.ts:159
updateBlendShape
▸ updateBlendShape(attributes
, key
, value
): void
Parameters
Name | Type |
---|---|
attributes | string [] |
key | string |
value | number |
Returns
void