Open 3D Engine Maestro Gem API Reference 25.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | List of all members
Maestro::CSelectTrack Class Reference

#include <SelectTrack.h>

Inherits Maestro::TAnimTrack< ISelectKey >.

Public Member Functions

 AZ_CLASS_ALLOCATOR (CSelectTrack, AZ::SystemAllocator)
 
 AZ_RTTI (CSelectTrack, "{D05D53BF-86D1-4D38-A3C6-4EFC09C16431}", IAnimTrack)
 
AnimValueType GetValueType () const override
 
void GetKeyInfo (int keyIndex, const char *&description, float &duration) const override
 
void SetKey (int keyIndex, IKey *key) override
 
int GetActiveKey (float time, ISelectKey *key) override
 
void CalculateDurationForEachKey ()
 
void SerializeKey (ISelectKey &key, XmlNodeRef &keyNode, bool bLoading) override
 
- Public Member Functions inherited from Maestro::TAnimTrack< ISelectKey >
 AZ_CLASS_ALLOCATOR (TAnimTrack, AZ::SystemAllocator)
 
 AZ_RTTI ((TAnimTrack, "{D6E0F0E3-8843-46F0-8484-7B6E130409AE}", ISelectKey), IAnimTrack)
 
EAnimCurveType GetCurveType () const override
 
AnimValueType GetValueType () const override
 
void SetNode (IAnimNode *node) override
 
IAnimNode * GetNode () const override
 
int GetSubTrackCount () const override
 
IAnimTrack * GetSubTrack (int nIndex) const override
 
AZStd::string GetSubTrackName (int nIndex) const override
 
void SetSubTrackName (int nIndex, const char *name) override
 
const CAnimParamType & GetParameterType () const override
 
void SetParameterType (CAnimParamType type) override
 
void add_ref () override
 
void release () override
 
bool IsKeySelected (int keyIndex) const override
 
void SelectKey (int keyIndex, bool select) override
 
bool IsSortMarkerKey (int keyIndex) const override
 
void SetSortMarkerKey (int keyIndex, bool enabled) override
 
int GetNumKeys () const override
 Return number of keys in track.
 
bool HasKeys () const override
 Return true if keys exists in this track.
 
void SetNumKeys (int numKeys) override
 
void RemoveKey (int keyIndex) override
 Remove specified key.
 
int CreateKey (float time) override
 
int CloneKey (int srcKeyIndex, float timeOffset) override
 
int CopyKey (IAnimTrack *pFromTrack, int fromKeyIndex) override
 
void GetKey (int keyIndex, IKey *key) const override
 
float GetKeyTime (int keyIndex) const override
 
float GetMinKeyTimeDelta () const override
 
int FindKey (float time) const override
 
int GetKeyFlags (int keyIndex) override
 
void SetKey (int keyIndex, IKey *key) override
 
void SetKeyTime (int keyIndex, float time) override
 Set time of specified key.
 
void SetKeyFlags (int keyIndex, int flags) override
 Set flags of specified key.
 
void SortKeys () override
 Sort keys in track (after time of keys was modified).
 
int GetFlags () const override
 Get track flags.
 
bool IsMasked (const uint32 mask) const override
 Check if track is masked.
 
void SetFlags (int flags) override
 Set track flags.
 
void GetValue (float time, float &value, bool applyMultiplier=false) const override
 
void GetValue (float time, AZ::Vector3 &value, bool applyMultiplier=false) const override
 
void GetValue (float time, AZ::Vector4 &value, bool applyMultiplier=false) const override
 
void GetValue (float time, AZ::Quaternion &value) const override
 
void GetValue (float time, bool &value) const override
 
void GetValue (float time, AssetBlends< AZ::Data::AssetData > &value) const override
 
void GetValue (float time, AZStd::string &value) const override
 
void SetValue (float time, const float &value, bool bDefault=false, bool applyMultiplier=false) override
 
void SetValue (float time, const AZ::Vector3 &value, bool bDefault=false, bool applyMultiplier=false) override
 
void SetValue (float time, const AZ::Vector4 &value, bool bDefault=false, bool applyMultiplier=false) override
 
void SetValue (float time, const AZ::Quaternion &value, bool bDefault=false) override
 
void SetValue (float time, const bool &value, bool bDefault=false) override
 
void SetValue (float time, const AssetBlends< AZ::Data::AssetData > &value, bool bDefault=false) override
 
void SetValue (float time, const AZStd::string &value, bool bDefault=false) override
 
void OffsetKeyPosition (const AZ::Vector3 &value) override
 
void UpdateKeyDataAfterParentChanged (const AZ::Transform &oldParentWorldTM, const AZ::Transform &newParentWorldTM) override
 
void SetTimeRange (const Range &timeRange) override
 
Range GetTimeRange () const override
 
bool Serialize (XmlNodeRef &xmlNode, bool bLoading, bool bLoadEmptyTracks=true) override
 
bool SerializeSelection (XmlNodeRef &xmlNode, bool bLoading, bool bCopySelected=false, float fTimeOffset=0) override
 
void InitPostLoad (IAnimSequence *sequence) override
 
void GetKeyValueRange (float &fMin, float &fMax) const override
 
void SetKeyValueRange (float fMin, float fMax) override
 
void SetMultiplier (float trackMultiplier) override
 
void SetExpanded (bool expanded) override
 
bool GetExpanded () const override
 
unsigned int GetId () const override
 
void SetId (unsigned int id) override
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
- Static Public Member Functions inherited from Maestro::TAnimTrack< ISelectKey >
static void Reflect (AZ::ReflectContext *context)
 

Additional Inherited Members

- Protected Types inherited from Maestro::TAnimTrack< ISelectKey >
typedef AZStd::vector< ISelectKey > Keys
 
- Protected Attributes inherited from Maestro::TAnimTrack< ISelectKey >
int m_refCount
 
Keys m_keys
 
Range m_timeRange
 
CAnimParamType m_nParamType
 
int m_currKey
 
float m_lastTime
 
int m_flags
 
float m_fMinKeyValue
 
float m_fMaxKeyValue
 
IAnimNode * m_node
 
float m_trackMultiplier
 
unsigned int m_id
 

Detailed Description

Select track. Used to select Cameras on a Director's Camera Track

Member Function Documentation

◆ GetActiveKey()

int Maestro::CSelectTrack::GetActiveKey ( float  time,
ISelectKey *  key 
)
overridevirtual

Get last key before specified time.

Returns
Index of key, or -1 if such key not exist.

Reimplemented from Maestro::TAnimTrack< ISelectKey >.

◆ SerializeKey()

void Maestro::CSelectTrack::SerializeKey ( ISelectKey &  key,
XmlNodeRef &  keyNode,
bool  bLoading 
)
overridevirtual

Serialize single key of this track. Override this in derived classes. Do not save time attribute, it is already saved in Serialize of the track.

Implements Maestro::TAnimTrack< ISelectKey >.

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