Skip to content

Documentation / scene / JointDynamicsModifier

Class: JointDynamicsModifier

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

Post-processor wrapper for joint dynamics systems.

Integrates joint-based physics simulation into the skeleton post-processing pipeline. The joint dynamics system is updated each frame and results are blended with the base animation.

Extends

Constructors

Constructor

new JointDynamicsModifier(jointDynamicsSystem): JointDynamicsModifier

Defined in: libs/scene/src/animation/joint_dynamics_modifier.ts:21

Create a joint dynamics post-processor.

Parameters

jointDynamicsSystem

JointDynamicsSystem

The joint dynamics system to integrate

Returns

JointDynamicsModifier

Overrides

SkeletonModifier.constructor

Properties

_enabled

protected _enabled: boolean

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

Whether this processor is enabled

Inherited from

SkeletonModifier._enabled

Accessors

jointDynamicsSystem

Get Signature

get jointDynamicsSystem(): JointDynamicsSystem

Defined in: libs/scene/src/animation/joint_dynamics_modifier.ts:29

Get the joint dynamics system.

Returns

JointDynamicsSystem


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

Inherited from

SkeletonModifier.weight


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

Inherited from

SkeletonModifier.enabled

Methods

apply()

apply(_skeleton, deltaTime): void

Defined in: libs/scene/src/animation/joint_dynamics_modifier.ts:36

Apply spring physics to skeleton joints.

Parameters

_skeleton

SkeletonRig

deltaTime

number

Returns

void

Overrides

SkeletonModifier.apply


reset()

reset(): void

Defined in: libs/scene/src/animation/joint_dynamics_modifier.ts:48

Reset the spring system to initial state.

Returns

void

Overrides

SkeletonModifier.reset


warp()

warp(): void

Defined in: libs/scene/src/animation/joint_dynamics_modifier.ts:56

Returns

void

Deprecated

Use JointDynamicsModifier.reset. Kept as a compatibility alias for teleport handling.


_getWeight()

protected _getWeight(): number

Defined in: libs/scene/src/animation/joint_dynamics_modifier.ts:60

Get the blend weight for this processor.

Returns

number

Overrides

SkeletonModifier._getWeight


_setWeight()

protected _setWeight(value): void

Defined in: libs/scene/src/animation/joint_dynamics_modifier.ts:64

Set the blend weight for this processor.

Parameters

value

number

Returns

void

Overrides

SkeletonModifier._setWeight

Released under the MIT License.