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
Constructors
Constructor
new SpringModifier(
springSystem,weight?):SpringModifier
Defined in: libs/scene/src/animation/spring_modifier.ts:26
Create a spring post-processor.
Parameters
springSystem
The spring system to integrate
weight?
number = 1.0
Blend weight [0-1] (default: 1.0)
Returns
SpringModifier
Overrides
Properties
_enabled
protected_enabled:boolean
Defined in: libs/scene/src/animation/skeleton_modifier.ts:13
Whether this processor is enabled
Inherited from
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
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
springSystem
Get Signature
get springSystem():
SpringSystem
Defined in: libs/scene/src/animation/spring_modifier.ts:36
Get the spring system.
Returns
sourceId
Get Signature
get sourceId():
string
Defined in: libs/scene/src/animation/spring_modifier.ts:43
Get the identifier of the configuration that created this modifier.
Returns
string
Set Signature
set sourceId(
value):void
Defined in: libs/scene/src/animation/spring_modifier.ts:47
Parameters
value
string
Returns
void
Methods
apply()
apply(
_skeleton,deltaTime):void
Defined in: libs/scene/src/animation/spring_modifier.ts:54
Apply spring physics to skeleton joints.
Parameters
_skeleton
deltaTime
number
Returns
void
Overrides
reset()
reset():
void
Defined in: libs/scene/src/animation/spring_modifier.ts:69
Reset the spring system to initial state.
Returns
void
Overrides
_getWeight()
protected_getWeight():number
Defined in: libs/scene/src/animation/spring_modifier.ts:77
Get the blend weight for this processor.
Returns
number
The current blend weight (0-1)
Overrides
_setWeight()
protected_setWeight(value):void
Defined in: libs/scene/src/animation/spring_modifier.ts:85
Set the blend weight for this processor.
Parameters
value
number
New blend weight (0-1)
Returns
void