1. Epic GamesDeveloper
  3. FRigUnit_SpringIK

FRigUnit_SpringIK

The Spring IK solver uses a verlet integrator to perform an IK solve.

API > API/Plugins > API/Plugins/ControlRig

The Spring IK solver uses a verlet integrator to perform an IK solve. It support custom constraints including distance, length etc. Note: This node operates in world space!

   
Name FRigUnit_SpringIK
Type struct
Header File /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Highlevel/Hierarchy/RigUnit_SpringIK.h
Include Path #include "Units/Highlevel/Hierarchy/RigUnit_SpringIK.h"

Syntax

USTRUCT (Meta=(DisplayName="Spring IK", Category="Hierarchy", Keywords="IK", NodeColor="0 1 1"))  
struct FRigUnit_SpringIK : public FRigUnit_HighlevelBaseMutable

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FRigUnit_SpringIK()

   Units/Highlevel/Hierarchy/RigUnit_SpringIK.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bFlipPolePlane bool If set to true the pole plane will be flipped Units/Highlevel/Hierarchy/RigUnit_SpringIK.h
  • Meta=(Input)
bLimitLocalPosition bool If set to true bones are placed within the original distance of the previous local transform. Units/Highlevel/Hierarchy/RigUnit_SpringIK.h
  • Meta=(Input)
bLiveSimulation bool If set to true simulation will continue for all intermediate bones over time. Units/Highlevel/Hierarchy/RigUnit_SpringIK.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_SpringIK.h
  • Meta=(Input, Constant)
Damping float The higher the value to more quickly the simulation calms down. Units/Highlevel/Hierarchy/RigUnit_SpringIK.h
  • Meta=(Input, Constant)
DebugSettings FRigUnit_SpringIK_DebugSettings The debug setting for the node Units/Highlevel/Hierarchy/RigUnit_SpringIK.h
  • Meta=(Input, DetailsOnly)
EffectorRatio float Defines the equilibrium of the effector springs. Units/Highlevel/Hierarchy/RigUnit_SpringIK.h
  • Meta=(Input, Constant)
EffectorStrength float Sets the coefficient of the springs towards the effector. Values between 1 and 2048 are common. Units/Highlevel/Hierarchy/RigUnit_SpringIK.h
  • Meta=(Input, Constant)
EndBone FName The name of the second bone to solve Units/Highlevel/Hierarchy/RigUnit_SpringIK.h
  • Meta=(Input, CustomWidget="BoneName")
HierarchyStrength float Sets the coefficient of the springs along the hierarchy. Values between 1 and 2048 are common. Units/Highlevel/Hierarchy/RigUnit_SpringIK.h
  • Meta=(Input, Constant)
Iterations int32 Drives how precise the solver operates. Units/Highlevel/Hierarchy/RigUnit_SpringIK.h
  • Meta=(Input, Constant)
PoleVector FVector The polevector to use for the IK solver This can be a location or direction. Units/Highlevel/Hierarchy/RigUnit_SpringIK.h
  • Meta=(Input)
PoleVectorKind EControlRigVectorKind The kind of pole vector this is representing - can be a direction or a location Units/Highlevel/Hierarchy/RigUnit_SpringIK.h
  • Meta=(Input)
PoleVectorSpace FName The space in which the pole vector is expressed Units/Highlevel/Hierarchy/RigUnit_SpringIK.h
  • Meta=(Input, CustomWidget="BoneName")
PrimaryAxis FVector The major axis being aligned - along the bone Units/Highlevel/Hierarchy/RigUnit_SpringIK.h
  • Meta=(Input)
RootRatio float Defines the equilibrium of the root springs. Units/Highlevel/Hierarchy/RigUnit_SpringIK.h
  • Meta=(Input, Constant)
RootStrength float Sets the coefficient of the springs towards the root. Values between 1 and 2048 are common. Units/Highlevel/Hierarchy/RigUnit_SpringIK.h
  • Meta=(Input, Constant)
SecondaryAxis FVector The minor axis being aligned - towards the pole vector Units/Highlevel/Hierarchy/RigUnit_SpringIK.h
  • Meta=(Input)
StartBone FName The name of the first bone to solve Units/Highlevel/Hierarchy/RigUnit_SpringIK.h
  • Meta=(Input, CustomWidget="BoneName")
WorkData FRigUnit_SpringIK_WorkData   Units/Highlevel/Hierarchy/RigUnit_SpringIK.h
  • Transient

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_SpringIK.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_SpringIK.h  

Overridden from FRigVMStruct

Name Remarks Include Path Unreal Specifiers

virtual void Execute()

   Units/Highlevel/Hierarchy/RigUnit_SpringIK.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page