[AI] Presenter for handling "Event" stream data, typically parsed from event actions in SI files. More...

#include <mxeventpresenter.h>

Inheritance diagram for MxEventPresenter:

[legend]

Collaboration diagram for MxEventPresenter:

[legend]

Public Member Functions
	MxEventPresenter ()
	[AI] Constructs an event presenter and initializes internal state. More...

	~MxEventPresenter () override
	[AI] Destructor, unregisters from event manager and releases memory. More...

const char *	ClassName () const override
	[AI] Returns the class identifier of this presenter instance. More...

MxBool	IsA (const char *p_name) const override
	[AI] Checks if this object matches, or derives from, a class of the given name. More...

void	ReadyTickle () override
	[AI] Processes event data in the ready state; copies the next chunk's data and prepares for parsing extra event commands. More...

void	StartingTickle () override
	[AI] Processes "starting" state, transitioning to streaming if elapsed time has passed the chunk time. More...

MxResult	AddToManager () override
	[AI] Registers this presenter with the event manager for tickling and notification. More...

void	Destroy () override
	[AI] Unregisters this presenter from the event manager and frees owned resources, including event data buffer. More...

MxResult	PutData () override
	[AI] If the event is a variable table command (event type == 2), parses and updates the variable table. More...

virtual void	CopyData (MxStreamChunk *p_chunk)
	[AI] Copies raw chunk data from a stream chunk (e.g., from a SI file), for use by the event presenter during parsing/execution. More...

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 static class identifier for this presenter ("MxEventPresenter"). 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 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 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 handling "Event" stream data, typically parsed from event actions in SI files.

MxEventPresenter is a derived class of MxMediaPresenter and responsible for processing and dispatching events encoded in streamed chunks, often to trigger in-game changes (such as variable table updates) in response to script commands. Handles memory for the parsed event data and interacts with the variable table if the event chunk represents a variable change. Registered with the event manager for processing and cleanup. [AI]

Definition at line 15 of file mxeventpresenter.h.

Constructor & Destructor Documentation

◆ MxEventPresenter()

MxEventPresenter::MxEventPresenter ( )

[AI] Constructs an event presenter and initializes internal state.

Definition at line 16 of file mxeventpresenter.cpp.

◆ ~MxEventPresenter()

MxEventPresenter::~MxEventPresenter ( )

override

[AI] Destructor, unregisters from event manager and releases memory.

Definition at line 22 of file mxeventpresenter.cpp.

Member Function Documentation

◆ AddToManager()

MxResult MxEventPresenter::AddToManager ( )

overridevirtual

[AI] Registers this presenter with the event manager for tickling and notification.

[AI]

Returns SUCCESS and registers with the event manager, or FAILURE if event manager is not present. [AI]

Reimplemented from MxPresenter.

Definition at line 34 of file mxeventpresenter.cpp.

◆ ClassName()

const char * MxEventPresenter::ClassName ( ) const

inlineoverridevirtual

[AI] Returns the class identifier of this presenter instance.

Overrides MxMediaPresenter::ClassName.

Reimplemented from MxCore.

Definition at line 40 of file mxeventpresenter.h.

◆ CopyData()

void MxEventPresenter::CopyData ( MxStreamChunk * p_chunk )

virtual

[AI] Copies raw chunk data from a stream chunk (e.g., from a SI file), for use by the event presenter during parsing/execution.

Allocates a buffer and duplicates the chunk's contents. [AI]

Parameters

p_chunk Pointer to the input MxStreamChunk holding original event data. [AI]

Definition at line 65 of file mxeventpresenter.cpp.

◆ Destroy()

void MxEventPresenter::Destroy ( )

overridevirtual

[AI] Unregisters this presenter from the event manager and frees owned resources, including event data buffer.

[AI]

Reimplemented from MxPresenter.

Definition at line 47 of file mxeventpresenter.cpp.

◆ HandlerClassName()

static const char * MxEventPresenter::HandlerClassName ( )

inlinestatic

[AI] Returns the static class identifier for this presenter ("MxEventPresenter").

Used for dynamic type checks and dispatch.

Returns: Pointer to null-terminated class name string. [AI]

Definition at line 31 of file mxeventpresenter.h.

◆ IsA()

MxBool MxEventPresenter::IsA ( const char * p_name ) const

inlineoverridevirtual

[AI] Checks if this object matches, or derives from, a class of the given name.

Returns true if p_name equals "MxEventPresenter" or if the parent class (MxMediaPresenter) matches.

Parameters

p_name Null-terminated class name to query against. [AI]

Reimplemented from MxCore.

Definition at line 50 of file mxeventpresenter.h.

◆ PutData()

MxResult MxEventPresenter::PutData ( )

overridevirtual

[AI] If the event is a variable table command (event type == 2), parses and updates the variable table.

Releases chunk memory if required and clears current chunk pointer. Always returns SUCCESS. [AI]

Reimplemented from MxPresenter.

Definition at line 96 of file mxeventpresenter.cpp.

◆ ReadyTickle()

void MxEventPresenter::ReadyTickle ( )

overridevirtual

[AI] Processes event data in the ready state; copies the next chunk's data and prepares for parsing extra event commands.

[AI]

Reimplemented from MxPresenter.

Definition at line 72 of file mxeventpresenter.cpp.

◆ StartingTickle()

void MxEventPresenter::StartingTickle ( )

overridevirtual

[AI] Processes "starting" state, transitioning to streaming if elapsed time has passed the chunk time.

[AI]

Reimplemented from MxPresenter.

Definition at line 85 of file mxeventpresenter.cpp.

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MxEventPresenter()

◆ ~MxEventPresenter()

Member Function Documentation

◆ AddToManager()

◆ ClassName()

◆ CopyData()

◆ Destroy()

◆ HandlerClassName()

◆ IsA()

◆ PutData()

◆ ReadyTickle()

◆ StartingTickle()