1. Epic GamesDeveloper
  3. FAnimNode_LinkedAnimGraph

FAnimNode_LinkedAnimGraph

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Animation

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Animation/AnimNode_LinkedAnimGraph.h
Include #include "Animation/AnimNode_LinkedAnimGraph.h"

Syntax

struct FAnimNode_LinkedAnimGraph : public FAnimNode_CustomProperty

Variables

  Type Name Description
Public variable uint8: 1 bPropagateNotifiesToLinkedInstances Whether named notifies will be propagated from this linked instance to other instances (outer or other linked instances)
Public variable uint8: 1 bReceiveNotifiesFromLinkedInstances Whether named notifies will be received by this linked instance from other instances (outer or other linked instances)
Public variable int32 CachedLinkedNodeIndex Cached node index for our linked function.
Public variable TArray< FName > InputPoseNames List of input pose names, 1-1 with pose links about, built by the compiler
Public variable TArray< FPoseLink > InputPoses Input poses for the node, intentionally not accessible because if there's no input nodes in the target class we don't want to show these as pins
Public variable TSubclassOf< UAnimInstance > InstanceClass The class spawned for this linked instance
Public variable FAnimNode_Base * LinkedRoot The root node of the dynamically-linked graph.
Public variable int32 NodeIndex Our node index.
Protected variable float PendingBlendInDuration Inertial blending duration to request next update (pulled from the new state's blend in)
Protected variable TObjectPtr< const UBlendProfile > PendingBlendInProfile Optional blend profile to use during inertial blending (pulled from the new state's blend in)
Protected variable float PendingBlendOutDuration Inertial blending duration to request next update (pulled from the prior state's blend out)
Protected variable TObjectPtr< const UBlendProfile > PendingBlendOutProfile Optional blend profile to use during inertial blending (pulled from the prior state's blend out)

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Caches bones only for the sub graph that this node is linked to.
Protected function Virtual Const bool

CanTeardownLinkedInstance ( const UAnimInstance* LinkedInstance
)

 Check if the currently linked instance can be teared down.
Protected function void

DynamicLink ( UAnimInstance* InOwningAnimInstance
)

 Link up pose links dynamically with linked instance
Protected function void

DynamicUnlink ( UAnimInstance* InOwningAnimInstance
)

 Break any pose links dynamically with linked instance
Protected function int32

FindFunctionInputIndex ( const FAnimBlueprintFunction& AnimBlueprintFunction,
const FName& InInputName
)

 Helper function for finding function inputs when linking/unlinking
Public function Virtual Const FName Get the function name we should be linking with when we call DynamicLink/Unlink
Public function Virtual Const UAnimInstance *

GetDynamicLinkTarget ( UAnimInstance* InOwningAnimInstance
)

 Get the dynamic link target
Public function void Initializes only the sub-graph that this node is linked to.
Protected function void

ReinitializeLinkedAnimInstance ( const UAnimInstance* InOwningAnimInstance,
UAnimInstance* InNewAnimInstance
)

 Re-create the linked instances for this node.
Protected function void

RequestBlend ( const IAnimClassInterface* PriorAnimBPClass,
const IAnimClassInterface* NewAnimBPClass
)

 Request a blend when the active instance changes
Public function void

SetAnimClass ( TSubclassOf< UAnimInstance > InClass,
const UAnimInstance* InOwningAnimInstance
)

 Dynamically set the anim class of this linked instance
Protected function void

TeardownInstance ( const UAnimInstance* InOwningAnimInstance
)

 Shutdown the currently running instance.

Overridden from FAnimNode_CustomProperty

  Type Name Description
Protected function Virtual Const UClass * Get Target Class
Protected function Virtual void

HandleObjectsReinstanced_Impl ( UObject* InSourceObject,
UObject* InTargetObject,
const TMap< UObject*, UObject* >& OldToNewInstanceMap
)

 Handle object reinstancing override point.

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 local-space bones transforms according to the weights set up in Update().
Public function Virtual void Called to gather on-screen debug data. This is called on the game thread.
Public function Virtual void Called when the node first runs.
Protected function Virtual Const bool For nodes that need some kind of initialization that is not dependent on node relevancy (i.e. it is insufficient or inefficient to use Initialize_AnyThread), return true here.
Protected function Virtual void

OnInitializeAnimInstance ( const FAnimInstanceProxy* InProxy,
const UAnimInstance* InAnimInstance
)

 We only subscribe to the OnInitializeAnimInstance path because we need to cache our source object, so we only override these methods in editor at the moment
Public function Virtual void Called to update the state of the graph relative to this node.

Deprecated Variables

  Type Name Description
Public variable FName Tag_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page