forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 3
/
vtkCocoaRenderWindow.h
338 lines (274 loc) · 11 KB
/
vtkCocoaRenderWindow.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
/*=========================================================================
Program: Visualization Toolkit
Module: vtkCocoaRenderWindow.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkCocoaRenderWindow - Cocoa OpenGL rendering window
//
// .SECTION Description
// vtkCocoaRenderWindow is a concrete implementation of the abstract
// class vtkOpenGLRenderWindow. It is only available on Mac OS X 10.3
// and later.
// To use this class, build VTK with VTK_USE_COCOA turned ON.
// This class can be used by 32 and 64 bit processes, and either in
// garbage collected or reference counted modes.
// vtkCocoaRenderWindow uses Objective-C++, and the OpenGL and
// Cocoa APIs. This class's default behaviour is to create an NSWindow and
// a vtkCocoaGLView which are used together to draw all vtk stuff into.
// If you already have an NSWindow and vtkCocoaGLView and you want this
// class to use them you must call both SetRootWindow() and SetWindowId(),
// respectively, early on (before WindowInitialize() is executed).
//
// .SECTION See Also
// vtkOpenGLRenderWindow vtkCocoaGLView
// .SECTION Warning
// This header must be in C++ only because it is included by .cxx files.
// That means no Objective-C may be used. That's why some instance variables
// are void* instead of what they really should be.
#ifndef __vtkCocoaRenderWindow_h
#define __vtkCocoaRenderWindow_h
#include "vtkOpenGLRenderWindow.h"
class VTK_RENDERING_EXPORT vtkCocoaRenderWindow : public vtkOpenGLRenderWindow
{
public:
static vtkCocoaRenderWindow *New();
vtkTypeMacro(vtkCocoaRenderWindow,vtkOpenGLRenderWindow);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Begin the rendering process.
virtual void Start();
// Description:
// Finish the rendering process.
virtual void Frame();
// Description:
// Specify various window parameters.
virtual void WindowConfigure();
// Description:
// Initialize the window for rendering.
// virtual void WindowInitialize();
// Description:
// Initialize the rendering window.
virtual void Initialize();
// Description:
// Change the window to fill the entire screen.
virtual void SetFullScreen(int);
// Description:
// Remap the window.
virtual void WindowRemap();
// Description:
// Set the preferred window size to full screen.
virtual void PrefFullScreen();
// Description:
// Set the size of the window in pixels.
virtual void SetSize(int*);
virtual void SetSize(int,int);
// Description:
// Get the current size of the window in pixels.
virtual int *GetSize();
// Description:
// Set the position of the window.
virtual void SetPosition(int*);
virtual void SetPosition(int,int);
// Description:
// Get the current size of the screen in pixels.
virtual int *GetScreenSize();
// Description:
// Get the position in screen coordinates of the window.
virtual int *GetPosition();
// Description:
// Set the name of the window. This appears at the top of the window
// normally.
virtual void SetWindowName(const char *);
void SetNextWindowInfo(char *)
{
vtkWarningMacro("SetNextWindowInfo not implemented (WindowRemap not implemented).");
}
virtual void* GetGenericDrawable()
{
vtkWarningMacro("Method not implemented.");
return 0;
}
virtual void SetDisplayId(void*)
{
vtkWarningMacro("Method not implemented.");
}
virtual void *GetGenericDisplayId()
{
vtkWarningMacro("Method not implemented.");
return 0;
}
// Description:
// Set this RenderWindow's window id to a pre-existing window.
// The paramater is an ASCII string of a decimal number representing
// a pointer to the window.
virtual void SetWindowInfo(char*);
// Description:
// See the documenation for SetParentId(). This method allows the ParentId
// to be set as an ASCII string of a decimal number that is the memory
// address of the parent NSView.
virtual void SetParentInfo(char*);
void SetNextWindowId(void*)
{
vtkWarningMacro("SetNextWindowId not implemented (WindowRemap not implemented).");
}
// Description:
// Update system if needed due to stereo rendering.
virtual void StereoUpdate();
// Description:
// Prescribe that the window be created in a stereo-capable mode. This
// method must be called before the window is realized. This method
// overrrides the superclass method since this class can actually check
// whether the window has been realized yet.
virtual void SetStereoCapableWindow(int capable);
// Description:
// Make this windows OpenGL context the current context.
virtual void MakeCurrent();
// Description:
// Tells if this window is the current OpenGL context for the calling thread.
virtual bool IsCurrent();
// Description:
// Update this window's OpenGL context, e.g. when the window is resized.
void UpdateContext();
// Description:
// Get report of capabilities for the render window
const char *ReportCapabilities();
// Description:
// Does this render window support OpenGL? 0-false, 1-true
int SupportsOpenGL();
// Description:
// Is this render window using hardware acceleration? 0-false, 1-true
int IsDirect();
// Description:
// If called, allow MakeCurrent() to skip cache-check when called.
// MakeCurrent() reverts to original behavior of cache-checking
// on the next render.
virtual void SetForceMakeCurrent();
// Description:
// Check to see if an event is pending for this window.
// This is a useful check to abort a long render.
virtual int GetEventPending();
// Description:
// Initialize OpenGL for this window.
virtual void SetupPalette(void *hDC);
virtual void SetupPixelFormat(void *hDC, void *dwFlags, int debug,
int bpp=16, int zbpp=16);
// Description:
// Clean up device contexts, rendering contexts, etc.
void Finalize();
// Description:
// Register a texture name with this render window
void RegisterTextureResource (GLuint id);
// Description:
// Get the size of the depth buffer.
int GetDepthBufferSize();
// Description:
// Hide or Show the mouse cursor, it is nice to be able to hide the
// default cursor if you want VTK to display a 3D cursor instead.
// Set cursor position in window (note that (0,0) is the lower left
// corner).
virtual void HideCursor();
virtual void ShowCursor();
virtual void SetCursorPosition(int x, int y);
// Description:
// Change the shape of the cursor.
virtual void SetCurrentCursor(int);
// Description:
// Get the WindowCreated flag. It is 1 if this object created an instance
// of NSWindow, 0 otherwise.
virtual int GetWindowCreated();
// Description:
// Accessors for the OpenGL context (Really an NSOpenGLContext*).
void SetContextId(void *);
void *GetContextId();
virtual void *GetGenericContext() {return this->GetContextId();}
// Description:
// Sets the NSWindow* associated with this vtkRenderWindow.
// This class' default behaviour, that is, if you never call
// SetWindowId()/SetRootWindow() is to create an NSWindow and a
// vtkCocoaGLView (NSView subclass) which are used together to draw
// all vtk stuff into. If you already have an NSWindow and NSView and
// you want this class to use them you must call both SetRootWindow()
// and SetWindowId(), respectively, early on (before WindowInitialize()
// is executed). In the case of Java, you should call only SetWindowId().
virtual void SetRootWindow(void *);
// Description:
// Returns the NSWindow* associated with this vtkRenderWindow.
virtual void *GetRootWindow();
// Description:
// Sets the NSView* associated with this vtkRenderWindow.
// This class' default behaviour, that is, if you never call this
// SetWindowId()/SetRootWindow() is to create an NSWindow and a
// vtkCocoaGLView (NSView subclass) which are used together to draw all
// vtk stuff into. If you already have an NSWindow and NSView and you
// want this class to use them you must call both SetRootWindow()
// and SetWindowId(), respectively, early on (before WindowInitialize()
// is executed). In the case of Java, you should call only SetWindowId().
virtual void SetWindowId(void *);
// Description:
// Returns the NSView* associated with this vtkRenderWindow.
virtual void *GetWindowId();
virtual void *GetGenericWindowId() {return this->GetWindowId();}
// Description:
// Set the NSView* for the vtkRenderWindow to be parented within. The
// Position and Size of the RenderWindow will set the rectangle of the
// NSView that the vtkRenderWindow will create within this parent.
// If you set the WindowId, then this ParentId will be ignored.
virtual void SetParentId(void *nsview);
// Description:
// Get the parent NSView* for this vtkRenderWindow. This method will
// return "NULL" if the parent was not set with SetParentId() or
// SetParentInfo().
virtual void *GetParentId();
virtual void *GetGenericParentId() { return this->GetParentId(); }
// Description:
// Returns the scaling factor for 'resolution independence', to convert
// between points and pixels.
vtkGetMacro(ScaleFactor, double);
// Description:
// Accessors for the pixel format object (Really an NSOpenGLPixelFormat*).
void SetPixelFormat(void *pixelFormat);
void *GetPixelFormat();
protected:
vtkCocoaRenderWindow();
~vtkCocoaRenderWindow();
void CreateGLContext();
void CreateAWindow();
void DestroyWindow();
void DestroyOffScreenWindow();
int OffScreenInitialized;
int OnScreenInitialized;
// Using CGFloat would be better, but doing it this way avoids pulling in
// Apple headers, which cause problems with the 10.3 SDK and python wrappings.
#if defined(__LP64__) && __LP64__
double ScaleFactor;
#else
float ScaleFactor;
#endif
// Description:
// Accessors for the cocoa manager (Really an NSMutableDictionary*).
// It manages all Cocoa objects in this C++ class.
void SetCocoaManager(void *manager);
void *GetCocoaManager();
private:
vtkCocoaRenderWindow(const vtkCocoaRenderWindow&); // Not implemented.
void operator=(const vtkCocoaRenderWindow&); // Not implemented.
private:
// Important: this class cannot contain Objective-C instance
// variables for 2 reasons:
// 1) C++ files include this header
// 2) because of garbage collection (the GC scanner does not scan objects create by C++'s new)
// Instead, use the CocoaManager dictionary to keep a collection
// of what would otherwise be Objective-C instance variables.
void *CocoaManager; // Really an NSMutableDictionary*
int WindowCreated;
int ViewCreated;
int CursorHidden;
int ForceMakeCurrent;
char *Capabilities;
};
#endif