Lego3DWavePresenter Class Reference

[AI] Handles the presentation of 3D positional audio using DirectSound buffers within the LEGO Island engine. More...

#include <lego3dwavepresenter.h>

Inheritance diagram for Lego3DWavePresenter:

Collaboration diagram for Lego3DWavePresenter:

Public Member Functions
const char *	ClassName () const override
	[AI] Returns the name used for IsA() type identification and dispatch. More...
MxBool	IsA (const char *p_name) const override
	[AI] Checks if another class matches this or a parent class type name. More...
void	StartingTickle () override
	[AI] Performs setup and initial buffer management prior to starting audio streaming. More...
void	StreamingTickle () override
	[AI] Updates the 3D buffer position each tick, keeping audio in sync with moving objects in the world. More...
MxResult	AddToManager () override
	[AI] Registers the presenter with the tickle manager, initializes for 3D mode if relevant. More...
void	Destroy () override
	[AI] Cleans up internal 3D sound resources and DirectSound objects, and reinitializes base presenter. More...
Public Member Functions inherited from MxWavePresenter
	MxWavePresenter ()
	[AI] Constructs MxWavePresenter and initializes all members. More...
	~MxWavePresenter () override
	[AI] Destroys the wave presenter and releases all associated resources, including sound buffers and memory. More...
void	Destroy () override
	[AI] Explicit resource release. More...
virtual void	Pause ()
	[AI] Pauses audio playback, halting sound buffer while keeping position for resume. More...
virtual void	Resume ()
	[AI] Resumes audio playback after a pause, restarting sound from the current buffer position. More...
virtual MxBool	IsPaused ()
	[AI] Returns pause state of the current audio playback. More...
const char *	ClassName () const override
	[AI] Returns the class name string at runtime. More...
MxBool	IsA (const char *p_name) const override
	[AI] Checks if this instance is of the given class or a parent class. More...
void	ReadyTickle () override
	[AI] Handles the transition and setup for the Ready state. Parses extra action data and advances state. More...
void	StartingTickle () override
	[AI] Handles actions required when first starting presentation. Advances to streaming state. More...
void	StreamingTickle () override
	[AI] Per-frame update when streaming the media stream. More...
void	DoneTickle () override
	[AI] Per-frame update for the "done" state; transitions this presenter to idle and ends the action. More...
void	ParseExtra () override
	[AI] Parses additional data from the associated action for configuration or world interaction. More...
MxResult	AddToManager () override
	[AI] Registers this presenter with the global MxSoundManager. More...
void	EndAction () override
	[AI] Ends the media playback action, releasing all resources, notifying listeners if necessary. More...
MxResult	PutData () override
	[AI] Allows the presenter to submit pending results or output to the engine. More...
void	Enable (MxBool p_enable) override
	[AI] Enables or disables media stream playback and transitions state as needed. More...
void	LoopChunk (MxStreamChunk *p_chunk) override
	[AI] Adds a chunk to the looping chunk list, making it available for repeated playback. More...
void	SetVolume (MxS32 p_volume) override
	[AI] Sets the presentation volume for playback (0-100). More...
Public Member Functions inherited from MxSoundPresenter
	~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 for presenter dispatching. More...
Static Public Member Functions inherited from MxWavePresenter
static const char *	HandlerClassName ()
	[AI] Returns the name identifying this presenter class. More...
Static Public Member Functions inherited from MxSoundPresenter
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...

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 MxWavePresenter
void	Init ()
	[AI] Initializes all member variables to safe/empty values. More...
void	Destroy (MxBool p_fromDestructor)
	[AI] Fully tears down/cleans up presenter state and releases resources. More...
MxS8	GetPlayedChunks ()
	[AI] Returns the index of the currently played chunk in the sound buffer. More...
MxBool	FUN_100b1ba0 ()
	[AI] Checks if more chunks can or should be streamed into buffer. More...
void	WriteToSoundBuffer (void *p_audioPtr, MxU32 p_length)
	[AI] Writes a block of audio data to the DirectSound buffer at the correct chunk offset. More...
Protected Member Functions inherited from MxSoundPresenter
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...
Protected Attributes inherited from MxWavePresenter
WaveFormat *	m_waveFormat
	[AI] Pointer to the wave format struct for buffer description/allocation. More...
LPDIRECTSOUNDBUFFER	m_dsBuffer
	[AI] DirectSound buffer handling PCM sample playback. More...
MxU32	m_chunkLength
	[AI] Size in bytes for one audio streaming chunk. More...
MxU32	m_lockSize
	[AI] Size in bytes for current buffer lock/write operation. More...
MxU8	m_writtenChunks
	[AI] Number of chunks written into the DirectSound buffer. More...
MxBool	m_started
	[AI] TRUE if audio playback has started on the buffer. More...
MxBool	m_is3d
	[AI] TRUE if buffer/audio is 3D spatialized. More...
MxS8	m_silenceData
	[AI] Value written as silence into buffer when needed (format-dependent, e.g., 0 or 0x7F). More...
MxBool	m_paused
	[AI] TRUE if playback is currently paused. 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] Handles the presentation of 3D positional audio using DirectSound buffers within the LEGO Island engine.

Inherits from MxWavePresenter to add 3D sound support. Used to play in-world audio that must be positioned and updated each frame according to the game world's logic and the listener (camera) position.

[AI] This class encapsulates a Lego3DSound object which manages the actual 3D sound buffer, and integrates with the tickling/updating system to correctly stream and update the source position in 3D. It may also fetch additional initialization parameters from associated MxDSAction objects or from parent presenters (e.g., MxCompositePresenter).

Definition at line 16 of file lego3dwavepresenter.h.

Member Function Documentation

AddToManager()

MxResult Lego3DWavePresenter::AddToManager ( )

overridevirtual

[AI] Registers the presenter with the tickle manager, initializes for 3D mode if relevant.

[AI] Calls base implementation and further enables 3D sound if supported by the engine state. [AI]

Reimplemented from MxPresenter.

Definition at line 10 of file lego3dwavepresenter.cpp.

ClassName()

const char * Lego3DWavePresenter::ClassName ( ) const

overridevirtual

[AI] Returns the name used for IsA() type identification and dispatch.

Returns

Pointer to class name string. [AI]

Reimplemented from MxCore.

Destroy()

void Lego3DWavePresenter::Destroy ( )

overridevirtual

[AI] Cleans up internal 3D sound resources and DirectSound objects, and reinitializes base presenter.

[AI] Called during destruction or detachment, ensures all associated memory is freed and presenter state is safely reset. [AI]

Reimplemented from MxPresenter.

Definition at line 23 of file lego3dwavepresenter.cpp.

HandlerClassName()

static const char * Lego3DWavePresenter::HandlerClassName ( )

static

[AI] Returns the class name for presenter dispatching.

Returns

Pointer to a string literal with the handler class name. [AI]

IsA()

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

overridevirtual

[AI] Checks if another class matches this or a parent class type name.

Parameters

p_name

Name to compare for type checking. [AI]

Returns

True if this or a parent class matches the name. [AI]

Reimplemented from MxCore.

StartingTickle()

void Lego3DWavePresenter::StartingTickle ( )

overridevirtual

[AI] Performs setup and initial buffer management prior to starting audio streaming.

[AI] Handles initializing 3D sound mode and creating the 3D buffer from action data. Also processes "FROM_PARENT" extra data to inherit audio initialization from the parent presenter if needed.

Reimplemented from MxPresenter.

Definition at line 35 of file lego3dwavepresenter.cpp.

StreamingTickle()

void Lego3DWavePresenter::StreamingTickle ( )

overridevirtual

[AI] Updates the 3D buffer position each tick, keeping audio in sync with moving objects in the world.

[AI] Calls Lego3DSound::UpdatePosition() so that audio tracks the correct world location. [AI]

Reimplemented from MxPresenter.

Definition at line 62 of file lego3dwavepresenter.cpp.

---

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

• lego3dwavepresenter.h
• lego3dwavepresenter.cpp