@orillusion/core

---

Class: SkeletonAnimationComponent

Defined in: src/components/SkeletonAnimationComponent.ts:16

skeleton animation

Extends

• ComponentBase

Constructors

Constructor

new SkeletonAnimationComponent(): SkeletonAnimationComponent

Defined in: src/components/SkeletonAnimationComponent.ts:37

Returns

SkeletonAnimationComponent

Overrides

ComponentBase.constructor

Properties

object3D

object3D: Object3D = null

Defined in: src/components/ComponentBase.ts:29

owner object3D

Inherited from

ComponentBase.object3D

---

isDestroyed

isDestroyed: boolean = false

Defined in: src/components/ComponentBase.ts:77

Inherited from

ComponentBase.isDestroyed

---

isPlaying

isPlaying: boolean = true

Defined in: src/components/SkeletonAnimationComponent.ts:20

Whether it is playing

---

timeScale

timeScale: number = 1.0

Defined in: src/components/SkeletonAnimationComponent.ts:25

Global animation time scaling

Accessors

visibleLayer

Get Signature

get visibleLayer(): number

Defined in: src/components/ComponentBase.ts:46

Composition-layer membership bitmask. The pass / camera / collector filters via

(component.visibleLayer & pass.layerMask & camera.cullingMask) !== 0

Defaults to VisibleLayer.Default (bit 0) so a fresh subclass is visible to passes whose layerMask is VisibleLayer.All (which includes bit 0). Application code can assign project-specific bits (1..31) to organise the scene into composition layers.

Returns

number

Set Signature

set visibleLayer(value): void

Defined in: src/components/ComponentBase.ts:50

Parameters

value

number

Returns

void

Inherited from

ComponentBase.visibleLayer

---

eventDispatcher

Get Signature

get eventDispatcher(): CEventDispatcher

Defined in: src/components/ComponentBase.ts:63

Returns

CEventDispatcher

Set Signature

set eventDispatcher(value): void

Defined in: src/components/ComponentBase.ts:68

Parameters

value

CEventDispatcher

Returns

void

Inherited from

ComponentBase.eventDispatcher

---

isStart

Get Signature

get isStart(): boolean

Defined in: src/components/ComponentBase.ts:79

Returns

boolean

Inherited from

ComponentBase.isStart

---

transform

Get Signature

get transform(): Transform

Defined in: src/components/ComponentBase.ts:89

Return the Transform component attached to the Object3D. Null before the component is attached — addComponent assigns object3D only after construction — so constructor-time callers can probe safely via this.transform?..

Returns

Transform

Inherited from

ComponentBase.transform

---

enable

Get Signature

get enable(): boolean

Defined in: src/components/ComponentBase.ts:113

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

Returns

boolean

Set Signature

set enable(value): void

Defined in: src/components/ComponentBase.ts:96

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

Parameters

value

boolean

Returns

void

Inherited from

ComponentBase.enable

---

currName

Get Signature

get currName(): string

Defined in: src/components/SkeletonAnimationComponent.ts:48

The name of the currently playing animation

Returns

string

---

skeleton

Get Signature

get skeleton(): Skeleton

Defined in: src/components/SkeletonAnimationComponent.ts:70

Skeleton data

Returns

Skeleton

Set Signature

set skeleton(value): void

Defined in: src/components/SkeletonAnimationComponent.ts:58

Skeleton data

Parameters

value

Skeleton

Returns

void

---

finalSkeletonPose

Get Signature

get finalSkeletonPose(): SkeletonPose

Defined in: src/components/SkeletonAnimationComponent.ts:77

Current final skeleton posture data

Returns

SkeletonPose

---

jointMatrixIndexTableBuffer

Get Signature

get jointMatrixIndexTableBuffer(): StorageGPUBuffer

Defined in: src/components/SkeletonAnimationComponent.ts:84

Bone matrix index table data

Returns

StorageGPUBuffer

Methods

init()

init(param?): void

Defined in: src/components/ComponentBase.ts:161

Parameters

param?

any

Returns

void

Inherited from

ComponentBase.init

---

stop()

stop(): void

Defined in: src/components/ComponentBase.ts:163

Returns

void

Inherited from

ComponentBase.stop

---

onEnable()?

optional onEnable(view?): any

Defined in: src/components/ComponentBase.ts:164

Parameters

view?

View3D

Returns

any

Inherited from

ComponentBase.onEnable

---

onDisable()?

optional onDisable(view?): any

Defined in: src/components/ComponentBase.ts:165

Parameters

view?

View3D

Returns

any

Inherited from

ComponentBase.onDisable

---

onLateUpdate()?

optional onLateUpdate(view?): any

Defined in: src/components/ComponentBase.ts:167

Parameters

view?

View3D

Returns

any

Inherited from

ComponentBase.onLateUpdate

---

onBeforeUpdate()?

optional onBeforeUpdate(view?): any

Defined in: src/components/ComponentBase.ts:168

Parameters

view?

View3D

Returns

any

Inherited from

ComponentBase.onBeforeUpdate

---

onCompute()?

optional onCompute(view?, command?): any

Defined in: src/components/ComponentBase.ts:169

Parameters

view?

View3D

command?

GPUCommandEncoder

Returns

any

Inherited from

ComponentBase.onCompute

---

onGraphic()?

optional onGraphic(view?): any

Defined in: src/components/ComponentBase.ts:170

Parameters

view?

View3D

Returns

any

Inherited from

ComponentBase.onGraphic

---

onParentChange()?

optional onParentChange(lastParent?, currentParent?): any

Defined in: src/components/ComponentBase.ts:171

Parameters

lastParent?

Object3D

currentParent?

Object3D

Returns

any

Inherited from

ComponentBase.onParentChange

---

onAddChild()?

optional onAddChild(child): any

Defined in: src/components/ComponentBase.ts:172

Parameters

child

Object3D

Returns

any

Inherited from

ComponentBase.onAddChild

---

onRemoveChild()?

optional onRemoveChild(child): any

Defined in: src/components/ComponentBase.ts:173

Parameters

child

Object3D

Returns

any

Inherited from

ComponentBase.onRemoveChild

---

copyComponent()

copyComponent(from): this

Defined in: src/components/ComponentBase.ts:182

Parameters

from

this

Returns

this

Inherited from

ComponentBase.copyComponent

---

beforeDestroy()

beforeDestroy(force?): void

Defined in: src/components/ComponentBase.ts:249

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

Parameters

force?

boolean

Returns

void

Inherited from

ComponentBase.beforeDestroy

---

destroy()

destroy(force?): void

Defined in: src/components/ComponentBase.ts:256

release this component

Parameters

force?

boolean

Returns

void

Inherited from

ComponentBase.destroy

---

start()

start(): void

Defined in: src/components/SkeletonAnimationComponent.ts:41

Returns

void

Overrides

ComponentBase.start

---

getJointIndexTable()

getJointIndexTable(skinJointsName): number[]

Defined in: src/components/SkeletonAnimationComponent.ts:93

Get the bone index information by the bone name

Parameters

skinJointsName

string[]

bone name

Returns

number[]

bone index

---

addAnimationClip()

addAnimationClip(clip): void

Defined in: src/components/SkeletonAnimationComponent.ts:107

Add a skeleton animation clip

Parameters

clip

SkeletonAnimationClip

Skeletal animation clip

Returns

void

---

getAnimationClip()

getAnimationClip(name): SkeletonAnimationClip

Defined in: src/components/SkeletonAnimationComponent.ts:124

Gets the animation clip data object with the specified name

Parameters

name

string

Name of animation

Returns

SkeletonAnimationClip

Animation clip data object

---

getAnimationClips()

getAnimationClips(): SkeletonAnimationClip[]

Defined in: src/components/SkeletonAnimationComponent.ts:136

Gets all animation clip data objects

Returns

SkeletonAnimationClip[]

Animation clip data object

---

getAnimationClipState()

getAnimationClipState(name): SkeletonAnimationClipState

Defined in: src/components/SkeletonAnimationComponent.ts:145

Gets the animation clip state object with the specified name

Parameters

name

string

Name of animation

Returns

SkeletonAnimationClipState

Animation clip state object

---

getAnimationClipStates()

getAnimationClipStates(): Map<string, SkeletonAnimationClipState>

Defined in: src/components/SkeletonAnimationComponent.ts:156

Gets all animation clip state objects

Returns

Map<string, SkeletonAnimationClipState>

Animation clip state object

---

pause()

pause(): void

Defined in: src/components/SkeletonAnimationComponent.ts:163

stop playing

Returns

void

---

resume()

resume(): void

Defined in: src/components/SkeletonAnimationComponent.ts:170

Resume playback

Returns

void

---

play()

play(animName, speed?, reset?): boolean

Defined in: src/components/SkeletonAnimationComponent.ts:181

Play the specified animation

Parameters

animName

string

The data set name for the animation

speed?

number = 1

Animation playback speed, default value is 1.0

reset?

boolean = false

When true, each play starts with the first frame

Returns

boolean

---

crossFade()

crossFade(animName, crossTime): void

Defined in: src/components/SkeletonAnimationComponent.ts:211

Fades the current animation and fades into another animation state for a specified time.

Parameters

animName

string

The name of the animation to fade in.

crossTime

number

The time of transition, in seconds.

Returns

void

---

setAnimIsLoop()

setAnimIsLoop(animName, isLoop): void

Defined in: src/components/SkeletonAnimationComponent.ts:251

Set the animation loop

Parameters

animName

string

The data set name for the animation

isLoop

boolean

If true, loop the animation

Returns

void

---

addJointBind()

addJointBind(jointName, obj): void

Defined in: src/components/SkeletonAnimationComponent.ts:262

Add joint bindings to the object

Parameters

jointName

string

Name of joint

obj

Object3D

Object of binding

Returns

void

---

removeJointBind()

removeJointBind(obj): void

Defined in: src/components/SkeletonAnimationComponent.ts:274

Removes the joint binding of the specified object

Parameters

obj

Object3D

Object of binding

Returns

void

---

cloneTo()

cloneTo(obj): void

Defined in: src/components/SkeletonAnimationComponent.ts:322

Clones the current component to the specified object

Parameters

obj

Object3D

target object

Returns

void

Overrides

ComponentBase.cloneTo