[AI] Concrete presenter for sound playback and control within the LEGO Island engine. More...

#include <mxsoundpresenter.h>

Inheritance diagram for MxSoundPresenter:

[legend]

Collaboration diagram for MxSoundPresenter:

[legend]

Public Member Functions
	~MxSoundPresenter () override
	[AI] Destructor, ensures resource release and deregisters the presenter from MxSoundManager. More...

void	Destroy () override
	[AI] Public destroy method called by the engine to clean up the presenter. More...

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

MxBool	IsA (const char *p_name) const override
	[AI] Tests if this instance is a MxSoundPresenter or derived type. More...

MxResult	AddToManager () override
	[AI] Registers this presenter with the global MxSoundManager. More...

Public Member Functions inherited from MxAudioPresenter
	MxAudioPresenter ()
	[AI] Constructs an audio presenter with default volume at 100%. More...

virtual MxS32	GetVolume ()
	[AI] Returns the current runtime audio volume for this presenter (0-100). More...

virtual void	SetVolume (MxS32 p_volume)
	[AI] Sets the presentation volume for playback (0-100). More...

const char *	ClassName () const override
	[AI] Returns the run-time class name string. More...

MxBool	IsA (const char *p_name) const override
	[AI] Checks if this object is or derives from the given class name. 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 class name of the presenter as a static string. More...

Static Public Member Functions inherited from MxAudioPresenter
static const char *	HandlerClassName ()
	[AI] Returns the class handler name used for presenter type registration and lookup. 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...

Protected Member Functions
void	Destroy (MxBool p_fromDestructor)
	[AI] Handles actual teardown logic for the presenter, including deregistration from 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...

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 Attributes inherited from MxAudioPresenter
MxS32	m_volume
	[AI] Current playback volume, range 0-100 (percent). 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] Concrete presenter for sound playback and control within the LEGO Island engine.

[AI] MxSoundPresenter manages the lifecycle and registration of sound resources and presentations, providing integration between an audio stream (via MxAudioPresenter base) and the MxSoundManager. It ensures that sound presenters are properly registered/unregistered and initialized/destroyed, reflecting correct resource handling for sound as a form of media presentation.

Definition at line 16 of file mxsoundpresenter.h.

Constructor & Destructor Documentation

◆ ~MxSoundPresenter()

MxSoundPresenter::~MxSoundPresenter ( )

inlineoverride

[AI] Destructor, ensures resource release and deregisters the presenter from MxSoundManager.

[AI] Calls Destroy(TRUE) to trigger resource cleanup, including custom teardown logic.

Definition at line 22 of file mxsoundpresenter.h.

Member Function Documentation

◆ AddToManager()

MxResult MxSoundPresenter::AddToManager ( )

overridevirtual

[AI] Registers this presenter with the global MxSoundManager.

[AI] Called when the object needs to participate in system sound management. Returns SUCCESS if registration was performed, FAILURE otherwise (e.g., no sound manager).

Returns: MxResult Operation result code (SUCCESS/FAILURE). [AI]

Reimplemented from MxPresenter.

Reimplemented in MxWavePresenter.

Definition at line 26 of file mxsoundpresenter.cpp.

◆ ClassName()

const char * MxSoundPresenter::ClassName ( ) const

inlineoverridevirtual

[AI] Returns the class name of this instance.

[AI] Supports runtime type identification, consistent with MxMediaPresenter framework.

Returns: const char* Name of the class ("MxSoundPresenter"). [AI]

Reimplemented from MxAudioPresenter.

Reimplemented in MxWavePresenter.

Definition at line 47 of file mxsoundpresenter.h.

◆ Destroy() [1/2]

void MxSoundPresenter::Destroy ( )

inlineoverridevirtual

[AI] Public destroy method called by the engine to clean up the presenter.

[AI] Delegates to the protected Destroy(FALSE), ensuring proper resource management when called explicitly rather than by destructor. Informs the sound manager of its removal.

Reimplemented from MxMediaPresenter.

Reimplemented in MxWavePresenter.

Definition at line 29 of file mxsoundpresenter.h.

◆ Destroy() [2/2]

void MxSoundPresenter::Destroy ( MxBool p_fromDestructor )

protected

[AI] Handles actual teardown logic for the presenter, including deregistration from manager.

[AI] If called from the destructor, ensures that the presenter is removed from the sound manager, and re-initializes the base presenter state. If not called from the destructor, explicitly invokes media base class destroy, which clears/frees all associated resources.

Parameters

p_fromDestructor Flag indicating destroy reason (TRUE if called from destructor). [AI]

Definition at line 10 of file mxsoundpresenter.cpp.

◆ HandlerClassName()

static const char * MxSoundPresenter::HandlerClassName ( )

inlinestatic

[AI] Returns the class name of the presenter as a static string.

[AI] Used for dynamic runtime type identification and factory pattern dispatch in the engine.

Returns: const char* Name of the handler class type. [AI]

Definition at line 36 of file mxsoundpresenter.h.

◆ IsA()

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

inlineoverridevirtual

[AI] Tests if this instance is a MxSoundPresenter or derived type.

[AI] Performs a type check, supporting the polymorphic "IsA" idiom for object hierarchies. Delegates up to MxAudioPresenter if no match.

Parameters

p_name Name of the class to test. [AI]

Returns: MxBool True if this matches the requested type or any parent type. [AI]

Reimplemented from MxAudioPresenter.

Reimplemented in MxWavePresenter.

Definition at line 59 of file mxsoundpresenter.h.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~MxSoundPresenter()

Member Function Documentation

◆ AddToManager()

◆ ClassName()

◆ Destroy() [1/2]

◆ Destroy() [2/2]

◆ HandlerClassName()

◆ IsA()