FAnimNode_IKRig | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/IKRig


Name	FAnimNode_IKRig
Type	struct
Header File	/Engine/Plugins/Animation/IKRig/Source/IKRig/Public/AnimNodes/AnimNode_IKRig.h
Include Path	#include "AnimNodes/AnimNode_IKRig.h"

Syntax

USTRUCT (BlueprintInternalUseOnly)  
struct FAnimNode_IKRig : public FAnimNode_CustomProperty

Inheritance Hierarchy

FAnimNode_Base → FAnimNode_CustomProperty → FAnimNode_IKRig

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FAnimNode_IKRig()		AnimNodes/AnimNode_IKRig.h

Typedefs

Name	Type	Remarks	Include Path
PropertyUpdateFunction	TFunction< void(const UObject *)>	Cached functions used to update goals using custom properties to avoid looking for then when evaluating	AnimNodes/AnimNode_IKRig.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
Alpha	float	Current strength of the skeletal control.	AnimNodes/AnimNode_IKRig.h	EditAnywhere BlueprintReadWrite Category=Alpha Meta=(PinShownByDefault)
AlphaBoolBlend	FInputAlphaBoolBlend		AnimNodes/AnimNode_IKRig.h	EditAnywhere BlueprintReadWrite Category=Alpha Meta=(DisplayName="Blend Settings")
AlphaCurveName	FName		AnimNodes/AnimNode_IKRig.h	EditAnywhere BlueprintReadWrite Category=Alpha Meta=(PinShownByDefault)
AlphaInputType	EAnimAlphaInputType	Alpha value handler	AnimNodes/AnimNode_IKRig.h	EditAnywhere BlueprintReadWrite Category=Alpha
AlphaScaleBias	FInputScaleBias		AnimNodes/AnimNode_IKRig.h	EditAnywhere BlueprintReadWrite Category=Alpha
AlphaScaleBiasClamp	FInputScaleBiasClamp		AnimNodes/AnimNode_IKRig.h	EditAnywhere BlueprintReadWrite Category=Alpha
bAlphaBoolEnabled	bool		AnimNodes/AnimNode_IKRig.h	EditAnywhere BlueprintReadWrite Category=Alpha Meta=(PinShownByDefault, DisplayName="bEnabled")
bDriveWithSourceAsset	bool	When true, goals will use the current transforms stored in the IK Rig Definition asset itself	AnimNodes/AnimNode_IKRig.h
bEnableDebugDraw	bool	Toggle debug drawing of goals when node is selected.	AnimNodes/AnimNode_IKRig.h	EditAnywhere Category=Solver
bStartFromRefPose	bool	Optionally ignore the input pose and start from the reference pose each solve	AnimNodes/AnimNode_IKRig.h	EditAnywhere Category=Solver
DebugScale	float	Adjust size of debug drawing.	AnimNodes/AnimNode_IKRig.h	EditAnywhere Category=Solver
Goals	TArray< FIKRigGoal >	The input goal transforms used by the IK Rig solvers.	AnimNodes/AnimNode_IKRig.h	EditAnywhere BlueprintReadWrite Category=Goal Meta=(NeverAsPin)
RigDefinitionAsset	TObjectPtr< UIKRigDefinition >	The IK rig to use to modify the incoming source pose.	AnimNodes/AnimNode_IKRig.h	EditAnywhere Category=RigDefinition Meta=(NeverAsPin)
Source	FPoseLink	The input pose to start the IK solve relative to.	AnimNodes/AnimNode_IKRig.h	EditAnywhere Category=Links

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
ActualAlpha	float		AnimNodes/AnimNode_IKRig.h
bSearchedForGoalCreators	bool		AnimNodes/AnimNode_IKRig.h
CompactPoseToRigIndices	TMap< FCompactPoseBoneIndex, int32, FDefaultSetAllocator, TCompactPoseBoneIndexMapKeyFuncs< int32 > >		AnimNodes/AnimNode_IKRig.h
GoalCreators	TArray< TObjectPtr< UActorComponent > >	A cached list of components on the owning actor that implement the goal creator interface	AnimNodes/AnimNode_IKRig.h	Transient
GoalsFromGoalCreators	TMap< FName, FIKRigGoal >		AnimNodes/AnimNode_IKRig.h	Transient
IKRigProcessor	FIKRigProcessor	IK Rig runtime processor	AnimNodes/AnimNode_IKRig.h
UpdateFunctions	TArray< PropertyUpdateFunction >		AnimNodes/AnimNode_IKRig.h

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
FIKRigProcessor * GetIKRigProcessor()		AnimNodes/AnimNode_IKRig.h
void SetProcessorNeedsInitialized()	Force reinitialization	AnimNodes/AnimNode_IKRig.h

Overridden from FAnimNode_Base

Name	Remarks	Include Path	Unreal Specifiers
virtual void CacheBones_AnyThread ( const FAnimationCacheBonesContext& Context )		AnimNodes/AnimNode_IKRig.h
virtual void Evaluate_AnyThread ( FPoseContext& Output )		AnimNodes/AnimNode_IKRig.h
virtual void GatherDebugData ( FNodeDebugData& DebugData )		AnimNodes/AnimNode_IKRig.h
virtual bool HasPreUpdate()		AnimNodes/AnimNode_IKRig.h
virtual void Initialize_AnyThread ( const FAnimationInitializeContext& Context )		AnimNodes/AnimNode_IKRig.h
virtual bool NeedsOnInitializeAnimInstance()		AnimNodes/AnimNode_IKRig.h
virtual void OnInitializeAnimInstance ( const FAnimInstanceProxy* InProxy, const UAnimInstance* InAnimInstance )		AnimNodes/AnimNode_IKRig.h
virtual void PreUpdate ( const UAnimInstance* InAnimInstance )		AnimNodes/AnimNode_IKRig.h
virtual void Update_AnyThread ( const FAnimationUpdateContext& Context )		AnimNodes/AnimNode_IKRig.h

Protected

Overridden from FAnimNode_CustomProperty

Name	Remarks	Include Path	Unreal Specifiers
virtual UClass * GetTargetClass()		AnimNodes/AnimNode_IKRig.h
virtual void InitializeProperties ( const UObject* InSourceInstance, UClass* InTargetClass )		AnimNodes/AnimNode_IKRig.h
virtual void PropagateInputProperties ( const UObject* InSourceInstance )		AnimNodes/AnimNode_IKRig.h

Navigation

Syntax

Inheritance Hierarchy

Constructors

Typedefs

Variables

Public

Protected

Functions

Public

Overridden from FAnimNode_Base

Protected

Overridden from FAnimNode_CustomProperty