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 Types | Public Member Functions | Friends | List of all members
CUiAnimViewSequence Class Reference

Inherits CUiAnimViewAnimNode, and IUndoManagerListener.

Public Types

typedef std::pair< CUiAnimViewTrack *, XmlNodeRef > TMatchedTrackLocation
 

Public Member Functions

 CUiAnimViewSequence (IUiAnimSequence *pSequence)
 
void Load ()
 
virtual EUiAnimViewNodeType GetNodeType () const override
 
AZStd::string GetName () const override
 
virtual bool SetName (const char *pName) override
 
virtual bool CanBeRenamed () const override
 
virtual void BindToEditorObjects () override
 
virtual void UnBindFromEditorObjects () override
 
virtual bool IsBoundToEditorObjects () const override
 
void SetTimeRange (Range timeRange)
 
Range GetTimeRange () const
 
const float GetTime () const
 
void SetFlags (IUiAnimSequence::EUiAnimSequenceFlags flags)
 
IUiAnimSequence::EUiAnimSequenceFlags GetFlags () const
 
bool IsAncestorOf (CUiAnimViewSequence *pSequence) const
 
CUiAnimViewKeyHandle FindSingleSelectedKey ()
 
uint32 GetSequenceId () const
 
virtual void Render (const SUiAnimContext &animContext) override
 
virtual void Animate (const SUiAnimContext &animContext) override
 
void Resume ()
 
void Pause ()
 
void StillUpdate ()
 
void OnLoop ()
 
void Activate ()
 
void Deactivate ()
 
void PrecacheData (const float time)
 
void BeginCutScene (const bool bResetFx) const
 
void EndCutScene () const
 
void Reset (const bool bSeekToStart)
 
void ResetHard ()
 
virtual bool IsGroupNode () const override
 
int GetTrackEventsCount () const
 
const char * GetTrackEvent (int index)
 
bool AddTrackEvent (const char *szEvent)
 
bool RemoveTrackEvent (const char *szEvent)
 
bool RenameTrackEvent (const char *szEvent, const char *szNewEvent)
 
bool MoveUpTrackEvent (const char *szEvent)
 
bool MoveDownTrackEvent (const char *szEvent)
 
void ClearTrackEvents ()
 
void DeleteSelectedNodes ()
 
void SelectSelectedNodesInViewport ()
 
void DeleteSelectedKeys ()
 
void SyncSelectedTracksToBase ()
 
void SyncSelectedTracksFromBase ()
 
void AddListener (IUiAnimViewSequenceListener *pListener)
 
void RemoveListener (IUiAnimViewSequenceListener *pListener)
 
bool IsActiveSequence () const
 
virtual bool IsActiveDirector () const override
 
void StoreUndoForTracksWithSelectedKeys ()
 
void CopyKeysToClipboard (const bool bOnlySelectedKeys, const bool bOnlyFromSelectedTracks)
 
void PasteKeysFromClipboard (CUiAnimViewAnimNode *pTargetNode, CUiAnimViewTrack *pTargetTrack, const float timeOffset=0.0f)
 
std::vector< TMatchedTrackLocation > GetMatchedPasteLocations (XmlNodeRef clipboardContent, CUiAnimViewAnimNode *pTargetNode, CUiAnimViewTrack *pTargetTrack)
 
void AdjustKeysToTimeRange (Range newTimeRange)
 
void DeselectAllKeys ()
 
void OffsetSelectedKeys (const float timeOffset)
 
void ScaleSelectedKeys (const float timeOffset)
 
void SlideKeys (const float timeOffset)
 Push all the keys which come after the first key in time among selected ones by this offset.
 
void CloneSelectedKeys ()
 Clone all selected keys.
 
float ClipTimeOffsetForOffsetting (const float timeOffset)
 
float ClipTimeOffsetForScaling (const float timeOffset)
 
float ClipTimeOffsetForSliding (const float timeOffset)
 
void OnSequenceSettingsChanged ()
 
void OnKeySelectionChanged ()
 
void OnKeysChanged ()
 
void OnNodeSelectionChanged ()
 
void OnNodeChanged (CUiAnimViewNode *pNode, IUiAnimViewSequenceListener::ENodeChangeType type)
 
void OnNodeRenamed (CUiAnimViewNode *pNode, const char *pOldName)
 
- Public Member Functions inherited from CUiAnimViewAnimNode
 CUiAnimViewAnimNode (IUiAnimSequence *pSequence, IUiAnimNode *pAnimNode, CUiAnimViewNode *pParentNode)
 
void UiElementPropertyChanged () override
 
virtual CUiAnimViewAnimNode * CreateSubNode (const QString &name, const EUiAnimNodeType animNodeType, AZ::Entity *pEntity=nullptr, bool listen=false)
 
virtual void RemoveSubNode (CUiAnimViewAnimNode *pSubNode)
 
virtual CUiAnimViewTrack * CreateTrack (const CUiAnimParamType &paramType)
 
virtual void RemoveTrack (CUiAnimViewTrack *pTrack)
 
virtual CUiAnimViewTrack * CreateTrackAz (const UiAnimParamData &param)
 
virtual CUiAnimViewAnimNodeBundle AddSelectedUiElements ()
 
virtual void SetAsActiveDirector ()
 
virtual bool IsActive ()
 
virtual void SetNodeEntityAz (AZ::Entity *pEntity)
 
virtual AZ::Entity * GetNodeEntityAz (const bool bSearch=true)
 
virtual bool SnapTimeToPrevKey (float &time) const override
 
virtual bool SnapTimeToNextKey (float &time) const override
 
CUiAnimViewAnimNodeBundle GetAllAnimNodes ()
 
CUiAnimViewAnimNodeBundle GetSelectedAnimNodes ()
 
CUiAnimViewAnimNodeBundle GetAllOwnedNodes (const AZ::Entity *pOwner)
 
CUiAnimViewAnimNodeBundle GetAnimNodesByType (EUiAnimNodeType animNodeType)
 
CUiAnimViewAnimNodeBundle GetAnimNodesByName (const char *pName)
 
virtual CUiAnimViewTrackBundle GetAllTracks ()
 
virtual CUiAnimViewTrackBundle GetSelectedTracks ()
 
virtual CUiAnimViewTrackBundle GetTracksByParam (const CUiAnimParamType &paramType)
 
virtual CUiAnimViewKeyBundle GetAllKeys () override
 
virtual CUiAnimViewKeyBundle GetSelectedKeys () override
 
virtual CUiAnimViewKeyBundle GetKeysInTimeRange (const float t0, const float t1) override
 
EUiAnimNodeType GetType () const
 
EUiAnimNodeFlags GetFlags () const
 
virtual void SetDisabled (bool bDisabled) override
 
virtual bool IsDisabled () const override
 
CUiAnimViewTrack * GetTrackForParameter (const CUiAnimParamType &paramType, uint32 index=0) const
 
CUiAnimViewTrack * GetTrackForParameterAz (const UiAnimParamData &param) const
 
unsigned int GetParamCount () const
 
CUiAnimParamType GetParamType (unsigned int index) const
 
AZStd::string GetParamName (const CUiAnimParamType &paramType) const
 
AZStd::string GetParamNameForTrack (const CUiAnimParamType &paramType, const IUiAnimTrack *track) const
 
bool IsParamValid (const CUiAnimParamType &param) const
 
IUiAnimNode::ESupportedParamFlags GetParamFlags (const CUiAnimParamType &paramType) const
 
EUiAnimValue GetParamValueType (const CUiAnimParamType &paramType) const
 
void UpdateDynamicParams ()
 
template<class Type >
bool SetParamValue (const float time, const CUiAnimParamType &param, const Type &value)
 
template<class Type >
bool GetParamValue (const float time, const CUiAnimParamType &param, Type &value)
 
virtual QString GetAvailableNodeNameStartingWith (const QString &name) const
 
virtual void CopyNodesToClipboard (const bool bOnlySelected, QWidget *context)
 
virtual bool PasteNodesFromClipboard (QWidget *context)
 
virtual void SetNewParent (CUiAnimViewAnimNode *pNewParent)
 
virtual bool IsValidReparentingTo (CUiAnimViewAnimNode *pNewParent)
 
- Public Member Functions inherited from CUiAnimViewNode
 CUiAnimViewNode (CUiAnimViewNode *pParent)
 
virtual bool SetName ([[maybe_unused]] const char *pName)
 
CUiAnimViewSequence * GetSequence ()
 
CUiAnimViewNode * GetParentNode () const
 
unsigned int GetChildCount () const
 
CUiAnimViewNode * GetChild (unsigned int index) const
 
virtual void SetSelected (bool bSelected)
 
virtual bool IsSelected () const
 
void ClearSelection ()
 
virtual void SetExpanded (bool bExpanded)
 
virtual bool IsExpanded () const
 
virtual void SetDisabled ([[maybe_unused]] bool bDisabled)
 
void SetHidden (bool bHidden)
 
bool IsHidden () const
 
bool HasObsoleteTrack () const
 
CUiAnimViewNode * GetAboveNode () const
 
CUiAnimViewNode * GetBelowNode () const
 
CUiAnimViewNode * GetPrevSibling () const
 
CUiAnimViewNode * GetNextSibling () const
 
bool operator< (const CUiAnimViewNode &pOtherNode) const
 
CUiAnimViewNode * GetFirstSelectedNode ()
 
CUiAnimViewAnimNode * GetDirector ()
 
- Public Member Functions inherited from IUiAnimNodeOwner
virtual void OnNodeReset ([[maybe_unused]] IUiAnimNode *pNode)
 

Friends

class CUiAnimViewSequenceManager
 
class CUiAnimViewNode
 
class CUiAnimViewAnimNode
 
class CUiAnimViewTrack
 
class CUiAnimViewSequenceNotificationContext
 
class CUiAnimViewSequenceNoNotificationContext
 
class CAbstractUndoTrackTransaction
 
class CAbstractUndoAnimNodeTransaction
 
class CUndoAnimNodeReparent
 
class CUndoTrackObject
 
class CAbstractUndoSequenceTransaction
 

Additional Inherited Members

- Protected Member Functions inherited from CUiAnimViewAnimNode
virtual void OnNodeUiAnimated (IUiAnimNode *pNode) override
 
IUiAnimNode * GetAnimNode ()
 
- Protected Member Functions inherited from CUiAnimViewNode
void AddNode (CUiAnimViewNode *pNode)
 
void SortNodes ()
 
bool HasObsoleteTrackRec (const CUiAnimViewNode *pCurrentNode) const
 
- Protected Attributes inherited from CUiAnimViewNode
CUiAnimViewNode * m_pParentNode
 
std::vector< std::unique_ptr< CUiAnimViewNode > > m_childNodes
 
bool m_bSelected
 
bool m_bExpanded
 
bool m_bHidden
 
The documentation for this class was generated from the following file: