1. Epic GamesDeveloper
  3. UAnimGraphNode_SkeletalControlBase

UAnimGraphNode_SkeletalControlBase

This is the base class for the 'source version' of all skeletal control animation graph nodes (nodes that manipulate the pose rather than playing animations to create a pose or blending between poses)

API > API/Editor > API/Editor/AnimGraph

Inheritance Hierarchy

References

   
Module AnimGraph
Header /Engine/Source/Editor/AnimGraph/Public/AnimGraphNode_SkeletalControlBase.h
Include #include "AnimGraphNode_SkeletalControlBase.h"

Syntax

UCLASS (Abstract)  
class UAnimGraphNode_SkeletalControlBase : public UAnimGraphNode_Base

Remarks

This is the base class for the 'source version' of all skeletal control animation graph nodes (nodes that manipulate the pose rather than playing animations to create a pose or blending between poses)

Concrete subclasses should contain a member struct derived from FAnimNode_SkeletalControlBase

Constructors

  Type Name Description
Public function  

UAnimGraphNode_SkeletalControlBase ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual int32

ChangeToNextWidgetMode ( const USkeletalMeshComponent* SkelComp,
int32 CurWidgetMode
)

 Called when the user changed widget mode by pressing "Space" key
Protected function FQuat

ConvertCSRotationToBoneSpace ( const USkeletalMeshComponent* SkelComp,
FRotator& InCSRotator,
FCSPose< FCompactHeapPose >& MeshBases,
const FName& BoneName,
const EBoneControlSpace Space
)

 Convert rotator in component space to bone space
Protected function FVector

ConvertCSVectorToBoneSpace ( const USkeletalMeshComponent* SkelComp,
FVector& InCSVector,
FCSPose< FCompactHeapPose >& MeshBases,
const FName& BoneName,
const EBoneControlSpace Space
)

 Convert drag vector in component space to bone space
Protected function Const void

ConvertToComponentSpaceTransform ( const USkeletalMeshComponent* SkelComp,
const FTransform& InTransform,
FTransform& OutCSTransform,
int32 BoneIndex,
EBoneControlSpace Space
)

 Helper functions for bone control preview local conversion function for drawing
Protected function FVector

ConvertWidgetLocation ( const USkeletalMeshComponent* InSkelComp,
FCSPose< FCompactHeapPose >& InMeshBases,
const FName& BoneName,
const FVector& InLocation,
const EBoneControlSpace Space
)

 Convert widget location according to bone control space
Public function Virtual void

CopyNodeDataFrom ( const FAnimNode_Base* NewAnimNode
)

  
Public function Virtual void

CopyNodeDataTo ( FAnimNode_Base* OutAnimNode
)

  
Public function Virtual void

DeselectActor ( USkeletalMeshComponent* SkelComp
)

 If it has select-actors, should hide all actors when de-select is called
Public function Virtual void

DoRotation ( const USkeletalMeshComponent* SkelComp,
FRotator& Rotation,
FAnimNode_Base* InOutAnimNode
)

 Called when the widget is dragged in rotation mode
Public function Virtual void

DoScale ( const USkeletalMeshComponent* SkelComp,
FVector& Scale,
FAnimNode_Base* InOutAnimNode
)

 Called when the widget is dragged in scale mode
Public function Virtual void

DoTranslation ( const USkeletalMeshComponent* SkelComp,
FVector& Drag,
FAnimNode_Base* InOutAnimNode
)

 Called when the widget is dragged in translation mode
Public function Virtual FName  
Protected function Virtual Const FText Returns the short descriptive name of the controller.
Protected function Const FAnimNode_SkeletalControlBase *  
Public function void

GetDefaultValue ( const FName PropName,
FRotator& OutValue
)

  
Public function void

GetDefaultValue ( const FName UpdateDefaultValueName,
FVector& OutVec
)

 Get literal value for vector
Protected function Virtual Const const FAnimNode_SkeletalControlBase *

GetNode ()

  
Public function ValueType

GetNodeValue ( const FName PropName,
const ValueType& CompileNodeValue
)

  
Public function Virtual Const FText  
Public function Virtual Const FText  
Public function Virtual int32

GetWidgetCoordinateSystem ( const USkeletalMeshComponent* SkelComp
)

 Returns the coordinate system that should be used for this bone
Public function Virtual FVector

GetWidgetLocation ( const USkeletalMeshComponent* SkelComp,
FAnimNode_SkeletalControlBase* AnimNode
)

 Methods related to widget control
Public function Virtual int32

GetWidgetMode ( const USkeletalMeshComponent* SkelComp
)

 Return current widget mode this anim graph node supports
Public function Virtual bool

IsActorClicked ( HActor* ActorHitProxy
)

  
Public function Const bool

IsPinShown ( const FName PinName
)

 Are we currently showing this pin
Public function Virtual void

MoveSelectActorLocation ( const USkeletalMeshComponent* SkelComp,
FAnimNode_SkeletalControlBase* InAnimNode
)

 If anim graph node needs other actors to select other bones, move actor's positions when this is called
Public function Virtual void

ProcessActorClick ( HActor* ActorHitProxy
)

  
Public function void

SetDefaultValue ( const FName InDefaultValueName,
const FVector& InValue
)

 Set literal value for FVector
Public function void

SetDefaultValue ( const FName PropName,
const FRotator& InValue
)

  
Public function void

SetNodeValue ( const FName PropName,
ValueType& CompileNodeValue,
const ValueType& InValue
)

  
Public function Virtual bool

SetWidgetMode ( const USkeletalMeshComponent* SkelComp,
int32 InWidgetMode
)

 Called when the user set widget mode directly, returns true if InWidgetMode is available
Public function Virtual Const bool  

Overridden from UAnimGraphNode_Base

  Type Name Description
Public function Virtual void Create any output pins necessary for this node.
Public function Virtual void

CustomizeDetails ( IDetailLayoutBuilder& DetailBuilder
)

 Can customize details tab
Public function Virtual Const void

CustomizePinData ( UEdGraphPin* Pin,
FName SourcePropertyName,
int32 ArrayIndex
)

 Customize pin data based on the input
Public function Virtual Const FString Gets the menu category this node belongs in.
Public function Virtual Const FLinearColor  
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual void

ValidateAnimNodePostCompile ( FCompilerResultsLog& MessageLog,
UAnimBlueprintGeneratedClass* CompiledClass,
int32 CompiledNodeIndex
)

 Gives each visual node a chance to validate that they are still valid in the context of the compiled class, giving a last shot at error or warning generation after primary compilation is finished.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page