vtkCarbonRenderWindowInteractor Class Reference
#include <vtkCarbonRenderWindowInteractor.h>
Detailed Description
implements Carbon specific functions required by vtkRenderWindowInteractor.The interactor interfaces with vtkCarbonWindow to trap messages from the Carbon window manager and send them to vtk.
- Events:
- vtkCommand::KeyPressEvent vtkCommand::ConfigureEvent vtkCommand::MouseWheelBackwardEvent vtkCommand::MiddleButtonPressEvent vtkCommand::KeyReleaseEvent vtkCommand::EnterEvent vtkCommand::MiddleButtonReleaseEvent vtkCommand::RightButtonPressEvent vtkCommand::CharEvent vtkCommand::MouseMoveEvent vtkCommand::ExitEvent vtkCommand::MouseWheelForwardEvent vtkCommand::StartEvent vtkCommand::TimerEvent vtkCommand::LeftButtonPressEvent vtkCommand::RightButtonReleaseEvent vtkCommand::LeaveEvent vtkCommand::LeftButtonReleaseEvent
Definition at line 49 of file vtkCarbonRenderWindowInteractor.h.
Public Types | |
| typedef vtkRenderWindowInteractor | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual void | Initialize () |
| virtual void | Start () |
| void | TerminateApp (void) |
| virtual void | ExitCallback () |
| virtual void | Enable () |
| virtual void | Disable () |
| virtual void | SetInstallMessageProc (int) |
| virtual int | GetInstallMessageProc () |
| virtual void | InstallMessageProcOn () |
| virtual void | InstallMessageProcOff () |
| void | GetLastMouseDelta (int delta[2]) |
| void | SetLastMouseDelta (int deltaX, int deltaY) |
| void | SetMouseInsideWindow (int val) |
| int | GetMouseInsideWindow () |
| void | SetMouseButtonDown (int val) |
| int | GetMouseButtonDown () |
Static Public Member Functions | |
| static vtkCarbonRenderWindowInteractor * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkCarbonRenderWindowInteractor * | SafeDownCast (vtkObject *o) |
| static void | SetClassExitMethod (void(*f)(void *), void *arg) |
| static void | SetClassExitMethodArgDelete (void(*f)(void *)) |
Protected Member Functions | |
| vtkCarbonRenderWindowInteractor () | |
| ~vtkCarbonRenderWindowInteractor () | |
| virtual int | InternalCreateTimer (int timerId, int timerType, unsigned long duration) |
| virtual int | InternalDestroyTimer (int platformTimerId) |
Protected Attributes | |
| EventHandlerUPP | ViewProcUPP |
| EventHandlerUPP | WindowProcUPP |
| int | InstallMessageProc |
| int | LastMouseDelta [2] |
| int | LeaveCheckId |
| int | MouseInsideWindow |
| int | MouseButtonDown |
Static Protected Attributes | |
| static void(* | ClassExitMethod )(void *) |
| static void(* | ClassExitMethodArgDelete )(void *) |
| static void * | ClassExitMethodArg |
Member Typedef Documentation
Reimplemented from vtkRenderWindowInteractor.
Definition at line 55 of file vtkCarbonRenderWindowInteractor.h.
Constructor & Destructor Documentation
| vtkCarbonRenderWindowInteractor::vtkCarbonRenderWindowInteractor | ( | ) | [protected] |
| vtkCarbonRenderWindowInteractor::~vtkCarbonRenderWindowInteractor | ( | ) | [protected] |
Member Function Documentation
| static vtkCarbonRenderWindowInteractor* vtkCarbonRenderWindowInteractor::New | ( | ) | [static] |
Construct object so that light follows camera motion.
Reimplemented from vtkRenderWindowInteractor.
| virtual const char* vtkCarbonRenderWindowInteractor::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkRenderWindowInteractor.
| static int vtkCarbonRenderWindowInteractor::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkRenderWindowInteractor.
| virtual int vtkCarbonRenderWindowInteractor::IsA | ( | const char * | name | ) | [virtual] |
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkRenderWindowInteractor.
| static vtkCarbonRenderWindowInteractor* vtkCarbonRenderWindowInteractor::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkRenderWindowInteractor.
| void vtkCarbonRenderWindowInteractor::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkRenderWindowInteractor.
| virtual void vtkCarbonRenderWindowInteractor::Initialize | ( | ) | [virtual] |
Initialize the even handler
Reimplemented from vtkRenderWindowInteractor.
| virtual void vtkCarbonRenderWindowInteractor::Enable | ( | ) | [virtual] |
Enable/Disable interactions. By default interactors are enabled when initialized. Initialize() must be called prior to enabling/disabling interaction. These methods are used when a window/widget is being shared by multiple renderers and interactors. This allows a "modal" display where one interactor is active when its data is to be displayed and all other interactors associated with the widget are disabled when their data is not displayed.
Reimplemented from vtkRenderWindowInteractor.
| virtual void vtkCarbonRenderWindowInteractor::Disable | ( | ) | [virtual] |
Enable/Disable interactions. By default interactors are enabled when initialized. Initialize() must be called prior to enabling/disabling interaction. These methods are used when a window/widget is being shared by multiple renderers and interactors. This allows a "modal" display where one interactor is active when its data is to be displayed and all other interactors associated with the widget are disabled when their data is not displayed.
Reimplemented from vtkRenderWindowInteractor.
| virtual void vtkCarbonRenderWindowInteractor::Start | ( | ) | [virtual] |
This will start up the event loop and never return. If you call this method it will loop processing events until the application is exited.
Reimplemented from vtkRenderWindowInteractor.
| virtual void vtkCarbonRenderWindowInteractor::SetInstallMessageProc | ( | int | ) | [virtual] |
By default the interactor installs a MessageProc callback which intercepts windows messages to the window and controls interactions. MFC or BCB programs can prevent this and instead directly route any mouse/key messages into the event bindings by setting InstallMessgeProc to false.
| virtual int vtkCarbonRenderWindowInteractor::GetInstallMessageProc | ( | ) | [virtual] |
By default the interactor installs a MessageProc callback which intercepts windows messages to the window and controls interactions. MFC or BCB programs can prevent this and instead directly route any mouse/key messages into the event bindings by setting InstallMessgeProc to false.
| virtual void vtkCarbonRenderWindowInteractor::InstallMessageProcOn | ( | ) | [virtual] |
By default the interactor installs a MessageProc callback which intercepts windows messages to the window and controls interactions. MFC or BCB programs can prevent this and instead directly route any mouse/key messages into the event bindings by setting InstallMessgeProc to false.
| virtual void vtkCarbonRenderWindowInteractor::InstallMessageProcOff | ( | ) | [virtual] |
By default the interactor installs a MessageProc callback which intercepts windows messages to the window and controls interactions. MFC or BCB programs can prevent this and instead directly route any mouse/key messages into the event bindings by setting InstallMessgeProc to false.
| void vtkCarbonRenderWindowInteractor::TerminateApp | ( | void | ) | [virtual] |
Carbon specific application terminate, calls ClassExitMethod then calls PostQuitMessage(0) to terminate app. An application can Specify ExitMethod for alternative behaviour (i.e. suppresion of keyboard exit)
Reimplemented from vtkRenderWindowInteractor.
| static void vtkCarbonRenderWindowInteractor::SetClassExitMethod | ( | void(*)(void *) | f, | |
| void * | arg | |||
| ) | [static] |
Methods to set the default exit method for the class. This method is only used if no instance level ExitMethod has been defined. It is provided as a means to control how an interactor is exited given the various language bindings (tcl, Carbon, etc.).
| static void vtkCarbonRenderWindowInteractor::SetClassExitMethodArgDelete | ( | void(*)(void *) | f | ) | [static] |
Methods to set the default exit method for the class. This method is only used if no instance level ExitMethod has been defined. It is provided as a means to control how an interactor is exited given the various language bindings (tcl, Carbon, etc.).
| virtual void vtkCarbonRenderWindowInteractor::ExitCallback | ( | ) | [virtual] |
These methods correspond to the the Exit, User and Pick callbacks. They allow for the Style to invoke them.
Reimplemented from vtkRenderWindowInteractor.
| void vtkCarbonRenderWindowInteractor::GetLastMouseDelta | ( | int | delta[2] | ) | [inline] |
This method is for internal use only. Track the Carbon mouse deltas Carbon events that don't provide mouse position directly.
Definition at line 111 of file vtkCarbonRenderWindowInteractor.h.
| void vtkCarbonRenderWindowInteractor::SetLastMouseDelta | ( | int | deltaX, | |
| int | deltaY | |||
| ) | [inline] |
This method is for internal use only. Track the Carbon mouse deltas Carbon events that don't provide mouse position directly.
Definition at line 113 of file vtkCarbonRenderWindowInteractor.h.
| void vtkCarbonRenderWindowInteractor::SetMouseInsideWindow | ( | int | val | ) | [inline] |
This method is for internal use only. This is a state variable used for Enter/Leave events. If the mouse is dragged outside of the window, MouseInsideWindow will remain set until the mouse button is released outside of the window.
Definition at line 122 of file vtkCarbonRenderWindowInteractor.h.
| int vtkCarbonRenderWindowInteractor::GetMouseInsideWindow | ( | ) | [inline] |
This method is for internal use only. This is a state variable used for Enter/Leave events. If the mouse is dragged outside of the window, MouseInsideWindow will remain set until the mouse button is released outside of the window.
Definition at line 124 of file vtkCarbonRenderWindowInteractor.h.
| void vtkCarbonRenderWindowInteractor::SetMouseButtonDown | ( | int | val | ) | [inline] |
This method is for internal use only. This is a state variable used for Enter/Leave events. It keeps track of whether a mouse button is down.
Definition at line 132 of file vtkCarbonRenderWindowInteractor.h.
| int vtkCarbonRenderWindowInteractor::GetMouseButtonDown | ( | ) | [inline] |
This method is for internal use only. This is a state variable used for Enter/Leave events. It keeps track of whether a mouse button is down.
Definition at line 134 of file vtkCarbonRenderWindowInteractor.h.
| virtual int vtkCarbonRenderWindowInteractor::InternalCreateTimer | ( | int | timerId, | |
| int | timerType, | |||
| unsigned long | duration | |||
| ) | [protected, virtual] |
Carbon-specific internal timer methods. See the superclass for detailed documentation.
Reimplemented from vtkRenderWindowInteractor.
| virtual int vtkCarbonRenderWindowInteractor::InternalDestroyTimer | ( | int | platformTimerId | ) | [protected, virtual] |
Carbon-specific internal timer methods. See the superclass for detailed documentation.
Reimplemented from vtkRenderWindowInteractor.
Member Data Documentation
EventHandlerUPP vtkCarbonRenderWindowInteractor::ViewProcUPP [protected] |
Definition at line 142 of file vtkCarbonRenderWindowInteractor.h.
EventHandlerUPP vtkCarbonRenderWindowInteractor::WindowProcUPP [protected] |
Definition at line 143 of file vtkCarbonRenderWindowInteractor.h.
int vtkCarbonRenderWindowInteractor::InstallMessageProc [protected] |
Definition at line 144 of file vtkCarbonRenderWindowInteractor.h.
int vtkCarbonRenderWindowInteractor::LastMouseDelta[2] [protected] |
Definition at line 147 of file vtkCarbonRenderWindowInteractor.h.
int vtkCarbonRenderWindowInteractor::LeaveCheckId [protected] |
Definition at line 148 of file vtkCarbonRenderWindowInteractor.h.
int vtkCarbonRenderWindowInteractor::MouseInsideWindow [protected] |
Definition at line 149 of file vtkCarbonRenderWindowInteractor.h.
int vtkCarbonRenderWindowInteractor::MouseButtonDown [protected] |
Definition at line 150 of file vtkCarbonRenderWindowInteractor.h.
void(* vtkCarbonRenderWindowInteractor::ClassExitMethod)(void *) [static, protected] |
Class variables so an exit method can be defined for this class (used to set different exit methods for various language bindings, i.e. tcl, java, Carbon)
void(* vtkCarbonRenderWindowInteractor::ClassExitMethodArgDelete)(void *) [static, protected] |
Class variables so an exit method can be defined for this class (used to set different exit methods for various language bindings, i.e. tcl, java, Carbon)
void* vtkCarbonRenderWindowInteractor::ClassExitMethodArg [static, protected] |
Class variables so an exit method can be defined for this class (used to set different exit methods for various language bindings, i.e. tcl, java, Carbon)
Definition at line 159 of file vtkCarbonRenderWindowInteractor.h.
The documentation for this class was generated from the following file:
- dox/Rendering/vtkCarbonRenderWindowInteractor.h
