1. Epic GamesDeveloper
  3. IAnimClassInterface

IAnimClassInterface

Unreal Engine C++ API Reference > Runtime > Engine > Animation

Inheritance Hierarchy

References

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

Syntax

class IAnimClassInterface

Functions

  Type Name Description
Public function Static const FAnimBlueprintFunction *

FindAnimBlueprintFunction ( IAnimClassInterface* AnimClassInterface,
const FName& InFunctionName
)

  
Public function Const const FAnimSubsystem *

FindSubsystem ( UScriptStruct* InSubsystemType
)

 Find a subsystem's class-resident data.
Public function Const const SubsystemType * Get a subsystem's class-resident data. If no subsystem of the type exists this will return nullptr.
Public function Const void

ForEachSubsystem ( UObject* InObject,
TFunctionRef< EAnimSubsystemEnumeration(const FAnimSubsystemInstanceContext&)> InFunction
)

  
Public function Const void

ForEachSubsystem ( TFunctionRef< EAnimSubsystemEnumeration(const FAnimSubsystemContext&)> InFunction
)

 Iterate over each subsystem for this class, supplying both the constant (FAnimSubsystem) and mutable (FAnimSubsystemInstance) data.
Public function Static const UClass *

GetActualAnimClass ( const IAnimClassInterface* AnimClassInterface
)

  
Public function Static UClass *

GetActualAnimClass ( IAnimClassInterface* AnimClassInterface
)

  
Public function Const const TArray< FAnimBlueprintFunction > &  
Public function Static const FAnimNode_Base *

GetAnimNodeFromObjectPtr ( const UObject* InObject,
int32 InNodeIndex,
UScriptStruct* InNodeType
)

 Get an anim node of the specified type given the object & node index Asserts if InObject is nullptr
Public function Static const NodeType &

GetAnimNodeFromObjectPtrChecked ( const UObject* InObject,
int32 InNodeIndex
)

 Get an anim node of the specified type given the object & node index Asserts if InObject is nullptr, the node index is out of bounds or the node is the incorrect type
Public function Const const TArray< FStructProperty * > &  
Protected function Const int32

GetAnimNodePropertyCount ( const UScriptStruct* InNodeType
)

 Get the number of properties (including editor only properties) that the anim node type has.
Protected function Const int32

GetAnimNodePropertyIndex ( const UScriptStruct* InNodeType,
FName InPropertyName
)

 Get the (editor-only data) index of the property.
Public function Const const TArray< FAnimNotifyEvent > &  
Protected function Const const TArray< FAnimNotifyEvent > &  
Public function Const const TArray< FBakedAnimationStateMachine > &  
Protected function Const const TArray< FBakedAnimationStateMachine > & These direct accessors are here to allow internal access that doesnt redirect to the root class.
Protected function Const const void * Get the struct that holds the constant data.
Protected function Const const void *

GetConstantNodeValueRaw ( int32 InIndex
)

 Access the various constant and mutable values.
Public function Const const TArray< FStructProperty * > &  
Public function Static IAnimClassInterface *

GetFromClass ( UClass* InClass
)

  
Public function Static const IAnimClassInterface *

GetFromClass ( const UClass* InClass
)

  
Public function Const const TMap< FName, FGraphAssetPlayerInformation > &  
Protected function Const const TMap< FName, FGraphAssetPlayerInformation > &  
Public function Const const TMap< FName, FAnimGraphBlendOptions > &  
Protected function Const const TMap< FName, FAnimGraphBlendOptions > &  
Public function Const const TArray< FStructProperty * > &  
Public function Const const TArray< FStructProperty * > &  
Public function Const const TArray< FStructProperty * > &  
Protected function Const FAnimBlueprintMutableData *

GetMutableNodeData ( UObject* InObject
)

  
Protected function Const const FAnimBlueprintMutableData *

GetMutableNodeData ( const UObject* InObject
)

 Get the struct that holds the mutable data
Protected function Const const void *

GetMutableNodeValueRaw ( int32 InIndex,
const UObject* InObject
)

  
Protected function Const TArrayView< const FAnimNodeData > Get the anim node data used for each node's constant/folded data.
Public function Static const UObject *

GetObjectPtrFromAnimNode ( const IAnimClassInterface* InAnimClassInterface,
const FAnimNode_Base* InNode
)

 Get the object ptr given an anim node.
Public function Const const TMap< FName, FCachedPoseIndices > &  
Protected function Const const TMap< FName, FCachedPoseIndices > &  
Public function Const const TArray< FStructProperty * > &  
Public function Const const IAnimClassInterface * Get the root anim class interface (i.e. if this is a derived class).
Public function Const const TArray< FStructProperty * > &  
Public function Const const SubsystemType & Get a subsystem's class-resident data. If no subsystem of the type exists this will assert.
Public function Const int32

GetSyncGroupIndex ( FName SyncGroupName
)

  
Public function Const const TArray< FName > &  
Protected function Const const TArray< FName > &  
Public function Const USkeleton *  
Public function Static bool

HasNodeAnyFlags ( IAnimClassInterface* InAnimClassInterface,
int32 InNodeIndex,
EAnimNodeDataFlags InNodeDataFlags
)

 Check whether a node at the specified index has the specified flags.
Public function Static bool

IsAnimBlueprintFunction ( IAnimClassInterface* InAnimClassInterface,
const UFunction* InFunction
)

 Check if a function is an anim function on this class
Protected function Const bool Check that the serialized NodeTypeMap can be used with the current set of native node data layouts.

Deprecated Functions

  Type Name Description
Public function Virtual Const const TArray< FExposedValueHandler > & Please use GetSubsystem
Public function Virtual Const const TArray< FStructProperty * > & Function has been renamed, please use GetLinkedLayerNodeProperties
Public function Virtual Const const FPropertyAccessLibrary & Please use GetSubsystem
Protected function Virtual Const const FPropertyAccessLibrary & Please use GetSubsystem
Public function Virtual Const int32 Please use GetAnimBlueprintFunctions()
Public function Virtual Const FStructProperty * Please use GetAnimBlueprintFunctions()
Public function Virtual Const const TArray< FStructProperty * > & Function has been renamed, please use GetLinkedAnimGraphNodeProperties

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page