vtkRenderWindow Class Reference

#include <vtkRenderWindow.h>

Inheritance diagram for vtkRenderWindow:

[legend]

Collaboration diagram for vtkRenderWindow:

[legend]

List of all members.

Detailed Description

create a window for renderers to draw into

vtkRenderWindow is an abstract object to specify the behavior of a rendering window. A rendering window is a window in a graphical user interface where renderers draw their images. Methods are provided to synchronize the rendering process, set window size, and control double buffering. The window also allows rendering in stereo. The interlaced render stereo type is for output to a VRex stereo projector. All of the odd horizontal lines are from the left eye, and the even lines are from the right eye. The user has to make the render window aligned with the VRex projector, or the eye will be swapped.

Warning:: In VTK versions 4 and later, the vtkWindowToImageFilter class is part of the canonical way to output an image of a window to a file (replacing the obsolete SaveImageAsPPM method for vtkRenderWindows that existed in 3.2 and earlier). Connect one of these filters to the output of the window, and filter's output to a writer such as vtkPNGWriter.

See also:: vtkRenderer vtkRenderWindowInteractor vtkWindowToImageFilter

Events:: vtkCommand::StartEvent vtkCommand::AbortCheckEvent vtkCommand::EndEvent

Examples:: vtkRenderWindow (Examples)

Tests:: vtkRenderWindow (Tests)

Definition at line 106 of file vtkRenderWindow.h.


Public Types
typedef vtkWindow	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	AddRenderer (vtkRenderer *)
void	RemoveRenderer (vtkRenderer *)
int	HasRenderer (vtkRenderer *)
vtkRendererCollection *	GetRenderers ()
virtual void	Render ()
virtual void	Start ()=0
virtual void	Finalize ()=0
virtual void	Frame ()=0
virtual void	WaitForCompletion ()=0
virtual void	CopyResultFrame ()
virtual vtkRenderWindowInteractor *	MakeRenderWindowInteractor ()
const char *	GetStereoTypeAsString ()
virtual void	StereoUpdate ()
virtual void	StereoMidpoint ()
virtual void	StereoRenderComplete ()
virtual void	WindowRemap ()=0
virtual int	GetIsPicking ()
virtual void	SetIsPicking (int)
virtual void	IsPickingOn ()
virtual void	IsPickingOff ()
virtual int	GetEventPending ()=0
virtual int	CheckInRenderStatus ()
virtual void	ClearInRenderStatus ()
void	SetInteractor (vtkRenderWindowInteractor *)
virtual void	UnRegister (vtkObjectBase *o)
virtual void	MakeCurrent ()=0
virtual bool	IsCurrent ()=0
virtual void	SetForceMakeCurrent ()
virtual const char *	ReportCapabilities ()
virtual int	SupportsOpenGL ()
virtual int	IsDirect ()
virtual int	GetDepthBufferSize ()=0
virtual int	GetColorBufferSizes (int *rgba)=0
virtual void	CheckGraphicError ()=0
virtual int	HasGraphicError ()=0
virtual const char *	GetLastGraphicErrorString ()=0

virtual void	HideCursor ()=0
virtual void	ShowCursor ()=0
virtual void	SetCursorPosition (int, int)

virtual void	SetCurrentCursor (int)
virtual int	GetCurrentCursor ()

virtual void	SetFullScreen (int)=0
virtual int	GetFullScreen ()
virtual void	FullScreenOn ()
virtual void	FullScreenOff ()

virtual void	SetBorders (int)
virtual int	GetBorders ()
virtual void	BordersOn ()
virtual void	BordersOff ()

virtual int	GetStereoCapableWindow ()
virtual void	StereoCapableWindowOn ()
virtual void	StereoCapableWindowOff ()
virtual void	SetStereoCapableWindow (int capable)

virtual int	GetStereoRender ()
void	SetStereoRender (int stereo)
virtual void	StereoRenderOn ()
virtual void	StereoRenderOff ()

virtual void	SetAlphaBitPlanes (int)
virtual int	GetAlphaBitPlanes ()
virtual void	AlphaBitPlanesOn ()
virtual void	AlphaBitPlanesOff ()

virtual void	SetPointSmoothing (int)
virtual int	GetPointSmoothing ()
virtual void	PointSmoothingOn ()
virtual void	PointSmoothingOff ()

virtual void	SetLineSmoothing (int)
virtual int	GetLineSmoothing ()
virtual void	LineSmoothingOn ()
virtual void	LineSmoothingOff ()

virtual void	SetPolygonSmoothing (int)
virtual int	GetPolygonSmoothing ()
virtual void	PolygonSmoothingOn ()
virtual void	PolygonSmoothingOff ()

virtual int	GetStereoType ()
virtual void	SetStereoType (int)
void	SetStereoTypeToCrystalEyes ()
void	SetStereoTypeToRedBlue ()
void	SetStereoTypeToInterlaced ()
void	SetStereoTypeToLeft ()
void	SetStereoTypeToRight ()
void	SetStereoTypeToDresden ()
void	SetStereoTypeToAnaglyph ()
void	SetStereoTypeToCheckerboard ()

virtual void	SetAnaglyphColorSaturation (float)
virtual float	GetAnaglyphColorSaturation ()

virtual void	SetAnaglyphColorMask (int, int)
void	SetAnaglyphColorMask (int[2])
virtual int *	GetAnaglyphColorMask ()
virtual void	GetAnaglyphColorMask (int data[2])

virtual void	SetSwapBuffers (int)
virtual int	GetSwapBuffers ()
virtual void	SwapBuffersOn ()
virtual void	SwapBuffersOff ()

virtual int	SetPixelData (int x, int y, int x2, int y2, unsigned char *data, int front)=0
virtual int	SetPixelData (int x, int y, int x2, int y2, vtkUnsignedCharArray *data, int front)=0

virtual float *	GetRGBAPixelData (int x, int y, int x2, int y2, int front)=0
virtual int	GetRGBAPixelData (int x, int y, int x2, int y2, int front, vtkFloatArray *data)=0
virtual int	SetRGBAPixelData (int x, int y, int x2, int y2, float *, int front, int blend=0)=0
virtual int	SetRGBAPixelData (int, int, int, int, vtkFloatArray *, int, int blend=0)=0
virtual void	ReleaseRGBAPixelData (float *data)=0
virtual unsigned char *	GetRGBACharPixelData (int x, int y, int x2, int y2, int front)=0
virtual int	GetRGBACharPixelData (int x, int y, int x2, int y2, int front, vtkUnsignedCharArray *data)=0
virtual int	SetRGBACharPixelData (int x, int y, int x2, int y2, unsigned char *data, int front, int blend=0)=0
virtual int	SetRGBACharPixelData (int x, int y, int x2, int y2, vtkUnsignedCharArray *data, int front, int blend=0)=0

virtual float *	GetZbufferData (int x, int y, int x2, int y2)=0
virtual int	GetZbufferData (int x, int y, int x2, int y2, float *z)=0
virtual int	GetZbufferData (int x, int y, int x2, int y2, vtkFloatArray *z)=0
virtual int	SetZbufferData (int x, int y, int x2, int y2, float *z)=0
virtual int	SetZbufferData (int x, int y, int x2, int y2, vtkFloatArray *z)=0
float	GetZbufferDataAtPoint (int x, int y)

virtual int	GetAAFrames ()
virtual void	SetAAFrames (int)

virtual int	GetFDFrames ()
virtual void	SetFDFrames (int)

virtual int	GetSubFrames ()
virtual void	SetSubFrames (int subFrames)

virtual int	GetNeverRendered ()

virtual int	GetAbortRender ()
virtual void	SetAbortRender (int)
virtual int	GetInAbortCheck ()
virtual void	SetInAbortCheck (int)
virtual int	CheckAbortStatus ()

virtual void	SetDesiredUpdateRate (double)
virtual double	GetDesiredUpdateRate ()

virtual int	GetNumberOfLayers ()
virtual void	SetNumberOfLayers (int)

virtual vtkRenderWindowInteractor *	GetInteractor ()

virtual void	SetDisplayId (void *)=0
virtual void	SetWindowId (void *)=0
virtual void	SetNextWindowId (void *)=0
virtual void	SetParentId (void *)=0
virtual void *	GetGenericDisplayId ()=0
virtual void *	GetGenericWindowId ()=0
virtual void *	GetGenericParentId ()=0
virtual void *	GetGenericContext ()=0
virtual void *	GetGenericDrawable ()=0
virtual void	SetWindowInfo (char *)=0
virtual void	SetNextWindowInfo (char *)=0
virtual void	SetParentInfo (char *)=0

virtual vtkPainterDeviceAdapter *	GetPainterDeviceAdapter ()

virtual void	SetMultiSamples (int)
virtual int	GetMultiSamples ()

virtual void	SetStencilCapable (int)
virtual int	GetStencilCapable ()
virtual void	StencilCapableOn ()
virtual void	StencilCapableOff ()

virtual void	SetReportGraphicErrors (int)
virtual int	GetReportGraphicErrors ()
virtual void	ReportGraphicErrorsOn ()
virtual void	ReportGraphicErrorsOff ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkRenderWindow *	SafeDownCast (vtkObject *o)
static vtkRenderWindow *	New ()
static const char *	GetRenderLibrary ()
Protected Member Functions
	vtkRenderWindow ()
	~vtkRenderWindow ()
virtual void	DoStereoRender ()
virtual void	DoFDRender ()
virtual void	DoAARender ()
Protected Attributes
vtkPainterDeviceAdapter *	PainterDeviceAdapter
vtkRendererCollection *	Renderers
int	Borders
int	FullScreen
int	OldScreen [5]
int	PointSmoothing
int	LineSmoothing
int	PolygonSmoothing
int	StereoRender
int	StereoType
int	StereoStatus
int	StereoCapableWindow
int	AlphaBitPlanes
vtkRenderWindowInteractor *	Interactor
unsigned char *	StereoBuffer
float *	AccumulationBuffer
unsigned int	AccumulationBufferSize
int	AAFrames
int	FDFrames
int	SubFrames
int	CurrentSubFrame
unsigned char *	ResultFrame
int	SwapBuffers
double	DesiredUpdateRate
int	AbortRender
int	InAbortCheck
int	InRender
int	NeverRendered
int	NumberOfLayers
int	CurrentCursor
int	IsPicking
float	AnaglyphColorSaturation
int	AnaglyphColorMask [2]
int	MultiSamples
int	StencilCapable
int	ReportGraphicErrors
double	AbortCheckTime

Member Typedef Documentation

typedef vtkWindow vtkRenderWindow::Superclass

Reimplemented from vtkWindow.

Reimplemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkMesaRenderWindow, vtkOpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

Definition at line 109 of file vtkRenderWindow.h.

Constructor & Destructor Documentation

vtkRenderWindow::vtkRenderWindow ( ) [protected]

vtkRenderWindow::~vtkRenderWindow ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkWindow.

Reimplemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkMesaRenderWindow, vtkOpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

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

Reimplemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkMesaRenderWindow, vtkOpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

virtual int vtkRenderWindow::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 vtkWindow.

Reimplemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkMesaRenderWindow, vtkOpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

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

Reimplemented from vtkWindow.

Reimplemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkMesaRenderWindow, vtkOpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

void vtkRenderWindow::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 vtkWindow.

Reimplemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkMesaRenderWindow, vtkOpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

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

Reimplemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

virtual void vtkRenderWindow::AddRenderer ( vtkRenderer * ) [virtual]

Add a renderer to the list of renderers.

void vtkRenderWindow::RemoveRenderer ( vtkRenderer * )

Remove a renderer from the list of renderers.

int vtkRenderWindow::HasRenderer ( vtkRenderer * )

Query if a renderer is in the list of renderers.

static const char* vtkRenderWindow::GetRenderLibrary ( ) [static]

What rendering library has the user requested

vtkRendererCollection* vtkRenderWindow::GetRenderers ( ) [inline]

Return the collection of renderers in the render window.

Definition at line 130 of file vtkRenderWindow.h.

virtual void vtkRenderWindow::Render ( ) [virtual]

Ask each renderer owned by this RenderWindow to render its image and synchronize this process.

Implements vtkWindow.

Reimplemented in vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

virtual void vtkRenderWindow::Start ( ) [pure virtual]

Initialize the rendering process.

Implemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

virtual void vtkRenderWindow::Finalize ( ) [pure virtual]

Finalize the rendering process.

Implemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

virtual void vtkRenderWindow::Frame ( ) [pure virtual]

A termination method performed at the end of the rendering process to do things like swapping buffers (if necessary) or similar actions.

Implemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

virtual void vtkRenderWindow::WaitForCompletion ( ) [pure virtual]

Block the thread until the actual rendering is finished(). Useful for measurement only.

Implemented in vtkOpenGLRenderWindow.

virtual void vtkRenderWindow::CopyResultFrame ( ) [virtual]

Performed at the end of the rendering process to generate image. This is typically done right before swapping buffers.

virtual vtkRenderWindowInteractor* vtkRenderWindow::MakeRenderWindowInteractor ( ) [virtual]

Create an interactor to control renderers in this window. We need to know what type of interactor to create, because we might be in X Windows or MS Windows.

virtual void vtkRenderWindow::HideCursor ( ) [pure 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).

Implemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

virtual void vtkRenderWindow::ShowCursor ( ) [pure 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).

Implemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

virtual void vtkRenderWindow::SetCursorPosition	(	int	,
		int
	)			`[inline, 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 in vtkCocoaRenderWindow, and vtkWin32OpenGLRenderWindow.

Definition at line 165 of file vtkRenderWindow.h.

virtual void vtkRenderWindow::SetCurrentCursor ( int ) [virtual]

Change the shape of the cursor.

Reimplemented in vtkCocoaRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

virtual int vtkRenderWindow::GetCurrentCursor ( ) [virtual]

Change the shape of the cursor.

virtual void vtkRenderWindow::SetFullScreen ( int ) [pure virtual]

Turn on/off rendering full screen window size.

Implemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

virtual int vtkRenderWindow::GetFullScreen ( ) [virtual]

Turn on/off rendering full screen window size.

virtual void vtkRenderWindow::FullScreenOn ( ) [virtual]

Turn on/off rendering full screen window size.

virtual void vtkRenderWindow::FullScreenOff ( ) [virtual]

Turn on/off rendering full screen window size.

virtual void vtkRenderWindow::SetBorders ( int ) [virtual]

Turn on/off window manager borders. Typically, you shouldn't turn the borders off, because that bypasses the window manager and can cause undesirable behavior.

virtual int vtkRenderWindow::GetBorders ( ) [virtual]

Turn on/off window manager borders. Typically, you shouldn't turn the borders off, because that bypasses the window manager and can cause undesirable behavior.

virtual void vtkRenderWindow::BordersOn ( ) [virtual]

Turn on/off window manager borders. Typically, you shouldn't turn the borders off, because that bypasses the window manager and can cause undesirable behavior.

virtual void vtkRenderWindow::BordersOff ( ) [virtual]

Turn on/off window manager borders. Typically, you shouldn't turn the borders off, because that bypasses the window manager and can cause undesirable behavior.

virtual int vtkRenderWindow::GetStereoCapableWindow ( ) [virtual]

Prescribe that the window be created in a stereo-capable mode. This method must be called before the window is realized. Default is off.

virtual void vtkRenderWindow::StereoCapableWindowOn ( ) [virtual]

Prescribe that the window be created in a stereo-capable mode. This method must be called before the window is realized. Default is off.

virtual void vtkRenderWindow::StereoCapableWindowOff ( ) [virtual]

Prescribe that the window be created in a stereo-capable mode. This method must be called before the window is realized. Default is off.

virtual void vtkRenderWindow::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. Default is off.

Reimplemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

virtual int vtkRenderWindow::GetStereoRender ( ) [virtual]

Turn on/off stereo rendering.

void vtkRenderWindow::SetStereoRender ( int stereo )

Turn on/off stereo rendering.

virtual void vtkRenderWindow::StereoRenderOn ( ) [virtual]

Turn on/off stereo rendering.

virtual void vtkRenderWindow::StereoRenderOff ( ) [virtual]

Turn on/off stereo rendering.

virtual void vtkRenderWindow::SetAlphaBitPlanes ( int ) [virtual]

Turn on/off the use of alpha bitplanes.

virtual int vtkRenderWindow::GetAlphaBitPlanes ( ) [virtual]

Turn on/off the use of alpha bitplanes.

virtual void vtkRenderWindow::AlphaBitPlanesOn ( ) [virtual]

Turn on/off the use of alpha bitplanes.

virtual void vtkRenderWindow::AlphaBitPlanesOff ( ) [virtual]

Turn on/off the use of alpha bitplanes.

virtual void vtkRenderWindow::SetPointSmoothing ( int ) [virtual]

Turn on/off point smoothing. Default is off. This must be applied before the first Render.

virtual int vtkRenderWindow::GetPointSmoothing ( ) [virtual]

Turn on/off point smoothing. Default is off. This must be applied before the first Render.

virtual void vtkRenderWindow::PointSmoothingOn ( ) [virtual]

Turn on/off point smoothing. Default is off. This must be applied before the first Render.

virtual void vtkRenderWindow::PointSmoothingOff ( ) [virtual]

Turn on/off point smoothing. Default is off. This must be applied before the first Render.

virtual void vtkRenderWindow::SetLineSmoothing ( int ) [virtual]

Turn on/off line smoothing. Default is off. This must be applied before the first Render.

virtual int vtkRenderWindow::GetLineSmoothing ( ) [virtual]

Turn on/off line smoothing. Default is off. This must be applied before the first Render.

virtual void vtkRenderWindow::LineSmoothingOn ( ) [virtual]

Turn on/off line smoothing. Default is off. This must be applied before the first Render.

virtual void vtkRenderWindow::LineSmoothingOff ( ) [virtual]

Turn on/off line smoothing. Default is off. This must be applied before the first Render.

virtual void vtkRenderWindow::SetPolygonSmoothing ( int ) [virtual]

Turn on/off polygon smoothing. Default is off. This must be applied before the first Render.

virtual int vtkRenderWindow::GetPolygonSmoothing ( ) [virtual]

Turn on/off polygon smoothing. Default is off. This must be applied before the first Render.

virtual void vtkRenderWindow::PolygonSmoothingOn ( ) [virtual]

Turn on/off polygon smoothing. Default is off. This must be applied before the first Render.

virtual void vtkRenderWindow::PolygonSmoothingOff ( ) [virtual]

Turn on/off polygon smoothing. Default is off. This must be applied before the first Render.

virtual int vtkRenderWindow::GetStereoType ( ) [virtual]

Set/Get what type of stereo rendering to use. CrystalEyes mode uses frame-sequential capabilities available in OpenGL to drive LCD shutter glasses and stereo projectors. RedBlue mode is a simple type of stereo for use with red-blue glasses. Anaglyph mode is a superset of RedBlue mode, but the color output channels can be configured using the AnaglyphColorMask and the color of the original image can be (somewhat) maintained using AnaglyphColorSaturation; the default colors for Anaglyph mode is red-cyan. Interlaced stereo mode produces a composite image where horizontal lines alternate between left and right views. StereoLeft and StereoRight modes choose one or the other stereo view. Dresden mode is yet another stereoscopic interleaving.

virtual void vtkRenderWindow::SetStereoType ( int ) [virtual]

Set/Get what type of stereo rendering to use. CrystalEyes mode uses frame-sequential capabilities available in OpenGL to drive LCD shutter glasses and stereo projectors. RedBlue mode is a simple type of stereo for use with red-blue glasses. Anaglyph mode is a superset of RedBlue mode, but the color output channels can be configured using the AnaglyphColorMask and the color of the original image can be (somewhat) maintained using AnaglyphColorSaturation; the default colors for Anaglyph mode is red-cyan. Interlaced stereo mode produces a composite image where horizontal lines alternate between left and right views. StereoLeft and StereoRight modes choose one or the other stereo view. Dresden mode is yet another stereoscopic interleaving.

void vtkRenderWindow::SetStereoTypeToCrystalEyes ( ) [inline]

Set/Get what type of stereo rendering to use. CrystalEyes mode uses frame-sequential capabilities available in OpenGL to drive LCD shutter glasses and stereo projectors. RedBlue mode is a simple type of stereo for use with red-blue glasses. Anaglyph mode is a superset of RedBlue mode, but the color output channels can be configured using the AnaglyphColorMask and the color of the original image can be (somewhat) maintained using AnaglyphColorSaturation; the default colors for Anaglyph mode is red-cyan. Interlaced stereo mode produces a composite image where horizontal lines alternate between left and right views. StereoLeft and StereoRight modes choose one or the other stereo view. Dresden mode is yet another stereoscopic interleaving.

Definition at line 251 of file vtkRenderWindow.h.

void vtkRenderWindow::SetStereoTypeToRedBlue ( ) [inline]

Set/Get what type of stereo rendering to use. CrystalEyes mode uses frame-sequential capabilities available in OpenGL to drive LCD shutter glasses and stereo projectors. RedBlue mode is a simple type of stereo for use with red-blue glasses. Anaglyph mode is a superset of RedBlue mode, but the color output channels can be configured using the AnaglyphColorMask and the color of the original image can be (somewhat) maintained using AnaglyphColorSaturation; the default colors for Anaglyph mode is red-cyan. Interlaced stereo mode produces a composite image where horizontal lines alternate between left and right views. StereoLeft and StereoRight modes choose one or the other stereo view. Dresden mode is yet another stereoscopic interleaving.

Definition at line 253 of file vtkRenderWindow.h.

void vtkRenderWindow::SetStereoTypeToInterlaced ( ) [inline]

Set/Get what type of stereo rendering to use. CrystalEyes mode uses frame-sequential capabilities available in OpenGL to drive LCD shutter glasses and stereo projectors. RedBlue mode is a simple type of stereo for use with red-blue glasses. Anaglyph mode is a superset of RedBlue mode, but the color output channels can be configured using the AnaglyphColorMask and the color of the original image can be (somewhat) maintained using AnaglyphColorSaturation; the default colors for Anaglyph mode is red-cyan. Interlaced stereo mode produces a composite image where horizontal lines alternate between left and right views. StereoLeft and StereoRight modes choose one or the other stereo view. Dresden mode is yet another stereoscopic interleaving.

Definition at line 255 of file vtkRenderWindow.h.

void vtkRenderWindow::SetStereoTypeToLeft ( ) [inline]

Set/Get what type of stereo rendering to use. CrystalEyes mode uses frame-sequential capabilities available in OpenGL to drive LCD shutter glasses and stereo projectors. RedBlue mode is a simple type of stereo for use with red-blue glasses. Anaglyph mode is a superset of RedBlue mode, but the color output channels can be configured using the AnaglyphColorMask and the color of the original image can be (somewhat) maintained using AnaglyphColorSaturation; the default colors for Anaglyph mode is red-cyan. Interlaced stereo mode produces a composite image where horizontal lines alternate between left and right views. StereoLeft and StereoRight modes choose one or the other stereo view. Dresden mode is yet another stereoscopic interleaving.

Definition at line 257 of file vtkRenderWindow.h.

void vtkRenderWindow::SetStereoTypeToRight ( ) [inline]

Set/Get what type of stereo rendering to use. CrystalEyes mode uses frame-sequential capabilities available in OpenGL to drive LCD shutter glasses and stereo projectors. RedBlue mode is a simple type of stereo for use with red-blue glasses. Anaglyph mode is a superset of RedBlue mode, but the color output channels can be configured using the AnaglyphColorMask and the color of the original image can be (somewhat) maintained using AnaglyphColorSaturation; the default colors for Anaglyph mode is red-cyan. Interlaced stereo mode produces a composite image where horizontal lines alternate between left and right views. StereoLeft and StereoRight modes choose one or the other stereo view. Dresden mode is yet another stereoscopic interleaving.

Definition at line 259 of file vtkRenderWindow.h.

void vtkRenderWindow::SetStereoTypeToDresden ( ) [inline]

Set/Get what type of stereo rendering to use. CrystalEyes mode uses frame-sequential capabilities available in OpenGL to drive LCD shutter glasses and stereo projectors. RedBlue mode is a simple type of stereo for use with red-blue glasses. Anaglyph mode is a superset of RedBlue mode, but the color output channels can be configured using the AnaglyphColorMask and the color of the original image can be (somewhat) maintained using AnaglyphColorSaturation; the default colors for Anaglyph mode is red-cyan. Interlaced stereo mode produces a composite image where horizontal lines alternate between left and right views. StereoLeft and StereoRight modes choose one or the other stereo view. Dresden mode is yet another stereoscopic interleaving.

Definition at line 261 of file vtkRenderWindow.h.

void vtkRenderWindow::SetStereoTypeToAnaglyph ( ) [inline]

Set/Get what type of stereo rendering to use. CrystalEyes mode uses frame-sequential capabilities available in OpenGL to drive LCD shutter glasses and stereo projectors. RedBlue mode is a simple type of stereo for use with red-blue glasses. Anaglyph mode is a superset of RedBlue mode, but the color output channels can be configured using the AnaglyphColorMask and the color of the original image can be (somewhat) maintained using AnaglyphColorSaturation; the default colors for Anaglyph mode is red-cyan. Interlaced stereo mode produces a composite image where horizontal lines alternate between left and right views. StereoLeft and StereoRight modes choose one or the other stereo view. Dresden mode is yet another stereoscopic interleaving.

Definition at line 263 of file vtkRenderWindow.h.

void vtkRenderWindow::SetStereoTypeToCheckerboard ( ) [inline]

Set/Get what type of stereo rendering to use. CrystalEyes mode uses frame-sequential capabilities available in OpenGL to drive LCD shutter glasses and stereo projectors. RedBlue mode is a simple type of stereo for use with red-blue glasses. Anaglyph mode is a superset of RedBlue mode, but the color output channels can be configured using the AnaglyphColorMask and the color of the original image can be (somewhat) maintained using AnaglyphColorSaturation; the default colors for Anaglyph mode is red-cyan. Interlaced stereo mode produces a composite image where horizontal lines alternate between left and right views. StereoLeft and StereoRight modes choose one or the other stereo view. Dresden mode is yet another stereoscopic interleaving.

Definition at line 265 of file vtkRenderWindow.h.

const char* vtkRenderWindow::GetStereoTypeAsString ( )

virtual void vtkRenderWindow::StereoUpdate ( ) [virtual]

Update the system, if needed, due to stereo rendering. For some stereo methods, subclasses might need to switch some hardware settings here.

Reimplemented in vtkCocoaRenderWindow, vtkMesaRenderWindow, and vtkOpenGLRenderWindow.

virtual void vtkRenderWindow::StereoMidpoint ( ) [virtual]

Intermediate method performs operations required between the rendering of the left and right eye.

virtual void vtkRenderWindow::StereoRenderComplete ( ) [virtual]

Handles work required once both views have been rendered when using stereo rendering.

virtual void vtkRenderWindow::SetAnaglyphColorSaturation ( float ) [virtual]

Set/get the anaglyph color saturation factor. This number ranges from 0.0 to 1.0: 0.0 means that no color from the original object is maintained, 1.0 means all of the color is maintained. The default value is 0.65. Too much saturation can produce uncomfortable 3D viewing because anaglyphs also use color to encode 3D.

virtual float vtkRenderWindow::GetAnaglyphColorSaturation ( ) [virtual]

Set/get the anaglyph color saturation factor. This number ranges from 0.0 to 1.0: 0.0 means that no color from the original object is maintained, 1.0 means all of the color is maintained. The default value is 0.65. Too much saturation can produce uncomfortable 3D viewing because anaglyphs also use color to encode 3D.

virtual void vtkRenderWindow::SetAnaglyphColorMask	(	int	,
		int
	)			`[virtual]`

Set/get the anaglyph color mask values. These two numbers are bits mask that control which color channels of the original stereo images are used to produce the final anaglyph image. The first value is the color mask for the left view, the second the mask for the right view. If a bit in the mask is on for a particular color for a view, that color is passed on to the final view; if it is not set, that channel for that view is ignored. The bits are arranged as r, g, and b, so r = 4, g = 2, and b = 1. By default, the first value (the left view) is set to 4, and the second value is set to 3. That means that the red output channel comes from the left view, and the green and blue values come from the right view.

void vtkRenderWindow::SetAnaglyphColorMask ( int [2] )

Set/get the anaglyph color mask values. These two numbers are bits mask that control which color channels of the original stereo images are used to produce the final anaglyph image. The first value is the color mask for the left view, the second the mask for the right view. If a bit in the mask is on for a particular color for a view, that color is passed on to the final view; if it is not set, that channel for that view is ignored. The bits are arranged as r, g, and b, so r = 4, g = 2, and b = 1. By default, the first value (the left view) is set to 4, and the second value is set to 3. That means that the red output channel comes from the left view, and the green and blue values come from the right view.

virtual int* vtkRenderWindow::GetAnaglyphColorMask ( ) [virtual]

Set/get the anaglyph color mask values. These two numbers are bits mask that control which color channels of the original stereo images are used to produce the final anaglyph image. The first value is the color mask for the left view, the second the mask for the right view. If a bit in the mask is on for a particular color for a view, that color is passed on to the final view; if it is not set, that channel for that view is ignored. The bits are arranged as r, g, and b, so r = 4, g = 2, and b = 1. By default, the first value (the left view) is set to 4, and the second value is set to 3. That means that the red output channel comes from the left view, and the green and blue values come from the right view.

virtual void vtkRenderWindow::GetAnaglyphColorMask ( int data[2] ) [virtual]

Set/get the anaglyph color mask values. These two numbers are bits mask that control which color channels of the original stereo images are used to produce the final anaglyph image. The first value is the color mask for the left view, the second the mask for the right view. If a bit in the mask is on for a particular color for a view, that color is passed on to the final view; if it is not set, that channel for that view is ignored. The bits are arranged as r, g, and b, so r = 4, g = 2, and b = 1. By default, the first value (the left view) is set to 4, and the second value is set to 3. That means that the red output channel comes from the left view, and the green and blue values come from the right view.

virtual void vtkRenderWindow::WindowRemap ( ) [pure virtual]

Remap the rendering window. This probably only works on UNIX right now. It is useful for changing properties that can't normally be changed once the window is up.

Implemented in vtkCarbonRenderWindow, vtkCocoaRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkWinCEOpenGLRenderWindow, vtkXMesaRenderWindow, and vtkXOpenGLRenderWindow.

virtual void vtkRenderWindow::SetSwapBuffers ( int ) [virtual]

Turn on/off buffer swapping between images.

virtual int vtkRenderWindow::GetSwapBuffers ( ) [virtual]

Turn on/off buffer swapping between images.

virtual void vtkRenderWindow::SwapBuffersOn ( ) [virtual]

Turn on/off buffer swapping between images.

virtual void vtkRenderWindow::SwapBuffersOff ( ) [virtual]

Turn on/off buffer swapping between images.

virtual int vtkRenderWindow::SetPixelData	(	int	x,
		int	y,
		int	x2,
		int	y2,
		unsigned char *	data,
		int	front
	)			`[pure virtual]`

Set/Get the pixel data of an image, transmitted as RGBRGBRGB. The front argument indicates if the front buffer should be used or the back buffer. It is the caller's responsibility to delete the resulting array. It is very important to realize that the memory in this array is organized from the bottom of the window to the top. The origin of the screen is in the lower left corner. The y axis increases as you go up the screen. So the storage of pixels is from left to right and from bottom to top. (x,y) is any corner of the rectangle. (x2,y2) is its opposite corner on the diagonal.

Implemented in vtkMesaRenderWindow, and vtkOpenGLRenderWindow.

virtual int vtkRenderWindow::SetPixelData	(	int	x,
		int	y,
		int	x2,
		int	y2,
		vtkUnsignedCharArray *	data,
		int	front
	)			`[pure virtual]`

Set/Get the pixel data of an image, transmitted as RGBRGBRGB. The front argument indicates if the front buffer should be used or the back buffer. It is the caller's responsibility to delete the resulting array. It is very important to realize that the memory in this array is organized from the bottom of the window to the top. The origin of the screen is in the lower left corner. The y axis increases as you go up the screen. So the storage of pixels is from left to right and from bottom to top. (x,y) is any corner of the rectangle. (x2,y2) is its opposite corner on the diagonal.

Implemented in vtkMesaRenderWindow, and vtkOpenGLRenderWindow.

virtual float* vtkRenderWindow::GetRGBAPixelData	(	int	x,
		int	y,
		int	x2,
		int	y2,
		int	front
	)			`[pure virtual]`

Same as Get/SetPixelData except that the image also contains an alpha component. The image is transmitted as RGBARGBARGBA... each of which is a float value. The "blend" parameter controls whether the SetRGBAPixelData method blends the data with the previous contents of the frame buffer or completely replaces the frame buffer data.

Implemented in vtkMesaRenderWindow, and vtkOpenGLRenderWindow.

virtual int vtkRenderWindow::GetRGBAPixelData	(	int	x,
		int	y,
		int	x2,
		int	y2,
		int	front,
		vtkFloatArray *	data
	)			`[pure virtual]`

Same as Get/SetPixelData except that the image also contains an alpha component. The image is transmitted as RGBARGBARGBA... each of which is a float value. The "blend" parameter controls whether the SetRGBAPixelData method blends the data with the previous contents of the frame buffer or completely replaces the frame buffer data.

Implemented in vtkMesaRenderWindow, and vtkOpenGLRenderWindow.

virtual int vtkRenderWindow::SetRGBAPixelData	(	int	x,
		int	y,
		int	x2,
		int	y2,
		float *	,
		int	front,
		int	blend = `0`
	)			`[pure virtual]`

Same as Get/SetPixelData except that the image also contains an alpha component. The image is transmitted as RGBARGBARGBA... each of which is a float value. The "blend" parameter controls whether the SetRGBAPixelData method blends the data with the previous contents of the frame buffer or completely replaces the frame buffer data.

Implemented in vtkMesaRenderWindow, and vtkOpenGLRenderWindow.

virtual int vtkRenderWindow::SetRGBAPixelData	(	int	,
		int	,
		int	,
		int	,
		vtkFloatArray *	,
		int	,
		int	blend = `0`
	)			`[pure virtual]`

Same as Get/SetPixelData except that the image also contains an alpha component. The image is transmitted as RGBARGBARGBA... each of which is a float value. The "blend" parameter controls whether the SetRGBAPixelData method blends the data with the previous contents of the frame buffer or completely replaces the frame buffer data.

Implemented in vtkMesaRenderWindow, and vtkOpenGLRenderWindow.

virtual void vtkRenderWindow::ReleaseRGBAPixelData ( float * data ) [pure virtual]

Same as Get/SetPixelData except that the image also contains an alpha component. The image is transmitted as RGBARGBARGBA... each of which is a float value. The "blend" parameter controls whether the SetRGBAPixelData method blends the data with the previous contents of the frame buffer or completely replaces the frame buffer data.

Implemented in vtkMesaRenderWindow, and vtkOpenGLRenderWindow.

virtual unsigned char* vtkRenderWindow::GetRGBACharPixelData	(	int	x,
		int	y,
		int	x2,
		int	y2,
		int	front
	)			`[pure virtual]`

Same as Get/SetPixelData except that the image also contains an alpha component. The image is transmitted as RGBARGBARGBA... each of which is a float value. The "blend" parameter controls whether the SetRGBAPixelData method blends the data with the previous contents of the frame buffer or completely replaces the frame buffer data.

Implemented in vtkMesaRenderWindow, and vtkOpenGLRenderWindow.

virtual int vtkRenderWindow::GetRGBACharPixelData	(	int	x,
		int	y,
		int	x2,
		int	y2,
		int	front,
		vtkUnsignedCharArray *	data
	)			`[pure virtual]`

Same as Get/SetPixelData except that the image also contains an alpha component. The image is transmitted as RGBARGBARGBA... each of which is a float value. The "blend" parameter controls whether the SetRGBAPixelData method blends the data with the previous contents of the frame buffer or completely replaces the frame buffer data.

Implemented in vtkMesaRenderWindow, and vtkOpenGLRenderWindow.

virtual int vtkRenderWindow::SetRGBACharPixelData	(	int	x,
		int	y,
		int	x2,
		int	y2,
		unsigned char *	data,
		int	front,
		int	blend = `0`
	)			`[pure virtual]`

Same as Get/SetPixelData except that the image also contains an alpha component. The image is transmitted as RGBARGBARGBA... each of which is a float value. The "blend" parameter controls whether the SetRGBAPixelData method blends the data with the previous contents of the frame buffer or completely replaces the frame buffer data.

Implemented in vtkMesaRenderWindow, and vtkOpenGLRenderWindow.

virtual int vtkRenderWindow::SetRGBACharPixelData	(	int	x,
		int	y,
		int	x2,
		int	y2,
		vtkUnsignedCharArray *	data,
		int	front,
		int	blend = `0`
	)			`[pure virtual]`

Same as Get/SetPixelData except that the image also contains an alpha component. The image is transmitted as RGBARGBARGBA... each of which is a float value. The "blend" parameter controls whether the SetRGBAPixelData method blends the data with the previous contents of the frame buffer or completely replaces the frame buffer data.

Implemented in vtkMesaRenderWindow, and vtkOpenGLRenderWindow.

virtual float* vtkRenderWindow::GetZbufferData	(	int	x,
		int	y,
		int	x2,
		int	y2
	)			`[pure virtual]`