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.
|
Inherits IUiAnimSequence.
Public Member Functions | |
AZ_RTTI (CUiAnimSequence, "{AA5AB4ED-CB98-4166-953E-0FE1EF7AC61F}", IUiAnimSequence) | |
CUiAnimSequence (IUiAnimationSystem *pUiAnimationSystem, uint32 id) | |
void | add_ref () override |
void | release () override |
IUiAnimationSystem * | GetUiAnimationSystem () const override |
Set the animation system for the canvas containing this sequence. | |
void | SetName (const char *name) override |
Set the name of this sequence. (ex. "Intro" in the same case as above) | |
const char * | GetName () const override |
Get the name of this sequence. (ex. "Intro" in the same case as above) | |
uint32 | GetId () const override |
Get the ID (unique in a level and consistent across renaming) of this sequence. | |
float | GetTime () const |
void | SetOwner (IUiAnimSequenceOwner *pOwner) override |
IUiAnimSequenceOwner * | GetOwner () const override |
void | SetActiveDirector (IUiAnimNode *pDirectorNode) override |
Set the currently active director node. | |
IUiAnimNode * | GetActiveDirector () const override |
Get the currently active director node, if any. | |
void | SetFlags (int flags) override |
Set animation sequence flags. | |
int | GetFlags () const override |
Get animation sequence flags. | |
int | GetCutSceneFlags (const bool localFlags=false) const override |
Get cutscene related animation sequence flags. | |
void | SetParentSequence (IUiAnimSequence *pParentSequence) override |
Set parent animation sequence. | |
const IUiAnimSequence * | GetParentSequence () const override |
Get parent animation sequence. | |
bool | IsAncestorOf (const IUiAnimSequence *pSequence) const override |
Check whether this sequence has the given sequence as a descendant through one of its sequence tracks. | |
void | SetTimeRange (Range timeRange) override |
Set time range of this sequence. | |
Range | GetTimeRange () override |
Get time range of this sequence. | |
void | AdjustKeysToTimeRange (const Range &timeRange) override |
int | GetNodeCount () const override |
Return number of animation nodes in sequence. | |
IUiAnimNode * | GetNode (int index) const override |
Get specified animation node. | |
IUiAnimNode * | FindNodeByName (const char *sNodeName, const IUiAnimNode *pParentDirector) override |
IUiAnimNode * | FindNodeById (int nNodeId) |
void | ReorderNode (IUiAnimNode *node, IUiAnimNode *pPivotNode, bool next) override |
void | Reset (bool bSeekToStart) override |
Resets the sequence. | |
void | ResetHard () override |
This can have more time-consuming tasks performed additional to tasks of the usual 'Reset()' method. | |
void | Pause () override |
void | Resume () override |
bool | IsPaused () const override |
virtual void | OnStart () |
virtual void | OnStop () |
void | OnLoop () override |
bool | AddNode (IUiAnimNode *node) override |
Add animation node to sequence. | |
IUiAnimNode * | CreateNode (EUiAnimNodeType nodeType) override |
IUiAnimNode * | CreateNode (XmlNodeRef node) override |
void | RemoveNode (IUiAnimNode *node) override |
Remove animation node from sequence. | |
void | RemoveAll () override |
Add scene node to sequence. | |
void | Activate () override |
bool | IsActivated () const override |
void | Deactivate () override |
void | PrecacheData (float startTime) override |
void | PrecacheStatic (const float startTime) |
void | PrecacheDynamic (float time) |
void | StillUpdate () override |
void | Animate (const SUiAnimContext &ec) override |
void | Render () override |
void | Serialize (XmlNodeRef &xmlNode, bool bLoading, bool bLoadEmptyTracks=true, uint32 overrideId=0, bool bResetLightAnimSet=false) override |
void | InitPostLoad (IUiAnimationSystem *pUiAnimationSystem, bool remapIds, LyShine::EntityIdMap *entityIdMap) override |
void | CopyNodes (XmlNodeRef &xmlNode, IUiAnimNode **pSelectedNodes, uint32 count) override |
void | PasteNodes (const XmlNodeRef &xmlNode, IUiAnimNode *pParent) override |
bool | AddTrackEvent (const char *szEvent) override |
Add/remove track events in sequence. | |
bool | RemoveTrackEvent (const char *szEvent) override |
bool | RenameTrackEvent (const char *szEvent, const char *szNewEvent) override |
bool | MoveUpTrackEvent (const char *szEvent) override |
bool | MoveDownTrackEvent (const char *szEvent) override |
void | ClearTrackEvents () override |
int | GetTrackEventsCount () const override |
Get the track events in the sequence. | |
char const * | GetTrackEvent (int iIndex) const override |
IUiAnimStringTable * | GetTrackEventStringTable () override |
void | TriggerTrackEvent (const char *event, const char *param=nullptr) override |
Call to trigger a track event. | |
void | AddTrackEventListener (IUiTrackEventListener *pListener) override |
Track event listener. | |
void | RemoveTrackEventListener (IUiTrackEventListener *pListener) override |
Static Public Member Functions | |
static void | Reflect (AZ::SerializeContext *serializeContext) |
Additional Inherited Members | |
Public Types inherited from IUiAnimSequence | |
enum | EUiAnimSequenceFlags { eSeqFlags_PlayOnReset = BIT(0) , eSeqFlags_OutOfRangeConstant = BIT(1) , eSeqFlags_OutOfRangeLoop = BIT(2) , eSeqFlags_CutScene = BIT(3) , eSeqFlags_NoHUD = BIT(4) , eSeqFlags_NoPlayer = BIT(5) , eSeqFlags_16To9 = BIT(8) , eSeqFlags_NoGameSounds = BIT(9) , eSeqFlags_NoSeek = BIT(10) , eSeqFlags_NoAbort = BIT(11) , eSeqFlags_NoSpeed = BIT(13) , eSeqFlags_EarlyAnimationUpdate = BIT(15) , eSeqFlags_LightAnimationSet = BIT(16) , eSeqFlags_NoMPSyncingNeeded = BIT(17) } |
Flags used for SetFlags(),GetFlags(),SetParentFlags(),GetParentFlags() methods. More... | |
Static Public Attributes inherited from IUiAnimSequence | |
static const int | kSequenceVersion = 3 |
|
overridevirtual |
Move/Scale all keys in tracks from previous time range to new time range.
Implements IUiAnimSequence.
|
inlineoverridevirtual |
Check if sequence is activated
Implements IUiAnimSequence.
|
overridevirtual |
Called to check if sequence is paused.
Implements IUiAnimSequence.
|
overridevirtual |
Called when a sequence is looped.
Implements IUiAnimSequence.