VTK  9.0.20201129
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkRenderer Class Reference

abstract specification for renderers More...

#include <vtkRenderer.h>

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

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. More...
 
vtkRendererNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void AddActor (vtkProp *p)
 Add/Remove different types of props to the renderer. More...
 
void AddVolume (vtkProp *p)
 
void RemoveActor (vtkProp *p)
 
void RemoveVolume (vtkProp *p)
 
void AddLight (vtkLight *)
 Add a light to the list of lights. More...
 
void RemoveLight (vtkLight *)
 Remove a light from the list of lights. More...
 
void RemoveAllLights ()
 Remove all lights from the list of lights. More...
 
vtkLightCollectionGetLights ()
 Return the collection of lights. More...
 
void SetLightCollection (vtkLightCollection *lights)
 Set the collection of lights. More...
 
void CreateLight (void)
 Create and add a light to renderer. More...
 
virtual vtkLightMakeLight ()
 Create a new Light sutible for use with this type of Renderer. More...
 
virtual vtkTypeBool GetTwoSidedLighting ()
 Turn on/off two-sided lighting of surfaces. More...
 
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. More...
 
virtual vtkTypeBool GetLightFollowCamera ()
 
virtual void LightFollowCameraOn ()
 
virtual void LightFollowCameraOff ()
 
virtual vtkTypeBool GetAutomaticLightCreation ()
 Turn on/off a flag which disables the automatic light creation capability. More...
 
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. More...
 
vtkVolumeCollectionGetVolumes ()
 Return the collection of volumes. More...
 
vtkActorCollectionGetActors ()
 Return any actors in this renderer. More...
 
void SetActiveCamera (vtkCamera *)
 Specify the camera to use for this renderer. More...
 
vtkCameraGetActiveCamera ()
 Get the current camera. More...
 
virtual vtkCameraMakeCamera ()
 Create a new Camera sutible for use with this type of Renderer. More...
 
virtual void SetErase (vtkTypeBool)
 When this flag is off, the renderer will not erase the background or the Zbuffer. More...
 
virtual vtkTypeBool GetErase ()
 
virtual void EraseOn ()
 
virtual void EraseOff ()
 
virtual void SetDraw (vtkTypeBool)
 When this flag is off, render commands are ignored. More...
 
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(). More...
 
void SetGL2PSSpecialPropCollection (vtkPropCollection *)
 Set the prop collection object used during vtkRenderWindow::CaptureGL2PSSpecialProps(). More...
 
void AddCuller (vtkCuller *)
 Add an culler to the list of cullers. More...
 
void RemoveCuller (vtkCuller *)
 Remove an actor from the list of cullers. More...
 
vtkCullerCollectionGetCullers ()
 Return the collection of cullers. More...
 
virtual void SetAmbient (double, double, double)
 Set the intensity of ambient lighting. More...
 
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. More...
 
virtual double GetAllocatedRenderTime ()
 
virtual double GetTimeFactor ()
 Get the ratio between allocated time and actual render time. More...
 
virtual void Render ()
 CALLED BY vtkRenderWindow ONLY. More...
 
virtual void DeviceRender ()
 Create an image. More...
 
virtual void DeviceRenderOpaqueGeometry (vtkFrameBufferObjectBase *fbo=nullptr)
 Render opaque polygonal geometry. More...
 
virtual void DeviceRenderTranslucentPolygonalGeometry (vtkFrameBufferObjectBase *fbo=nullptr)
 Render translucent polygonal geometry. More...
 
virtual void ClearLights (void)
 Internal method temporarily removes lights before reloading them into graphics pipeline. More...
 
virtual void Clear ()
 Clear the image to the background color. More...
 
int VisibleActorCount ()
 Returns the number of visible actors. More...
 
int VisibleVolumeCount ()
 Returns the number of visible volumes. More...
 
void ComputeVisiblePropBounds (double bounds[6])
 Compute the bounding box of all the visible props Used in ResetCamera() and ResetCameraClippingRange() More...
 
double * ComputeVisiblePropBounds ()
 Wrapper-friendly version of ComputeVisiblePropBounds. More...
 
virtual void ResetCameraClippingRange ()
 Reset the camera clipping range based on the bounds of the visible actors. More...
 
virtual void ResetCameraClippingRange (const double bounds[6])
 Reset the camera clipping range based on a bounding box. More...
 
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. More...
 
virtual double GetNearClippingPlaneTolerance ()
 
virtual void SetClippingRangeExpansion (double)
 Specify enlargement of bounds when resetting the camera clipping range. More...
 
virtual double GetClippingRangeExpansion ()
 
virtual void ResetCamera ()
 Automatically set up the camera based on the visible actors. More...
 
virtual void ResetCamera (const double bounds[6])
 Automatically set up the camera based on a specified bounding box (xmin,xmax, ymin,ymax, zmin,zmax). More...
 
virtual void ResetCamera (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
 Alternative version of ResetCamera(bounds[6]);. More...
 
void SetRenderWindow (vtkRenderWindow *)
 Specify the rendering window in which to draw. More...
 
vtkRenderWindowGetRenderWindow ()
 
vtkWindowGetVTKWindow () override
 Return the vtkWindow that owns this vtkViewport. More...
 
virtual void SetBackingStore (vtkTypeBool)
 Turn on/off using backing store. More...
 
virtual vtkTypeBool GetBackingStore ()
 
virtual void BackingStoreOn ()
 
virtual void BackingStoreOff ()
 
virtual void SetInteractive (vtkTypeBool)
 Turn on/off interactive status. More...
 
virtual vtkTypeBool GetInteractive ()
 
virtual void InteractiveOn ()
 
virtual void InteractiveOff ()
 
virtual void SetLayer (int layer)
 Set/Get the layer that this renderer belongs to. More...
 
virtual int GetLayer ()
 
virtual vtkTypeBool GetPreserveColorBuffer ()
 By default, the renderer at layer 0 is opaque, and all non-zero layer renderers are transparent. More...
 
virtual void SetPreserveColorBuffer (vtkTypeBool)
 
virtual void PreserveColorBufferOn ()
 
virtual void PreserveColorBufferOff ()
 
virtual void SetPreserveDepthBuffer (vtkTypeBool)
 By default, the depth buffer is reset for each renderer. More...
 
virtual vtkTypeBool GetPreserveDepthBuffer ()
 
virtual void PreserveDepthBufferOn ()
 
virtual void PreserveDepthBufferOff ()
 
int Transparent ()
 Returns a boolean indicating if this renderer is transparent. More...
 
void WorldToView () override
 Convert world point coordinates to view coordinates. More...
 
void ViewToWorld () override
 Convert view point coordinates to world coordinates. More...
 
void ViewToWorld (double &wx, double &wy, double &wz) override
 
void WorldToView (double &wx, double &wy, double &wz) override
 Convert world point coordinates to view coordinates. More...
 
void WorldToPose (double &wx, double &wy, double &wz) override
 Convert to from pose coordinates. More...
 
void PoseToWorld (double &wx, double &wy, double &wz) override
 
void ViewToPose (double &wx, double &wy, double &wz) override
 
void PoseToView (double &wx, double &wy, double &wz) override
 
double GetZ (int x, int y)
 Given a pixel location, return the Z value. More...
 
vtkMTimeType GetMTime () override
 Return the MTime of the renderer also considering its ivars. More...
 
virtual double GetLastRenderTimeInSeconds ()
 Get the time required, in seconds, for the last Render call. More...
 
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. More...
 
vtkAssemblyPathPickProp (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. More...
 
vtkAssemblyPathPickProp (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. More...
 
virtual void StereoMidpoint ()
 Do anything necessary between rendering the left and right viewpoints in a stereo render. More...
 
double GetTiledAspectRatio ()
 Compute the aspect ratio of this renderer for the current tile. More...
 
vtkTypeBool IsActiveCameraCreated ()
 This method returns 1 if the ActiveCamera has already been set or automatically created by the renderer. More...
 
virtual void SetUseDepthPeeling (vtkTypeBool)
 Turn on/off rendering of translucent material with depth peeling technique. More...
 
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. More...
 
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. More...
 
virtual double GetOcclusionRatio ()
 
virtual void SetMaximumNumberOfPeels (int)
 In case of depth peeling, define the maximum number of peeling layers. More...
 
virtual int GetMaximumNumberOfPeels ()
 
virtual vtkTypeBool GetLastRenderingUsedDepthPeeling ()
 Tells if the last call to DeviceRenderTranslucentPolygonalGeometry() actually used depth peeling. More...
 
virtual void SetUseSSAO (bool)
 Enable or disable Screen Space Ambient Occlusion. More...
 
virtual bool GetUseSSAO ()
 
virtual void UseSSAOOn ()
 
virtual void UseSSAOOff ()
 
virtual void SetSSAORadius (double)
 When using SSAO, define the SSAO hemisphere radius. More...
 
virtual double GetSSAORadius ()
 
virtual void SetSSAOBias (double)
 When using SSAO, define the bias when comparing samples. More...
 
virtual double GetSSAOBias ()
 
virtual void SetSSAOKernelSize (unsigned int)
 When using SSAO, define the number of samples. More...
 
virtual unsigned int GetSSAOKernelSize ()
 
virtual void SetSSAOBlur (bool)
 When using SSAO, define blurring of the ambient occlusion. More...
 
virtual bool GetSSAOBlur ()
 
virtual void SSAOBlurOn ()
 
virtual void SSAOBlurOff ()
 
void SetDelegate (vtkRendererDelegate *d)
 Set/Get a custom Render call. More...
 
virtual vtkRendererDelegateGetDelegate ()
 
virtual vtkHardwareSelectorGetSelector ()
 Get the current hardware selector. More...
 
virtual void SetLeftBackgroundTexture (vtkTexture *)
 Set/Get the texture to be used for the monocular or stereo left eye background. More...
 
vtkTextureGetLeftBackgroundTexture ()
 
virtual void SetBackgroundTexture (vtkTexture *)
 
virtual vtkTextureGetBackgroundTexture ()
 
virtual void SetRightBackgroundTexture (vtkTexture *)
 Set/Get the texture to be used for the right eye background. More...
 
virtual vtkTextureGetRightBackgroundTexture ()
 
virtual void SetTexturedBackground (bool)
 Set/Get whether this viewport should have a textured background. More...
 
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. More...
 
virtual bool GetUseFXAA ()
 
virtual void UseFXAAOn ()
 
virtual void UseFXAAOff ()
 
virtual vtkFXAAOptionsGetFXAAOptions ()
 The configuration object for FXAA antialiasing. More...
 
virtual void SetFXAAOptions (vtkFXAAOptions *)
 
virtual void SetUseShadows (vtkTypeBool)
 Turn on/off rendering of shadows if supported Initial value is off. More...
 
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. More...
 
virtual vtkTypeBool GetUseHiddenLineRemoval ()
 
virtual void UseHiddenLineRemovalOn ()
 
virtual void UseHiddenLineRemovalOff ()
 
void SetPass (vtkRenderPass *p)
 
virtual vtkRenderPassGetPass ()
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
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. More...
 
virtual bool GetUseImageBasedLighting ()
 
virtual void UseImageBasedLightingOn ()
 
virtual void UseImageBasedLightingOff ()
 
virtual vtkTextureGetEnvironmentTexture ()
 Set/Get the environment texture used for image based lighting. More...
 
virtual void SetEnvironmentTexture (vtkTexture *texture, bool isSRGB=false)
 
virtual double * GetEnvironmentUp ()
 Set/Get the environment up vector. More...
 
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. More...
 
virtual void GetEnvironmentRight (double &, double &, double &)
 
virtual void GetEnvironmentRight (double[3])
 
virtual void SetEnvironmentRight (double, double, double)
 
virtual void SetEnvironmentRight (double[3])
 
- Public Member Functions inherited from vtkViewport
vtkViewportNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void AddViewProp (vtkProp *)
 Add a prop to the list of props. More...
 
vtkPropCollectionGetViewProps ()
 Return any props in this viewport. More...
 
int HasViewProp (vtkProp *)
 Query if a prop is in the list of props. More...
 
void RemoveViewProp (vtkProp *)
 Remove a prop from the list of props. More...
 
void RemoveAllViewProps (void)
 Remove all props from the list of props. More...
 
void AddActor2D (vtkProp *p)
 Add/Remove different types of props to the renderer. More...
 
void RemoveActor2D (vtkProp *p)
 
vtkActor2DCollectionGetActors2D ()
 
virtual void SetBackground (double, double, double)
 Set/Get the background color of the rendering screen using an rgb color specification. More...
 
virtual void SetBackground (double[3])
 
virtual double * GetBackground ()
 
virtual void GetBackground (double &, double &, double &)
 
virtual void GetBackground (double[3])
 
virtual void SetBackground2 (double, double, double)
 Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification. More...
 
virtual void SetBackground2 (double[3])
 
virtual double * GetBackground2 ()
 
virtual void GetBackground2 (double &, double &, double &)
 
virtual void GetBackground2 (double[3])
 
virtual void SetBackgroundAlpha (double)
 Set/Get the alpha value used to fill the background with. More...
 
virtual double GetBackgroundAlpha ()
 
virtual void SetGradientBackground (bool)
 Set/Get whether this viewport should have a gradient background using the Background (bottom) and Background2 (top) colors. More...
 
virtual bool GetGradientBackground ()
 
virtual void GradientBackgroundOn ()
 
virtual void GradientBackgroundOff ()
 
virtual void SetAspect (double, double)
 Set the aspect ratio of the rendered image. More...
 
void SetAspect (double[2])
 
virtual double * GetAspect ()
 
virtual void GetAspect (double data[2])
 
virtual void ComputeAspect ()
 
virtual void SetPixelAspect (double, double)
 Set the aspect ratio of a pixel in the rendered image. More...
 
void SetPixelAspect (double[2])
 
virtual double * GetPixelAspect ()
 
virtual void GetPixelAspect (double data[2])
 
virtual void SetViewport (double, double, double, double)
 Specify the viewport for the Viewport to draw in the rendering window. More...
 
virtual void SetViewport (double[4])
 
virtual double * GetViewport ()
 
virtual void GetViewport (double data[4])
 
virtual void SetDisplayPoint (double, double, double)
 Set/get a point location in display (or screen) coordinates. More...
 
virtual void SetDisplayPoint (double[3])
 
virtual double * GetDisplayPoint ()
 
virtual void GetDisplayPoint (double data[3])
 
virtual void SetViewPoint (double, double, double)
 Specify a point location in view coordinates. More...
 
virtual void SetViewPoint (double[3])
 
virtual double * GetViewPoint ()
 
virtual void GetViewPoint (double data[3])
 
virtual void SetWorldPoint (double, double, double, double)
 Specify a point location in world coordinates. More...
 
virtual void SetWorldPoint (double[4])
 
virtual double * GetWorldPoint ()
 
virtual void GetWorldPoint (double data[4])
 
virtual double * GetCenter ()
 Return the center of this viewport in display coordinates. More...
 
virtual int IsInViewport (int x, int y)
 Is a given display point in this Viewport's viewport. More...
 
virtual void DisplayToView ()
 Convert display coordinates to view coordinates. More...
 
virtual void ViewToDisplay ()
 Convert view coordinates to display coordinates. More...
 
void DisplayToWorld ()
 Convert display (or screen) coordinates to world coordinates. More...
 
void WorldToDisplay ()
 Convert world point coordinates to display (or screen) coordinates. More...
 
virtual void LocalDisplayToDisplay (double &x, double &y)
 These methods map from one coordinate system to another. More...
 
virtual void DisplayToNormalizedDisplay (double &u, double &v)
 
virtual void NormalizedDisplayToViewport (double &x, double &y)
 
virtual void ViewportToNormalizedViewport (double &u, double &v)
 
virtual void NormalizedViewportToView (double &x, double &y, double &z)
 
virtual void DisplayToLocalDisplay (double &x, double &y)
 
virtual void NormalizedDisplayToDisplay (double &u, double &v)
 
virtual void ViewportToNormalizedDisplay (double &x, double &y)
 
virtual void NormalizedViewportToViewport (double &u, double &v)
 
virtual void ViewToNormalizedViewport (double &x, double &y, double &z)
 
virtual int * GetSize ()
 Get the size and origin of the viewport in display coordinates. More...
 
virtual int * GetOrigin ()
 
void GetTiledSize (int *width, int *height)
 
virtual void GetTiledSizeAndOrigin (int *width, int *height, int *lowerLeftX, int *lowerLeftY)
 
vtkAssemblyPathPickPropFrom (double selectionX, double selectionY, vtkPropCollection *)
 Same as PickProp with two arguments, but selects from the given collection of Props instead of the Renderers props. More...
 
vtkAssemblyPathPickPropFrom (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. More...
 
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). More...
 
double GetPickY () const
 
double GetPickWidth () const
 
double GetPickHeight () const
 
double GetPickX1 () const
 
double GetPickY1 () const
 
double GetPickX2 () const
 
double GetPickY2 () const
 
virtual vtkPropCollectionGetPickResultProps ()
 
virtual double GetPickedZ ()
 Return the Z value for the last picked Prop. More...
 
virtual void SetEnvironmentalBG (double, double, double)
 Set/Get the constant environmental color using an rgb color specification. More...
 
virtual void SetEnvironmentalBG (double[3])
 
virtual double * GetEnvironmentalBG ()
 
virtual void GetEnvironmentalBG (double &, double &, double &)
 
virtual void GetEnvironmentalBG (double[3])
 
virtual void SetEnvironmentalBG2 (double, double, double)
 Set/Get the second environmental gradient color using an rgb color specification. More...
 
virtual void SetEnvironmentalBG2 (double[3])
 
virtual double * GetEnvironmentalBG2 ()
 
virtual void GetEnvironmentalBG2 (double &, double &, double &)
 
virtual void GetEnvironmentalBG2 (double[3])
 
virtual void SetGradientEnvironmentalBG (bool)
 Set/Get whether this viewport should enable the gradient environment using the EnvironmentalBG (bottom) and EnvironmentalBG2 (top) colors. More...
 
virtual bool GetGradientEnvironmentalBG ()
 
virtual void GradientEnvironmentalBGOn ()
 
virtual void GradientEnvironmentalBGOff ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRendererSafeDownCast (vtkObjectBase *o)
 
static vtkRendererNew ()
 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. More...
 
- Static Public Member Functions inherited from vtkViewport
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkViewportSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkRenderer ()
 
 ~vtkRenderer () override
 
virtual void ExpandBounds (double bounds[6], vtkMatrix4x4 *matrix)
 
void AllocateTime ()
 
virtual int UpdateGeometry (vtkFrameBufferObjectBase *fbo=nullptr)
 Ask all props to update and draw any opaque and translucent geometry. More...
 
virtual int UpdateTranslucentPolygonalGeometry ()
 Ask all props to update and draw any translucent polygonal geometry. More...
 
virtual int UpdateOpaquePolygonalGeometry ()
 Ask all props to update and draw any opaque polygonal geometry. More...
 
virtual int UpdateCamera (void)
 Ask the active camera to do whatever it needs to do prior to rendering. More...
 
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). More...
 
virtual int UpdateLights (void)
 Ask all lights to load themselves into rendering pipeline. More...
 
vtkCameraGetActiveCameraAndResetIfCreated ()
 Get the current camera and reset it only if it gets created automatically (see GetActiveCamera). More...
 
void SetSelector (vtkHardwareSelector *selector)
 Called by vtkHardwareSelector when it begins rendering for selection. More...
 
- Protected Member Functions inherited from vtkViewport
 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. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkCameraActiveCamera
 
vtkLightCreatedLight
 
vtkLightCollectionLights
 
vtkCullerCollectionCullers
 
vtkActorCollectionActors
 
vtkVolumeCollectionVolumes
 
double Ambient [3]
 
vtkRenderWindowRenderWindow
 
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. More...
 
double ClippingRangeExpansion
 Specify enlargement of bounds when resetting the camera clipping range. More...
 
vtkTypeBool Erase
 When this flag is off, the renderer will not erase the background or the Zbuffer. More...
 
vtkTypeBool Draw
 When this flag is off, render commands are ignored. More...
 
vtkPropCollectionGL2PSSpecialPropCollection
 Temporary collection used by vtkRenderWindow::CaptureGL2PSSpecialProps. More...
 
bool UseFXAA
 If this flag is on and the rendering engine supports it, FXAA will be used to antialias the scene. More...
 
vtkFXAAOptionsFXAAOptions
 Holds the FXAA configuration. More...
 
vtkTypeBool UseShadows
 If this flag is on and the rendering engine supports it render shadows Initial value is off. More...
 
vtkTypeBool UseHiddenLineRemoval
 When this flag is on and the rendering engine supports it, wireframe polydata will be rendered using hidden line removal. More...
 
vtkTypeBool UseDepthPeeling
 If this flag is on and the GPU supports it, depth peeling is used for rendering translucent materials. More...
 
bool UseDepthPeelingForVolumes
 This flag is on and the GPU supports it, depth-peel volumes along with the translucent geometry. More...
 
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. More...
 
int MaximumNumberOfPeels
 In case of depth peeling, define the maximum number of peeling layers. More...
 
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. More...
 
vtkHardwareSelectorSelector
 
vtkRendererDelegateDelegate
 
bool TexturedBackground
 
vtkTextureBackgroundTexture
 
vtkTextureRightBackgroundTexture
 
vtkRenderPassPass
 
vtkInformationInformation
 
bool UseImageBasedLighting
 
vtkTextureEnvironmentTexture
 
double EnvironmentUp [3]
 
double EnvironmentRight [3]
 
- Protected Attributes inherited from vtkViewport
vtkAssemblyPathPickedProp
 
vtkPropCollectionPickFromProps
 
vtkPropCollectionPickResultProps
 
double PickX1
 
double PickY1
 
double PickX2
 
double PickY2
 
double PickedZ
 
vtkPropCollectionProps
 
vtkActor2DCollectionActors2D
 
vtkWindowVTKWindow
 
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)
Tests:
vtkRenderer (Tests)

Definition at line 67 of file vtkRenderer.h.

Member Typedef Documentation

◆ Superclass

Definition at line 70 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 vtkOpenGLRenderer, vtkExternalOpenGLRenderer, and vtkOpenVRRenderer.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkRenderer::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkViewport.

Reimplemented in vtkOpenGLRenderer, vtkExternalOpenGLRenderer, and vtkOpenVRRenderer.

◆ 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 vtkOpenGLRenderer, vtkExternalOpenGLRenderer, and vtkOpenVRRenderer.

◆ 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 1094 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 vtkOpenVRRenderer, and vtkExternalOpenGLRenderer.

◆ 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 1102 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 vtkOpenGLRenderer, and vtkOpenVRRenderer.

Definition at line 300 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 325 of file vtkRenderer.h.

◆ Clear()

virtual void vtkRenderer::Clear ( void  )
inlinevirtual

Clear the image to the background color.

Reimplemented in vtkOpenGLRenderer.

Definition at line 330 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

◆ ResetCameraClippingRange() [2/3]

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

Reset the camera clipping range based on a bounding box.

Reimplemented in vtkOpenVRRenderer.

◆ ResetCameraClippingRange() [3/3]

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

◆ 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 vtkOpenVRRenderer.

◆ 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 vtkOpenVRRenderer.

◆ 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 vtkOpenVRRenderer.

◆ 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 420 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 &  wx,
double &  wy,
double &  wz 
)
overridevirtual

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 &  wx,
double &  wy,
double &  wz 
)
overridevirtual

Reimplemented from vtkViewport.

◆ ViewToPose()

void vtkRenderer::ViewToPose ( double &  wx,
double &  wy,
double &  wz 
)
overridevirtual

Reimplemented from vtkViewport.

◆ PoseToView()

void vtkRenderer::PoseToView ( double &  wx,
double &  wy,
double &  wz 
)
overridevirtual

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 559 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 572 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 587 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

◆ 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 977 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 1060 of file vtkRenderer.h.

Friends And Related Function Documentation

◆ vtkHardwareSelector

friend class vtkHardwareSelector
friend

Definition at line 1055 of file vtkRenderer.h.

◆ vtkRendererDelegate

friend class vtkRendererDelegate
friend

Definition at line 1070 of file vtkRenderer.h.

◆ vtkRenderPass

friend class vtkRenderPass
friend

Definition at line 1077 of file vtkRenderer.h.

Member Data Documentation

◆ ActiveCamera

vtkCamera* vtkRenderer::ActiveCamera
protected

Definition at line 852 of file vtkRenderer.h.

◆ CreatedLight

vtkLight* vtkRenderer::CreatedLight
protected

Definition at line 853 of file vtkRenderer.h.

◆ Lights

vtkLightCollection* vtkRenderer::Lights
protected

Definition at line 855 of file vtkRenderer.h.

◆ Cullers

vtkCullerCollection* vtkRenderer::Cullers
protected

Definition at line 856 of file vtkRenderer.h.

◆ Actors

vtkActorCollection* vtkRenderer::Actors
protected

Definition at line 858 of file vtkRenderer.h.

◆ Volumes

vtkVolumeCollection* vtkRenderer::Volumes
protected

Definition at line 859 of file vtkRenderer.h.

◆ Ambient

double vtkRenderer::Ambient[3]
protected

Definition at line 861 of file vtkRenderer.h.

◆ RenderWindow

vtkRenderWindow* vtkRenderer::RenderWindow
protected

Definition at line 862 of file vtkRenderer.h.

◆ AllocatedRenderTime

double vtkRenderer::AllocatedRenderTime
protected

Definition at line 863 of file vtkRenderer.h.

◆ TimeFactor

double vtkRenderer::TimeFactor
protected

Definition at line 864 of file vtkRenderer.h.

◆ TwoSidedLighting

vtkTypeBool vtkRenderer::TwoSidedLighting
protected

Definition at line 865 of file vtkRenderer.h.

◆ AutomaticLightCreation

vtkTypeBool vtkRenderer::AutomaticLightCreation
protected

Definition at line 866 of file vtkRenderer.h.

◆ BackingStore

vtkTypeBool vtkRenderer::BackingStore
protected

Definition at line 867 of file vtkRenderer.h.

◆ BackingImage

unsigned char* vtkRenderer::BackingImage
protected

Definition at line 868 of file vtkRenderer.h.

◆ BackingStoreSize

int vtkRenderer::BackingStoreSize[2]
protected

Definition at line 869 of file vtkRenderer.h.

◆ RenderTime

vtkTimeStamp vtkRenderer::RenderTime
protected

Definition at line 870 of file vtkRenderer.h.

◆ LastRenderTimeInSeconds

double vtkRenderer::LastRenderTimeInSeconds
protected

Definition at line 872 of file vtkRenderer.h.

◆ LightFollowCamera

vtkTypeBool vtkRenderer::LightFollowCamera
protected

Definition at line 874 of file vtkRenderer.h.

◆ NumberOfPropsRendered

int vtkRenderer::NumberOfPropsRendered
protected

Definition at line 881 of file vtkRenderer.h.

◆ PropArray

vtkProp** vtkRenderer::PropArray
protected

Definition at line 885 of file vtkRenderer.h.

◆ PropArrayCount

int vtkRenderer::PropArrayCount
protected

Definition at line 886 of file vtkRenderer.h.

◆ Interactive

vtkTypeBool vtkRenderer::Interactive
protected

Definition at line 890 of file vtkRenderer.h.

◆ Layer

int vtkRenderer::Layer
protected

Definition at line 894 of file vtkRenderer.h.

◆ PreserveColorBuffer

vtkTypeBool vtkRenderer::PreserveColorBuffer
protected

Definition at line 895 of file vtkRenderer.h.

◆ PreserveDepthBuffer

vtkTypeBool vtkRenderer::PreserveDepthBuffer
protected

Definition at line 896 of file vtkRenderer.h.

◆ ComputedVisiblePropBounds

double vtkRenderer::ComputedVisiblePropBounds[6]
protected

Definition at line 900 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 909 of file vtkRenderer.h.

◆ ClippingRangeExpansion

double vtkRenderer::ClippingRangeExpansion
protected

Specify enlargement of bounds when resetting the camera clipping range.

Definition at line 915 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 923 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 930 of file vtkRenderer.h.

◆ GL2PSSpecialPropCollection

vtkPropCollection* vtkRenderer::GL2PSSpecialPropCollection
protected

Temporary collection used by vtkRenderWindow::CaptureGL2PSSpecialProps.

Definition at line 935 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 990 of file vtkRenderer.h.

◆ FXAAOptions

vtkFXAAOptions* vtkRenderer::FXAAOptions
protected

Holds the FXAA configuration.

Definition at line 995 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 1001 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 1007 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 1015 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 1021 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 1032 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 1039 of file vtkRenderer.h.

◆ UseSSAO

bool vtkRenderer::UseSSAO = false
protected

Definition at line 1041 of file vtkRenderer.h.

◆ SSAORadius

double vtkRenderer::SSAORadius = 0.5
protected

Definition at line 1042 of file vtkRenderer.h.

◆ SSAOBias

double vtkRenderer::SSAOBias = 0.01
protected

Definition at line 1043 of file vtkRenderer.h.

◆ SSAOKernelSize

unsigned int vtkRenderer::SSAOKernelSize = 32
protected

Definition at line 1044 of file vtkRenderer.h.

◆ SSAOBlur

bool vtkRenderer::SSAOBlur = false
protected

Definition at line 1045 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 1052 of file vtkRenderer.h.

◆ Selector

vtkHardwareSelector* vtkRenderer::Selector
protected

Definition at line 1067 of file vtkRenderer.h.

◆ Delegate

vtkRendererDelegate* vtkRenderer::Delegate
protected

Definition at line 1071 of file vtkRenderer.h.

◆ TexturedBackground

bool vtkRenderer::TexturedBackground
protected

Definition at line 1073 of file vtkRenderer.h.

◆ BackgroundTexture

vtkTexture* vtkRenderer::BackgroundTexture
protected

Definition at line 1074 of file vtkRenderer.h.

◆ RightBackgroundTexture

vtkTexture* vtkRenderer::RightBackgroundTexture
protected

Definition at line 1075 of file vtkRenderer.h.

◆ Pass

vtkRenderPass* vtkRenderer::Pass
protected

Definition at line 1078 of file vtkRenderer.h.

◆ Information

vtkInformation* vtkRenderer::Information
protected

Definition at line 1081 of file vtkRenderer.h.

◆ UseImageBasedLighting

bool vtkRenderer::UseImageBasedLighting
protected

Definition at line 1083 of file vtkRenderer.h.

◆ EnvironmentTexture

vtkTexture* vtkRenderer::EnvironmentTexture
protected

Definition at line 1084 of file vtkRenderer.h.

◆ EnvironmentUp

double vtkRenderer::EnvironmentUp[3]
protected

Definition at line 1086 of file vtkRenderer.h.

◆ EnvironmentRight

double vtkRenderer::EnvironmentRight[3]
protected

Definition at line 1087 of file vtkRenderer.h.


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