vtkVRRenderer Class Reference

Renderer class for VR/AR context. More...

#include <vtkVRRenderer.h>

Inheritance diagram for vtkVRRenderer:

Collaboration diagram for vtkVRRenderer:

Public Types
typedef vtkOpenGLRenderer	Superclass
Public Types inherited from vtkOpenGLRenderer
enum	LightingComplexityEnum { NoLighting = 0 , Headlight = 1 , Directional = 2 , Positional = 3 }
typedef vtkRenderer	Superclass
Public Types inherited from vtkRenderer
typedef vtkViewport	Superclass
Public Types inherited from vtkViewport
enum class	GradientModes : int { VTK_GRADIENT_VERTICAL , VTK_GRADIENT_HORIZONTAL , VTK_GRADIENT_RADIAL_VIEWPORT_FARTHEST_SIDE , VTK_GRADIENT_RADIAL_VIEWPORT_FARTHEST_CORNER }
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.
vtkVRRenderer *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	ResetCamera (const double bounds[6]) override
	Automatically set up the camera based on a specified bounding box (xmin,xmax, ymin,ymax, zmin,zmax).
vtkCamera *	MakeCamera () override=0
	Abstract function that creates a new Camera suitable for use with this type of Renderer.
virtual void	GetFloorTransform (vtkTransform *transform)
	Store in transform the floor transform.
void	DeviceRender () override
	Render the floor using GetFloorTransform.
virtual void	ResetCamera ()
	Automatically set up the camera based on the visible actors.
virtual void	ResetCamera (const double bounds[6])
	Automatically set up the camera based on a specified bounding box (xmin, xmax, ymin, ymax, zmin, zmax).
virtual void	ResetCamera (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
	Alternative version of ResetCamera(bounds[6]);.
virtual void	ResetCameraClippingRange ()
	Reset the camera clipping range based on the bounds of the visible actors.
virtual void	ResetCameraClippingRange (const double bounds[6])
	Reset the camera clipping range based on a bounding box.
virtual void	ResetCameraClippingRange (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
	Reset the camera clipping range based on a bounding box.
void	ResetCameraClippingRange () override
	Reset the camera clipping range based on a bounding box.
void	ResetCameraClippingRange (const double bounds[6]) override
	Reset the camera clipping range based on a bounding box.
virtual void	SetShowFloor (bool value)
	Set/get whether to show a white floor corresponding to the physical floor.
virtual bool	GetShowFloor ()
	Set/get whether to show a white floor corresponding to the physical floor.
virtual void	SetShowLeftMarker (bool value)
	Set/get whether to display a white cross marker at the tip of the left controller.
virtual bool	GetShowLeftMarker ()
	Set/get whether to display a white cross marker at the tip of the left controller.
virtual void	SetShowRightMarker (bool value)
	Set/get whether to display a white cross marker at the tip of the right controller.
virtual bool	GetShowRightMarker ()
	Set/get whether to display a white cross marker at the tip of the right controller.
Public Member Functions inherited from vtkOpenGLRenderer
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkOpenGLRenderer *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	DeviceRender () override
	Concrete open gl render method.
void	DeviceRenderOpaqueGeometry (vtkFrameBufferObjectBase *fbo=nullptr) override
	Overridden to support hidden line removal.
void	DeviceRenderTranslucentPolygonalGeometry (vtkFrameBufferObjectBase *fbo=nullptr) override
	Render translucent polygonal geometry.
void	Clear () override
	Clear the image to the background color.
int	UpdateLights () override
	Ask lights to load themselves into graphics pipeline.
int	GetDepthPeelingHigherLayer ()
	Is rendering at translucent geometry stage using depth peeling and rendering a layer other than the first one? (Boolean value) If so, the uniform variables UseTexture and Texture can be set.
bool	IsDualDepthPeelingSupported ()
	Dual depth peeling may be disabled for certain runtime configurations.
vtkOpenGLState *	GetState ()
const char *	GetLightingUniforms ()
void	UpdateLightingUniforms (vtkShaderProgram *prog)
virtual int	GetLightingComplexity ()
virtual int	GetLightingCount ()
vtkFloatArray *	GetSphericalHarmonics ()
	Get spherical harmonics coefficients used for irradiance.
void	SetEnvironmentTexture (vtkTexture *texture, bool isSRGB=false) override
	Set/Get the environment texture used for image based lighting.
void	ReleaseGraphicsResources (vtkWindow *w) override
void	SetUserLightTransform (vtkTransform *transform)
	Set the user light transform applied after the camera transform.
vtkTransform *	GetUserLightTransform ()
	Set the user light transform applied after the camera transform.
	vtkSetSmartPointerMacro (EnvMapLookupTable, vtkPBRLUTTexture)
	Get environment textures used for image based lighting.
vtkPBRLUTTexture *	GetEnvMapLookupTable ()
	Get environment textures used for image based lighting.
	vtkSetSmartPointerMacro (EnvMapIrradiance, vtkPBRIrradianceTexture)
	Get environment textures used for image based lighting.
vtkPBRIrradianceTexture *	GetEnvMapIrradiance ()
	Get environment textures used for image based lighting.
	vtkSetSmartPointerMacro (EnvMapPrefiltered, vtkPBRPrefilterTexture)
	Get environment textures used for image based lighting.
vtkPBRPrefilterTexture *	GetEnvMapPrefiltered ()
	Get environment textures used for image based lighting.
virtual void	SetUseSphericalHarmonics (bool)
	Use spherical harmonics instead of irradiance texture.
virtual bool	GetUseSphericalHarmonics ()
	Use spherical harmonics instead of irradiance texture.
virtual void	UseSphericalHarmonicsOn ()
	Use spherical harmonics instead of irradiance texture.
virtual void	UseSphericalHarmonicsOff ()
	Use spherical harmonics instead of irradiance texture.
Public Member Functions inherited from vtkRenderer
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkRenderer *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	AddLight (vtkLight *)
	Add a light to the list of lights.
void	RemoveLight (vtkLight *)
	Remove a light from the list of lights.
void	RemoveAllLights ()
	Remove all lights from the list of lights.
vtkLightCollection *	GetLights ()
	Return the collection of lights.
void	SetLightCollection (vtkLightCollection *lights)
	Set the collection of lights.
void	CreateLight ()
	Create and add a light to renderer.
virtual vtkLight *	MakeLight ()
	Create a new Light sutible for use with this type of Renderer.
virtual vtkTypeBool	UpdateLightsGeometryToFollowCamera ()
	Ask the lights in the scene that are not in world space (for instance, Headlights or CameraLights that are attached to the camera) to update their geometry to match the active camera.
vtkVolumeCollection *	GetVolumes ()
	Return the collection of volumes.
vtkActorCollection *	GetActors ()
	Return any actors in this renderer.
void	SetActiveCamera (vtkCamera *)
	Specify the camera to use for this renderer.
vtkCamera *	GetActiveCamera ()
	Get the current camera.
virtual vtkCamera *	MakeCamera ()
	Create a new Camera sutible for use with this type of Renderer.
int	CaptureGL2PSSpecialProp (vtkProp *)
	This function is called to capture an instance of vtkProp that requires special handling during vtkRenderWindow::CaptureGL2PSSpecialProps().
void	SetGL2PSSpecialPropCollection (vtkPropCollection *)
	Set the prop collection object used during vtkRenderWindow::CaptureGL2PSSpecialProps().
void	AddCuller (vtkCuller *)
	Add an culler to the list of cullers.
void	RemoveCuller (vtkCuller *)
	Remove an actor from the list of cullers.
vtkCullerCollection *	GetCullers ()
	Return the collection of cullers.
virtual double	GetTimeFactor ()
	Get the ratio between allocated time and actual render time.
virtual void	Render ()
	CALLED BY vtkRenderWindow ONLY.
virtual void	DeviceRender ()
	Create an image.
virtual void	DeviceRenderOpaqueGeometry (vtkFrameBufferObjectBase *fbo=nullptr)
	Render opaque polygonal geometry.
virtual void	DeviceRenderTranslucentPolygonalGeometry (vtkFrameBufferObjectBase *fbo=nullptr)
	Render translucent polygonal geometry.
virtual void	ClearLights ()
	Internal method temporarily removes lights before reloading them into graphics pipeline.
virtual void	Clear ()
	Clear the image to the background color.
int	VisibleActorCount ()
	Returns the number of visible actors.
int	VisibleVolumeCount ()
	Returns the number of visible volumes.
void	ComputeVisiblePropBounds (double bounds[6])
	Compute the bounding box of all the visible props Used in ResetCamera() and ResetCameraClippingRange()
double *	ComputeVisiblePropBounds ()
	Wrapper-friendly version of ComputeVisiblePropBounds.
virtual void	ResetCameraClippingRange ()
	Reset the camera clipping range based on the bounds of the visible actors.
virtual void	ResetCamera ()
	Automatically set up the camera based on the visible actors.
virtual void	ResetCamera (const double bounds[6])
	Automatically set up the camera based on a specified bounding box (xmin, xmax, ymin, ymax, zmin, zmax).
virtual void	ResetCamera (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
	Alternative version of ResetCamera(bounds[6]);.
virtual void	ResetCameraScreenSpace (double offsetRatio=0.9)
	Automatically set up the camera based on the visible actors.
virtual void	ResetCameraScreenSpace (const double bounds[6], double offsetRatio=0.9)
	Automatically set up the camera based on a specified bounding box (xmin, xmax, ymin, ymax, zmin, zmax).
vtkVector3d	DisplayToWorld (const vtkVector3d &display)
	Convert a vtkVector3d from display space to world space.
void	ZoomToBoxUsingViewAngle (const vtkRecti &box, double offsetRatio=1.0)
	Automatically set up the camera focal point and zoom factor to observe the box in display coordinates.
virtual void	ResetCameraScreenSpace (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax, double offsetRatio=0.9)
	Alternative version of ResetCameraScreenSpace(bounds[6]);.
vtkTypeBool	Transparent ()
	Returns a boolean indicating if this renderer is transparent.
void	WorldToView () override
	Convert world point coordinates to view coordinates.
void	WorldToView (double &wx, double &wy, double &wz) override
	Convert world point coordinates to view coordinates.
double	GetZ (int x, int y)
	Given a pixel location, return the Z value.
vtkMTimeType	GetMTime () override
	Return the MTime of the renderer also considering its ivars.
virtual void	StereoMidpoint ()
	Do anything necessary between rendering the left and right viewpoints in a stereo render.
double	GetTiledAspectRatio ()
	Compute the aspect ratio of this renderer for the current tile.
vtkTypeBool	IsActiveCameraCreated ()
	This method returns 1 if the ActiveCamera has already been set or automatically created by the renderer.
virtual void	SetUseDepthPeelingForVolumes (bool)
	This flag is on and the GPU supports it, depth-peel volumes along with the translucent geometry.
virtual bool	GetUseDepthPeelingForVolumes ()
virtual void	UseDepthPeelingForVolumesOn ()
virtual void	UseDepthPeelingForVolumesOff ()
virtual void	ReleaseGraphicsResources (vtkWindow *)
void	SetPass (vtkRenderPass *p)
virtual vtkRenderPass *	GetPass ()
void	DisplayToWorld ()
	Convert display (or screen) coordinates to world coordinates.
void	AddActor (vtkProp *p)
	Add/Remove different types of props to the renderer.
void	AddVolume (vtkProp *p)
	Add/Remove different types of props to the renderer.
void	RemoveActor (vtkProp *p)
	Add/Remove different types of props to the renderer.
void	RemoveVolume (vtkProp *p)
	Add/Remove different types of props to the renderer.
virtual vtkTypeBool	GetTwoSidedLighting ()
	Turn on/off two-sided lighting of surfaces.
virtual void	SetTwoSidedLighting (vtkTypeBool)
	Turn on/off two-sided lighting of surfaces.
virtual void	TwoSidedLightingOn ()
	Turn on/off two-sided lighting of surfaces.
virtual void	TwoSidedLightingOff ()
	Turn on/off two-sided lighting of surfaces.
virtual void	SetLightFollowCamera (vtkTypeBool)
	Turn on/off the automatic repositioning of lights as the camera moves.
virtual vtkTypeBool	GetLightFollowCamera ()
	Turn on/off the automatic repositioning of lights as the camera moves.
virtual void	LightFollowCameraOn ()
	Turn on/off the automatic repositioning of lights as the camera moves.
virtual void	LightFollowCameraOff ()
	Turn on/off the automatic repositioning of lights as the camera moves.
virtual vtkTypeBool	GetAutomaticLightCreation ()
	Turn on/off a flag which disables the automatic light creation capability.
virtual void	SetAutomaticLightCreation (vtkTypeBool)
	Turn on/off a flag which disables the automatic light creation capability.
virtual void	AutomaticLightCreationOn ()
	Turn on/off a flag which disables the automatic light creation capability.
virtual void	AutomaticLightCreationOff ()
	Turn on/off a flag which disables the automatic light creation capability.
virtual void	SetErase (vtkTypeBool)
	When this flag is off, the renderer will not erase the background or the Zbuffer.
virtual vtkTypeBool	GetErase ()
	When this flag is off, the renderer will not erase the background or the Zbuffer.
virtual void	EraseOn ()
	When this flag is off, the renderer will not erase the background or the Zbuffer.
virtual void	EraseOff ()
	When this flag is off, the renderer will not erase the background or the Zbuffer.
virtual void	SetDraw (vtkTypeBool)
	When this flag is off, render commands are ignored.
virtual vtkTypeBool	GetDraw ()
	When this flag is off, render commands are ignored.
virtual void	DrawOn ()
	When this flag is off, render commands are ignored.
virtual void	DrawOff ()
	When this flag is off, render commands are ignored.
virtual void	SetAmbient (double, double, double)
	Set the intensity of ambient lighting.
virtual void	SetAmbient (double[3])
	Set the intensity of ambient lighting.
virtual double *	GetAmbient ()
	Set the intensity of ambient lighting.
virtual void	GetAmbient (double data[3])
	Set the intensity of ambient lighting.
virtual void	SetAllocatedRenderTime (double)
	Set/Get the amount of time this renderer is allowed to spend rendering its scene.
virtual double	GetAllocatedRenderTime ()
	Set/Get the amount of time this renderer is allowed to spend rendering its scene.
virtual void	SetNearClippingPlaneTolerance (double)
	Specify tolerance for near clipping plane distance to the camera as a percentage of the far clipping plane distance.
virtual double	GetNearClippingPlaneTolerance ()
	Specify tolerance for near clipping plane distance to the camera as a percentage of the far clipping plane distance.
virtual void	SetClippingRangeExpansion (double)
	Specify enlargement of bounds when resetting the camera clipping range.
virtual double	GetClippingRangeExpansion ()
	Specify enlargement of bounds when resetting the camera clipping range.
void	SetRenderWindow (vtkRenderWindow *)
	Specify the rendering window in which to draw.
vtkRenderWindow *	GetRenderWindow ()
	Specify the rendering window in which to draw.
vtkWindow *	GetVTKWindow () override
	Specify the rendering window in which to draw.
virtual void	SetBackingStore (vtkTypeBool)
	Turn on/off using backing store.
virtual vtkTypeBool	GetBackingStore ()
	Turn on/off using backing store.
virtual void	BackingStoreOn ()
	Turn on/off using backing store.
virtual void	BackingStoreOff ()
	Turn on/off using backing store.
virtual void	SetInteractive (vtkTypeBool)
	Turn on/off interactive status.
virtual vtkTypeBool	GetInteractive ()
	Turn on/off interactive status.
virtual void	InteractiveOn ()
	Turn on/off interactive status.
virtual void	InteractiveOff ()
	Turn on/off interactive status.
virtual void	SetLayer (int layer)
	Set/Get the layer that this renderer belongs to.
virtual int	GetLayer ()
	Set/Get the layer that this renderer belongs to.
virtual vtkTypeBool	GetPreserveColorBuffer ()
	By default, the renderer at layer 0 is opaque, and all non-zero layer renderers are transparent.
virtual void	SetPreserveColorBuffer (vtkTypeBool)
	By default, the renderer at layer 0 is opaque, and all non-zero layer renderers are transparent.
virtual void	PreserveColorBufferOn ()
	By default, the renderer at layer 0 is opaque, and all non-zero layer renderers are transparent.
virtual void	PreserveColorBufferOff ()
	By default, the renderer at layer 0 is opaque, and all non-zero layer renderers are transparent.
virtual void	SetPreserveDepthBuffer (vtkTypeBool)
	By default, the depth buffer is reset for each renderer.
virtual vtkTypeBool	GetPreserveDepthBuffer ()
	By default, the depth buffer is reset for each renderer.
virtual void	PreserveDepthBufferOn ()
	By default, the depth buffer is reset for each renderer.
virtual void	PreserveDepthBufferOff ()
	By default, the depth buffer is reset for each renderer.
void	ViewToWorld () override
	Convert view point coordinates to world coordinates.
void	ViewToWorld (double &wx, double &wy, double &wz) override
	Convert view point coordinates to world coordinates.
void	WorldToPose (double &wx, double &wy, double &wz) override
	Convert to from pose coordinates.
void	PoseToWorld (double &wx, double &wy, double &wz) override
	Convert to from pose coordinates.
void	ViewToPose (double &wx, double &wy, double &wz) override
	Convert to from pose coordinates.
void	PoseToView (double &wx, double &wy, double &wz) override
	Convert to from pose coordinates.
virtual void	SetSafeGetZ (bool)
	If this flag is On GetZ(int, int) will use a vtkHardwareSelector internally to determine the Z value.
virtual bool	GetSafeGetZ ()
	If this flag is On GetZ(int, int) will use a vtkHardwareSelector internally to determine the Z value.
virtual void	SafeGetZOn ()
	If this flag is On GetZ(int, int) will use a vtkHardwareSelector internally to determine the Z value.
virtual void	SafeGetZOff ()
	If this flag is On GetZ(int, int) will use a vtkHardwareSelector internally to determine the Z value.
virtual double	GetLastRenderTimeInSeconds ()
	Get the time required, in seconds, for the last Render call.
virtual int	GetNumberOfPropsRendered ()
	Should be used internally only during a render Get the number of props that were rendered using a RenderOpaqueGeometry or RenderTranslucentPolygonalGeometry call.
vtkAssemblyPath *	PickProp (double selectionX, double selectionY) override
	Return the prop (via a vtkAssemblyPath) that has the highest z value at the given x, y position in the viewport.
vtkAssemblyPath *	PickProp (double selectionX1, double selectionY1, double selectionX2, double selectionY2) override
	Return the prop (via a vtkAssemblyPath) that has the highest z value at the given x, y position in the viewport.
vtkAssemblyPath *	PickProp (double selectionX, double selectionY, int fieldAssociation, vtkSmartPointer< vtkSelection > selection) override
	Return the prop (via a vtkAssemblyPath) that has the highest z value at the given x, y position in the viewport.
vtkAssemblyPath *	PickProp (double selectionX1, double selectionY1, double selectionX2, double selectionY2, int fieldAssociation, vtkSmartPointer< vtkSelection > selection) override
	Return the prop (via a vtkAssemblyPath) that has the highest z value at the given x, y position in the viewport.
virtual void	SetUseDepthPeeling (vtkTypeBool)
	Turn on/off rendering of translucent material with depth peeling technique.
virtual vtkTypeBool	GetUseDepthPeeling ()
	Turn on/off rendering of translucent material with depth peeling technique.
virtual void	UseDepthPeelingOn ()
	Turn on/off rendering of translucent material with depth peeling technique.
virtual void	UseDepthPeelingOff ()
	Turn on/off rendering of translucent material with depth peeling technique.
virtual void	SetOcclusionRatio (double)
	In case of use of depth peeling technique for rendering translucent material, define the threshold under which the algorithm stops to iterate over peel layers.
virtual double	GetOcclusionRatio ()
	In case of use of depth peeling technique for rendering translucent material, define the threshold under which the algorithm stops to iterate over peel layers.
virtual void	SetMaximumNumberOfPeels (int)
	In case of depth peeling, define the maximum number of peeling layers.
virtual int	GetMaximumNumberOfPeels ()
	In case of depth peeling, define the maximum number of peeling layers.
virtual vtkTypeBool	GetLastRenderingUsedDepthPeeling ()
	Tells if the last call to DeviceRenderTranslucentPolygonalGeometry() actually used depth peeling.
virtual void	SetUseSSAO (bool)
	Enable or disable Screen Space Ambient Occlusion.
virtual bool	GetUseSSAO ()
	Enable or disable Screen Space Ambient Occlusion.
virtual void	UseSSAOOn ()
	Enable or disable Screen Space Ambient Occlusion.
virtual void	UseSSAOOff ()
	Enable or disable Screen Space Ambient Occlusion.
virtual void	SetSSAORadius (double)
	When using SSAO, define the SSAO hemisphere radius.
virtual double	GetSSAORadius ()
	When using SSAO, define the SSAO hemisphere radius.
virtual void	SetSSAOBias (double)
	When using SSAO, define the bias when comparing samples.
virtual double	GetSSAOBias ()
	When using SSAO, define the bias when comparing samples.
virtual void	SetSSAOKernelSize (unsigned int)
	When using SSAO, define the number of samples.
virtual unsigned int	GetSSAOKernelSize ()
	When using SSAO, define the number of samples.
virtual void	SetSSAOBlur (bool)
	When using SSAO, define blurring of the ambient occlusion.
virtual bool	GetSSAOBlur ()
	When using SSAO, define blurring of the ambient occlusion.
virtual void	SSAOBlurOn ()
	When using SSAO, define blurring of the ambient occlusion.
virtual void	SSAOBlurOff ()
	When using SSAO, define blurring of the ambient occlusion.
void	SetDelegate (vtkRendererDelegate *d)
	Set/Get a custom Render call.
virtual vtkRendererDelegate *	GetDelegate ()
	Set/Get a custom Render call.
virtual vtkHardwareSelector *	GetSelector ()
	Get the current hardware selector.
virtual void	SetLeftBackgroundTexture (vtkTexture *)
	Set/Get the texture to be used for the monocular or stereo left eye background.
vtkTexture *	GetLeftBackgroundTexture ()
	Set/Get the texture to be used for the monocular or stereo left eye background.
virtual void	SetBackgroundTexture (vtkTexture *)
	Set/Get the texture to be used for the monocular or stereo left eye background.
virtual vtkTexture *	GetBackgroundTexture ()
	Set/Get the texture to be used for the monocular or stereo left eye background.
virtual void	SetRightBackgroundTexture (vtkTexture *)
	Set/Get the texture to be used for the right eye background.
virtual vtkTexture *	GetRightBackgroundTexture ()
	Set/Get the texture to be used for the right eye background.
virtual void	SetTexturedBackground (bool)
	Set/Get whether this viewport should have a textured background.
virtual bool	GetTexturedBackground ()
	Set/Get whether this viewport should have a textured background.
virtual void	TexturedBackgroundOn ()
	Set/Get whether this viewport should have a textured background.
virtual void	TexturedBackgroundOff ()
	Set/Get whether this viewport should have a textured background.
virtual void	SetUseFXAA (bool)
	Turn on/off FXAA anti-aliasing, if supported.
virtual bool	GetUseFXAA ()
	Turn on/off FXAA anti-aliasing, if supported.
virtual void	UseFXAAOn ()
	Turn on/off FXAA anti-aliasing, if supported.
virtual void	UseFXAAOff ()
	Turn on/off FXAA anti-aliasing, if supported.
virtual vtkFXAAOptions *	GetFXAAOptions ()
	The configuration object for FXAA antialiasing.
virtual void	SetFXAAOptions (vtkFXAAOptions *)
	The configuration object for FXAA antialiasing.
virtual void	SetUseShadows (vtkTypeBool)
	Turn on/off rendering of shadows if supported Initial value is off.
virtual vtkTypeBool	GetUseShadows ()
	Turn on/off rendering of shadows if supported Initial value is off.
virtual void	UseShadowsOn ()
	Turn on/off rendering of shadows if supported Initial value is off.
virtual void	UseShadowsOff ()
	Turn on/off rendering of shadows if supported Initial value is off.
virtual void	SetUseHiddenLineRemoval (vtkTypeBool)
	If this flag is true and the rendering engine supports it, wireframe geometry will be drawn using hidden line removal.
virtual vtkTypeBool	GetUseHiddenLineRemoval ()
	If this flag is true and the rendering engine supports it, wireframe geometry will be drawn using hidden line removal.
virtual void	UseHiddenLineRemovalOn ()
	If this flag is true and the rendering engine supports it, wireframe geometry will be drawn using hidden line removal.
virtual void	UseHiddenLineRemovalOff ()
	If this flag is true and the rendering engine supports it, wireframe geometry will be drawn using hidden line removal.
virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.
virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.
virtual void	SetUseImageBasedLighting (bool)
	If this flag is true and the rendering engine supports it, image based lighting is enabled and surface rendering displays environment reflections.
virtual bool	GetUseImageBasedLighting ()
	If this flag is true and the rendering engine supports it, image based lighting is enabled and surface rendering displays environment reflections.
virtual void	UseImageBasedLightingOn ()
	If this flag is true and the rendering engine supports it, image based lighting is enabled and surface rendering displays environment reflections.
virtual void	UseImageBasedLightingOff ()
	If this flag is true and the rendering engine supports it, image based lighting is enabled and surface rendering displays environment reflections.
virtual vtkTexture *	GetEnvironmentTexture ()
	Set/Get the environment texture used for image based lighting.
void	SetEnvironmentTextureProperty (vtkTexture *texture)
	Set/Get the environment texture used for image based lighting.
virtual double *	GetEnvironmentUp ()
	Set/Get the environment up vector.
virtual void	GetEnvironmentUp (double &, double &, double &)
	Set/Get the environment up vector.
virtual void	GetEnvironmentUp (double[3])
	Set/Get the environment up vector.
virtual void	SetEnvironmentUp (double, double, double)
	Set/Get the environment up vector.
virtual void	SetEnvironmentUp (double[3])
	Set/Get the environment up vector.
virtual double *	GetEnvironmentRight ()
	Set/Get the environment right vector.
virtual void	GetEnvironmentRight (double &, double &, double &)
	Set/Get the environment right vector.
virtual void	GetEnvironmentRight (double[3])
	Set/Get the environment right vector.
virtual void	SetEnvironmentRight (double, double, double)
	Set/Get the environment right vector.
virtual void	SetEnvironmentRight (double[3])
	Set/Get the environment right vector.
Public Member Functions inherited from vtkViewport
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkViewport *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	AddViewProp (vtkProp *)
	Add a prop to the list of props.
vtkPropCollection *	GetViewProps ()
	Return any props in this viewport.
vtkTypeBool	HasViewProp (vtkProp *)
	Query if a prop is in the list of props.
void	RemoveViewProp (vtkProp *)
	Remove a prop from the list of props.
void	RemoveAllViewProps ()
	Remove all props from the list of props.
virtual double *	GetCenter ()
	Return the center of this viewport in display coordinates.
virtual vtkTypeBool	IsInViewport (int x, int y)
	Is a given display point in this Viewport's viewport.
virtual vtkWindow *	GetVTKWindow ()=0
	Return the vtkWindow that owns this vtkViewport.
virtual void	DisplayToView ()
	Convert display coordinates to view coordinates.
virtual void	ViewToDisplay ()
	Convert view coordinates to display coordinates.
virtual void	WorldToView ()
	Convert world point coordinates to view coordinates.
virtual void	ViewToWorld ()
	Convert view point coordinates to world coordinates.
void	DisplayToWorld ()
	Convert display (or screen) coordinates to world coordinates.
void	WorldToDisplay ()
	Convert world point coordinates to display (or screen) coordinates.
void	WorldToDisplay (double &x, double &y, double &z)
	Convert world point coordinates to display (or screen) coordinates.
virtual vtkAssemblyPath *	PickProp (double selectionX, double selectionY)=0
	Return the Prop that has the highest z value at the given x, y position in the viewport.
virtual vtkAssemblyPath *	PickProp (double selectionX1, double selectionY1, double selectionX2, double selectionY2)=0
	Return the Prop that has the highest z value at the given x1, y1 and x2,y2 positions in the viewport.
vtkAssemblyPath *	PickPropFrom (double selectionX, double selectionY, vtkPropCollection *)
	Same as PickProp with two arguments, but selects from the given collection of Props instead of the Renderers props.
vtkAssemblyPath *	PickPropFrom (double selectionX1, double selectionY1, double selectionX2, double selectionY2, vtkPropCollection *)
	Same as PickProp with four arguments, but selects from the given collection of Props instead of the Renderers props.
virtual vtkAssemblyPath *	PickProp (double selectionX, double selectionY, int fieldAssociation, vtkSmartPointer< vtkSelection > selection)=0
	Return the Prop that has the highest z value at the given x, y position in the viewport.
virtual vtkAssemblyPath *	PickProp (double selectionX1, double selectionY1, double selectionX2, double selectionY2, int fieldAssociation, vtkSmartPointer< vtkSelection > selection)=0
	Return the Prop that has the highest z value at the given x1, y1 and x2,y2 positions in the viewport.
vtkAssemblyPath *	PickPropFrom (double selectionX, double selectionY, vtkPropCollection *, int fieldAssociation, vtkSmartPointer< vtkSelection > selection)
	Same as PickProp with two arguments, but selects from the given collection of Props instead of the Renderers props.
vtkAssemblyPath *	PickPropFrom (double selectionX1, double selectionY1, double selectionX2, double selectionY2, vtkPropCollection *, int fieldAssociation, vtkSmartPointer< vtkSelection > selection)
	Same as PickProp with four arguments, but selects from the given collection of Props instead of the Renderers props.
virtual double	GetPickedZ ()
	Return the Z value for the last picked Prop.
void	AddActor2D (vtkProp *p)
	Add/Remove different types of props to the renderer.
void	RemoveActor2D (vtkProp *p)
	Add/Remove different types of props to the renderer.
vtkActor2DCollection *	GetActors2D ()
	Add/Remove different types of props to the renderer.
virtual void	SetBackground (double, double, double)
	Set/Get the background color of the rendering screen using an rgb color specification.
virtual void	SetBackground (double[3])
	Set/Get the background color of the rendering screen using an rgb color specification.
virtual double *	GetBackground ()
	Set/Get the background color of the rendering screen using an rgb color specification.
virtual void	GetBackground (double &, double &, double &)
	Set/Get the background color of the rendering screen using an rgb color specification.
virtual void	GetBackground (double[3])
	Set/Get the background color of the rendering screen using an rgb color specification.
virtual void	SetBackground2 (double, double, double)
	Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification.
virtual void	SetBackground2 (double[3])
	Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification.
virtual double *	GetBackground2 ()
	Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification.
virtual void	GetBackground2 (double &, double &, double &)
	Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification.
virtual void	GetBackground2 (double[3])
	Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification.
virtual void	SetBackgroundAlpha (double)
	Set/Get the alpha value used to fill the background with.
virtual double	GetBackgroundAlpha ()
	Set/Get the alpha value used to fill the background with.
virtual void	SetGradientBackground (bool)
	Set/Get whether this viewport should have a gradient background using the Background (bottom) and Background2 (top) colors.
virtual bool	GetGradientBackground ()
	Set/Get whether this viewport should have a gradient background using the Background (bottom) and Background2 (top) colors.
virtual void	GradientBackgroundOn ()
	Set/Get whether this viewport should have a gradient background using the Background (bottom) and Background2 (top) colors.
virtual void	GradientBackgroundOff ()
	Set/Get whether this viewport should have a gradient background using the Background (bottom) and Background2 (top) colors.
virtual void	SetDitherGradient (bool)
	Set/Get whether this viewport should use dithering to reduce color banding when using gradient backgrounds.
virtual bool	GetDitherGradient ()
	Set/Get whether this viewport should use dithering to reduce color banding when using gradient backgrounds.
virtual void	DitherGradientOn ()
	Set/Get whether this viewport should use dithering to reduce color banding when using gradient backgrounds.
virtual void	DitherGradientOff ()
	Set/Get whether this viewport should use dithering to reduce color banding when using gradient backgrounds.
	vtkSetEnumMacro (GradientMode, GradientModes)
	Specify the direction of the gradient background.
	vtkGetEnumMacro (GradientMode, GradientModes)
	Specify the direction of the gradient background.
virtual void	SetAspect (double, double)
	Set the aspect ratio of the rendered image.
void	SetAspect (double[2])
	Set the aspect ratio of the rendered image.
virtual double *	GetAspect ()
	Set the aspect ratio of the rendered image.
virtual void	GetAspect (double data[2])
	Set the aspect ratio of the rendered image.
virtual void	ComputeAspect ()
	Set the aspect ratio of the rendered image.
virtual void	SetPixelAspect (double, double)
	Set the aspect ratio of a pixel in the rendered image.
void	SetPixelAspect (double[2])
	Set the aspect ratio of a pixel in the rendered image.
virtual double *	GetPixelAspect ()
	Set the aspect ratio of a pixel in the rendered image.
virtual void	GetPixelAspect (double data[2])
	Set the aspect ratio of a pixel in the rendered image.
virtual void	SetViewport (double, double, double, double)
	Specify the viewport for the Viewport to draw in the rendering window.
virtual void	SetViewport (double[4])
	Specify the viewport for the Viewport to draw in the rendering window.
virtual double *	GetViewport ()
	Specify the viewport for the Viewport to draw in the rendering window.
virtual void	GetViewport (double data[4])
	Specify the viewport for the Viewport to draw in the rendering window.
virtual void	SetDisplayPoint (double, double, double)
	Set/get a point location in display (or screen) coordinates.
virtual void	SetDisplayPoint (double[3])
	Set/get a point location in display (or screen) coordinates.
virtual double *	GetDisplayPoint ()
	Set/get a point location in display (or screen) coordinates.
virtual void	GetDisplayPoint (double data[3])
	Set/get a point location in display (or screen) coordinates.
virtual void	SetViewPoint (double, double, double)
	Specify a point location in view coordinates.
virtual void	SetViewPoint (double[3])
	Specify a point location in view coordinates.
virtual double *	GetViewPoint ()
	Specify a point location in view coordinates.
virtual void	GetViewPoint (double data[3])
	Specify a point location in view coordinates.
virtual void	SetWorldPoint (double, double, double, double)
	Specify a point location in world coordinates.
virtual void	SetWorldPoint (double[4])
	Specify a point location in world coordinates.
virtual double *	GetWorldPoint ()
	Specify a point location in world coordinates.
virtual void	GetWorldPoint (double data[4])
	Specify a point location in world coordinates.
virtual void	LocalDisplayToDisplay (double &x, double &y)
	These methods map from one coordinate system to another.
virtual void	DisplayToNormalizedDisplay (double &u, double &v)
	These methods map from one coordinate system to another.
virtual void	NormalizedDisplayToViewport (double &x, double &y)
	These methods map from one coordinate system to another.
virtual void	ViewportToNormalizedViewport (double &u, double &v)
	These methods map from one coordinate system to another.
virtual void	NormalizedViewportToView (double &x, double &y, double &z)
	These methods map from one coordinate system to another.
virtual void	DisplayToLocalDisplay (double &x, double &y)
	These methods map from one coordinate system to another.
virtual void	NormalizedDisplayToDisplay (double &u, double &v)
	These methods map from one coordinate system to another.
virtual void	ViewportToNormalizedDisplay (double &x, double &y)
	These methods map from one coordinate system to another.
virtual void	NormalizedViewportToViewport (double &u, double &v)
	These methods map from one coordinate system to another.
virtual void	ViewToNormalizedViewport (double &x, double &y, double &z)
	These methods map from one coordinate system to another.
virtual void	ViewToDisplay (double &x, double &y, double &z)
	These methods map from one coordinate system to another.
virtual int *	GetSize ()
	Get the size and origin of the viewport in display coordinates.
virtual int *	GetOrigin ()
	Get the size and origin of the viewport in display coordinates.
void	GetTiledSize (int *width, int *height)
	Get the size and origin of the viewport in display coordinates.
virtual void	GetTiledSizeAndOrigin (int *width, int *height, int *lowerLeftX, int *lowerLeftY)
	Get the size and origin of the viewport in display coordinates.
double	GetPickX () const
	Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY).
double	GetPickY () const
	Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY).
double	GetPickWidth () const
	Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY).
double	GetPickHeight () const
	Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY).
double	GetPickX1 () const
	Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY).
double	GetPickY1 () const
	Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY).
double	GetPickX2 () const
	Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY).
double	GetPickY2 () const
	Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY).
virtual vtkPropCollection *	GetPickResultProps ()
	Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY).
virtual void	SetEnvironmentalBG (double, double, double)
	Set/Get the constant environmental color using an rgb color specification.
virtual void	SetEnvironmentalBG (double[3])
	Set/Get the constant environmental color using an rgb color specification.
virtual double *	GetEnvironmentalBG ()
	Set/Get the constant environmental color using an rgb color specification.
virtual void	GetEnvironmentalBG (double &, double &, double &)
	Set/Get the constant environmental color using an rgb color specification.
virtual void	GetEnvironmentalBG (double[3])
	Set/Get the constant environmental color using an rgb color specification.
virtual void	SetEnvironmentalBG2 (double, double, double)
	Set/Get the second environmental gradient color using an rgb color specification.
virtual void	SetEnvironmentalBG2 (double[3])
	Set/Get the second environmental gradient color using an rgb color specification.
virtual double *	GetEnvironmentalBG2 ()
	Set/Get the second environmental gradient color using an rgb color specification.
virtual void	GetEnvironmentalBG2 (double &, double &, double &)
	Set/Get the second environmental gradient color using an rgb color specification.
virtual void	GetEnvironmentalBG2 (double[3])
	Set/Get the second environmental gradient color using an rgb color specification.
virtual void	SetGradientEnvironmentalBG (bool)
	Set/Get whether this viewport should enable the gradient environment using the EnvironmentalBG (bottom) and EnvironmentalBG2 (top) colors.
virtual bool	GetGradientEnvironmentalBG ()
	Set/Get whether this viewport should enable the gradient environment using the EnvironmentalBG (bottom) and EnvironmentalBG2 (top) colors.
virtual void	GradientEnvironmentalBGOn ()
	Set/Get whether this viewport should enable the gradient environment using the EnvironmentalBG (bottom) and EnvironmentalBG2 (top) colors.
virtual void	GradientEnvironmentalBGOff ()
	Set/Get whether this viewport should enable the gradient environment using the EnvironmentalBG (bottom) and EnvironmentalBG2 (top) colors.
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	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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 std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
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).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release 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 vtkTypeBool	IsTypeOf (const char *type)
static vtkVRRenderer *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkOpenGLRenderer
static vtkOpenGLRenderer *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkOpenGLRenderer *	SafeDownCast (vtkObjectBase *o)
static bool	HaveAppleQueryAllocationBug ()
	Indicate if this system is subject to the apple/NVIDIA bug that causes crashes in the driver when too many query objects are allocated.
Static Public Member Functions inherited from vtkRenderer
static vtkTypeBool	IsTypeOf (const char *type)
static vtkRenderer *	SafeDownCast (vtkObjectBase *o)
static vtkRenderer *	New ()
	Create a vtkRenderer with a black background, a white ambient light, two-sided lighting turned on, a viewport of (0,0,1,1), and backface culling turned off.
Static Public Member Functions inherited from vtkViewport
static vtkTypeBool	IsTypeOf (const char *type)
static vtkViewport *	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
	vtkVRRenderer ()
	~vtkVRRenderer () override=default
Protected Member Functions inherited from vtkOpenGLRenderer
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkOpenGLRenderer ()
	~vtkOpenGLRenderer () override
void	CheckCompilation (unsigned int fragmentShader)
	Check the compilation status of some fragment shader source.
int	UpdateGeometry (vtkFrameBufferObjectBase *fbo=nullptr) override
	Ask all props to update and draw any opaque and translucent geometry.
vtkTexture *	GetCurrentTexturedBackground ()
	Check and return the textured background for the current state If monocular or stereo left eye, check BackgroundTexture If stereo right eye, check RightBackgroundTexture.
Protected Member Functions inherited from vtkRenderer
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkRenderer ()
	~vtkRenderer () override
virtual void	ExpandBounds (double bounds[6], vtkMatrix4x4 *matrix)
void	AllocateTime ()
const std::array< double, 16 > &	GetCompositeProjectionTransformationMatrix ()
	Gets the ActiveCamera CompositeProjectionTransformationMatrix, only computing it if necessary.
const std::array< double, 16 > &	GetProjectionTransformationMatrix ()
	Gets the ActiveCamera ProjectionTransformationMatrix, only computing it if necessary.
const std::array< double, 16 > &	GetViewTransformMatrix ()
	Gets the ActiveCamera ViewTransformMatrix, only computing it if necessary.
virtual int	UpdateGeometry (vtkFrameBufferObjectBase *fbo=nullptr)
	Ask all props to update and draw any opaque and translucent geometry.
virtual int	UpdateTranslucentPolygonalGeometry ()
	Ask all props to update and draw any translucent polygonal geometry.
virtual int	UpdateOpaquePolygonalGeometry ()
	Ask all props to update and draw any opaque polygonal geometry.
virtual int	UpdateCamera ()
	Ask the active camera to do whatever it needs to do prior to rendering.
virtual vtkTypeBool	UpdateLightGeometry ()
	Update the geometry of the lights in the scene that are not in world space (for instance, Headlights or CameraLights that are attached to the camera).
virtual int	UpdateLights ()
	Ask all lights to load themselves into rendering pipeline.
vtkCamera *	GetActiveCameraAndResetIfCreated ()
	Get the current camera and reset it only if it gets created automatically (see GetActiveCamera).
void	SetSelector (vtkHardwareSelector *selector)
	Called by vtkHardwareSelector when it begins rendering for selection.
Protected Member Functions inherited from vtkViewport
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkViewport ()
	~vtkViewport () 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	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkNew< vtkActor >	FloorActor
bool	ShowFloor = false
Protected Attributes inherited from vtkOpenGLRenderer
vtkOpenGLFXAAFilter *	FXAAFilter
	FXAA is delegated to an instance of vtkOpenGLFXAAFilter.
vtkDepthPeelingPass *	DepthPeelingPass
	Depth peeling is delegated to an instance of vtkDepthPeelingPass.
vtkOrderIndependentTranslucentPass *	TranslucentPass
	Fallback for transparency.
vtkShadowMapPass *	ShadowMapPass
	Shadows are delegated to an instance of vtkShadowMapPass.
vtkSSAOPass *	SSAOPass
	SSAO is delegated to an instance of vtkSSAOPass.
int	DepthPeelingHigherLayer
std::string	LightingDeclaration
int	LightingComplexity
int	LightingCount
vtkMTimeType	LightingUpdateTime
vtkSmartPointer< vtkTransform >	UserLightTransform
	Optional user transform for lights.
vtkSmartPointer< vtkPBRLUTTexture >	EnvMapLookupTable
vtkSmartPointer< vtkPBRIrradianceTexture >	EnvMapIrradiance
vtkSmartPointer< vtkPBRPrefilterTexture >	EnvMapPrefiltered
vtkSmartPointer< vtkFloatArray >	SphericalHarmonics
bool	UseSphericalHarmonics
vtkSmartPointer< vtkTexturedActor2D >	BackgroundTextureActor
vtkSmartPointer< vtkTexturedActor2D >	BackgroundGradientActor
vtkSmartPointer< vtkPolyDataMapper2D >	BackgroundMapper
vtkSmartPointer< vtkPolyData >	BackgroundQuad
Protected Attributes inherited from vtkRenderer
vtkCamera *	ActiveCamera
vtkLight *	CreatedLight
vtkLightCollection *	Lights
vtkCullerCollection *	Cullers
vtkActorCollection *	Actors
vtkVolumeCollection *	Volumes
double	Ambient [3]
vtkRenderWindow *	RenderWindow
double	AllocatedRenderTime
double	TimeFactor
vtkTypeBool	TwoSidedLighting
vtkTypeBool	AutomaticLightCreation
vtkTypeBool	BackingStore
unsigned char *	BackingImage
int	BackingStoreSize [2]
vtkTimeStamp	RenderTime
double	LastRenderTimeInSeconds
vtkTypeBool	LightFollowCamera
int	NumberOfPropsRendered
vtkProp **	PropArray
int	PropArrayCount
vtkTypeBool	Interactive
int	Layer
vtkTypeBool	PreserveColorBuffer
vtkTypeBool	PreserveDepthBuffer
double	ComputedVisiblePropBounds [6]
double	NearClippingPlaneTolerance
	Specifies the minimum distance of the near clipping plane as a percentage of the far clipping plane distance.
double	ClippingRangeExpansion
	Specify enlargement of bounds when resetting the camera clipping range.
vtkTypeBool	Erase
	When this flag is off, the renderer will not erase the background or the Zbuffer.
vtkTypeBool	Draw
	When this flag is off, render commands are ignored.
vtkPropCollection *	GL2PSSpecialPropCollection
	Temporary collection used by vtkRenderWindow::CaptureGL2PSSpecialProps.
bool	UseFXAA
	If this flag is on and the rendering engine supports it, FXAA will be used to antialias the scene.
vtkFXAAOptions *	FXAAOptions
	Holds the FXAA configuration.
vtkTypeBool	UseShadows
	If this flag is on and the rendering engine supports it render shadows Initial value is off.
vtkTypeBool	UseHiddenLineRemoval
	When this flag is on and the rendering engine supports it, wireframe polydata will be rendered using hidden line removal.
vtkTypeBool	UseDepthPeeling
	If this flag is on and the GPU supports it, depth peeling is used for rendering translucent materials.
bool	UseDepthPeelingForVolumes
	This flag is on and the GPU supports it, depth-peel volumes along with the translucent geometry.
double	OcclusionRatio
	In case of use of depth peeling technique for rendering translucent material, define the threshold under which the algorithm stops to iterate over peel layers.
int	MaximumNumberOfPeels
	In case of depth peeling, define the maximum number of peeling layers.
bool	UseSSAO = false
double	SSAORadius = 0.5
double	SSAOBias = 0.01
unsigned int	SSAOKernelSize = 32
bool	SSAOBlur = false
vtkTypeBool	LastRenderingUsedDepthPeeling
	Tells if the last call to DeviceRenderTranslucentPolygonalGeometry() actually used depth peeling.
vtkHardwareSelector *	Selector
vtkRendererDelegate *	Delegate
bool	TexturedBackground
vtkTexture *	BackgroundTexture
vtkTexture *	RightBackgroundTexture
vtkRenderPass *	Pass
vtkInformation *	Information
bool	UseImageBasedLighting
vtkTexture *	EnvironmentTexture
double	EnvironmentUp [3]
double	EnvironmentRight [3]
Protected Attributes inherited from vtkViewport
vtkAssemblyPath *	PickedProp
vtkPropCollection *	PickFromProps
vtkPropCollection *	PickResultProps
double	PickX1
double	PickY1
double	PickX2
double	PickY2
double	PickedZ
vtkPropCollection *	Props
vtkActor2DCollection *	Actors2D
vtkWindow *	VTKWindow
double	Background [3]
double	Background2 [3]
double	BackgroundAlpha
double	Viewport [4]
double	Aspect [2]
double	PixelAspect [2]
double	Center [2]
bool	GradientBackground
bool	DitherGradient
GradientModes	GradientMode = GradientModes::VTK_GRADIENT_VERTICAL
double	EnvironmentalBG [3]
double	EnvironmentalBG2 [3]
bool	GradientEnvironmentalBG
int	Size [2]
int	Origin [2]
double	DisplayPoint [3]
double	ViewPoint [3]
double	WorldPoint [4]
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

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Renderer class for VR/AR context.

vtkVRRenderer is an abstract vtkRenderer class that is meant to be used in VR context. It defines a floor actor with a grid fading with the distance, as well as a cross-like marker that can be attached to the tip of a controller (can be used e.g. to help place points).

Subclasses must define MakeCamera().

Definition at line 25 of file vtkVRRenderer.h.

Member Typedef Documentation

Superclass

typedef vtkOpenGLRenderer vtkVRRenderer::Superclass

Definition at line 28 of file vtkVRRenderer.h.

Constructor & Destructor Documentation

vtkVRRenderer()

vtkVRRenderer::vtkVRRenderer ( )

protected

~vtkVRRenderer()

vtkVRRenderer::~vtkVRRenderer ( )

overrideprotecteddefault

Member Function Documentation

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool vtkVRRenderer::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 vtkOpenGLRenderer.

Reimplemented in vtkOpenVRRenderer, and vtkOpenXRRenderer.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkVRRenderer::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkOpenGLRenderer.

Reimplemented in vtkOpenVRRenderer, and vtkOpenXRRenderer.

NewInstance()

vtkVRRenderer * vtkVRRenderer::NewInstance

(

)

const

PrintSelf()

void vtkVRRenderer::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 vtkOpenGLRenderer.

ResetCamera() [1/4]

void vtkVRRenderer::ResetCamera ( const double  bounds[6] )

overridevirtual

Automatically set up the camera based on a specified bounding box (xmin,xmax, ymin,ymax, zmin,zmax).

Camera will reposition itself so that its focal point is the center of the bounding box, and adjust its distance and position to preserve its initial view plane normal (i.e., vector defined from camera position to focal point). Note: if the view plane is parallel to the view up axis, the view up axis will be reset to one of the three coordinate axes.

Reimplemented from vtkRenderer.

ResetCameraClippingRange() [1/5]

void vtkVRRenderer::ResetCameraClippingRange ( )

overridevirtual

Reset the camera clipping range based on a bounding box.

Reimplemented from vtkRenderer.

ResetCameraClippingRange() [2/5]

void vtkVRRenderer::ResetCameraClippingRange ( const double  bounds[6] )

overridevirtual

Reset the camera clipping range based on a bounding box.

Reimplemented from vtkRenderer.

MakeCamera()

vtkCamera * vtkVRRenderer::MakeCamera ( )

overridepure virtual

Abstract function that creates a new Camera suitable for use with this type of Renderer.

Reimplemented from vtkRenderer.

Implemented in vtkOpenVRRenderer, and vtkOpenXRRenderer.

GetFloorTransform()

virtual void vtkVRRenderer::GetFloorTransform ( vtkTransform *  transform )

virtual

Store in transform the floor transform.

DeviceRender()

void vtkVRRenderer::DeviceRender ( )

overridevirtual

Render the floor using GetFloorTransform.

Reimplemented from vtkOpenGLRenderer.

SetShowFloor()

virtual void vtkVRRenderer::SetShowFloor ( bool  value )

virtual

Set/get whether to show a white floor corresponding to the physical floor.

Default is false.

GetShowFloor()

virtual bool vtkVRRenderer::GetShowFloor ( )

virtual

Set/get whether to show a white floor corresponding to the physical floor.

Default is false.

SetShowLeftMarker()

virtual void vtkVRRenderer::SetShowLeftMarker ( bool  value )

virtual

Set/get whether to display a white cross marker at the tip of the left controller.

Default is false.

GetShowLeftMarker()

virtual bool vtkVRRenderer::GetShowLeftMarker ( )

virtual

Set/get whether to display a white cross marker at the tip of the left controller.

Default is false.

SetShowRightMarker()

virtual void vtkVRRenderer::SetShowRightMarker ( bool  value )

virtual

Set/get whether to display a white cross marker at the tip of the right controller.

Default is false.

GetShowRightMarker()

virtual bool vtkVRRenderer::GetShowRightMarker ( )

virtual

Set/get whether to display a white cross marker at the tip of the right controller.

Default is false.

ResetCamera() [2/4]

virtual void vtkRenderer::ResetCamera ( )

virtual

Automatically set up the camera based on the visible actors.

The camera will reposition itself to view the center point of the actors, and move along its initial view plane normal (i.e., vector defined from camera position to focal point) so that all of the actors can be seen.

Reimplemented from vtkRenderer.

ResetCamera() [3/4]

virtual void vtkRenderer::ResetCamera ( const double  bounds[6] )

virtual

Automatically set up the camera based on a specified bounding box (xmin, xmax, ymin, ymax, zmin, zmax).

Camera will reposition itself so that its focal point is the center of the bounding box, and adjust its distance and position to preserve its initial view plane normal (i.e., vector defined from camera position to focal point). Note: if the view plane is parallel to the view up axis, the view up axis will be reset to one of the three coordinate axes.

Reimplemented from vtkRenderer.

ResetCamera() [4/4]

virtual void vtkRenderer::ResetCamera ( double  xmin, double  xmax, double  ymin, double  ymax, double  zmin, double  zmax  )

virtual

Alternative version of ResetCamera(bounds[6]);.

Reimplemented from vtkRenderer.

ResetCameraClippingRange() [3/5]

virtual void vtkRenderer::ResetCameraClippingRange ( )

virtual

Reset the camera clipping range based on the bounds of the visible actors.

This ensures that no props are cut off

Reimplemented from vtkRenderer.

ResetCameraClippingRange() [4/5]

virtual void vtkRenderer::ResetCameraClippingRange ( const double  bounds[6] )

virtual

Reset the camera clipping range based on a bounding box.

Reimplemented from vtkRenderer.

ResetCameraClippingRange() [5/5]

virtual void vtkRenderer::ResetCameraClippingRange ( double  xmin, double  xmax, double  ymin, double  ymax, double  zmin, double  zmax  )

virtual

Reset the camera clipping range based on a bounding box.

Reimplemented from vtkRenderer.

Member Data Documentation

FloorActor

vtkNew<vtkActor> vtkVRRenderer::FloorActor

protected

Definition at line 100 of file vtkVRRenderer.h.

ShowFloor

bool vtkVRRenderer::ShowFloor = false

protected

Definition at line 101 of file vtkVRRenderer.h.

---

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

• Rendering/VR/vtkVRRenderer.h