Documentation / scene / SpringModifier

Class: SpringModifier

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

Post-processor wrapper for spring physics systems.

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

Deprecated

Use the new JointDynamicsModifier class instead.

Extends

• SkeletonModifier

Constructors

Constructor

new SpringModifier(springSystem, weight?): SpringModifier

Defined in: libs/scene/src/animation/spring_modifier.ts:25

Create a spring post-processor.

Parameters

springSystem

SpringSystem

The spring system to integrate

weight?

number = 1.0

Blend weight [0-1] (default: 1.0)

Returns

SpringModifier

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

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

---

springSystem

Get Signature

get springSystem(): SpringSystem

Defined in: libs/scene/src/animation/spring_modifier.ts:34

Get the spring system.

Returns

SpringSystem

Methods

apply()

apply(_skeleton, deltaTime): void

Defined in: libs/scene/src/animation/spring_modifier.ts:41

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/spring_modifier.ts:56

Reset the spring system to initial state.

Returns

void

Overrides

SkeletonModifier.reset

---

_getWeight()

protected _getWeight(): number

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

Get the blend weight for this processor.

Returns

number

The current blend weight (0-1)

Overrides

SkeletonModifier._getWeight

---

_setWeight()

protected _setWeight(value): void

Defined in: libs/scene/src/animation/spring_modifier.ts:72

Set the blend weight for this processor.

Parameters

value

number

New blend weight (0-1)

Returns

void

Overrides

SkeletonModifier._setWeight