138 #ifndef vtkRenderer_h
139 #define vtkRenderer_h
141 #include "vtkRenderingCoreModule.h"
149 VTK_ABI_NAMESPACE_BEGIN
371 vtkSetVector3Macro(Ambient,
double);
372 vtkGetVectorMacro(Ambient,
double, 3);
380 vtkSetMacro(AllocatedRenderTime,
double);
460 virtual
void ResetCameraClippingRange();
466 virtual
void ResetCameraClippingRange(const
double bounds[6]);
467 virtual
void ResetCameraClippingRange(
468 double xmin,
double xmax,
double ymin,
double ymax,
double zmin,
double zmax);
477 vtkSetClampMacro(NearClippingPlaneTolerance,
double, 0, 0.99);
478 vtkGetMacro(NearClippingPlaneTolerance,
double);
487 vtkSetClampMacro(ClippingRangeExpansion,
double, 0, 0.99);
488 vtkGetMacro(ClippingRangeExpansion,
double);
497 virtual
void ResetCamera();
508 virtual
void ResetCamera(const
double bounds[6]);
513 virtual
void ResetCamera(
514 double xmin,
double xmax,
double ymin,
double ymax,
double zmin,
double zmax);
523 virtual
void ResetCameraScreenSpace(
double offsetRatio = 0.9);
533 virtual
void ResetCameraScreenSpace(const
double bounds[6],
double offsetRatio = 0.9);
547 void ZoomToBoxUsingViewAngle(const
vtkRecti& box,
double offsetRatio = 1.0);
555 virtual
void ResetCameraScreenSpace(
double xmin,
double xmax,
double ymin,
double ymax,
556 double zmin,
double zmax,
double offsetRatio = 0.9);
605 vtkGetMacro(Layer,
int);
664 void ViewToPose(
double& wx,
double& wy,
double& wz)
override;
665 void PoseToView(
double& wx,
double& wy,
double& wz)
override;
683 vtkGetMacro(LastRenderTimeInSeconds,
double);
693 vtkGetMacro(NumberOfPropsRendered,
int);
706 return this->
PickProp(selectionX, selectionY, selectionX, selectionY);
709 double selectionX1,
double selectionY1,
double selectionX2,
double selectionY2)
override;
726 selectionX, selectionY, selectionX, selectionY, fieldAssociation, selection);
775 vtkSetMacro(UseDepthPeelingForVolumes,
bool);
776 vtkGetMacro(UseDepthPeelingForVolumes,
bool);
777 vtkBooleanMacro(UseDepthPeelingForVolumes,
bool);
789 vtkSetClampMacro(OcclusionRatio,
double, 0.0, 0.5);
790 vtkGetMacro(OcclusionRatio,
double);
799 vtkSetMacro(MaximumNumberOfPeels,
int);
800 vtkGetMacro(MaximumNumberOfPeels,
int);
817 vtkSetMacro(UseSSAO,
bool);
818 vtkGetMacro(UseSSAO,
bool);
819 vtkBooleanMacro(UseSSAO,
bool);
827 vtkSetMacro(SSAORadius,
double);
828 vtkGetMacro(SSAORadius,
double);
836 vtkSetMacro(SSAOBias,
double);
837 vtkGetMacro(SSAOBias,
double);
845 vtkSetMacro(SSAOKernelSize,
unsigned int);
846 vtkGetMacro(SSAOKernelSize,
unsigned int);
855 vtkSetMacro(SSAOBlur,
bool);
856 vtkGetMacro(SSAOBlur,
bool);
857 vtkBooleanMacro(SSAOBlur,
bool);
906 vtkSetMacro(TexturedBackground,
bool);
907 vtkGetMacro(TexturedBackground,
bool);
908 vtkBooleanMacro(TexturedBackground,
bool);
918 vtkSetMacro(UseFXAA,
bool);
919 vtkGetMacro(UseFXAA,
bool);
920 vtkBooleanMacro(UseFXAA,
bool);
971 vtkSetMacro(UseImageBasedLighting,
bool);
972 vtkGetMacro(UseImageBasedLighting,
bool);
973 vtkBooleanMacro(UseImageBasedLighting,
bool);
990 vtkGetVector3Macro(EnvironmentUp,
double);
991 vtkSetVector3Macro(EnvironmentUp,
double);
998 vtkGetVector3Macro(EnvironmentRight,
double);
999 vtkSetVector3Macro(EnvironmentRight,
double);
1028 int BackingStoreSize[2];
1059 double ComputedVisiblePropBounds[6];
1218 bool UseSSAO =
false;
1219 double SSAORadius = 0.5;
1220 double SSAOBias = 0.01;
1221 unsigned int SSAOKernelSize = 32;
1222 bool SSAOBlur =
false;
1239 this->Selector = selector;
1263 double EnvironmentUp[3];
1264 double EnvironmentRight[3];
1270 std::array<double, 16> CompositeProjectionTransformationMatrix;
1275 double LastCompositeProjectionTransformationMatrixTiledAspectRatio;
1280 vtkMTimeType LastCompositeProjectionTransformationMatrixCameraModified;
1285 std::array<double, 16> ProjectionTransformationMatrix;
1290 double LastProjectionTransformationMatrixTiledAspectRatio;
1295 vtkMTimeType LastProjectionTransformationMatrixCameraModified;
1300 std::array<double, 16> ViewTransformMatrix;
1324 VTK_ABI_NAMESPACE_END
a actor that draws 2D data
an ordered list of actors
represents an object (geometry & properties) in a rendered scene
a list of nodes that form an assembly path
a virtual camera for 3D rendering
an ordered list of Cullers
a superclass for prop cullers
Configuration for FXAA implementations.
abstract interface to OpenGL FBOs
a simple class to control print indentation
an ordered list of lights
a virtual light for 3D rendering
represent and manipulate 4x4 transformation matrices
virtual void Modified()
Update the modification time for this object.
abstract superclass for all actors, volumes and annotations
Perform part of the rendering of a vtkRenderer.
create a window for renderers to draw into
Render the props of a vtkRenderer.
abstract specification for renderers
void RemoveVolume(vtkProp *p)
Add/Remove different types of props to the renderer.
virtual void SetLayer(int layer)
Set/Get the layer that this renderer belongs to.
void ViewToWorld(double &wx, double &wy, double &wz) override
Convert view point coordinates to world coordinates.
virtual void SetFXAAOptions(vtkFXAAOptions *)
The configuration object for FXAA antialiasing.
const std::array< double, 16 > & GetViewTransformMatrix()
Gets the ActiveCamera ViewTransformMatrix, only computing it if necessary.
virtual int UpdateCamera()
Ask the active camera to do whatever it needs to do prior to rendering.
void AddCuller(vtkCuller *)
Add an culler to the list of cullers.
virtual vtkTypeBool UpdateLightGeometry()
Update the geometry of the lights in the scene that are not in world space (for instance,...
void SetPass(vtkRenderPass *p)
virtual int UpdateLights()
Ask all lights to load themselves into rendering pipeline.
vtkTypeBool PreserveDepthBuffer
vtkTypeBool UseShadows
If this flag is on and the rendering engine supports it render shadows Initial value is off.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static vtkRenderer * New()
Create a vtkRenderer with a black background, a white ambient light, two-sided lighting turned on,...
double LastRenderTimeInSeconds
double GetTiledAspectRatio()
Compute the aspect ratio of this renderer for the current tile.
void CreateLight()
Create and add a light to renderer.
vtkCamera * GetActiveCameraAndResetIfCreated()
Get the current camera and reset it only if it gets created automatically (see GetActiveCamera).
void AddLight(vtkLight *)
Add a light to the list of lights.
vtkCullerCollection * GetCullers()
Return the collection of cullers.
virtual vtkLight * MakeLight()
Create a new Light sutible for use with this type of Renderer.
virtual void SetRightBackgroundTexture(vtkTexture *)
Set/Get the texture to be used for the right eye background.
virtual void SetInformation(vtkInformation *)
Set/Get the information object associated with this algorithm.
vtkAssemblyPath * PickProp(double selectionX, double selectionY, int fieldAssociation, vtkSmartPointer< vtkSelection > selection) override
Return the prop (via a vtkAssemblyPath) that has the highest z value at the given x,...
virtual int UpdateGeometry(vtkFrameBufferObjectBase *fbo=nullptr)
Ask all props to update and draw any opaque and translucent geometry.
vtkWindow * GetVTKWindow() override
Specify the rendering window in which to draw.
vtkActorCollection * GetActors()
Return any actors in this renderer.
bool UseImageBasedLighting
int VisibleActorCount()
Returns the number of visible actors.
vtkTexture * EnvironmentTexture
void RemoveLight(vtkLight *)
Remove a light from the list of lights.
bool UseDepthPeelingForVolumes
This flag is on and the GPU supports it, depth-peel volumes along with the translucent geometry.
void RemoveActor(vtkProp *p)
Add/Remove different types of props to the renderer.
virtual void SetLeftBackgroundTexture(vtkTexture *)
Set/Get the texture to be used for the monocular or stereo left eye background.
void SetSelector(vtkHardwareSelector *selector)
Called by vtkHardwareSelector when it begins rendering for selection.
vtkMTimeType GetMTime() override
Return the MTime of the renderer also considering its ivars.
int MaximumNumberOfPeels
In case of depth peeling, define the maximum number of peeling layers.
vtkTypeBool LastRenderingUsedDepthPeeling
Tells if the last call to DeviceRenderTranslucentPolygonalGeometry() actually used depth peeling.
vtkRenderWindow * RenderWindow
int VisibleVolumeCount()
Returns the number of visible volumes.
double * ComputeVisiblePropBounds()
Wrapper-friendly version of ComputeVisiblePropBounds.
vtkTypeBool AutomaticLightCreation
int NumberOfPropsRendered
virtual void StereoMidpoint()
Do anything necessary between rendering the left and right viewpoints in a stereo render.
virtual int UpdateOpaquePolygonalGeometry()
Ask all props to update and draw any opaque polygonal geometry.
vtkAssemblyPath * PickProp(double selectionX1, double selectionY1, double selectionX2, double selectionY2, int fieldAssociation, vtkSmartPointer< vtkSelection > selection) override
Return the prop (via a vtkAssemblyPath) that has the highest z value at the given x,...
vtkVolumeCollection * Volumes
virtual void ExpandBounds(double bounds[6], vtkMatrix4x4 *matrix)
void RemoveCuller(vtkCuller *)
Remove an actor from the list of cullers.
double OcclusionRatio
In case of use of depth peeling technique for rendering translucent material, define the threshold un...
vtkAssemblyPath * PickProp(double selectionX, double selectionY) override
Return the prop (via a vtkAssemblyPath) that has the highest z value at the given x,...
void PoseToView(double &wx, double &wy, double &wz) override
Convert to from pose coordinates.
vtkTypeBool Erase
When this flag is off, the renderer will not erase the background or the Zbuffer.
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.
double ClippingRangeExpansion
Specify enlargement of bounds when resetting the camera clipping range.
int CaptureGL2PSSpecialProp(vtkProp *)
This function is called to capture an instance of vtkProp that requires special handling during vtkRe...
vtkTypeBool Transparent()
Returns a boolean indicating if this renderer is transparent.
vtkTypeBool IsActiveCameraCreated()
This method returns 1 if the ActiveCamera has already been set or automatically created by the render...
unsigned char * BackingImage
vtkRendererDelegate * Delegate
void SetLightCollection(vtkLightCollection *lights)
Set the collection of lights.
virtual void ReleaseGraphicsResources(vtkWindow *)
void PoseToWorld(double &wx, double &wy, double &wz) override
Convert to from pose coordinates.
void RemoveAllLights()
Remove all lights from the list of lights.
vtkTexture * BackgroundTexture
virtual vtkCamera * MakeCamera()
Create a new Camera sutible for use with this type of Renderer.
double GetZ(int x, int y)
Given a pixel location, return the Z value.
vtkCullerCollection * Cullers
vtkCamera * GetActiveCamera()
Get the current camera.
void AddActor(vtkProp *p)
Add/Remove different types of props to the renderer.
virtual double GetTimeFactor()
Get the ratio between allocated time and actual render time.
double AllocatedRenderTime
const std::array< double, 16 > & GetProjectionTransformationMatrix()
Gets the ActiveCamera ProjectionTransformationMatrix, only computing it if necessary.
double NearClippingPlaneTolerance
Specifies the minimum distance of the near clipping plane as a percentage of the far clipping plane d...
vtkTypeBool Draw
When this flag is off, render commands are ignored.
vtkHardwareSelector * Selector
virtual void DeviceRender()
Create an image.
vtkTypeBool TwoSidedLighting
vtkTexture * RightBackgroundTexture
virtual vtkTypeBool UpdateLightsGeometryToFollowCamera()
Ask the lights in the scene that are not in world space (for instance, Headlights or CameraLights tha...
vtkTypeBool UseDepthPeeling
If this flag is on and the GPU supports it, depth peeling is used for rendering translucent materials...
vtkTypeBool UseHiddenLineRemoval
When this flag is on and the rendering engine supports it, wireframe polydata will be rendered using ...
void WorldToPose(double &wx, double &wy, double &wz) override
Convert to from pose coordinates.
vtkLightCollection * Lights
vtkTexture * GetLeftBackgroundTexture()
Set/Get the texture to be used for the monocular or stereo left eye background.
void ViewToWorld() override
Convert view point coordinates to world coordinates.
vtkVolumeCollection * GetVolumes()
Return the collection of volumes.
void SetActiveCamera(vtkCamera *)
Specify the camera to use for this renderer.
virtual void SetEnvironmentTexture(vtkTexture *texture, bool isSRGB=false)
Set/Get the environment texture used for image based lighting.
virtual void Render()
CALLED BY vtkRenderWindow ONLY.
virtual int UpdateTranslucentPolygonalGeometry()
Ask all props to update and draw any translucent polygonal geometry.
virtual void ClearLights()
Internal method temporarily removes lights before reloading them into graphics pipeline.
vtkLightCollection * GetLights()
Return the collection of lights.
vtkTypeBool LightFollowCamera
vtkFXAAOptions * FXAAOptions
Holds the FXAA configuration.
void ViewToPose(double &wx, double &wy, double &wz) override
Convert to from pose coordinates.
void WorldToView() override
Convert world point coordinates to view coordinates.
virtual void DeviceRenderOpaqueGeometry(vtkFrameBufferObjectBase *fbo=nullptr)
Render opaque polygonal geometry.
vtkAssemblyPath * PickProp(double selectionX1, double selectionY1, double selectionX2, double selectionY2) override
Return the prop (via a vtkAssemblyPath) that has the highest z value at the given x,...
virtual void SetBackgroundTexture(vtkTexture *)
Set/Get the texture to be used for the monocular or stereo left eye background.
void AddVolume(vtkProp *p)
Add/Remove different types of props to the renderer.
void WorldToView(double &wx, double &wy, double &wz) override
Convert world point coordinates to view coordinates.
virtual double GetAllocatedRenderTime()
Set/Get the amount of time this renderer is allowed to spend rendering its scene.
virtual void Clear()
Clear the image to the background color.
void ComputeVisiblePropBounds(double bounds[6])
Compute the bounding box of all the visible props Used in ResetCamera() and ResetCameraClippingRange(...
virtual void DeviceRenderTranslucentPolygonalGeometry(vtkFrameBufferObjectBase *fbo=nullptr)
Render translucent polygonal geometry.
vtkTypeBool PreserveColorBuffer
void SetGL2PSSpecialPropCollection(vtkPropCollection *)
Set the prop collection object used during vtkRenderWindow::CaptureGL2PSSpecialProps().
vtkActorCollection * Actors
void SetDelegate(vtkRendererDelegate *d)
Set/Get a custom Render call.
vtkInformation * Information
const std::array< double, 16 > & GetCompositeProjectionTransformationMatrix()
Gets the ActiveCamera CompositeProjectionTransformationMatrix, only computing it if necessary.
handles properties associated with a texture map
record modification and/or execution time
abstract specification for Viewports
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.
an ordered list of volumes
represents a volume (data & properties) in a rendered scene
window superclass for vtkRenderWindow
vtkTypeUInt32 vtkMTimeType
#define VTK_SIZEHINT(...)