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_SkeletalControlBase

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module	AnimGraphRuntime
Header	/Engine/Source/Runtime/AnimGraphRuntime/Public/BoneControllers/AnimNode_SkeletalControlBase.h
Include	#include "BoneControllers/AnimNode_SkeletalControlBase.h"

Syntax

struct FAnimNode_SkeletalControlBase : public FAnimNode_Base

Variables

	Name	Description
float	ActualAlpha
float	Alpha	Current strength of the skeletal control.
FInputAlphaBool...	AlphaBoolBlend
FName	AlphaCurveName
EAnimAlphaInput...	AlphaInputType
FInputScaleBias	AlphaScaleBias
FInputScaleBias...	AlphaScaleBiasClamp
bool	bAlphaBoolEnabled
FComponentSpace...	ComponentPose	Input link.
FCSPose< FCompa...	ForwardedPose	Forwarded pose data from the wired node which current node's skeletal control is not applied yet
int32	LODThreshold	Max LOD that this node is allowed to run For example if you have LODThreadhold 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

Constructors

	Name	Description
	FAnimNode_SkeletalControlBase()

Functions

	Name	Description
void	AddDebugNodeData ( FString& OutDebugData )	Allow base to add info to the node debug output
void	EvaluateComponentPose_AnyThread ( FComponentSpacePoseContext& Output )	Evaluate incoming component pose.
void	EvaluateComponentSpaceInternal ( FComponentSpacePoseContext& Contex... )	Use this function to evaluate for skeletal control base
void	EvaluateSkeletalControl_AnyThread ( FComponentSpacePoseContext& Output, TArray< FBoneTransform >& OutBoneT... )	Evaluate the new component-space transforms for the affected bones.
float	GetAlpha()	Get the alpha of this node.
void	InitializeBoneReferences ( const FBoneContainer& RequiredBone... )	Initialize any bone references you have
bool	IsValidToEvaluate ( const USkeleton* Skeleton, const FBoneContainer& RequiredBone... )	Return true if it is valid to Evaluate
void	SetAlpha ( float InAlpha )	Set the alpha of this node.
void	UpdateComponentPose_AnyThread ( const FAnimationUpdateContext& Con... )	Update incoming component pose.
void	UpdateInternal ( const FAnimationUpdateContext& Con... )	Interface for derived skeletal controls to implement use this function to update for skeletal control base

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	EvaluateComponentSpace_AnyThread ( FComponentSpacePoseContext& Output )	Called to evaluate component-space bone transforms according to the weights set up in Update().
int32	GetLODThreshold()	Get the LOD threshold at which this node is enabled.
void	Initialize_AnyThread ( const FAnimationInitializeContext&... )	Called when the node first runs.
void	Update_AnyThread ( const FAnimationUpdateContext& Con... )	Called to update the state of the graph relative to this node.

Deprecated Functions

		Name	Description
	void	EvaluateBoneTransforms ( USkeletalMeshComponent* SkelCo..., FCSPose< FCompactPose >& MeshBases, TArray< FBoneTransform >& OutBoneT... )	Please use EvaluateSkeletalControl_AnyThread.