1. Epic GamesDeveloper
  3. UPoseSearchSchema

UPoseSearchSchema

Specifies the format of a pose search index.

API > API/Plugins > API/Plugins/PoseSearch

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

   
Name UPoseSearchSchema
Type class
Header File /Engine/Plugins/Animation/PoseSearch/Source/Runtime/Public/PoseSearch/PoseSearchSchema.h
Include Path #include "PoseSearch/PoseSearchSchema.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, Category="Animation|Pose Search",  
       Meta=(DisplayName="Pose Search Schema"), CollapseCategories)  
class UPoseSearchSchema : public UDataAsset

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAddDataPadding bool 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 PoseSearch/PoseSearchSchema.h
  • EditAnywhere
  • Category="Performance"
bDrawInjectAdditionalDebugChannels bool If bDrawInjectAdditionalDebugChannels is true, all the channels added for debug purposes with bInjectAdditionalDebugChannels (as well as all those channels with an associated zero weight) will be drawn PoseSearch/PoseSearchSchema.h
  • EditAnywhere
  • Category="Debug"
bInjectAdditionalDebugChannels bool If bInjectAdditionalDebugChannels is true, channels will be asked to inject additional channels into this schema. PoseSearch/PoseSearchSchema.h
  • EditAnywhere
  • Category="Debug"
DataPreprocessor EPoseSearchDataPreprocessor Type of operation performed to the full pose features dataset. PoseSearch/PoseSearchSchema.h
  • EditAnywhere
  • Category="Schema"
  • Meta=(DisplayPriority=2)
NumberOfPermutations int32 How many times the animation assets of the database using this schema will be indexed. PoseSearch/PoseSearchSchema.h
  • EditAnywhere
  • Category="Permutations"
  • Meta=(ClampMin="1")
PermutationsSampleRate int32 Delta time between every permutation indexing. PoseSearch/PoseSearchSchema.h
  • EditAnywhere
  • Category="Permutations"
  • Meta=(ClampMin="1", ClampMax="240", EditCondition="NumberOfPermutations > 1", EditConditionHides)
PermutationsTimeOffset float Starting offset of the "PermutationTime" from the "SamplingTime" of the first permutation. PoseSearch/PoseSearchSchema.h
  • EditAnywhere
  • Category="Permutations"
SampleRate int32 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. PoseSearch/PoseSearchSchema.h
  • EditAnywhere
  • Category="Schema"
  • Meta=(DisplayPriority=3, ClampMin="1", ClampMax="240")
SchemaCardinality int32   PoseSearch/PoseSearchSchema.h
  • Transient

Protected

Name Type Remarks Include Path Unreal Specifiers
Channels TArray< TObjectPtr< UPoseSearchFeatureChannel > > Channels itemize the cost breakdown of the Schema in simpler parts such as position or velocity of a bones, or phase of limbs. The total cost of a query against an indexed database pose will be the sum of the combined channel costs. PoseSearch/PoseSearchSchema.h
  • EditAnywhere
  • Instanced
  • Category="Schema"
FinalizedChannels TArray< TObjectPtr< UPoseSearchFeatureChannel > > FinalizedChannels gets populated with UPoseSearchFeatureChannel(s) from Channels and additional injected ones during the Finalize. PoseSearch/PoseSearchSchema.h
  • Transient
Skeletons TArray< FPoseSearchRoledSkeleton >   PoseSearch/PoseSearchSchema.h
  • EditAnywhere
  • Category="Schema"
  • Meta=(DisplayPriority=0)

Functions

Public

Name Remarks Include Path Unreal Specifiers

int8 AddBoneReference ( const FBoneReference& BoneReference,
const UE::PoseSearch::FRole& Role,
bool bDefaultWithRootBone
)

 Experimental, this feature might be removed without warning, not for production use. PoseSearch/PoseSearchSchema.h  

int8 AddBoneReference ( const FBoneReference& BoneReference,
const UE::PoseSearch::FRole& Role
)

   PoseSearch/PoseSearchSchema.h  

void AddChannel ( UPoseSearchFeatureChannel* Channel
)

   PoseSearch/PoseSearchSchema.h  

int8 AddCurveReference ( const FName& CurveReference,
const UE::PoseSearch::FRole& Role
)

   PoseSearch/PoseSearchSchema.h  

void AddDefaultChannels()

   PoseSearch/PoseSearchSchema.h  

void AddSkeleton ( USkeleton* Skeleton,
UMirrorDataTable* MirrorDataTable,
const UE::PoseSearch::FRole& Role
)

   PoseSearch/PoseSearchSchema.h  

void AddTemporaryChannel ( UPoseSearchFeatureChannel* DependentChannel
)

   PoseSearch/PoseSearchSchema.h  

bool AllRoledSkeletonHaveMirrorDataTable()

   PoseSearch/PoseSearchSchema.h  

bool AreSkeletonsCompatible ( const UPoseSearchSchema* Other
) const

   PoseSearch/PoseSearchSchema.h  

TConstArrayView< float > BuildQuery ( UE::PoseSearch::FSearchContext& SearchContext
) const

   PoseSearch/PoseSearchSchema.h  

const UPoseSearchFeatureChannel * FindChannel ( FindPredicateType FindPredicate
) const

   PoseSearch/PoseSearchSchema.h  

const ChannelType * FindFirstChannelOfType()

   PoseSearch/PoseSearchSchema.h  

TConstArrayView< FBoneReference > GetBoneReferences ( const UE::PoseSearch::FRole& Role
) const

   PoseSearch/PoseSearchSchema.h  

TConstArrayView< TObjectPtr< UPoseSearchFeatureChannel > > GetChannels()

   PoseSearch/PoseSearchSchema.h  

const UE::PoseSearch::FRole GetDefaultRole()

   PoseSearch/PoseSearchSchema.h  

UMirrorDataTable * GetMirrorDataTable ( const UE::PoseSearch::FRole& Role
) const

   PoseSearch/PoseSearchSchema.h  

const FPoseSearchRoledSkeleton * GetRoledSkeleton ( const UE::PoseSearch::FRole& Role
) const

   PoseSearch/PoseSearchSchema.h  

FPoseSearchRoledSkeleton * GetRoledSkeleton ( const UE::PoseSearch::FRole& Role
)

   PoseSearch/PoseSearchSchema.h  

const TArray< FPoseSearchRoledSkeleton > & GetRoledSkeletons()

   PoseSearch/PoseSearchSchema.h  

USkeleton * GetSkeleton ( const UE::PoseSearch::FRole& Role
) const

   PoseSearch/PoseSearchSchema.h  

void InitBoneContainersFromRoledSkeleton ( TMap< FName, FBoneContainer >& RoledBoneContainers
) const

   PoseSearch/PoseSearchSchema.h  

void IterateChannels ( IteratePredicateType IteratePredicate
) const

   PoseSearch/PoseSearchSchema.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   PoseSearch/PoseSearchSchema.h  

virtual void PostLoad()

 UObject. PoseSearch/PoseSearchSchema.h  

Static

Name Remarks Include Path Unreal Specifiers

static const UPoseSearchFeatureChannel * FindChannelRecursive ( TConstArrayView< TObjectPtr< UPoseSearchFeatureChannel > > Channels,
FindPredicateType FindPredicate
)

   PoseSearch/PoseSearchSchema.h  

static void IterateChannelsRecursive ( TConstArrayView< TObjectPtr< UPoseSearchFeatureChannel > > Channels,
IteratePredicateType IteratePredicate
)

   PoseSearch/PoseSearchSchema.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
MirrorDataTable_DEPRECATED TObjectPtr< UMirrorDataTable >   PoseSearch/PoseSearchSchema.h  
Skeleton_DEPRECATED TObjectPtr< USkeleton >   PoseSearch/PoseSearchSchema.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page