1. Epic GamesDeveloper
  3. FAnimNode_SkeletalControlBase

FAnimNode_SkeletalControlBase

API > API/Runtime > API/Runtime/AnimGraphRuntime > API/Runtime/AnimGraphRuntime/BoneControllers

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

  Type Name Description
Public variable float ActualAlpha  
Public variable float Alpha Current strength of the skeletal control.
Public variable FInputAlphaBoolBlend AlphaBoolBlend  
Public variable FName AlphaCurveName  
Public variable EAnimAlphaInputType AlphaInputType  
Public variable FInputScaleBias AlphaScaleBias  
Public variable FInputScaleBiasClamp AlphaScaleBiasClamp  
Public variable bool bAlphaBoolEnabled  
Public variable FComponentSpacePoseLink ComponentPose Input link.
Public variable FCSPose< FCompactHeapPose > ForwardedPose Forwarded pose data from the wired node which current node's skeletal control is not applied yet
Public variable 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

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function 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
Protected function void

AddDebugNodeData ( FString& OutDebugData
)

 Allow base to add info to the node debug output
Public function void

AddValidationVisualWarning ( FText ValidationVisualWarning
)

  
Public function void  
Protected function Virtual void Evaluate incoming component pose.
Protected function Virtual void Use this function to evaluate for skeletal control base
Protected function Virtual void Evaluate the new component-space transforms for the affected bones.
Public function Const float Get the alpha of this node.
Public function Const FText  
Public function Const bool  
Public function void

InitializeAndValidateBoneRef ( FBoneReference& BoneRef,
const FBoneContainer& RequiredBones
)

  
Protected function Virtual void

InitializeBoneReferences ( const FBoneContainer& RequiredBones
)

 Initialize any bone references you have
Protected function Virtual bool

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

 Return true if it is valid to Evaluate
Public function void

SetAlpha ( float InAlpha
)

 Set the alpha of this node.
Protected function Virtual void Update incoming component pose.
Protected function Virtual void Interface for derived skeletal controls to implement use this function to update for skeletal control base

Overridden from FAnimNode_Base

  Type Name Description
Public function Virtual void Called to cache any bones that this node needs to track (e.g. in a FBoneReference).
Public function Virtual void Called to evaluate component-space bone transforms according to the weights set up in Update().
Public function Virtual Const int32 Get the LOD threshold at which this node is enabled.
Public function Virtual void Called when the node first runs.
Public function Virtual void Called to update the state of the graph relative to this node.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page