1. Epic GamesDeveloper
  3. FAnimNode_PoseSearchHistoryCollector_Base

FAnimNode_PoseSearchHistoryCollector_Base

API > API/Plugins > API/Plugins/PoseSearch

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

Syntax

USTRUCT (BlueprintInternalUseOnly)  
struct FAnimNode_PoseSearchHistoryCollector_Base : public FAnimNode_Base

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

PRAGMA_DISABLE_DEPRECATION_WARNINGS FAnimNode_PoseSearchHistoryCollector_Base ()

 Note: We need to explicitly disable warnings on these constructors/operators for clang to be happy with deprecated variables this is a requirement for clang to compile without warnings. PoseSearch/AnimNode_PoseSearchHistoryCollector.h  
  PoseSearch/AnimNode_PoseSearchHistoryCollector.h  
  PoseSearch/AnimNode_PoseSearchHistoryCollector.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FAnimNode_PoseSearchHistoryCollector_Base()

   PoseSearch/AnimNode_PoseSearchHistoryCollector.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bCacheBones bool   PoseSearch/AnimNode_PoseSearchHistoryCollector.h  
bGenerateTrajectory bool If true Trajectory the pose history node will generate the trajectory using the TrajectoryData parameters instead of relying on the input Trajectory Experimental, this feature might be removed without warning, not for production use PoseSearch/AnimNode_PoseSearchHistoryCollector.h
  • EditAnywhere
  • Category=Experimental
bResetOnBecomingRelevant bool Reset the pose history if it has become relevant to the graph after not being updated on previous frames. PoseSearch/AnimNode_PoseSearchHistoryCollector.h
  • EditAnywhere
  • Category=Settings
bStoreScales bool If true pose scales will be cached, otherwise implied to be unitary scales PoseSearch/AnimNode_PoseSearchHistoryCollector.h
  • EditAnywhere
  • Category=Settings
CollectedBones TArray< FBoneReference >   PoseSearch/AnimNode_PoseSearchHistoryCollector.h
  • EditAnywhere
  • Category=Settings
CollectedCurves TArray< FName >   PoseSearch/AnimNode_PoseSearchHistoryCollector.h
  • EditAnywhere
  • Category=Settings
DebugColor FLinearColor   PoseSearch/AnimNode_PoseSearchHistoryCollector.h
  • EditAnywhere
  • Category=Debug
PoseCount int32 The maximum amount of poses that can be stored. PoseSearch/AnimNode_PoseSearchHistoryCollector.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
  • Meta=(ClampMin="2")
PredictionSamplingInterval float If bGenerateTrajectory is true, this is the sampling interval between trajectory future (prediction) samples PoseSearch/AnimNode_PoseSearchHistoryCollector.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Experimental
  • Meta=(ClampMin="0.001", EditCondition="bGenerateTrajectory", EditConditionHides)
RootBoneRecoveryTime float Time in seconds to recover to the reference skeleton root bone transform by RootBoneTranslationRecoveryRatio and RootBoneRotationRecoveryRatio from any eventual root bone modification. PoseSearch/AnimNode_PoseSearchHistoryCollector.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Experimental
  • Meta=(ClampMin="0")
RootBoneRotationRecoveryRatio float Ratio to recover to the reference skeleton root bone rotation from any eventual root bone modification. zero for no recovery, 1 for full recovery PoseSearch/AnimNode_PoseSearchHistoryCollector.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Experimental
  • Meta=(ClampMin="0", ClampMax="1", EditCondition="RootBoneRecoveryTime > 0", EditConditionHides)
RootBoneTranslationRecoveryRatio float Ratio to recover to the reference skeleton root bone translation from any eventual root bone modification. zero for no recovery, 1 for full recovery PoseSearch/AnimNode_PoseSearchHistoryCollector.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Experimental
  • Meta=(ClampMin="0", ClampMax="1", EditCondition="RootBoneRecoveryTime > 0", EditConditionHides)
SamplingInterval float How often in seconds poses are collected (if 0, it will collect every update) PoseSearch/AnimNode_PoseSearchHistoryCollector.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
  • Meta=(ClampMin="0")
Trajectory PRAGMA_DISABLE_DEPRECATION_WARNINGSFPoseSearchQueryTrajectory   PoseSearch/AnimNode_PoseSearchHistoryCollector.h  
TrajectoryData FPoseSearchTrajectoryData If bGenerateTrajectory is true, TrajectoryData contains the tuning parameters to generate the trajectory PoseSearch/AnimNode_PoseSearchHistoryCollector.h
  • EditAnywhere
  • Category=Experimental
  • Meta=(EditCondition="bGenerateTrajectory", EditConditionHides)
TrajectoryHistoryCount int32 If bGenerateTrajectory is true, this is the number of trajectory past (collected) samples PoseSearch/AnimNode_PoseSearchHistoryCollector.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Experimental
  • Meta=(ClampMin="2", EditCondition="bGenerateTrajectory", EditConditionHides)
TrajectoryPredictionCount int32 If bGenerateTrajectory is true, this is the number of trajectory future (prediction) samples PoseSearch/AnimNode_PoseSearchHistoryCollector.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Experimental
  • Meta=(ClampMin="2", EditCondition="bGenerateTrajectory", EditConditionHides)
TrajectorySpeedMultiplier float Input Trajectory velocity will be multiplied by TrajectorySpeedMultiplier: values below 1 will result in selecting animation slower than requested from the original Trajectory. PoseSearch/AnimNode_PoseSearchHistoryCollector.h
  • EditAnywhere
  • Category=Experimental
  • Meta=(PinHiddenByDefault, ClampMin="0", EditCondition="!bGenerateTrajectory", EditConditionHides)
TransformTrajectory FTransformTrajectory Input Trajectory samples for pose search queries in Motion Matching. PoseSearch/AnimNode_PoseSearchHistoryCollector.h
  • EditAnywhere
  • Transient
  • Category=Settings
  • DisplayName="Trajectory"
  • Meta=(PinShownByDefault, EditCondition="!bGenerateTrajectory", EditConditionHides)
UpdateCounter FGraphTraversalCounter Update Counter for detecting being relevant. PoseSearch/AnimNode_PoseSearchHistoryCollector.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
PoseHistoryPtr TSharedPtr< UE::PoseSearch::FGenerateTrajectoryPoseHistory, ESPMode::ThreadSafe >   PoseSearch/AnimNode_PoseSearchHistoryCollector.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void GenerateTrajectory ( const UAnimInstance* InAnimInstance
)

   PoseSearch/AnimNode_PoseSearchHistoryCollector.h  
  PoseSearch/AnimNode_PoseSearchHistoryCollector.h  
  PoseSearch/AnimNode_PoseSearchHistoryCollector.h  

FPoseHistoryReference GetPoseHistoryReference()

   PoseSearch/AnimNode_PoseSearchHistoryCollector.h  

Overridden from FAnimNode_Base

Name Remarks Include Path Unreal Specifiers

virtual void CacheBones_AnyThread ( const FAnimationCacheBonesContext& Context
)

   PoseSearch/AnimNode_PoseSearchHistoryCollector.h  

virtual void Initialize_AnyThread ( const FAnimationInitializeContext& Context
)

   PoseSearch/AnimNode_PoseSearchHistoryCollector.h  

virtual bool NeedsOnInitializeAnimInstance()

   PoseSearch/AnimNode_PoseSearchHistoryCollector.h  

virtual void OnInitializeAnimInstance ( const FAnimInstanceProxy* InProxy,
const UAnimInstance* InAnimInstance
)

   PoseSearch/AnimNode_PoseSearchHistoryCollector.h  

virtual void Update_AnyThread ( const FAnimationUpdateContext& Context
)

   PoseSearch/AnimNode_PoseSearchHistoryCollector.h  

Protected

Name Remarks Include Path Unreal Specifiers

TArray< FBoneIndexType > GetRequiredBones ( const FAnimInstanceProxy* AnimInstanceProxy
) const

 Returns an array of skeleton bone indexes (encoded as FBoneIndexType) PoseSearch/AnimNode_PoseSearchHistoryCollector.h  

Operators

Name Remarks Include Path Unreal Specifiers
  PoseSearch/AnimNode_PoseSearchHistoryCollector.h  
  PoseSearch/AnimNode_PoseSearchHistoryCollector.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bInitializeWithRefPose_DEPRECATED bool   PoseSearch/AnimNode_PoseSearchHistoryCollector.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page