FRigUnit_TwoBoneIKSimple

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

API > API/Plugins > API/Plugins/ControlRig > API/Plugins/ControlRig/Units > API/Plugins/ControlRig/Units/Highlevel > API/Plugins/ControlRig/Units/Highlevel/Hierarchy

Inheritance Hierarchy

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
Public variable UProperty Meta bool bEnableStretch If set to true the stretch feature of the solver will be enabled
Public variable UProperty Meta FName BoneA The name of first bone
Public variable UProperty Meta float BoneALength The length of the first bone. If set to 0.0 it will be determined by the hierarchy
Public variable UProperty Meta FName BoneB The name of second bone
Public variable UProperty Meta float BoneBLength The length of the second bone. If set to 0.0 it will be determined by the hierarchy
Public variable UProperty Meta 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.
Public variable UProperty FCachedRigElement CachedBoneAIndex  
Public variable UProperty FCachedRigElement CachedBoneBIndex  
Public variable UProperty FCachedRigElement CachedEffectorBoneIndex  
Public variable UProperty FCachedRigElement CachedPoleVectorSpaceIndex  
Public variable UProperty Meta FRigUnit_TwoBoneIKSimple_DebugSettings DebugSettings The settings for debug drawing
Public variable UProperty Meta FTransform Effector The transform of the effector
Public variable UProperty Meta FName EffectorBone The name of the effector bone (if exists)
Public variable UProperty Meta FVector PoleVector The polevector to use for the IK solver This can be a location or direction.
Public variable UProperty Meta EControlRigVectorKind PoleVectorKind The kind of pole vector this is representing - can be a direction or a location
Public variable UProperty Meta FName PoleVectorSpace The space in which the pole vector is expressed
Public variable UProperty Meta FVector PrimaryAxis The major axis being aligned - along the bone
Public variable UProperty Meta FVector SecondaryAxis The minor axis being aligned - towards the polevector
Public variable UProperty Meta float SecondaryAxisWeight Determines how much the secondary axis roll is being applied
Public variable UProperty Meta float StretchMaximumRatio The maximum allowed stretch ratio
Public variable UProperty Meta float StretchStartRatio The ratio where the stretch starts
Public variable UProperty Meta float Weight The weight of the solver - how much the IK should be applied.

Constructors

  Type Name Description
Public function    

Overridden from FRigVMStruct

  Type Name Description
Public function Virtual void

Execute ()

 Execute logic for this struct
Public function Virtual Const FRigVMStructUpgradeInfo  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page