an X event driven interface for a RenderWindow More...
#include <vtkXOpenGLRenderWindowInteractor.h>
Public Types | |
| typedef vtkRenderWindowInteractor | Superclass |
Public Member Functions | |
| virtual int | IsA (const char *type) |
| vtkXOpenGLRenderWindowInteractor * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual void | Initialize () |
| void | TerminateApp () |
| virtual void | UpdateSize (int, int) |
| virtual void | GetMousePosition (int *x, int *y) |
| virtual int | GetBreakLoopFlag () |
| void | SetBreakLoopFlag (int) |
| void | BreakLoopFlagOff () |
| void | BreakLoopFlagOn () |
| virtual void | Initialize (XtAppContext app) |
| virtual XtAppContext | GetApp () |
| virtual void | Enable () |
| virtual void | Disable () |
| virtual void | SetWidget (Widget) |
| Widget | GetWidget () |
| virtual void | SetTopLevelShell (Widget) |
| Widget | GetTopLevelShell () |
Static Public Member Functions | |
| static vtkXOpenGLRenderWindowInteractor * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkXOpenGLRenderWindowInteractor * | SafeDownCast (vtkObjectBase *o) |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| vtkXOpenGLRenderWindowInteractor () | |
| ~vtkXOpenGLRenderWindowInteractor () | |
| XtIntervalId | AddTimeOut (XtAppContext app_context, unsigned long interval, XtTimerCallbackProc proc, XtPointer client_data) |
| void | Timer (XtPointer client_data, XtIntervalId *id) |
| void | Callback (Widget w, XtPointer client_data, XEvent *event, Boolean *ctd) |
| virtual void | StartEventLoop () |
| virtual int | InternalCreateTimer (int timerId, int timerType, unsigned long duration) |
| virtual int | InternalDestroyTimer (int platformTimerId) |
Protected Attributes | |
| Display * | DisplayId |
| Window | WindowId |
| Atom | KillAtom |
| Widget | Top |
| int | OwnTop |
| int | OwnApp |
| int | PositionBeforeStereo [2] |
| Widget | TopLevelShell |
| int | TimerId |
| vtkXOpenGLRenderWindowInteractorInternals * | Internal |
Static Protected Attributes | |
| static XtAppContext | App |
| static int | NumAppInitialized |
| static int | BreakLoopFlag |
Friends | |
| void | vtkXOpenGLRenderWindowInteractorCallback (Widget, XtPointer, XEvent *, Boolean *) |
| void | vtkXOpenGLRenderWindowInteractorTimer (XtPointer, XtIntervalId *) |
Detailed Description
an X event driven interface for a RenderWindow
vtkXOpenGLRenderWindowInteractor is a convenience object that provides event bindings to common graphics functions. For example, camera and actor functions such as zoom-in/zoom-out, azimuth, roll, and pan. IT is one of the window system specific subclasses of vtkRenderWindowInteractor. Please see vtkRenderWindowInteractor documentation for event bindings.
- See also:
- vtkRenderWindowInteractor vtkXOpenGL2RenderWindow
I've been though this and deleted all I think should go, tried to create the basic structure and if you're lucky it might even work! but frankly I doubt it
- Events:
- vtkCommand::KeyPressEvent vtkCommand::ConfigureEvent vtkCommand::MouseWheelBackwardEvent vtkCommand::KeyReleaseEvent vtkCommand::MiddleButtonPressEvent vtkCommand::EnterEvent vtkCommand::MiddleButtonReleaseEvent vtkCommand::RightButtonPressEvent vtkCommand::CharEvent vtkCommand::MouseMoveEvent vtkCommand::ExposeEvent vtkCommand::MouseWheelForwardEvent vtkCommand::LeftButtonPressEvent vtkCommand::TimerEvent vtkCommand::RightButtonReleaseEvent vtkCommand::LeaveEvent vtkCommand::LeftButtonReleaseEvent
Definition at line 53 of file vtkXOpenGLRenderWindowInteractor.h.
Member Typedef Documentation
Reimplemented from vtkRenderWindowInteractor.
Definition at line 57 of file vtkXOpenGLRenderWindowInteractor.h.
Constructor & Destructor Documentation
Member Function Documentation
| static vtkXOpenGLRenderWindowInteractor* vtkXOpenGLRenderWindowInteractor::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkRenderWindowInteractor.
| static int vtkXOpenGLRenderWindowInteractor::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 vtkXOpenGLRenderWindowInteractor::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 vtkXOpenGLRenderWindowInteractor* vtkXOpenGLRenderWindowInteractor::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkRenderWindowInteractor.
| virtual vtkObjectBase* vtkXOpenGLRenderWindowInteractor::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkRenderWindowInteractor.
Reimplemented from vtkRenderWindowInteractor.
| void vtkXOpenGLRenderWindowInteractor::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 vtkXOpenGLRenderWindowInteractor::Initialize | ( | ) | [virtual] |
Initializes the event handlers without an XtAppContext. This is good for when you don't have a user interface, but you still want to have mouse interaction.
Reimplemented from vtkRenderWindowInteractor.
| void vtkXOpenGLRenderWindowInteractor::TerminateApp | ( | ) | [virtual] |
Break the event loop on 'q','e' keypress. Want more ???
Reimplemented from vtkRenderWindowInteractor.
| virtual int vtkXOpenGLRenderWindowInteractor::GetBreakLoopFlag | ( | ) | [virtual] |
The BreakLoopFlag is checked in the Start() method. Setting it to anything other than zero will cause the interactor loop to terminate and return to the calling function.
The BreakLoopFlag is checked in the Start() method. Setting it to anything other than zero will cause the interactor loop to terminate and return to the calling function.
The BreakLoopFlag is checked in the Start() method. Setting it to anything other than zero will cause the interactor loop to terminate and return to the calling function.
The BreakLoopFlag is checked in the Start() method. Setting it to anything other than zero will cause the interactor loop to terminate and return to the calling function.
| virtual void vtkXOpenGLRenderWindowInteractor::Initialize | ( | XtAppContext | app | ) | [virtual] |
Initializes the event handlers using an XtAppContext that you have provided. This assumes that you want to own the event loop.
| virtual XtAppContext vtkXOpenGLRenderWindowInteractor::GetApp | ( | ) | [virtual] |
Initializes the event handlers using an XtAppContext that you have provided. This assumes that you want to own the event loop.
| virtual void vtkXOpenGLRenderWindowInteractor::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 vtkXOpenGLRenderWindowInteractor::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 vtkXOpenGLRenderWindowInteractor::UpdateSize | ( | int | , |
| int | |||
| ) | [virtual] |
Update the Size data member and set the associated RenderWindow's size.
Reimplemented from vtkRenderWindowInteractor.
| virtual void vtkXOpenGLRenderWindowInteractor::SetWidget | ( | Widget | ) | [virtual] |
Specify the Xt widget to use for interaction. This method is one of a couple steps that are required for setting up a vtkRenderWindowInteractor as a widget inside of another user interface. You do not need to use this method if the render window will be a stand-alone window. This is only used when you want the render window to be a subwindow within a larger user interface. In that case, you must tell the render window what X display id to use, and then ask the render window what depth, visual and colormap it wants. Then, you must create an Xt TopLevelShell with those settings. Then you can create the rest of your user interface as a child of the TopLevelShell you created. Eventually, you will create a drawing area or some other widget to serve as the rendering window. You must use the SetWidget method to tell this Interactor about that widget. It's X and it's not terribly easy, but it looks cool.
| Widget vtkXOpenGLRenderWindowInteractor::GetWidget | ( | ) | [inline] |
Specify the Xt widget to use for interaction. This method is one of a couple steps that are required for setting up a vtkRenderWindowInteractor as a widget inside of another user interface. You do not need to use this method if the render window will be a stand-alone window. This is only used when you want the render window to be a subwindow within a larger user interface. In that case, you must tell the render window what X display id to use, and then ask the render window what depth, visual and colormap it wants. Then, you must create an Xt TopLevelShell with those settings. Then you can create the rest of your user interface as a child of the TopLevelShell you created. Eventually, you will create a drawing area or some other widget to serve as the rendering window. You must use the SetWidget method to tell this Interactor about that widget. It's X and it's not terribly easy, but it looks cool.
Definition at line 117 of file vtkXOpenGLRenderWindowInteractor.h.
| virtual void vtkXOpenGLRenderWindowInteractor::SetTopLevelShell | ( | Widget | ) | [virtual] |
This method will store the top level shell widget for the interactor. This method and the method invocation sequence applies for: 1 vtkRenderWindow-Interactor pair in a nested widget hierarchy multiple vtkRenderWindow-Interactor pairs in the same top level shell It is not needed for 1 vtkRenderWindow-Interactor pair as the direct child of a top level shell multiple vtkRenderWindow-Interactor pairs, each in its own top level shell The method, along with EnterNotify event, changes the keyboard focus among the widgets/vtkRenderWindow(s) so the Interactor(s) can receive the proper keyboard events. The following calls need to be made: vtkRenderWindow's display ID need to be set to the top level shell's display ID. vtkXOpenGLRenderWindowInteractor's Widget has to be set to the vtkRenderWindow's container widget vtkXOpenGLRenderWindowInteractor's TopLevel has to be set to the top level shell widget note that the procedure for setting up render window in a widget needs to be followed. See vtkRenderWindowInteractor's SetWidget method. If multiple vtkRenderWindow-Interactor pairs in SEPARATE windows are desired, do not set the display ID (Interactor will create them as needed. Alternatively, create and set distinct DisplayID for each vtkRenderWindow. Using the same display ID without setting the parent widgets will cause the display to be reinitialized every time an interactor is initialized), do not set the widgets (so the render windows would be in their own windows), and do not set TopLevelShell (each has its own top level shell already)
| Widget vtkXOpenGLRenderWindowInteractor::GetTopLevelShell | ( | ) | [inline] |
This method will store the top level shell widget for the interactor. This method and the method invocation sequence applies for: 1 vtkRenderWindow-Interactor pair in a nested widget hierarchy multiple vtkRenderWindow-Interactor pairs in the same top level shell It is not needed for 1 vtkRenderWindow-Interactor pair as the direct child of a top level shell multiple vtkRenderWindow-Interactor pairs, each in its own top level shell The method, along with EnterNotify event, changes the keyboard focus among the widgets/vtkRenderWindow(s) so the Interactor(s) can receive the proper keyboard events. The following calls need to be made: vtkRenderWindow's display ID need to be set to the top level shell's display ID. vtkXOpenGLRenderWindowInteractor's Widget has to be set to the vtkRenderWindow's container widget vtkXOpenGLRenderWindowInteractor's TopLevel has to be set to the top level shell widget note that the procedure for setting up render window in a widget needs to be followed. See vtkRenderWindowInteractor's SetWidget method. If multiple vtkRenderWindow-Interactor pairs in SEPARATE windows are desired, do not set the display ID (Interactor will create them as needed. Alternatively, create and set distinct DisplayID for each vtkRenderWindow. Using the same display ID without setting the parent widgets will cause the display to be reinitialized every time an interactor is initialized), do not set the widgets (so the render windows would be in their own windows), and do not set TopLevelShell (each has its own top level shell already)
Definition at line 146 of file vtkXOpenGLRenderWindowInteractor.h.
| virtual void vtkXOpenGLRenderWindowInteractor::GetMousePosition | ( | int * | x, |
| int * | y | ||
| ) | [virtual] |
Re-defines virtual function to get mouse position by querying X-server.
Reimplemented from vtkRenderWindowInteractor.
| virtual int vtkXOpenGLRenderWindowInteractor::InternalCreateTimer | ( | int | timerId, |
| int | timerType, | ||
| unsigned long | duration | ||
| ) | [protected, virtual] |
X-specific internal timer methods. See the superclass for detailed documentation.
Reimplemented from vtkRenderWindowInteractor.
| virtual int vtkXOpenGLRenderWindowInteractor::InternalDestroyTimer | ( | int | platformTimerId | ) | [protected, virtual] |
X-specific internal timer methods. See the superclass for detailed documentation.
Reimplemented from vtkRenderWindowInteractor.
| XtIntervalId vtkXOpenGLRenderWindowInteractor::AddTimeOut | ( | XtAppContext | app_context, |
| unsigned long | interval, | ||
| XtTimerCallbackProc | proc, | ||
| XtPointer | client_data | ||
| ) | [protected] |
| void vtkXOpenGLRenderWindowInteractor::Timer | ( | XtPointer | client_data, |
| XtIntervalId * | id | ||
| ) | [protected] |
| void vtkXOpenGLRenderWindowInteractor::Callback | ( | Widget | w, |
| XtPointer | client_data, | ||
| XEvent * | event, | ||
| Boolean * | ctd | ||
| ) | [protected] |
| virtual void vtkXOpenGLRenderWindowInteractor::StartEventLoop | ( | ) | [protected, virtual] |
This will start up the X event loop and never return. If you call this method it will loop processing X events until the application is exited.
Reimplemented from vtkRenderWindowInteractor.
Friends And Related Function Documentation
| void vtkXOpenGLRenderWindowInteractorCallback | ( | Widget | , |
| XtPointer | , | ||
| XEvent * | , | ||
| Boolean * | |||
| ) | [friend] |
Functions that are used internally.
| void vtkXOpenGLRenderWindowInteractorTimer | ( | XtPointer | , |
| XtIntervalId * | |||
| ) | [friend] |
Functions that are used internally.
Member Data Documentation
XtAppContext vtkXOpenGLRenderWindowInteractor::App [static, protected] |
Definition at line 165 of file vtkXOpenGLRenderWindowInteractor.h.
int vtkXOpenGLRenderWindowInteractor::NumAppInitialized [static, protected] |
Definition at line 166 of file vtkXOpenGLRenderWindowInteractor.h.
Display* vtkXOpenGLRenderWindowInteractor::DisplayId [protected] |
Definition at line 168 of file vtkXOpenGLRenderWindowInteractor.h.
Window vtkXOpenGLRenderWindowInteractor::WindowId [protected] |
Definition at line 169 of file vtkXOpenGLRenderWindowInteractor.h.
Atom vtkXOpenGLRenderWindowInteractor::KillAtom [protected] |
Definition at line 170 of file vtkXOpenGLRenderWindowInteractor.h.
Widget vtkXOpenGLRenderWindowInteractor::Top [protected] |
Definition at line 171 of file vtkXOpenGLRenderWindowInteractor.h.
int vtkXOpenGLRenderWindowInteractor::OwnTop [protected] |
Definition at line 172 of file vtkXOpenGLRenderWindowInteractor.h.
int vtkXOpenGLRenderWindowInteractor::OwnApp [protected] |
Definition at line 173 of file vtkXOpenGLRenderWindowInteractor.h.
int vtkXOpenGLRenderWindowInteractor::PositionBeforeStereo[2] [protected] |
Definition at line 174 of file vtkXOpenGLRenderWindowInteractor.h.
Widget vtkXOpenGLRenderWindowInteractor::TopLevelShell [protected] |
Definition at line 175 of file vtkXOpenGLRenderWindowInteractor.h.
int vtkXOpenGLRenderWindowInteractor::TimerId [protected] |
Definition at line 176 of file vtkXOpenGLRenderWindowInteractor.h.
vtkXOpenGLRenderWindowInteractorInternals* vtkXOpenGLRenderWindowInteractor::Internal [protected] |
Definition at line 177 of file vtkXOpenGLRenderWindowInteractor.h.
int vtkXOpenGLRenderWindowInteractor::BreakLoopFlag [static, protected] |
Definition at line 191 of file vtkXOpenGLRenderWindowInteractor.h.
The documentation for this class was generated from the following file:
- /Users/kitware/Dashboards/MyTests/VTK_BLD_Release_docs/Utilities/Doxygen/dox/Rendering/OpenGL2/vtkXOpenGLRenderWindowInteractor.h
