FAnimNode_IKRig

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FAnimNode_Base

FAnimNode_CustomProperty

FAnimNode_IKRig

References

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

Syntax

USTRUCT(BlueprintInternalUseOnly)
struct FAnimNode_IKRig : public FAnimNode_CustomProperty

Variables

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

Constructors

	Name	Description
	FAnimNode_IKRig()

Functions

		Name	Description
	void	SetProcessorNeedsInitialized()	Force reinitialization

Overridden from FAnimNode_CustomProperty

	Name	Description
UClass *	GetTargetClass()	Get Target Class
void	InitializeProperties ( const UObject* InSourceInstanc..., UClass* InTargetClass )	Initialize property links from the source instance, in this case AnimInstance Compiler creates those properties during compile time
void	PropagateInputProperties ( const UObject* InSourceInstanc... )	Propagate the Source Instances' properties to Target Instance

Overridden from FAnimNode_Base

	Name	Description
void	CacheBones_AnyThread ( const FAnimationCacheBonesContext&... )	Called to cache any bones that this node needs to track (e.g. in a FBoneReference).
void	Evaluate_AnyThread ( FPoseContext& Output )	Called to evaluate local-space bones transforms according to the weights set up in Update().
void	GatherDebugData ( FNodeDebugData& DebugData )	Called to gather on-screen debug data. This is called on the game thread.
bool	HasPreUpdate()	Override this to indicate that PreUpdate() should be called on the game thread (usually to gather non-thread safe data) before Update() is called.
void	Initialize_AnyThread ( const FAnimationInitializeContext&... )	Called when the node first runs.
bool	NeedsOnInitializeAnimInstance()	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.
void	OnInitializeAnimInstance ( const FAnimInstanceProxy* InPr..., const UAnimInstance* InAnimIns... )	Called once, from game thread as the parent anim instance is created
void	PreUpdate ( const UAnimInstance* InAnimIns... )	Override this to perform game-thread work prior to non-game thread Update() being called
void	Update_AnyThread ( const FAnimationUpdateContext& Con... )	Called to update the state of the graph relative to this node.

Typedefs

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