vtkRenderer Class Reference

abstract specification for renderers More...

#include <vtkRenderer.h>

Inheritance diagram for vtkRenderer:

Collaboration diagram for vtkRenderer:

Public Types
typedef vtkViewport	Superclass
Public Types inherited from vtkViewport
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.
vtkRenderer *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	AddActor (vtkProp *p)
	Add/Remove different types of props to the renderer.
void	AddVolume (vtkProp *p)
void	RemoveActor (vtkProp *p)
void	RemoveVolume (vtkProp *p)
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 (void)
	Create and add a light to renderer.
virtual vtkLight *	MakeLight ()
	Create a new Light sutible for use with this type of Renderer.
virtual vtkTypeBool	GetTwoSidedLighting ()
	Turn on/off two-sided lighting of surfaces.
virtual void	SetTwoSidedLighting (vtkTypeBool)
virtual void	TwoSidedLightingOn ()
virtual void	TwoSidedLightingOff ()
virtual void	SetLightFollowCamera (vtkTypeBool)
	Turn on/off the automatic repositioning of lights as the camera moves.
virtual vtkTypeBool	GetLightFollowCamera ()
virtual void	LightFollowCameraOn ()
virtual void	LightFollowCameraOff ()
virtual vtkTypeBool	GetAutomaticLightCreation ()
	Turn on/off a flag which disables the automatic light creation capability.
virtual void	SetAutomaticLightCreation (vtkTypeBool)
virtual void	AutomaticLightCreationOn ()
virtual void	AutomaticLightCreationOff ()
virtual vtkTypeBool	UpdateLightsGeometryToFollowCamera (void)
	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.
virtual void	SetErase (vtkTypeBool)
	When this flag is off, the renderer will not erase the background or the Zbuffer.
virtual vtkTypeBool	GetErase ()
virtual void	EraseOn ()
virtual void	EraseOff ()
virtual void	SetDraw (vtkTypeBool)
	When this flag is off, render commands are ignored.
virtual vtkTypeBool	GetDraw ()
virtual void	DrawOn ()
virtual void	DrawOff ()
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 void	SetAmbient (double, double, double)
	Set the intensity of ambient lighting.
virtual void	SetAmbient (double[3])
virtual double *	GetAmbient ()
virtual void	GetAmbient (double data[3])
virtual void	SetAllocatedRenderTime (double)
	Set/Get the amount of time this renderer is allowed to spend rendering its scene.
virtual double	GetAllocatedRenderTime ()
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 (void)
	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	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)
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 ()
virtual void	SetClippingRangeExpansion (double)
	Specify enlargement of bounds when resetting the camera clipping range.
virtual double	GetClippingRangeExpansion ()
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 ()
	Automatically set up the camera based on the visible actors.
virtual void	ResetCameraScreenSpace (const double bounds[6])
	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, const 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)
	Alternative version of ResetCameraScreenSpace(bounds[6]);.
void	SetRenderWindow (vtkRenderWindow *)
	Specify the rendering window in which to draw.
vtkRenderWindow *	GetRenderWindow ()
vtkWindow *	GetVTKWindow () override
	Return the vtkWindow that owns this vtkViewport.
virtual void	SetBackingStore (vtkTypeBool)
	Turn on/off using backing store.
virtual vtkTypeBool	GetBackingStore ()
virtual void	BackingStoreOn ()
virtual void	BackingStoreOff ()
virtual void	SetInteractive (vtkTypeBool)
	Turn on/off interactive status.
virtual vtkTypeBool	GetInteractive ()
virtual void	InteractiveOn ()
virtual void	InteractiveOff ()
virtual void	SetLayer (int layer)
	Set/Get the layer that this renderer belongs to.
virtual int	GetLayer ()
virtual vtkTypeBool	GetPreserveColorBuffer ()
	By default, the renderer at layer 0 is opaque, and all non-zero layer renderers are transparent.
virtual void	SetPreserveColorBuffer (vtkTypeBool)
virtual void	PreserveColorBufferOn ()
virtual void	PreserveColorBufferOff ()
virtual void	SetPreserveDepthBuffer (vtkTypeBool)
	By default, the depth buffer is reset for each renderer.
virtual vtkTypeBool	GetPreserveDepthBuffer ()
virtual void	PreserveDepthBufferOn ()
virtual void	PreserveDepthBufferOff ()
int	Transparent ()
	Returns a boolean indicating if this renderer is transparent.
void	WorldToView () override
	Convert world point coordinates to view coordinates.
void	ViewToWorld () override
	Convert view point coordinates to world coordinates.
void	ViewToWorld (double &wx, double &wy, double &wz) override
	These methods map from one coordinate system to another.
void	WorldToView (double &wx, double &wy, double &wz) override
	Convert world point coordinates to view coordinates.
void	WorldToPose (double &wx, double &wy, double &wz) override
	Convert to from pose coordinates.
void	PoseToWorld (double &wx, double &wy, double &wz) override
	These methods map from one coordinate system to another.
void	ViewToPose (double &wx, double &wy, double &wz) override
	These methods map from one coordinate system to another.
void	PoseToView (double &wx, double &wy, double &wz) override
	These methods map from one coordinate system to another.
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 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 that has the highest z value at the given x1, y1 and x2,y2 positions in the viewport.
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	SetUseDepthPeeling (vtkTypeBool)
	Turn on/off rendering of translucent material with depth peeling technique.
virtual vtkTypeBool	GetUseDepthPeeling ()
virtual void	UseDepthPeelingOn ()
virtual void	UseDepthPeelingOff ()
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	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 ()
virtual void	SetMaximumNumberOfPeels (int)
	In case of depth peeling, define the maximum number of peeling layers.
virtual int	GetMaximumNumberOfPeels ()
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 ()
virtual void	UseSSAOOn ()
virtual void	UseSSAOOff ()
virtual void	SetSSAORadius (double)
	When using SSAO, define the SSAO hemisphere radius.
virtual double	GetSSAORadius ()
virtual void	SetSSAOBias (double)
	When using SSAO, define the bias when comparing samples.
virtual double	GetSSAOBias ()
virtual void	SetSSAOKernelSize (unsigned int)
	When using SSAO, define the number of samples.
virtual unsigned int	GetSSAOKernelSize ()
virtual void	SetSSAOBlur (bool)
	When using SSAO, define blurring of the ambient occlusion.
virtual bool	GetSSAOBlur ()
virtual void	SSAOBlurOn ()
virtual void	SSAOBlurOff ()
void	SetDelegate (vtkRendererDelegate *d)
	Set/Get a custom Render call.
virtual vtkRendererDelegate *	GetDelegate ()
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 ()
virtual void	SetBackgroundTexture (vtkTexture *)
virtual vtkTexture *	GetBackgroundTexture ()
virtual void	SetRightBackgroundTexture (vtkTexture *)
	Set/Get the texture to be used for the right eye background.
virtual vtkTexture *	GetRightBackgroundTexture ()
virtual void	SetTexturedBackground (bool)
	Set/Get whether this viewport should have a textured background.
virtual bool	GetTexturedBackground ()
virtual void	TexturedBackgroundOn ()
virtual void	TexturedBackgroundOff ()
virtual void	ReleaseGraphicsResources (vtkWindow *)
virtual void	SetUseFXAA (bool)
	Turn on/off FXAA anti-aliasing, if supported.
virtual bool	GetUseFXAA ()
virtual void	UseFXAAOn ()
virtual void	UseFXAAOff ()
virtual vtkFXAAOptions *	GetFXAAOptions ()
	The configuration object for FXAA antialiasing.
virtual void	SetFXAAOptions (vtkFXAAOptions *)
virtual void	SetUseShadows (vtkTypeBool)
	Turn on/off rendering of shadows if supported Initial value is off.
virtual vtkTypeBool	GetUseShadows ()
virtual void	UseShadowsOn ()
virtual void	UseShadowsOff ()
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 ()
virtual void	UseHiddenLineRemovalOn ()
virtual void	UseHiddenLineRemovalOff ()
void	SetPass (vtkRenderPass *p)
virtual vtkRenderPass *	GetPass ()
virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.
virtual void	SetInformation (vtkInformation *)
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 ()
virtual void	UseImageBasedLightingOn ()
virtual void	UseImageBasedLightingOff ()
virtual vtkTexture *	GetEnvironmentTexture ()
	Set/Get the environment texture used for image based lighting.
virtual void	SetEnvironmentTexture (vtkTexture *texture, bool isSRGB=false)
virtual double *	GetEnvironmentUp ()
	Set/Get the environment up vector.
virtual void	GetEnvironmentUp (double &, double &, double &)
virtual void	GetEnvironmentUp (double[3])
virtual void	SetEnvironmentUp (double, double, double)
virtual void	SetEnvironmentUp (double[3])
virtual double *	GetEnvironmentRight ()
	Set/Get the environment right vector.
virtual void	GetEnvironmentRight (double &, double &, double &)
virtual void	GetEnvironmentRight (double[3])
virtual void	SetEnvironmentRight (double, double, double)
virtual void	SetEnvironmentRight (double[3])
void	DisplayToWorld ()
	Convert display (or screen) coordinates to world coordinates.
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.
int	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 (void)
	Remove all props from the list of props.
virtual double *	GetCenter ()
	Return the center of this viewport in display coordinates.
virtual int	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 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	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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
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.
virtual 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.

Static Public Member Functions
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 (int 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 int	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
	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 (void)
	Ask the active camera to do whatever it needs to do prior to rendering.
virtual vtkTypeBool	UpdateLightGeometry (void)
	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 (void)
	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 *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
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
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
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Friends
class	vtkHardwareSelector
class	vtkRendererDelegate
class	vtkRenderPass

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

Detailed Description

abstract specification for renderers

vtkRenderer provides an abstract specification for renderers. A renderer is an object that controls the rendering process for objects. Rendering is the process of converting geometry, a specification for lights, and a camera view into an image. vtkRenderer also performs coordinate transformation between world coordinates, view coordinates (the computer graphics rendering coordinate system), and display coordinates (the actual screen coordinates on the display device). Certain advanced rendering features such as two-sided lighting can also be controlled.

See also

vtkRenderWindow vtkActor vtkCamera vtkLight vtkVolume

Events:

vtkCommand::ActiveCameraEvent vtkCommand::ComputeVisiblePropBoundsEvent vtkCommand::CreateCameraEvent vtkCommand::EndEvent vtkCommand::ResetCameraClippingRangeEvent vtkCommand::ResetCameraEvent vtkCommand::StartEvent

Examples:

vtkRenderer (Examples)

Online Examples:

RegularPolygonSource

CreateTree

BorderPixelSize

PBR_Skybox_Texturing

ProjectedTexture

HanoiIntermediate

LabeledDataMapper

PineRootDecimation

TensorAxes

TensorEllipsoids

Tests:

vtkRenderer (Tests)

Definition at line 181 of file vtkRenderer.h.

Member Typedef Documentation

Superclass

typedef vtkViewport vtkRenderer::Superclass

Definition at line 184 of file vtkRenderer.h.

Constructor & Destructor Documentation

vtkRenderer()

vtkRenderer::vtkRenderer ( )

protected

~vtkRenderer()

vtkRenderer::~vtkRenderer ( )

overrideprotected

Member Function Documentation

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool vtkRenderer::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 vtkViewport.

Reimplemented in vtkExternalOpenGLRenderer, vtkOpenGLRenderer, vtkOpenVRRenderer, and vtkVRRenderer.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkRenderer::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkViewport.

Reimplemented in vtkExternalOpenGLRenderer, vtkOpenGLRenderer, vtkOpenVRRenderer, and vtkVRRenderer.

NewInstance()

vtkRenderer * vtkRenderer::NewInstance

(

)

const

PrintSelf()

void vtkRenderer::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 vtkObject.

Reimplemented in vtkExternalOpenGLRenderer, vtkOpenGLRenderer, and vtkVRRenderer.

New()

static vtkRenderer * vtkRenderer::New ( )

static

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.

AddActor()

void vtkRenderer::AddActor

(

vtkProp *

p

)

Add/Remove different types of props to the renderer.

These methods are all synonyms to AddViewProp and RemoveViewProp. They are here for convenience and backwards compatibility.

AddVolume()

void vtkRenderer::AddVolume

(

vtkProp *

p

)

RemoveActor()

void vtkRenderer::RemoveActor

(

vtkProp *

p

)

RemoveVolume()

void vtkRenderer::RemoveVolume

(

vtkProp *

p

)

AddLight()

void vtkRenderer::AddLight

(

vtkLight *

)

Add a light to the list of lights.

RemoveLight()

void vtkRenderer::RemoveLight

(

vtkLight *

)

Remove a light from the list of lights.

RemoveAllLights()

void vtkRenderer::RemoveAllLights

(

)

Remove all lights from the list of lights.

GetLights()

vtkLightCollection * vtkRenderer::GetLights ( )

inline

Return the collection of lights.

Definition at line 1299 of file vtkRenderer.h.

SetLightCollection()

void vtkRenderer::SetLightCollection

(

vtkLightCollection *

lights

)

Set the collection of lights.

We cannot name it SetLights because of TestSetGet

Precondition

lights_exist: lights!=0

Postcondition

lights_set: lights==this->GetLights()

CreateLight()

void vtkRenderer::CreateLight

(

void

)

Create and add a light to renderer.

MakeLight()

virtual vtkLight * vtkRenderer::MakeLight ( )

virtual

Create a new Light sutible for use with this type of Renderer.

For example, a vtkMesaRenderer should create a vtkMesaLight in this function. The default is to just call vtkLight::New.

GetTwoSidedLighting()

virtual vtkTypeBool vtkRenderer::GetTwoSidedLighting ( )

virtual

Turn on/off two-sided lighting of surfaces.

If two-sided lighting is off, then only the side of the surface facing the light(s) will be lit, and the other side dark. If two-sided lighting on, both sides of the surface will be lit.

SetTwoSidedLighting()

virtual void vtkRenderer::SetTwoSidedLighting ( vtkTypeBool  )

virtual

TwoSidedLightingOn()

virtual void vtkRenderer::TwoSidedLightingOn ( )

virtual

TwoSidedLightingOff()

virtual void vtkRenderer::TwoSidedLightingOff ( )

virtual

SetLightFollowCamera()

virtual void vtkRenderer::SetLightFollowCamera ( vtkTypeBool  )

virtual

Turn on/off the automatic repositioning of lights as the camera moves.

If LightFollowCamera is on, lights that are designated as Headlights or CameraLights will be adjusted to move with this renderer's camera. If LightFollowCamera is off, the lights will not be adjusted.

(Note: In previous versions of vtk, this light-tracking functionality was part of the interactors, not the renderer. For backwards compatibility, the older, more limited interactor behavior is enabled by default. To disable this mode, turn the interactor's LightFollowCamera flag OFF, and leave the renderer's LightFollowCamera flag ON.)

GetLightFollowCamera()

virtual vtkTypeBool vtkRenderer::GetLightFollowCamera ( )

virtual

LightFollowCameraOn()

virtual void vtkRenderer::LightFollowCameraOn ( )

virtual

LightFollowCameraOff()

virtual void vtkRenderer::LightFollowCameraOff ( )

virtual

GetAutomaticLightCreation()

virtual vtkTypeBool vtkRenderer::GetAutomaticLightCreation ( )

virtual

Turn on/off a flag which disables the automatic light creation capability.

Normally in VTK if no lights are associated with the renderer, then a light is automatically created. However, in special circumstances this feature is undesirable, so the following boolean is provided to disable automatic light creation. (Turn AutomaticLightCreation off if you do not want lights to be created.)

SetAutomaticLightCreation()

virtual void vtkRenderer::SetAutomaticLightCreation ( vtkTypeBool  )

virtual

AutomaticLightCreationOn()

virtual void vtkRenderer::AutomaticLightCreationOn ( )

virtual

AutomaticLightCreationOff()

virtual void vtkRenderer::AutomaticLightCreationOff ( )

virtual

UpdateLightsGeometryToFollowCamera()

virtual vtkTypeBool vtkRenderer::UpdateLightsGeometryToFollowCamera ( void  )

virtual

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.

GetVolumes()

vtkVolumeCollection * vtkRenderer::GetVolumes

(

)

Return the collection of volumes.

GetActors()

vtkActorCollection * vtkRenderer::GetActors

(

)

Return any actors in this renderer.

SetActiveCamera()

void vtkRenderer::SetActiveCamera

(

vtkCamera *

)

Specify the camera to use for this renderer.

GetActiveCamera()

vtkCamera * vtkRenderer::GetActiveCamera

(

)

Get the current camera.

If there is not camera assigned to the renderer already, a new one is created automatically. This does not reset the camera.

MakeCamera()

virtual vtkCamera * vtkRenderer::MakeCamera ( )

virtual

Create a new Camera sutible for use with this type of Renderer.

For example, a vtkMesaRenderer should create a vtkMesaCamera in this function. The default is to just call vtkCamera::New.

Reimplemented in vtkExternalOpenGLRenderer, vtkOpenVRRenderer, and vtkVRRenderer.

SetErase()

virtual void vtkRenderer::SetErase ( vtkTypeBool  )

virtual

When this flag is off, the renderer will not erase the background or the Zbuffer.

It is used to have overlapping renderers. Both the RenderWindow Erase and Render Erase must be on for the camera to clear the renderer. By default, Erase is on.

GetErase()

virtual vtkTypeBool vtkRenderer::GetErase ( )

virtual

EraseOn()

virtual void vtkRenderer::EraseOn ( )

virtual

EraseOff()

virtual void vtkRenderer::EraseOff ( )

virtual

SetDraw()

virtual void vtkRenderer::SetDraw ( vtkTypeBool  )

virtual

When this flag is off, render commands are ignored.

It is used to either multiplex a vtkRenderWindow or render only part of a vtkRenderWindow. By default, Draw is on.

GetDraw()

virtual vtkTypeBool vtkRenderer::GetDraw ( )

virtual

DrawOn()

virtual void vtkRenderer::DrawOn ( )

virtual

DrawOff()

virtual void vtkRenderer::DrawOff ( )

virtual

CaptureGL2PSSpecialProp()

int vtkRenderer::CaptureGL2PSSpecialProp

(

vtkProp *

)

This function is called to capture an instance of vtkProp that requires special handling during vtkRenderWindow::CaptureGL2PSSpecialProps().

SetGL2PSSpecialPropCollection()

void vtkRenderer::SetGL2PSSpecialPropCollection

(

vtkPropCollection *

)

Set the prop collection object used during vtkRenderWindow::CaptureGL2PSSpecialProps().

Do not call manually, this is handled automatically by the render window.

AddCuller()

void vtkRenderer::AddCuller

(

vtkCuller *

)

Add an culler to the list of cullers.

RemoveCuller()

void vtkRenderer::RemoveCuller

(

vtkCuller *

)

Remove an actor from the list of cullers.

GetCullers()

vtkCullerCollection * vtkRenderer::GetCullers ( )

inline

Return the collection of cullers.

Get the list of cullers for this renderer.

Definition at line 1307 of file vtkRenderer.h.

SetAmbient() [1/2]

virtual void vtkRenderer::SetAmbient ( double  , double  , double    )

virtual

Set the intensity of ambient lighting.

SetAmbient() [2/2]

virtual void vtkRenderer::SetAmbient ( double  [3] )

virtual

GetAmbient() [1/2]

virtual double * vtkRenderer::GetAmbient ( )

virtual

GetAmbient() [2/2]

virtual void vtkRenderer::GetAmbient ( double  data[3] )

virtual

SetAllocatedRenderTime()

virtual void vtkRenderer::SetAllocatedRenderTime ( double  )

virtual

Set/Get the amount of time this renderer is allowed to spend rendering its scene.

This is used by vtkLODActor's.

GetAllocatedRenderTime()

virtual double vtkRenderer::GetAllocatedRenderTime ( )

virtual

GetTimeFactor()

virtual double vtkRenderer::GetTimeFactor ( )

virtual

Get the ratio between allocated time and actual render time.

TimeFactor has been taken out of the render process. It is still computed in case someone finds it useful. It may be taken away in the future.

Render()

virtual void vtkRenderer::Render ( )

virtual

CALLED BY vtkRenderWindow ONLY.

End-user pass your way and call vtkRenderWindow::Render(). Create an image. This is a superclass method which will in turn call the DeviceRender method of Subclasses of vtkRenderer.

Reimplemented in vtkExternalOpenGLRenderer.

DeviceRender()

virtual void vtkRenderer::DeviceRender ( void  )

inlinevirtual

Create an image.

Subclasses of vtkRenderer must implement this method.

Reimplemented in vtkVRRenderer, and vtkOpenGLRenderer.

Definition at line 414 of file vtkRenderer.h.

DeviceRenderOpaqueGeometry()

virtual void vtkRenderer::DeviceRenderOpaqueGeometry ( vtkFrameBufferObjectBase *  fbo = nullptr )

virtual

Render opaque polygonal geometry.

Default implementation just calls UpdateOpaquePolygonalGeometry(). Subclasses of vtkRenderer that can deal with, e.g. hidden line removal must override this method.

Reimplemented in vtkOpenGLRenderer.

DeviceRenderTranslucentPolygonalGeometry()

virtual void vtkRenderer::DeviceRenderTranslucentPolygonalGeometry ( vtkFrameBufferObjectBase *  fbo = nullptr )

virtual

Render translucent polygonal geometry.

Default implementation just call UpdateTranslucentPolygonalGeometry(). Subclasses of vtkRenderer that can deal with depth peeling must override this method. If UseDepthPeeling and UseDepthPeelingForVolumes are true, volumetric data will be rendered here as well. It updates boolean ivar LastRenderingUsedDepthPeeling.

Reimplemented in vtkOpenGLRenderer.

ClearLights()

virtual void vtkRenderer::ClearLights ( void  )

inlinevirtual

Internal method temporarily removes lights before reloading them into graphics pipeline.

Definition at line 439 of file vtkRenderer.h.

Clear()

virtual void vtkRenderer::Clear ( void  )

inlinevirtual

Clear the image to the background color.

Reimplemented in vtkOpenGLRenderer.

Definition at line 444 of file vtkRenderer.h.

VisibleActorCount()

int vtkRenderer::VisibleActorCount

(

)

Returns the number of visible actors.

VisibleVolumeCount()

int vtkRenderer::VisibleVolumeCount

(

)

Returns the number of visible volumes.

ComputeVisiblePropBounds() [1/2]

void vtkRenderer::ComputeVisiblePropBounds

(

double

bounds[6]

)

Compute the bounding box of all the visible props Used in ResetCamera() and ResetCameraClippingRange()

ComputeVisiblePropBounds() [2/2]

double * vtkRenderer::ComputeVisiblePropBounds

(

)

Wrapper-friendly version of ComputeVisiblePropBounds.

ResetCameraClippingRange() [1/3]

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 in vtkVRRenderer, and vtkVRRenderer.

ResetCameraClippingRange() [2/3]

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

virtual

Reset the camera clipping range based on a bounding box.

Reimplemented in vtkVRRenderer, and vtkVRRenderer.

ResetCameraClippingRange() [3/3]

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

virtual

Reimplemented in vtkVRRenderer.

SetNearClippingPlaneTolerance()

virtual void vtkRenderer::SetNearClippingPlaneTolerance ( double  )

virtual

Specify tolerance for near clipping plane distance to the camera as a percentage of the far clipping plane distance.

By default this will be set to 0.01 for 16 bit zbuffers and 0.001 for higher depth z buffers

GetNearClippingPlaneTolerance()

virtual double vtkRenderer::GetNearClippingPlaneTolerance ( )

virtual

SetClippingRangeExpansion()

virtual void vtkRenderer::SetClippingRangeExpansion ( double  )

virtual

Specify enlargement of bounds when resetting the camera clipping range.

By default the range is not expanded by any percent of the (far - near) on the near and far sides

GetClippingRangeExpansion()

virtual double vtkRenderer::GetClippingRangeExpansion ( )

virtual

ResetCamera() [1/3]

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 in vtkVRRenderer.

ResetCamera() [2/3]

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 in vtkVRRenderer, and vtkVRRenderer.

ResetCamera() [3/3]

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

virtual

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

Reimplemented in vtkVRRenderer.

ResetCameraScreenSpace() [1/3]

virtual void vtkRenderer::ResetCameraScreenSpace ( )

virtual

Automatically set up the camera based on the visible actors.

Use a screen space bounding box to zoom closer to the data.

ResetCameraScreenSpace() [2/3]

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

virtual

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

Use a screen space bounding box to zoom closer to the data.

DisplayToWorld() [1/2]

vtkVector3d vtkRenderer::DisplayToWorld

(

const vtkVector3d &

display

)

Convert a vtkVector3d from display space to world space.

ZoomToBoxUsingViewAngle()

void vtkRenderer::ZoomToBoxUsingViewAngle	(	const vtkRecti &	box,
		const double	offsetRatio = 1.0
	)

Automatically set up the camera focal point and zoom factor to observe the box in display coordinates.

OffsetRatio can be used to add a zoom offset.

ResetCameraScreenSpace() [3/3]

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

virtual

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

SetRenderWindow()

void vtkRenderer::SetRenderWindow

(

vtkRenderWindow *

)

Specify the rendering window in which to draw.

This is automatically set when the renderer is created by MakeRenderer. The user probably shouldn't ever need to call this method.

GetRenderWindow()

vtkRenderWindow * vtkRenderer::GetRenderWindow ( )

inline

Definition at line 567 of file vtkRenderer.h.

GetVTKWindow()

vtkWindow * vtkRenderer::GetVTKWindow ( )

overridevirtual

Return the vtkWindow that owns this vtkViewport.

Implements vtkViewport.

SetBackingStore()

virtual void vtkRenderer::SetBackingStore ( vtkTypeBool  )

virtual

Turn on/off using backing store.

This may cause the re-rendering time to be slightly slower when the view changes. But it is much faster when the image has not changed, such as during an expose event.

GetBackingStore()

virtual vtkTypeBool vtkRenderer::GetBackingStore ( )

virtual

BackingStoreOn()

virtual void vtkRenderer::BackingStoreOn ( )

virtual

BackingStoreOff()

virtual void vtkRenderer::BackingStoreOff ( )

virtual

SetInteractive()

virtual void vtkRenderer::SetInteractive ( vtkTypeBool  )

virtual

Turn on/off interactive status.

An interactive renderer is one that can receive events from an interactor. Should only be set if there are multiple renderers in the same section of the viewport.

GetInteractive()

virtual vtkTypeBool vtkRenderer::GetInteractive ( )

virtual

InteractiveOn()

virtual void vtkRenderer::InteractiveOn ( )

virtual

InteractiveOff()

virtual void vtkRenderer::InteractiveOff ( )

virtual

SetLayer()

virtual void vtkRenderer::SetLayer ( int  layer )

virtual

Set/Get the layer that this renderer belongs to.

This is only used if there are layered renderers.

Note: Changing the layer will update the PreserveColorBuffer setting. If the layer is 0, PreserveColorBuffer will be set to false, making the bottom renderer opaque. If the layer is non-zero, PreserveColorBuffer will be set to true, giving the renderer a transparent background. If other PreserveColorBuffer configurations are desired, they must be adjusted after the layer is set.

GetLayer()

virtual int vtkRenderer::GetLayer ( )

virtual

GetPreserveColorBuffer()

virtual vtkTypeBool vtkRenderer::GetPreserveColorBuffer ( )

virtual

By default, the renderer at layer 0 is opaque, and all non-zero layer renderers are transparent.

This flag allows this behavior to be overridden. If true, this setting will force the renderer to preserve the existing color buffer regardless of layer. If false, it will always be cleared at the start of rendering.

This flag influences the Transparent() method, and is updated by calls to SetLayer(). For this reason it should only be set after changing the layer.

SetPreserveColorBuffer()

virtual void vtkRenderer::SetPreserveColorBuffer ( vtkTypeBool  )

virtual

PreserveColorBufferOn()

virtual void vtkRenderer::PreserveColorBufferOn ( )

virtual

PreserveColorBufferOff()

virtual void vtkRenderer::PreserveColorBufferOff ( )

virtual

SetPreserveDepthBuffer()

virtual void vtkRenderer::SetPreserveDepthBuffer ( vtkTypeBool  )

virtual

By default, the depth buffer is reset for each renderer.

If this flag is true, this renderer will use the existing depth buffer for its rendering.

GetPreserveDepthBuffer()

virtual vtkTypeBool vtkRenderer::GetPreserveDepthBuffer ( )

virtual

PreserveDepthBufferOn()

virtual void vtkRenderer::PreserveDepthBufferOn ( )

virtual

PreserveDepthBufferOff()

virtual void vtkRenderer::PreserveDepthBufferOff ( )

virtual

Transparent()

int vtkRenderer::Transparent

(

)

Returns a boolean indicating if this renderer is transparent.

It is transparent if it is not in the deepest layer of its render window.

WorldToView() [1/2]

void vtkRenderer::WorldToView ( )

overridevirtual

Convert world point coordinates to view coordinates.

Reimplemented from vtkViewport.

ViewToWorld() [1/2]

void vtkRenderer::ViewToWorld ( )

overridevirtual

Convert view point coordinates to world coordinates.

Reimplemented from vtkViewport.

ViewToWorld() [2/2]

void vtkRenderer::ViewToWorld ( double &  , double &  , double &    )

overridevirtual

These methods map from one coordinate system to another.

They are primarily used by the vtkCoordinate object and are often strung together. These methods return valid information only if the window has been realized (e.g., GetSize() returns something other than (0,0)).

Reimplemented from vtkViewport.

WorldToView() [2/2]

void vtkRenderer::WorldToView ( double &  wx, double &  wy, double &  wz  )

overridevirtual

Convert world point coordinates to view coordinates.

Reimplemented from vtkViewport.

WorldToPose()

void vtkRenderer::WorldToPose ( double &  wx, double &  wy, double &  wz  )

overridevirtual

Convert to from pose coordinates.

Reimplemented from vtkViewport.

PoseToWorld()

void vtkRenderer::PoseToWorld ( double &  , double &  , double &    )

overridevirtual

These methods map from one coordinate system to another.

They are primarily used by the vtkCoordinate object and are often strung together. These methods return valid information only if the window has been realized (e.g., GetSize() returns something other than (0,0)).

Reimplemented from vtkViewport.

ViewToPose()

void vtkRenderer::ViewToPose ( double &  , double &  , double &    )

overridevirtual

These methods map from one coordinate system to another.

They are primarily used by the vtkCoordinate object and are often strung together. These methods return valid information only if the window has been realized (e.g., GetSize() returns something other than (0,0)).

Reimplemented from vtkViewport.

PoseToView()

void vtkRenderer::PoseToView ( double &  , double &  , double &    )

overridevirtual

These methods map from one coordinate system to another.

They are primarily used by the vtkCoordinate object and are often strung together. These methods return valid information only if the window has been realized (e.g., GetSize() returns something other than (0,0)).

Reimplemented from vtkViewport.

GetZ()

double vtkRenderer::GetZ	(	int	x,
		int	y
	)

Given a pixel location, return the Z value.

The z value is normalized (0,1) between the front and back clipping planes.

GetMTime()

vtkMTimeType vtkRenderer::GetMTime ( )

overridevirtual

Return the MTime of the renderer also considering its ivars.

Reimplemented from vtkObject.

GetLastRenderTimeInSeconds()

virtual double vtkRenderer::GetLastRenderTimeInSeconds ( )

virtual

Get the time required, in seconds, for the last Render call.

GetNumberOfPropsRendered()

virtual int vtkRenderer::GetNumberOfPropsRendered ( )

virtual

Should be used internally only during a render Get the number of props that were rendered using a RenderOpaqueGeometry or RenderTranslucentPolygonalGeometry call.

This is used to know if something is in the frame buffer.

PickProp() [1/2]

vtkAssemblyPath * vtkRenderer::PickProp ( double  selectionX, double  selectionY  )

inlineoverridevirtual

Return the prop (via a vtkAssemblyPath) that has the highest z value at the given x, y position in the viewport.

Basically, the top most prop that renders the pixel at selectionX, selectionY will be returned. If nothing was picked then NULL is returned. This method selects from the renderers Prop list.

Implements vtkViewport.

Definition at line 706 of file vtkRenderer.h.

PickProp() [2/2]

vtkAssemblyPath * vtkRenderer::PickProp ( double  selectionX1, double  selectionY1, double  selectionX2, double  selectionY2  )

overridevirtual

Return the Prop that has the highest z value at the given x1, y1 and x2,y2 positions in the viewport.

Basically, the top most prop that renders the pixel at selectionX1, selectionY1, selectionX2, selectionY2 will be returned. If no Props are there NULL is returned. This method selects from the Viewports Prop list.

Implements vtkViewport.

StereoMidpoint()

virtual void vtkRenderer::StereoMidpoint ( )

inlinevirtual

Do anything necessary between rendering the left and right viewpoints in a stereo render.

Doesn't do anything except in the derived vtkIceTRenderer in ParaView.

Definition at line 719 of file vtkRenderer.h.

GetTiledAspectRatio()

double vtkRenderer::GetTiledAspectRatio

(

)

Compute the aspect ratio of this renderer for the current tile.

When tiled displays are used the aspect ratio of the renderer for a given tile may be different that the aspect ratio of the renderer when rendered in it entirety

IsActiveCameraCreated()

vtkTypeBool vtkRenderer::IsActiveCameraCreated ( )

inline

This method returns 1 if the ActiveCamera has already been set or automatically created by the renderer.

It returns 0 if the ActiveCamera does not yet exist.

Definition at line 734 of file vtkRenderer.h.

SetUseDepthPeeling()

virtual void vtkRenderer::SetUseDepthPeeling ( vtkTypeBool  )

virtual

Turn on/off rendering of translucent material with depth peeling technique.

The render window must have alpha bits (ie call SetAlphaBitPlanes(1)) and no multisample buffer (ie call SetMultiSamples(0) ) to support depth peeling. If UseDepthPeeling is on and the GPU supports it, depth peeling is used for rendering translucent materials. If UseDepthPeeling is off, alpha blending is used. Initial value is off.

GetUseDepthPeeling()

virtual vtkTypeBool vtkRenderer::GetUseDepthPeeling ( )

virtual

UseDepthPeelingOn()

virtual void vtkRenderer::UseDepthPeelingOn ( )

virtual

UseDepthPeelingOff()

virtual void vtkRenderer::UseDepthPeelingOff ( )

virtual

SetUseDepthPeelingForVolumes()

virtual void vtkRenderer::SetUseDepthPeelingForVolumes ( bool  )

virtual

This flag is on and the GPU supports it, depth-peel volumes along with the translucent geometry.

Only supported on OpenGL2 with dual-depth peeling. Default is false.

GetUseDepthPeelingForVolumes()

virtual bool vtkRenderer::GetUseDepthPeelingForVolumes ( )

virtual

UseDepthPeelingForVolumesOn()

virtual void vtkRenderer::UseDepthPeelingForVolumesOn ( )

virtual

UseDepthPeelingForVolumesOff()

virtual void vtkRenderer::UseDepthPeelingForVolumesOff ( )

virtual

SetOcclusionRatio()

virtual void vtkRenderer::SetOcclusionRatio ( double  )

virtual

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.

This is the ratio of the number of pixels that have been touched by the last layer over the total number of pixels of the viewport area. Initial value is 0.0, meaning rendering have to be exact. Greater values may speed-up the rendering with small impact on the quality.

GetOcclusionRatio()

virtual double vtkRenderer::GetOcclusionRatio ( )

virtual

SetMaximumNumberOfPeels()

virtual void vtkRenderer::SetMaximumNumberOfPeels ( int  )

virtual

In case of depth peeling, define the maximum number of peeling layers.

Initial value is 4. A special value of 0 means no maximum limit. It has to be a positive value.

GetMaximumNumberOfPeels()

virtual int vtkRenderer::GetMaximumNumberOfPeels ( )

virtual

GetLastRenderingUsedDepthPeeling()

virtual vtkTypeBool vtkRenderer::GetLastRenderingUsedDepthPeeling ( )

virtual

Tells if the last call to DeviceRenderTranslucentPolygonalGeometry() actually used depth peeling.

Initial value is false.

SetUseSSAO()

virtual void vtkRenderer::SetUseSSAO ( bool  )

virtual

Enable or disable Screen Space Ambient Occlusion.

SSAO darkens some pixels to improve depth perception.

GetUseSSAO()

virtual bool vtkRenderer::GetUseSSAO ( )

virtual

UseSSAOOn()

virtual void vtkRenderer::UseSSAOOn ( )

virtual

UseSSAOOff()

virtual void vtkRenderer::UseSSAOOff ( )

virtual

SetSSAORadius()

virtual void vtkRenderer::SetSSAORadius ( double  )

virtual

When using SSAO, define the SSAO hemisphere radius.

Default is 0.5

GetSSAORadius()

virtual double vtkRenderer::GetSSAORadius ( )

virtual

SetSSAOBias()

virtual void vtkRenderer::SetSSAOBias ( double  )

virtual

When using SSAO, define the bias when comparing samples.

Default is 0.01

GetSSAOBias()

virtual double vtkRenderer::GetSSAOBias ( )

virtual

SetSSAOKernelSize()

virtual void vtkRenderer::SetSSAOKernelSize ( unsigned int  )

virtual

When using SSAO, define the number of samples.

Default is 32

GetSSAOKernelSize()

virtual unsigned int vtkRenderer::GetSSAOKernelSize ( )

virtual

SetSSAOBlur()

virtual void vtkRenderer::SetSSAOBlur ( bool  )

virtual

When using SSAO, define blurring of the ambient occlusion.

Blurring can help to improve the result if samples number is low. Default is false

GetSSAOBlur()

virtual bool vtkRenderer::GetSSAOBlur ( )

virtual

SSAOBlurOn()

virtual void vtkRenderer::SSAOBlurOn ( )

virtual

SSAOBlurOff()

virtual void vtkRenderer::SSAOBlurOff ( )

virtual

SetDelegate()

void vtkRenderer::SetDelegate

(

vtkRendererDelegate *

d

)

Set/Get a custom Render call.

Allows to hook a Render call from an external project.It will be used in place of vtkRenderer::Render() if it is not NULL and its Used ivar is set to true. Initial value is NULL.

GetDelegate()

virtual vtkRendererDelegate * vtkRenderer::GetDelegate ( )

virtual

GetSelector()

virtual vtkHardwareSelector * vtkRenderer::GetSelector ( )

virtual

Get the current hardware selector.

If the Selector is set, it implies the current render pass is for selection. Mappers/Properties may choose to behave differently when rendering for hardware selection.

SetLeftBackgroundTexture()

virtual void vtkRenderer::SetLeftBackgroundTexture ( vtkTexture *  )

virtual

Set/Get the texture to be used for the monocular or stereo left eye background.

If set and enabled this gets the priority over the gradient background.

GetLeftBackgroundTexture()

vtkTexture * vtkRenderer::GetLeftBackgroundTexture

(

)

SetBackgroundTexture()

virtual void vtkRenderer::SetBackgroundTexture ( vtkTexture *  )

virtual

GetBackgroundTexture()

virtual vtkTexture * vtkRenderer::GetBackgroundTexture ( )

virtual

SetRightBackgroundTexture()

virtual void vtkRenderer::SetRightBackgroundTexture ( vtkTexture *  )

virtual

Set/Get the texture to be used for the right eye background.

If set and enabled this gets the priority over the gradient background.

GetRightBackgroundTexture()

virtual vtkTexture * vtkRenderer::GetRightBackgroundTexture ( )

virtual

SetTexturedBackground()

virtual void vtkRenderer::SetTexturedBackground ( bool  )

virtual

Set/Get whether this viewport should have a textured background.

Default is off.

GetTexturedBackground()

virtual bool vtkRenderer::GetTexturedBackground ( )

virtual

TexturedBackgroundOn()

virtual void vtkRenderer::TexturedBackgroundOn ( )

virtual

TexturedBackgroundOff()

virtual void vtkRenderer::TexturedBackgroundOff ( )

virtual

ReleaseGraphicsResources()

virtual void vtkRenderer::ReleaseGraphicsResources ( vtkWindow *  )

virtual

Reimplemented in vtkOpenGLRenderer.

SetUseFXAA()

virtual void vtkRenderer::SetUseFXAA ( bool  )

virtual

Turn on/off FXAA anti-aliasing, if supported.

Initial value is off.

GetUseFXAA()

virtual bool vtkRenderer::GetUseFXAA ( )

virtual

UseFXAAOn()

virtual void vtkRenderer::UseFXAAOn ( )

virtual

UseFXAAOff()

virtual void vtkRenderer::UseFXAAOff ( )

virtual

GetFXAAOptions()

virtual vtkFXAAOptions * vtkRenderer::GetFXAAOptions ( )

virtual

The configuration object for FXAA antialiasing.

SetFXAAOptions()

virtual void vtkRenderer::SetFXAAOptions ( vtkFXAAOptions *  )

virtual

SetUseShadows()

virtual void vtkRenderer::SetUseShadows ( vtkTypeBool  )

virtual

Turn on/off rendering of shadows if supported Initial value is off.

GetUseShadows()

virtual vtkTypeBool vtkRenderer::GetUseShadows ( )

virtual

UseShadowsOn()

virtual void vtkRenderer::UseShadowsOn ( )

virtual

UseShadowsOff()

virtual void vtkRenderer::UseShadowsOff ( )

virtual

SetUseHiddenLineRemoval()

virtual void vtkRenderer::SetUseHiddenLineRemoval ( vtkTypeBool  )

virtual

If this flag is true and the rendering engine supports it, wireframe geometry will be drawn using hidden line removal.

GetUseHiddenLineRemoval()

virtual vtkTypeBool vtkRenderer::GetUseHiddenLineRemoval ( )

virtual

UseHiddenLineRemovalOn()

virtual void vtkRenderer::UseHiddenLineRemovalOn ( )

virtual

UseHiddenLineRemovalOff()

virtual void vtkRenderer::UseHiddenLineRemovalOff ( )

virtual

SetPass()

void vtkRenderer::SetPass

(

vtkRenderPass *

p

)

GetPass()

virtual vtkRenderPass * vtkRenderer::GetPass ( )

virtual

GetInformation()

virtual vtkInformation * vtkRenderer::GetInformation ( )

virtual

Set/Get the information object associated with this algorithm.

SetInformation()

virtual void vtkRenderer::SetInformation ( vtkInformation *  )

virtual

SetUseImageBasedLighting()

virtual void vtkRenderer::SetUseImageBasedLighting ( bool  )

virtual

If this flag is true and the rendering engine supports it, image based lighting is enabled and surface rendering displays environment reflections.

The input cube map have to be set with SetEnvironmentCubeMap. If not cubemap is specified, this feature is disable.

GetUseImageBasedLighting()

virtual bool vtkRenderer::GetUseImageBasedLighting ( )

virtual

UseImageBasedLightingOn()

virtual void vtkRenderer::UseImageBasedLightingOn ( )

virtual

UseImageBasedLightingOff()

virtual void vtkRenderer::UseImageBasedLightingOff ( )

virtual

GetEnvironmentTexture()

virtual vtkTexture * vtkRenderer::GetEnvironmentTexture ( )

virtual

Set/Get the environment texture used for image based lighting.

This texture is supposed to represent the scene background. If it is not a cubemap, the texture is supposed to represent an equirectangular projection. If used with raytracing backends, the texture must be an equirectangular projection and must be constructed with a valid vtkImageData. Warning, this texture must be expressed in linear color space. If the texture is in sRGB color space, set the color flag on the texture or set the argument isSRGB to true.

See also

vtkTexture::UseSRGBColorSpaceOn

SetEnvironmentTexture()

virtual void vtkRenderer::SetEnvironmentTexture ( vtkTexture *  texture, bool  isSRGB = false  )

virtual

Reimplemented in vtkOpenGLRenderer.

GetEnvironmentUp() [1/3]

virtual double * vtkRenderer::GetEnvironmentUp ( )

virtual

Set/Get the environment up vector.

GetEnvironmentUp() [2/3]

virtual void vtkRenderer::GetEnvironmentUp ( double &  , double &  , double &    )

virtual

GetEnvironmentUp() [3/3]

virtual void vtkRenderer::GetEnvironmentUp ( double  [3] )

virtual

SetEnvironmentUp() [1/2]

virtual void vtkRenderer::SetEnvironmentUp ( double  , double  , double    )

virtual

SetEnvironmentUp() [2/2]

virtual void vtkRenderer::SetEnvironmentUp ( double  [3] )

virtual

GetEnvironmentRight() [1/3]

virtual double * vtkRenderer::GetEnvironmentRight ( )

virtual

Set/Get the environment right vector.

GetEnvironmentRight() [2/3]

virtual void vtkRenderer::GetEnvironmentRight ( double &  , double &  , double &    )

virtual

GetEnvironmentRight() [3/3]

virtual void vtkRenderer::GetEnvironmentRight ( double  [3] )

virtual

SetEnvironmentRight() [1/2]

virtual void vtkRenderer::SetEnvironmentRight ( double  , double  , double    )

virtual

SetEnvironmentRight() [2/2]

virtual void vtkRenderer::SetEnvironmentRight ( double  [3] )

virtual

ExpandBounds()

virtual void vtkRenderer::ExpandBounds ( double  bounds[6], vtkMatrix4x4 *  matrix  )

protectedvirtual

AllocateTime()

void vtkRenderer::AllocateTime ( )

protected

GetCompositeProjectionTransformationMatrix()

const std::array< double, 16 > & vtkRenderer::GetCompositeProjectionTransformationMatrix ( )

protected

Gets the ActiveCamera CompositeProjectionTransformationMatrix, only computing it if necessary.

This function expects that this->ActiveCamera is not nullptr.

GetProjectionTransformationMatrix()

const std::array< double, 16 > & vtkRenderer::GetProjectionTransformationMatrix ( )

protected

Gets the ActiveCamera ProjectionTransformationMatrix, only computing it if necessary.

This function expects that this->ActiveCamera is not nullptr.

GetViewTransformMatrix()

const std::array< double, 16 > & vtkRenderer::GetViewTransformMatrix ( )

protected

Gets the ActiveCamera ViewTransformMatrix, only computing it if necessary.

This function expects that this->ActiveCamera is not nullptr.

UpdateGeometry()

virtual int vtkRenderer::UpdateGeometry ( vtkFrameBufferObjectBase *  fbo = nullptr )

protectedvirtual

Ask all props to update and draw any opaque and translucent geometry.

This includes both vtkActors and vtkVolumes Returns the number of props that rendered geometry.

Reimplemented in vtkOpenGLRenderer.

UpdateTranslucentPolygonalGeometry()

virtual int vtkRenderer::UpdateTranslucentPolygonalGeometry ( )

protectedvirtual

Ask all props to update and draw any translucent polygonal geometry.

This includes both vtkActors and vtkVolumes Return the number of rendered props. It is called once with alpha blending technique. It is called multiple times with depth peeling technique.

UpdateOpaquePolygonalGeometry()

virtual int vtkRenderer::UpdateOpaquePolygonalGeometry ( )

protectedvirtual

Ask all props to update and draw any opaque polygonal geometry.

This includes both vtkActors and vtkVolumes Return the number of rendered props.

UpdateCamera()

virtual int vtkRenderer::UpdateCamera ( void  )

protectedvirtual

Ask the active camera to do whatever it needs to do prior to rendering.

Creates a camera if none found active.

UpdateLightGeometry()

virtual vtkTypeBool vtkRenderer::UpdateLightGeometry ( void  )

protectedvirtual

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).

UpdateLights()

virtual int vtkRenderer::UpdateLights ( void  )

inlineprotectedvirtual

Ask all lights to load themselves into rendering pipeline.

This method will return the actual number of lights that were on.

Reimplemented in vtkOpenGLRenderer.

Definition at line 1142 of file vtkRenderer.h.

GetActiveCameraAndResetIfCreated()

vtkCamera * vtkRenderer::GetActiveCameraAndResetIfCreated ( )

protected

Get the current camera and reset it only if it gets created automatically (see GetActiveCamera).

This is only used internally.

SetSelector()

void vtkRenderer::SetSelector ( vtkHardwareSelector *  selector )

inlineprotected

Called by vtkHardwareSelector when it begins rendering for selection.

Definition at line 1225 of file vtkRenderer.h.

DisplayToWorld() [2/2]

void vtkViewport::DisplayToWorld ( )

inline

Convert display (or screen) coordinates to world coordinates.

Definition at line 227 of file vtkViewport.h.

Friends And Related Function Documentation

vtkHardwareSelector

friend class vtkHardwareSelector

friend

Definition at line 1220 of file vtkRenderer.h.

vtkRendererDelegate

friend class vtkRendererDelegate

friend

Definition at line 1235 of file vtkRenderer.h.

vtkRenderPass

friend class vtkRenderPass

friend

Definition at line 1242 of file vtkRenderer.h.

Member Data Documentation

ActiveCamera

vtkCamera* vtkRenderer::ActiveCamera

protected

Definition at line 999 of file vtkRenderer.h.

CreatedLight

vtkLight* vtkRenderer::CreatedLight

protected

Definition at line 1000 of file vtkRenderer.h.

Lights

vtkLightCollection* vtkRenderer::Lights

protected

Definition at line 1002 of file vtkRenderer.h.

Cullers

vtkCullerCollection* vtkRenderer::Cullers

protected

Definition at line 1003 of file vtkRenderer.h.

Actors

vtkActorCollection* vtkRenderer::Actors

protected

Definition at line 1005 of file vtkRenderer.h.

Volumes

vtkVolumeCollection* vtkRenderer::Volumes

protected

Definition at line 1006 of file vtkRenderer.h.

Ambient

double vtkRenderer::Ambient[3]

protected

Definition at line 1008 of file vtkRenderer.h.

RenderWindow

vtkRenderWindow* vtkRenderer::RenderWindow

protected

Definition at line 1009 of file vtkRenderer.h.

AllocatedRenderTime

double vtkRenderer::AllocatedRenderTime

protected

Definition at line 1010 of file vtkRenderer.h.

TimeFactor

double vtkRenderer::TimeFactor

protected

Definition at line 1011 of file vtkRenderer.h.

TwoSidedLighting

vtkTypeBool vtkRenderer::TwoSidedLighting

protected

Definition at line 1012 of file vtkRenderer.h.

AutomaticLightCreation

vtkTypeBool vtkRenderer::AutomaticLightCreation

protected

Definition at line 1013 of file vtkRenderer.h.

BackingStore

vtkTypeBool vtkRenderer::BackingStore

protected

Definition at line 1014 of file vtkRenderer.h.

BackingImage

unsigned char* vtkRenderer::BackingImage

protected

Definition at line 1015 of file vtkRenderer.h.

BackingStoreSize

int vtkRenderer::BackingStoreSize[2]

protected

Definition at line 1016 of file vtkRenderer.h.

RenderTime

vtkTimeStamp vtkRenderer::RenderTime

protected

Definition at line 1017 of file vtkRenderer.h.

LastRenderTimeInSeconds

double vtkRenderer::LastRenderTimeInSeconds

protected

Definition at line 1019 of file vtkRenderer.h.

LightFollowCamera

vtkTypeBool vtkRenderer::LightFollowCamera

protected

Definition at line 1021 of file vtkRenderer.h.

NumberOfPropsRendered

int vtkRenderer::NumberOfPropsRendered

protected

Definition at line 1028 of file vtkRenderer.h.

PropArray

vtkProp** vtkRenderer::PropArray

protected

Definition at line 1032 of file vtkRenderer.h.

PropArrayCount

int vtkRenderer::PropArrayCount

protected

Definition at line 1033 of file vtkRenderer.h.

Interactive

vtkTypeBool vtkRenderer::Interactive

protected

Definition at line 1037 of file vtkRenderer.h.

Layer

int vtkRenderer::Layer

protected

Definition at line 1041 of file vtkRenderer.h.

PreserveColorBuffer

vtkTypeBool vtkRenderer::PreserveColorBuffer

protected

Definition at line 1042 of file vtkRenderer.h.

PreserveDepthBuffer

vtkTypeBool vtkRenderer::PreserveDepthBuffer

protected

Definition at line 1043 of file vtkRenderer.h.

ComputedVisiblePropBounds

double vtkRenderer::ComputedVisiblePropBounds[6]

protected

Definition at line 1047 of file vtkRenderer.h.

NearClippingPlaneTolerance

double vtkRenderer::NearClippingPlaneTolerance

protected

Specifies the minimum distance of the near clipping plane as a percentage of the far clipping plane distance.

Values below this threshold are clipped to NearClippingPlaneTolerance*range[1]. Note that values which are too small may cause problems on systems with low z-buffer resolution.

Definition at line 1056 of file vtkRenderer.h.

ClippingRangeExpansion

double vtkRenderer::ClippingRangeExpansion

protected

Specify enlargement of bounds when resetting the camera clipping range.

Definition at line 1062 of file vtkRenderer.h.

Erase

vtkTypeBool vtkRenderer::Erase

protected

When this flag is off, the renderer will not erase the background or the Zbuffer.

It is used to have overlapping renderers. Both the RenderWindow Erase and Render Erase must be on for the camera to clear the renderer. By default, Erase is on.

Definition at line 1070 of file vtkRenderer.h.

Draw

vtkTypeBool vtkRenderer::Draw

protected

When this flag is off, render commands are ignored.

It is used to either multiplex a vtkRenderWindow or render only part of a vtkRenderWindow. By default, Draw is on.

Definition at line 1077 of file vtkRenderer.h.

GL2PSSpecialPropCollection

vtkPropCollection* vtkRenderer::GL2PSSpecialPropCollection

protected

Temporary collection used by vtkRenderWindow::CaptureGL2PSSpecialProps.

Definition at line 1082 of file vtkRenderer.h.

UseFXAA

bool vtkRenderer::UseFXAA

protected

If this flag is on and the rendering engine supports it, FXAA will be used to antialias the scene.

Default is off.

Definition at line 1155 of file vtkRenderer.h.

FXAAOptions

vtkFXAAOptions* vtkRenderer::FXAAOptions

protected

Holds the FXAA configuration.

Definition at line 1160 of file vtkRenderer.h.

UseShadows

vtkTypeBool vtkRenderer::UseShadows

protected

If this flag is on and the rendering engine supports it render shadows Initial value is off.

Definition at line 1166 of file vtkRenderer.h.

UseHiddenLineRemoval

vtkTypeBool vtkRenderer::UseHiddenLineRemoval

protected

When this flag is on and the rendering engine supports it, wireframe polydata will be rendered using hidden line removal.

Definition at line 1172 of file vtkRenderer.h.

UseDepthPeeling

vtkTypeBool vtkRenderer::UseDepthPeeling

protected

If this flag is on and the GPU supports it, depth peeling is used for rendering translucent materials.

If this flag is off, alpha blending is used. Initial value is off.

Definition at line 1180 of file vtkRenderer.h.

UseDepthPeelingForVolumes

bool vtkRenderer::UseDepthPeelingForVolumes

protected

This flag is on and the GPU supports it, depth-peel volumes along with the translucent geometry.

Default is false;

Definition at line 1186 of file vtkRenderer.h.

OcclusionRatio

double vtkRenderer::OcclusionRatio

protected

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.

This is the ratio of the number of pixels that have been touched by the last layer over the total number of pixels of the viewport area. Initial value is 0.0, meaning rendering have to be exact. Greater values may speed-up the rendering with small impact on the quality.

Definition at line 1197 of file vtkRenderer.h.

MaximumNumberOfPeels

int vtkRenderer::MaximumNumberOfPeels

protected

In case of depth peeling, define the maximum number of peeling layers.

Initial value is 4. A special value of 0 means no maximum limit. It has to be a positive value.

Definition at line 1204 of file vtkRenderer.h.

UseSSAO

bool vtkRenderer::UseSSAO = false

protected

Definition at line 1206 of file vtkRenderer.h.

SSAORadius

double vtkRenderer::SSAORadius = 0.5

protected

Definition at line 1207 of file vtkRenderer.h.

SSAOBias

double vtkRenderer::SSAOBias = 0.01

protected

Definition at line 1208 of file vtkRenderer.h.

SSAOKernelSize

unsigned int vtkRenderer::SSAOKernelSize = 32

protected

Definition at line 1209 of file vtkRenderer.h.

SSAOBlur

bool vtkRenderer::SSAOBlur = false

protected

Definition at line 1210 of file vtkRenderer.h.

LastRenderingUsedDepthPeeling

vtkTypeBool vtkRenderer::LastRenderingUsedDepthPeeling

protected

Tells if the last call to DeviceRenderTranslucentPolygonalGeometry() actually used depth peeling.

Initial value is false.

Definition at line 1217 of file vtkRenderer.h.

Selector

vtkHardwareSelector* vtkRenderer::Selector

protected

Definition at line 1232 of file vtkRenderer.h.

Delegate

vtkRendererDelegate* vtkRenderer::Delegate

protected

Definition at line 1236 of file vtkRenderer.h.

TexturedBackground

bool vtkRenderer::TexturedBackground

protected

Definition at line 1238 of file vtkRenderer.h.

BackgroundTexture

vtkTexture* vtkRenderer::BackgroundTexture

protected

Definition at line 1239 of file vtkRenderer.h.

RightBackgroundTexture

vtkTexture* vtkRenderer::RightBackgroundTexture

protected

Definition at line 1240 of file vtkRenderer.h.

Pass

vtkRenderPass* vtkRenderer::Pass

protected

Definition at line 1243 of file vtkRenderer.h.

Information

vtkInformation* vtkRenderer::Information

protected

Definition at line 1246 of file vtkRenderer.h.

UseImageBasedLighting

bool vtkRenderer::UseImageBasedLighting

protected

Definition at line 1248 of file vtkRenderer.h.

EnvironmentTexture

vtkTexture* vtkRenderer::EnvironmentTexture

protected

Definition at line 1249 of file vtkRenderer.h.

EnvironmentUp

double vtkRenderer::EnvironmentUp[3]

protected

Definition at line 1251 of file vtkRenderer.h.

EnvironmentRight

double vtkRenderer::EnvironmentRight[3]

protected

Definition at line 1252 of file vtkRenderer.h.

---

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

• Rendering/Core/vtkRenderer.h