1. Epic GamesDeveloper
  3. UAnimationAsset

UAnimationAsset

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (Abstract, BlueprintType, MinimalAPI)  
class UAnimationAsset :  
    public UObject ,  
    public IInterface_AssetUserData ,  
    public IInterface_PreviewMeshProvider

Variables

  Type Name Description
Protected variable UProperty Category visibleanywhere TObjectPtr< class UAssetMappingTable > AssetMappingTable Asset mapping table when ParentAsset is set
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay instanced TArray< TObjectPtr< UAssetUserData > > AssetUserData Array of user data stored with the asset
Public variable UProperty Transient TArray< TObjectPtr< class UAnimationAsset > > ChildrenAssets Note this is transient as they're added as they're loaded
Public variable UProperty Category assetregistrysearchable, visibleanywhere TObjectPtr< class UAnimationAsset > ParentAsset Parent asset is used for AnimMontage when it derives all settings but remap animation asset.
Public variable UProperty Category, EditAnywhere duplicatetransient TObjectPtr< class UPoseAsset > PreviewPoseAsset The default skeletal mesh to use when previewing this asset - this only applies when you open Persona using this asset
Public variable UProperty Category instanced, visibleanywhere TObjectPtr< class UThumbnailInfo > ThumbnailInfo Information for thumbnail rendering

Functions

  Type Name Description
Public function void

AddMetaData ( UAnimMetaData* MetaDataInstance
)

  
Public function void  
Public function Const UFunction BlueprintCallable, Category UAnimMetaData *

FindMetaDataByClass ( const TSubclassOf< UAnimMetaData > MetaDataClass
)

 Returns the first metadata of the specified class
Public function Const T * Templatized version of FindMetaDataByClass that handles casting for you
Public function Virtual bool

GetAllAnimationSequencesReferred ( TArray< class UAnimationAsset* >& AnimationSequences,
bool bRecursive
)

 Retrieve all animations that are used by this asset
Public function Const const UAssetMappingTable *  
Public function Virtual Const int32  
Public function Virtual float This is used in editor only when used for transition getter this doesn't mean max time.
Public function Const const TArray< UAnimMetaData * > & Get available Metadata within the animation asset
Public function Virtual Const UFunction BlueprintPure, Category, Meta float  
Public function Const USkeleton *  
Public function Const FGuid  
Public function Const FGuid  
Public function Virtual TArray< FName > * Return a list of unique marker names for blending compatibility
Public function void

HandleAnimReferenceCollection ( TArray< UAnimationAsset* >& AnimationAssets,
bool bRecursive
)

 Helper function for GetAllAnimationSequencesReferred, it adds itself first and call GetAllAnimationSEquencesReferred.
Public function Const bool  
Public function Virtual Const bool Return true if this is valid additive animation false otherwise
Public function Virtual void

OnSetSkeleton ( USkeleton* NewSkeleton
)

  
Protected function Virtual void  
Public function bool

RemapAsset ( UAnimationAsset* SourceAsset,
UAnimationAsset* TargetAsset
)

  
Protected function Virtual void

RemapTracksToNewSkeleton ( USkeleton* NewSkeleton,
bool bConvertSpaces
)

  
Public function void

RemoveMetaData ( TArrayView< UAnimMetaData* > MetaDataInstances
)

  
Public function void

RemoveMetaData ( UAnimMetaData* MetaDataInstance
)

  
Public function Virtual void Replace this assets references to other animations based on ReplacementMap
Public function bool

ReplaceSkeleton ( USkeleton* NewSkeleton,
bool bConvertSpaces
)

 Replace Skeleton
Public function void

ResetSkeleton ( USkeleton* NewSkeleton
)

  
Public function void

SetParentAsset ( UAnimationAsset* InParentAsset
)

 Parent Asset related function. Used by editor
Public function UFunction BlueprintCallable, Category void Sets or updates the preview skeletal mesh
Public function void

SetSkeleton ( USkeleton* NewSkeleton
)

  
Public function void  
Public function Virtual Const void Advances the asset player instance
Public function void We have to update whenever we have anything loaded
Public function void  
Public function void Validate our stored data against our skeleton and update accordingly

Overridden from UObject

  Type Name Description
Public function Virtual Const void Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
Public function Virtual Const void

GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
)

  
Public function Virtual Const EDataValidationResult Generic function to validate objects during changelist validations, etc.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from IInterface_AssetUserData

  Type Name Description
Public function Virtual void  
Public function Virtual Const const TArray< UAssetUserData * > *  
Public function Virtual UAssetUserData * Returns an instance of the provided AssetUserData class if it's contained in the target asset.
Public function Virtual void  

Overridden from IInterface_PreviewMeshProvider

  Type Name Description
Public function Virtual Const USkeletalMesh * Get the preview mesh for this asset
Public function Virtual USkeletalMesh *

GetPreviewMesh ( bool bFindIfNotSet
)

 Get the preview mesh for this asset, non const.
Public function Virtual void

SetPreviewMesh ( USkeletalMesh* PreviewMesh,
bool bMarkAsDirty
)

 IInterface_PreviewMeshProvider interface

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page