VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkRenderWindow Class Referenceabstract

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

#include <vtkRenderWindow.h>

Inheritance diagram for vtkRenderWindow:
[legend]
Collaboration diagram for vtkRenderWindow:
[legend]

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...
 
vtkRenderWindowNewInstance () 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 vtkRenderWindowInteractorMakeRenderWindowInteractor ()
 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 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 intGetAnaglyphColorMask ()
 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 floatGetRGBAPixelData (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 floatGetZbufferData (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 vtkRenderWindowInteractorGetInteractor ()
 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 vtkRenderWindowGetSharedRenderWindow ()
 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
vtkWindowNewInstance () const
 
intGetActualSize ()
 GetSize() returns the size * this->TileScale, whereas this method returns the size without multiplying with the tile scale. More...
 
virtual intGetScreenSize ()=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...
 
vtkTypeBool GetOffScreenRendering ()
 Deprecated, directly use GetShowWindow and GetOffScreenBuffers instead. More...
 
virtual intGetPosition ()
 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 intGetSize ()
 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 vtkTypeBool GetMapped ()
 Keep track of whether the rendering window has been mapped to screen. More...
 
virtual bool GetShowWindow ()
 Show or not Show the window. More...
 
virtual void SetShowWindow (bool)
 Show or not Show the window. More...
 
virtual void ShowWindowOn ()
 Show or not Show the window. More...
 
virtual void ShowWindowOff ()
 Show or not Show the window. More...
 
virtual void SetUseOffScreenBuffers (bool)
 Render to an offscreen destination such as a framebuffer. More...
 
virtual bool GetUseOffScreenBuffers ()
 Render to an offscreen destination such as a framebuffer. More...
 
virtual void UseOffScreenBuffersOn ()
 Render to an offscreen destination such as a framebuffer. More...
 
virtual void UseOffScreenBuffersOff ()
 Render to an offscreen destination such as a framebuffer. 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...
 
void SetOffScreenRendering (vtkTypeBool val)
 Convenience to set SHowWindow and UseOffScreenBuffers in one call. More...
 
virtual void OffScreenRenderingOn ()
 Convenience to set SHowWindow and UseOffScreenBuffers in one call. More...
 
virtual void OffScreenRenderingOff ()
 Convenience to set SHowWindow and UseOffScreenBuffers in one call. 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 intGetTileScale ()
 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 doubleGetTileViewport ()
 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...
 
vtkCommandGetCommand (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 vtkRenderWindowSafeDownCast (vtkObjectBase *o)
 
static vtkRenderWindowNew ()
 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 vtkWindowSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

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

vtkRendererCollectionRenderers
 
vtkNew< vtkRenderTimerLogRenderTimer
 
vtkTypeBool Borders
 
vtkTypeBool FullScreen
 
int OldScreen [5]
 
vtkTypeBool PointSmoothing
 
vtkTypeBool LineSmoothing
 
vtkTypeBool PolygonSmoothing
 
vtkTypeBool StereoRender
 
int StereoType
 
vtkTypeBool StereoCapableWindow
 
vtkTypeBool AlphaBitPlanes
 
vtkRenderWindowInteractorInteractor
 
unsigned char * StereoBuffer
 
floatAccumulationBuffer
 
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...
 
vtkRenderWindowSharedRenderWindow
 
- Protected Attributes inherited from vtkWindow
char * WindowName
 
int Size [2]
 
int Position [2]
 
vtkTypeBool Mapped
 
bool ShowWindow
 
bool UseOffScreenBuffers
 
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

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
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
virtual void vtkRenderWindow::Finalize ( )
pure virtual
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, vtkXOpenGLRenderWindow, vtkEGLRenderWindow, vtkOSOpenGLRenderWindow, 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
virtual int vtkRenderWindow::GetCurrentCursor ( )
virtual

Change the shape of the cursor.

virtual void vtkRenderWindow::SetFullScreen ( vtkTypeBool  )
pure virtual
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, vtkXOpenGLRenderWindow, vtkOSOpenGLRenderWindow, 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.

Default is off. This must be applied before the first Render.

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

Turn on/off line smoothing.

Default is off. This must be applied before the first Render.

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

Turn on/off polygon smoothing.

Default is off. This must be applied before the first Render.

virtual vtkTypeBool 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. Fake simply causes the window to render twice without actually swapping the camera from left eye to right eye. This is useful in certain applications that want to emulate the rendering passes without actually rendering in stereo mode.

void vtkRenderWindow::SetStereoType ( int  )

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. Fake simply causes the window to render twice without actually swapping the camera from left eye to right eye. This is useful in certain applications that want to emulate the rendering passes without actually rendering in stereo mode.

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. Fake simply causes the window to render twice without actually swapping the camera from left eye to right eye. This is useful in certain applications that want to emulate the rendering passes without actually rendering in stereo mode.

Definition at line 311 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. Fake simply causes the window to render twice without actually swapping the camera from left eye to right eye. This is useful in certain applications that want to emulate the rendering passes without actually rendering in stereo mode.

Definition at line 313 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. Fake simply causes the window to render twice without actually swapping the camera from left eye to right eye. This is useful in certain applications that want to emulate the rendering passes without actually rendering in stereo mode.

Definition at line 315 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. Fake simply causes the window to render twice without actually swapping the camera from left eye to right eye. This is useful in certain applications that want to emulate the rendering passes without actually rendering in stereo mode.

Definition at line 317 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. Fake simply causes the window to render twice without actually swapping the camera from left eye to right eye. This is useful in certain applications that want to emulate the rendering passes without actually rendering in stereo mode.

Definition at line 319 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. Fake simply causes the window to render twice without actually swapping the camera from left eye to right eye. This is useful in certain applications that want to emulate the rendering passes without actually rendering in stereo mode.

Definition at line 321 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. Fake simply causes the window to render twice without actually swapping the camera from left eye to right eye. This is useful in certain applications that want to emulate the rendering passes without actually rendering in stereo mode.

Definition at line 323 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. Fake simply causes the window to render twice without actually swapping the camera from left eye to right eye. This is useful in certain applications that want to emulate the rendering passes without actually rendering in stereo mode.

Definition at line 325 of file vtkRenderWindow.h.

void vtkRenderWindow::SetStereoTypeToSplitViewportHorizontal ( )
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. Fake simply causes the window to render twice without actually swapping the camera from left eye to right eye. This is useful in certain applications that want to emulate the rendering passes without actually rendering in stereo mode.

Definition at line 327 of file vtkRenderWindow.h.

void vtkRenderWindow::SetStereoTypeToFake ( )
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. Fake simply causes the window to render twice without actually swapping the camera from left eye to right eye. This is useful in certain applications that want to emulate the rendering passes without actually rendering in stereo mode.

Definition at line 329 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 vtkOpenGLRenderWindow, and vtkOpenVRRenderWindow.

virtual void vtkRenderWindow::StereoMidpoint ( )
virtual

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

Reimplemented in vtkOpenGLRenderWindow, and vtkOpenVRRenderWindow.

virtual void vtkRenderWindow::StereoRenderComplete ( )
virtual

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

Reimplemented in vtkOpenVRRenderWindow.

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

virtual void vtkRenderWindow::SetSwapBuffers ( vtkTypeBool  )
virtual

Turn on/off buffer swapping between images.

virtual vtkTypeBool 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,
int  right = 0 
)
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 vtkOpenGLRenderWindow.

virtual int vtkRenderWindow::SetPixelData ( int  x,
int  y,
int  x2,
int  y2,
vtkUnsignedCharArray data,
int  front,
int  right = 0 
)
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 vtkOpenGLRenderWindow.

virtual float* vtkRenderWindow::GetRGBAPixelData ( int  x,
int  y,
int  x2,
int  y2,
int  front,
int  right = 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 vtkOpenGLRenderWindow.

virtual int vtkRenderWindow::GetRGBAPixelData ( int  x,
int  y,
int  x2,
int  y2,
int  front,
vtkFloatArray data,
int  right = 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 vtkOpenGLRenderWindow.

virtual int vtkRenderWindow::SetRGBAPixelData ( int  x,
int  y,
int  x2,
int  y2,
float ,
int  front,
int  blend = 0,
int  right = 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 vtkOpenGLRenderWindow.

virtual int vtkRenderWindow::SetRGBAPixelData ( int  ,
int  ,
int  ,
int  ,
vtkFloatArray ,
int  ,
int  blend = 0,
int  right = 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 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 vtkOpenGLRenderWindow.

virtual unsigned char* vtkRenderWindow::GetRGBACharPixelData ( int  x,
int  y,
int  x2,
int  y2,
int  front,
int  right = 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 vtkOpenGLRenderWindow.

virtual int vtkRenderWindow::GetRGBACharPixelData ( int  x,
int  y,
int  x2,
int  y2,
int  front,
vtkUnsignedCharArray data,
int  right = 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 vtkOpenGLRenderWindow.

virtual int vtkRenderWindow::SetRGBACharPixelData ( int  x,
int  y,
int  x2,
int  y2,
unsigned char *  data,
int  front,
int  blend = 0,
int  right = 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 vtkOpenGLRenderWindow.

virtual int vtkRenderWindow::SetRGBACharPixelData ( int  x,
int  y,
int  x2,
int  y2,
vtkUnsignedCharArray data,
int  front,
int  blend = 0,
int  right = 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 vtkOpenGLRenderWindow.

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

Set/Get the zbuffer data from the frame buffer.

(x,y) is any corner of the rectangle. (x2,y2) is its opposite corner on the diagonal.

Implemented in vtkOpenGLRenderWindow.

virtual int vtkRenderWindow::GetZbufferData ( int  x,
int  y,
int  x2,
int  y2,
float z 
)
pure virtual

Set/Get the zbuffer data from the frame buffer.

(x,y) is any corner of the rectangle. (x2,y2) is its opposite corner on the diagonal.

Implemented in vtkOpenGLRenderWindow.

virtual int vtkRenderWindow::GetZbufferData ( int  x,
int  y,
int  x2,
int  y2,
vtkFloatArray z 
)
pure virtual

Set/Get the zbuffer data from the frame buffer.

(x,y) is any corner of the rectangle. (x2,y2) is its opposite corner on the diagonal.

Implemented in vtkOpenGLRenderWindow.

virtual int vtkRenderWindow::SetZbufferData ( int  x,
int  y,
int  x2,
int  y2,
float z 
)
pure virtual

Set/Get the zbuffer data from the frame buffer.

(x,y) is any corner of the rectangle. (x2,y2) is its opposite corner on the diagonal.

Implemented in vtkOpenGLRenderWindow.

virtual int vtkRenderWindow::SetZbufferData ( int  x,
int  y,
int  x2,
int  y2,
vtkFloatArray z 
)
pure virtual

Set/Get the zbuffer data from the frame buffer.

(x,y) is any corner of the rectangle. (x2,y2) is its opposite corner on the diagonal.

Implemented in vtkOpenGLRenderWindow.

float vtkRenderWindow::GetZbufferDataAtPoint ( int  x,
int  y 
)
inline

Set/Get the zbuffer data from the frame buffer.

(x,y) is any corner of the rectangle. (x2,y2) is its opposite corner on the diagonal.

Definition at line 460 of file vtkRenderWindow.h.

virtual int vtkRenderWindow::GetNeverRendered ( )
virtual

This flag is set if the window hasn't rendered since it was created.

virtual int vtkRenderWindow::GetAbortRender ( )
virtual

This is a flag that can be set to interrupt a rendering that is in progress.

virtual void vtkRenderWindow::SetAbortRender ( int  )
virtual

This is a flag that can be set to interrupt a rendering that is in progress.

virtual int vtkRenderWindow::GetInAbortCheck ( )
virtual

This is a flag that can be set to interrupt a rendering that is in progress.

virtual void vtkRenderWindow::SetInAbortCheck ( int  )
virtual

This is a flag that can be set to interrupt a rendering that is in progress.

virtual int vtkRenderWindow::CheckAbortStatus ( )
virtual

This is a flag that can be set to interrupt a rendering that is in progress.

virtual vtkTypeBool vtkRenderWindow::GetIsPicking ( )
virtual
virtual void vtkRenderWindow::SetIsPicking ( vtkTypeBool  )
virtual

Reimplemented in vtkGenericOpenGLRenderWindow.

virtual void vtkRenderWindow::IsPickingOn ( )
virtual
virtual void vtkRenderWindow::IsPickingOff ( )
virtual
virtual int vtkRenderWindow::GetEventPending ( )
pure virtual

Check to see if a mouse button has been pressed.

All other events are ignored by this method. Ideally, you want to abort the render on any event which causes the DesiredUpdateRate to switch from a high-quality rate to a more interactive rate.

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

virtual int vtkRenderWindow::CheckInRenderStatus ( )
inlinevirtual

Are we rendering at the moment.

Definition at line 502 of file vtkRenderWindow.h.

virtual void vtkRenderWindow::ClearInRenderStatus ( )
inlinevirtual

Clear status (after an exception was thrown for example)

Definition at line 507 of file vtkRenderWindow.h.

virtual void vtkRenderWindow::SetDesiredUpdateRate ( double  )
virtual

Set/Get the desired update rate.

This is used with the vtkLODActor class. When using level of detail actors you need to specify what update rate you require. The LODActors then will pick the correct resolution to meet your desired update rate in frames per second. A value of zero indicates that they can use all the time they want to.

virtual double vtkRenderWindow::GetDesiredUpdateRate ( )
virtual

Set/Get the desired update rate.

This is used with the vtkLODActor class. When using level of detail actors you need to specify what update rate you require. The LODActors then will pick the correct resolution to meet your desired update rate in frames per second. A value of zero indicates that they can use all the time they want to.

virtual int vtkRenderWindow::GetNumberOfLayers ( )
virtual

Get the number of layers for renderers.

Each renderer should have its layer set individually. Some algorithms iterate through all layers, so it is not wise to set the number of layers to be exorbitantly large (say bigger than 100).

virtual void vtkRenderWindow::SetNumberOfLayers ( int  )
virtual

Get the number of layers for renderers.

Each renderer should have its layer set individually. Some algorithms iterate through all layers, so it is not wise to set the number of layers to be exorbitantly large (say bigger than 100).

virtual vtkRenderWindowInteractor* vtkRenderWindow::GetInteractor ( )
virtual

Get the interactor associated with this render window.

void vtkRenderWindow::SetInteractor ( vtkRenderWindowInteractor )

Set the interactor to the render window.

void vtkRenderWindow::UnRegister ( vtkObjectBase o)
overridevirtual

This Method detects loops of RenderWindow<->Interactor, so objects are freed properly.

Reimplemented from vtkObjectBase.

void vtkRenderWindow::SetDisplayId ( void *  )
overridepure virtual
void vtkRenderWindow::SetWindowId ( void *  )
overridepure virtual
virtual void vtkRenderWindow::SetNextWindowId ( void *  )
pure virtual
void vtkRenderWindow::SetParentId ( void *  )
overridepure virtual
void* vtkRenderWindow::GetGenericDisplayId ( )
overridepure virtual
void* vtkRenderWindow::GetGenericWindowId ( )
overridepure virtual
void* vtkRenderWindow::GetGenericParentId ( )
overridepure virtual
void* vtkRenderWindow::GetGenericContext ( )
overridepure virtual
void* vtkRenderWindow::GetGenericDrawable ( )
overridepure virtual
void vtkRenderWindow::SetWindowInfo ( const char *  )
overridepure virtual
virtual void vtkRenderWindow::SetNextWindowInfo ( const char *  )
pure virtual
void vtkRenderWindow::SetParentInfo ( const char *  )
overridepure virtual
virtual bool vtkRenderWindow::InitializeFromCurrentContext ( )
inlinevirtual

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

Reimplemented in vtkOpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkCocoaRenderWindow, vtkIOSRenderWindow, and vtkWin32OpenGLRenderWindow.

Definition at line 573 of file vtkRenderWindow.h.

virtual void vtkRenderWindow::SetSharedRenderWindow ( vtkRenderWindow )
virtual

Set/Get an already existing window that this window should share data with if possible.

This must be set after the shared render window has been created and initialized but before this window has been initialized. Not all platforms support data sharing.

virtual vtkRenderWindow* vtkRenderWindow::GetSharedRenderWindow ( )
virtual

Set/Get an already existing window that this window should share data with if possible.

This must be set after the shared render window has been created and initialized but before this window has been initialized. Not all platforms support data sharing.

virtual bool vtkRenderWindow::GetPlatformSupportsRenderWindowSharing ( )
inlinevirtual

Set/Get an already existing window that this window should share data with if possible.

This must be set after the shared render window has been created and initialized but before this window has been initialized. Not all platforms support data sharing.

Reimplemented in vtkXOpenGLRenderWindow, vtkCocoaRenderWindow, and vtkWin32OpenGLRenderWindow.

Definition at line 585 of file vtkRenderWindow.h.

void vtkRenderWindow::MakeCurrent ( )
overridepure virtual

Attempt to make this window the current graphics context for the calling thread.

Reimplemented from vtkWindow.

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

virtual bool vtkRenderWindow::IsCurrent ( )
pure virtual
virtual bool vtkRenderWindow::IsDrawable ( )
inlinevirtual

Test if the window has a valid drawable.

This is currently only an issue on Mac OS X Cocoa where rendering to an invalid drawable results in all OpenGL calls to fail with "invalid framebuffer operation".

Reimplemented in vtkCocoaRenderWindow, and vtkIOSRenderWindow.

Definition at line 606 of file vtkRenderWindow.h.

virtual void vtkRenderWindow::SetForceMakeCurrent ( )
inlinevirtual

If called, allow MakeCurrent() to skip cache-check when called.

MakeCurrent() reverts to original behavior of cache-checking on the next render.

Reimplemented in vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkXOpenGLRenderWindow, and vtkOSOpenGLRenderWindow.

Definition at line 613 of file vtkRenderWindow.h.

virtual const char* vtkRenderWindow::ReportCapabilities ( )
inlinevirtual

Get report of capabilities for the render window.

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

Definition at line 618 of file vtkRenderWindow.h.

virtual int vtkRenderWindow::SupportsOpenGL ( )
inlinevirtual

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

Reimplemented in vtkOpenVRRenderWindow, vtkOpenGLRenderWindow, vtkIOSRenderWindow, vtkOSOpenGLRenderWindow, and vtkGenericOpenGLRenderWindow.

Definition at line 623 of file vtkRenderWindow.h.

virtual int vtkRenderWindow::IsDirect ( )
inlinevirtual

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

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

Definition at line 628 of file vtkRenderWindow.h.

virtual int vtkRenderWindow::GetDepthBufferSize ( )
pure virtual

This method should be defined by the subclass.

How many bits of precision are there in the zbuffer?

Implemented in vtkIOSRenderWindow, and vtkOpenGLRenderWindow.

virtual int vtkRenderWindow::GetColorBufferSizes ( int rgba)
pure virtual

Get the size of the color buffer.

Returns 0 if not able to determine otherwise sets R G B and A into buffer.

Implemented in vtkOpenGLRenderWindow.

virtual void vtkRenderWindow::SetMultiSamples ( int  )
virtual

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

virtual int vtkRenderWindow::GetMultiSamples ( )
virtual

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

virtual void vtkRenderWindow::SetStencilCapable ( vtkTypeBool  )
virtual

Set / Get the availability of the stencil buffer.

virtual vtkTypeBool vtkRenderWindow::GetStencilCapable ( )
virtual

Set / Get the availability of the stencil buffer.

virtual void vtkRenderWindow::StencilCapableOn ( )
virtual

Set / Get the availability of the stencil buffer.

virtual void vtkRenderWindow::StencilCapableOff ( )
virtual

Set / Get the availability of the stencil buffer.

virtual void vtkRenderWindow::SetDeviceIndex ( int  )
virtual

If there are several graphics card installed on a system, this index can be used to specify which card you want to render to.

the default is 0. This may not work on all derived render window and it may need to be set before the first render.

virtual int vtkRenderWindow::GetDeviceIndex ( )
virtual

If there are several graphics card installed on a system, this index can be used to specify which card you want to render to.

the default is 0. This may not work on all derived render window and it may need to be set before the first render.

virtual int vtkRenderWindow::GetNumberOfDevices ( )
inlinevirtual

Returns the number of devices (graphics cards) on a system.

This may not work on all derived render windows.

Reimplemented in vtkEGLRenderWindow.

Definition at line 673 of file vtkRenderWindow.h.

virtual bool vtkRenderWindow::GetUseSRGBColorSpace ( )
virtual

Set/Get if we want this window to use the sRGB color space.

Some hardware/drivers do not fully support this.

virtual void vtkRenderWindow::SetUseSRGBColorSpace ( bool  )
virtual

Set/Get if we want this window to use the sRGB color space.

Some hardware/drivers do not fully support this.

virtual void vtkRenderWindow::UseSRGBColorSpaceOn ( )
virtual

Set/Get if we want this window to use the sRGB color space.

Some hardware/drivers do not fully support this.

virtual void vtkRenderWindow::UseSRGBColorSpaceOff ( )
virtual

Set/Get if we want this window to use the sRGB color space.

Some hardware/drivers do not fully support this.

virtual void vtkRenderWindow::DoStereoRender ( )
protectedvirtual

Member Data Documentation

vtkRendererCollection* vtkRenderWindow::Renderers
protected

Definition at line 694 of file vtkRenderWindow.h.

vtkNew<vtkRenderTimerLog> vtkRenderWindow::RenderTimer
protected

Definition at line 695 of file vtkRenderWindow.h.

vtkTypeBool vtkRenderWindow::Borders
protected

Definition at line 696 of file vtkRenderWindow.h.

vtkTypeBool vtkRenderWindow::FullScreen
protected

Definition at line 697 of file vtkRenderWindow.h.

int vtkRenderWindow::OldScreen[5]
protected

Definition at line 698 of file vtkRenderWindow.h.

vtkTypeBool vtkRenderWindow::PointSmoothing
protected

Definition at line 699 of file vtkRenderWindow.h.

vtkTypeBool vtkRenderWindow::LineSmoothing
protected

Definition at line 700 of file vtkRenderWindow.h.

vtkTypeBool vtkRenderWindow::PolygonSmoothing
protected

Definition at line 701 of file vtkRenderWindow.h.

vtkTypeBool vtkRenderWindow::StereoRender
protected

Definition at line 702 of file vtkRenderWindow.h.

int vtkRenderWindow::StereoType
protected

Definition at line 703 of file vtkRenderWindow.h.

vtkTypeBool vtkRenderWindow::StereoCapableWindow
protected

Definition at line 704 of file vtkRenderWindow.h.

vtkTypeBool vtkRenderWindow::AlphaBitPlanes
protected

Definition at line 705 of file vtkRenderWindow.h.

vtkRenderWindowInteractor* vtkRenderWindow::Interactor
protected

Definition at line 706 of file vtkRenderWindow.h.

unsigned char* vtkRenderWindow::StereoBuffer
protected

Definition at line 707 of file vtkRenderWindow.h.

float* vtkRenderWindow::AccumulationBuffer
protected

Definition at line 708 of file vtkRenderWindow.h.

unsigned int vtkRenderWindow::AccumulationBufferSize
protected

Definition at line 709 of file vtkRenderWindow.h.

unsigned char* vtkRenderWindow::ResultFrame
protected

Definition at line 710 of file vtkRenderWindow.h.

vtkTypeBool vtkRenderWindow::SwapBuffers
protected

Definition at line 711 of file vtkRenderWindow.h.

double vtkRenderWindow::DesiredUpdateRate
protected

Definition at line 712 of file vtkRenderWindow.h.

int vtkRenderWindow::AbortRender
protected

Definition at line 713 of file vtkRenderWindow.h.

int vtkRenderWindow::InAbortCheck
protected

Definition at line 714 of file vtkRenderWindow.h.

int vtkRenderWindow::InRender
protected

Definition at line 715 of file vtkRenderWindow.h.

int vtkRenderWindow::NeverRendered
protected

Definition at line 716 of file vtkRenderWindow.h.

int vtkRenderWindow::NumberOfLayers
protected

Definition at line 717 of file vtkRenderWindow.h.

int vtkRenderWindow::CurrentCursor
protected

Definition at line 718 of file vtkRenderWindow.h.

vtkTypeBool vtkRenderWindow::IsPicking
protected

Definition at line 719 of file vtkRenderWindow.h.

float vtkRenderWindow::AnaglyphColorSaturation
protected

Definition at line 720 of file vtkRenderWindow.h.

int vtkRenderWindow::AnaglyphColorMask[2]
protected

Definition at line 721 of file vtkRenderWindow.h.

int vtkRenderWindow::MultiSamples
protected

Definition at line 722 of file vtkRenderWindow.h.

vtkTypeBool vtkRenderWindow::StencilCapable
protected

Definition at line 723 of file vtkRenderWindow.h.

int vtkRenderWindow::CapturingGL2PSSpecialProps
protected

Definition at line 724 of file vtkRenderWindow.h.

int vtkRenderWindow::DeviceIndex
protected

Definition at line 725 of file vtkRenderWindow.h.

bool vtkRenderWindow::UseSRGBColorSpace
protected

Definition at line 727 of file vtkRenderWindow.h.

double vtkRenderWindow::AbortCheckTime
protected

The universal time since the last abort check occurred.

Definition at line 732 of file vtkRenderWindow.h.

vtkRenderWindow* vtkRenderWindow::SharedRenderWindow
protected

Definition at line 734 of file vtkRenderWindow.h.


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