FAnimNode_PoseDriver | Unreal Engine 5.0 Documentation

API > API/Runtime > API/Runtime/AnimGraphRuntime > API/Runtime/AnimGraphRuntime/AnimNodes

Inheritance Hierarchy

References


Module	AnimGraphRuntime
Header	/Engine/Source/Runtime/AnimGraphRuntime/Public/AnimNodes/AnimNode_PoseDriver.h
Include	#include "AnimNodes/AnimNode_PoseDriver.h"

Syntax

struct FAnimNode_PoseDriver : public FAnimNode_PoseHandler

Remarks

RBF based orientation driver

Variables

Type	Name	Description
uint8: 1	bCachedDrivenIDsAreDirty	If true, will recalculate DrivenUID values in PoseTargets array on next eval
bool	bEvalFromRefPose	Evaluate SourceBone transform relative from its Reference Pose.
bool	bHasOnlyDriveBones	Checks if there are valid bones in OnlyDriveBones, since some entries can be None
TArray< FCompactPoseBoneIndex >	BonesToFilter	This array lists bones that we should filter out (ie have a track in the PoseAsset, but are not listed in OnlyDriveBones)
bool	bSoloDrivenOnly	Only solo the driven poses, and don't move the source joint(s) to match
EPoseDriverOutput	DriveOutput	Whether we should drive poses or curves
EPoseDriverSource	DriveSource	Which part of the transform is read
FBoneReference	EvalSpaceBone	Optional other bone space to use when reading SourceBone transform.
int32	LODThreshold	Max LOD that this node is allowed to run For example if you have LODThreshold to be 2, it will run until LOD 2 (based on 0 index) when the component LOD becomes 3, it will stop update/evaluate currently transition would be issue and that has to be re-visited
TArray< FBoneReference >	OnlyDriveBones	List of bones that will modified by this node.
TArray< FRBFOutputWeight >	OutputWeights	Last set of output weights from RBF solve
TArray< FPoseDriverTarget >	PoseTargets	Targets used to compare with current pose and drive morphs/poses
FRBFParams	RBFParams	Parameters used by RBF solver
int32	SoloTargetIndex	The target to solo on, or INDEX_NONE if to use the normal weight computation.
TArray< FBoneReference >	SourceBones	Bone to use for driving parameters based on its orientation
TArray< FTransform >	SourceBoneTMs	Input source bone TM, used for debug drawing
FPoseLink	SourcePose	Bones to use for driving parameters based on their transform

Constructors

	Type	Name	Description
		FAnimNode_PoseDriver ()

Functions

Type	Name	Description
float	GetRadiusForTarget ( const FRBFTarget& Target )	Returns the radius for a given target
void	GetRBFTargets ( TArray< FRBFTarget >& OutTargets, const FBoneContainer* BoneContainer )	Return array of FRBFTarget structs, derived from PoseTargets array and DriveSource setting
bool	IsBoneDriven ( FName BoneName )	Util for seeing if BoneName is in the list of driven bones (and bFilterDrivenBones is true)

Overridden from FAnimNode_PoseHandler

	Type	Name	Description
	void	RebuildPoseList ( const FBoneContainer& InBoneContainer, const UPoseAsset* InPoseAsset )	Rebuild Pose List

Overridden from FAnimNode_AssetPlayerBase

	Type	Name	Description
	void	UpdateAssetPlayer ( const FAnimationUpdateContext& Context )	Update method for the asset player, to be implemented by derived classes

Overridden from FAnimNode_Base

Type	Name	Description
void	CacheBones_AnyThread ( const FAnimationCacheBonesContext& Context )	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.
int32	GetLODThreshold ()	Get the LOD threshold at which this node is enabled.
void	Initialize_AnyThread ( const FAnimationInitializeContext& Context )	Initialize function for setup purposes