#include <vtkAnariRenderWindow.h>

Detailed Description

Create a render window context for ANARI.

vtkAnariRenderWindow is a vtkRenderWindow in the ANARI context. This allows to use ANARI for rendering a 3D scene in VTK.

Warning: the class only supports offscreen rendering. This render window can be used with a vtkWindowToImageFilter to convert the rendered scene to an image.

Note: vtkAnariPass is still available for onscreen rendering. It however still requires OpenGL dependency.

See also: vtkAnariPass

Tests:: vtkAnariRenderWindow (Tests)

Definition at line 32 of file vtkAnariRenderWindow.h.

Inheritance diagram for vtkAnariRenderWindow:

[legend]

Collaboration diagram for vtkAnariRenderWindow:

[legend]

Public Types
typedef vtkRenderWindow	Superclass
Public Types inherited from vtkRenderWindow
enum	: vtkTypeUInt16 { PhysicalToWorldMatrixModified = vtkCommand::UserEvent + 200 }
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.
vtkAnariRenderWindow *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual vtkAnariDevice *	GetAnariDevice ()
	Return the AnariDevice contained by the render window.
virtual vtkAnariRenderer *	GetAnariRenderer ()
	Return the AnariRenderer contained by the render window.
Pixel query functions
Return a pixel buffer containing the pixel data in the region delimited by [x1,y1] to [x2,y2]. Warning It is to the caller responsibility to delete the returned buffer after usage. The unsigned char* return overrides return the pointer to the pixel data. If the color buffer query fails in any way, it returns a nullptr. The int return override returns VTK_OK if the pixel data were fetched properly, otherwise it returns VTK_ERROR.
unsigned char *	GetPixelData (int x1, int y1, int x2, int y2, int front, int right=0) override
	Functions that query RGB pixel image.
int	GetPixelData (int x1, int y1, int x2, int y2, int front, vtkUnsignedCharArray *data, int right=0) override
	Functions that query RGB pixel image.
unsigned char *	GetRGBACharPixelData (int x1, int y1, int x2, int y2, int front, int right=0) override
	Functions that query RGBA pixel image.
int	GetRGBACharPixelData (int x1, int y1, int x2, int y2, int front, vtkUnsignedCharArray *data, int right=0) override
	Functions that query RGB pixel image.
Public Member Functions inherited from vtkRenderWindow
vtkRenderWindow *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	AddRenderer (vtkRenderer *)
	Add a renderer to the list of renderers.
void	RemoveRenderer (vtkRenderer *)
	Remove a renderer from the list of renderers.
vtkTypeBool	HasRenderer (vtkRenderer *)
	Query if a renderer is in the list of renderers.
virtual const char *	GetRenderingBackend ()
	What rendering backend has the user requested.
	vtkGetNewMacro (RenderTimer, vtkRenderTimerLog)
	Get the render timer log for this window.
vtkRendererCollection *	GetRenderers ()
	Return the collection of renderers in the render window.
void	CaptureGL2PSSpecialProps (vtkCollection *specialProps)
	The GL2PS exporter must handle certain props in a special way (e.g.
void	Render () override
	Ask each renderer owned by this RenderWindow to render its image and synchronize this process.
virtual VTK_MAYSUSPEND void	Start ()
	Start the rendering process for a frame.
virtual void	End ()
	Update the system, if needed, at end of render process.
virtual VTK_MAYSUSPEND void	Initialize ()
	Initializes the rendering process.
virtual void	Finalize ()
	Finalize the rendering process.
virtual VTK_MAYSUSPEND void	Frame ()
	A termination method performed at the end of the rendering process to do things like swapping buffers (if necessary) or similar actions.
virtual VTK_MAYSUSPEND void	WaitForCompletion ()
	Block the thread until the actual rendering is finished().
virtual void	CopyResultFrame ()
	Performed at the end of the rendering process to generate image.
virtual vtkRenderWindowInteractor *	MakeRenderWindowInteractor ()
	Create an interactor to control renderers in this window.
virtual void	StereoUpdate ()
	Update the system, if needed, due to stereo rendering.
virtual void	StereoMidpoint ()
	Intermediate method performs operations required between the rendering of the left and right eye.
virtual void	StereoRenderComplete ()
	Handles work required once both views have been rendered when using stereo rendering.
virtual void	WindowRemap ()
	Remap the rendering window.
virtual vtkTypeBool	GetEventPending ()
	Check to see if a mouse button has been pressed.
virtual int	CheckInRenderStatus ()
	Are we rendering at the moment.
virtual void	ClearInRenderStatus ()
	Clear status (after an exception was thrown for example).
virtual void	SetInteractor (vtkRenderWindowInteractor *)
	Set the interactor to the render window.
void	UnRegister (vtkObjectBase *o) override
	This Method detects loops of RenderWindow<->Interactor, so objects are freed properly.
virtual bool	InitializeFromCurrentContext ()
	Initialize the render window from the information associated with the currently activated OpenGL context.
virtual bool	IsCurrent ()
	Tells if this window is the current graphics context for the calling thread.
virtual void	SetForceMakeCurrent ()
	If called, allow MakeCurrent() to skip cache-check when called.
virtual const char *	ReportCapabilities ()
	Get report of capabilities for the render window.
virtual int	SupportsOpenGL ()
	Does this render window support OpenGL?
virtual vtkTypeBool	IsDirect ()
	Is this render window using hardware acceleration?
virtual int	GetDepthBufferSize ()
	This method should be defined by the subclass.
virtual int	GetColorBufferSizes (int *)
	Get the size of the color buffer.
virtual int	GetNumberOfDevices ()
	Returns the number of devices (graphics cards) on a system.
virtual void	SetPhysicalToWorldMatrix (vtkMatrix4x4 *matrix)
	Set physical to world transform matrix.
virtual void	GetPhysicalToWorldMatrix (vtkMatrix4x4 *matrix)
	Get physical to world transform matrix.
virtual bool	GetDeviceToWorldMatrixForDevice (vtkEventDataDevice device, vtkMatrix4x4 *deviceToWorldMatrix)
	Store in `deviceToWorldMatrix` the matrix that goes from device coordinates to world coordinates.
virtual int	GetCapturingGL2PSSpecialProps ()
	Returns true if the render process is capturing text actors.
virtual bool	GetInitialized ()
	Get/set whether or not the window has been initialized yet.
virtual void	SetFullScreen (vtkTypeBool)
	Turn on/off rendering full screen window size.
virtual vtkTypeBool	GetFullScreen ()
	Turn on/off rendering full screen window size.
virtual void	FullScreenOn ()
	Turn on/off rendering full screen window size.
virtual void	FullScreenOff ()
	Turn on/off rendering full screen window size.
virtual vtkTypeBool	GetCoverable ()
	Set/Get whether windows should be coverable (as opposed to always on top).
virtual void	CoverableOn ()
	Set/Get whether windows should be coverable (as opposed to always on top).
virtual void	CoverableOff ()
	Set/Get whether windows should be coverable (as opposed to always on top).
virtual void	SetCoverable (vtkTypeBool coverable)
	Set/Get whether windows should be coverable (as opposed to always on top).
virtual vtkTypeBool	GetStereoCapableWindow ()
	Prescribe that the window be created in a stereo-capable mode.
virtual void	StereoCapableWindowOn ()
	Prescribe that the window be created in a stereo-capable mode.
virtual void	StereoCapableWindowOff ()
	Prescribe that the window be created in a stereo-capable mode.
virtual void	SetStereoCapableWindow (vtkTypeBool capable)
	Prescribe that the window be created in a stereo-capable mode.
virtual int	GetStereoType ()
	Set/Get what type of stereo rendering to use.
void	SetStereoType (int)
	Set/Get what type of stereo rendering to use.
void	SetStereoTypeToCrystalEyes ()
	Set/Get what type of stereo rendering to use.
void	SetStereoTypeToRedBlue ()
	Set/Get what type of stereo rendering to use.
void	SetStereoTypeToInterlaced ()
	Set/Get what type of stereo rendering to use.
void	SetStereoTypeToLeft ()
	Set/Get what type of stereo rendering to use.
void	SetStereoTypeToRight ()
	Set/Get what type of stereo rendering to use.
void	SetStereoTypeToDresden ()
	Set/Get what type of stereo rendering to use.
void	SetStereoTypeToAnaglyph ()
	Set/Get what type of stereo rendering to use.
void	SetStereoTypeToCheckerboard ()
	Set/Get what type of stereo rendering to use.
void	SetStereoTypeToSplitViewportHorizontal ()
	Set/Get what type of stereo rendering to use.
void	SetStereoTypeToFake ()
	Set/Get what type of stereo rendering to use.
void	SetStereoTypeToEmulate ()
	Set/Get what type of stereo rendering to use.
virtual vtkTypeBool	GetStereoRender ()
	Turn on/off stereo rendering.
void	SetStereoRender (vtkTypeBool stereo)
	Turn on/off stereo rendering.
virtual void	StereoRenderOn ()
	Turn on/off stereo rendering.
virtual void	StereoRenderOff ()
	Turn on/off stereo rendering.
virtual void	SetAlphaBitPlanes (vtkTypeBool)
	Turn on/off the use of alpha bitplanes.
virtual vtkTypeBool	GetAlphaBitPlanes ()
	Turn on/off the use of alpha bitplanes.
virtual void	AlphaBitPlanesOn ()
	Turn on/off the use of alpha bitplanes.
virtual void	AlphaBitPlanesOff ()
	Turn on/off the use of alpha bitplanes.
virtual void	SetPointSmoothing (vtkTypeBool)
	Turn on/off point smoothing.
virtual vtkTypeBool	GetPointSmoothing ()
	Turn on/off point smoothing.
virtual void	PointSmoothingOn ()
	Turn on/off point smoothing.
virtual void	PointSmoothingOff ()
	Turn on/off point smoothing.
virtual void	SetLineSmoothing (vtkTypeBool)
	Turn on/off line smoothing.
virtual vtkTypeBool	GetLineSmoothing ()
	Turn on/off line smoothing.
virtual void	LineSmoothingOn ()
	Turn on/off line smoothing.
virtual void	LineSmoothingOff ()
	Turn on/off line smoothing.
virtual void	SetPolygonSmoothing (vtkTypeBool)
	Turn on/off polygon smoothing.
virtual vtkTypeBool	GetPolygonSmoothing ()
	Turn on/off polygon smoothing.
virtual void	PolygonSmoothingOn ()
	Turn on/off polygon smoothing.
virtual void	PolygonSmoothingOff ()
	Turn on/off polygon smoothing.
virtual void	SetAnaglyphColorSaturation (float)
	Set/get the anaglyph color saturation factor.
virtual float	GetAnaglyphColorSaturation ()
	Set/get the anaglyph color saturation factor.
virtual void	SetAnaglyphColorMask (int, int)
	Set/get the anaglyph color mask values.
void	SetAnaglyphColorMask (int[2])
	Set/get the anaglyph color mask values.
virtual int *	GetAnaglyphColorMask ()
	Set/get the anaglyph color mask values.
virtual void	GetAnaglyphColorMask (int data[2])
	Set/get the anaglyph color mask values.
virtual void	SetSwapBuffers (vtkTypeBool)
	Turn on/off buffer swapping between images.
virtual vtkTypeBool	GetSwapBuffers ()
	Turn on/off buffer swapping between images.
virtual void	SwapBuffersOn ()
	Turn on/off buffer swapping between images.
virtual void	SwapBuffersOff ()
	Turn on/off buffer swapping between images.
virtual int	SetPixelData (int, int, int, int, unsigned char *, int, int=0)
	Set/Get the pixel data of an image, transmitted as RGBRGBRGB.
virtual int	SetPixelData (int, int, int, int, vtkUnsignedCharArray *, int, int=0)
	Set/Get the pixel data of an image, transmitted as RGBRGBRGB.
virtual float *	GetRGBAPixelData (int, int, int, int, int, int=0)
	Same as Get/SetPixelData except that the image also contains an alpha component.
virtual VTK_MAYSUSPEND int	GetRGBAPixelData (int, int, int, int, int, vtkFloatArray *, int=0)
	Same as Get/SetPixelData except that the image also contains an alpha component.
virtual int	SetRGBAPixelData (int, int, int, int, float *, int, int=0, int=0)
	Same as Get/SetPixelData except that the image also contains an alpha component.
virtual int	SetRGBAPixelData (int, int, int, int, vtkFloatArray *, int, int=0, int=0)
	Same as Get/SetPixelData except that the image also contains an alpha component.
virtual void	ReleaseRGBAPixelData (float *)
	Same as Get/SetPixelData except that the image also contains an alpha component.
virtual int	SetRGBACharPixelData (int, int, int, int, unsigned char *, int, int=0, int=0)
	Same as Get/SetPixelData except that the image also contains an alpha component.
virtual int	SetRGBACharPixelData (int, int, int, int, vtkUnsignedCharArray *, int, int=0, int=0)
	Same as Get/SetPixelData except that the image also contains an alpha component.
virtual float *	GetZbufferData (int, int, int, int)
	Set/Get the zbuffer data from the frame buffer.
virtual int	GetZbufferData (int, int, int, int, float *)
	Set/Get the zbuffer data from the frame buffer.
virtual VTK_MAYSUSPEND int	GetZbufferData (int, int, int, int, vtkFloatArray *)
	Set/Get the zbuffer data from the frame buffer.
virtual int	SetZbufferData (int, int, int, int, float *)
	Set/Get the zbuffer data from the frame buffer.
virtual int	SetZbufferData (int, int, int, int, vtkFloatArray *)
	Set/Get the zbuffer data from the frame buffer.
float	GetZbufferDataAtPoint (int x, int y)
	Set/Get the zbuffer data from the frame buffer.
virtual int	GetNeverRendered ()
	This flag is set if the window hasn't rendered since it was created.
virtual int	GetAbortRender ()
	This is a flag that can be set to interrupt a rendering that is in progress.
virtual void	SetAbortRender (int)
	This is a flag that can be set to interrupt a rendering that is in progress.
virtual int	GetInAbortCheck ()
	This is a flag that can be set to interrupt a rendering that is in progress.
virtual void	SetInAbortCheck (int)
	This is a flag that can be set to interrupt a rendering that is in progress.
virtual int	CheckAbortStatus ()
	This is a flag that can be set to interrupt a rendering that is in progress.
virtual void	SetDesiredUpdateRate (double)
	Set/Get the desired update rate.
virtual double	GetDesiredUpdateRate ()
	Set/Get the desired update rate.
virtual int	GetNumberOfLayers ()
	Get the number of layers for renderers.
virtual void	SetNumberOfLayers (int)
	Get the number of layers for renderers.
virtual vtkRenderWindowInteractor *	GetInteractor ()
	Get the interactor associated with this render window.
void	SetDisplayId (void *) override
	Dummy stubs for vtkWindow API.
void	SetWindowId (void *) override
	Dummy stubs for vtkWindow API.
virtual void	SetNextWindowId (void *)
	Dummy stubs for vtkWindow API.
void	SetParentId (void *) override
	Dummy stubs for vtkWindow API.
void *	GetGenericDisplayId () override
	Dummy stubs for vtkWindow API.
void *	GetGenericWindowId () override
	Dummy stubs for vtkWindow API.
void *	GetGenericParentId () override
	Dummy stubs for vtkWindow API.
void *	GetGenericContext () override
	Dummy stubs for vtkWindow API.
void *	GetGenericDrawable () override
	Dummy stubs for vtkWindow API.
void	SetWindowInfo (const char *) override
	Dummy stubs for vtkWindow API.
virtual void	SetNextWindowInfo (const char *)
	Dummy stubs for vtkWindow API.
void	SetParentInfo (const char *) override
	Dummy stubs for vtkWindow API.
virtual void	SetSharedRenderWindow (vtkRenderWindow *)
	Set/Get an already existing window that this window should share data with if possible.
virtual vtkRenderWindow *	GetSharedRenderWindow ()
	Set/Get an already existing window that this window should share data with if possible.
virtual bool	GetPlatformSupportsRenderWindowSharing ()
	Set/Get an already existing window that this window should share data with if possible.
virtual void	SetMultiSamples (int)
	Set / Get the number of multisamples to use for hardware antialiasing.
virtual int	GetMultiSamples ()
	Set / Get the number of multisamples to use for hardware antialiasing.
virtual void	SetStencilCapable (vtkTypeBool)
	Set / Get the availability of the stencil buffer.
virtual vtkTypeBool	GetStencilCapable ()
	Set / Get the availability of the stencil buffer.
virtual void	StencilCapableOn ()
	Set / Get the availability of the stencil buffer.
virtual void	StencilCapableOff ()
	Set / Get the availability of the stencil buffer.
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.
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.
virtual bool	GetUseSRGBColorSpace ()
	Set/Get if we want this window to use the sRGB color space.
virtual void	SetUseSRGBColorSpace (bool)
	Set/Get if we want this window to use the sRGB color space.
virtual void	UseSRGBColorSpaceOn ()
	Set/Get if we want this window to use the sRGB color space.
virtual void	UseSRGBColorSpaceOff ()
	Set/Get if we want this window to use the sRGB color space.
virtual void	SetPhysicalViewDirection (double, double, double)
	Set/get physical coordinate system in world coordinate system.
virtual void	SetPhysicalViewDirection (double[3])
	Set/get physical coordinate system in world coordinate system.
virtual double *	GetPhysicalViewDirection ()
	Set/get physical coordinate system in world coordinate system.
virtual void	GetPhysicalViewDirection (double &, double &, double &)
	Set/get physical coordinate system in world coordinate system.
virtual void	GetPhysicalViewDirection (double[3])
	Set/get physical coordinate system in world coordinate system.
virtual void	SetPhysicalViewUp (double, double, double)
	Set/get physical coordinate system in world coordinate system.
virtual void	SetPhysicalViewUp (double[3])
	Set/get physical coordinate system in world coordinate system.
virtual double *	GetPhysicalViewUp ()
	Set/get physical coordinate system in world coordinate system.
virtual void	GetPhysicalViewUp (double &, double &, double &)
	Set/get physical coordinate system in world coordinate system.
virtual void	GetPhysicalViewUp (double[3])
	Set/get physical coordinate system in world coordinate system.
virtual void	SetPhysicalTranslation (double, double, double)
	Set/get physical coordinate system in world coordinate system.
virtual void	SetPhysicalTranslation (double[3])
	Set/get physical coordinate system in world coordinate system.
virtual double *	GetPhysicalTranslation ()
	Set/get physical coordinate system in world coordinate system.
virtual void	GetPhysicalTranslation (double &, double &, double &)
	Set/get physical coordinate system in world coordinate system.
virtual void	GetPhysicalTranslation (double[3])
	Set/get physical coordinate system in world coordinate system.
virtual void	SetPhysicalScale (double)
	Set/get physical coordinate system in world coordinate system.
virtual double	GetPhysicalScale ()
	Set/get physical coordinate system in world coordinate system.
virtual bool	GetEnableTranslucentSurface ()
	Set/Get if we want this window to use a translucent surface with alpha channel support.
virtual void	SetEnableTranslucentSurface (bool)
	Set/Get if we want this window to use a translucent surface with alpha channel support.
virtual void	EnableTranslucentSurfaceOn ()
	Set/Get if we want this window to use a translucent surface with alpha channel support.
virtual void	EnableTranslucentSurfaceOff ()
	Set/Get if we want this window to use a translucent surface with alpha channel support.
virtual vtkHardwareWindow *	GetHardwareWindow ()
	Set/Get the platform hardware window associated with this window.
virtual void	SetHardwareWindow (vtkHardwareWindow *win)
	Set/Get the platform hardware window associated with this window.
const char *	GetStereoTypeAsString ()
	Returns the stereo type as a string.
Public Member Functions inherited from vtkWindow
vtkWindow *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
int *	GetActualSize ()
	GetSize() returns the size * this->TileScale, whereas this method returns the size without multiplying with the tile scale.
virtual int *	GetScreenSize ()
	Get the current size of the screen in pixels.
virtual void	SetIcon (vtkImageData *)
	Set the icon used in title bar and task bar.
virtual void	ReleaseGraphicsResources (vtkWindow *)
	Release any graphics resources that are being consumed by this texture.
virtual bool	DetectDPI ()
	Attempt to detect and set the DPI of the display device by querying the system.
vtkTypeBool	GetOffScreenRendering ()
	Deprecated, directly use GetShowWindow and GetOffScreenBuffers instead.
virtual void	MakeCurrent ()
	Make the window current.
virtual void	ReleaseCurrent ()
	Release the current context.
virtual bool	EnsureDisplay ()
	These are window system independent methods that are used to help interface vtkWindow to native windowing systems.
virtual int *	GetPosition ()
	Get the position (x and y) of the rendering window in screen coordinates (in pixels).
virtual void	SetPosition (int x, int y)
	Set the position (x and y) of the rendering window in screen coordinates (in pixels).
virtual void	SetPosition (int a[2])
	Get the position (x and y) of the rendering window in screen coordinates (in pixels).
virtual int *	GetSize ()
	Get the size (width and height) of the rendering window in screen coordinates (in pixels).
virtual void	SetSize (int width, int height)
	Set the size (width and height) of the rendering window in screen coordinates (in pixels).
virtual void	SetSize (int a[2])
	Get the size (width and height) of the rendering window in screen coordinates (in pixels).
virtual vtkTypeBool	GetMapped ()
	Keep track of whether the rendering window has been mapped to screen.
virtual bool	GetShowWindow ()
	Show or not Show the window.
virtual void	SetShowWindow (bool)
	Show or not Show the window.
virtual void	ShowWindowOn ()
	Show or not Show the window.
virtual void	ShowWindowOff ()
	Show or not Show the window.
virtual void	SetUseOffScreenBuffers (bool)
	Render to an offscreen destination such as a framebuffer.
virtual bool	GetUseOffScreenBuffers ()
	Render to an offscreen destination such as a framebuffer.
virtual void	UseOffScreenBuffersOn ()
	Render to an offscreen destination such as a framebuffer.
virtual void	UseOffScreenBuffersOff ()
	Render to an offscreen destination such as a framebuffer.
virtual void	SetErase (vtkTypeBool)
	Turn on/off erasing the screen between images.
virtual vtkTypeBool	GetErase ()
	Turn on/off erasing the screen between images.
virtual void	EraseOn ()
	Turn on/off erasing the screen between images.
virtual void	EraseOff ()
	Turn on/off erasing the screen between images.
virtual void	SetDoubleBuffer (vtkTypeBool)
	Keep track of whether double buffering is on or off.
virtual vtkTypeBool	GetDoubleBuffer ()
	Keep track of whether double buffering is on or off.
virtual void	DoubleBufferOn ()
	Keep track of whether double buffering is on or off.
virtual void	DoubleBufferOff ()
	Keep track of whether double buffering is on or off.
virtual char *	GetWindowName ()
	Get name of rendering window.
virtual void	SetWindowName (const char *)
	Get name of rendering window.
virtual int	GetDPI ()
	Return a best estimate to the dots per inch of the display device being rendered (or printed).
virtual void	SetDPI (int dpi)
	Return a best estimate to the dots per inch of the display device being rendered (or printed).
void	SetOffScreenRendering (vtkTypeBool val)
	Convenience to set SHowWindow and UseOffScreenBuffers in one call.
virtual void	OffScreenRenderingOn ()
	Convenience to set SHowWindow and UseOffScreenBuffers in one call.
virtual void	OffScreenRenderingOff ()
	Convenience to set SHowWindow and UseOffScreenBuffers in one call.
virtual void	SetTileScale (int, int)
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.
void	SetTileScale (int[2])
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.
virtual int *	GetTileScale ()
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.
virtual void	GetTileScale (int &, int &)
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.
virtual void	GetTileScale (int[2])
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.
void	SetTileScale (int s)
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.
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.
virtual void	SetTileViewport (double[4])
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.
virtual double *	GetTileViewport ()
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.
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.
virtual void	GetTileViewport (double[4])
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.
virtual void	SetBorders (vtkTypeBool)
	Turn on/off window manager borders.
virtual vtkTypeBool	GetBorders ()
	Turn on/off window manager borders.
virtual void	BordersOn ()
	Turn on/off window manager borders.
virtual void	BordersOff ()
	Turn on/off window manager borders.
virtual void	HideCursor ()
	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.
virtual void	ShowCursor ()
	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.
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.
virtual void	SetCurrentCursor (int)
	Change the shape of the cursor.
virtual int	GetCurrentCursor ()
	Change the shape of the cursor.
	vtkSetFilePathMacro (CursorFileName)
	Set/Get the full path to the custom cursor.
	vtkGetFilePathMacro (CursorFileName)
	Set/Get the full path to the custom cursor.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
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)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkAnariRenderWindow *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAnariRenderWindow *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkRenderWindow
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.
static const char *	GetRenderLibrary ()
	What rendering library has the user requested.
static const char *	GetStereoTypeAsString (int type)
	Returns the stereo type as a string.
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.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAnariRenderWindow ()
	As the render window only supports offscreen rendering for the moment, the constructor calls OffscreenRenderingOn() to enforce it.
	~vtkAnariRenderWindow () override=default
void	DoStereoRender () override
	Called to trigger the rendering to ANARI.
Protected Member Functions inherited from vtkRenderWindow
	vtkRenderWindow ()
	~vtkRenderWindow () override
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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Protected Attributes inherited from vtkRenderWindow
vtkRendererCollection *	Renderers
vtkNew< vtkRenderTimerLog >	RenderTimer
vtkTypeBool	Coverable
vtkTypeBool	FullScreen
int	OldScreen [5]
vtkTypeBool	PointSmoothing
vtkTypeBool	LineSmoothing
vtkTypeBool	PolygonSmoothing
vtkTypeBool	StereoRender
int	StereoType
vtkTypeBool	StereoCapableWindow
vtkTypeBool	AlphaBitPlanes
vtkRenderWindowInteractor *	Interactor
vtkSmartPointer< vtkUnsignedCharArray >	StereoBuffer
vtkSmartPointer< vtkUnsignedCharArray >	ResultFrame
vtkTypeBool	SwapBuffers
double	DesiredUpdateRate
int	AbortRender
int	InAbortCheck
int	InRender
int	NeverRendered
int	NumberOfLayers
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.
vtkRenderWindow *	SharedRenderWindow
double	PhysicalViewDirection [3] = { 0.0, 0.0, -1.0 }
double	PhysicalViewUp [3] = { 0.0, 1.0, 0.0 }
double	PhysicalTranslation [3] = { 0.0, 0.0, 0.0 }
double	PhysicalScale = 1.0
bool	EnableTranslucentSurface = false
bool	Initialized = false
vtkSmartPointer< vtkHardwareWindow >	HardwareWindow
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
vtkTypeBool	Borders = true
int	CurrentCursor = VTK_CURSOR_DEFAULT
char *	CursorFileName = nullptr
double	TileViewport [4]
int	TileSize [2]
int	TileScale [2]
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Member Typedef Documentation

◆ Superclass

typedef vtkRenderWindow vtkAnariRenderWindow::Superclass

Definition at line 36 of file vtkAnariRenderWindow.h.

Constructor & Destructor Documentation

◆ vtkAnariRenderWindow()

vtkAnariRenderWindow::vtkAnariRenderWindow ( )

protected

As the render window only supports offscreen rendering for the moment, the constructor calls OffscreenRenderingOn() to enforce it.

◆ ~vtkAnariRenderWindow()

vtkAnariRenderWindow::~vtkAnariRenderWindow ( )

overrideprotecteddefault

Member Function Documentation

◆ New()

vtkAnariRenderWindow * vtkAnariRenderWindow::New ( )

static

◆ IsTypeOf()

vtkTypeBool vtkAnariRenderWindow::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkAnariRenderWindow::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 vtkRenderWindow.

◆ SafeDownCast()

vtkAnariRenderWindow * vtkAnariRenderWindow::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkAnariRenderWindow::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkRenderWindow.

◆ NewInstance()

vtkAnariRenderWindow * vtkAnariRenderWindow::NewInstance ( ) const

◆ PrintSelf()

void vtkAnariRenderWindow::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 vtkObjectBase.

◆ GetAnariDevice()

virtual vtkAnariDevice * vtkAnariRenderWindow::GetAnariDevice ( )

virtual

Return the AnariDevice contained by the render window.

◆ GetAnariRenderer()

virtual vtkAnariRenderer * vtkAnariRenderWindow::GetAnariRenderer ( )

virtual

Return the AnariRenderer contained by the render window.

vtkAnariRenderer is the internal renderer for parameter management.

◆ GetPixelData() [1/2]

unsigned char * vtkAnariRenderWindow::GetPixelData	(	int	x1,
		int	y1,
		int	x2,
		int	y2,
		int	front,
		int	right = 0 )

overridevirtual

Functions that query RGB pixel image.

Reimplemented from vtkWindow.

◆ GetPixelData() [2/2]

int vtkAnariRenderWindow::GetPixelData	(	int	x1,
		int	y1,
		int	x2,
		int	y2,
		int	front,
		vtkUnsignedCharArray *	data,
		int	right = 0 )

overridevirtual

Functions that query RGB pixel image.

Reimplemented from vtkWindow.

◆ GetRGBACharPixelData() [1/2]

unsigned char * vtkAnariRenderWindow::GetRGBACharPixelData	(	int	x1,
		int	y1,
		int	x2,
		int	y2,
		int	front,
		int	right = 0 )

overridevirtual

Functions that query RGBA pixel image.

Reimplemented from vtkRenderWindow.

◆ GetRGBACharPixelData() [2/2]

int vtkAnariRenderWindow::GetRGBACharPixelData	(	int	x1,
		int	y1,
		int	x2,
		int	y2,
		int	front,
		vtkUnsignedCharArray *	data,
		int	right = 0 )

overridevirtual

Functions that query RGB pixel image.

Reimplemented from vtkRenderWindow.

◆ DoStereoRender()

void vtkAnariRenderWindow::DoStereoRender ( )

overrideprotectedvirtual

Called to trigger the rendering to ANARI.

Reimplemented from vtkRenderWindow.

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

Rendering/ANARI/vtkAnariRenderWindow.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkAnariRenderWindow()

◆ ~vtkAnariRenderWindow()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetAnariDevice()

◆ GetAnariRenderer()

◆ GetPixelData() [1/2]

◆ GetPixelData() [2/2]

◆ GetRGBACharPixelData() [1/2]

◆ GetRGBACharPixelData() [2/2]

◆ DoStereoRender()