Basic IK | Unreal Engine 5.7 Documentation

This page is not available in the language you have chosen. It will be displayed in English by default. If you would like to view it in a different language, you can try selecting another language.

Description

Solves the two bone IK given two bones. Note: This node operates in world space!

Information

Plugin	ControlRig
Category	Hierarchy
Tags	TwoBone,IK
Type	FRigUnit_TwoBoneIKSimplePerItem

IO

Name	Description	Permitted Types	Default Value
ExecutePin	This property is used to chain multiple mutable units together	Execute Context

Inputs

Name	Description	Permitted Types	Default Value
ItemA	The name of first item	Rig Element Key	(Type=Bone,Name="")
ItemB	The name of second item	Rig Element Key	(Type=Bone,Name="")
EffectorItem	The name of the effector item (if exists)	Rig Element Key	(Type=Bone,Name="")
Effector	The transform of the effector	Transform	(Rotation=(X=0.000000,Y=0.000000,Z=0.000000,W=1.000000),Translation=(X=0.000000,Y=0.000000,Z=0.000000),Scale3D=(X=1.000000,Y=1.000000,Z=1.000000))
PrimaryAxis	The major axis being aligned - along the item	Vector	(X=1.000000,Y=0.000000,Z=0.000000)
SecondaryAxis	The minor axis being aligned - towards the polevector	Vector	(X=0.000000,Y=1.000000,Z=0.000000)
SecondaryAxisWeight	Determines how much the secondary axis roll is being applied	float	1.000000
PoleVector	The polevector to use for the IK solver This can be a location or direction.	Vector	(X=0.000000,Y=0.000000,Z=1.000000)
PoleVectorKind	The kind of pole vector this is representing - can be a direction or a location	Control Rig Vector Kind	Direction
PoleVectorSpace	The space in which the pole vector is expressed	Rig Element Key	(Type=Bone,Name="")
bEnableStretch	If set to true the stretch feature of the solver will be enabled	bool	False
StretchStartRatio	The ratio where the stretch starts	float	0.750000
StretchMaximumRatio	The maximum allowed stretch ratio	float	1.250000
Weight	The weight of the solver - how much the IK should be applied.	float	1.000000
ItemALength	The length of the first item. If set to 0.0 it will be determined by the hierarchy	float	0.000000
ItemBLength	The length of the second item. If set to 0.0 it will be determined by the hierarchy	float	0.000000
bPropagateToChildren	If set to true all of the global transforms of the children of this bone will be recalculated based on their local transforms. Note: This is computationally more expensive than turning it off.	bool	True
DebugSettings	The settings for debug drawing	Rig Unit Two Bone IKSimple Debug Settings	(bEnabled=False,Scale=10.000000,WorldOffset=(Rotation=(X=0.000000,Y=0.000000,Z=0.000000,W=1.000000),Translation=(X=0.000000,Y=0.000000,Z=0.000000),Scale3D=(X=1.000000,Y=1.000000,Z=1.000000)))