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