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 =========================================================================*/
25 #ifndef vtkXOpenGLRenderWindow_h
26 #define vtkXOpenGLRenderWindow_h
27 
28 #include "vtkRenderingOpenGL2Module.h" // For export macro
29 #include <stack> // for ivar
30 #include "vtkOpenGLRenderWindow.h"
31 #include <X11/Xlib.h> // Needed for X types used in the public interface
32 #include <X11/Xutil.h> // Needed for X types used in the public interface
33 
34 class vtkIdList;
35 class vtkXOpenGLRenderWindowInternal;
36 
37 class VTKRENDERINGOPENGL2_EXPORT vtkXOpenGLRenderWindow : public vtkOpenGLRenderWindow
38 {
39 public:
40  static vtkXOpenGLRenderWindow *New();
42  void PrintSelf(ostream& os, vtkIndent indent);
43 
47  virtual void Start(void);
48 
52  virtual void Frame(void);
53 
57  virtual void WindowInitialize(void);
58 
65  virtual void Initialize(void);
66 
72  virtual void Finalize(void);
73 
77  virtual void SetFullScreen(int);
78 
82  virtual void WindowRemap(void);
83 
87  virtual void PrefFullScreen(void);
88 
92  virtual void SetSize(int,int);
93  virtual void SetSize(int a[2]) {this->SetSize(a[0], a[1]);}
94 
96 
99  virtual Colormap GetDesiredColormap();
100  virtual Visual *GetDesiredVisual();
101  virtual XVisualInfo *GetDesiredVisualInfo();
102  virtual int GetDesiredDepth();
104 
111  virtual void SetStereoCapableWindow(int capable);
112 
116  void MakeCurrent();
117 
121  virtual bool IsCurrent();
122 
128  void SetForceMakeCurrent();
129 
133  const char *ReportCapabilities();
134 
138  int IsDirect();
139 
143  virtual void *GetGenericDisplayId()
144  {
145  return this->GetDisplayId();
146  }
147 
148  virtual void *GetGenericWindowId();
149  virtual void *GetGenericParentId()
150  {
151  return reinterpret_cast<void *>(this->ParentId);
152  }
153 
154  virtual void *GetGenericContext();
155  virtual void *GetGenericDrawable()
156  {
157  return reinterpret_cast<void *>(this->WindowId);
158  }
159 
163  virtual int *GetScreenSize();
164 
168  virtual int *GetPosition();
169 
173  Display *GetDisplayId();
174 
176 
180  void SetDisplayId(Display *);
181  void SetDisplayId(void *);
183 
187  Window GetParentId();
188 
190 
193  void SetParentId(Window);
194  void SetParentId(void *);
196 
200  Window GetWindowId();
201 
203 
206  void SetWindowId(Window);
207  void SetWindowId(void *);
209 
213  void SetNextWindowId(Window);
214 
220  void SetNextWindowId(void *);
221 
222  void SetWindowName(const char *);
223 
228  virtual bool InitializeFromCurrentContext();
229 
231 
234  void SetPosition(int,int);
235  void SetPosition(int a[2]) {this->SetPosition(a[0], a[1]);};
237 
239 
243  void HideCursor();
244  void ShowCursor();
246 
250  virtual void SetCurrentCursor(int);
251 
257  virtual int GetEventPending();
258 
262  void SetWindowInfo(char *info);
263 
267  void SetNextWindowInfo(char *info);
268 
272  void SetParentInfo(char *info);
273 
278  void Render();
279 
283  void SetOffScreenRendering(int i);
284 
286 
293  virtual void PushContext();
294  virtual void PopContext();
296 
297 protected:
300 
301  vtkXOpenGLRenderWindowInternal *Internal;
302 
303  Window ParentId;
304  Window WindowId;
305  Window NextWindowId;
306  Display *DisplayId;
307  Colormap ColorMap;
308  int OwnWindow;
309  int OwnDisplay;
310  int ScreenSize[2];
311  int CursorHidden;
312  int ForceMakeCurrent;
313  int UsingHardware;
314  char *Capabilities;
315 
316  std::stack<Display *> DisplayStack;
317  std::stack<Drawable> DrawableStack;
318  std::stack<void *> ContextStack;
319 
320  // we must keep track of the cursors we are using
321  Cursor XCCrosshair;
322  Cursor XCArrow;
323  Cursor XCSizeAll;
324  Cursor XCSizeNS;
325  Cursor XCSizeWE;
326  Cursor XCSizeNE;
327  Cursor XCSizeNW;
328  Cursor XCSizeSE;
329  Cursor XCSizeSW;
330  Cursor XCHand;
331 
332 
333  void CreateAWindow();
334  void DestroyWindow();
335  void CreateOffScreenWindow(int width, int height);
336  void DestroyOffScreenWindow();
337  void ResizeOffScreenWindow(int width, int height);
338  void CloseDisplay();
339 
340 
341 private:
342  vtkXOpenGLRenderWindow(const vtkXOpenGLRenderWindow&) VTK_DELETE_FUNCTION;
343  void operator=(const vtkXOpenGLRenderWindow&) VTK_DELETE_FUNCTION;
344 };
345 
346 
347 
348 #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])
Set the size of the window in screen coordinates 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.
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.
std::stack< Display * > DisplayStack
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.
std::stack< Drawable > DrawableStack
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 PushContext()
Ability to push and pop this window&#39;s context as the current context.
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...
std::stack< void * > ContextStack
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 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.