Notification parameter for signaling the end of an animation in the LEGO Island engine. More...
#include <legoendanimnotificationparam.h>
Public Member Functions | |
| LegoEndAnimNotificationParam (NotificationId p_type, MxCore *p_sender, MxU32 p_index) | |
| Constructor. More... | |
| MxNotificationParam * | Clone () const override |
| Creates a copy of this notification parameter object. More... | |
| MxU32 | GetIndex () |
| Retrieves the index associated with this end-animation notification. More... | |
 Public Member Functions inherited from MxNotificationParam | |
| MxNotificationParam () | |
| [AI] Constructs a default notification parameter with type c_notificationType0 and no sender. More... | |
| MxNotificationParam (NotificationId p_type, MxCore *p_sender) | |
| [AI] Constructs a notification parameter with a specific type and sender. More... | |
| virtual MxNotificationParam * | Clone () const |
| [AI] Creates a copy of this notification parameter object on the heap. More... | |
| NotificationId | GetNotification () const |
| [AI] Retrieves the current notification type of this parameter. More... | |
| MxCore * | GetSender () const |
| [AI] Retrieves the sender pointer associated with this notification. More... | |
| void | SetNotification (NotificationId p_type) |
| [AI] Sets the notification type for this parameter object. More... | |
| void | SetSender (MxCore *p_sender) |
| [AI] Sets the sender pointer for this notification parameter. More... | |
| Public Member Functions inherited from MxParam | |
| virtual | ~MxParam () |
| [AI] Virtual destructor for safe polymorphic deletion of derived parameter objects. More... | |
Protected Attributes | |
| MxU32 | m_index |
| Index of the finished animation. More... | |
| Protected Attributes inherited from MxNotificationParam | |
| NotificationId | m_type |
| [AI] Type of notification/event carried by this object (see NotificationId). More... | |
| MxCore * | m_sender |
| [AI] Pointer to the MxCore instance that sent or originated this notification. More... | |
Detailed Description
Notification parameter for signaling the end of an animation in the LEGO Island engine.
[AI]
[AI] This class extends MxNotificationParam to include specific information (the index of the animation) about which animation's end event is being reported. It is typically posted by an animation system to notify subscribers that a particular animation (as identified by the index) has finished. This mechanism is central to decoupling animation playback from logical responses within the engine (such as triggering follow-up actions or state changes). [AI]
Definition at line 18 of file legoendanimnotificationparam.h.
Constructor & Destructor Documentation
◆ LegoEndAnimNotificationParam()
|
inline |
Constructor.
[AI]
- Parameters
-
p_type The notification type, used by the MxNotificationParam base. [AI] p_sender Pointer to the sending MxCore object. [AI] p_index Integer that identifies which animation ended. [AI]
[AI] The index typically refers to the animation resource or sequence, allowing receivers to know exactly which animation finished.
Definition at line 28 of file legoendanimnotificationparam.h.
Member Function Documentation
◆ Clone()
|
inlineoverridevirtual |
Creates a copy of this notification parameter object.
[AI]
[AI] Used to safely propagate notification parameters through the event/notification system, ensuring unique ownership and proper polymorphic behavior.
- Returns
- A dynamically-allocated clone (caller takes ownership). [AI]
Reimplemented from MxNotificationParam.
Definition at line 40 of file legoendanimnotificationparam.h.
◆ GetIndex()
|
inline |
Retrieves the index associated with this end-animation notification.
[AI]
[AI] This index typically maps to the specific animation or sequence whose end event is being signaled. Receivers can use the index to identify or react to the specific animation completion.
- Returns
- Animation index value for this notification. [AI]
Definition at line 52 of file legoendanimnotificationparam.h.
Member Data Documentation
◆ m_index
|
protected |
Index of the finished animation.
[AI]
[AI] Used by listeners to identify what animation ended.
Definition at line 60 of file legoendanimnotificationparam.h.
The documentation for this class was generated from the following file:
