ManipulatorInterpreter.ManipulatorInterpreter Class Reference
Detailed Description
ManipulatorInterpreter is used for managing manipulators, each of which defines its own way to draw, react and affect change.
Add new manipulators to the application using the appendManipulator() method.
#include
<class_manipulator_interpreter_1_1_manipulator_interpreter.h>
Public Member Functions |
|
| __init__ () | |
| deactivate () | |
| Abstract - to be implemented by the
subclasses. |
|
| getActionMethod () | |
| handleEvent () | |
| Passes the event for handling by the
manipulators that are enabled. |
|
| addManipulatorContext () | |
| Adds the given manipulator context to be
managed by this interpreter. |
|
| addManipulator () | |
| Adds the given manipulator to be managed by
this interpreter. |
|
| getManipulator () | |
| Returns the manipulator with the given name,
if it exists; None otherwise. |
|
| MANIPULATOR_CHANGE_MODE () | |
| Sets the mode of the manipulator with the
given name to the given mode. |
|
| MANIPULATOR_CHANGE_ENABLE_STATUS () | |
| Enables or disables the manipulator with the
given name. |
|
| MANIPULATOR_FIT_TO_VIEW () | |
| CLIENT_CONNECTION_STATUS () | |
| Disables the manipulators if the user has
connected to another session as a client. |
|
| VIEWER_LAYOUT () | |
| Trigger each manipulator to update its
intersector. |
|
| MANIPULATOR_POSITION_CHANGED () | |
| If MoveManipulator is active,
determine if it is still visible on the screen and if not, display
a HUD message that
lets the user know where the manip is. |
|
Member Function Documentation
| ManipulatorInterpreter.ManipulatorInterpreter.__init__ | ( | ) |
Reimplemented from MessageInterpreter.CompositeMessageInterpreter.
| ManipulatorInterpreter.ManipulatorInterpreter.deactivate | ( | ) |
Abstract - to be implemented by the subclasses.
Performs the operations necessary to place this interpreter into a passive state. Ensure that this base class implementation is called by the subclass implementation.
Reimplemented from MessageInterpreter.CompositeMessageInterpreter.
| ManipulatorInterpreter.ManipulatorInterpreter.getActionMethod | ( | ) |
Reimplemented from MessageInterpreter.MessageInterpreter.
| ManipulatorInterpreter.ManipulatorInterpreter.handleEvent | ( | ) |
Passes the event for handling by the manipulators that are enabled.
Reimplemented from MessageInterpreter.MessageInterpreter.
| ManipulatorInterpreter.ManipulatorInterpreter.addManipulatorContext | ( | ) |
Adds the given manipulator context to be managed by this interpreter.
| ManipulatorInterpreter.ManipulatorInterpreter.addManipulator | ( | ) |
Adds the given manipulator to be managed by this interpreter.
If a manipulator with the same name has already been added, then it is replaced by the new manipulator.
| ManipulatorInterpreter.ManipulatorInterpreter.getManipulator | ( | ) |
Returns the manipulator with the given name, if it exists; None otherwise.
| ManipulatorInterpreter.ManipulatorInterpreter.MANIPULATOR_CHANGE_MODE | ( | ) |
Sets the mode of the manipulator with the given name to the given mode.
| ManipulatorInterpreter.ManipulatorInterpreter.MANIPULATOR_CHANGE_ENABLE_STATUS | ( | ) |
Enables or disables the manipulator with the given name.
| ManipulatorInterpreter.ManipulatorInterpreter.MANIPULATOR_FIT_TO_VIEW | ( | ) |
| ManipulatorInterpreter.ManipulatorInterpreter.CLIENT_CONNECTION_STATUS | ( | ) |
Disables the manipulators if the user has connected to another session as a client.
| ManipulatorInterpreter.ManipulatorInterpreter.VIEWER_LAYOUT | ( | ) |
Trigger each manipulator to update its intersector.
This message indicates that the viewport layout has changed, eg. single view to side-by-side (two viewports). Since each manipulator's intersector is specific to the viewport of its first click, each manipulator needs to be reset to possibly receive clicks from a different viewport.
| ManipulatorInterpreter.ManipulatorInterpreter.MANIPULATOR_POSITION_CHANGED | ( | ) |
If MoveManipulator is active, determine if it is still visible on the screen and if not, display a HUD message that lets the user know where the manip is.
