|The constructor. |
|The destructor. |
|VisualActor (const VisualActor &other)|
|Copy constructor. |
|VisualActor &||operator= (const VisualActor &other)|
|Assignment operator. |
|virtual VisualActor *||clone (void) const|
|Copies the current VisualActor and returns a pointer to a new VisualActor. |
|virtual void||init (void)|
|Initialization method called immediately after construction. |
|virtual const char *const||getName (void)|
|Returns the name of the actor. |
|virtual void||show (const VisualPlayerState &visualPlayerState)|
|Asks the actor to perform individual show. |
|virtual VisualActorState||getState (void)|
|Returns the state of the actor. |
|virtual void||setState (VisualActorState actorState)|
|Sets the state of the actor. |
|virtual void||handleNotification (VisualNotification &aNotification)|
|The actor receives a notification. |
|virtual uint8||getError (char *errorString)|
|After the completion of the show, the actor is called to see if any errors occured. |
|void||copy (const VisualActor &other)|
|Copy method for assignment operator and copy constructor. |
|The state of the VisualActor. |
|The name of the VisualActor. |
VisualActor defines the interface for each specific actor.
VisualActor is an abstract class each actor has to implement. Some virtual methods are pure abstract interface methods which must be overridden by the concrete actor. Some virtual methods provide a default implementation which can be overridden by the concrete actor.
Each actor should implement its own constructor that is called additionally.
Each actor can implement its own destructor.
Copy method for assignment operator and copy constructor.
After the completion of the show, the actor is called to see if any errors occured.
This method is implemented by the VisualActor interface class. It calls the OpenGL error handler. Should not be overridden by subclass. Subclasses can implement the method but should then call the superclass implementation inside the subclass implementation also.
|[out]||errorString||The error c-string.|
|const char *const VisualActor::getName||(||void||)||
Returns the name of the actor.
The name is used as identifier by the VisualStageControl.
Returns the state of the actor.
Interface method that does not need to be implemented by subclass. Default implementation returns the value of the state variable.
The actor receives a notification.
Each actor can register for a notification (event/message) by calling VisualNotification's registerNotification(). This function receives the notification. Hook method that can be implemented by subclass.
|aNotification||The notification package.|
Initialization method called immediately after construction.
Sets the state of the actor.
Interface method that does not need to be implemented by subclass. Default implementation sets the value of the state variable.
|actorState||The requested state of the actor expressed as VisualActorState.|
Asks the actor to perform individual show.
This is the main method of the actor.
|visualPlayerState||Read-only access to the VisualPlayerState.|