1. Epic GamesDeveloper
  3. FRigUnit_TwoBoneIKSimplePerItem

FRigUnit_TwoBoneIKSimplePerItem

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

API > API/Plugins > API/Plugins/ControlRig

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

   
Name FRigUnit_TwoBoneIKSimplePerItem
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", NodeColor="0 1 1"))  
struct FRigUnit_TwoBoneIKSimplePerItem : public FRigUnit_HighlevelBaseMutable

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FRigUnit_TwoBoneIKSimplePerItem()

   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
  • Meta=(Input)
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
  • Meta=(Input, Constant)
CachedEffectorItemIndex FCachedRigElement   Units/Highlevel/Hierarchy/RigUnit_TwoBoneIKSimple.h  
CachedItemAIndex FCachedRigElement   Units/Highlevel/Hierarchy/RigUnit_TwoBoneIKSimple.h  
CachedItemBIndex 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
  • Meta=(Input, DetailsOnly)
Effector FTransform The transform of the effector Units/Highlevel/Hierarchy/RigUnit_TwoBoneIKSimple.h
  • Meta=(Input)
EffectorItem FRigElementKey The name of the effector item (if exists) Units/Highlevel/Hierarchy/RigUnit_TwoBoneIKSimple.h
  • Meta=(Input, ExpandByDefault)
ItemA FRigElementKey The name of first item Units/Highlevel/Hierarchy/RigUnit_TwoBoneIKSimple.h
  • Meta=(Input, ExpandByDefault)
ItemALength float The length of the first item. If set to 0.0 it will be determined by the hierarchy Units/Highlevel/Hierarchy/RigUnit_TwoBoneIKSimple.h
  • Meta=(Input)
ItemB FRigElementKey The name of second item Units/Highlevel/Hierarchy/RigUnit_TwoBoneIKSimple.h
  • Meta=(Input, ExpandByDefault)
ItemBLength float The length of the second item. If set to 0.0 it will be determined by the hierarchy Units/Highlevel/Hierarchy/RigUnit_TwoBoneIKSimple.h
  • Meta=(Input)
PoleVector FVector The polevector to use for the IK solver This can be a location or direction. Units/Highlevel/Hierarchy/RigUnit_TwoBoneIKSimple.h
  • Meta=(Input)
PoleVectorKind EControlRigVectorKind The kind of pole vector this is representing - can be a direction or a location Units/Highlevel/Hierarchy/RigUnit_TwoBoneIKSimple.h
  • Meta=(Input)
PoleVectorSpace FRigElementKey The space in which the pole vector is expressed Units/Highlevel/Hierarchy/RigUnit_TwoBoneIKSimple.h
  • Meta=(Input)
PrimaryAxis FVector The major axis being aligned - along the item Units/Highlevel/Hierarchy/RigUnit_TwoBoneIKSimple.h
  • Meta=(Input)
SecondaryAxis FVector The minor axis being aligned - towards the polevector Units/Highlevel/Hierarchy/RigUnit_TwoBoneIKSimple.h
  • Meta=(Input)
SecondaryAxisWeight float Determines how much the secondary axis roll is being applied Units/Highlevel/Hierarchy/RigUnit_TwoBoneIKSimple.h
  • Meta=(Input)
StretchMaximumRatio float The maximum allowed stretch ratio Units/Highlevel/Hierarchy/RigUnit_TwoBoneIKSimple.h
  • Meta=(Input)
StretchStartRatio float The ratio where the stretch starts Units/Highlevel/Hierarchy/RigUnit_TwoBoneIKSimple.h
  • Meta=(Input)
Weight float The weight of the solver - how much the IK should be applied. Units/Highlevel/Hierarchy/RigUnit_TwoBoneIKSimple.h
  • Meta=(Input)

Functions

Public

Overridden from FRigUnit

Name Remarks Include Path Unreal Specifiers

virtual bool UpdateDirectManipulationFromHierarchy ( const URigVMUnitNode* InNode,
TSharedPtr< FStructOnScope > InInstance,
FControlRigExecuteContext& InContext,
TSharedPtr< FRigDirectManipulationInfo > InInfo
)

 Sets the values on this node based on a viewport pose Units/Highlevel/Hierarchy/RigUnit_TwoBoneIKSimple.h  

virtual bool UpdateHierarchyForDirectManipulation ( const URigVMUnitNode* InNode,
TSharedPtr< FStructOnScope > InInstance,
FControlRigExecuteContext& InContext,
TSharedPtr< FRigDirectManipulationInfo > InInfo
)

 Sets a control's pose to represent this viewport pose target Units/Highlevel/Hierarchy/RigUnit_TwoBoneIKSimple.h  

Overridden from FRigVMStruct

Name Remarks Include Path Unreal Specifiers

virtual void Execute()

   Units/Highlevel/Hierarchy/RigUnit_TwoBoneIKSimple.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page