Open 3D Engine LyShine Gem API Reference  24.09
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
UiBoolTrack Class Reference

#include <BoolTrack.h>

Inherits TUiAnimTrack< IBoolKey >.

Public Member Functions

 AZ_RTTI (UiBoolTrack, "{F0EDB82F-B3D7-47FC-AA97-91358A7F1168}", IUiAnimTrack)
 
virtual EUiAnimValue GetValueType ()
 
virtual void GetValue (float time, bool &value)
 
virtual void SetValue (float time, const bool &value, bool bDefault=false)
 
void SerializeKey ([[maybe_unused]] IBoolKey &key, [[maybe_unused]] XmlNodeRef &keyNode, [[maybe_unused]] bool bLoading)
 
void GetKeyInfo (int key, const char *&description, float &duration)
 
void SetDefaultValue (const bool bDefaultValue)
 
- Public Member Functions inherited from TUiAnimTrack< IBoolKey >
 AZ_RTTI ((TUiAnimTrack, "{5513FA16-991D-40DD-99B2-9C5531AC872C}", IBoolKey), IUiAnimTrack)
 
EUiAnimCurveType GetCurveType () override
 
EUiAnimValue GetValueType () override
 
int GetSubTrackCount () const override
 
IUiAnimTrack * GetSubTrack ([[maybe_unused]] int nIndex) const override
 
AZStd::string GetSubTrackName ([[maybe_unused]] int nIndex) const override
 
void SetSubTrackName ([[maybe_unused]] int nIndex,[[maybe_unused]] const char *name) override
 
const CUiAnimParamType & GetParameterType () const override
 
void SetParameterType (CUiAnimParamType type) override
 
const UiAnimParamData & GetParamData () const override
 
void SetParamData (const UiAnimParamData &param) override
 
void add_ref () override
 
void release () override
 
bool IsKeySelected (int key) const override
 
void SelectKey (int key, bool select) 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 num) override
 Remove specified key.
 
int CreateKey (float time) override
 
int CloneKey (int fromKey) override
 
int CopyKey (IUiAnimTrack *pFromTrack, int nFromKey) override
 
void GetKey (int index, IKey *key) const override
 
float GetKeyTime (int index) const override
 
int FindKey (float time) override
 
int GetKeyFlags (int index) override
 
void SetKey (int index, IKey *key) override
 
void SetKeyTime (int index, float time) override
 Set time of specified key.
 
void SetKeyFlags (int index, int flags) override
 Set flags of specified key.
 
void SortKeys () override
 Sort keys in track (after time of keys was modified).
 
int GetFlags () override
 Get track flags.
 
bool IsMasked ([[maybe_unused]] const uint32 mask) const override
 Check if track is masked.
 
void SetFlags (int flags) override
 Set track flags.
 
void GetValue ([[maybe_unused]] float time,[[maybe_unused]] float &value) override
 
void GetValue ([[maybe_unused]] float time,[[maybe_unused]] Vec3 &value) override
 
void GetValue ([[maybe_unused]] float time,[[maybe_unused]] Vec4 &value) override
 
void GetValue ([[maybe_unused]] float time,[[maybe_unused]] Quat &value) override
 
void GetValue ([[maybe_unused]] float time,[[maybe_unused]] bool &value) override
 
void GetValue ([[maybe_unused]] float time,[[maybe_unused]] AZ::Vector2 &value) override
 
void GetValue ([[maybe_unused]] float time,[[maybe_unused]] AZ::Vector3 &value) override
 
void GetValue ([[maybe_unused]] float time,[[maybe_unused]] AZ::Vector4 &value) override
 
void GetValue ([[maybe_unused]] float time,[[maybe_unused]] AZ::Color &value) override
 
void SetValue ([[maybe_unused]] float time,[[maybe_unused]] const float &value,[[maybe_unused]] bool bDefault=false) override
 
void SetValue ([[maybe_unused]] float time,[[maybe_unused]] const Vec3 &value,[[maybe_unused]] bool bDefault=false) override
 
void SetValue ([[maybe_unused]] float time,[[maybe_unused]] const Vec4 &value,[[maybe_unused]] bool bDefault=false) override
 
void SetValue ([[maybe_unused]] float time,[[maybe_unused]] const Quat &value,[[maybe_unused]] bool bDefault=false) override
 
void SetValue ([[maybe_unused]] float time,[[maybe_unused]] const bool &value,[[maybe_unused]] bool bDefault=false) override
 
void SetValue ([[maybe_unused]] float time,[[maybe_unused]] const AZ::Vector2 &value,[[maybe_unused]] bool bDefault=false) override
 
void SetValue ([[maybe_unused]] float time,[[maybe_unused]] const AZ::Vector3 &value,[[maybe_unused]] bool bDefault=false) override
 
void SetValue ([[maybe_unused]] float time,[[maybe_unused]] const AZ::Vector4 &value,[[maybe_unused]] bool bDefault=false) override
 
void SetValue ([[maybe_unused]] float time,[[maybe_unused]] const AZ::Color &value,[[maybe_unused]] bool bDefault=false) override
 
void OffsetKeyPosition ([[maybe_unused]] const AZ::Vector3 &value) override
 
void SetTimeRange (const Range &timeRange) override
 
bool Serialize (IUiAnimationSystem *uiAnimationSystem, XmlNodeRef &xmlNode, bool bLoading, bool bLoadEmptyTracks=true) override
 
bool SerializeSelection (XmlNodeRef &xmlNode, bool bLoading, bool bCopySelected=false, float fTimeOffset=0) override
 
virtual void SerializeKey (IBoolKey &key, XmlNodeRef &keyNode, bool bLoading)=0
 
int GetActiveKey (float time, IBoolKey *key)
 
void GetKeyValueRange (float &fMin, float &fMax) const override
 
void SetKeyValueRange (float fMin, float fMax) override
 
- Public Member Functions inherited from IUiAnimTrack
virtual ColorB GetCustomColor () const =0
 
virtual void SetCustomColor (ColorB color)=0
 
virtual bool HasCustomColor () const =0
 
virtual void ClearCustomColor ()=0
 
virtual IUiAnimTrack * GetSubTrack (int nIndex) const =0
 
virtual AZStd::string GetSubTrackName (int nIndex) const =0
 
virtual void SetSubTrackName (int nIndex, const char *name)=0
 
virtual bool IsMasked (const uint32 mask) const =0
 Check if track is masked by mask.
 
virtual void GetValue (float time, float &value)=0
 
virtual void GetValue (float time, Vec3 &value)=0
 
virtual void GetValue (float time, Vec4 &value)=0
 
virtual void GetValue (float time, Quat &value)=0
 
virtual void GetValue (float time, AZ::Vector2 &value)=0
 
virtual void GetValue (float time, AZ::Vector3 &value)=0
 
virtual void GetValue (float time, AZ::Vector4 &value)=0
 
virtual void GetValue (float time, AZ::Color &value)=0
 
virtual void SetValue (float time, const float &value, bool bDefault=false)=0
 
virtual void SetValue (float time, const Vec3 &value, bool bDefault=false)=0
 
virtual void SetValue (float time, const Vec4 &value, bool bDefault=false)=0
 
virtual void SetValue (float time, const Quat &value, bool bDefault=false)=0
 
virtual void SetValue (float time, const AZ::Vector2 &value, bool bDefault=false)=0
 
virtual void SetValue (float time, const AZ::Vector3 &value, bool bDefault=false)=0
 
virtual void SetValue (float time, const AZ::Vector4 &value, bool bDefault=false)=0
 
virtual void SetValue (float time, const AZ::Color &value, bool bDefault=false)=0
 
virtual void OffsetKeyPosition (const AZ::Vector3 &value)=0
 
virtual void InitPostLoad (IUiAnimSequence *)
 
virtual void Animate ([[maybe_unused]] SUiAnimContext &ec)
 For custom track animate parameters.
 
virtual ISplineInterpolator * GetSpline () const
 
virtual bool IsKeySelected ([[maybe_unused]] int key) const
 
virtual void SelectKey ([[maybe_unused]] int key, [[maybe_unused]] bool select)
 
virtual int NextKeyByTime (int key) const
 
virtual int GetAnimationLayerIndex () const
 Get the animation layer index assigned. (only for character/look-at tracks ATM)
 
virtual void SetAnimationLayerIndex ([[maybe_unused]] int index)
 Set the animation layer index. (only for character/look-at tracks ATM)
 

Static Public Member Functions

static void Reflect (AZ::SerializeContext *serializeContext)
 
- Static Public Member Functions inherited from TUiAnimTrack< IBoolKey >
static void Reflect (AZ::SerializeContext *serializeContext)
 

Additional Inherited Members

- Public Types inherited from IUiAnimTrack
enum  EUiAnimTrackFlags {
  eUiAnimTrackFlags_Linear = BIT(1) , eUiAnimTrackFlags_Loop = BIT(2) , eUiAnimTrackFlags_Cycle = BIT(3) , eUiAnimTrackFlags_Disabled = BIT(4) ,
  eUiAnimTrackFlags_Hidden = BIT(5) , eUiAnimTrackFlags_Muted = BIT(8)
}
 Flags that can be set on animation track. More...
 
- Protected Types inherited from TUiAnimTrack< IBoolKey >
typedef AZStd::vector< IBoolKey > Keys
 
- Protected Member Functions inherited from TUiAnimTrack< IBoolKey >
void CheckValid ()
 
void Invalidate ()
 
- Protected Attributes inherited from TUiAnimTrack< IBoolKey >
int m_refCount
 
Keys m_keys
 
Range m_timeRange
 
CUiAnimParamType m_nParamType
 
unsigned int m_currKey
 
unsigned int m_bModified
 
float m_lastTime
 
int m_flags
 
UiAnimParamData m_componentParamData
 
float m_fMinKeyValue
 
float m_fMaxKeyValue
 
- Static Protected Attributes inherited from TUiAnimTrack< IBoolKey >
static constexpr unsigned int InvalidKey
 

Detailed Description

Boolean track, every key on this track negates boolean value.

Member Function Documentation

◆ GetKeyInfo()

void UiBoolTrack::GetKeyInfo ( int  key,
const char *&  description,
float &  duration 
)
virtual

Get info about specified key.

Parameters
Shorthuman readable text description of this key.
durationof this key in seconds.

Implements IUiAnimTrack.

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