vtkIOSRenderWindow Class Reference

IOS OpenGL rendering window. More...

#include <vtkIOSRenderWindow.h>

Inheritance diagram for vtkIOSRenderWindow:

Collaboration diagram for vtkIOSRenderWindow:

List of all members.

Public Types
typedef vtkOpenGLRenderWindow	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkIOSRenderWindow *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Start ()
virtual void	Frame ()
virtual void	WindowConfigure ()
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 *)
void	SetNextWindowInfo (char *)
virtual void *	GetGenericDrawable ()
virtual void	SetDisplayId (void *)
virtual void *	GetGenericDisplayId ()
virtual void	SetWindowInfo (char *)
virtual void	SetParentInfo (char *)
void	SetNextWindowId (void *)
virtual bool	InitializeFromCurrentContext ()
virtual void	StereoUpdate ()
virtual void	SetStereoCapableWindow (int capable)
virtual void	MakeCurrent ()
virtual bool	IsCurrent ()
virtual bool	IsDrawable ()
void	UpdateContext ()
const char *	ReportCapabilities ()
int	SupportsOpenGL ()
int	IsDirect ()
virtual void	SetForceMakeCurrent ()
virtual int	GetEventPending ()
void	Finalize ()
int	GetDepthBufferSize ()
virtual void	SetCurrentCursor (int)
virtual int	GetWindowCreated ()
virtual void	SetRootWindow (void *)
virtual void *	GetRootWindow ()
virtual void	SetWindowId (void *)
virtual void	SetParentId (void *UIView)
virtual void	SetSize (int a[2])
virtual void	SetSize (int, int)
virtual void	SetPosition (int a[2])
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 ()
virtual void	SetCursorPosition (int x, int y)
void	SetContextId (void *)
void *	GetContextId ()
virtual void *	GetGenericContext ()
virtual void *	GetWindowId ()
virtual void *	GetGenericWindowId ()
virtual void *	GetParentId ()
virtual void *	GetGenericParentId ()
void	SetPixelFormat (void *pixelFormat)
void *	GetPixelFormat ()
Static Public Member Functions
static vtkIOSRenderWindow *	New ()
static int	IsTypeOf (const char *type)
static vtkIOSRenderWindow *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkIOSRenderWindow ()
	~vtkIOSRenderWindow ()
void	CreateGLContext ()
void	CreateAWindow ()
void	DestroyWindow ()
void	DestroyOffScreenWindow ()
Protected Attributes
int	OffScreenInitialized
int	OnScreenInitialized

---

Detailed Description

IOS OpenGL rendering window.

vtkIOSRenderWindow is a concrete implementation of the abstract class vtkOpenGLRenderWindow. It is only available on Mac OS X 10.5 and later. To use this class, build VTK with VTK_USE_IOS turned ON (this is the default). This class can be used by 32 and 64 bit processes, and either in garbage collected or reference counted modes. ARC is not supported. vtkIOSRenderWindow uses Objective-C++, and the OpenGL and IOS APIs. This class's default behaviour is to create an NSWindow and a vtkIOSGLView which are used together to draw all VTK content. If you already have an NSWindow and vtkIOSGLView and you want this class to use them you must call both SetRootWindow() and SetWindowId(), respectively, early on (before WindowInitialize() is executed).

See also:

vtkOpenGLRenderWindow vtkIOSGLView

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.

Definition at line 48 of file vtkIOSRenderWindow.h.

---

Member Typedef Documentation

typedef vtkOpenGLRenderWindow vtkIOSRenderWindow::Superclass

Reimplemented from vtkOpenGLRenderWindow.

Definition at line 52 of file vtkIOSRenderWindow.h.

---

Constructor & Destructor Documentation

vtkIOSRenderWindow::vtkIOSRenderWindow

(

)

[protected]

vtkIOSRenderWindow::~vtkIOSRenderWindow

(

)

[protected]

---

Member Function Documentation

static vtkIOSRenderWindow* vtkIOSRenderWindow::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.

static int vtkIOSRenderWindow::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkOpenGLRenderWindow.

virtual int vtkIOSRenderWindow::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkOpenGLRenderWindow.

static vtkIOSRenderWindow* vtkIOSRenderWindow::SafeDownCast

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkOpenGLRenderWindow.

virtual vtkObjectBase* vtkIOSRenderWindow::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkOpenGLRenderWindow.

vtkIOSRenderWindow* vtkIOSRenderWindow::NewInstance

(

)

const

Reimplemented from vtkOpenGLRenderWindow.

void vtkIOSRenderWindow::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 vtkIOSRenderWindow::Start

(

)

[virtual]

Begin the rendering process.

Implements vtkRenderWindow.

virtual void vtkIOSRenderWindow::Frame

(

)

[virtual]

Finish the rendering process.

Implements vtkRenderWindow.

virtual void vtkIOSRenderWindow::WindowConfigure

(

)

[virtual]

Specify various window parameters.

virtual void vtkIOSRenderWindow::Initialize

(

)

[virtual]

Initialize the window for rendering. virtual void WindowInitialize();

Initialize the rendering window.

virtual void vtkIOSRenderWindow::SetFullScreen

(

int

)

[virtual]

Change the window to fill the entire screen. This is only partially implemented for the vtkIOSRenderWindow. It can only be called before the window has been created, and it might not work on all versions of OS X.

Implements vtkRenderWindow.

virtual void vtkIOSRenderWindow::WindowRemap

(

)

[virtual]

Remap the window. This is not implemented for the vtkIOSRenderWindow.

Implements vtkRenderWindow.

virtual void vtkIOSRenderWindow::PrefFullScreen

(

)

[virtual]

Set the preferred window size to full screen. This is not implemented for the vtkIOSRenderWindow.

virtual void vtkIOSRenderWindow::SetSize

(

int

a[2]

)

[virtual]

Set the size of the window in pixels.

Reimplemented from vtkWindow.

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

Set the size of the window in pixels.

Reimplemented from vtkWindow.

virtual int* vtkIOSRenderWindow::GetSize

(

)

[virtual]

Get the current size of the window in pixels.

Reimplemented from vtkWindow.

virtual void vtkIOSRenderWindow::SetPosition

(

int

a[2]

)

[virtual]

Set the position of the window.

Reimplemented from vtkWindow.

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

Set the position of the window.

Reimplemented from vtkWindow.

virtual int* vtkIOSRenderWindow::GetScreenSize

(

)

[virtual]

Get the current size of the screen in pixels.

Implements vtkWindow.

virtual int* vtkIOSRenderWindow::GetPosition

(

)

[virtual]

Get the position in screen coordinates of the window.

Reimplemented from vtkWindow.

virtual void vtkIOSRenderWindow::SetWindowName

(

const char *

)

[virtual]

Set the name of the window. This appears at the top of the window normally.

Reimplemented from vtkWindow.

void vtkIOSRenderWindow::SetNextWindowInfo

(

char *

)

[inline, virtual]

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

Definition at line 108 of file vtkIOSRenderWindow.h.

virtual void* vtkIOSRenderWindow::GetGenericDrawable

(

)

[inline, virtual]

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

Definition at line 112 of file vtkIOSRenderWindow.h.

virtual void vtkIOSRenderWindow::SetDisplayId

(

void *

)

[inline, virtual]

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

Definition at line 117 of file vtkIOSRenderWindow.h.

virtual void* vtkIOSRenderWindow::GetGenericDisplayId

(

)

[inline, virtual]

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

Definition at line 121 of file vtkIOSRenderWindow.h.

virtual void vtkIOSRenderWindow::SetWindowInfo

(

char *

)

[virtual]

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.

Implements vtkRenderWindow.

virtual void vtkIOSRenderWindow::SetParentInfo

(

char *

)

[virtual]

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 UIView.

Implements vtkRenderWindow.

void vtkIOSRenderWindow::SetNextWindowId

(

void *

)

[inline, virtual]

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

Definition at line 137 of file vtkIOSRenderWindow.h.

virtual bool vtkIOSRenderWindow::InitializeFromCurrentContext

(

)

[virtual]

Initialize the render window from the information associated with the currently activated OpenGL context.

Reimplemented from vtkRenderWindow.

virtual void vtkIOSRenderWindow::StereoUpdate

(

)

[virtual]

Update system if needed due to stereo rendering.

Reimplemented from vtkOpenGLRenderWindow.

virtual void vtkIOSRenderWindow::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 vtkIOSRenderWindow::MakeCurrent

(

)

[virtual]

Make this windows OpenGL context the current context.

Implements vtkRenderWindow.

virtual bool vtkIOSRenderWindow::IsCurrent

(

)

[virtual]

Tells if this window is the current OpenGL context for the calling thread.

Implements vtkRenderWindow.

virtual bool vtkIOSRenderWindow::IsDrawable

(

)

[virtual]

Test if the window has a valid drawable. This is currently only an issue on Mac OS X IOS where rendering to an invalid drawable results in all OpenGL calls to fail with "invalid framebuffer operation".

Reimplemented from vtkRenderWindow.

void vtkIOSRenderWindow::UpdateContext

(

)

Update this window's OpenGL context, e.g. when the window is resized.

const char* vtkIOSRenderWindow::ReportCapabilities

(

)

[virtual]

Get report of capabilities for the render window

Reimplemented from vtkRenderWindow.

int vtkIOSRenderWindow::SupportsOpenGL

(

)

[virtual]

Does this render window support OpenGL? 0-false, 1-true

Reimplemented from vtkRenderWindow.

int vtkIOSRenderWindow::IsDirect

(

)

[virtual]

Is this render window using hardware acceleration? 0-false, 1-true

Reimplemented from vtkRenderWindow.

virtual void vtkIOSRenderWindow::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 vtkIOSRenderWindow::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 vtkIOSRenderWindow::SetupPalette

(

void *

hDC

)

[virtual]

Initialize OpenGL for this window.

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

Initialize OpenGL for this window.

void vtkIOSRenderWindow::Finalize

(

)

[virtual]

Clean up device contexts, rendering contexts, etc.

Implements vtkRenderWindow.

int vtkIOSRenderWindow::GetDepthBufferSize

(

)

[virtual]

Get the size of the depth buffer.

Reimplemented from vtkOpenGLRenderWindow.

virtual void vtkIOSRenderWindow::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. Set cursor position in window (note that (0,0) is the lower left corner).

Implements vtkRenderWindow.

virtual void vtkIOSRenderWindow::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. Set cursor position in window (note that (0,0) is the lower left corner).

Implements vtkRenderWindow.

virtual void vtkIOSRenderWindow::SetCursorPosition	(	int	x,
		int	y
	)		[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. Set cursor position in window (note that (0,0) is the lower left corner).

Reimplemented from vtkRenderWindow.

virtual void vtkIOSRenderWindow::SetCurrentCursor

(

int

)

[virtual]

Change the shape of the cursor.

Reimplemented from vtkRenderWindow.

virtual int vtkIOSRenderWindow::GetWindowCreated

(

)

[virtual]

Get the WindowCreated flag. It is 1 if this object created an instance of NSWindow, 0 otherwise.

void vtkIOSRenderWindow::SetContextId

(

void *

)

Accessors for the OpenGL context (Really an NSOpenGLContext*).

void* vtkIOSRenderWindow::GetContextId

(

)

Accessors for the OpenGL context (Really an NSOpenGLContext*).

virtual void* vtkIOSRenderWindow::GetGenericContext

(

)

[inline, virtual]

Accessors for the OpenGL context (Really an NSOpenGLContext*).

Implements vtkRenderWindow.

Definition at line 221 of file vtkIOSRenderWindow.h.

virtual void vtkIOSRenderWindow::SetRootWindow

(

void *

)

[virtual]

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 vtkIOSGLView (UIView subclass) which are used together to draw all vtk stuff into. If you already have an NSWindow and UIView 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* vtkIOSRenderWindow::GetRootWindow

(

)

[virtual]

Returns the NSWindow* associated with this vtkRenderWindow.

virtual void vtkIOSRenderWindow::SetWindowId

(

void *

)

[virtual]

Sets the UIView* associated with this vtkRenderWindow. This class' default behaviour, that is, if you never call this SetWindowId()/SetRootWindow() is to create an NSWindow and a vtkIOSGLView (UIView subclass) which are used together to draw all vtk stuff into. If you already have an NSWindow and UIView 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().

Implements vtkRenderWindow.

virtual void* vtkIOSRenderWindow::GetWindowId

(

)

[virtual]

Returns the UIView* associated with this vtkRenderWindow.

virtual void* vtkIOSRenderWindow::GetGenericWindowId

(

)

[inline, virtual]

Returns the UIView* associated with this vtkRenderWindow.

Implements vtkRenderWindow.

Definition at line 250 of file vtkIOSRenderWindow.h.

virtual void vtkIOSRenderWindow::SetParentId

(

void *

UIView

)

[virtual]

Set the UIView* for the vtkRenderWindow to be parented within. The Position and Size of the RenderWindow will set the rectangle of the UIView that the vtkRenderWindow will create within this parent. If you set the WindowId, then this ParentId will be ignored.

Implements vtkRenderWindow.

virtual void* vtkIOSRenderWindow::GetParentId

(

)

[virtual]

Get the parent UIView* for this vtkRenderWindow. This method will return "NULL" if the parent was not set with SetParentId() or SetParentInfo().

virtual void* vtkIOSRenderWindow::GetGenericParentId

(

)

[inline, virtual]

Get the parent UIView* for this vtkRenderWindow. This method will return "NULL" if the parent was not set with SetParentId() or SetParentInfo().

Implements vtkRenderWindow.

Definition at line 264 of file vtkIOSRenderWindow.h.

void vtkIOSRenderWindow::SetPixelFormat

(

void *

pixelFormat

)

Accessors for the pixel format object (Really an NSOpenGLPixelFormat*).

void* vtkIOSRenderWindow::GetPixelFormat

(

)

Accessors for the pixel format object (Really an NSOpenGLPixelFormat*).

void vtkIOSRenderWindow::CreateGLContext

(

)

[protected]

void vtkIOSRenderWindow::CreateAWindow

(

)

[protected, virtual]

Create a not-off-screen window.

Implements vtkOpenGLRenderWindow.

void vtkIOSRenderWindow::DestroyWindow

(

)

[protected, virtual]

Destroy a not-off-screen window.

Implements vtkOpenGLRenderWindow.

void vtkIOSRenderWindow::DestroyOffScreenWindow

(

)

[protected]

---

Member Data Documentation

int vtkIOSRenderWindow::OffScreenInitialized [protected]

Definition at line 284 of file vtkIOSRenderWindow.h.

int vtkIOSRenderWindow::OnScreenInitialized [protected]

Definition at line 285 of file vtkIOSRenderWindow.h.

---

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

• /Users/kitware/Dashboards/MyTests/VTK_BLD_Release_docs/Utilities/Doxygen/dox/Rendering/OpenGL2/vtkIOSRenderWindow.h