Loading...
Searching...
No Matches
MxLoopingSmkPresenter Class Reference
[AI] Presenter for looping Smacker video resources. More...
#include <mxloopingsmkpresenter.h>
Inheritance diagram for MxLoopingSmkPresenter:
Collaboration diagram for MxLoopingSmkPresenter:
Public Member Functions | |
| MxLoopingSmkPresenter () | |
| [AI] Constructs a looping SMK presenter and initializes resources and state. More... | |
| ~MxLoopingSmkPresenter () override | |
| [AI] Destructor, releases internal resources and calls cleanup as needed. More... | |
| const char * | ClassName () const override |
| [AI] Returns the class name string, used for type identification and debugging. More... | |
| void | RepeatingTickle () override |
| [AI] Processes the repeating tickle state, manages looping frame/time logic and state transitions for repeating video playback. More... | |
| MxResult | AddToManager () override |
| [AI] Adds this presenter to its manager, handling resource/thread safety and registration. More... | |
| void | Destroy () override |
| [AI] General object destruction routine, releases resources and unregisters presenter from the manager if appropriate. More... | |
| void | NextFrame () override |
| [AI] Advances to the next frame of the video, managing end of stream logic and frame reloading for looping playback. More... | |
| void | VTable0x88 () override |
| [AI] Handles palette resets and frame control at the logical end of a loop. More... | |
| virtual void | VTable0x8c () |
| [AI] Processes looped frame loading and tickle state progression during loop playback. More... | |
 Public Member Functions inherited from MxSmkPresenter | |
| MxSmkPresenter () | |
| [AI] Constructs an MxSmkPresenter and initializes member variables. More... | |
| ~MxSmkPresenter () override | |
| [AI] Destructor. More... | |
| const char * | ClassName () const override |
| [AI] Returns the class name for this object. More... | |
| MxBool | IsA (const char *p_name) const override |
| [AI] Run-time type check. More... | |
| MxResult | AddToManager () override |
| [AI] Registers this presenter instance with the video presentation manager. More... | |
| void | Destroy () override |
| [AI] Cleans up and destroys the resources used by this presenter. More... | |
| void | LoadHeader (MxStreamChunk *p_chunk) override |
| [AI] Loads the Smacker header information from a stream chunk. More... | |
| void | CreateBitmap () override |
| [AI] Allocates and prepares the bitmap for a Smacker video frame. More... | |
| void | LoadFrame (MxStreamChunk *p_chunk) override |
| [AI] Loads and renders a Smacker video frame from a stream chunk. More... | |
| void | RealizePalette () override |
| [AI] Realizes (uploads) the color palette for the current frame bitmap. More... | |
| virtual void | VTable0x88 () |
| [AI] Virtual function for custom frame or looping logic for Smacker video playback. More... | |
| Public Member Functions inherited from MxVideoPresenter | |
| MxVideoPresenter () | |
| Constructs a new MxVideoPresenter and initializes internal state. More... | |
| virtual void | LoadHeader (MxStreamChunk *p_chunk) |
| Loads and processes header information from a video stream chunk. More... | |
| virtual void | CreateBitmap () |
| Allocates and sets up the display bitmap for video frame data. More... | |
| virtual void | NextFrame () |
| Advances video playback to the next frame, handling decoding and playback progression. More... | |
| virtual void | LoadFrame (MxStreamChunk *p_chunk) |
| Loads and processes frame data from a video stream chunk. More... | |
| virtual void | PutFrame () |
| Presents the current frame using the chosen output mechanism (e.g., blitting to screen). More... | |
| virtual void | RealizePalette () |
| Loads or establishes the palette for display from the current video format or media. More... | |
| virtual undefined | VTable0x74 () |
| Unknown/potentially format-specific method (VTable0x74). More... | |
| ~MxVideoPresenter () override | |
| Destroys the MxVideoPresenter, releasing owned resources and unregistering from the manager. More... | |
| void | Destroy () override |
| Destroys internal resources for the presenter. More... | |
| virtual LPDIRECTDRAWSURFACE | VTable0x78 () |
| Retrieves the DirectDraw surface used for hardware-accelerated rendering. More... | |
| virtual MxBool | VTable0x7c () |
| Checks if this presenter has either a video frame bitmap or alpha mask available. More... | |
| virtual MxS32 | GetWidth () |
| Returns the width of the current bitmap or alpha mask in pixels. More... | |
| virtual MxS32 | GetHeight () |
| Returns the height of the current bitmap or alpha mask in pixels. More... | |
| const char * | ClassName () const override |
| Returns the run-time class name of this presenter instance. More... | |
| MxBool | IsA (const char *p_name) const override |
| Determines if this object is or derives from a class with the given name. More... | |
| void | ReadyTickle () override |
| Advance logic for the "ready" tickle state. More... | |
| void | StartingTickle () override |
| Advance logic for the "starting" tickle state (frame setup). More... | |
| void | StreamingTickle () override |
| Advance logic for the "streaming" tickle state (typical video playback). More... | |
| void | RepeatingTickle () override |
| Advance logic for the "repeating" tickle state (media looping). More... | |
| void | FreezingTickle () override |
| Advance logic for the "freezing" tickle state (sustain after playback). More... | |
| MxResult | AddToManager () override |
| Adds this presenter to the global video manager. More... | |
| void | EndAction () override |
| Signals the end of the current playback action. More... | |
| MxResult | PutData () override |
| Writes the frame to the display device if appropriate. More... | |
| MxBool | IsHit (MxS32 p_x, MxS32 p_y) override |
| Determines if a point is inside the non-transparent region of frame/alpha. More... | |
| MxS32 | PrepareRects (RECT &p_rectDest, RECT &p_rectSrc) |
| Utility function to adjust source/dest rectangles to stay within allowed bounds. More... | |
| MxBitmap * | GetBitmap () |
| Returns the frame bitmap currently used for this presenter. More... | |
| AlphaMask * | GetAlphaMask () |
| Returns this presenter's alpha mask for hit testing. More... | |
| MxU8 * | GetBitmapStart (MxS32 p_left, MxS32 p_top) |
| Provides a pointer to the start of frame bitmap data at a given coordinate. More... | |
| void | SetBit0 (BOOL p_e) |
| Sets internal miscellaneous state flags. More... | |
| void | SetBit1 (BOOL p_e) |
| void | SetBit2 (BOOL p_e) |
| void | SetBit3 (BOOL p_e) |
| void | SetBit4 (BOOL p_e) |
| BYTE | GetBit0 () |
| Gets internal miscellaneous state flags (bits 0-4). More... | |
| BYTE | GetBit1 () |
| BYTE | GetBit2 () |
| BYTE | GetBit3 () |
| BYTE | GetBit4 () |
| Public Member Functions inherited from MxMediaPresenter | |
| MxMediaPresenter () | |
| [AI] Constructs the presenter, initializing all member variables. More... | |
| ~MxMediaPresenter () override | |
| [AI] Destructor; cleans up and optionally destroys all internal resources as well as the MxDSSubscriber and chunk list/cursor. More... | |
| void | Destroy () override |
| [AI] Cleans up internal resources and resets the presenter to an uninitialized state. More... | |
| MxResult | Tickle () override |
| [AI] Advances the presenter's state and media stream, if any, by tickling (i.e., updating) components. More... | |
| const char * | ClassName () const override |
| [AI] Returns the class name for this presenter (see HandlerClassName()). More... | |
| MxBool | IsA (const char *p_name) const override |
| [AI] Returns TRUE if the provided class name matches this class or any of its parents. More... | |
| void | StreamingTickle () override |
| [AI] Per-frame update when streaming the media stream. More... | |
| void | RepeatingTickle () override |
| [AI] Per-frame update while looping/repeating over known chunks. More... | |
| void | DoneTickle () override |
| [AI] Per-frame update for the "done" state; transitions this presenter to idle and ends the action. More... | |
| MxResult | StartAction (MxStreamController *, MxDSAction *) override |
| [AI] Begins a new media playback action, wiring up the stream and chunk lists as needed. More... | |
| void | EndAction () override |
| [AI] Ends the media playback action, releasing all resources, notifying listeners if necessary. More... | |
| void | Enable (MxBool p_enable) override |
| [AI] Enables or disables media stream playback and transitions state as needed. More... | |
| virtual void | LoopChunk (MxStreamChunk *p_chunk) |
| [AI] Adds a chunk to the looping chunk list, making it available for repeated playback. More... | |
| MxStreamChunk * | CurrentChunk () |
| [AI] Returns a pointer to the current data chunk at the head of the stream, without consuming it. More... | |
| MxStreamChunk * | NextChunk () |
| [AI] Returns the next data chunk in the stream, removing it from the stream queue. More... | |
| Public Member Functions inherited from MxPresenter | |
| MxPresenter () | |
| [AI] Constructor. Initializes internal tickle state and other members. More... | |
| MxResult | Tickle () override |
| [AI] Main tickle handler, called periodically to progress presenter's internal state. More... | |
| virtual void | VTable0x14 () |
| [AI] Reserved for future or specialized use in derived classes. More... | |
| virtual void | ReadyTickle () |
| [AI] Handles the transition and setup for the Ready state. Parses extra action data and advances state. More... | |
| virtual void | StartingTickle () |
| [AI] Handles actions required when first starting presentation. Advances to streaming state. More... | |
| virtual void | StreamingTickle () |
| [AI] Handles periodic updates during the streaming/presentation stage. Advances to repeating state. More... | |
| virtual void | RepeatingTickle () |
| [AI] Handles updates when in a repeating (looping) stage. Advances to freezing state. More... | |
| virtual void | FreezingTickle () |
| [AI] Handles updates during the freezing/suspended state. Advances to done state. More... | |
| ~MxPresenter () override | |
| [AI] Destructor, cleans up resources (base class: does nothing beyond Init). More... | |
| virtual MxResult | AddToManager () |
| [AI] Optional registration with a manager (such as TickleManager); by default does nothing. More... | |
| virtual void | Destroy () |
| [AI] Resets presenter state or cleans up resources after completion/removal. More... | |
| virtual MxResult | StartAction (MxStreamController *, MxDSAction *) |
| [AI] Initiates presenter for a new action, setting up context and state. More... | |
| virtual void | EndAction () |
| [AI] Terminates the current action, notifies listeners and resets state. More... | |
| virtual void | SetTickleState (TickleState p_tickleState) |
| [AI] Forces the tickle state, advancing to the requested lifecycle stage. More... | |
| virtual MxBool | HasTickleStatePassed (TickleState p_tickleState) |
| [AI] Checks if the specified tickle state has ever been passed since last reset. More... | |
| virtual MxResult | PutData () |
| [AI] Allows the presenter to submit pending results or output to the engine. More... | |
| virtual MxBool | IsHit (MxS32 p_x, MxS32 p_y) |
| [AI] Returns TRUE if the given (x, y) falls within hit-test bounds for the presenter (e.g. More... | |
| virtual void | Enable (MxBool p_enable) |
| [AI] Enables or disables this presenter (controls action flags accordingly). More... | |
| const char * | ClassName () const override |
| [AI] Returns the run-time class name for this presenter. More... | |
| MxBool | IsA (const char *p_name) const override |
| [AI] Determines if this object is of (or inherits) the specified named class. More... | |
| MxEntity * | CreateEntity (const char *p_defaultName) |
| [AI] Creates an entity based on action 'extra' data, or uses the provided default name. More... | |
| void | SendToCompositePresenter (MxOmni *p_omni) |
| [AI] Notifies a composite presenter (if one exists) that this presenter wishes to join a group. More... | |
| MxBool | IsEnabled () |
| [AI] Returns whether this presenter is logically enabled (based on the associated action's flags). More... | |
| MxS32 | GetCurrentTickleState () const |
| [AI] Returns the current tickle state. More... | |
| MxPoint32 | GetLocation () const |
| [AI] Returns the presenter's screen location (in pixels). More... | |
| MxS32 | GetX () const |
| [AI] Returns the X coordinate of screen location. More... | |
| MxS32 | GetY () const |
| [AI] Returns the Y coordinate of screen location. More... | |
| MxS32 | GetDisplayZ () const |
| [AI] Returns the display Z (depth) order. More... | |
| MxDSAction * | GetAction () const |
| [AI] Returns the current action being presented. More... | |
| void | SetAction (MxDSAction *p_action) |
| [AI] Sets the action associated with this presenter. More... | |
| void | SetCompositePresenter (MxCompositePresenter *p_compositePresenter) |
| [AI] Sets the composite presenter to notify/join on completion. More... | |
| void | SetDisplayZ (MxS32 p_displayZ) |
| [AI] Sets the display Z (depth) order for the presenter. More... | |
| Public Member Functions inherited from MxCore | |
| MxCore () | |
| [AI] Constructs a new MxCore object and assigns it a unique id. More... | |
| virtual | ~MxCore () |
| [AI] Virtual destructor. Required for correct polymorphic cleanup in derived classes. More... | |
| virtual MxLong | Notify (MxParam &p_param) |
| [AI] Virtual callback notification mechanism. More... | |
| virtual MxResult | Tickle () |
| [AI] Called by tickle managers to allow the object to update itself. More... | |
| virtual const char * | ClassName () const |
| [AI] Returns the runtime class name of this object. More... | |
| virtual MxBool | IsA (const char *p_name) const |
| [AI] Checks whether this object's class type or parents match the given name. More... | |
| MxU32 | GetId () |
| [AI] Gets the unique (per-process) id assigned to this object instance. More... | |
Static Public Member Functions | |
| static const char * | HandlerClassName () |
| [AI] Returns the handler class name used in presenter dispatching: "MxLoopingSmkPresenter". More... | |
| Static Public Member Functions inherited from MxSmkPresenter | |
| static const char * | HandlerClassName () |
| [AI] Returns the human-readable handler class name for this presenter type. More... | |
| Static Public Member Functions inherited from MxVideoPresenter | |
| static const char * | HandlerClassName () |
| Returns the class name string for this presenter type. More... | |
| Static Public Member Functions inherited from MxMediaPresenter | |
| static const char * | HandlerClassName () |
| [AI] Gets the class name string for handler dispatch and RTTI emulation. More... | |
| Static Public Member Functions inherited from MxPresenter | |
| static const char * | HandlerClassName () |
| [AI] Returns the handler class name for identification and reflection purposes. More... | |
Additional Inherited Members | |
| Public Types inherited from MxPresenter | |
| enum | TickleState { e_idle = 0 , e_ready , e_starting , e_streaming , e_repeating , e_freezing , e_done } |
| [AI] Represents the state of the presenter's tickle (update) lifecycle. More... | |
| Protected Member Functions inherited from MxVideoPresenter | |
| void | Destroy (MxBool p_fromDestructor) |
| Releases resources and unregisters presenter from the video manager. More... | |
| Protected Member Functions inherited from MxMediaPresenter | |
| void | Init () |
| [AI] Initializes all member variables to a known default state (NULL pointers, etc). More... | |
| void | Destroy (MxBool p_fromDestructor) |
| [AI] Frees all managed resources, owned memory and pointers, optionally preventing destruction of the base class. More... | |
| Protected Member Functions inherited from MxPresenter | |
| virtual void | DoneTickle () |
| [AI] Handles any post-completion logic, resetting to idle state. More... | |
| virtual void | ParseExtra () |
| [AI] Parses additional data from the associated action for configuration or world interaction. More... | |
| void | ProgressTickleState (TickleState p_tickleState) |
| [AI] Helper for advancing the presenter's tickle state and updating transition history. More... | |
| void | Init () |
| [AI] Initializes object state to post-construction defaults. More... | |
| Protected Attributes inherited from MxSmkPresenter | |
| MxSmk | m_mxSmk |
| [AI] Smacker file decoding context holding header, palette, frame types, and decode buffers. More... | |
| MxU32 | m_currentFrame |
| [AI] Current frame index within the Smacker stream. More... | |
| Protected Attributes inherited from MxVideoPresenter | |
| MxBitmap * | m_frameBitmap |
| Bitmap for current video frame. [AI]. More... | |
| AlphaMask * | m_alpha |
| Alpha mask for hit testing. May be null. [AI]. More... | |
| LPDIRECTDRAWSURFACE | m_unk0x58 |
| DirectDraw surface for hardware video rendering. [AI]. More... | |
| MxS16 | m_unk0x5c |
| Loop/advance/frame decode counter. [AI]. More... | |
| FlagBitfield | m_flags |
| Miscellaneous flags for object and UI state. [AI]. More... | |
| MxLong | m_unk0x60 |
| Last freeze time/start of sustain interval. [AI]. More... | |
| Protected Attributes inherited from MxMediaPresenter | |
| MxDSSubscriber * | m_subscriber |
| [AI] Subscriber that provides the stream data (e.g., audio/video chunks) for this presenter. More... | |
| MxStreamChunkList * | m_loopingChunks |
| [AI] Linked list of all chunks available for looping/repeating playback. More... | |
| MxStreamChunkListCursor * | m_loopingChunkCursor |
| [AI] Cursor used to iterate through the loopingChunk list during repeat mode. More... | |
| MxStreamChunk * | m_currentChunk |
| [AI] Currently active data chunk for playback or processing. More... | |
| Protected Attributes inherited from MxPresenter | |
| TickleState | m_currentTickleState |
| [AI] Current state in the tickle lifecycle. More... | |
| MxU32 | m_previousTickleStates |
| [AI] Bitfield representing all tickle states that have already occurred during this lifetime. More... | |
| MxPoint32 | m_location |
| [AI] 2D display location for the presenter. More... | |
| MxS32 | m_displayZ |
| [AI] Z-order value for display stacking. More... | |
| MxDSAction * | m_action |
| [AI] The associated action currently being presented by this presenter. More... | |
| MxCriticalSection | m_criticalSection |
| [AI] Thread synchronization for presenter state and data. More... | |
| MxCompositePresenter * | m_compositePresenter |
| [AI] Owner composite presenter, if any. More... | |
Detailed Description
[AI] Presenter for looping Smacker video resources.
Handles playback and repeat logic for SMK video streams, managing frame/state progression and reset for looping animations. [AI]
[AI] Extends MxSmkPresenter by adding logic for repeating/looping a video resource. Implements special handling for frame progression and timing, including repeating tickle states, loop duration management, and palette resets. Used for videos in SI scripts that should play in a loop. [AI]
Definition at line 13 of file mxloopingsmkpresenter.h.
Constructor & Destructor Documentation
◆ MxLoopingSmkPresenter()
| MxLoopingSmkPresenter::MxLoopingSmkPresenter | ( | ) |
[AI] Constructs a looping SMK presenter and initializes resources and state.
[AI]
Definition at line 10 of file mxloopingsmkpresenter.cpp.
◆ ~MxLoopingSmkPresenter()
|
override |
[AI] Destructor, releases internal resources and calls cleanup as needed.
[AI]
Definition at line 16 of file mxloopingsmkpresenter.cpp.
Member Function Documentation
◆ AddToManager()
|
overridevirtual |
[AI] Adds this presenter to its manager, handling resource/thread safety and registration.
[AI]
[AI] Acquires a lock for thread safety and delegates to the base class for actual addition. [AI]
Reimplemented from MxPresenter.
Definition at line 124 of file mxloopingsmkpresenter.cpp.
◆ ClassName()
|
inlineoverridevirtual |
[AI] Returns the class name string, used for type identification and debugging.
[AI]
- Returns
- Pointer to literal class name string. [AI]
Reimplemented from MxCore.
Definition at line 39 of file mxloopingsmkpresenter.h.
◆ Destroy()
|
overridevirtual |
[AI] General object destruction routine, releases resources and unregisters presenter from the manager if appropriate.
[AI]
[AI] Calls Destroy with p_fromDestructor=FALSE, which may perform additional cleanup beyond basic object teardown. [AI]
Reimplemented from MxPresenter.
Definition at line 131 of file mxloopingsmkpresenter.cpp.
◆ HandlerClassName()
|
inlinestatic |
[AI] Returns the handler class name used in presenter dispatching: "MxLoopingSmkPresenter".
[AI]
- Returns
- Pointer to literal class name string. [AI]
Definition at line 29 of file mxloopingsmkpresenter.h.
◆ NextFrame()
|
overridevirtual |
[AI] Advances to the next frame of the video, managing end of stream logic and frame reloading for looping playback.
[AI]
[AI] When end of stream is reached, the tickle state advances to repeating, otherwise loads current frame, loops, and adjusts timing based on video FPS. [AI]
Reimplemented from MxVideoPresenter.
Definition at line 52 of file mxloopingsmkpresenter.cpp.
◆ RepeatingTickle()
|
overridevirtual |
[AI] Processes the repeating tickle state, manages looping frame/time logic and state transitions for repeating video playback.
[AI]
[AI] When in repeating tickle state, advances frames, handles end/beginning of the video, and resets palettes and timing as needed to achieve a loop. [AI]
Reimplemented from MxPresenter.
Definition at line 83 of file mxloopingsmkpresenter.cpp.
◆ VTable0x88()
|
overridevirtual |
[AI] Handles palette resets and frame control at the logical end of a loop.
[AI]
[AI] If the current frame reaches the total frame count, resets current frame and clears the video palette to begin a new loop cycle. [AI]
Reimplemented from MxSmkPresenter.
Definition at line 42 of file mxloopingsmkpresenter.cpp.
◆ VTable0x8c()
|
virtual |
[AI] Processes looped frame loading and tickle state progression during loop playback.
[AI]
[AI] If the elapsed duration exceeds the intended loop duration, tickle state is advanced to freezing; otherwise, it continues looping through the video frames, adjusting elapsed time. [AI]
- Note
- [AI] Virtual: meant to allow further refinement of frame looping strategy in subclasses. [AI]
Definition at line 69 of file mxloopingsmkpresenter.cpp.
The documentation for this class was generated from the following files:
