UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
IAnimClassInterface Class Referenceabstract

#include <AnimClassInterface.h>

+ Inheritance diagram for IAnimClassInterface:

Public Member Functions

virtual const TArray< FBakedAnimationStateMachine > & GetBakedStateMachines () const =0
 
virtual const TArray< FAnimNotifyEvent > & GetAnimNotifies () const =0
 
virtual const TArray< FStructProperty * > & GetAnimNodeProperties () const =0
 
virtual const TArray< FStructProperty * > & GetSubInstanceNodeProperties () const
 
virtual const TArray< FStructProperty * > & GetLinkedAnimGraphNodeProperties () const =0
 
virtual const TArray< FStructProperty * > & GetLayerNodeProperties () const
 
virtual const TArray< FStructProperty * > & GetLinkedAnimLayerNodeProperties () const =0
 
virtual const TArray< FStructProperty * > & GetPreUpdateNodeProperties () const =0
 
virtual const TArray< FStructProperty * > & GetDynamicResetNodeProperties () const =0
 
virtual const TArray< FStructProperty * > & GetStateMachineNodeProperties () const =0
 
virtual const TArray< FStructProperty * > & GetInitializationNodeProperties () const =0
 
virtual ENGINE_API const TArray< FExposedValueHandler > & GetExposedValueHandlers () const
 
virtual const TArray< FName > & GetSyncGroupNames () const =0
 
virtual const TMap< FName, FCachedPoseIndices > & GetOrderedSavedPoseNodeIndicesMap () const =0
 
virtual const TArray< FAnimBlueprintFunction > & GetAnimBlueprintFunctions () const =0
 
virtual const TMap< FName, FGraphAssetPlayerInformation > & GetGraphAssetPlayerInformation () const =0
 
virtual const TMap< FName, FAnimGraphBlendOptions > & GetGraphBlendOptions () const =0
 
virtual USkeleton * GetTargetSkeleton () const =0
 
virtual int32 GetSyncGroupIndex (FName SyncGroupName) const =0
 
virtual ENGINE_API const FPropertyAccessLibrary & GetPropertyAccessLibrary () const
 
virtual void ForEachSubsystem (TFunctionRef< EAnimSubsystemEnumeration(const FAnimSubsystemContext &)> InFunction) const =0
 
virtual void ForEachSubsystem (UObject *InObject, TFunctionRef< EAnimSubsystemEnumeration(const FAnimSubsystemInstanceContext &)> InFunction) const =0
 
virtual const FAnimSubsystem * FindSubsystem (UScriptStruct *InSubsystemType) const =0
 
template<typename SubsystemType >
const SubsystemType * FindSubsystem () const
 
template<typename SubsystemType >
const SubsystemType & GetSubsystem () const
 
ENGINE_API const IAnimClassInterface * GetRootClass () const
 
virtual int32 GetRootAnimNodeIndex () const
 
virtual FStructProperty * GetRootAnimNodeProperty () const
 

Static Public Member Functions

static ENGINE_API bool HasNodeAnyFlags (IAnimClassInterface *InAnimClassInterface, int32 InNodeIndex, EAnimNodeDataFlags InNodeDataFlags)
 
static ENGINE_API IAnimClassInterface * GetFromClass (UClass *InClass)
 
static ENGINE_API const IAnimClassInterface * GetFromClass (const UClass *InClass)
 
static ENGINE_API UClass * GetActualAnimClass (IAnimClassInterface *AnimClassInterface)
 
static ENGINE_API const UClass * GetActualAnimClass (const IAnimClassInterface *AnimClassInterface)
 
static ENGINE_API const FAnimBlueprintFunction * FindAnimBlueprintFunction (IAnimClassInterface *AnimClassInterface, const FName &InFunctionName)
 
static ENGINE_API bool IsAnimBlueprintFunction (IAnimClassInterface *InAnimClassInterface, const UFunction *InFunction)
 
static ENGINE_API const UObject * GetObjectPtrFromAnimNode (const IAnimClassInterface *InAnimClassInterface, const FAnimNode_Base *InNode)
 
static ENGINE_API const FAnimNode_Base * GetAnimNodeFromObjectPtr (const UObject *InObject, int32 InNodeIndex, UScriptStruct *InNodeType)
 
template<typename NodeType >
static const NodeType & GetAnimNodeFromObjectPtrChecked (const UObject *InObject, int32 InNodeIndex)
 

Protected Member Functions

virtual const TArray< FBakedAnimationStateMachine > & GetBakedStateMachines_Direct () const =0
 
virtual const TArray< FAnimNotifyEvent > & GetAnimNotifies_Direct () const =0
 
virtual const TArray< FName > & GetSyncGroupNames_Direct () const =0
 
virtual const TMap< FName, FCachedPoseIndices > & GetOrderedSavedPoseNodeIndicesMap_Direct () const =0
 
virtual const TMap< FName, FGraphAssetPlayerInformation > & GetGraphAssetPlayerInformation_Direct () const =0
 
virtual const TMap< FName, FAnimGraphBlendOptions > & GetGraphBlendOptions_Direct () const =0
 
virtual ENGINE_API const FPropertyAccessLibrary & GetPropertyAccessLibrary_Direct () const
 
virtual const void * GetConstantNodeValueRaw (int32 InIndex) const =0
 
virtual const void * GetMutableNodeValueRaw (int32 InIndex, const UObject *InObject) const =0
 
virtual const FAnimBlueprintMutableData * GetMutableNodeData (const UObject *InObject) const =0
 
virtual FAnimBlueprintMutableData * GetMutableNodeData (UObject *InObject) const =0
 
virtual const void * GetConstantNodeData () const =0
 
virtual TArrayView< const FAnimNodeData > GetNodeData () const =0
 
virtual int32 GetAnimNodePropertyIndex (const UScriptStruct *InNodeType, FName InPropertyName) const =0
 
virtual int32 GetAnimNodePropertyCount (const UScriptStruct *InNodeType) const =0
 

Friends

class UAnimBlueprintGeneratedClass
 
struct FAnimNodeData
 
struct UE::Anim::FNodeDataId
 

Member Function Documentation

◆ FindAnimBlueprintFunction()

const FAnimBlueprintFunction * IAnimClassInterface::FindAnimBlueprintFunction ( IAnimClassInterface *  AnimClassInterface,
const FName &  InFunctionName 
)
static

◆ FindSubsystem() [1/2]

template<typename SubsystemType >
const SubsystemType * IAnimClassInterface::FindSubsystem ( ) const
inline

◆ FindSubsystem() [2/2]

virtual const FAnimSubsystem * IAnimClassInterface::FindSubsystem ( UScriptStruct *  InSubsystemType) const
pure virtual

◆ ForEachSubsystem() [1/2]

virtual void IAnimClassInterface::ForEachSubsystem ( TFunctionRef< EAnimSubsystemEnumeration(const FAnimSubsystemContext &)>  InFunction) const
pure virtual

◆ ForEachSubsystem() [2/2]

virtual void IAnimClassInterface::ForEachSubsystem ( UObject *  InObject,
TFunctionRef< EAnimSubsystemEnumeration(const FAnimSubsystemInstanceContext &)>  InFunction 
) const
pure virtual

◆ GetActualAnimClass() [1/2]

const UClass * IAnimClassInterface::GetActualAnimClass ( const IAnimClassInterface *  AnimClassInterface)
static

◆ GetActualAnimClass() [2/2]

UClass * IAnimClassInterface::GetActualAnimClass ( IAnimClassInterface *  AnimClassInterface)
static

◆ GetAnimBlueprintFunctions()

virtual const TArray< FAnimBlueprintFunction > & IAnimClassInterface::GetAnimBlueprintFunctions ( ) const
pure virtual

Implemented in UAnimBlueprintGeneratedClass.

◆ GetAnimNodeFromObjectPtr()

const FAnimNode_Base * IAnimClassInterface::GetAnimNodeFromObjectPtr ( const UObject *  InObject,
int32  InNodeIndex,
UScriptStruct *  InNodeType 
)
static

◆ GetAnimNodeFromObjectPtrChecked()

template<typename NodeType >
static const NodeType & IAnimClassInterface::GetAnimNodeFromObjectPtrChecked ( const UObject *  InObject,
int32  InNodeIndex 
)
inlinestatic

◆ GetAnimNodeProperties()

virtual const TArray< FStructProperty * > & IAnimClassInterface::GetAnimNodeProperties ( ) const
pure virtual

Implemented in UAnimBlueprintGeneratedClass.

◆ GetAnimNodePropertyCount()

virtual int32 IAnimClassInterface::GetAnimNodePropertyCount ( const UScriptStruct *  InNodeType) const
protectedpure virtual

◆ GetAnimNodePropertyIndex()

virtual int32 IAnimClassInterface::GetAnimNodePropertyIndex ( const UScriptStruct *  InNodeType,
FName  InPropertyName 
) const
protectedpure virtual

◆ GetAnimNotifies()

virtual const TArray< FAnimNotifyEvent > & IAnimClassInterface::GetAnimNotifies ( ) const
pure virtual

Implemented in UAnimBlueprintGeneratedClass.

◆ GetAnimNotifies_Direct()

virtual const TArray< FAnimNotifyEvent > & IAnimClassInterface::GetAnimNotifies_Direct ( ) const
protectedpure virtual

◆ GetBakedStateMachines()

virtual const TArray< FBakedAnimationStateMachine > & IAnimClassInterface::GetBakedStateMachines ( ) const
pure virtual

Implemented in UAnimBlueprintGeneratedClass.

◆ GetBakedStateMachines_Direct()

virtual const TArray< FBakedAnimationStateMachine > & IAnimClassInterface::GetBakedStateMachines_Direct ( ) const
protectedpure virtual

◆ GetConstantNodeData()

virtual const void * IAnimClassInterface::GetConstantNodeData ( ) const
protectedpure virtual

◆ GetConstantNodeValueRaw()

virtual const void * IAnimClassInterface::GetConstantNodeValueRaw ( int32  InIndex) const
protectedpure virtual

◆ GetDynamicResetNodeProperties()

virtual const TArray< FStructProperty * > & IAnimClassInterface::GetDynamicResetNodeProperties ( ) const
pure virtual

Implemented in UAnimBlueprintGeneratedClass.

◆ GetExposedValueHandlers()

const TArray< FExposedValueHandler > & IAnimClassInterface::GetExposedValueHandlers ( ) const
virtual

◆ GetFromClass() [1/2]

const IAnimClassInterface * IAnimClassInterface::GetFromClass ( const UClass *  InClass)
static

◆ GetFromClass() [2/2]

IAnimClassInterface * IAnimClassInterface::GetFromClass ( UClass *  InClass)
static

◆ GetGraphAssetPlayerInformation()

virtual const TMap< FName, FGraphAssetPlayerInformation > & IAnimClassInterface::GetGraphAssetPlayerInformation ( ) const
pure virtual

Implemented in UAnimBlueprintGeneratedClass.

◆ GetGraphAssetPlayerInformation_Direct()

virtual const TMap< FName, FGraphAssetPlayerInformation > & IAnimClassInterface::GetGraphAssetPlayerInformation_Direct ( ) const
protectedpure virtual

◆ GetGraphBlendOptions()

virtual const TMap< FName, FAnimGraphBlendOptions > & IAnimClassInterface::GetGraphBlendOptions ( ) const
pure virtual

Implemented in UAnimBlueprintGeneratedClass.

◆ GetGraphBlendOptions_Direct()

virtual const TMap< FName, FAnimGraphBlendOptions > & IAnimClassInterface::GetGraphBlendOptions_Direct ( ) const
protectedpure virtual

◆ GetInitializationNodeProperties()

virtual const TArray< FStructProperty * > & IAnimClassInterface::GetInitializationNodeProperties ( ) const
pure virtual

Implemented in UAnimBlueprintGeneratedClass.

◆ GetLayerNodeProperties()

virtual const TArray< FStructProperty * > & IAnimClassInterface::GetLayerNodeProperties ( ) const
inlinevirtual

◆ GetLinkedAnimGraphNodeProperties()

virtual const TArray< FStructProperty * > & IAnimClassInterface::GetLinkedAnimGraphNodeProperties ( ) const
pure virtual

Implemented in UAnimBlueprintGeneratedClass.

◆ GetLinkedAnimLayerNodeProperties()

virtual const TArray< FStructProperty * > & IAnimClassInterface::GetLinkedAnimLayerNodeProperties ( ) const
pure virtual

Implemented in UAnimBlueprintGeneratedClass.

◆ GetMutableNodeData() [1/2]

virtual const FAnimBlueprintMutableData * IAnimClassInterface::GetMutableNodeData ( const UObject *  InObject) const
protectedpure virtual

◆ GetMutableNodeData() [2/2]

virtual FAnimBlueprintMutableData * IAnimClassInterface::GetMutableNodeData ( UObject *  InObject) const
protectedpure virtual

◆ GetMutableNodeValueRaw()

virtual const void * IAnimClassInterface::GetMutableNodeValueRaw ( int32  InIndex,
const UObject *  InObject 
) const
protectedpure virtual

◆ GetNodeData()

virtual TArrayView< const FAnimNodeData > IAnimClassInterface::GetNodeData ( ) const
protectedpure virtual

◆ GetObjectPtrFromAnimNode()

const UObject * IAnimClassInterface::GetObjectPtrFromAnimNode ( const IAnimClassInterface *  InAnimClassInterface,
const FAnimNode_Base *  InNode 
)
static

◆ GetOrderedSavedPoseNodeIndicesMap()

virtual const TMap< FName, FCachedPoseIndices > & IAnimClassInterface::GetOrderedSavedPoseNodeIndicesMap ( ) const
pure virtual

Implemented in UAnimBlueprintGeneratedClass.

◆ GetOrderedSavedPoseNodeIndicesMap_Direct()

virtual const TMap< FName, FCachedPoseIndices > & IAnimClassInterface::GetOrderedSavedPoseNodeIndicesMap_Direct ( ) const
protectedpure virtual

◆ GetPreUpdateNodeProperties()

virtual const TArray< FStructProperty * > & IAnimClassInterface::GetPreUpdateNodeProperties ( ) const
pure virtual

Implemented in UAnimBlueprintGeneratedClass.

◆ GetPropertyAccessLibrary()

const FPropertyAccessLibrary & IAnimClassInterface::GetPropertyAccessLibrary ( ) const
virtual

◆ GetPropertyAccessLibrary_Direct()

const FPropertyAccessLibrary & IAnimClassInterface::GetPropertyAccessLibrary_Direct ( ) const
protectedvirtual

◆ GetRootAnimNodeIndex()

virtual int32 IAnimClassInterface::GetRootAnimNodeIndex ( ) const
inlinevirtual

◆ GetRootAnimNodeProperty()

virtual FStructProperty * IAnimClassInterface::GetRootAnimNodeProperty ( ) const
inlinevirtual

◆ GetRootClass()

const IAnimClassInterface * IAnimClassInterface::GetRootClass ( ) const

◆ GetStateMachineNodeProperties()

virtual const TArray< FStructProperty * > & IAnimClassInterface::GetStateMachineNodeProperties ( ) const
pure virtual

Implemented in UAnimBlueprintGeneratedClass.

◆ GetSubInstanceNodeProperties()

virtual const TArray< FStructProperty * > & IAnimClassInterface::GetSubInstanceNodeProperties ( ) const
inlinevirtual

◆ GetSubsystem()

template<typename SubsystemType >
const SubsystemType & IAnimClassInterface::GetSubsystem ( ) const
inline

◆ GetSyncGroupIndex()

virtual int32 IAnimClassInterface::GetSyncGroupIndex ( FName  SyncGroupName) const
pure virtual

Implemented in UAnimBlueprintGeneratedClass.

◆ GetSyncGroupNames()

virtual const TArray< FName > & IAnimClassInterface::GetSyncGroupNames ( ) const
pure virtual

Implemented in UAnimBlueprintGeneratedClass.

◆ GetSyncGroupNames_Direct()

virtual const TArray< FName > & IAnimClassInterface::GetSyncGroupNames_Direct ( ) const
protectedpure virtual

◆ GetTargetSkeleton()

virtual USkeleton * IAnimClassInterface::GetTargetSkeleton ( ) const
pure virtual

Implemented in UAnimBlueprintGeneratedClass.

◆ HasNodeAnyFlags()

bool IAnimClassInterface::HasNodeAnyFlags ( IAnimClassInterface *  InAnimClassInterface,
int32  InNodeIndex,
EAnimNodeDataFlags  InNodeDataFlags 
)
static

◆ IsAnimBlueprintFunction()

bool IAnimClassInterface::IsAnimBlueprintFunction ( IAnimClassInterface *  InAnimClassInterface,
const UFunction *  InFunction 
)
static

Check if a function is an anim function on this class

Parameters
InAnimClassInterfaceThe interface to check
InFunctionThe function to check
Returns
true if the supplied function is an anim function on the specified class

Friends And Related Symbol Documentation

◆ FAnimNodeData

friend struct FAnimNodeData
friend

◆ UAnimBlueprintGeneratedClass

friend class UAnimBlueprintGeneratedClass
friend

◆ UE::Anim::FNodeDataId

friend struct UE::Anim::FNodeDataId
friend
The documentation for this class was generated from the following files: