1. Epic GamesDeveloper
  3. FAnimNode_IKRig

FAnimNode_IKRig

API > API/Plugins > API/Plugins/IKRig > API/Plugins/IKRig/AnimNodes

Inheritance Hierarchy

References

   
Module IKRig
Header /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/AnimNodes/AnimNode_IKRig.h
Include #include "AnimNodes/AnimNode_IKRig.h"

Syntax

USTRUCT&40;BlueprintInternalUseOnly&41;  
struct FAnimNode_IKRig : public FAnimNode_CustomProperty

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float Alpha Current strength of the skeletal control.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FInputAlphaBoolBlend AlphaBoolBlend  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FName AlphaCurveName  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EAnimAlphaInputType AlphaInputType Alpha value handler
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FInputScaleBias AlphaScaleBias  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FInputScaleBiasClamp AlphaScaleBiasClamp  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bAlphaBoolEnabled  
Public variable bool bDriveWithSourceAsset When true, goals will use the current transforms stored in the IK Rig Definition asset itself
Public variable UProperty Category, EditAnywhere bool bEnableDebugDraw Toggle debug drawing of goals when node is selected.
Public variable UProperty Category, EditAnywhere bool bStartFromRefPose Optionally ignore the input pose and start from the reference pose each solve
Public variable UProperty Category, EditAnywhere float DebugScale Adjust size of debug drawing.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TArray< FIKRigGoal > Goals The input goal transforms used by the IK Rig solvers.
Public variable UProperty Category, EditAnywhere, Meta TObjectPtr< UIKRigDefinition > RigDefinitionAsset The IK rig to use to modify the incoming source pose.
Public variable UProperty Category, EditAnywhere FPoseLink Source The input pose to start the IK solve relative to.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Force reinitialization

Overridden from FAnimNode_CustomProperty

  Type Name Description
Protected function Virtual Const UClass * Get Target Class
Protected function Virtual void

InitializeProperties ( const UObject* InSourceInstance,
UClass* InTargetClass
)

 Initialize property links from the source instance, in this case AnimInstance Compiler creates those properties during compile time
Protected function Virtual void

PropagateInputProperties ( const UObject* InSourceInstance
)

 Propagate the Source Instances' properties to Target Instance

Overridden from FAnimNode_Base

  Type Name Description
Public function Virtual void Called to cache any bones that this node needs to track (e.g. in a FBoneReference).
Public function Virtual void Called to evaluate local-space bones transforms according to the weights set up in Update().
Public function Virtual void Called to gather on-screen debug data. This is called on the game thread.
Public function Virtual Const bool Override this to indicate that PreUpdate() should be called on the game thread (usually to gather non-thread safe data) before Update() is called.
Public function Virtual void Called when the node first runs.
Public function Virtual Const bool For nodes that need some kind of initialization that is not dependent on node relevancy (i.e. it is insufficient or inefficient to use Initialize_AnyThread), return true here.
Public function Virtual void

OnInitializeAnimInstance ( const FAnimInstanceProxy* InProxy,
const UAnimInstance* InAnimInstance
)

 We only subscribe to the OnInitializeAnimInstance path because we need to cache our source object, so we only override these methods in editor at the moment
Public function Virtual void

PreUpdate ( const UAnimInstance* InAnimInstance
)

 Override this to perform game-thread work prior to non-game thread Update() being called
Public function Virtual void Called to update the state of the graph relative to this node.

Typedefs

Name Description
PropertyUpdateFunction Cached functions used to update goals using custom properties to avoid looking for then when evaluating

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page