1. Epic GamesDeveloper
  3. UPoseSearchSchema

UPoseSearchSchema

Specifies the format of a pose search index.

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/PoseSearchSchema.h
Include #include "PoseSearch/PoseSearchSchema.h"

Syntax

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

Remarks

Specifies the format of a pose search index. At runtime, queries are built according to the schema for searching.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere bool bAddDataPadding If true a padding channel will be added to make sure the data is 16 bytes (aligned) and padded, to facilitate performance improvements at cost of eventual additional memory
Public variable UProperty Category, EditAnywhere float BaseCostBias Base Cost added or removed to all poses from databases that use this config.
Public variable UProperty Category, EditAnywhere bool bInjectAdditionalDebugChannels If bInjectAdditionalDebugChannels is true, channels will be asked to inject additional channels into this schema.
Public variable UProperty Transient TArray< uint16 > BoneIndicesWithParents  
Public variable UProperty Transient TArray< FBoneReference > BoneReferences  
Public variable UProperty Category, EditAnywhere float ContinuingPoseCostBias Cost added to the continuing pose from databases that uses this config.
Public variable UProperty Category, EditAnywhere, Meta EPoseSearchDataPreprocessor DataPreprocessor Type of operation performed to the full pose features dataset.
Public variable UProperty Category, EditAnywhere float LoopingCostBias Cost added to all looping animation assets in a database that uses this config.
Public variable UProperty Category, EditAnywhere, Meta TObjectPtr< UMirrorDataTable > MirrorDataTable Setting up and assigning a mirror data table will allow all your assets in your database to access the mirrored version of the data. This is required for mirroring to work with Motion Matching.
Public variable UProperty Category, EditAnywhere, Meta int32 NumberOfPermutations How many times the animation assets of the database using this schema will be indexed.
Public variable UProperty Category, EditAnywhere, Meta int32 PermutationsSampleRate Delta time between every permutation indexing.
Public variable UProperty Category, EditAnywhere float PermutationsTimeOffset Starting offset of the "PermutationTime" from the "SamplingTime" of the first permutation.
Public variable UProperty Category, EditAnywhere, Meta int32 SampleRate The update rate at which we sample the animation data in the database. The higher the SampleRate the more refined your searches will be, but the more memory will be required.
Public variable UProperty Transient int32 SchemaCardinality  
Public variable UProperty Category, EditAnywhere, Meta TObjectPtr< USkeleton > Skeleton Skeleton Reference for Motion Matching Database assets. Must be set to a compatible skeleton to the animation data in the database.

Functions

  Type Name Description
Public function int8

AddBoneReference ( const FBoneReference& BoneReference
)

  
Public function void  
Public function void  
Public function Const void  
Public function Const const UPoseSearchFeatureChannel *

FindChannel ( FindPredicateType FindPredicate
)

  
Public function Const const ChannelType *  
Public function Const FBoneIndexType

GetBoneIndexType ( int8 SchemaBoneIdx
)

  
Public function Const TConstArrayView< TObjectPtr< UPoseSearchFeatureChannel > >  
Public function USkeleton *

GetSkeleton ( bool& bInvalidSkeletonIsError,
const IPropertyHandle* PropertyHandle
)

 IBoneReferenceSkeletonProvider.
Public function Const bool

IsRootBone ( int8 SchemaBoneIdx
)

  
Public function Const bool

IsValid ()

  

Overridden from UObject

  Type Name Description
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

PreSave ( FObjectPreSaveContext ObjectSaveContext
)

 UObject.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page