Open 3D Engine LyShine 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.
CUiAnimViewTrack Class Reference

Inherits CUiAnimViewNode, and IUiAnimViewKeyBundle.

Public Member Functions

 CUiAnimViewTrack (IUiAnimTrack *pTrack, CUiAnimViewAnimNode *pTrackAnimNode, CUiAnimViewNode *pParentNode, bool bIsSubTrack=false, unsigned int subTrackIndex=0)
 
CUiAnimViewAnimNodeGetAnimNode () const
 
AZStd::string GetName () const override
 
virtual EUiAnimViewNodeType GetNodeType () const override
 
bool IsCompoundTrack () const
 
bool IsSubTrack () const
 
unsigned int GetSubTrackIndex () const
 
virtual bool SnapTimeToPrevKey (float &time) const override
 
virtual bool SnapTimeToNextKey (float &time) const override
 
virtual unsigned int GetKeyCount () const override
 
virtual CUiAnimViewKeyHandle GetKey (unsigned int index) override
 
virtual CUiAnimViewKeyConstHandle GetKey (unsigned int index) const
 
virtual CUiAnimViewKeyHandle GetKeyByTime (const float time)
 
virtual CUiAnimViewKeyHandle GetNearestKeyByTime (const float time)
 
virtual CUiAnimViewKeyBundle GetSelectedKeys () override
 
virtual CUiAnimViewKeyBundle GetAllKeys () override
 
virtual CUiAnimViewKeyBundle GetKeysInTimeRange (const float t0, const float t1) override
 
virtual CUiAnimViewKeyHandle CreateKey (const float time)
 
virtual void SlideKeys (const float time0, const float timeOffset)
 
void OffsetKeyPosition (const Vec3 &offset)
 
template<class Type >
void GetValue (const float time, Type &value) const
 
void GetKeyValueRange (float &min, float &max) const
 
CUiAnimParamType GetParameterType () const
 
EUiAnimValue GetValueType () const
 
EUiAnimCurveType GetCurveType () const
 
const UiAnimParamDataGetParamData () const
 
bool IsMasked (uint32 mask) const
 
IUiAnimTrack::EUiAnimTrackFlags GetFlags () const
 
ISplineInterpolator * GetSpline () const
 
ColorB GetCustomColor () const
 
void SetCustomColor (ColorB color)
 
bool HasCustomColor () const
 
void ClearCustomColor ()
 
virtual CUiAnimViewTrackMemento GetMemento () const
 
virtual void RestoreFromMemento (const CUiAnimViewTrackMemento &memento)
 
virtual void SetDisabled (bool bDisabled) override
 
virtual bool IsDisabled () const override
 
void SetMuted (bool bMuted)
 
bool IsMuted () const
 
virtual void SelectKeys (const bool bSelected) override
 
void PasteKeys (XmlNodeRef xmlNode, const float timeOffset)
 
virtual bool AreAllKeysOfSameType () const override
 
void SetAnimationLayerIndex (const int index)
 
int GetAnimationLayerIndex () const
 
- Public Member Functions inherited from CUiAnimViewNode
 CUiAnimViewNode (CUiAnimViewNode *pParent)
 
virtual AZStd::string GetName () const =0
 
virtual bool SetName (const char *pName)
 
virtual bool CanBeRenamed () const
 
virtual EUiAnimViewNodeType GetNodeType () const =0
 
CUiAnimViewSequenceGetSequence ()
 
CUiAnimViewNodeGetParentNode () const
 
unsigned int GetChildCount () const
 
CUiAnimViewNodeGetChild (unsigned int index) const
 
virtual bool SnapTimeToPrevKey (float &time) const =0
 
virtual bool SnapTimeToNextKey (float &time) const =0
 
virtual void SetSelected (bool bSelected)
 
virtual bool IsSelected () const
 
void ClearSelection ()
 
virtual void SetExpanded (bool bExpanded)
 
virtual bool IsExpanded () const
 
virtual void SetDisabled (bool bDisabled)
 
virtual bool IsDisabled () const
 
void SetHidden (bool bHidden)
 
bool IsHidden () const
 
virtual CUiAnimViewKeyBundle GetSelectedKeys ()=0
 
virtual CUiAnimViewKeyBundle GetAllKeys ()=0
 
virtual CUiAnimViewKeyBundle GetKeysInTimeRange (const float t0, const float t1)=0
 
bool HasObsoleteTrack () const
 
CUiAnimViewNodeGetAboveNode () const
 
CUiAnimViewNodeGetBelowNode () const
 
CUiAnimViewNodeGetPrevSibling () const
 
CUiAnimViewNodeGetNextSibling () const
 
virtual bool IsGroupNode () const
 
virtual void CopyKeysToClipboard (XmlNodeRef &xmlNode, const bool bOnlySelectedKeys, const bool bOnlyFromSelectedTracks)=0
 
bool operator< (const CUiAnimViewNode &pOtherNode) const
 
CUiAnimViewNodeGetFirstSelectedNode ()
 
CUiAnimViewAnimNodeGetDirector ()
 
virtual bool AreAllKeysOfSameType () const =0
 
virtual unsigned int GetKeyCount () const =0
 
virtual CUiAnimViewKeyHandle GetKey (unsigned int index)=0
 
virtual void SelectKeys (const bool bSelected)=0
 

Friends

class CUiAnimViewKeyHandle
 
class CUiAnimViewKeyConstHandle
 
class CUiAnimViewKeyBundle
 
class CAbstractUndoTrackTransaction
 

Additional Inherited Members

- Protected Member Functions inherited from CUiAnimViewNode
void AddNode (CUiAnimViewNode *pNode)
 
void SortNodes ()
 
bool HasObsoleteTrackRec (const CUiAnimViewNode *pCurrentNode) const
 
- Protected Attributes inherited from CUiAnimViewNode
CUiAnimViewNodem_pParentNode
 
std::vector< std::unique_ptr< CUiAnimViewNode > > m_childNodes
 
bool m_bSelected
 
bool m_bExpanded
 
bool m_bHidden
 

Member Function Documentation

◆ AreAllKeysOfSameType()

virtual bool CUiAnimViewTrack::AreAllKeysOfSameType ( ) const
inlineoverridevirtual

Implements IUiAnimViewKeyBundle.

◆ GetAllKeys()

virtual CUiAnimViewKeyBundle CUiAnimViewTrack::GetAllKeys ( )
overridevirtual

Implements CUiAnimViewNode.

◆ GetKey()

virtual CUiAnimViewKeyHandle CUiAnimViewTrack::GetKey ( unsigned int  index)
overridevirtual

Implements IUiAnimViewKeyBundle.

◆ GetKeyCount()

virtual unsigned int CUiAnimViewTrack::GetKeyCount ( ) const
inlineoverridevirtual

Implements IUiAnimViewKeyBundle.

◆ GetKeysInTimeRange()

virtual CUiAnimViewKeyBundle CUiAnimViewTrack::GetKeysInTimeRange ( const float  t0,
const float  t1 
)
overridevirtual

Implements CUiAnimViewNode.

◆ GetName()

AZStd::string CUiAnimViewTrack::GetName ( ) const
overridevirtual

Implements CUiAnimViewNode.

◆ GetNodeType()

virtual EUiAnimViewNodeType CUiAnimViewTrack::GetNodeType ( ) const
inlineoverridevirtual

Implements CUiAnimViewNode.

◆ GetSelectedKeys()

virtual CUiAnimViewKeyBundle CUiAnimViewTrack::GetSelectedKeys ( )
overridevirtual

Implements CUiAnimViewNode.

◆ IsDisabled()

virtual bool CUiAnimViewTrack::IsDisabled ( ) const
overridevirtual

Reimplemented from CUiAnimViewNode.

◆ SelectKeys()

virtual void CUiAnimViewTrack::SelectKeys ( const bool  bSelected)
overridevirtual

Implements IUiAnimViewKeyBundle.

◆ SetDisabled()

virtual void CUiAnimViewTrack::SetDisabled ( bool  bDisabled)
overridevirtual

Reimplemented from CUiAnimViewNode.

◆ SnapTimeToNextKey()

virtual bool CUiAnimViewTrack::SnapTimeToNextKey ( float &  time) const
overridevirtual

Implements CUiAnimViewNode.

◆ SnapTimeToPrevKey()

virtual bool CUiAnimViewTrack::SnapTimeToPrevKey ( float &  time) const
overridevirtual

Implements CUiAnimViewNode.


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