VTK
vtkWin32OpenGLRenderWindow.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3 Program: Visualization Toolkit
4 Module: vtkWin32OpenGL2RenderWindow.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 =========================================================================*/
24 #ifndef vtkWin32OpenGLRenderWindow_h
25 #define vtkWin32OpenGLRenderWindow_h
26 
27 #include "vtkRenderingOpenGL2Module.h" // For export macro
28 #include <stack> // for ivar
29 #include "vtkOpenGLRenderWindow.h"
30 
31 #include "vtkWindows.h" // For windows API
32 
33 class vtkIdList;
34 
35 class VTKRENDERINGOPENGL2_EXPORT vtkWin32OpenGLRenderWindow : public vtkOpenGLRenderWindow
36 {
37 public:
40  void PrintSelf(ostream& os, vtkIndent indent);
41 
45  virtual void Start(void);
46 
50  void Frame(void);
51 
55  virtual void WindowInitialize(void);
56 
63  virtual void Initialize(void);
64 
70  virtual void Finalize(void);
71 
75  virtual void SetFullScreen(int);
76 
80  virtual void WindowRemap(void);
81 
85  virtual void PrefFullScreen(void);
86 
88 
91  virtual void SetSize(int,int);
92  virtual void SetSize(int a[2]) {vtkOpenGLRenderWindow::SetSize(a);};
94 
98  virtual int *GetSize();
99 
101 
104  virtual void SetPosition(int,int);
105  virtual void SetPosition(int a[2]) {vtkOpenGLRenderWindow::SetPosition(a);};
107 
111  virtual int *GetScreenSize();
112 
116  virtual int *GetPosition();
117 
122  virtual void SetWindowName(const char *);
123 
127  void SetWindowInfo(char *);
128 
132  void SetNextWindowInfo(char *);
133 
137  void SetParentInfo(char *);
138 
139  virtual void *GetGenericDisplayId() {return (void *)this->ContextId;};
140  virtual void *GetGenericWindowId() {return (void *)this->WindowId;};
141  virtual void *GetGenericParentId() {return (void *)this->ParentId;};
142  virtual void *GetGenericContext() {return (void *)this->DeviceContext;};
143  virtual void *GetGenericDrawable() {return (void *)this->WindowId;};
144  virtual void SetDisplayId(void *);
145 
149  virtual HWND GetWindowId();
150 
152 
155  virtual void SetWindowId(HWND);
156  void SetWindowId(void *foo) {this->SetWindowId((HWND)foo);};
158 
164 
166 
169  virtual void SetParentId(HWND);
170  void SetParentId(void *foo) {this->SetParentId((HWND)foo);};
172 
173  void SetContextId(HGLRC); // hsr
174  void SetDeviceContext(HDC); // hsr
175 
179  virtual void SetNextWindowId(HWND);
180 
186  virtual void SetNextWindowId(void *arg);
187 
194  virtual void SetStereoCapableWindow(int capable);
195 
199  void MakeCurrent();
200 
204  virtual bool IsCurrent();
205 
209  const char *ReportCapabilities();
210 
214  int IsDirect();
215 
221  virtual int GetEventPending();
222 
224 
227  virtual void SetupPalette(HDC hDC);
229  HDC hDC, DWORD dwFlags, int debug,
230  int bpp=16, int zbpp=16);
232 
236  void Clean();
237 
239 
245  void HideCursor();
246  void ShowCursor();
247  void SetCursorPosition(int x, int y);
249 
253  virtual void SetCurrentCursor(int);
254 
255  virtual bool DetectDPI();
256 
261  virtual void SetOffScreenRendering(int offscreen);
262 
264 
271  virtual void PushContext();
272  virtual void PopContext();
274 
275 protected:
278 
279  HINSTANCE ApplicationInstance;
280  HPALETTE Palette;
281  HPALETTE OldPalette;
282  HGLRC ContextId;
283  HDC DeviceContext;
284  BOOL MFChandledWindow;
285  HWND WindowId;
286  HWND ParentId;
287  HWND NextWindowId;
288  int OwnWindow;
289  int ScreenSize[2];
290 
291  std::stack<HGLRC> ContextStack;
292  std::stack<HDC> DCStack;
293 
294  int CreatingOffScreenWindow; // to avoid recursion (and memory leaks...)
295 
296  // message handler
297  virtual LRESULT MessageProc(HWND hWnd, UINT message,
298  WPARAM wParam, LPARAM lParam);
299 
300  static LRESULT APIENTRY WndProc(HWND hWnd, UINT message,
301  WPARAM wParam, LPARAM lParam);
302  int CursorHidden;
303  int ForceMakeCurrent;
304 
305  char *Capabilities;
306  int WindowIdReferenceCount;
307  void ResizeWhileOffscreen(int xsize, int ysize);
308  virtual void CreateAWindow();
309  virtual void DestroyWindow();
312  void CreateOffScreenWindow(int width,int height);
315 
316 private:
317  vtkWin32OpenGLRenderWindow(const vtkWin32OpenGLRenderWindow&) VTK_DELETE_FUNCTION;
318  void operator=(const vtkWin32OpenGLRenderWindow&) VTK_DELETE_FUNCTION;
319 };
320 
321 
322 #endif
vtkWin32OpenGLRenderWindow::GetGenericDrawable
virtual void * GetGenericDrawable()
Definition: vtkWin32OpenGLRenderWindow.h:143
vtkWin32OpenGLRenderWindow::InitializeApplication
void InitializeApplication()
vtkWin32OpenGLRenderWindow::PopContext
virtual void PopContext()
vtkWin32OpenGLRenderWindow::PrefFullScreen
virtual void PrefFullScreen(void)
Set the preferred window size to full screen.
vtkWin32OpenGLRenderWindow::ResizeWhileOffscreen
void ResizeWhileOffscreen(int xsize, int ysize)
vtkWin32OpenGLRenderWindow::Initialize
virtual void Initialize(void)
Initialize the rendering window.
vtkWin32OpenGLRenderWindow
OpenGL rendering window.
Definition: vtkWin32OpenGLRenderWindow.h:33
vtkWin32OpenGLRenderWindow::SetCurrentCursor
virtual void SetCurrentCursor(int)
Change the shape of the cursor.
vtkWin32OpenGLRenderWindow::SetNextWindowInfo
void SetNextWindowInfo(char *)
Sets the WindowInfo that will be used after a WindowRemap.
vtkWin32OpenGLRenderWindow::GetEventPending
virtual int GetEventPending()
Check to see if a mouse button has been pressed or mouse wheel activated.
vtkWin32OpenGLRenderWindow::GetGenericDisplayId
virtual void * GetGenericDisplayId()
Definition: vtkWin32OpenGLRenderWindow.h:139
vtkWin32OpenGLRenderWindow::ReportCapabilities
const char * ReportCapabilities()
Get report of capabilities for the render window.
vtkWin32OpenGLRenderWindow::GetGenericParentId
virtual void * GetGenericParentId()
Definition: vtkWin32OpenGLRenderWindow.h:141
vtkWin32OpenGLRenderWindow::SetDeviceContext
void SetDeviceContext(HDC)
vtkWin32OpenGLRenderWindow::SetStereoCapableWindow
virtual void SetStereoCapableWindow(int capable)
Prescribe that the window be created in a stereo-capable mode.
vtkWin32OpenGLRenderWindow::SetWindowId
void SetWindowId(void *foo)
Definition: vtkWin32OpenGLRenderWindow.h:156
vtkWin32OpenGLRenderWindow::SetWindowName
virtual void SetWindowName(const char *)
Set the name of the window.
vtkWin32OpenGLRenderWindow::Frame
void Frame(void)
End the rendering process and display the image.
vtkWin32OpenGLRenderWindow::~vtkWin32OpenGLRenderWindow
~vtkWin32OpenGLRenderWindow()
vtkWin32OpenGLRenderWindow::IsDirect
int IsDirect()
Is this render window using hardware acceleration? 0-false, 1-true.
vtkWin32OpenGLRenderWindow::SetNextWindowId
virtual void SetNextWindowId(void *arg)
Set the window id of the new window once a WindowRemap is done.
vtkWin32OpenGLRenderWindow::VTKRegisterClass
void VTKRegisterClass()
vtkWin32OpenGLRenderWindow::WindowRemap
virtual void WindowRemap(void)
Remap the window.
vtkWin32OpenGLRenderWindow::SetCursorPosition
void SetCursorPosition(int x, int y)
vtkWin32OpenGLRenderWindow::WndProc
static LRESULT APIENTRY WndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
vtkWin32OpenGLRenderWindow::MessageProc
virtual LRESULT MessageProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
vtkWin32OpenGLRenderWindow::Start
virtual void Start(void)
Begin the rendering process.
vtkWin32OpenGLRenderWindow::GetSize
virtual int * GetSize()
Get the current size of the window in pixels.
vtkWin32OpenGLRenderWindow::SetParentId
virtual void SetParentId(HWND)
Set the window's parent id to a pre-existing window.
vtkWin32OpenGLRenderWindow::HideCursor
void HideCursor()
Hide or Show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to di...
vtkWin32OpenGLRenderWindow::SetWindowId
virtual void SetWindowId(HWND)
Set the window id to a pre-existing window.
vtkOpenGLRenderWindow.h
vtkWin32OpenGLRenderWindow::GetGenericContext
virtual void * GetGenericContext()
Definition: vtkWin32OpenGLRenderWindow.h:142
vtkWin32OpenGLRenderWindow::DetectDPI
virtual bool DetectDPI()
Attempt to detect and set the DPI of the display device by querying the system.
vtkX3D::height
@ height
Definition: vtkX3D.h:254
vtkWin32OpenGLRenderWindow::IsCurrent
virtual bool IsCurrent()
Tells if this window is the current OpenGL context for the calling thread.
vtkWin32OpenGLRenderWindow::Clean
void Clean()
Clean up device contexts, rendering contexts, etc.
vtkWin32OpenGLRenderWindow::PushContext
virtual void PushContext()
Ability to push and pop this window's context as the current context.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkWin32OpenGLRenderWindow::SetContextId
void SetContextId(HGLRC)
vtkWin32OpenGLRenderWindow::SetPosition
virtual void SetPosition(int, int)
Set the position of the window.
vtkWin32OpenGLRenderWindow::Finalize
virtual void Finalize(void)
Finalize the rendering window.
vtkWin32OpenGLRenderWindow::DestroyWindow
virtual void DestroyWindow()
Destroy a not-off-screen window.
vtkWin32OpenGLRenderWindow::SetOffScreenRendering
virtual void SetOffScreenRendering(int offscreen)
Override the default implementation so that we can actively switch between on and off screen renderin...
vtkIdList
list of point or cell ids
Definition: vtkIdList.h:37
vtkWin32OpenGLRenderWindow::SetNextWindowId
virtual void SetNextWindowId(HWND)
Set the window id of the new window once a WindowRemap is done.
vtkWin32OpenGLRenderWindow::SetFullScreen
virtual void SetFullScreen(int)
Change the window to fill the entire screen.
vtkWin32OpenGLRenderWindow::ShowCursor
void ShowCursor()
vtkWin32OpenGLRenderWindow::New
static vtkWin32OpenGLRenderWindow * New()
vtkWin32OpenGLRenderWindow::SetPosition
virtual void SetPosition(int a[2])
Definition: vtkWin32OpenGLRenderWindow.h:105
vtkWin32OpenGLRenderWindow::CreateOffScreenWindow
void CreateOffScreenWindow(int width, int height)
vtkWin32OpenGLRenderWindow::CleanUpOffScreenRendering
void CleanUpOffScreenRendering(void)
vtkWin32OpenGLRenderWindow::SetSize
virtual void SetSize(int, int)
Set the size of the window in pixels.
vtkWin32OpenGLRenderWindow::SetSize
virtual void SetSize(int a[2])
Set the size of the window in screen coordinates in pixels.
Definition: vtkWin32OpenGLRenderWindow.h:92
vtkWin32OpenGLRenderWindow::SetupPalette
virtual void SetupPalette(HDC hDC)
Initialize OpenGL for this window.
vtkWin32OpenGLRenderWindow::DCStack
std::stack< HDC > DCStack
Definition: vtkWin32OpenGLRenderWindow.h:292
vtkWin32OpenGLRenderWindow::SetParentId
void SetParentId(void *foo)
Definition: vtkWin32OpenGLRenderWindow.h:170
vtkWin32OpenGLRenderWindow::GetWindowId
virtual HWND GetWindowId()
Get the window id.
vtkWin32OpenGLRenderWindow::SetParentInfo
void SetParentInfo(char *)
Sets the HWND id of the window that WILL BE created.
vtkWin32OpenGLRenderWindow::InitializeFromCurrentContext
virtual bool InitializeFromCurrentContext()
Initialize the render window from the information associated with the currently activated OpenGL cont...
vtkWin32OpenGLRenderWindow::vtkWin32OpenGLRenderWindow
vtkWin32OpenGLRenderWindow()
vtkWin32OpenGLRenderWindow::MakeCurrent
void MakeCurrent()
Make this windows OpenGL context the current context.
vtkWin32OpenGLRenderWindow::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
vtkWin32OpenGLRenderWindow::SetupPixelFormatPaletteAndContext
virtual void SetupPixelFormatPaletteAndContext(HDC hDC, DWORD dwFlags, int debug, int bpp=16, int zbpp=16)
vtkWin32OpenGLRenderWindow::GetGenericWindowId
virtual void * GetGenericWindowId()
Definition: vtkWin32OpenGLRenderWindow.h:140
vtkWin32OpenGLRenderWindow::CleanUpRenderers
void CleanUpRenderers()
vtkOpenGLRenderWindow
OpenGL rendering window.
Definition: vtkOpenGLRenderWindow.h:39
vtkWindow::SetPosition
virtual void SetPosition(int, int)
vtkWin32OpenGLRenderWindow::GetPosition
virtual int * GetPosition()
Get the position in screen coordinates of the window.
vtkWin32OpenGLRenderWindow::SetDisplayId
virtual void SetDisplayId(void *)
Dummy stubs for vtkWindow API.
vtkWin32OpenGLRenderWindow::CreateAWindow
virtual void CreateAWindow()
Create a not-off-screen window.
vtkWin32OpenGLRenderWindow::SetWindowInfo
void SetWindowInfo(char *)
Set this RenderWindow's window id to a pre-existing window.
vtkWin32OpenGLRenderWindow::GetScreenSize
virtual int * GetScreenSize()
Get the current size of the screen in pixels.
vtkWin32OpenGLRenderWindow::WindowInitialize
virtual void WindowInitialize(void)
Create the window.
vtkWin32OpenGLRenderWindow::ContextStack
std::stack< HGLRC > ContextStack
Definition: vtkWin32OpenGLRenderWindow.h:291
vtkOpenGLRenderWindow::SetSize
virtual void SetSize(int a[2])
Set the size of the window in screen coordinates in pixels.