Navigation
API > API/Plugins > API/Plugins/ControlRig > API/Plugins/ControlRig/Units > API/Plugins/ControlRig/Units/Highlevel > API/Plugins/ControlRig/Units/Highlevel/Hierarchy
Inheritance Hierarchy
- FRigVMStruct
- FRigUnit
- FRigUnitMutable
- FRigUnit_HighlevelBaseMutable
- FRigUnit_TwoBoneIKSimple
References
| Module | ControlRig |
| Header | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Highlevel/Hierarchy/RigUnit_TwoBoneIKSimple.h |
| Include | #include "Units/Highlevel/Hierarchy/RigUnit_TwoBoneIKSimple.h" |
Syntax
USTRUCT (
Meta=(DisplayName="Basic IK", Category="Hierarchy", Keywords="TwoBone,IK", Deprecated="4.25"))
struct FRigUnit_TwoBoneIKSimple : public FRigUnit_HighlevelBaseMutable
Remarks
Solves the two bone IK given two bones. Note: This node operates in world space!
Variables
| Type | Name | Description | |
|---|---|---|---|
   |
bool | bEnableStretch | If set to true the stretch feature of the solver will be enabled |
   |
FName | BoneA | The name of first bone |
   |
float | BoneALength | The length of the first bone. If set to 0.0 it will be determined by the hierarchy |
   |
FName | BoneB | The name of second bone |
   |
float | BoneBLength | The length of the second bone. If set to 0.0 it will be determined by the hierarchy |
   |
bool | bPropagateToChildren | If set to true all of the global transforms of the children of this bone will be recalculated based on their local transforms. |
  |
FCachedRigElement | CachedBoneAIndex | |
  |
FCachedRigElement | CachedBoneBIndex | |
  |
FCachedRigElement | CachedEffectorBoneIndex | |
  |
FCachedRigElement | CachedPoleVectorSpaceIndex | |
   |
FRigUnit_TwoBoneIKSimple_DebugSettings | DebugSettings | The settings for debug drawing |
   |
FTransform | Effector | The transform of the effector |
   |
FName | EffectorBone | The name of the effector bone (if exists) |
   |
FVector | PoleVector | The polevector to use for the IK solver This can be a location or direction. |
   |
EControlRigVectorKind | PoleVectorKind | The kind of pole vector this is representing - can be a direction or a location |
   |
FName | PoleVectorSpace | The space in which the pole vector is expressed |
   |
FVector | PrimaryAxis | The major axis being aligned - along the bone |
   |
FVector | SecondaryAxis | The minor axis being aligned - towards the polevector |
   |
float | SecondaryAxisWeight | Determines how much the secondary axis roll is being applied |
   |
float | StretchMaximumRatio | The maximum allowed stretch ratio |
   |
float | StretchStartRatio | The ratio where the stretch starts |
   |
float | Weight | The weight of the solver - how much the IK should be applied. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Overridden from FRigVMStruct
| Type | Name | Description | |
|---|---|---|---|
  |
void | Execute () |
Execute logic for this struct |
   |
FRigVMStructUpgradeInfo |