vtkGenericRenderWindowInteractor Class Reference
#include <vtkGenericRenderWindowInteractor.h>
Detailed Description
platform-independent programmable render window interactor.vtkGenericRenderWindowInteractor provides a way to translate native mouse and keyboard events into vtk Events. By calling the methods on this class, vtk events will be invoked. This will allow scripting languages to use vtkInteractorStyles and 3D widgets.
- Events:
- vtkCommand::KeyPressEvent vtkCommand::ConfigureEvent vtkCommand::MouseWheelBackwardEvent vtkCommand::KeyReleaseEvent vtkCommand::MiddleButtonPressEvent vtkCommand::DestroyTimerEvent vtkCommand::EnterEvent vtkCommand::RightButtonPressEvent vtkCommand::MiddleButtonReleaseEvent vtkCommand::CharEvent vtkCommand::MouseMoveEvent vtkCommand::ExitEvent vtkCommand::MouseWheelForwardEvent vtkCommand::ExposeEvent vtkCommand::CreateTimerEvent vtkCommand::LeftButtonPressEvent vtkCommand::TimerEvent vtkCommand::RightButtonReleaseEvent vtkCommand::LeaveEvent vtkCommand::LeftButtonReleaseEvent
Definition at line 33 of file vtkGenericRenderWindowInteractor.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 | MouseMoveEvent () |
| virtual void | RightButtonPressEvent () |
| virtual void | RightButtonReleaseEvent () |
| virtual void | LeftButtonPressEvent () |
| virtual void | LeftButtonReleaseEvent () |
| virtual void | MiddleButtonPressEvent () |
| virtual void | MiddleButtonReleaseEvent () |
| virtual void | MouseWheelForwardEvent () |
| virtual void | MouseWheelBackwardEvent () |
| virtual void | ExposeEvent () |
| virtual void | ConfigureEvent () |
| virtual void | EnterEvent () |
| virtual void | LeaveEvent () |
| virtual void | TimerEvent () |
| virtual void | KeyPressEvent () |
| virtual void | KeyReleaseEvent () |
| virtual void | CharEvent () |
| virtual void | ExitEvent () |
| virtual void | SetTimerEventResetsTimer (int) |
| virtual int | GetTimerEventResetsTimer () |
| virtual void | TimerEventResetsTimerOn () |
| virtual void | TimerEventResetsTimerOff () |
Static Public Member Functions | |
| static vtkGenericRenderWindowInteractor * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkGenericRenderWindowInteractor * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkGenericRenderWindowInteractor () | |
| ~vtkGenericRenderWindowInteractor () | |
| virtual int | InternalCreateTimer (int timerId, int timerType, unsigned long duration) |
| virtual int | InternalDestroyTimer (int platformTimerId) |
Protected Attributes | |
| int | TimerEventResetsTimer |
Member Typedef Documentation
Reimplemented from vtkRenderWindowInteractor.
Definition at line 37 of file vtkGenericRenderWindowInteractor.h.
Constructor & Destructor Documentation
| vtkGenericRenderWindowInteractor::vtkGenericRenderWindowInteractor | ( | ) | [protected] |
| vtkGenericRenderWindowInteractor::~vtkGenericRenderWindowInteractor | ( | ) | [protected] |
Member Function Documentation
| static vtkGenericRenderWindowInteractor* vtkGenericRenderWindowInteractor::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkRenderWindowInteractor.
| virtual const char* vtkGenericRenderWindowInteractor::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkRenderWindowInteractor.
| static int vtkGenericRenderWindowInteractor::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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkRenderWindowInteractor.
| virtual int vtkGenericRenderWindowInteractor::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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkRenderWindowInteractor.
| static vtkGenericRenderWindowInteractor* vtkGenericRenderWindowInteractor::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkRenderWindowInteractor.
| void vtkGenericRenderWindowInteractor::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 vtkGenericRenderWindowInteractor::MouseMoveEvent | ( | ) | [virtual] |
Fire various events. SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
| virtual void vtkGenericRenderWindowInteractor::RightButtonPressEvent | ( | ) | [virtual] |
Fire various events. SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
| virtual void vtkGenericRenderWindowInteractor::RightButtonReleaseEvent | ( | ) | [virtual] |
Fire various events. SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
| virtual void vtkGenericRenderWindowInteractor::LeftButtonPressEvent | ( | ) | [virtual] |
Fire various events. SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
| virtual void vtkGenericRenderWindowInteractor::LeftButtonReleaseEvent | ( | ) | [virtual] |
Fire various events. SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
| virtual void vtkGenericRenderWindowInteractor::MiddleButtonPressEvent | ( | ) | [virtual] |
Fire various events. SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
| virtual void vtkGenericRenderWindowInteractor::MiddleButtonReleaseEvent | ( | ) | [virtual] |
Fire various events. SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
| virtual void vtkGenericRenderWindowInteractor::MouseWheelForwardEvent | ( | ) | [virtual] |
Fire various events. SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
| virtual void vtkGenericRenderWindowInteractor::MouseWheelBackwardEvent | ( | ) | [virtual] |
Fire various events. SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
| virtual void vtkGenericRenderWindowInteractor::ExposeEvent | ( | ) | [virtual] |
Fire various events. SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
| virtual void vtkGenericRenderWindowInteractor::ConfigureEvent | ( | ) | [virtual] |
Fire various events. SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
| virtual void vtkGenericRenderWindowInteractor::EnterEvent | ( | ) | [virtual] |
Fire various events. SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
| virtual void vtkGenericRenderWindowInteractor::LeaveEvent | ( | ) | [virtual] |
Fire various events. SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
| virtual void vtkGenericRenderWindowInteractor::TimerEvent | ( | ) | [virtual] |
Fire various events. SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
| virtual void vtkGenericRenderWindowInteractor::KeyPressEvent | ( | ) | [virtual] |
Fire various events. SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
| virtual void vtkGenericRenderWindowInteractor::KeyReleaseEvent | ( | ) | [virtual] |
Fire various events. SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
| virtual void vtkGenericRenderWindowInteractor::CharEvent | ( | ) | [virtual] |
Fire various events. SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
| virtual void vtkGenericRenderWindowInteractor::ExitEvent | ( | ) | [virtual] |
Fire various events. SetEventInformation should be called just prior to calling any of these methods. These methods will Invoke the corresponding vtk event.
| virtual void vtkGenericRenderWindowInteractor::SetTimerEventResetsTimer | ( | int | ) | [virtual] |
Flag that indicates whether the TimerEvent method should call ResetTimer to simulate repeating timers with an endless stream of one shot timers. By default this flag is on and all repeating timers are implemented as a stream of sequential one shot timers. If the observer of CreateTimerEvent actually creates a "natively repeating" timer, setting this flag to off will prevent (perhaps many many) unnecessary calls to ResetTimer. Having the flag on by default means that "natively one shot" timers can be either one shot or repeating timers with no additional work. Also, "natively repeating" timers still work with the default setting, but with potentially many create and destroy calls.
| virtual int vtkGenericRenderWindowInteractor::GetTimerEventResetsTimer | ( | ) | [virtual] |
Flag that indicates whether the TimerEvent method should call ResetTimer to simulate repeating timers with an endless stream of one shot timers. By default this flag is on and all repeating timers are implemented as a stream of sequential one shot timers. If the observer of CreateTimerEvent actually creates a "natively repeating" timer, setting this flag to off will prevent (perhaps many many) unnecessary calls to ResetTimer. Having the flag on by default means that "natively one shot" timers can be either one shot or repeating timers with no additional work. Also, "natively repeating" timers still work with the default setting, but with potentially many create and destroy calls.
| virtual void vtkGenericRenderWindowInteractor::TimerEventResetsTimerOn | ( | ) | [virtual] |
Flag that indicates whether the TimerEvent method should call ResetTimer to simulate repeating timers with an endless stream of one shot timers. By default this flag is on and all repeating timers are implemented as a stream of sequential one shot timers. If the observer of CreateTimerEvent actually creates a "natively repeating" timer, setting this flag to off will prevent (perhaps many many) unnecessary calls to ResetTimer. Having the flag on by default means that "natively one shot" timers can be either one shot or repeating timers with no additional work. Also, "natively repeating" timers still work with the default setting, but with potentially many create and destroy calls.
| virtual void vtkGenericRenderWindowInteractor::TimerEventResetsTimerOff | ( | ) | [virtual] |
Flag that indicates whether the TimerEvent method should call ResetTimer to simulate repeating timers with an endless stream of one shot timers. By default this flag is on and all repeating timers are implemented as a stream of sequential one shot timers. If the observer of CreateTimerEvent actually creates a "natively repeating" timer, setting this flag to off will prevent (perhaps many many) unnecessary calls to ResetTimer. Having the flag on by default means that "natively one shot" timers can be either one shot or repeating timers with no additional work. Also, "natively repeating" timers still work with the default setting, but with potentially many create and destroy calls.
| virtual int vtkGenericRenderWindowInteractor::InternalCreateTimer | ( | int | timerId, | |
| int | timerType, | |||
| unsigned long | duration | |||
| ) | [protected, virtual] |
Generic internal timer methods. See the superclass for detailed documentation.
Reimplemented from vtkRenderWindowInteractor.
| virtual int vtkGenericRenderWindowInteractor::InternalDestroyTimer | ( | int | platformTimerId | ) | [protected, virtual] |
Generic internal timer methods. See the superclass for detailed documentation.
Reimplemented from vtkRenderWindowInteractor.
Member Data Documentation
int vtkGenericRenderWindowInteractor::TimerEventResetsTimer [protected] |
Definition at line 92 of file vtkGenericRenderWindowInteractor.h.
The documentation for this class was generated from the following file:
- dox/Rendering/vtkGenericRenderWindowInteractor.h
