1. Epic GamesDeveloper
  3. UAnimGraphNode_Base

UAnimGraphNode_Base

This is the base class for any animation graph nodes that generate or consume an animation pose in the animation blend graph.

API > API/Editor > API/Editor/AnimGraph

This is the base class for any animation graph nodes that generate or consume an animation pose in the animation blend graph.

Any concrete implementations will be paired with a runtime graph node derived from FAnimNode_Base

   
Name UAnimGraphNode_Base
Type class
Header File /Engine/Source/Editor/AnimGraph/Public/AnimGraphNode_Base.h
Include Path #include "AnimGraphNode_Base.h"

Syntax

UCLASS (Abstract, BlueprintType)  
class UAnimGraphNode_Base : public UK2Node

Inheritance Hierarchy

Derived Classes

UAnimGraphNode_Base derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UAnimGraphNode_Base ( const FObjectInitializer& ObjectInitializer
)

   AnimGraphNode_Base.h  

Classes

Name Remarks
FOnNodePropertyChangedEvent Event that observers can bind to so that they are notified about changes made to this node through the property system
FOnNodeTitleChangedEvent Event that is broadcast to inform observers that the node title has changed The default SAnimationGraphNode uses this to invalidate cached node title text
FPinVisibilityChangedEvent Event that observers can bind to so that they are notified about changes to pin visibility.

Structs

Name Remarks
FAnimPropertyBindingWidgetArgs Arguments used to construct a property binding widget.

Typedefs

Name Type Remarks Include Path
FNodeAttributeArray TArray< FName, TInlineAllocator< 4 > >   AnimGraphNode_Base.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AlwaysDynamicProperties TSet< FName > Properties marked as always dynamic, so they can be set externally AnimGraphNode_Base.h  
BecomeRelevantFunction FMemberReference Function called when the node becomes relevant, meaning it goes from having no weight to any weight. AnimGraphNode_Base.h
  • EditAnywhere
  • Category=Functions
  • Meta=(FunctionReference, AllowFunctionLibraries, PrototypeFunction="/Script/AnimGraphRuntime.AnimExecutionContextLibrary.Prototype_ThreadSafeAnimUpdateCall", DefaultBindingName="OnBecomeRelevant")
  • DisplayName="On Become Relevant"
BlueprintUsage EBlueprintUsage   AnimGraphNode_Base.h
  • Transient
InitialUpdateFunction FMemberReference Function called before the node is updated for the first time. AnimGraphNode_Base.h
  • EditAnywhere
  • Category=Functions
  • Meta=(FunctionReference, AllowFunctionLibraries, PrototypeFunction="/Script/AnimGraphRuntime.AnimExecutionContextLibrary.Prototype_ThreadSafeAnimUpdateCall", DefaultBindingName="OnInitialUpdate")
  • DisplayName="On Initial Update"
ShowPinForProperties TArray< FOptionalPinFromProperty >   AnimGraphNode_Base.h
  • EditAnywhere
  • Category=PinOptions
  • EditFixedSize
UpdateFunction FMemberReference Function called when the node is updated. AnimGraphNode_Base.h
  • EditAnywhere
  • Category=Functions
  • Meta=(FunctionReference, AllowFunctionLibraries, PrototypeFunction="/Script/AnimGraphRuntime.AnimExecutionContextLibrary.Prototype_ThreadSafeAnimUpdateCall", DefaultBindingName="OnUpdate")
  • DisplayName="On Update"

Protected

Name Type Remarks Include Path Unreal Specifiers
Binding TObjectPtr< UAnimGraphNodeBinding > Bindings for pins that this node exposes. AnimGraphNode_Base.h
  • EditAnywhere
  • Instanced
  • Category=Bindings
Tag FName Optional reference tag name. If this is set then this node can be referenced from elsewhere in this animation blueprint using an anim node reference. AnimGraphNode_Base.h
  • EditAnywhere
  • Category=Tag

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void BakeDataDuringCompilation ( FCompilerResultsLog& MessageLog
)

 Gives each visual node a chance to update the node template before it is inserted in the compiled class. AnimGraphNode_Base.h  

virtual void CopyNodeDataToPreviewNode ( FAnimNode_Base* InPreviewNode
)

 Called to propagate data from the internal node to the preview in Persona. AnimGraphNode_Base.h  

virtual void CopyPinDefaultsToNodeData ( UEdGraphPin* InPin
)

 Called after editing a default value to update internal node from pin defaults. AnimGraphNode_Base.h  

virtual void CreateOutputPins()

 Create any output pins necessary for this node. AnimGraphNode_Base.h  

virtual void CustomizeDetails ( IDetailLayoutBuilder& DetailBuilder
)

 Can customize details tab AnimGraphNode_Base.h  

virtual void CustomizePinData ( UEdGraphPin* Pin,
FName SourcePropertyName,
int32 ArrayIndex
) const

 Customize pin data based on the input AnimGraphNode_Base.h  

virtual bool DoesSupportTimeForTransitionGetter()

 BEGIN Interface to support transition getter if you return true for DoesSupportExposeTimeForTransitionGetter you should implement all below functions AnimGraphNode_Base.h  

virtual void Draw ( FPrimitiveDrawInterface* PDI,
USkeletalMeshComponent* PreviewSkelMeshComp,
const bool bIsSelected,
const bool bIsPoseWatchEnabled
) const

 Draw function called on nodes that are selected and / or have a pose watch enabled. AnimGraphNode_Base.h  

virtual void Draw ( FPrimitiveDrawInterface* PDI,
USkeletalMeshComponent* PreviewSkelMeshComp
) const

 Draw function for supporting visualization. AnimGraphNode_Base.h  

virtual void DrawCanvas ( FViewport& InViewport,
FSceneView& View,
FCanvas& Canvas,
USkeletalMeshComponent* PreviewSkelMeshComp
) const

 Canvas draw function to draw to viewport. AnimGraphNode_Base.h  

FAnimNode_Base * FindDebugAnimNode ( USkeletalMeshComponent* PreviewSkelMeshComp
) const

 Try to find the preview node instance for this anim graph node AnimGraphNode_Base.h  

NodeType * GetActiveInstanceNode ( UObject* AnimInstanceObject
) const

   AnimGraphNode_Base.h  

virtual void GetAllAnimationSequencesReferred ( TArray< UAnimationAsset* >& AnimAssets
) const

 Populate the supplied arrays with the currently reffered to animation assets. AnimGraphNode_Base.h  

virtual UAnimationAsset * GetAnimationAsset()

   AnimGraphNode_Base.h  

virtual TSubclassOf< UAnimationAsset > GetAnimationAssetClass()

   AnimGraphNode_Base.h  

UAnimBlueprint * GetAnimBlueprint()

 Get the animation blueprint to which this node belongs AnimGraphNode_Base.h  

const UAnimGraphNodeBinding * GetBinding()

 Get the bindings for this node. AnimGraphNode_Base.h  

virtual void GetBoundFunctionsInfo ( TArray< TPair< FName, FName > >& InOutBindingsInfo
)

 Gets editor information for all the bound anim node functions (category metadata string, member variable's name) Used by SAnimGraphNode to display all bound functions of an anim node. AnimGraphNode_Base.h  
Get the currently-debugged runtime anim node (in the anim BP debugger that this node is currently being edited in) AnimGraphNode_Base.h  

TNodeType * GetDebuggedAnimNode ()

 Get the currently-debugged runtime anim node of a specified type (in the anim BP debugger that this node is currently being edited in) AnimGraphNode_Base.h  

virtual FEditorModeID GetEditorMode()

 Override this function to push an editor mode when this node is selected AnimGraphNode_Base.h  

FAnimNode_Base * GetFNode()

 Get the runtime anim node that we template. AnimGraphNode_Base.h  

FStructProperty * GetFNodeProperty()

 Gets the animation FNode property represented by this ed graph node. AnimGraphNode_Base.h  

UScriptStruct * GetFNodeType()

 Gets the animation FNode type represented by this ed graph node. AnimGraphNode_Base.h  

virtual void GetInputLinkAttributes ( FNodeAttributeArray& OutAttributes
) const

 Get the named attribute types that this node takes (absorbs) as inputs. Other attributes are assumed to 'pass through' this node. AnimGraphNode_Base.h  

UAnimGraphNodeBinding * GetMutableBinding()

 Get the mutable bindings for this node. AnimGraphNode_Base.h  

virtual FString GetNodeCategory()

 Gets the menu category this node belongs in. AnimGraphNode_Base.h  

virtual void GetOnScreenDebugInfo ( TArray< FText >& DebugInfo,
FAnimNode_Base* RuntimeAnimNode,
USkeletalMeshComponent* PreviewSkelMeshComp
) const

 Function to collect strings from nodes to display in the viewport. AnimGraphNode_Base.h  

virtual void GetOutputLinkAttributes ( FNodeAttributeArray& OutAttributes
) const

 Get the named attribute types that this node provides as outputs. Other attributes are assumed to 'pass through' this node. AnimGraphNode_Base.h  

virtual FProperty * GetPinProperty ( FName InPinName
) const

   AnimGraphNode_Base.h  

FProperty * GetPinProperty ( const UEdGraphPin* InPin
) const

 Get the property corresponding to a pin. For array element pins returns the outer array property. Returns null if a property cannot be found. AnimGraphNode_Base.h  
Some anim graph nodes can act as proxies to outer nodes (e.g. sink nodes in nested graphs). AnimGraphNode_Base.h  

FName GetTag()

 Get the tag for this node, if any. AnimGraphNode_Base.h  

virtual const TCHAR * GetTimePropertyName()

   AnimGraphNode_Base.h  

virtual UScriptStruct * GetTimePropertyStruct()

   AnimGraphNode_Base.h  

void HandleAnimReferenceCollection ( UAnimationAsset* AnimAsset,
TArray< UAnimationAsset* >& AnimationAssets
) const

 Helper function for GetAllAnimationSequencesReferred. AnimGraphNode_Base.h  

void HandleAnimReferenceReplacement ( TObjectPtr< AssetType >& OriginalAsset,
const TMap< UAnimationAsset*, UAnimationAsset* >& AnimAssetReplacementMap
)

   AnimGraphNode_Base.h  

void HandleAnimReferenceReplacement ( AssetType*& OriginalAsset,
const TMap< UAnimationAsset*, UAnimationAsset* >& AnimAssetReplacementMap
)

 Helper function for ReplaceReferredAnimations AnimGraphNode_Base.h  

virtual bool HasBinding ( FName InPropertyName
) const

 Check whether the specified property is bound via PropertyBindings. AnimGraphNode_Base.h  

virtual bool IsPinBindable ( const UEdGraphPin* InPin
) const

 Check whether the named pin is bindable. AnimGraphNode_Base.h  

bool IsPinExposedAndBound ( const FString& InPinName,
const EEdGraphPinDirection InDirection
) const

 Helper function to check whether a pin is valid and bound via property access AnimGraphNode_Base.h  

bool IsPinExposedAndLinked ( const FString& InPinName,
const EEdGraphPinDirection Direction
) const

 Helper function to check whether a pin is valid and linked to something else in the graph AnimGraphNode_Base.h  

bool IsPinUnlinkedUnboundAndUnset ( const FString& InPinName,
const EEdGraphPinDirection InDirection
) const

 Helper function to check whether a pin is not linked, not bound via property access and still has its default value AnimGraphNode_Base.h  

virtual bool IsPoseWatchable()

 Whether or not you can add a pose watch on this node. AnimGraphNode_Base.h  

virtual bool IsSinkNode()

 Is this node a sink that has no pose outputs? AnimGraphNode_Base.h  

FOnNodePropertyChangedEvent & OnNodePropertyChanged()

   AnimGraphNode_Base.h  

virtual void OnNodeSelected ( bool bInIsSelected,
FEditorModeTools& InModeTools,
FAnimNode_Base* InRuntimeNode
)

 Selection notification callback. AnimGraphNode_Base.h  

FOnNodeTitleChangedEvent & OnNodeTitleChangedEvent()

   AnimGraphNode_Base.h  

FPinVisibilityChangedEvent & OnPinVisibilityChanged()

   AnimGraphNode_Base.h  

virtual void OnPoseWatchChanged ( const bool IsPoseWatchEnabled,
TObjectPtr< class UPoseWatch > InPoseWatch,
FEditorModeTools& InModeTools,
FAnimNode_Base* InRuntimeNode
)

 Pose Watch change notification callback. AnimGraphNode_Base.h  
Refreshes the debugged component post-edit. AnimGraphNode_Base.h  

virtual void PostProcessPinName ( const UEdGraphPin* Pin,
FString& DisplayName
) const

 Give the node a chance to change the display name of a pin. AnimGraphNode_Base.h  

bool RedirectBinding ( FName OldPropertyBindingName,
FName NewPropertyBindingName
)

 Update the property binding name. AnimGraphNode_Base.h  

void RemoveBindings ( FName InBindingName
)

 Remove any bindings for the specified name. AnimGraphNode_Base.h  

virtual void ReplaceReferredAnimations ( const TMap< UAnimationAsset*, UAnimationAsset* >& AnimAssetReplacementMap
)

 Replace references to animations that exist in the supplied maps AnimGraphNode_Base.h  

void SetPinVisibility ( bool bInVisible,
int32 InOptionalPinIndex
)

 Sets the visibility of the specified pin, reconstructs the node if it changes. AnimGraphNode_Base.h  

void SetTag ( FName InTag
)

 Set the tag for this node. AnimGraphNode_Base.h  

virtual bool ShouldShowAttributesOnPins()

   AnimGraphNode_Base.h  

virtual EAnimAssetHandlerType SupportsAssetClass ( const UClass* AssetClass
) const

 Returns whether this node supports the supplied asset class AnimGraphNode_Base.h  

virtual bool UsingCopyPoseFromMesh()

 If using CopyPoseFromMesh, the AnimBlueprint Compiler will cache this off for optimizations. AnimGraphNode_Base.h  

virtual void ValidateAnimNodeDuringCompilation ( USkeleton* ForSkeleton,
FCompilerResultsLog& MessageLog
)

 Gives each visual node a chance to do final validation before it's node is harvested for use at runtime. AnimGraphNode_Base.h  

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. AnimGraphNode_Base.h  

Overridden from UK2Node

Name Remarks Include Path Unreal Specifiers

virtual bool CanPlaceBreakpoints()

   AnimGraphNode_Base.h  

virtual void ExpandNode ( FKismetCompilerContext& CompilerContext,
UEdGraph* SourceGraph
)

   AnimGraphNode_Base.h  

virtual void GetMenuActions ( FBlueprintActionDatabaseRegistrar& ActionRegistrar
) const

   AnimGraphNode_Base.h  

virtual FText GetMenuCategory()

   AnimGraphNode_Base.h  

virtual void GetNodeAttributes ( TArray< TKeyValuePair< FString, FString > >& OutNodeAttributes
) const

   AnimGraphNode_Base.h  

virtual void HandleFunctionRenamed ( UBlueprint* InBlueprint,
UClass* InFunctionClass,
UEdGraph* InGraph,
const FName& InOldFuncName,
const FName& InNewFuncName
)

   AnimGraphNode_Base.h  

virtual void HandleVariableRenamed ( UBlueprint* InBlueprint,
UClass* InVariableClass,
UEdGraph* InGraph,
const FName& InOldVarName,
const FName& InNewVarName
)

   AnimGraphNode_Base.h  

virtual bool NodeCausesStructuralBlueprintChange()

   AnimGraphNode_Base.h  

virtual void ReallocatePinsDuringReconstruction ( TArray< UEdGraphPin* >& OldPins
)

   AnimGraphNode_Base.h  

virtual bool ReferencesFunction ( const FName& InFunctionName,
const UStruct* InScope
) const

   AnimGraphNode_Base.h  

virtual bool ReferencesVariable ( const FName& InVarName,
const UStruct* InScope
) const

   AnimGraphNode_Base.h  

virtual void ReplaceReferences ( UBlueprint* InBlueprint,
UBlueprint* InReplacementBlueprint,
const FMemberReference& InSource,
const FMemberReference& InReplacement
)

   AnimGraphNode_Base.h  

virtual bool ShouldShowNodeProperties()

   AnimGraphNode_Base.h  

Overridden from UEdGraphNode

Name Remarks Include Path Unreal Specifiers

virtual void AddPinSearchMetaDataInfo ( const UEdGraphPin* Pin,
TArray< struct FSearchTagDataPair >& OutTaggedMetaData
) const

   AnimGraphNode_Base.h  

virtual void AddSearchMetaDataInfo ( TArray< struct FSearchTagDataPair >& OutTaggedMetaData
) const

   AnimGraphNode_Base.h  

virtual void AllocateDefaultPins()

   AnimGraphNode_Base.h  

virtual void AutowireNewNode ( UEdGraphPin* FromPin
)

   AnimGraphNode_Base.h  

virtual bool CanCreateUnderSpecifiedSchema ( const UEdGraphSchema* DesiredSchema
) const

   AnimGraphNode_Base.h  

virtual bool CanJumpToDefinition()

   AnimGraphNode_Base.h  

virtual void DestroyNode()

   AnimGraphNode_Base.h  

virtual FString GetDocumentationLink()

   AnimGraphNode_Base.h  

virtual UObject * GetJumpTargetForDoubleClick()

 By default return any animation assets we have. AnimGraphNode_Base.h  

virtual FLinearColor GetNodeTitleColor()

   AnimGraphNode_Base.h  

virtual void GetPinHoverText ( const UEdGraphPin& Pin,
FString& HoverTextOut
) const

   AnimGraphNode_Base.h  

virtual FString GetPinMetaData ( FName InPinName,
FName InKey
)

   AnimGraphNode_Base.h  

virtual void JumpToDefinition()

   AnimGraphNode_Base.h  

virtual void PinConnectionListChanged ( UEdGraphPin* Pin
)

   AnimGraphNode_Base.h  

virtual void PinDefaultValueChanged ( UEdGraphPin* Pin
)

   AnimGraphNode_Base.h  

virtual void PostPasteNode()

   AnimGraphNode_Base.h  

virtual void PostPlacedNewNode()

   AnimGraphNode_Base.h  

virtual void ReconstructNode()

   AnimGraphNode_Base.h  

virtual bool ShowPaletteIconOnNode()

   AnimGraphNode_Base.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   AnimGraphNode_Base.h  

virtual void PostEditUndo()

   AnimGraphNode_Base.h  

virtual void PreEditChange ( FProperty* PropertyAboutToChange
)

   AnimGraphNode_Base.h  

virtual void Serialize ( FArchive& Ar
)

   AnimGraphNode_Base.h  

Protected

Name Remarks Include Path Unreal Specifiers

void CopyTermDefaultsToDefaultObject ( IAnimBlueprintCopyTermDefaultsContext& InCompilationContext,
IAnimBlueprintNodeCopyTermDefaultsContext& InPerNodeContext,
IAnimBlueprintGeneratedClassCompiledData& OutCompiledData
)

 Copy this node's data during the last phase of compilation where term defaults are copied to the new CDO. AnimGraphNode_Base.h  

virtual void CreateCustomPins ( TArray< UEdGraphPin* >* OldPins
)

 Override point to create custom pins AnimGraphNode_Base.h  

virtual void CreatePinsForPoseLink ( FProperty* PoseProperty,
int32 ArrayIndex
)

 This will be called when a pose link is found, and can be called with PoseProperty being either of: AnimGraphNode_Base.h  

void EnsureBindingsArePresent()

 Create the bindings subobject if required. AnimGraphNode_Base.h  

virtual FPoseLinkMappingRecord GetLinkIDLocation ( const UScriptStruct* NodeType,
UEdGraphPin* InputLinkPin
)

   AnimGraphNode_Base.h  

UObject * GetObjectBeingDebugged()

   AnimGraphNode_Base.h  

virtual void GetPinAssociatedProperty ( const UScriptStruct* NodeType,
const UEdGraphPin* InputPin,
FProperty*& OutProperty,
int32& OutIndex
) const

 Get the property (and possibly array index) associated with the supplied pin AnimGraphNode_Base.h  

virtual bool GetPinBindingInfo ( FName InPinName,
FName& OutBindingName,
FProperty*& OutPinProperty,
int32& OutOptionalPinIndex
) const

 Get the pin binding info for the supplied pin AnimGraphNode_Base.h  

virtual void GetRequiredExtensions ( TArray< TSubclassOf< UAnimBlueprintExtension > >& OutExtensions
) const

 Get the extension types that this node type holds on the anim blueprint. Some extension types are always requested by the system. AnimGraphNode_Base.h  

void InternalPinCreation ( TArray< UEdGraphPin* >* OldPins
)

 Allocates or reallocates pins. AnimGraphNode_Base.h  

virtual void OnCopyTermDefaultsToDefaultObject ( IAnimBlueprintCopyTermDefaultsContext& InCompilationContext,
IAnimBlueprintNodeCopyTermDefaultsContext& InPerNodeContext,
IAnimBlueprintGeneratedClassCompiledData& OutCompiledData
)

 Override point for CopyTermDefaultsToDefaultObject Copy this node's data during the last phase of compilation where term defaults are copied to the new CDO AnimGraphNode_Base.h  

virtual void OnOverrideAssets ( IAnimBlueprintNodeOverrideAssetsContext& InContext
) const

 Override point for OverrideAssets. AnimGraphNode_Base.h  

virtual void OnProcessDuringCompilation ( IAnimBlueprintCompilationContext& InCompilationContext,
IAnimBlueprintGeneratedClassCompiledData& OutCompiledData
)

 Process this node's data during compilation (override point) AnimGraphNode_Base.h  

void OverrideAssets ( IAnimBlueprintNodeOverrideAssetsContext& InContext
) const

 Called to override the assets held on a runtime anim node. Implements per-node logic for child anim blueprints. AnimGraphNode_Base.h  

void ProcessDuringCompilation ( IAnimBlueprintCompilationContext& InCompilationContext,
IAnimBlueprintGeneratedClassCompiledData& OutCompiledData
)

 Process this node's data during compilation. AnimGraphNode_Base.h  

void RecalculateBindingType ( FAnimGraphNodePropertyBinding& InBinding
)

 Helper function used to refresh the type of a binding. AnimGraphNode_Base.h  

void SetTagInternal ( FName InTag
)

 Set the tag for this node but without regenerating any BP data for tagging. AnimGraphNode_Base.h  

virtual bool ShouldCreateStructEvalHandlers()

 Whether this node should create BP evaluation handlers as part of compilation. AnimGraphNode_Base.h  

void ValidateFunctionRef ( FName InPropertyName,
const FMemberReference& InRef,
const FText& InFunctionName,
FCompilerResultsLog& MessageLog
)

 Helper function used to validate anim node function references AnimGraphNode_Base.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool IsPotentiallyBoundFunction ( const FMemberReference& FunctionReference
)

 Check if a specified function reference appears to be valid by inspecting only the validity of the name and guid. AnimGraphNode_Base.h  

static TSharedRef< SWidget > MakePropertyBindingWidget ( const FAnimPropertyBindingWidgetArgs& InArgs
)

 Make a property binding widget to edit the bindings of the passed-in nodes. AnimGraphNode_Base.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
PropertyBindings_DEPRECATED TMap< FName, FAnimGraphNodePropertyBinding > Map from property name->binding info AnimGraphNode_Base.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page