Documentation / scene / SkeletonModifier

Abstract Class: SkeletonModifier

Defined in: libs/scene/src/animation/skeleton_modifier.ts:11

Abstract base class for skeleton post-processors.

Post-processors are applied after the base animation/bind pose layer, allowing procedural modifications like IK, spring physics, or manual overrides.

Extended by

• IKModifier
• SpringModifier
• JointDynamicsModifier

Constructors

Constructor

new SkeletonModifier(): SkeletonModifier

Defined in: libs/scene/src/animation/skeleton_modifier.ts:15

Returns

SkeletonModifier

Properties

_enabled

protected _enabled: boolean

Defined in: libs/scene/src/animation/skeleton_modifier.ts:13

Whether this processor is enabled

Accessors

weight

Get Signature

get weight(): number

Defined in: libs/scene/src/animation/skeleton_modifier.ts:22

Get the blend weight [0-1]

Returns

number

Set Signature

set weight(value): void

Defined in: libs/scene/src/animation/skeleton_modifier.ts:26

Parameters

value

number

Returns

void

---

enabled

Get Signature

get enabled(): boolean

Defined in: libs/scene/src/animation/skeleton_modifier.ts:33

Get whether this processor is enabled

Returns

boolean

Set Signature

set enabled(value): void

Defined in: libs/scene/src/animation/skeleton_modifier.ts:37

Parameters

value

boolean

Returns

void

Methods

apply()

abstract apply(skeleton, deltaTime): void

Defined in: libs/scene/src/animation/skeleton_modifier.ts:51

Apply post-processing to skeleton joints.

This method is called after the base animation/bind pose has been applied. Implementations should modify joint transforms and blend with the current state using the processor's weight.

Parameters

skeleton

SkeletonRig

The shared rig to process

deltaTime

number

Time elapsed since last frame (in seconds)

Returns

void

---

reset()

abstract reset(): void

Defined in: libs/scene/src/animation/skeleton_modifier.ts:58

Reset the processor to its initial state.

Called when the skeleton or animation state changes significantly.

Returns

void

---

_getWeight()

abstract protected _getWeight(): number

Defined in: libs/scene/src/animation/skeleton_modifier.ts:63

Get the blend weight for this processor.

Returns

number

---

_setWeight()

abstract protected _setWeight(_value): void

Defined in: libs/scene/src/animation/skeleton_modifier.ts:69

Set the blend weight for this processor.

Parameters

_value

number

New blend weight (0-1)

Returns

void