Open 3D Engine MotionMatching Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
EMotionFX::MotionMatching::FeatureVelocity Class Reference

Inherits EMotionFX::MotionMatching::Feature.

Public Member Functions

void ExtractFeatureValues (const ExtractFeatureContext &context) override
 
void FillQueryVector (QueryVector &queryVector, const QueryVectorContext &context) override
 
float CalculateFrameCost (size_t frameIndex, const FrameCostContext &context) const override
 
void DebugDraw (AzFramework::DebugDisplayRequests &debugDisplay, const Pose &currentPose, const FeatureMatrix &featureMatrix, const FeatureMatrixTransformer *featureTransformer, size_t frameIndex) override
 
size_t GetNumDimensions () const override
 
AZStd::string GetDimensionName (size_t index) const override
 
- Public Member Functions inherited from EMotionFX::MotionMatching::Feature
virtual bool Init (const InitSettings &settings)
 
virtual void ExtractFeatureValues (const ExtractFeatureContext &context)=0
 
virtual void FillQueryVector (QueryVector &queryVector, const QueryVectorContext &context)=0
 
virtual float CalculateFrameCost (size_t frameIndex, const FrameCostContext &context) const
 
void SetCostFactor (float costFactor)
 
float GetCostFactor () const
 
virtual void DebugDraw (AzFramework::DebugDisplayRequests &debugDisplay, const Pose &currentPose, const FeatureMatrix &featureMatrix, const FeatureMatrixTransformer *featureTransformer, size_t frameIndex)
 
void SetDebugDrawColor (const AZ::Color &color)
 
const AZ::Color & GetDebugDrawColor () const
 
void SetDebugDrawEnabled (bool enabled)
 
bool GetDebugDrawEnabled () const
 
void SetJointName (const AZStd::string &jointName)
 
const AZStd::string & GetJointName () const
 
void SetRelativeToJointName (const AZStd::string &jointName)
 
const AZStd::string & GetRelativeToJointName () const
 
void SetName (const AZStd::string &name)
 
const AZStd::string & GetName () const
 
virtual size_t GetNumDimensions () const =0
 
virtual AZStd::string GetDimensionName (size_t index) const
 
FeatureMatrix::Index GetColumnOffset () const
 
void SetColumnOffset (FeatureMatrix::Index offset)
 
const AZ::TypeId & GetId () const
 
size_t GetRelativeToNodeIndex () const
 
void SetRelativeToNodeIndex (size_t nodeIndex)
 

Static Public Member Functions

static void DebugDraw (AzFramework::DebugDisplayRequests &debugDisplay, const Pose &pose, const AZ::Vector3 &velocity, size_t jointIndex, size_t relativeToJointIndex, const AZ::Color &color)
 
static void Reflect (AZ::ReflectContext *context)
 
- Static Public Member Functions inherited from EMotionFX::MotionMatching::Feature
static void Reflect (AZ::ReflectContext *context)
 

Additional Inherited Members

- Public Types inherited from EMotionFX::MotionMatching::Feature
enum  ResidualType { Absolute , Squared }
 
- Protected Member Functions inherited from EMotionFX::MotionMatching::Feature
float GetNormalizedDirectionDifference (const AZ::Vector2 &directionA, const AZ::Vector2 &directionB) const
 
float GetNormalizedDirectionDifference (const AZ::Vector3 &directionA, const AZ::Vector3 &directionB) const
 
float CalcResidual (float value) const
 
float CalcResidual (const AZ::Vector3 &a, const AZ::Vector3 &b) const
 
virtual AZ::Crc32 GetCostFactorVisibility () const
 
- Protected Attributes inherited from EMotionFX::MotionMatching::Feature
AZ::TypeId m_id = AZ::TypeId::CreateRandom()
 
AZStd::string m_name
 
AZStd::string m_jointName
 
AZStd::string m_relativeToJointName
 
AZ::Color m_debugColor = AZ::Colors::Green
 
bool m_debugDrawEnabled = false
 
float m_costFactor = 1.0f
 
ResidualType m_residualType = ResidualType::Absolute
 
FeatureMatrix::Index m_featureColumnOffset
 
size_t m_relativeToNodeIndex = InvalidIndex
 
size_t m_jointIndex = InvalidIndex
 

Member Function Documentation

◆ CalculateFrameCost()

float EMotionFX::MotionMatching::FeatureVelocity::CalculateFrameCost ( size_t  frameIndex,
const FrameCostContext context 
) const
overridevirtual

◆ DebugDraw()

void EMotionFX::MotionMatching::FeatureVelocity::DebugDraw ( AzFramework::DebugDisplayRequests &  debugDisplay,
const Pose &  currentPose,
const FeatureMatrix featureMatrix,
const FeatureMatrixTransformer featureTransformer,
size_t  frameIndex 
)
overridevirtual

◆ ExtractFeatureValues()

void EMotionFX::MotionMatching::FeatureVelocity::ExtractFeatureValues ( const ExtractFeatureContext context)
overridevirtual

◆ FillQueryVector()

void EMotionFX::MotionMatching::FeatureVelocity::FillQueryVector ( QueryVector queryVector,
const QueryVectorContext context 
)
overridevirtual

◆ GetDimensionName()

AZStd::string EMotionFX::MotionMatching::FeatureVelocity::GetDimensionName ( size_t  index) const
overridevirtual

◆ GetNumDimensions()

size_t EMotionFX::MotionMatching::FeatureVelocity::GetNumDimensions ( ) const
overridevirtual

The documentation for this class was generated from the following file: