VTK
vtkWin32OpenGLRenderWindow.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkWin32OpenGLRenderWindow.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 =========================================================================*/
27 #ifndef vtkWin32OpenGLRenderWindow_h
28 #define vtkWin32OpenGLRenderWindow_h
29 
30 #include "vtkRenderingOpenGLModule.h" // For export macro
31 #include "vtkOpenGLRenderWindow.h"
32 
33 class vtkIdList;
34 
35 class VTKRENDERINGOPENGL_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 
90  virtual void SetSize(int width, int height);
91  virtual void SetSize(int a[2]) { vtkOpenGLRenderWindow::SetSize(a); }
92 
96  virtual int *GetSize();
97 
101  virtual void SetPosition(int x, int y);
102  virtual void SetPosition(int a[2]) { vtkOpenGLRenderWindow::SetPosition(a); }
103 
107  virtual int *GetScreenSize();
108 
112  virtual int *GetPosition();
113 
118  virtual void SetWindowName(const char*);
119 
123  void SetWindowInfo(char*);
124 
128  void SetNextWindowInfo(char*);
129 
133  void SetParentInfo(char*);
134 
135  virtual void *GetGenericDisplayId() { return (void*)this->ContextId; }
136  virtual void *GetGenericWindowId() { return (void*)this->WindowId; }
137  virtual void *GetGenericParentId() { return (void*)this->ParentId; }
138  virtual void *GetGenericContext() { return (void*)this->DeviceContext; }
139  virtual void *GetGenericDrawable() { return (void*)this->WindowId; }
140  virtual void SetDisplayId(void*);
141 
145  virtual HWND GetWindowId();
146 
150  virtual void SetWindowId(HWND);
151  void SetWindowId(void *foo) { this->SetWindowId((HWND)foo); }
152 
158 
162  virtual void SetParentId(HWND);
163  void SetParentId(void *foo) { this->SetParentId((HWND)foo); }
164 
168  void SetContextId(HGLRC);
169 
173  void SetDeviceContext(HDC);
174 
178  virtual void SetNextWindowId(HWND);
179 
185  virtual void SetNextWindowId(void *arg);
186 
193  virtual void SetStereoCapableWindow(int capable);
194 
198  void MakeCurrent();
199 
203  virtual bool IsCurrent();
204 
208  const char *ReportCapabilities();
209 
214 
218  int IsDirect();
219 
225  virtual int GetEventPending();
226 
228 
233  void SetupMemoryRendering(int x, int y, HDC prn);
234  void SetupMemoryRendering(HBITMAP hbmp);
236  HDC GetMemoryDC();
237  unsigned char *GetMemoryData() { return this->MemoryData; }
239 
241 
244  virtual void SetupPalette(HDC hDC);
245  virtual void SetupPixelFormat(HDC hDC, DWORD dwFlags, int debug,
246  int bpp = 16, int zbpp = 16);
248 
252  void Clean();
253 
255 
259  void HideCursor();
260  void ShowCursor();
262 
265  void SetCursorPosition(int x, int y);
266 
270  virtual void SetCurrentCursor(int);
271 
272  virtual bool DetectDPI();
273 
278  virtual void SetOffScreenRendering(int offscreen);
279 
280 protected:
283 
285  HPALETTE Palette;
286  HPALETTE OldPalette;
287  HGLRC ContextId;
290  HWND WindowId;
291  HWND ParentId;
294  int ScreenSize[2];
295 
296  // the following is used to support rendering into memory
297  BITMAPINFO MemoryDataHeader;
298  HBITMAP MemoryBuffer;
299  unsigned char *MemoryData; // the data in the DIBSection
301 
303  int ScreenWindowSize[2];
307 
308  int CreatingOffScreenWindow; // to avoid recursion (and memory leaks...)
309 
310  // message handler
311  virtual LRESULT MessageProc(HWND hWnd, UINT message,
312  WPARAM wParam, LPARAM lParam);
313 
314  static LRESULT APIENTRY WndProc(HWND hWnd, UINT message,
315  WPARAM wParam, LPARAM lParam);
316 
319 
322  void ResizeWhileOffscreen(int xsize, int ysize);
323  virtual void CreateAWindow();
324  virtual void DestroyWindow();
327  void CreateOffScreenDC(int xsize, int ysize, HDC aHdc);
328  void CreateOffScreenDC(HBITMAP hbmp, HDC aHdc);
329  void CreateOffScreenWindow(int width, int height);
332 
333 private:
334  vtkWin32OpenGLRenderWindow(const vtkWin32OpenGLRenderWindow&) VTK_DELETE_FUNCTION;
335  void operator=(const vtkWin32OpenGLRenderWindow&) VTK_DELETE_FUNCTION;
336 };
337 
338 #endif
vtkWin32OpenGLRenderWindow::GetGenericDrawable
virtual void * GetGenericDrawable()
Definition: vtkWin32OpenGLRenderWindow.h:139
vtkWin32OpenGLRenderWindow::InitializeApplication
void InitializeApplication()
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:36
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::SupportsOpenGL
int SupportsOpenGL()
Does this render window support OpenGL? 0-false, 1-true.
vtkWin32OpenGLRenderWindow::Palette
HPALETTE Palette
Definition: vtkWin32OpenGLRenderWindow.h:285
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:135
vtkWin32OpenGLRenderWindow::ReportCapabilities
const char * ReportCapabilities()
Get report of capabilities for the render window.
vtkWin32OpenGLRenderWindow::NextWindowId
HWND NextWindowId
Definition: vtkWin32OpenGLRenderWindow.h:292
vtkWin32OpenGLRenderWindow::GetGenericParentId
virtual void * GetGenericParentId()
Definition: vtkWin32OpenGLRenderWindow.h:137
vtkWin32OpenGLRenderWindow::SetDeviceContext
void SetDeviceContext(HDC)
Set the window's device context.
vtkWin32OpenGLRenderWindow::SetSize
virtual void SetSize(int width, int height)
Set the size of the window in pixels.
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:151
vtkWin32OpenGLRenderWindow::MemoryBuffer
HBITMAP MemoryBuffer
Definition: vtkWin32OpenGLRenderWindow.h:298
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::ResumeScreenRendering
void ResumeScreenRendering(void)
vtkWin32OpenGLRenderWindow::WindowIdReferenceCount
int WindowIdReferenceCount
Definition: vtkWin32OpenGLRenderWindow.h:321
vtkWin32OpenGLRenderWindow::WindowId
HWND WindowId
Definition: vtkWin32OpenGLRenderWindow.h:290
vtkWin32OpenGLRenderWindow::~vtkWin32OpenGLRenderWindow
~vtkWin32OpenGLRenderWindow()
vtkWin32OpenGLRenderWindow::ContextId
HGLRC ContextId
Definition: vtkWin32OpenGLRenderWindow.h:287
vtkWin32OpenGLRenderWindow::ApplicationInstance
HINSTANCE ApplicationInstance
Definition: vtkWin32OpenGLRenderWindow.h:284
vtkWin32OpenGLRenderWindow::GetMemoryDC
HDC GetMemoryDC()
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::WindowRemap
virtual void WindowRemap(void)
Remap the window.
vtkWin32OpenGLRenderWindow::SetCursorPosition
void SetCursorPosition(int x, int y)
Set cursor position in window (note that (0,0) is the lower left corner).
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::SetupMemoryRendering
void SetupMemoryRendering(HBITMAP hbmp)
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::SetupMemoryRendering
void SetupMemoryRendering(int x, int y, HDC prn)
These methods can be used by MFC applications to support print preview and printing,...
vtkWin32OpenGLRenderWindow::SetWindowId
virtual void SetWindowId(HWND)
Set the window id to a pre-existing window.
vtkWin32OpenGLRenderWindow::Capabilities
char * Capabilities
Definition: vtkWin32OpenGLRenderWindow.h:320
vtkOpenGLRenderWindow.h
vtkWin32OpenGLRenderWindow::ScreenMapped
int ScreenMapped
Definition: vtkWin32OpenGLRenderWindow.h:302
vtkWin32OpenGLRenderWindow::ParentId
HWND ParentId
Definition: vtkWin32OpenGLRenderWindow.h:291
vtkWin32OpenGLRenderWindow::GetGenericContext
virtual void * GetGenericContext()
Definition: vtkWin32OpenGLRenderWindow.h:138
vtkWin32OpenGLRenderWindow::CreatingOffScreenWindow
int CreatingOffScreenWindow
Definition: vtkWin32OpenGLRenderWindow.h:308
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::OldPalette
HPALETTE OldPalette
Definition: vtkWin32OpenGLRenderWindow.h:286
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.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkWin32OpenGLRenderWindow::MemoryHdc
HDC MemoryHdc
Definition: vtkWin32OpenGLRenderWindow.h:300
vtkWin32OpenGLRenderWindow::SetContextId
void SetContextId(HGLRC)
Set the window's context id.
vtkWin32OpenGLRenderWindow::ScreenContextId
HGLRC ScreenContextId
Definition: vtkWin32OpenGLRenderWindow.h:306
vtkWin32OpenGLRenderWindow::OwnWindow
int OwnWindow
Definition: vtkWin32OpenGLRenderWindow.h:293
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::SetupPixelFormat
virtual void SetupPixelFormat(HDC hDC, DWORD dwFlags, int debug, int bpp=16, int zbpp=16)
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::DeviceContext
HDC DeviceContext
Definition: vtkWin32OpenGLRenderWindow.h:288
vtkWin32OpenGLRenderWindow::New
static vtkWin32OpenGLRenderWindow * New()
vtkWin32OpenGLRenderWindow::SetPosition
virtual void SetPosition(int a[2])
Definition: vtkWin32OpenGLRenderWindow.h:102
vtkWin32OpenGLRenderWindow::CreateOffScreenDC
void CreateOffScreenDC(int xsize, int ysize, HDC aHdc)
vtkWin32OpenGLRenderWindow::CreateOffScreenWindow
void CreateOffScreenWindow(int width, int height)
vtkWin32OpenGLRenderWindow::CleanUpOffScreenRendering
void CleanUpOffScreenRendering(void)
vtkWin32OpenGLRenderWindow::MemoryDataHeader
BITMAPINFO MemoryDataHeader
Definition: vtkWin32OpenGLRenderWindow.h:297
vtkWin32OpenGLRenderWindow::SetSize
virtual void SetSize(int a[2])
Set the size of the window in screen coordinates in pixels.
Definition: vtkWin32OpenGLRenderWindow.h:91
vtkWin32OpenGLRenderWindow::SetupPalette
virtual void SetupPalette(HDC hDC)
Initialize OpenGL for this window.
vtkWin32OpenGLRenderWindow::SetParentId
void SetParentId(void *foo)
Definition: vtkWin32OpenGLRenderWindow.h:163
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::SaveScreenRendering
void SaveScreenRendering()
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::CreateOffScreenDC
void CreateOffScreenDC(HBITMAP hbmp, HDC aHdc)
vtkWin32OpenGLRenderWindow::GetMemoryData
unsigned char * GetMemoryData()
Definition: vtkWin32OpenGLRenderWindow.h:237
vtkWin32OpenGLRenderWindow::GetGenericWindowId
virtual void * GetGenericWindowId()
Definition: vtkWin32OpenGLRenderWindow.h:136
vtkWin32OpenGLRenderWindow::CursorHidden
int CursorHidden
Definition: vtkWin32OpenGLRenderWindow.h:317
vtkWin32OpenGLRenderWindow::MemoryData
unsigned char * MemoryData
Definition: vtkWin32OpenGLRenderWindow.h:299
vtkWin32OpenGLRenderWindow::CleanUpRenderers
void CleanUpRenderers()
vtkOpenGLRenderWindow
OpenGL rendering window.
Definition: vtkOpenGLRenderWindow.h:42
vtkWin32OpenGLRenderWindow::ScreenDoubleBuffer
int ScreenDoubleBuffer
Definition: vtkWin32OpenGLRenderWindow.h:305
vtkWindow::SetPosition
virtual void SetPosition(int, int)
vtkWin32OpenGLRenderWindow::GetPosition
virtual int * GetPosition()
Get the position in screen coordinates of the window.
vtkWin32OpenGLRenderWindow::SetPosition
virtual void SetPosition(int x, int y)
Set the position of the window.
vtkWin32OpenGLRenderWindow::ForceMakeCurrent
int ForceMakeCurrent
Definition: vtkWin32OpenGLRenderWindow.h:318
vtkWin32OpenGLRenderWindow::SetDisplayId
virtual void SetDisplayId(void *)
Dummy stubs for vtkWindow API.
vtkWin32OpenGLRenderWindow::MFChandledWindow
BOOL MFChandledWindow
Definition: vtkWin32OpenGLRenderWindow.h:289
vtkWin32OpenGLRenderWindow::ScreenDeviceContext
HDC ScreenDeviceContext
Definition: vtkWin32OpenGLRenderWindow.h:304
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.
vtkOpenGLRenderWindow::SetSize
virtual void SetSize(int a[2])
Set the size of the window in screen coordinates in pixels.