Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FAnimNode_PoseDriver

RBF based orientation driver

Windows

MacOS

Linux

Inheritance Hierarchy

FAnimNode_Base

FAnimNode_AssetPlayerBase

FAnimNode_PoseHandler

FAnimNode_PoseDriver

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

	Name	Description
uint8: 1	bCachedDrivenIDsAreDirty	If true, will recalculate DrivenUID values in PoseTargets array on next eval
TArray< FCompac...	BonesToFilter	If bFilterDrivenBones, this array lists bones that we should filter out (ie have a track in the PoseAsset, but are not listed in OnlyDriveBones
uint8: 1	bOnlyDriveSelectedBones	If we should filter bones to be driven using the DrivenBonesFilter array
EPoseDriverOutp...	DriveOutput	Whether we should drive poses or curves
EPoseDriverSour...	DriveSource	Which part of the transform is read
FBoneReference	EvalSpaceBone	Optional other bone space to use when reading SourceBone transform.
TArray< FBoneRe...	OnlyDriveBones	If bFilterDrivenBones is specified, only these bones will be modified by this node
TArray< FRBFOut...	OutputWeights	Last set of output weights from RBF solve
TArray< FPoseDr...	PoseTargets	Targets used to compare with current pose and drive morphs/poses
FRBFParams	RBFParams	Parameters used by RBF solver
TArray< FBoneRe...	SourceBones	Bone to use for driving parameters based on its orientation
TArray< FTransf...	SourceBoneTMs	Input source bone TM, used for debug drawing
FPoseLink	SourcePose	Bones to use for driving parameters based on their transform

Constructors

	Name	Description
	FAnimNode_PoseDriver()

Functions

	Name	Description
float	GetRadiusForTarget ( const FRBFTarget& Target )	Returns the radius for a given target
void	GetRBFTargets ( TArray< FRBFTarget >& OutTargets )	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

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

Overridden from FAnimNode_AssetPlayerBase

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

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.
void	Initialize_AnyThread ( const FAnimationInitializeContext&... )	Initialize function for setup purposes

Deprecated Variables

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss