Documentation / scene / IKModifier
Class: IKModifier<Solver>
Defined in: libs/scene/src/animation/ik_modifier.ts:14
Skeleton modifier for IK solvers.
Integrates IK solving into the skeleton post-processing pipeline. The IK solver is executed each frame and results are blended with the base animation.
Extends
Type Parameters
Solver
Solver extends IKSolver = IKSolver
Constructors
Constructor
new IKModifier<
Solver>(solver,target,weight?):IKModifier<Solver>
Defined in: libs/scene/src/animation/ik_modifier.ts:26
Create an IK post-processor.
Parameters
solver
Solver
The IK solver to integrate
target
Vector3
Target position for the end effector
weight?
number = 1.0
Blend weight [0-1] (default: 1.0)
Returns
IKModifier<Solver>
Overrides
Properties
_enabled
protected_enabled:boolean
Defined in: libs/scene/src/animation/skeleton_modifier.ts:13
Whether this processor is enabled
Inherited from
Accessors
solver
Get Signature
get solver():
Solver
Defined in: libs/scene/src/animation/ik_modifier.ts:36
Get the IK solver.
Returns
Solver
target
Get Signature
get target():
Vector3
Defined in: libs/scene/src/animation/ik_modifier.ts:43
Get the current target position.
Returns
Vector3
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
Methods
setTarget()
setTarget(
target):void
Defined in: libs/scene/src/animation/ik_modifier.ts:52
Set the target position for the end effector.
Parameters
target
Vector3
New target position (will be cloned)
Returns
void
apply()
apply(
_skeleton,_deltaTime):void
Defined in: libs/scene/src/animation/ik_modifier.ts:59
Apply IK solving to skeleton joints.
Parameters
_skeleton
_deltaTime
number
Returns
void
Overrides
reset()
reset():
void
Defined in: libs/scene/src/animation/ik_modifier.ts:74
Reset the IK solver to initial state.
Returns
void
Overrides
_getWeight()
protected_getWeight():number
Defined in: libs/scene/src/animation/ik_modifier.ts:79
Get the blend weight for this processor.
Returns
number
Overrides
_setWeight()
protected_setWeight(value):void
Defined in: libs/scene/src/animation/ik_modifier.ts:83
Set the blend weight for this processor.
Parameters
value
number
Returns
void