create a window for renderers to draw into More...

#include <vtkRenderWindow.h>

Inheritance diagram for vtkRenderWindow:

Collaboration diagram for vtkRenderWindow:

Public Types
typedef vtkWindow	Superclass

Public Types inherited from vtkWindow
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkRenderWindow *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	AddRenderer (vtkRenderer *)
	Add a renderer to the list of renderers. More...

void	RemoveRenderer (vtkRenderer *)
	Remove a renderer from the list of renderers. More...

int	HasRenderer (vtkRenderer *)
	Query if a renderer is in the list of renderers. More...

virtual const char *	GetRenderingBackend ()
	What rendering backend has the user requested. More...

	vtkGetNewMacro (RenderTimer, vtkRenderTimerLog) vtkRendererCollection *GetRenderers()
	Get the render timer log for this window. More...

void	CaptureGL2PSSpecialProps (vtkCollection *specialProps)
	The GL2PS exporter must handle certain props in a special way (e.g. More...

void	Render () override
	Ask each renderer owned by this RenderWindow to render its image and synchronize this process. More...

virtual void	Start ()=0
	Initialize the rendering process. More...

virtual void	Finalize ()=0
	Finalize the rendering process. More...

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

virtual void	WaitForCompletion ()=0
	Block the thread until the actual rendering is finished(). More...

virtual void	CopyResultFrame ()
	Performed at the end of the rendering process to generate image. More...

virtual vtkRenderWindowInteractor *	MakeRenderWindowInteractor ()
	Create an interactor to control renderers in this window. More...

const char *	GetStereoTypeAsString ()

virtual void	StereoUpdate ()
	Update the system, if needed, due to stereo rendering. More...

virtual void	StereoMidpoint ()
	Intermediate method performs operations required between the rendering of the left and right eye. More...

virtual void	StereoRenderComplete ()
	Handles work required once both views have been rendered when using stereo rendering. More...

virtual void	WindowRemap ()=0
	Remap the rendering window. More...

virtual vtkTypeBool	GetIsPicking ()

virtual void	SetIsPicking (vtkTypeBool)

virtual void	IsPickingOn ()

virtual void	IsPickingOff ()

virtual int	GetEventPending ()=0
	Check to see if a mouse button has been pressed. More...

virtual int	CheckInRenderStatus ()
	Are we rendering at the moment. More...

virtual void	ClearInRenderStatus ()
	Clear status (after an exception was thrown for example) More...

void	SetInteractor (vtkRenderWindowInteractor *)
	Set the interactor to the render window. More...

void	UnRegister (vtkObjectBase *o) override
	This Method detects loops of RenderWindow<->Interactor, so objects are freed properly. More...

virtual bool	InitializeFromCurrentContext ()
	Initialize the render window from the information associated with the currently activated OpenGL context. More...

void	MakeCurrent () override=0
	Attempt to make this window the current graphics context for the calling thread. More...

virtual bool	IsCurrent ()=0
	Tells if this window is the current graphics context for the calling thread. More...

virtual bool	IsDrawable ()
	Test if the window has a valid drawable. More...

virtual void	SetForceMakeCurrent ()
	If called, allow MakeCurrent() to skip cache-check when called. More...

virtual const char *	ReportCapabilities ()
	Get report of capabilities for the render window. More...

virtual int	SupportsOpenGL ()
	Does this render window support OpenGL? 0-false, 1-true. More...

virtual int	IsDirect ()
	Is this render window using hardware acceleration? 0-false, 1-true. More...

virtual int	GetDepthBufferSize ()=0
	This method should be defined by the subclass. More...

virtual int	GetColorBufferSizes (int *rgba)=0
	Get the size of the color buffer. More...

virtual int	GetNumberOfDevices ()
	Returns the number of devices (graphics cards) on a system. More...

virtual int	SetUseOffScreenBuffers (bool)
	Create and bind offscreen rendering buffers without destroying the current OpenGL context. More...

virtual bool	GetUseOffScreenBuffers ()


virtual int	GetCapturingGL2PSSpecialProps ()
	Returns true if the render process is capturing text actors. More...


virtual void	HideCursor ()=0
	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. More...

virtual void	ShowCursor ()=0
	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. More...

virtual void	SetCursorPosition (int, int)
	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. More...


virtual void	SetCurrentCursor (int)
	Change the shape of the cursor. More...

virtual int	GetCurrentCursor ()
	Change the shape of the cursor. More...


virtual void	SetFullScreen (vtkTypeBool)=0
	Turn on/off rendering full screen window size. More...

virtual vtkTypeBool	GetFullScreen ()
	Turn on/off rendering full screen window size. More...

virtual void	FullScreenOn ()
	Turn on/off rendering full screen window size. More...

virtual void	FullScreenOff ()
	Turn on/off rendering full screen window size. More...


virtual void	SetBorders (vtkTypeBool)
	Turn on/off window manager borders. More...

virtual vtkTypeBool	GetBorders ()
	Turn on/off window manager borders. More...

virtual void	BordersOn ()
	Turn on/off window manager borders. More...

virtual void	BordersOff ()
	Turn on/off window manager borders. More...


virtual vtkTypeBool	GetStereoCapableWindow ()
	Prescribe that the window be created in a stereo-capable mode. More...

virtual void	StereoCapableWindowOn ()
	Prescribe that the window be created in a stereo-capable mode. More...

virtual void	StereoCapableWindowOff ()
	Prescribe that the window be created in a stereo-capable mode. More...

virtual void	SetStereoCapableWindow (vtkTypeBool capable)
	Prescribe that the window be created in a stereo-capable mode. More...


virtual vtkTypeBool	GetStereoRender ()
	Turn on/off stereo rendering. More...

void	SetStereoRender (vtkTypeBool stereo)
	Turn on/off stereo rendering. More...

virtual void	StereoRenderOn ()
	Turn on/off stereo rendering. More...

virtual void	StereoRenderOff ()
	Turn on/off stereo rendering. More...


virtual void	SetAlphaBitPlanes (vtkTypeBool)
	Turn on/off the use of alpha bitplanes. More...

virtual vtkTypeBool	GetAlphaBitPlanes ()
	Turn on/off the use of alpha bitplanes. More...

virtual void	AlphaBitPlanesOn ()
	Turn on/off the use of alpha bitplanes. More...

virtual void	AlphaBitPlanesOff ()
	Turn on/off the use of alpha bitplanes. More...


virtual void	SetPointSmoothing (vtkTypeBool)
	Turn on/off point smoothing. More...

virtual vtkTypeBool	GetPointSmoothing ()
	Turn on/off point smoothing. More...

virtual void	PointSmoothingOn ()
	Turn on/off point smoothing. More...

virtual void	PointSmoothingOff ()
	Turn on/off point smoothing. More...


virtual void	SetLineSmoothing (vtkTypeBool)
	Turn on/off line smoothing. More...

virtual vtkTypeBool	GetLineSmoothing ()
	Turn on/off line smoothing. More...

virtual void	LineSmoothingOn ()
	Turn on/off line smoothing. More...

virtual void	LineSmoothingOff ()
	Turn on/off line smoothing. More...


virtual void	SetPolygonSmoothing (vtkTypeBool)
	Turn on/off polygon smoothing. More...

virtual vtkTypeBool	GetPolygonSmoothing ()
	Turn on/off polygon smoothing. More...

virtual void	PolygonSmoothingOn ()
	Turn on/off polygon smoothing. More...

virtual void	PolygonSmoothingOff ()
	Turn on/off polygon smoothing. More...


virtual int	GetStereoType ()
	Set/Get what type of stereo rendering to use. More...

void	SetStereoType (int)
	Set/Get what type of stereo rendering to use. More...

void	SetStereoTypeToCrystalEyes ()
	Set/Get what type of stereo rendering to use. More...

void	SetStereoTypeToRedBlue ()
	Set/Get what type of stereo rendering to use. More...

void	SetStereoTypeToInterlaced ()
	Set/Get what type of stereo rendering to use. More...

void	SetStereoTypeToLeft ()
	Set/Get what type of stereo rendering to use. More...

void	SetStereoTypeToRight ()
	Set/Get what type of stereo rendering to use. More...

void	SetStereoTypeToDresden ()
	Set/Get what type of stereo rendering to use. More...

void	SetStereoTypeToAnaglyph ()
	Set/Get what type of stereo rendering to use. More...

void	SetStereoTypeToCheckerboard ()
	Set/Get what type of stereo rendering to use. More...

void	SetStereoTypeToSplitViewportHorizontal ()
	Set/Get what type of stereo rendering to use. More...

void	SetStereoTypeToFake ()
	Set/Get what type of stereo rendering to use. More...


virtual void	SetAnaglyphColorSaturation (float)
	Set/get the anaglyph color saturation factor. More...

virtual float	GetAnaglyphColorSaturation ()
	Set/get the anaglyph color saturation factor. More...


virtual void	SetAnaglyphColorMask (int, int)
	Set/get the anaglyph color mask values. More...

void	SetAnaglyphColorMask (int[2])
	Set/get the anaglyph color mask values. More...

virtual int *	GetAnaglyphColorMask ()
	Set/get the anaglyph color mask values. More...

virtual void	GetAnaglyphColorMask (int data[2])
	Set/get the anaglyph color mask values. More...


virtual void	SetSwapBuffers (vtkTypeBool)
	Turn on/off buffer swapping between images. More...

virtual vtkTypeBool	GetSwapBuffers ()
	Turn on/off buffer swapping between images. More...

virtual void	SwapBuffersOn ()
	Turn on/off buffer swapping between images. More...

virtual void	SwapBuffersOff ()
	Turn on/off buffer swapping between images. More...


virtual int	SetPixelData (int x, int y, int x2, int y2, unsigned char *data, int front, int right=0)=0
	Set/Get the pixel data of an image, transmitted as RGBRGBRGB. More...

virtual int	SetPixelData (int x, int y, int x2, int y2, vtkUnsignedCharArray *data, int front, int right=0)=0
	Set/Get the pixel data of an image, transmitted as RGBRGBRGB. More...


virtual float *	GetRGBAPixelData (int x, int y, int x2, int y2, int front, int right=0)=0
	Same as Get/SetPixelData except that the image also contains an alpha component. More...

virtual int	GetRGBAPixelData (int x, int y, int x2, int y2, int front, vtkFloatArray *data, int right=0)=0
	Same as Get/SetPixelData except that the image also contains an alpha component. More...

virtual int	SetRGBAPixelData (int x, int y, int x2, int y2, float *, int front, int blend=0, int right=0)=0
	Same as Get/SetPixelData except that the image also contains an alpha component. More...

virtual int	SetRGBAPixelData (int, int, int, int, vtkFloatArray *, int, int blend=0, int right=0)=0
	Same as Get/SetPixelData except that the image also contains an alpha component. More...

virtual void	ReleaseRGBAPixelData (float *data)=0
	Same as Get/SetPixelData except that the image also contains an alpha component. More...

virtual unsigned char *	GetRGBACharPixelData (int x, int y, int x2, int y2, int front, int right=0)=0
	Same as Get/SetPixelData except that the image also contains an alpha component. More...

virtual int	GetRGBACharPixelData (int x, int y, int x2, int y2, int front, vtkUnsignedCharArray *data, int right=0)=0
	Same as Get/SetPixelData except that the image also contains an alpha component. More...

virtual int	SetRGBACharPixelData (int x, int y, int x2, int y2, unsigned char *data, int front, int blend=0, int right=0)=0
	Same as Get/SetPixelData except that the image also contains an alpha component. More...

virtual int	SetRGBACharPixelData (int x, int y, int x2, int y2, vtkUnsignedCharArray *data, int front, int blend=0, int right=0)=0
	Same as Get/SetPixelData except that the image also contains an alpha component. More...


virtual float *	GetZbufferData (int x, int y, int x2, int y2)=0
	Set/Get the zbuffer data from the frame buffer. More...

virtual int	GetZbufferData (int x, int y, int x2, int y2, float *z)=0
	Set/Get the zbuffer data from the frame buffer. More...

virtual int	GetZbufferData (int x, int y, int x2, int y2, vtkFloatArray *z)=0
	Set/Get the zbuffer data from the frame buffer. More...

virtual int	SetZbufferData (int x, int y, int x2, int y2, float *z)=0
	Set/Get the zbuffer data from the frame buffer. More...

virtual int	SetZbufferData (int x, int y, int x2, int y2, vtkFloatArray *z)=0
	Set/Get the zbuffer data from the frame buffer. More...

float	GetZbufferDataAtPoint (int x, int y)
	Set/Get the zbuffer data from the frame buffer. More...


virtual int	GetNeverRendered ()
	This flag is set if the window hasn't rendered since it was created. More...


virtual int	GetAbortRender ()
	This is a flag that can be set to interrupt a rendering that is in progress. More...

virtual void	SetAbortRender (int)
	This is a flag that can be set to interrupt a rendering that is in progress. More...

virtual int	GetInAbortCheck ()
	This is a flag that can be set to interrupt a rendering that is in progress. More...

virtual void	SetInAbortCheck (int)
	This is a flag that can be set to interrupt a rendering that is in progress. More...

virtual int	CheckAbortStatus ()
	This is a flag that can be set to interrupt a rendering that is in progress. More...


virtual void	SetDesiredUpdateRate (double)
	Set/Get the desired update rate. More...

virtual double	GetDesiredUpdateRate ()
	Set/Get the desired update rate. More...


virtual int	GetNumberOfLayers ()
	Get the number of layers for renderers. More...

virtual void	SetNumberOfLayers (int)
	Get the number of layers for renderers. More...


virtual vtkRenderWindowInteractor *	GetInteractor ()
	Get the interactor associated with this render window. More...


void	SetDisplayId (void *) override=0
	Dummy stubs for vtkWindow API. More...

void	SetWindowId (void *) override=0
	Dummy stubs for vtkWindow API. More...

virtual void	SetNextWindowId (void *)=0
	Dummy stubs for vtkWindow API. More...

void	SetParentId (void *) override=0
	Dummy stubs for vtkWindow API. More...

void *	GetGenericDisplayId () override=0
	Dummy stubs for vtkWindow API. More...

void *	GetGenericWindowId () override=0
	Dummy stubs for vtkWindow API. More...

void *	GetGenericParentId () override=0
	Dummy stubs for vtkWindow API. More...

void *	GetGenericContext () override=0
	Dummy stubs for vtkWindow API. More...

void *	GetGenericDrawable () override=0
	Dummy stubs for vtkWindow API. More...

void	SetWindowInfo (const char *) override=0
	Dummy stubs for vtkWindow API. More...

virtual void	SetNextWindowInfo (const char *)=0
	Dummy stubs for vtkWindow API. More...

void	SetParentInfo (const char *) override=0
	Dummy stubs for vtkWindow API. More...


virtual void	SetSharedRenderWindow (vtkRenderWindow *)
	Set/Get an already existing window that this window should share data with if possible. More...

virtual vtkRenderWindow *	GetSharedRenderWindow ()
	Set/Get an already existing window that this window should share data with if possible. More...

virtual bool	GetPlatformSupportsRenderWindowSharing ()
	Set/Get an already existing window that this window should share data with if possible. More...


virtual void	SetMultiSamples (int)
	Set / Get the number of multisamples to use for hardware antialiasing. More...

virtual int	GetMultiSamples ()
	Set / Get the number of multisamples to use for hardware antialiasing. More...


virtual void	SetStencilCapable (vtkTypeBool)
	Set / Get the availability of the stencil buffer. More...

virtual vtkTypeBool	GetStencilCapable ()
	Set / Get the availability of the stencil buffer. More...

virtual void	StencilCapableOn ()
	Set / Get the availability of the stencil buffer. More...

virtual void	StencilCapableOff ()
	Set / Get the availability of the stencil buffer. More...


virtual void	SetDeviceIndex (int)
	If there are several graphics card installed on a system, this index can be used to specify which card you want to render to. More...

virtual int	GetDeviceIndex ()
	If there are several graphics card installed on a system, this index can be used to specify which card you want to render to. More...


virtual bool	GetUseSRGBColorSpace ()
	Set/Get if we want this window to use the sRGB color space. More...

virtual void	SetUseSRGBColorSpace (bool)
	Set/Get if we want this window to use the sRGB color space. More...

virtual void	UseSRGBColorSpaceOn ()
	Set/Get if we want this window to use the sRGB color space. More...

virtual void	UseSRGBColorSpaceOff ()
	Set/Get if we want this window to use the sRGB color space. More...

Public Member Functions inherited from vtkWindow
vtkWindow *	NewInstance () const

int *	GetActualSize ()
	GetSize() returns the size * this->TileScale, whereas this method returns the size without multiplying with the tile scale. More...

virtual int *	GetScreenSize ()=0
	Get the current size of the screen in pixels. More...

virtual bool	DetectDPI ()
	Attempt to detect and set the DPI of the display device by querying the system. More...

virtual int *	GetPosition ()
	Set/Get the position in screen coordinates of the rendering window. More...

virtual void	SetPosition (int, int)
	Set/Get the position in screen coordinates of the rendering window. More...

virtual void	SetPosition (int a[2])
	Set/Get the position in screen coordinates of the rendering window. More...

virtual int *	GetSize ()
	Set/Get the size of the window in screen coordinates in pixels. More...

virtual void	SetSize (int, int)
	Set/Get the size of the window in screen coordinates in pixels. More...

virtual void	SetSize (int a[2])
	Set/Get the size of the window in screen coordinates in pixels. More...

virtual void	SetMapped (vtkTypeBool)
	Keep track of whether the rendering window has been mapped to screen. More...

virtual vtkTypeBool	GetMapped ()
	Keep track of whether the rendering window has been mapped to screen. More...

virtual void	MappedOn ()
	Keep track of whether the rendering window has been mapped to screen. More...

virtual void	MappedOff ()
	Keep track of whether the rendering window has been mapped to screen. More...

virtual void	SetErase (vtkTypeBool)
	Turn on/off erasing the screen between images. More...

virtual vtkTypeBool	GetErase ()
	Turn on/off erasing the screen between images. More...

virtual void	EraseOn ()
	Turn on/off erasing the screen between images. More...

virtual void	EraseOff ()
	Turn on/off erasing the screen between images. More...

virtual void	SetDoubleBuffer (vtkTypeBool)
	Keep track of whether double buffering is on or off. More...

virtual vtkTypeBool	GetDoubleBuffer ()
	Keep track of whether double buffering is on or off. More...

virtual void	DoubleBufferOn ()
	Keep track of whether double buffering is on or off. More...

virtual void	DoubleBufferOff ()
	Keep track of whether double buffering is on or off. More...

virtual char *	GetWindowName ()
	Get name of rendering window. More...

virtual void	SetWindowName (const char *)
	Get name of rendering window. More...

virtual unsigned char *	GetPixelData (int x, int y, int x2, int y2, int front, int right=0)=0
	Get the pixel data of an image, transmitted as RGBRGBRGB. More...

virtual int	GetPixelData (int x, int y, int x2, int y2, int front, vtkUnsignedCharArray *data, int right=0)=0
	Get the pixel data of an image, transmitted as RGBRGBRGB. More...

virtual int	GetDPI ()
	Return a best estimate to the dots per inch of the display device being rendered (or printed). More...

virtual void	SetDPI (int)
	Return a best estimate to the dots per inch of the display device being rendered (or printed). More...

virtual void	SetOffScreenRendering (vtkTypeBool)
	Create a window in memory instead of on the screen. More...

virtual vtkTypeBool	GetOffScreenRendering ()
	Create a window in memory instead of on the screen. More...

virtual void	OffScreenRenderingOn ()
	Create a window in memory instead of on the screen. More...

virtual void	OffScreenRenderingOff ()
	Create a window in memory instead of on the screen. More...

virtual void	SetTileScale (int, int)
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...

void	SetTileScale (int[2])
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...

virtual int *	GetTileScale ()
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...

virtual void	GetTileScale (int &, int &)
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...

virtual void	GetTileScale (int[2])
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...

void	SetTileScale (int s)
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...

virtual void	SetTileViewport (double, double, double, double)
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...

virtual void	SetTileViewport (double[4])
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...

virtual double *	GetTileViewport ()
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...

virtual void	GetTileViewport (double &, double &, double &, double &)
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...

virtual void	GetTileViewport (double[4])
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkRenderWindow *	SafeDownCast (vtkObjectBase *o)

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

static const char *	GetRenderLibrary ()
	What rendering library has the user requested. More...

Static Public Member Functions inherited from vtkWindow
static vtkTypeBool	IsTypeOf (const char *type)

static vtkWindow *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkRenderWindow ()

	~vtkRenderWindow () override

virtual void	DoStereoRender ()

Protected Member Functions inherited from vtkWindow
	vtkWindow ()

	~vtkWindow () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkRendererCollection *	Renderers

vtkNew< vtkRenderTimerLog >	RenderTimer

vtkTypeBool	Borders

vtkTypeBool	FullScreen

int	OldScreen [5]

vtkTypeBool	PointSmoothing

vtkTypeBool	LineSmoothing

vtkTypeBool	PolygonSmoothing

vtkTypeBool	StereoRender

int	StereoType

vtkTypeBool	StereoCapableWindow

vtkTypeBool	AlphaBitPlanes

vtkRenderWindowInteractor *	Interactor

unsigned char *	StereoBuffer

float *	AccumulationBuffer

unsigned int	AccumulationBufferSize

unsigned char *	ResultFrame

vtkTypeBool	SwapBuffers

double	DesiredUpdateRate

int	AbortRender

int	InAbortCheck

int	InRender

int	NeverRendered

int	NumberOfLayers

int	CurrentCursor

vtkTypeBool	IsPicking

float	AnaglyphColorSaturation

int	AnaglyphColorMask [2]

int	MultiSamples

vtkTypeBool	StencilCapable

int	CapturingGL2PSSpecialProps

int	DeviceIndex

bool	UseSRGBColorSpace

double	AbortCheckTime
	The universal time since the last abort check occurred. More...

vtkRenderWindow *	SharedRenderWindow

Protected Attributes inherited from vtkWindow
vtkTypeBool	OffScreenRendering

char *	WindowName

int	Size [2]

int	Position [2]

vtkTypeBool	Mapped

vtkTypeBool	Erase

vtkTypeBool	DoubleBuffer

int	DPI

double	TileViewport [4]

int	TileSize [2]

int	TileScale [2]

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

Examples:: vtkRenderWindow (Examples)

Tests:: vtkRenderWindow (Tests)

Definition at line 87 of file vtkRenderWindow.h.

Member Typedef Documentation

typedef vtkWindow vtkRenderWindow::Superclass

Definition at line 90 of file vtkRenderWindow.h.

Constructor & Destructor Documentation

vtkRenderWindow::vtkRenderWindow ( )

protected

vtkRenderWindow::~vtkRenderWindow ( )

overrideprotected

Member Function Documentation

static vtkTypeBool vtkRenderWindow::IsTypeOf ( const char * type )

static

virtual vtkTypeBool 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 vtkOpenVRRenderWindow, vtkOpenGLRenderWindow, vtkExternalOpenGLRenderWindow, vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkEGLRenderWindow, vtkGenericOpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkXOpenGLRenderWindow, and vtkWin32OpenGLRenderWindow.

static vtkRenderWindow* vtkRenderWindow::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkRenderWindow::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkWindow.

Reimplemented in vtkOpenVRRenderWindow, vtkOpenGLRenderWindow, vtkExternalOpenGLRenderWindow, vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkEGLRenderWindow, vtkGenericOpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkXOpenGLRenderWindow, and vtkWin32OpenGLRenderWindow.

vtkRenderWindow* vtkRenderWindow::NewInstance ( ) const

void vtkRenderWindow::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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 vtkOpenVRRenderWindow, vtkOpenGLRenderWindow, vtkExternalOpenGLRenderWindow, vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkEGLRenderWindow, vtkGenericOpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkXOpenGLRenderWindow, and vtkWin32OpenGLRenderWindow.

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.

virtual void vtkRenderWindow::AddRenderer ( vtkRenderer * )

virtual

Add a renderer to the list of renderers.

Reimplemented in vtkOpenVRRenderWindow.

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.

virtual const char* vtkRenderWindow::GetRenderingBackend ( )

virtual

What rendering backend has the user requested.

Reimplemented in vtkOpenGLRenderWindow.

vtkRenderWindow::vtkGetNewMacro	(	RenderTimer	,
		vtkRenderTimerLog
	)

inline

Get the render timer log for this window.

Return the collection of renderers in the render window.

Definition at line 128 of file vtkRenderWindow.h.

void vtkRenderWindow::CaptureGL2PSSpecialProps ( vtkCollection * specialProps )

The GL2PS exporter must handle certain props in a special way (e.g.

text). This method performs a render and captures all "GL2PS-special" props in the specified collection. The collection will contain a vtkPropCollection for each vtkRenderer in this->GetRenderers(), each containing the special props rendered by the corresponding renderer.

virtual int vtkRenderWindow::GetCapturingGL2PSSpecialProps ( )

virtual

Returns true if the render process is capturing text actors.

void vtkRenderWindow::Render ( )

overridevirtual

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

Implements vtkWindow.

Reimplemented in vtkOpenGLRenderWindow, vtkOpenVRRenderWindow, vtkXOpenGLRenderWindow, vtkEGLRenderWindow, and vtkGenericOpenGLRenderWindow.

virtual void vtkRenderWindow::Start ( )

pure virtual

Initialize the rendering process.

Implemented in vtkOpenVRRenderWindow, vtkGenericOpenGLRenderWindow, vtkExternalOpenGLRenderWindow, vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkEGLRenderWindow, vtkOSOpenGLRenderWindow, vtkXOpenGLRenderWindow, and vtkWin32OpenGLRenderWindow.

virtual void vtkRenderWindow::Finalize ( )

pure virtual

Finalize the rendering process.

Implemented in vtkOpenVRRenderWindow, vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkEGLRenderWindow, vtkOSOpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, and vtkGenericOpenGLRenderWindow.

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 vtkOpenVRRenderWindow, vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkGenericOpenGLRenderWindow, vtkEGLRenderWindow, vtkOSOpenGLRenderWindow, vtkXOpenGLRenderWindow, and vtkWin32OpenGLRenderWindow.

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 vtkOpenVRRenderWindow, vtkIOSRenderWindow, vtkCocoaRenderWindow, vtkXOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkEGLRenderWindow, and vtkGenericOpenGLRenderWindow.

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 vtkOpenVRRenderWindow, vtkIOSRenderWindow, vtkCocoaRenderWindow, vtkXOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkEGLRenderWindow, and vtkGenericOpenGLRenderWindow.

virtual void vtkRenderWindow::SetCursorPosition	(	int	,
		int
	)

inlinevirtual

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 vtkIOSRenderWindow, vtkCocoaRenderWindow, and vtkWin32OpenGLRenderWindow.

Definition at line 201 of file vtkRenderWindow.h.

virtual void vtkRenderWindow::SetCurrentCursor ( int )

virtual

Change the shape of the cursor.

Reimplemented in vtkIOSRenderWindow, vtkCocoaRenderWindow, vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkOSOpenGLRenderWindow, and vtkGenericOpenGLRenderWindow.

virtual int vtkRenderWindow::GetCurrentCursor ( )

virtual

Change the shape of the cursor.

virtual void vtkRenderWindow::SetFullScreen ( vtkTypeBool )

pure virtual

Turn on/off rendering full screen window size.

Implemented in vtkOpenVRRenderWindow, vtkGenericOpenGLRenderWindow, vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkEGLRenderWindow, vtkOSOpenGLRenderWindow, vtkXOpenGLRenderWindow, and vtkWin32OpenGLRenderWindow.

virtual vtkTypeBool 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 ( vtkTypeBool )

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 vtkTypeBool 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 vtkTypeBool 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 ( vtkTypeBool 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 vtkWin32OpenGLRenderWindow, vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkOSOpenGLRenderWindow, vtkXOpenGLRenderWindow, and vtkEGLRenderWindow.

virtual vtkTypeBool vtkRenderWindow::GetStereoRender ( )

virtual

Turn on/off stereo rendering.

void vtkRenderWindow::SetStereoRender ( vtkTypeBool 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 ( vtkTypeBool )

virtual

Turn on/off the use of alpha bitplanes.

virtual vtkTypeBool 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 ( vtkTypeBool )

virtual

Turn on/off point smoothing.