1. Epic GamesDeveloper
  3. FPoseHistory

FPoseHistory

API > API/Plugins > API/Plugins/PoseSearch

   
Name FPoseHistory
Type struct
Header File /Engine/Plugins/Animation/PoseSearch/Source/Runtime/Public/PoseSearch/PoseSearchHistory.h
Include Path #include "PoseSearch/PoseSearchHistory.h"

Syntax

struct FPoseHistory : public UE::PoseSearch::IPoseHistory

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

PRAGMA_DISABLE_DEPRECATION_WARNINGS FPoseHistory ()

   PoseSearch/PoseSearchHistory.h  

FPoseHistory ( const FPoseHistory& Other
)

   PoseSearch/PoseSearchHistory.h  
  PoseSearch/PoseSearchHistory.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FPoseHistory()

   PoseSearch/PoseSearchHistory.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
BoneToTransformMap FBoneToTransformMap Map from skeleton bone indexes (encoded as FBoneIndexType) to internal pose history transform index (FComponentSpaceTransformIndex). PoseSearch/PoseSearchHistory.h  
BoneToTransformMapTypeHash uint32 GetTypeHash for BoneToTransformMap. PoseSearch/PoseSearchHistory.h  
CollectedCurves TArray< FName > List of curves that we want to collect into our history. PoseSearch/PoseSearchHistory.h  
Entries TRingBuffer< FPoseHistoryEntry > Ring buffer of collected bones PoseSearch/PoseSearchHistory.h  
LastUpdateSkeleton TWeakObjectPtr< const USkeleton > Skeleton from the last Update, to keep tracking skeleton changes, and support compatible skeletons PoseSearch/PoseSearchHistory.h  
MaxNumPoses int32 Caching MaxNumPoses, since FData::Entries.Max() is a padded number PoseSearch/PoseSearchHistory.h  
PoseDataThreadSafeCounter FRWTransactionallySafeAccessDetector   PoseSearch/PoseSearchHistory.h  
PoseIndicesHistory FPoseIndicesHistory Datra structure containing the previously played pose indexes with their respective datababases PoseSearch/PoseSearchHistory.h  
SamplingInterval float   PoseSearch/PoseSearchHistory.h  
Trajectory FTransformTrajectory   PoseSearch/PoseSearchHistory.h  
TrajectoryDataState FPoseSearchTrajectoryData::FState   PoseSearch/PoseSearchHistory.h  
TrajectorySpeedMultiplier float   PoseSearch/PoseSearchHistory.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void EvaluateComponentSpace_AnyThread ( float DeltaTime,
FCSPose< FCompactPose >& ComponentSpacePose,
bool bStoreScales,
float RootBoneRecoveryTime,
float RootBoneTranslationRecoveryRatio,
float RootBoneRotationRecoveryRatio,
bool bNeedsReset,
bool bCacheBones,
const TArray< FBoneIndexType >& RequiredBones,
const FBlendedCurve& Curves,
const TConstArrayView< FName >& InCollectedCurves
)

   PoseSearch/PoseSearchHistory.h  

void EvaluateComponentSpace_AnyThread ( float DeltaTime,
IComponentSpacePoseProvider& ComponentSpacePoseProvider,
bool bStoreScales,
float RootBoneRecoveryTime,
float RootBoneTranslationRecoveryRatio,
float RootBoneRotationRecoveryRatio,
bool bNeedsReset,
bool bCacheBones,
const TArray< FBoneIndexType >& RequiredBones,
const FBlendedCurve& Curves,
const TConstArrayView< FName >& InCollectedCurves
)

   PoseSearch/PoseSearchHistory.h  

void GenerateTrajectory ( const UObject* AnimContext,
float DeltaTime,
const FPoseSearchTrajectoryData& TrajectoryData,
const FPoseSearchTrajectoryData::FSampling& TrajectoryDataSampling
)

   PoseSearch/PoseSearchHistory.h  

int32 GetMaxNumPoses()

   PoseSearch/PoseSearchHistory.h  

float GetSamplingInterval()

   PoseSearch/PoseSearchHistory.h  

void Initialize_AnyThread ( int32 InNumPoses,
float InSamplingInterval
)

   PoseSearch/PoseSearchHistory.h  

void PreUpdate()

   PoseSearch/PoseSearchHistory.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGS void SetTrajectory ( const FPoseSearchQueryTrajectory& InTrajectory,
float InTrajectorySpeedMultiplier
)

 We need to handle the changes from CL 39422514 since licensees still haven't gotten the move of this function to the IPoseHistory, as of 5.5, therefore this function still needs to be marked as deprecated even tho it was deleted later on. PoseSearch/PoseSearchHistory.h  

Overridden from IPoseHistory

Name Remarks Include Path Unreal Specifiers

virtual void DebugDraw ( FAnimInstanceProxy& AnimInstanceProxy,
FColor Color
) const

   PoseSearch/PoseSearchHistory.h  

virtual void DebugDraw ( const UWorld* World,
FColor Color
) const

   PoseSearch/PoseSearchHistory.h  

virtual void GenerateTrajectory ( const UObject* AnimContext,
float DeltaTime
)

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

virtual const FBoneToTransformMap & GetBoneToTransformMap()

   PoseSearch/PoseSearchHistory.h  

virtual const TConstArrayView< FName > GetCollectedCurves()

   PoseSearch/PoseSearchHistory.h  

virtual bool GetCurveValueAtTime ( float Time,
const FName& CurveName,
float& OutCurveValue,
bool bExtrapolate
) const

   PoseSearch/PoseSearchHistory.h  

virtual const FPoseHistoryEntry & GetEntry ( int32 EntryIndex
) const

   PoseSearch/PoseSearchHistory.h  

virtual int32 GetNumEntries()

   PoseSearch/PoseSearchHistory.h  

virtual const FPoseIndicesHistory * GetPoseIndicesHistory()

   PoseSearch/PoseSearchHistory.h  

virtual const FTransformTrajectory & GetTrajectory ()

 For review: Here we are just changing the return type to force users to update immediately. PoseSearch/PoseSearchHistory.h  

virtual float GetTrajectorySpeedMultiplier()

   PoseSearch/PoseSearchHistory.h  

virtual bool GetTransformAtTime ( float Time,
FTransform& OutBoneTransform,
const USkeleton* BoneIndexSkeleton,
FBoneIndexType BoneIndexType,
FBoneIndexType ReferenceBoneIndexType,
bool bExtrapolate
) const

 Returns transform of the the skeleton bone index BoneIndexType (encoded as FBoneIndexType) relative to the transform of ReferenceBoneIndexType: if ReferenceBoneIndexType is 0 (RootBoneIndexType), OutBoneTransform is in root bone space if ReferenceBoneIndexType is FBoneIndexType(-1) (ComponentSpaceIndexType), OutBoneTransform is in component space if ReferenceBoneIndexType is FBoneIndexType(-2) (WorldSpaceIndexType), OutBoneTransform is in world space PoseSearch/PoseSearchHistory.h  

virtual bool IsEmpty()

   PoseSearch/PoseSearchHistory.h  

virtual void SetTrajectory ( const FTransformTrajectory& InTrajectory,
float InTrajectorySpeedMultiplier
)

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

Operators

Name Remarks Include Path Unreal Specifiers

FPoseHistory & operator= ( const FPoseHistory& Other
)

   PoseSearch/PoseSearchHistory.h  
  PoseSearch/PoseSearchHistory.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page