vtkCarbonRenderWindow Class Reference

#include <vtkCarbonRenderWindow.h>

Inheritance diagram for vtkCarbonRenderWindow:

[legend]Collaboration diagram for vtkCarbonRenderWindow:

[legend]List of all members.

---

Detailed Description

Carbon OpenGL rendering window.

vtkCarbonRenderWindow is a concrete implementation of the abstract class vtkOpenGLRenderWindow. vtkCarbonRenderWindow interfaces to the OpenGL graphics library using the Carbon API on Mac OSX.

Definition at line 32 of file vtkCarbonRenderWindow.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)
void	Start ()
void	Frame ()
virtual void	WindowConfigure ()
virtual void	WindowInitialize ()
virtual void	Initialize ()
virtual void	Finalize ()
virtual void	SetFullScreen (int)
virtual void	WindowRemap ()
virtual int *	GetScreenSize ()
virtual int *	GetPosition ()
virtual void	SetWindowName (const char *)
void	SetWindowInfo (char *)
void	SetNextWindowInfo (char *)
virtual void *	GetGenericDisplayId ()
virtual void *	GetGenericWindowId ()
virtual void *	GetGenericParentId ()
virtual AGLContext	GetContextId ()
virtual void *	GetGenericContext ()
virtual void	SetDisplayId (void *)
virtual void *	GetGenericDrawable ()
virtual void	SetMultiSamples (int)
virtual int	GetMultiSamples ()
virtual void	SetStereoCapableWindow (int capable)
void	MakeCurrent ()
void	SetForceMakeCurrent ()
void	Clean ()
void	UpdateSizeAndPosition (int xPos, int yPos, int xSize, int ySize)
void	UpdateGLRegion ()
virtual void	PrefFullScreen ()
virtual void	SetSize (int a[2])
virtual void	SetSize (int, int)
virtual int *	GetSize ()
virtual void	SetPosition (int *)
virtual void	SetPosition (int, int)
void	SetParentInfo (char *)
virtual HIViewRef	GetWindowId ()
void	SetWindowId (void *foo)
void	SetNextWindowId (void *)
virtual void	SetParentId (HIViewRef)
void	SetParentId (void *foo)
virtual void	SetWindowId (HIViewRef)
void	SetRootWindow (WindowPtr win)
WindowPtr	GetRootWindow ()
virtual int	GetEventPending ()
virtual void	SetupPalette (void *hDC)
virtual void	SetupPixelFormat (void *hDC, void *dwFlags, int debug, int bpp=16, int zbpp=16)
int	GetDepthBufferSize ()
void	HideCursor ()
void	ShowCursor ()
Static Public Member Functions
static vtkCarbonRenderWindow *	New ()
static int	IsTypeOf (const char *type)
static vtkCarbonRenderWindow *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkCarbonRenderWindow ()
	~vtkCarbonRenderWindow ()
void	CreateAWindow (int x, int y, int width, int height)
void	InitializeApplication ()
Static Protected Member Functions
static OSStatus	RegionEventProcessor (EventHandlerCallRef er, EventRef event, void *)
Protected Attributes
int	ApplicationInitialized
Boolean	fAcceleratedMust
Boolean	draggable
GLint	aglAttributes [64]
SInt32	VRAM
SInt32	textureRAM
AGLPixelFormat	fmt
AGLContext	ContextId
HIViewRef	WindowId
HIViewRef	ParentId
WindowPtr	RootWindow
int	OwnWindow
int	ScreenSize [2]
int	CursorHidden
int	ForceMakeCurrent
EventHandlerUPP	RegionEventHandlerUPP
EventHandlerRef	RegionEventHandler

---

Member Typedef Documentation

typedef vtkOpenGLRenderWindow vtkCarbonRenderWindow::Superclass

Reimplemented from vtkOpenGLRenderWindow. Definition at line 36 of file vtkCarbonRenderWindow.h.

---

Constructor & Destructor Documentation

vtkCarbonRenderWindow::vtkCarbonRenderWindow (   )  [protected]

vtkCarbonRenderWindow::~vtkCarbonRenderWindow (   )  [protected]

---

Member Function Documentation

static vtkCarbonRenderWindow* vtkCarbonRenderWindow::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* vtkCarbonRenderWindow::GetClassName (   )  [virtual]

Reimplemented from vtkOpenGLRenderWindow.

static int vtkCarbonRenderWindow::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 vtkCarbonRenderWindow::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.

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

Reimplemented from vtkOpenGLRenderWindow.

void vtkCarbonRenderWindow::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.

void vtkCarbonRenderWindow::Start (   )  [virtual]

Begin the rendering process. Implements vtkRenderWindow.

void vtkCarbonRenderWindow::Frame (   )  [virtual]

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

virtual void vtkCarbonRenderWindow::WindowConfigure (   )  [virtual]

Specify various window parameters.

virtual void vtkCarbonRenderWindow::WindowInitialize (   )  [virtual]

Create the window.

virtual void vtkCarbonRenderWindow::Initialize (   )  [virtual]

Initialize the rendering window. This will setup all system-specific resources. This method and Finalize() must be symmetric and it should be possible to call them multiple times, even changing WindowId in-between. This is what WindowRemap does.

virtual void vtkCarbonRenderWindow::Finalize (   )  [virtual]

Finalize the rendering window. This will shutdown all system-specifc resources. After having called this, it should be possible to destroy a window that was used for a SetWindowId() call without any ill effects. Implements vtkRenderWindow.

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

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

virtual void vtkCarbonRenderWindow::WindowRemap (   )  [virtual]

Remap the window. Implements vtkRenderWindow.

virtual void vtkCarbonRenderWindow::PrefFullScreen (   )  [virtual]

Set the preferred window size to full screen.

virtual void vtkCarbonRenderWindow::SetSize (  int  a[2]  )  [virtual]

Set the size of the window. Reimplemented from vtkWindow.

virtual void vtkCarbonRenderWindow::SetSize (  int  , int  )  [virtual]

Set the preferred window size to full screen. Reimplemented from vtkWindow.

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

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

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

Set the position of the window.

virtual void vtkCarbonRenderWindow::SetPosition (  int  , int  )  [virtual]

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

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

Return the scrren size. Implements vtkWindow.

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

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

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

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

void vtkCarbonRenderWindow::SetWindowInfo (  char *   )  [virtual]

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

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

This Method detects loops of RenderWindow<->Interactor, so objects are freed properly. Implements vtkRenderWindow. Definition at line 100 of file vtkCarbonRenderWindow.h.

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

This Method detects loops of RenderWindow<->Interactor, so objects are freed properly. Implements vtkRenderWindow. Definition at line 106 of file vtkCarbonRenderWindow.h.

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

This Method detects loops of RenderWindow<->Interactor, so objects are freed properly. Implements vtkRenderWindow. Definition at line 107 of file vtkCarbonRenderWindow.h.

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

This Method detects loops of RenderWindow<->Interactor, so objects are freed properly. Implements vtkRenderWindow. Definition at line 108 of file vtkCarbonRenderWindow.h.

virtual AGLContext vtkCarbonRenderWindow::GetContextId (   )  [inline, virtual]

Definition at line 109 of file vtkCarbonRenderWindow.h.

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

This Method detects loops of RenderWindow<->Interactor, so objects are freed properly. Implements vtkRenderWindow. Definition at line 110 of file vtkCarbonRenderWindow.h.

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

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

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

This Method detects loops of RenderWindow<->Interactor, so objects are freed properly. Implements vtkRenderWindow. Definition at line 113 of file vtkCarbonRenderWindow.h.

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

This Method detects loops of RenderWindow<->Interactor, so objects are freed properly. Implements vtkRenderWindow. Definition at line 119 of file vtkCarbonRenderWindow.h.

virtual HIViewRef vtkCarbonRenderWindow::GetWindowId (   )  [virtual]

Get the HIView window pointer.

void vtkCarbonRenderWindow::SetWindowId (  void *  foo  )  [inline, virtual]

This Method detects loops of RenderWindow<->Interactor, so objects are freed properly. Implements vtkRenderWindow. Definition at line 128 of file vtkCarbonRenderWindow.h. References vtkRenderWindow::SetWindowId().

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

This Method detects loops of RenderWindow<->Interactor, so objects are freed properly. Implements vtkRenderWindow. Definition at line 129 of file vtkCarbonRenderWindow.h.

virtual void vtkCarbonRenderWindow::SetParentId (  HIViewRef   )  [virtual]

Set the parent HIView.

void vtkCarbonRenderWindow::SetParentId (  void *  foo  )  [inline, virtual]

Set the parent HIView. Implements vtkRenderWindow. Definition at line 138 of file vtkCarbonRenderWindow.h. References vtkRenderWindow::SetParentId().

virtual void vtkCarbonRenderWindow::SetWindowId (  HIViewRef   )  [virtual]

Set the HIVIew pointer to a pre-existing window.

void vtkCarbonRenderWindow::SetRootWindow (  WindowPtr  win  )

Set the root window id. Use this when using non-HIView GUIs.

WindowPtr vtkCarbonRenderWindow::GetRootWindow (   )

Set the HIVIew pointer to a pre-existing window.

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

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

virtual int vtkCarbonRenderWindow::GetMultiSamples (   )  [virtual]

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

virtual void vtkCarbonRenderWindow::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.

void vtkCarbonRenderWindow::MakeCurrent (   )  [virtual]

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

void vtkCarbonRenderWindow::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 vtkCarbonRenderWindow::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 vtkCarbonRenderWindow::SetupPalette (  void *  hDC  )  [virtual]

Initialize OpenGL for this window.

virtual void vtkCarbonRenderWindow::SetupPixelFormat (  void *  hDC, void *  dwFlags, int  debug, int  bpp = 16, int  zbpp = 16 )  [virtual]

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

void vtkCarbonRenderWindow::Clean (   )

Clean up device contexts, rendering contexts, etc.

int vtkCarbonRenderWindow::GetDepthBufferSize (   )  [virtual]

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

void vtkCarbonRenderWindow::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.

void vtkCarbonRenderWindow::ShowCursor (   )  [virtual]

Get the size of the depth buffer. Implements vtkRenderWindow.

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

void vtkCarbonRenderWindow::UpdateGLRegion (   )

Fix the GL region. The AGL_BUFFER_RECT and AGL_CLIP_REGION will be updated

static OSStatus vtkCarbonRenderWindow::RegionEventProcessor (  EventHandlerCallRef  er, EventRef  event, void *  )  [static, protected]

void vtkCarbonRenderWindow::CreateAWindow (  int  x, int  y, int  width, int  height )  [protected]

void vtkCarbonRenderWindow::InitializeApplication (   )  [protected]

---

Member Data Documentation

int vtkCarbonRenderWindow::ApplicationInitialized [protected]

Definition at line 205 of file vtkCarbonRenderWindow.h.

Boolean vtkCarbonRenderWindow::fAcceleratedMust [protected]

Definition at line 206 of file vtkCarbonRenderWindow.h.

Boolean vtkCarbonRenderWindow::draggable [protected]

Definition at line 207 of file vtkCarbonRenderWindow.h.

GLint vtkCarbonRenderWindow::aglAttributes[64] [protected]

Definition at line 208 of file vtkCarbonRenderWindow.h.

SInt32 vtkCarbonRenderWindow::VRAM [protected]

Definition at line 210 of file vtkCarbonRenderWindow.h.

SInt32 vtkCarbonRenderWindow::textureRAM [protected]

Definition at line 212 of file vtkCarbonRenderWindow.h.

AGLPixelFormat vtkCarbonRenderWindow::fmt [protected]

Definition at line 214 of file vtkCarbonRenderWindow.h.

AGLContext vtkCarbonRenderWindow::ContextId [protected]

Definition at line 215 of file vtkCarbonRenderWindow.h.

HIViewRef vtkCarbonRenderWindow::WindowId [protected]

Definition at line 216 of file vtkCarbonRenderWindow.h.

HIViewRef vtkCarbonRenderWindow::ParentId [protected]

Definition at line 217 of file vtkCarbonRenderWindow.h.

WindowPtr vtkCarbonRenderWindow::RootWindow [protected]

Definition at line 218 of file vtkCarbonRenderWindow.h.

int vtkCarbonRenderWindow::OwnWindow [protected]

Definition at line 219 of file vtkCarbonRenderWindow.h.

int vtkCarbonRenderWindow::ScreenSize[2] [protected]

Definition at line 220 of file vtkCarbonRenderWindow.h.

int vtkCarbonRenderWindow::CursorHidden [protected]

Definition at line 222 of file vtkCarbonRenderWindow.h.

int vtkCarbonRenderWindow::ForceMakeCurrent [protected]

Definition at line 223 of file vtkCarbonRenderWindow.h.

EventHandlerUPP vtkCarbonRenderWindow::RegionEventHandlerUPP [protected]

Definition at line 227 of file vtkCarbonRenderWindow.h.

EventHandlerRef vtkCarbonRenderWindow::RegionEventHandler [protected]

Definition at line 228 of file vtkCarbonRenderWindow.h.

---

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

• dox/Rendering/vtkCarbonRenderWindow.h

---