vtkCarbonRenderWindow Class Reference

#include <vtkCarbonRenderWindow.h>

Inheritance diagram for vtkCarbonRenderWindow:

Inheritance graph
[legend]
Collaboration diagram for vtkCarbonRenderWindow:

Collaboration graph
[legend]

List of all members.


Detailed Description

Carbon OpenGL rendering window.

vtkCarbonRenderWindow 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_CARBON turned ON. This class can be used only by 32 bit processes, as Carbon is unavailable in 64 bit. If you need 64 bit support, use vtkCocoaRenderWindow. vtkCarbonRenderWindow interfaces to the OpenGL graphics library using the Carbon AGL APIs.

See also:
vtkOpenGLRenderWindow vtkCocoaRenderWindow

Definition at line 57 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 ()
void SetOffScreenRendering (int)
virtual void SetFullScreen (int)
virtual void WindowRemap ()
virtual void PrefFullScreen ()
virtual int * GetSize ()
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 ()
void SetParentInfo (char *)
virtual void SetWindowId (HIViewRef)
virtual void SetMultiSamples (int)
virtual int GetMultiSamples ()
virtual void SetStereoCapableWindow (int capable)
void MakeCurrent ()
void SetForceMakeCurrent ()
virtual int GetEventPending ()
int GetDepthBufferSize ()
void UpdateSizeAndPosition (int xPos, int yPos, int xSize, int ySize)
void UpdateGLRegion ()
virtual void SetSize (int a[2])
virtual void SetSize (int, int)
virtual void SetPosition (int *)
virtual void SetPosition (int, int)
virtual HIViewRef GetWindowId ()
void SetWindowId (void *foo)
void SetNextWindowId (void *)
virtual void SetParentId (HIViewRef)
void SetParentId (void *foo)
void SetRootWindow (WindowPtr win)
WindowPtr GetRootWindow ()
void HideCursor ()
void ShowCursor ()

Static Public Member Functions

static vtkCarbonRenderWindowNew ()
static int IsTypeOf (const char *type)
static vtkCarbonRenderWindowSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkCarbonRenderWindow ()
 ~vtkCarbonRenderWindow ()
void InitializeApplication ()
void CreateAWindow ()
void DestroyWindow ()
void CreateOffScreenWindow (int x, int y)
void DestroyOffScreenWindow ()
void ResizeOffScreenWindow (int x, int y)

Static Protected Member Functions

static OSStatus RegionEventProcessor (EventHandlerCallRef er, EventRef event, void *)

Protected Attributes

vtkCarbonRenderWindowInternal * Internal
int ApplicationInitialized
GLint aglAttributes [64]
AGLContext ContextId
HIViewRef WindowId
HIViewRef ParentId
WindowPtr RootWindow
int OwnWindow
int ScreenSize [2]
int CursorHidden
int ForceMakeCurrent
EventHandlerUPP RegionEventHandlerUPP
EventHandlerRef RegionEventHandler

Member Typedef Documentation

Reimplemented from vtkOpenGLRenderWindow.

Definition at line 61 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 *  name  )  [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 *  name  )  [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.

void vtkCarbonRenderWindow::SetOffScreenRendering ( int   )  [virtual]

Create a rendering area in memory.

Reimplemented from vtkWindow.

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 in pixels.

Reimplemented from vtkWindow.

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

Set the size of the window in pixels.

Reimplemented from vtkWindow.

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

Get the current size of the window in pixels.

Reimplemented from vtkWindow.

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

Set the position of the window.

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

Set the position of the window.

Reimplemented from vtkWindow.

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

Get the current size of the screen in pixels.

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]

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

Definition at line 128 of file vtkCarbonRenderWindow.h.

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

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

Definition at line 134 of file vtkCarbonRenderWindow.h.

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

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

Definition at line 135 of file vtkCarbonRenderWindow.h.

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

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

Definition at line 136 of file vtkCarbonRenderWindow.h.

virtual AGLContext vtkCarbonRenderWindow::GetContextId (  )  [virtual]

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

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

Definition at line 138 of file vtkCarbonRenderWindow.h.

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

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

Definition at line 139 of file vtkCarbonRenderWindow.h.

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

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

Definition at line 141 of file vtkCarbonRenderWindow.h.

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

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

Definition at line 147 of file vtkCarbonRenderWindow.h.

virtual HIViewRef vtkCarbonRenderWindow::GetWindowId (  )  [virtual]

Get the HIView window pointer.

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

Get the HIView window pointer.

Implements vtkRenderWindow.

Definition at line 156 of file vtkCarbonRenderWindow.h.

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

Get the HIView window pointer.

Implements vtkRenderWindow.

Definition at line 157 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 166 of file vtkCarbonRenderWindow.h.

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 root window id. Use this when using non-HIView GUIs.

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

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

Reimplemented from vtkRenderWindow.

virtual int vtkCarbonRenderWindow::GetMultiSamples (  )  [virtual]

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

Reimplemented from vtkRenderWindow.

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.

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]

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::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::InitializeApplication (  )  [protected]

void vtkCarbonRenderWindow::CreateAWindow (  )  [protected, virtual]

Create a not-off-screen window.

Implements vtkOpenGLRenderWindow.

void vtkCarbonRenderWindow::DestroyWindow (  )  [protected, virtual]

Destroy a not-off-screen window.

Implements vtkOpenGLRenderWindow.

void vtkCarbonRenderWindow::CreateOffScreenWindow ( int  x,
int  y 
) [protected]

void vtkCarbonRenderWindow::DestroyOffScreenWindow (  )  [protected]

void vtkCarbonRenderWindow::ResizeOffScreenWindow ( int  x,
int  y 
) [protected]


Member Data Documentation

vtkCarbonRenderWindowInternal* vtkCarbonRenderWindow::Internal [protected]

Definition at line 223 of file vtkCarbonRenderWindow.h.

Definition at line 225 of file vtkCarbonRenderWindow.h.

GLint vtkCarbonRenderWindow::aglAttributes[64] [protected]

Definition at line 226 of file vtkCarbonRenderWindow.h.

AGLContext vtkCarbonRenderWindow::ContextId [protected]

Definition at line 228 of file vtkCarbonRenderWindow.h.

HIViewRef vtkCarbonRenderWindow::WindowId [protected]

Definition at line 229 of file vtkCarbonRenderWindow.h.

HIViewRef vtkCarbonRenderWindow::ParentId [protected]

Definition at line 230 of file vtkCarbonRenderWindow.h.

WindowPtr vtkCarbonRenderWindow::RootWindow [protected]

Definition at line 231 of file vtkCarbonRenderWindow.h.

Definition at line 232 of file vtkCarbonRenderWindow.h.

Definition at line 233 of file vtkCarbonRenderWindow.h.

Definition at line 235 of file vtkCarbonRenderWindow.h.

Definition at line 236 of file vtkCarbonRenderWindow.h.

EventHandlerUPP vtkCarbonRenderWindow::RegionEventHandlerUPP [protected]

Definition at line 240 of file vtkCarbonRenderWindow.h.

EventHandlerRef vtkCarbonRenderWindow::RegionEventHandler [protected]

Definition at line 241 of file vtkCarbonRenderWindow.h.


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

Generated on Sat Dec 27 13:19:08 2008 for VTK by  doxygen 1.5.6