vtkRenderer Class Reference

#include <vtkRenderer.h>

Inheritance diagram for vtkRenderer:

[legend]Collaboration diagram for vtkRenderer:

[legend]List of all members.

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::StartEvent vtkCommand::ResetCameraEvent vtkCommand::ResetCameraClippingRangeEvent vtkCommand::EndEvent

Created by:

Martin, Ken

CVS contributions (if > 5%):

Martin, Ken (32%)
Avila, Lisa (27%)
Schroeder, Will (13%)
Law, Charles (6%)

CVS logs (CVSweb):

.cxx (/Rendering/vtkRenderer.cxx)
.h (/Rendering/vtkRenderer.h)

Examples:: vtkRenderer (Examples)

Tests:: vtkRenderer (Tests)

Definition at line 71 of file vtkRenderer.h.

Public Types

typedef vtkViewport Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

void AddLight (vtkLight *)

void RemoveLight (vtkLight *)

vtkLightCollection * GetLights ()

void CreateLight (void)

virtual vtkLight * MakeLight ()

virtual int UpdateLightsGeometryToFollowCamera (void)

vtkVolumeCollection * GetVolumes ()

vtkActorCollection * GetActors ()

void SetActiveCamera (vtkCamera *)

vtkCamera * GetActiveCamera ()

virtual vtkCamera * MakeCamera ()

void AddCuller (vtkCuller *)

void RemoveCuller (vtkCuller *)

vtkCullerCollection * GetCullers ()

virtual double GetTimeFactor ()

virtual void Render ()

virtual void DeviceRender ()=0

virtual void Clear ()

int VisibleActorCount ()

int VisibleVolumeCount ()

void ComputeVisiblePropBounds (double bounds[6])

double * ComputeVisiblePropBounds ()

void ResetCameraClippingRange ()

void ResetCamera ()

void ResetCamera (double bounds[6])

int Transparent ()

void WorldToView ()

virtual void WorldToView (double &wx, double &wy, double &wz)

double GetZ (int x, int y)

unsigned long GetMTime ()

vtkAssemblyPath * PickProp (double selectionX, double selectionY)

virtual void StereoMidpoint ()

double GetTiledAspectRatio ()

void AddActor (vtkProp *p)

void AddVolume (vtkProp *p)

void RemoveActor (vtkProp *p)

void RemoveVolume (vtkProp *p)

virtual int GetTwoSidedLighting ()

virtual void SetTwoSidedLighting (int)

virtual void TwoSidedLightingOn ()

virtual void TwoSidedLightingOff ()

virtual void SetLightFollowCamera (int)

virtual int GetLightFollowCamera ()

virtual void LightFollowCameraOn ()

virtual void LightFollowCameraOff ()

virtual int GetAutomaticLightCreation ()

virtual void SetAutomaticLightCreation (int)

virtual void AutomaticLightCreationOn ()

virtual void AutomaticLightCreationOff ()

virtual void SetErase (int)

virtual int GetErase ()

virtual void EraseOn ()

virtual void EraseOff ()

virtual void SetAmbient (double, double, double)

virtual void SetAmbient (double[3])

virtual double * GetAmbient ()

virtual void GetAmbient (double data[3])

virtual void SetAllocatedRenderTime (double)

virtual double GetAllocatedRenderTime ()

void ResetCameraClippingRange (double bounds[6])

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

virtual void SetNearClippingPlaneTolerance (double)

virtual double GetNearClippingPlaneTolerance ()

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

void SetRenderWindow (vtkRenderWindow *)

vtkRenderWindow * GetRenderWindow ()

virtual vtkWindow * GetVTKWindow ()

virtual void SetBackingStore (int)

virtual int GetBackingStore ()

virtual void BackingStoreOn ()

virtual void BackingStoreOff ()

virtual void SetInteractive (int)

virtual int GetInteractive ()

virtual void InteractiveOn ()

virtual void InteractiveOff ()

virtual void SetLayer (int)

virtual int GetLayer ()

void ViewToWorld ()

virtual void ViewToWorld (double &wx, double &wy, double &wz)

virtual double GetLastRenderTimeInSeconds ()

virtual int GetNumberOfPropsRendered ()

Static Public Member Functions

int IsTypeOf (const char *type)

vtkRenderer * SafeDownCast (vtkObject *o)

vtkRenderer * New ()

Protected Member Functions

vtkRenderer ()

~vtkRenderer ()

virtual void PickRender (vtkPropCollection *props)

virtual void PickGeometry ()

void AllocateTime ()

virtual int UpdateGeometry (void)

virtual int UpdateCamera (void)

virtual int UpdateLightGeometry (void)

virtual int UpdateLights (void)

Protected Attributes

vtkCamera * ActiveCamera

vtkLight * CreatedLight

vtkLightCollection * Lights

vtkCullerCollection * Cullers

vtkActorCollection * Actors

vtkVolumeCollection * Volumes

double Ambient [3]

vtkRenderWindow * RenderWindow

double AllocatedRenderTime

double TimeFactor

int TwoSidedLighting

int AutomaticLightCreation

int BackingStore

unsigned char * BackingImage

int BackingStoreSize [2]

vtkTimeStamp RenderTime

double LastRenderTimeInSeconds

int LightFollowCamera

int NumberOfPropsRendered

vtkProp ** PropArray

int PropArrayCount

vtkAssemblyPath ** PathArray

int PathArrayCount

int Interactive

int Layer

double ComputedVisiblePropBounds [6]

double NearClippingPlaneTolerance

int Erase

Member Typedef Documentation

typedef vtkViewport vtkRenderer::Superclass

Reimplemented from vtkViewport.
Reimplemented in vtkMesaRenderer, and vtkOpenGLRenderer.
Definition at line 74 of file vtkRenderer.h.

Constructor & Destructor Documentation

vtkRenderer::vtkRenderer ( ) [protected]

vtkRenderer::~vtkRenderer ( ) [protected]

Member Function Documentation

virtual const char* vtkRenderer::GetClassName ( ) [virtual]

Reimplemented from vtkViewport.
Reimplemented in vtkMesaRenderer, and vtkOpenGLRenderer.

int vtkRenderer::IsTypeOf ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkViewport.
Reimplemented in vtkMesaRenderer, and vtkOpenGLRenderer.

virtual int vtkRenderer::IsA ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkViewport.
Reimplemented in vtkMesaRenderer, and vtkOpenGLRenderer.

vtkRenderer* vtkRenderer::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkViewport.
Reimplemented in vtkMesaRenderer, and vtkOpenGLRenderer.

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.

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 ) [inline]

Add/Remove different types of props to the renderer. These methods are all synonyms to AddProp and RemoveProp. They are here for convenience and backwards compatibility.
Definition at line 86 of file vtkRenderer.h.
References vtkViewport::AddProp().

void vtkRenderer::AddVolume ( vtkProp * p ) [inline]

Add/Remove different types of props to the renderer. These methods are all synonyms to AddProp and RemoveProp. They are here for convenience and backwards compatibility.
Definition at line 87 of file vtkRenderer.h.
References vtkViewport::AddProp().

void vtkRenderer::RemoveActor ( vtkProp * p ) [inline]

Add/Remove different types of props to the renderer. These methods are all synonyms to AddProp and RemoveProp. They are here for convenience and backwards compatibility.
Definition at line 88 of file vtkRenderer.h.
References vtkViewport::RemoveProp().

void vtkRenderer::RemoveVolume ( vtkProp * p ) [inline]

Add/Remove different types of props to the renderer. These methods are all synonyms to AddProp and RemoveProp. They are here for convenience and backwards compatibility.
Definition at line 89 of file vtkRenderer.h.
References vtkViewport::RemoveProp().

void vtkRenderer::AddLight ( vtkLight * )

Add a light to the list of lights.

void vtkRenderer::RemoveLight ( vtkLight * )

Remove a light from the list of lights.

vtkLightCollection * vtkRenderer::GetLights ( ) [inline]

Return the collection of lights.
Definition at line 459 of file vtkRenderer.h.

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.

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.

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.
Definition at line 464 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]

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::Clear ( void ) [inline, virtual]

Clear the image to the background color.
Reimplemented in vtkMesaRenderer, and vtkOpenGLRenderer.
Definition at line 216 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 280 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.

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 RenderTranslucentGeometry call. This is used to know if something is in the frame buffer.

vtkAssemblyPath* vtkRenderer::PickProp ( double selectionX,

double selectionY

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

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 355 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

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::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 452 of file vtkRenderer.h.

Member Data Documentation

vtkCamera* vtkRenderer::ActiveCamera [protected]

Definition at line 371 of file vtkRenderer.h.

vtkLight* vtkRenderer::CreatedLight [protected]

Definition at line 372 of file vtkRenderer.h.

vtkLightCollection* vtkRenderer::Lights [protected]

Definition at line 374 of file vtkRenderer.h.

vtkCullerCollection* vtkRenderer::Cullers [protected]

Definition at line 375 of file vtkRenderer.h.

vtkActorCollection* vtkRenderer::Actors [protected]

Definition at line 377 of file vtkRenderer.h.

vtkVolumeCollection* vtkRenderer::Volumes [protected]

Definition at line 378 of file vtkRenderer.h.

double vtkRenderer::Ambient[3] [protected]

Definition at line 380 of file vtkRenderer.h.

vtkRenderWindow* vtkRenderer::RenderWindow [protected]

Definition at line 381 of file vtkRenderer.h.

double vtkRenderer::AllocatedRenderTime [protected]

Definition at line 382 of file vtkRenderer.h.

double vtkRenderer::TimeFactor [protected]

Definition at line 383 of file vtkRenderer.h.

int vtkRenderer::TwoSidedLighting [protected]

Definition at line 384 of file vtkRenderer.h.

int vtkRenderer::AutomaticLightCreation [protected]

Definition at line 385 of file vtkRenderer.h.

int vtkRenderer::BackingStore [protected]

Definition at line 386 of file vtkRenderer.h.

unsigned char* vtkRenderer::BackingImage [protected]

Definition at line 387 of file vtkRenderer.h.

int vtkRenderer::BackingStoreSize[2] [protected]

Definition at line 388 of file vtkRenderer.h.

vtkTimeStamp vtkRenderer::RenderTime [protected]

Definition at line 389 of file vtkRenderer.h.

double vtkRenderer::LastRenderTimeInSeconds [protected]

Definition at line 391 of file vtkRenderer.h.

int vtkRenderer::LightFollowCamera [protected]

Definition at line 393 of file vtkRenderer.h.

int vtkRenderer::NumberOfPropsRendered [protected]

Definition at line 400 of file vtkRenderer.h.

vtkProp** vtkRenderer::PropArray [protected]

Definition at line 404 of file vtkRenderer.h.

int vtkRenderer::PropArrayCount [protected]

Definition at line 405 of file vtkRenderer.h.

vtkAssemblyPath** vtkRenderer::PathArray [protected]

Definition at line 408 of file vtkRenderer.h.

int vtkRenderer::PathArrayCount [protected]

Definition at line 409 of file vtkRenderer.h.

int vtkRenderer::Interactive [protected]

Definition at line 413 of file vtkRenderer.h.

int vtkRenderer::Layer [protected]

Definition at line 417 of file vtkRenderer.h.

double vtkRenderer::ComputedVisiblePropBounds[6] [protected]

Definition at line 421 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 428 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 434 of file vtkRenderer.h.

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

dox/Rendering/vtkRenderer.h


Public Types
typedef vtkViewport	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	AddLight (vtkLight *)
void	RemoveLight (vtkLight *)
vtkLightCollection *	GetLights ()
void	CreateLight (void)
virtual vtkLight *	MakeLight ()
virtual int	UpdateLightsGeometryToFollowCamera (void)
vtkVolumeCollection *	GetVolumes ()
vtkActorCollection *	GetActors ()
void	SetActiveCamera (vtkCamera *)
vtkCamera *	GetActiveCamera ()
virtual vtkCamera *	MakeCamera ()
void	AddCuller (vtkCuller *)
void	RemoveCuller (vtkCuller *)
vtkCullerCollection *	GetCullers ()
virtual double	GetTimeFactor ()
virtual void	Render ()
virtual void	DeviceRender ()=0
virtual void	Clear ()
int	VisibleActorCount ()
int	VisibleVolumeCount ()
void	ComputeVisiblePropBounds (double bounds[6])
double *	ComputeVisiblePropBounds ()
void	ResetCameraClippingRange ()
void	ResetCamera ()
void	ResetCamera (double bounds[6])
int	Transparent ()
void	WorldToView ()
virtual void	WorldToView (double &wx, double &wy, double &wz)
double	GetZ (int x, int y)
unsigned long	GetMTime ()
vtkAssemblyPath *	PickProp (double selectionX, double selectionY)
virtual void	StereoMidpoint ()
double	GetTiledAspectRatio ()

void	AddActor (vtkProp *p)
void	AddVolume (vtkProp *p)
void	RemoveActor (vtkProp *p)
void	RemoveVolume (vtkProp *p)

virtual int	GetTwoSidedLighting ()
virtual void	SetTwoSidedLighting (int)
virtual void	TwoSidedLightingOn ()
virtual void	TwoSidedLightingOff ()

virtual void	SetLightFollowCamera (int)
virtual int	GetLightFollowCamera ()
virtual void	LightFollowCameraOn ()
virtual void	LightFollowCameraOff ()

virtual int	GetAutomaticLightCreation ()
virtual void	SetAutomaticLightCreation (int)
virtual void	AutomaticLightCreationOn ()
virtual void	AutomaticLightCreationOff ()

virtual void	SetErase (int)
virtual int	GetErase ()
virtual void	EraseOn ()
virtual void	EraseOff ()

virtual void	SetAmbient (double, double, double)
virtual void	SetAmbient (double[3])
virtual double *	GetAmbient ()
virtual void	GetAmbient (double data[3])

virtual void	SetAllocatedRenderTime (double)
virtual double	GetAllocatedRenderTime ()

void	ResetCameraClippingRange (double bounds[6])
void	ResetCameraClippingRange (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)

virtual void	SetNearClippingPlaneTolerance (double)
virtual double	GetNearClippingPlaneTolerance ()

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

void	SetRenderWindow (vtkRenderWindow *)
vtkRenderWindow *	GetRenderWindow ()
virtual vtkWindow *	GetVTKWindow ()

virtual void	SetBackingStore (int)
virtual int	GetBackingStore ()
virtual void	BackingStoreOn ()
virtual void	BackingStoreOff ()

virtual void	SetInteractive (int)
virtual int	GetInteractive ()
virtual void	InteractiveOn ()
virtual void	InteractiveOff ()

virtual void	SetLayer (int)
virtual int	GetLayer ()

void	ViewToWorld ()
virtual void	ViewToWorld (double &wx, double &wy, double &wz)

virtual double	GetLastRenderTimeInSeconds ()

virtual int	GetNumberOfPropsRendered ()
Static Public Member Functions
int	IsTypeOf (const char *type)
vtkRenderer *	SafeDownCast (vtkObject *o)
vtkRenderer *	New ()
Protected Member Functions
	vtkRenderer ()
	~vtkRenderer ()
virtual void	PickRender (vtkPropCollection *props)
virtual void	PickGeometry ()
void	AllocateTime ()
virtual int	UpdateGeometry (void)
virtual int	UpdateCamera (void)
virtual int	UpdateLightGeometry (void)
virtual int	UpdateLights (void)
Protected Attributes
vtkCamera *	ActiveCamera
vtkLight *	CreatedLight
vtkLightCollection *	Lights
vtkCullerCollection *	Cullers
vtkActorCollection *	Actors
vtkVolumeCollection *	Volumes
double	Ambient [3]
vtkRenderWindow *	RenderWindow
double	AllocatedRenderTime
double	TimeFactor
int	TwoSidedLighting
int	AutomaticLightCreation
int	BackingStore
unsigned char *	BackingImage
int	BackingStoreSize [2]
vtkTimeStamp	RenderTime
double	LastRenderTimeInSeconds
int	LightFollowCamera
int	NumberOfPropsRendered
vtkProp **	PropArray
int	PropArrayCount
vtkAssemblyPath **	PathArray
int	PathArrayCount
int	Interactive
int	Layer
double	ComputedVisiblePropBounds [6]
double	NearClippingPlaneTolerance
int	Erase