vtkRenderer Class Reference
#include <vtkRenderer.h>
Detailed Description
abstract specification for renderersvtkRenderer 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::StartEvent vtkCommand::CreateCameraEvent vtkCommand::ComputeVisiblePropBoundsEvent vtkCommand::ResetCameraEvent vtkCommand::ResetCameraClippingRangeEvent vtkCommand::EndEvent
- Examples:
- vtkRenderer (Examples)
- Tests:
- vtkRenderer (Tests)
Definition at line 69 of file vtkRenderer.h.
Member Typedef Documentation
| typedef vtkViewport vtkRenderer::Superclass |
Reimplemented from vtkViewport.
Reimplemented in vtkMesaRenderer, and vtkOpenGLRenderer.
Definition at line 72 of file vtkRenderer.h.
Member Enumeration Documentation
anonymous enum [protected] |
Call to put the Renderer into a mode in which it will color visible polygons with an enoded index. Later the pixel colors can be retrieved to determine what objects lie behind each pixel.
- Enumerator:
-
NOT_SELECTING COLOR_BY_PROCESSOR COLOR_BY_ACTOR COLOR_BY_CELL_ID_HIGH COLOR_BY_CELL_ID_MID COLOR_BY_CELL_ID_LOW COLOR_BY_VERTEX
Definition at line 627 of file vtkRenderer.h.
Constructor & Destructor Documentation
| vtkRenderer::vtkRenderer | ( | ) | [protected] |
| vtkRenderer::~vtkRenderer | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkRenderer::GetClassName | ( | ) | [virtual] |
| static int vtkRenderer::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type 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 vtkMesaRenderer, and vtkOpenGLRenderer.
| virtual int 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 vtkMesaRenderer, and vtkOpenGLRenderer.
| static vtkRenderer* vtkRenderer::SafeDownCast | ( | vtkObject * | o | ) | [static] |
| void vtkRenderer::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
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 vtkViewport.
Reimplemented in vtkMesaRenderer, and vtkOpenGLRenderer.
| 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.
Reimplemented from vtkObject.
Reimplemented in vtkMesaRenderer, and vtkOpenGLRenderer.
| 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.
| void vtkRenderer::AddVolume | ( | 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.
| void vtkRenderer::RemoveActor | ( | 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.
| void vtkRenderer::RemoveVolume | ( | 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.
| void vtkRenderer::AddLight | ( | vtkLight * | ) |
Add a light to the list of lights.
| void vtkRenderer::RemoveLight | ( | vtkLight * | ) |
Remove a light from the list of lights.
| void vtkRenderer::RemoveAllLights | ( | ) |
Remove all lights from the list of lights.
| vtkLightCollection * vtkRenderer::GetLights | ( | ) | [inline] |
Return the collection of lights.
Definition at line 698 of file vtkRenderer.h.
| 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()
| void vtkRenderer::CreateLight | ( | void | ) |
Create and add a light to renderer.
| 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.
Reimplemented in vtkMesaRenderer.
| virtual int 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.
| virtual void vtkRenderer::SetTwoSidedLighting | ( | int | ) | [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.
| virtual void vtkRenderer::TwoSidedLightingOn | ( | ) | [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.
| virtual void vtkRenderer::TwoSidedLightingOff | ( | ) | [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.
| virtual void vtkRenderer::SetLightFollowCamera | ( | int | ) | [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.)
| virtual int vtkRenderer::GetLightFollowCamera | ( | ) | [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.)
| virtual void vtkRenderer::LightFollowCameraOn | ( | ) | [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.)
| virtual void vtkRenderer::LightFollowCameraOff | ( | ) | [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.)
| virtual int 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.)
| virtual void vtkRenderer::SetAutomaticLightCreation | ( | int | ) | [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.)
| virtual void vtkRenderer::AutomaticLightCreationOn | ( | ) | [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.)
| virtual void vtkRenderer::AutomaticLightCreationOff | ( | ) | [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.)
| virtual int 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.
| vtkVolumeCollection* vtkRenderer::GetVolumes | ( | ) |
Return the collection of volumes.
| vtkActorCollection* vtkRenderer::GetActors | ( | ) |
Return any actors in this renderer.
| void vtkRenderer::SetActiveCamera | ( | vtkCamera * | ) |
Specify the camera to use for this renderer.
| 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.
| 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 vtkMesaRenderer.
| virtual void vtkRenderer::SetErase | ( | int | ) | [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.
| virtual int vtkRenderer::GetErase | ( | ) | [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.
| virtual void vtkRenderer::EraseOn | ( | ) | [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.
| virtual void vtkRenderer::EraseOff | ( | ) | [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.
| virtual void vtkRenderer::SetDraw | ( | int | ) | [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.
| virtual int vtkRenderer::GetDraw | ( | ) | [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.
| virtual void vtkRenderer::DrawOn | ( | ) | [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.
| virtual void vtkRenderer::DrawOff | ( | ) | [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.
| void vtkRenderer::AddCuller | ( | vtkCuller * | ) |
Add an culler to the list of cullers.
| void vtkRenderer::RemoveCuller | ( | vtkCuller * | ) |
Remove an actor from the list of cullers.
| vtkCullerCollection * vtkRenderer::GetCullers | ( | ) | [inline] |
Return the collection of cullers.
Get the list of cullers for this renderer.
Definition at line 703 of file vtkRenderer.h.
| virtual void vtkRenderer::SetAmbient | ( | double | , | |
| double | , | |||
| double | ||||
| ) | [virtual] |
Set the intensity of ambient lighting.
| virtual void vtkRenderer::SetAmbient | ( | double | [3] | ) | [virtual] |
Set the intensity of ambient lighting.
| virtual double* vtkRenderer::GetAmbient | ( | ) | [virtual] |
Set the intensity of ambient lighting.
| virtual void vtkRenderer::GetAmbient | ( | double | data[3] | ) | [virtual] |
Set the intensity of ambient lighting.
| 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.
| virtual double vtkRenderer::GetAllocatedRenderTime | ( | ) | [virtual] |
Set/Get the amount of time this renderer is allowed to spend rendering its scene. This is used by vtkLODActor's.
| 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.
| 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.
| virtual void vtkRenderer::DeviceRender | ( | ) | [pure virtual] |
Create an image. Subclasses of vtkRenderer must implement this method.
Implemented in vtkMesaRenderer, and vtkOpenGLRenderer.
| virtual void vtkRenderer::DeviceRenderTranslucentPolygonalGeometry | ( | ) | [virtual] |
Render translucent polygonal geometry. Default implementation just call UpdateTranslucentPolygonalGeometry(). Subclasses of vtkRenderer that can deal with depth peeling must override this method. It updates boolean ivar LastRenderingUsedDepthPeeling.
Reimplemented in vtkOpenGLRenderer.
| virtual void vtkRenderer::Clear | ( | void | ) | [inline, virtual] |
Clear the image to the background color.
Reimplemented in vtkMesaRenderer, and vtkOpenGLRenderer.
Definition at line 241 of file vtkRenderer.h.
| int vtkRenderer::VisibleActorCount | ( | ) |
Returns the number of visible actors.
| int vtkRenderer::VisibleVolumeCount | ( | ) |
Returns the number of visible volumes.
| void vtkRenderer::ComputeVisiblePropBounds | ( | double | bounds[6] | ) |
Compute the bounding box of all the visible props Used in ResetCamera() and ResetCameraClippingRange()
| double* vtkRenderer::ComputeVisiblePropBounds | ( | ) |
Wrapper-friendly version of ComputeVisiblePropBounds
| void vtkRenderer::ResetCameraClippingRange | ( | ) |
Reset the camera clipping range based on the bounds of the visible actors. This ensures that no props are cut off
| void vtkRenderer::ResetCameraClippingRange | ( | double | bounds[6] | ) |
Reset the camera clipping range based on a bounding box. This method is called from ResetCameraClippingRange()
| void vtkRenderer::ResetCameraClippingRange | ( | double | xmin, | |
| double | xmax, | |||
| double | ymin, | |||
| double | ymax, | |||
| double | zmin, | |||
| double | zmax | |||
| ) |
Reset the camera clipping range based on a bounding box. This method is called from ResetCameraClippingRange()
| 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
| virtual double vtkRenderer::GetNearClippingPlaneTolerance | ( | ) | [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
| void vtkRenderer::ResetCamera | ( | ) |
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.
| void vtkRenderer::ResetCamera | ( | double | bounds[6] | ) |
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: is the view plane is parallel to the view up axis, the view up axis will be reset to one of the three coordinate axes.
| void vtkRenderer::ResetCamera | ( | double | xmin, | |
| double | xmax, | |||
| double | ymin, | |||
| double | ymax, | |||
| double | zmin, | |||
| double | zmax | |||
| ) |
Alternative version of ResetCamera(bounds[6]);
| 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.
| vtkRenderWindow* vtkRenderer::GetRenderWindow | ( | ) | [inline] |
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.
Definition at line 305 of file vtkRenderer.h.
| virtual vtkWindow* vtkRenderer::GetVTKWindow | ( | ) | [virtual] |
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.
Implements vtkViewport.
| virtual void vtkRenderer::SetBackingStore | ( | int | ) | [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.
| virtual int vtkRenderer::GetBackingStore | ( | ) | [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.
| virtual void vtkRenderer::BackingStoreOn | ( | ) | [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.
| virtual void vtkRenderer::BackingStoreOff | ( | ) | [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.
| virtual void vtkRenderer::SetInteractive | ( | int | ) | [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.
| virtual int vtkRenderer::GetInteractive | ( | ) | [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.
| virtual void vtkRenderer::InteractiveOn | ( | ) | [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.
| virtual void vtkRenderer::InteractiveOff | ( | ) | [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.
| virtual void vtkRenderer::SetLayer | ( | int | ) | [virtual] |
Set/Get the layer that this renderer belongs to. This is only used if there are layered renderers.
| virtual int vtkRenderer::GetLayer | ( | ) | [virtual] |
Set/Get the layer that this renderer belongs to. This is only used if there are layered renderers.
| virtual void vtkRenderer::SetPreserveDepthBuffer | ( | int | ) | [virtual] |
Normally a renderer is treated as transparent if Layer > 0. To treat a renderer at Layer 0 as transparent, set this flag to true.
| virtual int vtkRenderer::GetPreserveDepthBuffer | ( | ) | [virtual] |
Normally a renderer is treated as transparent if Layer > 0. To treat a renderer at Layer 0 as transparent, set this flag to true.
| virtual void vtkRenderer::PreserveDepthBufferOn | ( | ) | [virtual] |
Normally a renderer is treated as transparent if Layer > 0. To treat a renderer at Layer 0 as transparent, set this flag to true.
| virtual void vtkRenderer::PreserveDepthBufferOff | ( | ) | [virtual] |
Normally a renderer is treated as transparent if Layer > 0. To treat a renderer at Layer 0 as transparent, set this flag to true.
| 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.
| void vtkRenderer::WorldToView | ( | ) | [virtual] |
Convert world point coordinates to view coordinates.
Reimplemented from vtkViewport.
| void vtkRenderer::ViewToWorld | ( | ) | [virtual] |
Convert view point coordinates to world coordinates.
Reimplemented from vtkViewport.
| virtual void vtkRenderer::ViewToWorld | ( | double & | wx, | |
| double & | wy, | |||
| double & | wz | |||
| ) | [virtual] |
Convert view point coordinates to world coordinates.
Reimplemented from vtkViewport.
| virtual void vtkRenderer::WorldToView | ( | double & | wx, | |
| double & | wy, | |||
| double & | wz | |||
| ) | [virtual] |
Convert world point coordinates to view coordinates.
Reimplemented from vtkViewport.
| 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.
| unsigned long vtkRenderer::GetMTime | ( | ) | [virtual] |
Return the MTime of the renderer also considering its ivars.
Reimplemented from vtkObject.
| virtual double vtkRenderer::GetLastRenderTimeInSeconds | ( | ) | [virtual] |
Get the time required, in seconds, for the last Render call.
| 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.
| vtkAssemblyPath* vtkRenderer::PickProp | ( | double | selectionX, | |
| double | selectionY | |||
| ) | [inline, virtual] |
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 384 of file vtkRenderer.h.
| vtkAssemblyPath* vtkRenderer::PickProp | ( | double | selectionX1, | |
| double | selectionY1, | |||
| double | selectionX2, | |||
| double | selectionY2 | |||
| ) |
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.
| virtual void vtkRenderer::StereoMidpoint | ( | ) | [inline, virtual] |
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 395 of file vtkRenderer.h.
| 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 diferent that the aspect ratio of the renderer when rendered in it entirity
| int 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 407 of file vtkRenderer.h.
| virtual void vtkRenderer::SetUseDepthPeeling | ( | int | ) | [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.
| virtual int vtkRenderer::GetUseDepthPeeling | ( | ) | [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.
| virtual void vtkRenderer::UseDepthPeelingOn | ( | ) | [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.
| virtual void vtkRenderer::UseDepthPeelingOff | ( | ) | [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.
| 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.
| virtual double vtkRenderer::GetOcclusionRatio | ( | ) | [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.
| 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.
| virtual int vtkRenderer::GetMaximumNumberOfPeels | ( | ) | [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.
| virtual int vtkRenderer::GetLastRenderingUsedDepthPeeling | ( | ) | [virtual] |
Tells if the last call to DeviceRenderTranslucentPolygonalGeometry() actually used depth peeling. Initial value is false.
| 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.
| virtual vtkRendererDelegate* vtkRenderer::GetDelegate | ( | ) | [virtual] |
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.
| void vtkRenderer::SetPass | ( | vtkRenderPass * | p | ) |
Set/Get a custom render pass. Initial value is NULL.
| virtual vtkRenderPass* vtkRenderer::GetPass | ( | ) | [virtual] |
Set/Get a custom render pass. Initial value is NULL.
| 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.
| void vtkRenderer::SetBackgroundTexture | ( | vtkTexture * | ) |
Set/Get the texture to be used for the background. If set and enabled this gets the priority over the gradient background.
| virtual vtkTexture* vtkRenderer::GetBackgroundTexture | ( | ) | [virtual] |
Set/Get the texture to be used for the background. If set and enabled this gets the priority over the gradient background.
| virtual void vtkRenderer::SetTexturedBackground | ( | bool | ) | [virtual] |
Set/Get whether this viewport should have a textured background. Default is off.
| virtual bool vtkRenderer::GetTexturedBackground | ( | ) | [virtual] |
Set/Get whether this viewport should have a textured background. Default is off.
| virtual void vtkRenderer::TexturedBackgroundOn | ( | ) | [virtual] |
Set/Get whether this viewport should have a textured background. Default is off.
| virtual void vtkRenderer::TexturedBackgroundOff | ( | ) | [virtual] |
Set/Get whether this viewport should have a textured background. Default is off.
| virtual void vtkRenderer::PickRender | ( | vtkPropCollection * | props | ) | [protected, virtual] |
| virtual void vtkRenderer::PickGeometry | ( | ) | [protected, virtual] |
| void vtkRenderer::AllocateTime | ( | ) | [protected] |
| virtual int vtkRenderer::UpdateGeometry | ( | void | ) | [protected, virtual] |
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.
| virtual int vtkRenderer::UpdateTranslucentPolygonalGeometry | ( | ) | [protected, virtual] |
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.
| virtual int vtkRenderer::UpdateCamera | ( | void | ) | [protected, virtual] |
Ask the active camera to do whatever it needs to do prior to rendering. Creates a camera if none found active.
| virtual int vtkRenderer::UpdateLightGeometry | ( | void | ) | [protected, virtual] |
Update the geometry of the lights in the scene that are not in world space (for instance, Headlights or CameraLights that are attached to the camera).
| virtual int vtkRenderer::UpdateLights | ( | void | ) | [inline, protected, virtual] |
Ask all lights to load themselves into rendering pipeline. This method will return the actual number of lights that were on.
Reimplemented in vtkMesaRenderer, and vtkOpenGLRenderer.
Definition at line 590 of file vtkRenderer.h.
| vtkCamera* vtkRenderer::GetActiveCameraAndResetIfCreated | ( | ) | [protected] |
Get the current camera and reset it only if it gets created automatically (see GetActiveCamera). This is only used internally.
| virtual void vtkRenderer::SetSelectMode | ( | int | ) | [protected, virtual] |
| virtual void vtkRenderer::SetSelectConst | ( | unsigned | int | ) | [protected, virtual] |
| void vtkRenderer::SetIdentPainter | ( | vtkIdentColoredPainter * | ) | [protected] |
Allows the use of customized Painters for selection. If none is supplied with this method, a default will be created automatically.
| virtual int vtkRenderer::UpdateGeometryForSelection | ( | void | ) | [protected, virtual] |
Renders each polygon with a color that represents an selection index.
| vtkPainter* vtkRenderer::SwapInSelectablePainter | ( | vtkProp * | , | |
| int & | ||||
| ) | [protected] |
Called by UpdateGeometryForSelection to temporarily swap in a mapper to render a prop in selection mode.
| void vtkRenderer::SwapOutSelectablePainter | ( | vtkProp * | , | |
| vtkPainter * | , | |||
| int | ||||
| ) | [protected] |
Called by UpdateGeometryForSelection to restore a prop's original mapper.
| void vtkRenderer::SetSelector | ( | vtkHardwareSelector * | selector | ) | [inline, protected] |
Called by vtkHardwareSelector when it begins rendering for selection.
Definition at line 675 of file vtkRenderer.h.
Friends And Related Function Documentation
friend class vtkVisibleCellSelector [friend] |
Definition at line 621 of file vtkRenderer.h.
friend class vtkHardwareSelector [friend] |
Definition at line 671 of file vtkRenderer.h.
friend class vtkRendererDelegate [friend] |
Definition at line 683 of file vtkRenderer.h.
friend class vtkRenderPass [friend] |
Definition at line 686 of file vtkRenderer.h.
Member Data Documentation
vtkCamera* vtkRenderer::ActiveCamera [protected] |
Definition at line 497 of file vtkRenderer.h.
vtkLight* vtkRenderer::CreatedLight [protected] |
Definition at line 498 of file vtkRenderer.h.
vtkLightCollection* vtkRenderer::Lights [protected] |
Definition at line 500 of file vtkRenderer.h.
vtkCullerCollection* vtkRenderer::Cullers [protected] |
Definition at line 501 of file vtkRenderer.h.
vtkActorCollection* vtkRenderer::Actors [protected] |
Definition at line 503 of file vtkRenderer.h.
vtkVolumeCollection* vtkRenderer::Volumes [protected] |
Definition at line 504 of file vtkRenderer.h.
double vtkRenderer::Ambient[3] [protected] |
Definition at line 506 of file vtkRenderer.h.
vtkRenderWindow* vtkRenderer::RenderWindow [protected] |
Definition at line 507 of file vtkRenderer.h.
double vtkRenderer::AllocatedRenderTime [protected] |
Definition at line 508 of file vtkRenderer.h.
double vtkRenderer::TimeFactor [protected] |
Definition at line 509 of file vtkRenderer.h.
int vtkRenderer::TwoSidedLighting [protected] |
Definition at line 510 of file vtkRenderer.h.
int vtkRenderer::AutomaticLightCreation [protected] |
Definition at line 511 of file vtkRenderer.h.
int vtkRenderer::BackingStore [protected] |
Definition at line 512 of file vtkRenderer.h.
unsigned char* vtkRenderer::BackingImage [protected] |
Definition at line 513 of file vtkRenderer.h.
int vtkRenderer::BackingStoreSize[2] [protected] |
Definition at line 514 of file vtkRenderer.h.
vtkTimeStamp vtkRenderer::RenderTime [protected] |
Definition at line 515 of file vtkRenderer.h.
double vtkRenderer::LastRenderTimeInSeconds [protected] |
Definition at line 517 of file vtkRenderer.h.
int vtkRenderer::LightFollowCamera [protected] |
Definition at line 519 of file vtkRenderer.h.
int vtkRenderer::NumberOfPropsRendered [protected] |
Definition at line 526 of file vtkRenderer.h.
vtkProp** vtkRenderer::PropArray [protected] |
Definition at line 530 of file vtkRenderer.h.
int vtkRenderer::PropArrayCount [protected] |
Definition at line 531 of file vtkRenderer.h.
vtkAssemblyPath** vtkRenderer::PathArray [protected] |
Definition at line 534 of file vtkRenderer.h.
int vtkRenderer::PathArrayCount [protected] |
Definition at line 535 of file vtkRenderer.h.
int vtkRenderer::Interactive [protected] |
Definition at line 539 of file vtkRenderer.h.
int vtkRenderer::Layer [protected] |
Definition at line 543 of file vtkRenderer.h.
int vtkRenderer::PreserveDepthBuffer [protected] |
Definition at line 544 of file vtkRenderer.h.
double vtkRenderer::ComputedVisiblePropBounds[6] [protected] |
Definition at line 548 of file vtkRenderer.h.
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 555 of file vtkRenderer.h.
int 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 561 of file vtkRenderer.h.
int 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 566 of file vtkRenderer.h.
int 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 599 of file vtkRenderer.h.
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 608 of file vtkRenderer.h.
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 613 of file vtkRenderer.h.
int vtkRenderer::LastRenderingUsedDepthPeeling [protected] |
Tells if the last call to DeviceRenderTranslucentPolygonalGeometry() actually used depth peeling. Initial value is false.
Definition at line 617 of file vtkRenderer.h.
vtkProp** vtkRenderer::PropsSelectedFrom [protected] |
Used in Selection to recover a selected prop from an index.
Definition at line 659 of file vtkRenderer.h.
int vtkRenderer::PropsSelectedFromCount [protected] |
Used in Selection to recover a selected prop from an index.
Definition at line 660 of file vtkRenderer.h.
int vtkRenderer::SelectMode [protected] |
Definition at line 664 of file vtkRenderer.h.
unsigned int vtkRenderer::SelectConst [protected] |
Definition at line 665 of file vtkRenderer.h.
vtkIdentColoredPainter* vtkRenderer::IdentPainter [protected] |
Definition at line 666 of file vtkRenderer.h.
vtkHardwareSelector* vtkRenderer::Selector [protected] |
Definition at line 680 of file vtkRenderer.h.
vtkRendererDelegate* vtkRenderer::Delegate [protected] |
Definition at line 684 of file vtkRenderer.h.
vtkRenderPass* vtkRenderer::Pass [protected] |
Definition at line 687 of file vtkRenderer.h.
bool vtkRenderer::TexturedBackground [protected] |
Definition at line 689 of file vtkRenderer.h.
vtkTexture* vtkRenderer::BackgroundTexture [protected] |
Definition at line 690 of file vtkRenderer.h.
The documentation for this class was generated from the following file:
- dox/Rendering/vtkRenderer.h
