1. Epic GamesDeveloper
  3. FAnimNode_SkeletalControlBase

FAnimNode_SkeletalControlBase

API > API/Runtime > API/Runtime/AnimGraphRuntime

   
Name FAnimNode_SkeletalControlBase
Type struct
Header File /Engine/Source/Runtime/AnimGraphRuntime/Public/BoneControllers/AnimNode_SkeletalControlBase.h
Include Path #include "BoneControllers/AnimNode_SkeletalControlBase.h"

Syntax

USTRUCT (BlueprintInternalUseOnly)  
struct FAnimNode_SkeletalControlBase : public FAnimNode_Base

Inheritance Hierarchy

Derived Classes

FAnimNode_SkeletalControlBase derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FAnimNode_SkeletalControlBase()

   BoneControllers/AnimNode_SkeletalControlBase.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FAnimNode_SkeletalControlBase()

   BoneControllers/AnimNode_SkeletalControlBase.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ActualAlpha float   BoneControllers/AnimNode_SkeletalControlBase.h
  • Transient
Alpha float Current strength of the skeletal control. BoneControllers/AnimNode_SkeletalControlBase.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Alpha
  • Meta=(PinShownByDefault)
AlphaBoolBlend FInputAlphaBoolBlend   BoneControllers/AnimNode_SkeletalControlBase.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Alpha
  • Meta=(DisplayName="Blend Settings")
AlphaCurveName FName   BoneControllers/AnimNode_SkeletalControlBase.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Alpha
  • Meta=(PinShownByDefault)
AlphaInputType EAnimAlphaInputType   BoneControllers/AnimNode_SkeletalControlBase.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Alpha
AlphaScaleBias FInputScaleBias   BoneControllers/AnimNode_SkeletalControlBase.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Alpha
AlphaScaleBiasClamp FInputScaleBiasClamp   BoneControllers/AnimNode_SkeletalControlBase.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Alpha
bAlphaBoolEnabled bool   BoneControllers/AnimNode_SkeletalControlBase.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Alpha
  • Meta=(PinShownByDefault, DisplayName="bEnabled")
ComponentPose FComponentSpacePoseLink Input link. BoneControllers/AnimNode_SkeletalControlBase.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Links
ForwardedPose FCSPose< FCompactHeapPose > Forwarded pose data from the wired node which current node's skeletal control is not applied yet BoneControllers/AnimNode_SkeletalControlBase.h  
LODThreshold int32 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 BoneControllers/AnimNode_SkeletalControlBase.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Performance
  • Meta=(PinHiddenByDefault, DisplayName="LOD Threshold")

Protected

Name Type Remarks Include Path Unreal Specifiers
BoneTransforms TArray< FBoneTransform > Resused bone transform array to avoid reallocating in skeletal controls. BoneControllers/AnimNode_SkeletalControlBase.h  
ValidationVisualWarningMessage FText   BoneControllers/AnimNode_SkeletalControlBase.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddBoneRefMissingVisualWarning ( const FString& BoneName,
const FString& SkeletalMeshName
)

 Visual warnings are shown on the node but not logged as an error for build system, use with care The warnigns are cleared at CacheBones_AnyThread and should be added during InitializeBoneReferences BoneControllers/AnimNode_SkeletalControlBase.h  

void AddValidationVisualWarning ( FText ValidationVisualWarning
)

   BoneControllers/AnimNode_SkeletalControlBase.h  

void ClearValidationVisualWarnings()

   BoneControllers/AnimNode_SkeletalControlBase.h  

float GetAlpha()

 Get the alpha of this node. BoneControllers/AnimNode_SkeletalControlBase.h  

FText GetValidationVisualWarningMessage()

   BoneControllers/AnimNode_SkeletalControlBase.h  

bool HasValidationVisualWarnings()

   BoneControllers/AnimNode_SkeletalControlBase.h  

void InitializeAndValidateBoneRef ( FBoneReference& BoneRef,
const FBoneContainer& RequiredBones
)

   BoneControllers/AnimNode_SkeletalControlBase.h  

void SetAlpha ( float InAlpha
)

 Set the alpha of this node. BoneControllers/AnimNode_SkeletalControlBase.h  

Overridden from FAnimNode_Base

Name Remarks Include Path Unreal Specifiers

virtual void CacheBones_AnyThread ( const FAnimationCacheBonesContext& Context
)

   BoneControllers/AnimNode_SkeletalControlBase.h  

virtual void EvaluateComponentSpace_AnyThread ( FComponentSpacePoseContext& Output
)

   BoneControllers/AnimNode_SkeletalControlBase.h  

virtual int32 GetLODThreshold()

   BoneControllers/AnimNode_SkeletalControlBase.h  

virtual void Initialize_AnyThread ( const FAnimationInitializeContext& Context
)

   BoneControllers/AnimNode_SkeletalControlBase.h  

virtual void Update_AnyThread ( const FAnimationUpdateContext& Context
)

   BoneControllers/AnimNode_SkeletalControlBase.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AddDebugNodeData ( FString& OutDebugData
)

 Allow base to add info to the node debug output BoneControllers/AnimNode_SkeletalControlBase.h  

virtual void EvaluateComponentPose_AnyThread ( FComponentSpacePoseContext& Output
)

 Evaluate incoming component pose. BoneControllers/AnimNode_SkeletalControlBase.h  

virtual void EvaluateComponentSpaceInternal ( FComponentSpacePoseContext& Context
)

 Use this function to evaluate for skeletal control base BoneControllers/AnimNode_SkeletalControlBase.h  

virtual void EvaluateSkeletalControl_AnyThread ( FComponentSpacePoseContext& Output,
TArray< FBoneTransform >& OutBoneTransforms
)

 Evaluate the new component-space transforms for the affected bones. BoneControllers/AnimNode_SkeletalControlBase.h  

virtual void InitializeBoneReferences ( const FBoneContainer& RequiredBones
)

 Initialize any bone references you have BoneControllers/AnimNode_SkeletalControlBase.h  

virtual bool IsValidToEvaluate ( const USkeleton* Skeleton,
const FBoneContainer& RequiredBones
)

 Return true if it is valid to Evaluate BoneControllers/AnimNode_SkeletalControlBase.h  

virtual void UpdateComponentPose_AnyThread ( const FAnimationUpdateContext& Context
)

 Update incoming component pose. BoneControllers/AnimNode_SkeletalControlBase.h  

virtual void UpdateInternal ( const FAnimationUpdateContext& Context
)

 Interface for derived skeletal controls to implement use this function to update for skeletal control base BoneControllers/AnimNode_SkeletalControlBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page