VizKit
3.3.7
|
Singleton mediator that controls the show of the VisualEnsemble. More...
#include <VisualStageControl.h>
Static Public Member Functions | |
static void | dispose (void) |
Disposes the VisualStageControl. | |
static void | addEnsembleMember (VisualActor *aVisualActor) |
Adds a VisualActor to the VisualEnsemble. | |
static void | doEnsembleShow (const VisualPlayerState &visualPlayerState) |
Sends each actor a message to prepare, perform and finish show. | |
static VisualActor * | getVisualActorByName (const char *const aVisualActorName) |
Returns a pointer to a VisualActor whose name is aVisualActorName. | |
static void | registerObserverForNotification (VisualActor *aVisualActor, const VisualNotificationKey aNotificationKey) |
Registers a VisualActor for a specific notification (event/message). | |
static void | removeObserverOfNotification (VisualActor *aVisualActor, const VisualNotificationKey aNotificationKey) |
Removes a VisualActor from the list of observers for a specific notification (event/message). | |
static void | dispatchNotification (VisualNotification &aNotification) |
Dispatches a VisualNotification. | |
static void | checkForFadeOutEvent (void) |
Checks whether the fade out event should be sent. | |
Private Member Functions | |
VisualStageControl () | |
The constructor. | |
~VisualStageControl () | |
The destructor. | |
VisualStageControl (const VisualStageControl &other) | |
Copy constructor. | |
VisualStageControl & | operator= (const VisualStageControl &other) |
Assignment operator. | |
void | init (void) |
Initializes the VisualStageControl. | |
Static Private Member Functions | |
static VisualStageControl * | getInstance (void) |
Initializes the VisualStageControl if neccessary. | |
Private Attributes | |
VisualEnsemble * | visualEnsemble |
A pointer to a visual ensemble. | |
Static Private Attributes | |
static VisualStageControl * | theVisualStageControl = NULL |
VisualStageControl is a singleton class. |
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.
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.
other | Another VisualStageControl. |
void VisualStageControl::addEnsembleMember | ( | VisualActor * | aVisualActor | ) | [static] |
Adds a VisualActor to the VisualEnsemble.
void VisualStageControl::checkForFadeOutEvent | ( | void | ) | [static] |
Checks whether the fade out event should be sent.
If it should, a notification is added to the queue.
void VisualStageControl::dispatchNotification | ( | VisualNotification & | aNotification | ) | [static] |
Dispatches a VisualNotification.
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.
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.
VisualActor * VisualStageControl::getVisualActorByName | ( | const char *const | aVisualActorName | ) | [static] |
Returns a pointer to a VisualActor whose name is aVisualActorName.
aVisualActorName | The name of the visual actor. |
void VisualStageControl::init | ( | void | ) | [private] |
Initializes the VisualStageControl.
VisualStageControl& VizKit::VisualStageControl::operator= | ( | const VisualStageControl & | other | ) | [private] |
Assignment operator.
void VisualStageControl::registerObserverForNotification | ( | VisualActor * | aVisualActor, |
const VisualNotificationKey | aNotificationKey | ||
) | [static] |
Registers a VisualActor for a specific notification (event/message).
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).
aVisualActor | A visual actor. |
aNotificationKey | An enum that denotes a notification. |
VisualStageControl * VisualStageControl::theVisualStageControl = NULL [static, private] |
VisualStageControl is a singleton class.
Pointer to private instance is handled internally.
A pointer to a visual ensemble.