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::Frame Class Reference

#include <Frame.h>

Public Member Functions

 Frame (size_t frameIndex, Motion *sourceMotion, float sampleTime, bool mirrored)
 
void SamplePose (Pose *outputPose, float timeOffset=0.0f) const
 
Motion * GetSourceMotion () const
 
float GetSampleTime () const
 
size_t GetFrameIndex () const
 
bool GetMirrored () const
 
void SetSourceMotion (Motion *sourceMotion)
 
void SetSampleTime (float sampleTime)
 
void SetFrameIndex (size_t frameIndex)
 
void SetMirrored (bool enabled)
 

Detailed Description

A motion matching frame. This holds information required in order to extract a given pose in a given motion.

Member Function Documentation

◆ SamplePose()

void EMotionFX::MotionMatching::Frame::SamplePose ( Pose *  outputPose,
float  timeOffset = 0.0f 
) const

Sample the pose for the given frame.

Parameters
[in]outputPoseThe pose used to store the sampled result.
[in]timeOffsetFrames in the frame database are samples with a given sample rate (default = 30 fps). For calculating velocities for example, it is needed to sample a pose close to a frame but not exactly at the frame position. The timeOffset parameter can be used for that and represents the offset in time from the frame sample time in seconds. In case the time offset is 0.0, the pose exactly at the frame position will be sampled.

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