VizKit::VisualStageControl Class Reference

#include <VisualStageControl.h>

Collaboration diagram for VizKit::VisualStageControl:

List of all members.

Static Public Member Functions
static void	dispose (void)
static void	doEnsembleShow (const VisualPlayerState &visualPlayerState)
static VisualActor *	getVisualActorByName (const char *const aVisualActorName)
static void	registerObserverForNotification (VisualActor *aVisualActor, const VisualNotificationKey aNotificationKey)
static void	removeObserverOfNotification (VisualActor *aVisualActor, const VisualNotificationKey aNotificationKey)
static void	dispatchNotification (VisualNotification &aNotification)
static void	checkForFadeOutEvent (void)
static void	handleKeyPressed (const char keyboadVal, const PlayerShowMode showMode)
Private Member Functions
	VisualStageControl ()
	~VisualStageControl ()
	VisualStageControl (const VisualStageControl &other)
VisualStageControl &	operator= (const VisualStageControl &other)
void	init (void)
Static Private Member Functions
static VisualStageControl *	getInstance (void)
Private Attributes
VisualEnsemble *	aVisualEnsemble
Static Private Attributes
static VisualStageControl *	theVisualStageControl = NULL

---

Detailed Description

Singleton mediator that controls the show of the VisualEnsemble. All public methods are declared static. Controls the show of the VisualEnsemble and communicates with individual actors. The VisualStageControl can manipulate the behaviour of individual VisualActors.

---

Constructor & Destructor Documentation

VisualStageControl::VisualStageControl

(

)

[private]

The constructor. VisualStageControl is a singleton class. The constructor is private. New instance of class can only be created internally.

VisualStageControl::~VisualStageControl

(

)

[private]

The destructor. VisualStageControl is a singleton class. The destructor is private. Instance of class can only be destructed internally.

VizKit::VisualStageControl::VisualStageControl

(

const VisualStageControl &

other

)

[private]

Copy constructor.

Parameters:

other

Another VisualStageControl.

Remarks:

Explicitely declared in private section and not implemented to enforce uniqueness of singleton pattern.

---

Member Function Documentation

void VisualStageControl::checkForFadeOutEvent

(

void

)

[static]

Checks whether the fade out event should be sent. If it should, a notification is added to the queue.

Remarks:

The kAudioPlayReachedFadeOutTimeEvt event is sent if remaining audio time of track is less than kFadeOutTimeBeforeEndOfTrackInMS.

void VisualStageControl::dispatchNotification

(

VisualNotification &

aNotification

)

[static]

Dispatches a VisualNotification.

Parameters:

aNotification

A notification.

void VisualStageControl::dispose

(

void

)

[static]

Disposes the VisualStageControl.

void VisualStageControl::doEnsembleShow

(

const VisualPlayerState &

visualPlayerState

)

[static]

Sends each actor a message to prepare, perform and finish show.

Parameters:

visualPlayerState

Read-only access to the VisualPlayerState.

VisualStageControl * VisualStageControl::getInstance

(

void

)

[static, private]

Initializes the VisualStageControl if neccessary. Returns a pointer to the VisualStageControl. The VisualStageControl is a singleton.

Returns:

A pointer to the VisualStageControl.

VisualActor * VisualStageControl::getVisualActorByName

(

const char *const

aVisualActorName

)

[static]

Returns a pointer to a VisualActor whose name is aVisualActorName.

Parameters:

aVisualActorName

The name of the visual actor.

Returns:

A pointer to a VisualActor whose name is aVisualActorName or NULL if none is found.

void VisualStageControl::handleKeyPressed	(	const char	keyboadVal,
		const PlayerShowMode	showMode
	)			[static]

Processes keyboard events.

Parameters:

	keyboadVal	The value of the key that was pressed.
	showMode	The show mode.

void VisualStageControl::init

(

void

)

[private]

Initializes the VisualStageControl.

Remarks:

In VisualStageControl's init() the VisualActors are constructed and added to the VisualEnsemble.

VisualStageControl& VizKit::VisualStageControl::operator=

(

const VisualStageControl &

other

)

[private]

Assignment operator.

Remarks:

Explicitely declared in private section and not implemented to enforce uniqueness of singleton pattern.

void VisualStageControl::registerObserverForNotification	(	VisualActor *	aVisualActor,
		const VisualNotificationKey	aNotificationKey
	)			[static]

Registers a VisualActor for a specific notification (event/message).

Parameters:

	aVisualActor	A visual actor.
	aNotificationKey	An enum that denotes a notification.

void VisualStageControl::removeObserverOfNotification	(	VisualActor *	aVisualActor,
		const VisualNotificationKey	aNotificationKey
	)			[static]

Removes a VisualActor from the list of observers for a specific notification (event/message).

Parameters:

	aVisualActor	A visual actor.
	aNotificationKey	An enum that denotes a notification.

---

Member Data Documentation

VisualEnsemble* VizKit::VisualStageControl::aVisualEnsemble [private]

A pointer to a visual ensemble.

VisualStageControl * VisualStageControl::theVisualStageControl = NULL [static, private]

VisualStageControl is a singleton class. Pointer to private instance is handled internally.

---

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

• VisualStageControl.h
• VisualStageControl.cpp