vtkCocoaRenderWindow Class Reference

#include <vtkCocoaRenderWindow.h>

Inheritance diagram for vtkCocoaRenderWindow:

[legend]Collaboration diagram for vtkCocoaRenderWindow:

[legend]List of all members.

Detailed Description

Cocoa OpenGL rendering window.

vtkCocoaRenderWindow is a concrete implementation of the abstract class vtkOpenGLRenderWindow. vtkCocoaRenderWindow interfaces to the OpenGL graphics library using the Cocoa API on Mac OSX. It interacts with the OSX Window manager to display a window and create its vtkCocoaGLView. These were separated to allow applications to do their own window management and just use vtkCocoaGLView themselves.

Created by:

Starreveld, Yves

CVS contributions (if > 5%):

Starreveld, Yves (59%)
Malaterre, Mathieu (19%)
Cedilnik, Andy (12%)

CVS logs (CVSweb):

.h (/Rendering/vtkCocoaRenderWindow.h)
.mm (/Rendering/vtkCocoaRenderWindow.mm)

Definition at line 44 of file vtkCocoaRenderWindow.h.

Public Types

typedef vtkOpenGLRenderWindow Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

virtual void Start ()

virtual void Frame ()

virtual void WindowConfigure ()

virtual void WindowInitialize ()

virtual void Initialize ()

virtual void SetFullScreen (int)

virtual void WindowRemap ()

virtual void PrefFullScreen ()

virtual int * GetSize ()

virtual int * GetScreenSize ()

virtual int * GetPosition ()

virtual void SetWindowName (const char *)

virtual void SetWindowInfo (void *)

void SetNextWindowInfo (char *)

virtual void * GetGenericDisplayId ()

virtual void * GetGenericWindowId ()

virtual void * GetGenericContext ()

virtual void SetDisplayId (void *)

virtual void SetParentId (void *)

virtual void * GetGenericParentId ()

virtual void * GetGenericDrawable ()

virtual void SetWindowInfo (char *)

virtual void SetParentInfo (char *)

virtual void * GetWindowId ()

virtual void SetWindowId (void *)

void SetNextWindowId (void *)

void SetContextId (void *)

void SetDeviceContext (void *)

virtual void SetMultiSamples (int)

virtual int GetMultiSamples ()

virtual void StereoUpdate ()

virtual void SetStereoCapableWindow (int capable)

virtual void MakeCurrent ()

const char * ReportCapabilities ()

int SupportsOpenGL ()

int IsDirect ()

virtual void SetForceMakeCurrent ()

virtual int GetEventPending ()

void Clean ()

void RegisterTextureResource (GLuint id)

int GetDepthBufferSize ()

void UpdateSizeAndPosition (int xPos, int yPos, int xSize, int ySize)

virtual void SetSize (int *)

virtual void SetSize (int, int)

virtual void SetPosition (int *)

virtual void SetPosition (int, int)

virtual void SetupPalette (void *hDC)

virtual void SetupPixelFormat (void *hDC, void *dwFlags, int debug, int bpp=16, int zbpp=16)

virtual void HideCursor ()

virtual void ShowCursor ()

Static Public Member Functions

vtkCocoaRenderWindow * New ()

int IsTypeOf (const char *type)

vtkCocoaRenderWindow * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkCocoaRenderWindow ()

~vtkCocoaRenderWindow ()

Protected Attributes

int ApplicationInitialized

void * AutoreleasePool

void * ContextId

void * DeviceContext

void * WindowId

void * WindowController

int OwnWindow

int ScreenSize [2]

int MultiSamples

int ScreenMapped

int ScreenWindowSize [2]

void * ScreenDeviceContext

int ScreenDoubleBuffer

void * ScreenContextId

int CursorHidden

int ForceMakeCurrent

char * Capabilities

Member Typedef Documentation

typedef vtkOpenGLRenderWindow vtkCocoaRenderWindow::Superclass

Reimplemented from vtkOpenGLRenderWindow.
Definition at line 48 of file vtkCocoaRenderWindow.h.

Constructor & Destructor Documentation

vtkCocoaRenderWindow::vtkCocoaRenderWindow ( ) [protected]

vtkCocoaRenderWindow::~vtkCocoaRenderWindow ( ) [protected]

Member Function Documentation

vtkCocoaRenderWindow* vtkCocoaRenderWindow::New ( ) [static]

Construct an instance of vtkRenderWindow with its screen size set to 300x300, borders turned on, positioned at (0,0), double buffering turned on.
Reimplemented from vtkRenderWindow.

virtual const char* vtkCocoaRenderWindow::GetClassName ( ) [virtual]

Reimplemented from vtkOpenGLRenderWindow.

int vtkCocoaRenderWindow::IsTypeOf ( const char * type ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkOpenGLRenderWindow.

virtual int vtkCocoaRenderWindow::IsA ( const char * type ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkOpenGLRenderWindow.

vtkCocoaRenderWindow* vtkCocoaRenderWindow::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkOpenGLRenderWindow.

void vtkCocoaRenderWindow::PrintSelf ( ostream & os,

vtkIndent indent

) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkOpenGLRenderWindow.

virtual void vtkCocoaRenderWindow::Start ( ) [virtual]

Begin the rendering process.
Implements vtkRenderWindow.

virtual void vtkCocoaRenderWindow::Frame ( ) [virtual]

End the rendering process and display the image.
Implements vtkRenderWindow.

virtual void vtkCocoaRenderWindow::WindowConfigure ( ) [virtual]

Specify various window parameters.

virtual void vtkCocoaRenderWindow::WindowInitialize ( ) [virtual]

Initialize the window for rendering.

virtual void vtkCocoaRenderWindow::Initialize ( ) [virtual]

Initialize the rendering window.

virtual void vtkCocoaRenderWindow::SetFullScreen ( int ) [virtual]

Change the window to fill the entire screen.
Implements vtkRenderWindow.

virtual void vtkCocoaRenderWindow::WindowRemap ( ) [virtual]

Remap the window.
Implements vtkRenderWindow.

virtual void vtkCocoaRenderWindow::PrefFullScreen ( ) [virtual]

Set the preferred window size to full screen.

virtual void vtkCocoaRenderWindow::SetSize ( int * ) [virtual]

Set the size of the window.

virtual void vtkCocoaRenderWindow::SetSize ( int ,

int

) [virtual]

Set the size of the window.
Reimplemented from vtkWindow.

virtual int* vtkCocoaRenderWindow::GetSize ( ) [virtual]

Get the current size of the window.
Reimplemented from vtkWindow.

virtual void vtkCocoaRenderWindow::SetPosition ( int * ) [virtual]

Set the position of the window.

virtual void vtkCocoaRenderWindow::SetPosition ( int ,

int

) [virtual]

Set the position of the window.
Reimplemented from vtkWindow.

virtual int* vtkCocoaRenderWindow::GetScreenSize ( ) [virtual]

Return the scrren size.
Implements vtkWindow.

virtual int* vtkCocoaRenderWindow::GetPosition ( ) [virtual]

Get the position in screen coordinates of the window.
Reimplemented from vtkWindow.

virtual void vtkCocoaRenderWindow::SetWindowName ( const char * ) [virtual]

Set the name of the window. This appears at the top of the window normally.
Reimplemented from vtkWindow.

virtual void vtkCocoaRenderWindow::SetWindowInfo ( void * ) [virtual]

Set this RenderWindow's window id to a pre-existing window.

void vtkCocoaRenderWindow::SetNextWindowInfo ( char * ) [inline, virtual]

Dummy stubs for vtkWindow API.
Implements vtkRenderWindow.
Definition at line 103 of file vtkCocoaRenderWindow.h.

virtual void* vtkCocoaRenderWindow::GetGenericDisplayId ( ) [inline, virtual]

Dummy stubs for vtkWindow API.
Implements vtkRenderWindow.
Definition at line 110 of file vtkCocoaRenderWindow.h.

virtual void* vtkCocoaRenderWindow::GetGenericWindowId ( ) [inline, virtual]

Dummy stubs for vtkWindow API.
Implements vtkRenderWindow.
Definition at line 111 of file vtkCocoaRenderWindow.h.

virtual void* vtkCocoaRenderWindow::GetGenericContext ( ) [inline, virtual]

Dummy stubs for vtkWindow API.
Implements vtkRenderWindow.
Definition at line 112 of file vtkCocoaRenderWindow.h.

virtual void vtkCocoaRenderWindow::SetDisplayId ( void * ) [inline, virtual]

Dummy stubs for vtkWindow API.
Implements vtkRenderWindow.
Definition at line 113 of file vtkCocoaRenderWindow.h.

virtual void vtkCocoaRenderWindow::SetParentId ( void * ) [inline, virtual]

Dummy stubs for vtkWindow API.
Implements vtkRenderWindow.
Definition at line 114 of file vtkCocoaRenderWindow.h.

virtual void* vtkCocoaRenderWindow::GetGenericParentId ( ) [inline, virtual]

Dummy stubs for vtkWindow API.
Implements vtkRenderWindow.
Definition at line 118 of file vtkCocoaRenderWindow.h.

virtual void* vtkCocoaRenderWindow::GetGenericDrawable ( ) [inline, virtual]

Dummy stubs for vtkWindow API.
Implements vtkRenderWindow.
Definition at line 123 of file vtkCocoaRenderWindow.h.

virtual void vtkCocoaRenderWindow::SetWindowInfo ( char * ) [inline, virtual]

Dummy stubs for vtkWindow API.
Implements vtkRenderWindow.
Definition at line 128 of file vtkCocoaRenderWindow.h.

virtual void vtkCocoaRenderWindow::SetParentInfo ( char * ) [inline, virtual]

Dummy stubs for vtkWindow API.
Implements vtkRenderWindow.
Definition at line 132 of file vtkCocoaRenderWindow.h.

virtual void* vtkCocoaRenderWindow::GetWindowId ( ) [virtual]

Get the window id.

virtual void vtkCocoaRenderWindow::SetWindowId ( void * ) [virtual]

Set the window id to a pre-existing window.
Implements vtkRenderWindow.

void vtkCocoaRenderWindow::SetNextWindowId ( void * ) [inline, virtual]

Dummy stubs for vtkWindow API.
Implements vtkRenderWindow.
Definition at line 143 of file vtkCocoaRenderWindow.h.

void vtkCocoaRenderWindow::SetContextId ( void * )

void vtkCocoaRenderWindow::SetDeviceContext ( void * )

virtual void vtkCocoaRenderWindow::SetMultiSamples ( int ) [virtual]

Set / Get the number of multisamples to use for hardware antialiasing.
Reimplemented from vtkOpenGLRenderWindow.

virtual int vtkCocoaRenderWindow::GetMultiSamples ( ) [virtual]

Set / Get the number of multisamples to use for hardware antialiasing.
Reimplemented from vtkOpenGLRenderWindow.

virtual void vtkCocoaRenderWindow::StereoUpdate ( ) [virtual]

Update system if needed due to stereo rendering.
Reimplemented from vtkOpenGLRenderWindow.

virtual void vtkCocoaRenderWindow::SetStereoCapableWindow ( int capable ) [virtual]

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.
Reimplemented from vtkRenderWindow.

virtual void vtkCocoaRenderWindow::MakeCurrent ( ) [virtual]

Make this windows OpenGL context the current context.
Implements vtkOpenGLRenderWindow.

const char* vtkCocoaRenderWindow::ReportCapabilities ( ) [virtual]

Get report of capabilities for the render window
Reimplemented from vtkRenderWindow.

int vtkCocoaRenderWindow::SupportsOpenGL ( ) [virtual]

Does this render window support OpenGL? 0-false, 1-true
Reimplemented from vtkRenderWindow.

int vtkCocoaRenderWindow::IsDirect ( ) [virtual]

Is this render window using hardware acceleration? 0-false, 1-true
Reimplemented from vtkRenderWindow.

virtual void vtkCocoaRenderWindow::SetForceMakeCurrent ( ) [virtual]

If called, allow MakeCurrent() to skip cache-check when called. MakeCurrent() reverts to original behavior of cache-checking on the next render.
Reimplemented from vtkRenderWindow.

virtual int vtkCocoaRenderWindow::GetEventPending ( ) [virtual]

Check to see if an event is pending for this window. This is a useful check to abort a long render.
Implements vtkRenderWindow.

virtual void vtkCocoaRenderWindow::SetupPalette ( void * hDC ) [virtual]

Initialize OpenGL for this window.

virtual void vtkCocoaRenderWindow::SetupPixelFormat ( void * hDC,

void * dwFlags,

int debug,

int bpp = 16,

int zbpp = 16

) [virtual]

Initialize OpenGL for this window.

void vtkCocoaRenderWindow::Clean ( )

Clean up device contexts, rendering contexts, etc.

void vtkCocoaRenderWindow::RegisterTextureResource ( GLuint id )

Register a texture name with this render window
Reimplemented from vtkOpenGLRenderWindow.

int vtkCocoaRenderWindow::GetDepthBufferSize ( ) [virtual]

Get the size of the depth buffer.
Reimplemented from vtkOpenGLRenderWindow.

virtual void vtkCocoaRenderWindow::HideCursor ( ) [virtual]

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.
Implements vtkRenderWindow.

virtual void vtkCocoaRenderWindow::ShowCursor ( ) [virtual]

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.
Implements vtkRenderWindow.

void vtkCocoaRenderWindow::UpdateSizeAndPosition ( int xPos,

int yPos,

int xSize,

int ySize

)

Member Data Documentation

int vtkCocoaRenderWindow::ApplicationInitialized [protected]

Definition at line 222 of file vtkCocoaRenderWindow.h.

void* vtkCocoaRenderWindow::AutoreleasePool [protected]

Definition at line 223 of file vtkCocoaRenderWindow.h.

void* vtkCocoaRenderWindow::ContextId [protected]

Definition at line 224 of file vtkCocoaRenderWindow.h.

void* vtkCocoaRenderWindow::DeviceContext [protected]

Definition at line 225 of file vtkCocoaRenderWindow.h.

void* vtkCocoaRenderWindow::WindowId [protected]

Definition at line 226 of file vtkCocoaRenderWindow.h.

void* vtkCocoaRenderWindow::WindowController [protected]

Definition at line 227 of file vtkCocoaRenderWindow.h.

int vtkCocoaRenderWindow::OwnWindow [protected]

Definition at line 228 of file vtkCocoaRenderWindow.h.

int vtkCocoaRenderWindow::ScreenSize[2] [protected]

Definition at line 229 of file vtkCocoaRenderWindow.h.

int vtkCocoaRenderWindow::MultiSamples [protected]

Reimplemented from vtkOpenGLRenderWindow.
Definition at line 230 of file vtkCocoaRenderWindow.h.

int vtkCocoaRenderWindow::ScreenMapped [protected]

Definition at line 238 of file vtkCocoaRenderWindow.h.

int vtkCocoaRenderWindow::ScreenWindowSize[2] [protected]

Definition at line 239 of file vtkCocoaRenderWindow.h.

void* vtkCocoaRenderWindow::ScreenDeviceContext [protected]

Definition at line 240 of file vtkCocoaRenderWindow.h.

int vtkCocoaRenderWindow::ScreenDoubleBuffer [protected]

Definition at line 241 of file vtkCocoaRenderWindow.h.

void* vtkCocoaRenderWindow::ScreenContextId [protected]

Definition at line 242 of file vtkCocoaRenderWindow.h.

int vtkCocoaRenderWindow::CursorHidden [protected]

Definition at line 244 of file vtkCocoaRenderWindow.h.

int vtkCocoaRenderWindow::ForceMakeCurrent [protected]

Definition at line 245 of file vtkCocoaRenderWindow.h.

char* vtkCocoaRenderWindow::Capabilities [protected]

Definition at line 247 of file vtkCocoaRenderWindow.h.

The documentation for this class was generated from the following file:

dox/Rendering/vtkCocoaRenderWindow.h


Public Types
typedef vtkOpenGLRenderWindow	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Start ()
virtual void	Frame ()
virtual void	WindowConfigure ()
virtual void	WindowInitialize ()
virtual void	Initialize ()
virtual void	SetFullScreen (int)
virtual void	WindowRemap ()
virtual void	PrefFullScreen ()
virtual int *	GetSize ()
virtual int *	GetScreenSize ()
virtual int *	GetPosition ()
virtual void	SetWindowName (const char *)
virtual void	SetWindowInfo (void *)
void	SetNextWindowInfo (char *)
virtual void *	GetGenericDisplayId ()
virtual void *	GetGenericWindowId ()
virtual void *	GetGenericContext ()
virtual void	SetDisplayId (void *)
virtual void	SetParentId (void *)
virtual void *	GetGenericParentId ()
virtual void *	GetGenericDrawable ()
virtual void	SetWindowInfo (char *)
virtual void	SetParentInfo (char *)
virtual void *	GetWindowId ()
virtual void	SetWindowId (void *)
void	SetNextWindowId (void *)
void	SetContextId (void *)
void	SetDeviceContext (void *)
virtual void	SetMultiSamples (int)
virtual int	GetMultiSamples ()
virtual void	StereoUpdate ()
virtual void	SetStereoCapableWindow (int capable)
virtual void	MakeCurrent ()
const char *	ReportCapabilities ()
int	SupportsOpenGL ()
int	IsDirect ()
virtual void	SetForceMakeCurrent ()
virtual int	GetEventPending ()
void	Clean ()
void	RegisterTextureResource (GLuint id)
int	GetDepthBufferSize ()
void	UpdateSizeAndPosition (int xPos, int yPos, int xSize, int ySize)

virtual void	SetSize (int *)
virtual void	SetSize (int, int)

virtual void	SetPosition (int *)
virtual void	SetPosition (int, int)

virtual void	SetupPalette (void *hDC)
virtual void	SetupPixelFormat (void hDC, void dwFlags, int debug, int bpp=16, int zbpp=16)

virtual void	HideCursor ()
virtual void	ShowCursor ()
Static Public Member Functions
vtkCocoaRenderWindow *	New ()
int	IsTypeOf (const char *type)
vtkCocoaRenderWindow *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkCocoaRenderWindow ()
	~vtkCocoaRenderWindow ()
Protected Attributes
int	ApplicationInitialized
void *	AutoreleasePool
void *	ContextId
void *	DeviceContext
void *	WindowId
void *	WindowController
int	OwnWindow
int	ScreenSize [2]
int	MultiSamples
int	ScreenMapped
int	ScreenWindowSize [2]
void *	ScreenDeviceContext
int	ScreenDoubleBuffer
void *	ScreenContextId
int	CursorHidden
int	ForceMakeCurrent
char *	Capabilities