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.

Unreal Engine C++ API Reference > Editor > AnimGraph

Inheritance Hierarchy

References

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

Syntax

UCLASS (Abstract, BlueprintType)  
class UAnimGraphNode_Base : public UK2Node

Remarks

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

Variables

  Type Name Description
Public variable UProperty TSet< FName > AlwaysDynamicProperties Properties marked as always dynamic, so they can be set externally
Public variable UProperty Category, EditAnywhere, Meta displayname FMemberReference BecomeRelevantFunction Function called when the node becomes relevant, meaning it goes from having no weight to any weight.
Public variable UProperty Transient EBlueprintUsage BlueprintUsage  
Public variable UProperty Category, EditAnywhere, Meta displayname FMemberReference InitialUpdateFunction Function called before the node is updated for the first time.
Protected variable FOnNodeTitleChangedEvent NodeTitleChangedEvent  
Protected variable TArray< FName > OldShownPins Old shown pins. Needs to be a member variable to track pin visibility changes between Pre and PostEditChange.
Protected variable FPinVisibilityChangedEvent PinVisibilityChangedEvent  
Protected variable FOnNodePropertyChangedEvent PropertyChangeEvent  
Public variable UProperty Category, EditAnywhere editfixedsize TArray< FOptionalPinFromProperty > ShowPinForProperties  
Public variable UProperty Category, EditAnywhere, Meta displayname FMemberReference UpdateFunction Function called when the node is updated.

Constructors

  Type Name Description
Public function  

UAnimGraphNode_Base ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual Const void

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

  
Public function Virtual Const void

AddSearchMetaDataInfo ( TArray< struct FSearchTagDataPair >& OutTaggedMetaData
)

  
Public function Virtual void  
Public function Virtual void

AutowireNewNode ( UEdGraphPin* FromPin
)

  
Public function Virtual void

BakeDataDuringCompilation ( FCompilerResultsLog& MessageLog
)

 Gives each visual node a chance to update the node template before it is inserted in the compiled class.
Public function Virtual Const bool

CanCreateUnderSpecifiedSchema ( const UEdGraphSchema* DesiredSchema
)

  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual void

CopyNodeDataToPreviewNode ( FAnimNode_Base* InPreviewNode
)

 Called to propagate data from the internal node to the preview in Persona.
Public function Virtual void

CopyPinDefaultsToNodeData ( UEdGraphPin* InPin
)

 Called after editing a default value to update internal node from pin defaults.
Protected function void Copy this node's data during the last phase of compilation where term defaults are copied to the new CDO.
Protected function Virtual void

CreateCustomPins ( TArray< UEdGraphPin* >* OldPins
)

 Override point to create custom pins
Public function Virtual void Create any output pins necessary for this node.
Protected function 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:
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 void  
Public function Virtual Const bool BEGIN Interface to support transition getter if you return true for DoesSupportExposeTimeForTransitionGetter you should implement all below functions
Public function Virtual Const void

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

 Draw function called on nodes that are selected and / or have a pose watch enabled.
Public function Virtual Const void

Draw ( FPrimitiveDrawInterface* PDI,
USkeletalMeshComponent* PreviewSkelMeshComp
)

 Draw function for supporting visualization.
Public function Virtual Const void

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

 Canvas draw function to draw to viewport.
Protected function void Create the bindings subobject if required.
Public function Virtual void

ExpandNode ( FKismetCompilerContext& CompilerContext,
UEdGraph* SourceGraph
)

  
Public function Const FAnimNode_Base *

FindDebugAnimNode ( USkeletalMeshComponent* PreviewSkelMeshComp
)

 Try to find the preview node instance for this anim graph node
Public function Const NodeType *

GetActiveInstanceNode ( UObject* AnimInstanceObject
)

  
Public function Virtual Const void

GetAllAnimationSequencesReferred ( TArray< UAnimationAsset* >& AnimAssets
)

 Populate the supplied arrays with the currently reffered to animation assets.
Public function Virtual Const UAnimationAsset *  
Public function Virtual Const TSubclassOf< UAnimationAsset >  
Public function Const UAnimBlueprint * Get the animation blueprint to which this node belongs
Public function Const const UAnimGraphNodeBinding * Get the bindings for this node.
Public function 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.
Public function Const FAnimNode_Base * Get the currently-debugged runtime anim node (in the anim BP debugger that this node is currently being edited in)
Public function Const TNodeType * Get the currently-debugged runtime anim node of a specified type (in the anim BP debugger that this node is currently being edited in)
Public function Virtual Const FString  
Public function Virtual Const FEditorModeID Override this function to push an editor mode when this node is selected
Public function FAnimNode_Base * Get the runtime anim node that we template.
Public function Const FStructProperty * Gets the animation FNode property represented by this ed graph node.
Public function Const UScriptStruct * Gets the animation FNode type represented by this ed graph node.
Public function Virtual Const void Get the named attribute types that this node takes (absorbs) as inputs. Other attributes are assumed to 'pass through' this node.
Public function Virtual Const UObject * By default return any animation assets we have.
Protected function Virtual FPoseLinkMappingRecord

GetLinkIDLocation ( const UScriptStruct* NodeType,
UEdGraphPin* InputLinkPin
)

  
Public function Virtual Const void

GetMenuActions ( FBlueprintActionDatabaseRegistrar& ActionRegistrar
)

  
Public function Virtual Const FText  
Public function UAnimGraphNodeBinding * Get the mutable bindings for this node.
Public function Virtual Const void

GetNodeAttributes ( TArray< TKeyValuePair< FString, FString > >& OutNodeAttributes
)

  
Public function Virtual Const FString Gets the menu category this node belongs in.
Public function Virtual Const FLinearColor  
Protected function Const UObject *  
Public function Virtual Const void

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

 Function to collect strings from nodes to display in the viewport.
Public function Virtual Const void Get the named attribute types that this node provides as outputs. Other attributes are assumed to 'pass through' this node.
Protected function Virtual Const void

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

 Get the property (and possibly array index) associated with the supplied pin
Protected function Virtual Const bool

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

 Get the pin binding info for the supplied pin
Public function Virtual Const void

GetPinHoverText ( const UEdGraphPin& Pin,
FString& HoverTextOut
)

  
Public function Virtual FString

GetPinMetaData ( FName InPinName,
FName InKey
)

  
Public function Virtual Const FProperty *

GetPinProperty ( FName InPinName
)

  
Public function Const FProperty *

GetPinProperty ( const UEdGraphPin* InPin
)

 Get the property corresponding to a pin. For array element pins returns the outer array property. Returns null if a property cannot be found.
Public function Virtual Const const UAnimGraphNode_Base * Some anim graph nodes can act as proxies to outer nodes (e.g. sink nodes in nested graphs).
Protected function Virtual Const void

GetRequiredExtensions ( TArray< TSubclassOf< UAnimBlueprintExtension > >& OutExtensions
)

 Get the extension types that this node type holds on the anim blueprint. Some extension types are always requested by the system.
Public function Const FName

GetTag ()

 Get the tag for this node, if any.
Public function Virtual Const const TCHAR *  
Public function Virtual Const UScriptStruct *  
Public function Const void

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

 Helper function for GetAllAnimationSequencesReferred.
Public function void

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

  
Public function void

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

 Helper function for ReplaceReferredAnimations
Public function Virtual void

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

  
Public function Virtual void

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

  
Public function Virtual Const bool

HasBinding ( FName InPropertyName
)

 Check whether the specified property is bound via PropertyBindings.
Protected function void

InternalPinCreation ( TArray< UEdGraphPin* >* OldPins
)

 Allocates or reallocates pins.
Public function Virtual Const bool

IsPinBindable ( const UEdGraphPin* InPin
)

 Check whether the named pin is bindable.
Public function Const bool

IsPinExposedAndBound ( const FString& InPinName,
const EEdGraphPinDirection InDirection
)

 Helper function to check whether a pin is valid and bound via property access
Public function Const bool

IsPinExposedAndLinked ( const FString& InPinName,
const EEdGraphPinDirection Direction
)

 Helper function to check whether a pin is valid and linked to something else in the graph
Public function Const bool

IsPinUnlinkedUnboundAndUnset ( const FString& InPinName,
const EEdGraphPinDirection InDirection
)

 Helper function to check whether a pin is not linked, not bound via property access and still has its default value
Public function Virtual Const bool Whether or not you can add a pose watch on this node.
Public function 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.
Public function Virtual Const bool Is this node a sink that has no pose outputs?
Public function Virtual Const void  
Public function Static TSharedRef< SWidget > Make a property binding widget to edit the bindings of the passed-in nodes.
Public function Virtual Const bool  
Protected function Virtual void Override point for CopyTermDefaultsToDefaultObject Copy this node's data during the last phase of compilation where term defaults are copied to the new CDO
Public function FOnNodePropertyChangedEvent &  
Public function Virtual void

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

 Selection notification callback.
Public function FOnNodeTitleChangedEvent &  
Protected function Virtual Const void Override point for OverrideAssets.
Public function FPinVisibilityChangedEvent &  
Public function Virtual void

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

 Pose Watch change notification callback.
Protected function Virtual void Process this node's data during compilation (override point)
Protected function Const void Called to override the assets held on a runtime anim node. Implements per-node logic for child anim blueprints.
Public function Virtual void

PinConnectionListChanged ( UEdGraphPin* Pin
)

  
Public function Virtual void

PinDefaultValueChanged ( UEdGraphPin* Pin
)

  
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function void Refreshes the debugged component post-edit.
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual Const void

PostProcessPinName ( const UEdGraphPin* Pin,
FString& DisplayName
)

 Give the node a chance to change the display name of a pin.
Public function Virtual void

PreEditChange ( FProperty* PropertyAboutToChange
)

  
Protected function void Process this node's data during compilation.
Public function Virtual void

ReallocatePinsDuringReconstruction ( TArray< UEdGraphPin* >& OldPins
)

  
Protected function void Helper function used to refresh the type of a binding.
Public function Virtual void  
Public function Virtual Const bool

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

  
Public function Virtual Const bool

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

  
Public function void

RemoveBindings ( FName InBindingName
)

 Remove any bindings for the specified name.
Public function Virtual void

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

  
Public function Virtual void

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

 Replace references to animations that exist in the supplied maps
Public function Virtual void

Serialize ( FArchive& Ar
)

  
Public function void

SetPinVisibility ( bool bInVisible,
int32 InOptionalPinIndex
)

 Sets the visibility of the specified pin, reconstructs the node if it changes.
Public function void

SetTag ( FName InTag
)

 Set the tag for this node.
Protected function void

SetTagInternal ( FName InTag
)

 Set the tag for this node but without regenerating any BP data for tagging.
Protected function Virtual Const bool Whether this node should create BP evaluation handlers as part of compilation.
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const EAnimAssetHandlerType

SupportsAssetClass ( const UClass* AssetClass
)

 Returns whether this node supports the supplied asset class
Public function Virtual Const bool If using CopyPoseFromMesh, the AnimBlueprint Compiler will cache this off for optimizations.
Public function 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.
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.
Protected function void

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

 Helper function used to validate anim node function references

Classes

  Type Name Description
Public struct FAnimPropertyBindingWidgetArgs Arguments used to construct a property binding widget.  
Public class FOnNodePropertyChangedEvent Event that observers can bind to so that they are notified about changes made to this node through the property system  
Public class 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  
Public class FPinVisibilityChangedEvent Event that observers can bind to so that they are notified about changes to pin visibility.  

Typedefs

Name Description
FNodeAttributeArray  

Deprecated Variables

  Type Name Description
Public variable UProperty TMap< FName, FAnimGraphNodePropertyBinding > PropertyBindings_DEPRECATED Map from property name->binding info

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page