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.
CUiAnimViewEventNode Class Reference

Inherits CUiAnimViewAnimNode, and IUiTrackEventListener.

Public Member Functions

 CUiAnimViewEventNode (IUiAnimSequence *pSequence, IUiAnimNode *pAnimNode, CUiAnimViewNode *pParentNode)
 
void OnTrackEvent (IUiAnimSequence *pSequence, int reason, const char *event, void *pUserData) override
 
- Public Member Functions inherited from CUiAnimViewAnimNode
 CUiAnimViewAnimNode (IUiAnimSequence *pSequence, IUiAnimNode *pAnimNode, CUiAnimViewNode *pParentNode)
 
void UiElementPropertyChanged () override
 
virtual void Render (const SUiAnimContext &ac)
 
virtual void Animate (const SUiAnimContext &animContext)
 
virtual void BindToEditorObjects ()
 
virtual void UnBindFromEditorObjects ()
 
virtual bool IsBoundToEditorObjects () const
 
virtual EUiAnimViewNodeType GetNodeType () const override
 
virtual CUiAnimViewAnimNodeCreateSubNode (const QString &name, const EUiAnimNodeType animNodeType, AZ::Entity *pEntity=nullptr, bool listen=false)
 
virtual void RemoveSubNode (CUiAnimViewAnimNode *pSubNode)
 
virtual CUiAnimViewTrackCreateTrack (const CUiAnimParamType &paramType)
 
virtual void RemoveTrack (CUiAnimViewTrack *pTrack)
 
virtual CUiAnimViewTrackCreateTrackAz (const UiAnimParamData &param)
 
virtual CUiAnimViewAnimNodeBundle AddSelectedUiElements ()
 
virtual void SetAsActiveDirector ()
 
virtual bool IsActiveDirector () const
 
virtual bool IsActive ()
 
AZStd::string GetName () const override
 
virtual bool SetName (const char *pName) override
 
virtual bool CanBeRenamed () const override
 
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
 
CUiAnimViewTrackGetTrackForParameter (const CUiAnimParamType &paramType, uint32 index=0) const
 
CUiAnimViewTrackGetTrackForParameterAz (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 bool IsGroupNode () const override
 
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 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 void OnNodeUiAnimated (IUiAnimNode *pNode)=0
 
virtual void OnNodeVisibilityChanged (IUiAnimNode *pNode, const bool bHidden)=0
 
virtual void OnNodeReset (IUiAnimNode *pNode)
 
virtual void OnTrackEvent (IUiAnimSequence *pSequence, int reason, const char *event, void *pUserData)=0
 

Static Public Member Functions

static CUiAnimViewKeyBundle GetTrackEventKeys (CUiAnimViewAnimNode *pAnimNode, const char *eventName)
 

Protected Member Functions

void RenameTrackEvent (const char *fromName, const char *toName)
 
void RemoveTrackEvent (const char *removedEventName)
 
- Protected Member Functions inherited from CUiAnimViewAnimNode
virtual void OnNodeUiAnimated (IUiAnimNode *pNode) override
 
IUiAnimNodeGetAnimNode ()
 
- Protected Member Functions inherited from CUiAnimViewNode
void AddNode (CUiAnimViewNode *pNode)
 
void SortNodes ()
 
bool HasObsoleteTrackRec (const CUiAnimViewNode *pCurrentNode) const
 

Additional Inherited Members

- Public Types inherited from IUiTrackEventListener
enum  ETrackEventReason {
  eTrackEventReason_Added , eTrackEventReason_Removed , eTrackEventReason_Renamed , eTrackEventReason_Triggered ,
  eTrackEventReason_MovedUp , eTrackEventReason_MovedDown
}
 Reasons.
 
- 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

◆ OnTrackEvent()

void CUiAnimViewEventNode::OnTrackEvent ( IUiAnimSequence pSequence,
int  reason,
const char *  event,
void *  pUserData 
)
overridevirtual

Implements IUiTrackEventListener.


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