1. Epic GamesDeveloper
  3. UPoseSearchDatabase

UPoseSearchDatabase

A data asset for indexing a collection of animation sequences.

API > API/Plugins > API/Plugins/PoseSearch > API/Plugins/PoseSearch/PoseSearch

Inheritance Hierarchy

References

   
Module PoseSearch
Header /Engine/Plugins/Experimental/Animation/PoseSearch/Source/Runtime/Public/PoseSearch/PoseSearchDatabase.h
Include #include "PoseSearch/PoseSearchDatabase.h"

Syntax

UCLASS&40;BlueprintType, Category&61;"Animation&124;Pose Search", Experimental,  
       Meta&61;&40;DisplayName&61;"Motion Database"&41;&41;  
class UPoseSearchDatabase : public UDataAsset

Remarks

A data asset for indexing a collection of animation sequences.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere TArray< FInstancedStruct > AnimationAssets  
Public variable UProperty Category, EditAnywhere bool bSkipSearchIfPossible When evaluating multiple searches, including the continuing pose search, the system keeps track of the best pose and associated cost.
Public variable UProperty Category, EditAnywhere FPoseSearchExcludeFromDatabaseParameters ExcludeFromDatabaseParameters These settings allow users to trim the start and end of animations in the database to preserve start/end frames for blending, and prevent the system from selecting the very last frames before it blends out.
Public variable UProperty Category, EditAnywhere, Meta int32 KDTreeMaxLeafSize  
Public variable UProperty Category, EditAnywhere, Meta int32 KDTreeQueryNumNeighbors Out of a kdtree search, results will have only an approximate cost, so the database search will select the best “KDTree Query Num Neighbors” poses to perform the full cost analysis, and be able to elect the best pose.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< const UPoseSearchNormalizationSet > NormalizationSet This optional asset defines a list of databases you want to normalize together.
Public variable UProperty Category, EditAnywhere, Meta int32 NumberOfPrincipalComponents Number of dimensions used to create the kdtree. More dimensions allows a better explanation of the variance of the dataset that usually translates in better search results, but will imply more memory usage and worse performances.
Public variable UProperty Category, EditAnywhere EPoseSearchMode PoseSearchMode This dictates how the database will perform the search.
Public variable UProperty Category, EditAnywhere TObjectPtr< USkeletalMesh > PreviewMesh If null, the default preview mesh for the skeleton will be used.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly displayname TObjectPtr< const UPoseSearchSchema > Schema The Motion Database Config sets what channels this database will use to match against (bones, trajectory and what properties of those you’re interested in, such as position and velocity).

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const const FPoseSearchDatabaseAnimationAssetBase *  
Public function Const const FPoseSearchDatabaseAnimationAssetBase *

GetAnimationAssetBase ( int32 AnimationAssetIndex
)

  
Public function Const const FInstancedStruct &  
Public function Const const FInstancedStruct &

GetAnimationAssetStruct ( int32 AnimationAssetIndex
)

  
Public function FPoseSearchDatabaseAnimationAssetBase *  
Public function FPoseSearchDatabaseAnimationAssetBase *

GetMutableAnimationAssetBase ( int32 AnimationAssetIndex
)

  
Public function FInstancedStruct &

GetMutableAnimationAssetStruct ( int32 AnimationAssetIndex
)

  
Public function FInstancedStruct &  
Public function Const float

GetNormalizedAssetTime ( int32 PoseIdx
)

  
Public function Const int32  
Public function Const int32

GetPoseIndexFromTime ( float AssetTime,
const UE::PoseSearch::FSearchIndexAsset& SearchIndexAsset
)

  
Public function Const float

GetRealAssetTime ( int32 PoseIdx
)

  
Public function Const const UE::PoseSearch::FSearchIndex &  
Public function Const bool  
Public function Const const FString  
Public function Const const bool  
Public function Const void  
Public function void  
Public function Const UE::PoseSearch::FSearchResult  
Public function Const FPoseSearchCost  
Public function void  
Public function void

UnregisterOnDerivedDataRebuild ( void* Unregister
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void Starts caching of platform specific data for the target platform Called when cooking before serialization so that object can prepare platform specific data Not called during normal loading of objects
Public function Virtual bool Have we finished loading all the cooked platform data for the target platforms requested in BeginCacheForCookedPlatformData
Public function Virtual void Begin UObject.
Public function Virtual void Called from within SavePackage on the passed in base/root object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Typedefs

Name Description
FOnDerivedDataRebuild  
FOnDerivedDataRebuildMulticaster  

Deprecated Variables

  Type Name Description
Public variable UProperty TArray< FPoseSearchDatabaseBlendSpace > BlendSpaces_DEPRECATED  
Public variable UProperty TArray< FPoseSearchDatabaseSequence > Sequences_DEPRECATED Sequences and Blendspaces are deprecated and its data will be part of the AnimationAssets.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page