VTK
vtkXOpenGLRenderWindow.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkXOpenGLRenderWindow.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
31 #ifndef vtkXOpenGLRenderWindow_h
32 #define vtkXOpenGLRenderWindow_h
33 
34 #include "vtkRenderingOpenGLModule.h" // For export macro
35 #include "vtkOpenGLRenderWindow.h"
36 #include <X11/Xlib.h> // Needed for X types used in the public interface
37 #include <X11/Xutil.h> // Needed for X types used in the public interface
38 
39 class vtkIdList;
40 class vtkXOpenGLRenderWindowInternal;
41 
42 class VTKRENDERINGOPENGL_EXPORT vtkXOpenGLRenderWindow : public vtkOpenGLRenderWindow
43 {
44 public:
45  static vtkXOpenGLRenderWindow *New();
47  void PrintSelf(ostream& os, vtkIndent indent);
48 
52  virtual void Start(void);
53 
57  virtual void Frame(void);
58 
62  virtual void WindowInitialize(void);
63 
70  virtual void Initialize(void);
71 
77  virtual void Finalize(void);
78 
82  virtual void SetFullScreen(int);
83 
87  virtual void WindowRemap(void);
88 
92  virtual void PrefFullScreen(void);
93 
95 
98  virtual void SetSize(int,int);
99  virtual void SetSize(int a[2]) {this->SetSize(a[0], a[1]);};
101 
103 
106  virtual Colormap GetDesiredColormap();
107  virtual Visual *GetDesiredVisual();
108  virtual XVisualInfo *GetDesiredVisualInfo();
109  virtual int GetDesiredDepth();
111 
118  virtual void SetStereoCapableWindow(int capable);
119 
123  void MakeCurrent();
124 
128  virtual bool IsCurrent();
129 
135  void SetForceMakeCurrent();
136 
140  const char *ReportCapabilities();
141 
145  int SupportsOpenGL();
146 
150  int IsDirect();
151 
155  virtual void *GetGenericDisplayId()
156  {
157  return this->GetDisplayId();
158  }
159 
160  virtual void *GetGenericWindowId();
161  virtual void *GetGenericParentId()
162  {
163  return reinterpret_cast<void *>(this->ParentId);
164  }
165 
166  virtual void *GetGenericContext();
167  virtual void *GetGenericDrawable()
168  {
169  return reinterpret_cast<void *>(this->WindowId);
170  }
171 
175  virtual int *GetScreenSize();
176 
180  virtual int *GetPosition();
181 
185  Display *GetDisplayId();
186 
188 
192  void SetDisplayId(Display *);
193  void SetDisplayId(void *);
195 
199  Window GetParentId();
200 
202 
205  void SetParentId(Window);
206  void SetParentId(void *);
208 
212  Window GetWindowId();
213 
215 
218  void SetWindowId(Window);
219  void SetWindowId(void *);
221 
225  void SetNextWindowId(Window);
226 
232  void SetNextWindowId(void *);
233 
234  void SetWindowName(const char *);
235 
240  virtual bool InitializeFromCurrentContext();
241 
243 
246  void SetPosition(int,int);
247  void SetPosition(int a[2]) {this->SetPosition(a[0], a[1]);};
249 
251 
255  void HideCursor();
256  void ShowCursor();
258 
262  virtual void SetCurrentCursor(int);
263 
269  virtual int GetEventPending();
270 
274  void SetWindowInfo(char *info);
275 
279  void SetNextWindowInfo(char *info);
280 
284  void SetParentInfo(char *info);
285 
290  virtual void Render();
291 
295  void SetOffScreenRendering(int i);
296 
297 protected:
300 
301  vtkXOpenGLRenderWindowInternal *Internal;
302 
303  Window ParentId;
304  Window WindowId;
305  Window NextWindowId;
306  Display *DisplayId;
307  Colormap ColorMap;
310  int ScreenSize[2];
315 
316  // we must keep track of the cursors we are using
317  Cursor XCCrosshair;
318  Cursor XCArrow;
319  Cursor XCSizeAll;
320  Cursor XCSizeNS;
321  Cursor XCSizeWE;
322  Cursor XCSizeNE;
323  Cursor XCSizeNW;
324  Cursor XCSizeSE;
325  Cursor XCSizeSW;
326  Cursor XCHand;
327 
328 
329  void CreateAWindow();
330  void DestroyWindow();
331  void CreateOffScreenWindow(int width, int height);
332  void DestroyOffScreenWindow();
333  void ResizeOffScreenWindow(int width, int height);
334 
335 
336 private:
337  vtkXOpenGLRenderWindow(const vtkXOpenGLRenderWindow&) VTK_DELETE_FUNCTION;
338  void operator=(const vtkXOpenGLRenderWindow&) VTK_DELETE_FUNCTION;
339 };
340 
341 
342 
343 #endif
OpenGL rendering window.
virtual void SetOffScreenRendering(int)
Create a window in memory instead of on the screen.
virtual void Finalize()=0
Finalize the rendering process.
virtual void SetForceMakeCurrent()
If called, allow MakeCurrent() to skip cache-check when called.
virtual void SetWindowInfo(char *)=0
Dummy stubs for vtkWindow API.
virtual void SetSize(int a[2])
Specify the size of the rendering window in pixels.
virtual void * GetGenericParentId()
Dummy stubs for vtkWindow API.
virtual void WindowRemap()=0
Remap the rendering window.
virtual void * GetGenericContext()=0
Dummy stubs for vtkWindow API.
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
virtual void HideCursor()=0
Hide or Show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to di...
static vtkRenderWindow * New()
Construct an instance of vtkRenderWindow with its screen size set to 300x300, borders turned on...
virtual int * GetScreenSize()=0
Get the current size of the screen in pixels.
vtkXOpenGLRenderWindowInternal * Internal
virtual void SetWindowId(void *)=0
Dummy stubs for vtkWindow API.
virtual void SetCurrentCursor(int)
Change the shape of the cursor.
virtual void SetNextWindowInfo(char *)=0
Dummy stubs for vtkWindow API.
virtual void SetSize(int a[2])
Set the size of the window in screen coordinates in pixels.
virtual void SetFullScreen(int)=0
Turn on/off rendering full screen window size.
OpenGL rendering window.
virtual void * GetGenericDrawable()
Dummy stubs for vtkWindow API.
virtual int GetEventPending()=0
Check to see if a mouse button has been pressed.
virtual void SetStereoCapableWindow(int capable)
Prescribe that the window be created in a stereo-capable mode.
virtual const char * ReportCapabilities()
Get report of capabilities for the render window.
virtual int IsDirect()
Is this render window using hardware acceleration? 0-false, 1-true.
virtual void SetParentInfo(char *)=0
Dummy stubs for vtkWindow API.
virtual bool IsCurrent()=0
Tells if this window is the current graphics context for the calling thread.
virtual void SetParentId(void *)=0
Dummy stubs for vtkWindow API.
a simple class to control print indentation
Definition: vtkIndent.h:39
virtual void DestroyWindow()=0
Destroy a not-off-screen window.
list of point or cell ids
Definition: vtkIdList.h:36
virtual void SetDisplayId(void *)=0
Dummy stubs for vtkWindow API.
virtual void MakeCurrent()=0
Attempt to make this window the current graphics context for the calling thread.
virtual void SetNextWindowId(void *)=0
Dummy stubs for vtkWindow API.
virtual void * GetGenericDisplayId()
Xwindow get set functions.
virtual int * GetPosition()
Set/Get the position in screen coordinates of the rendering window.
virtual void Frame()=0
A termination method performed at the end of the rendering process to do things like swapping buffers...
void SetPosition(int a[2])
Move the window to a new position on the display.
virtual bool InitializeFromCurrentContext()
Initialize the render window from the information associated with the currently activated OpenGL cont...
virtual void Start()=0
Initialize the rendering process.
virtual void SetWindowName(const char *)
Get name of rendering window.
virtual void SetPosition(int, int)
Set/Get the position in screen coordinates of the rendering window.
virtual void Render()
Ask each renderer owned by this RenderWindow to render its image and synchronize this process...
virtual void Initialize(void)
Initialize the rendering window.
virtual void CreateAWindow()=0
Create a not-off-screen window.
virtual int SupportsOpenGL()
Does this render window support OpenGL? 0-false, 1-true.
virtual void ShowCursor()=0
Hide or Show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to di...
virtual void * GetGenericWindowId()=0
Dummy stubs for vtkWindow API.