abstract specification for renderers More...
#include <vtkRenderer.h>
Public Types | |
| typedef vtkViewport | Superclass |
 Public Types inherited from vtkViewport | |
| typedef vtkObject | Superclass |
Public Member Functions | |
| virtual int | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
| vtkRenderer * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
| void | AddLight (vtkLight *) |
| Add a light to the list of lights. More... | |
| void | RemoveLight (vtkLight *) |
| Remove a light from the list of lights. More... | |
| void | RemoveAllLights () |
| Remove all lights from the list of lights. More... | |
| vtkLightCollection * | GetLights () |
| Return the collection of lights. More... | |
| void | SetLightCollection (vtkLightCollection *lights) |
| Set the collection of lights. More... | |
| void | CreateLight (void) |
| Create and add a light to renderer. More... | |
| virtual vtkLight * | MakeLight () |
| Create a new Light sutible for use with this type of Renderer. More... | |
| virtual int | UpdateLightsGeometryToFollowCamera (void) |
| Ask the lights in the scene that are not in world space (for instance, Headlights or CameraLights that are attached to the camera) to update their geometry to match the active camera. More... | |
| vtkVolumeCollection * | GetVolumes () |
| Return the collection of volumes. More... | |
| vtkActorCollection * | GetActors () |
| Return any actors in this renderer. More... | |
| void | SetActiveCamera (vtkCamera *) |
| Specify the camera to use for this renderer. More... | |
| vtkCamera * | GetActiveCamera () |
| Get the current camera. More... | |
| virtual vtkCamera * | MakeCamera () |
| Create a new Camera sutible for use with this type of Renderer. More... | |
| int | CaptureGL2PSSpecialProp (vtkProp *) |
| This function is called to capture an instance of vtkProp that requires special handling during vtkRenderWindow::CaptureGL2PSSpecialProps(). More... | |
| void | SetGL2PSSpecialPropCollection (vtkPropCollection *) |
| Set the prop collection object used during vtkRenderWindow::CaptureGL2PSSpecialProps(). More... | |
| void | AddCuller (vtkCuller *) |
| Add an culler to the list of cullers. More... | |
| void | RemoveCuller (vtkCuller *) |
| Remove an actor from the list of cullers. More... | |
| vtkCullerCollection * | GetCullers () |
| Return the collection of cullers. More... | |
| virtual double | GetTimeFactor () |
| Get the ratio between allocated time and actual render time. More... | |
| virtual void | Render () |
| CALLED BY vtkRenderWindow ONLY. More... | |
| virtual void | DeviceRender ()=0 |
| Create an image. More... | |
| virtual void | DeviceRenderOpaqueGeometry () |
| Render opaque polygonal geometry. More... | |
| virtual void | DeviceRenderTranslucentPolygonalGeometry () |
| Render translucent polygonal geometry. More... | |
| virtual void | ClearLights (void) |
| Internal method temporarily removes lights before reloading them into graphics pipeline. More... | |
| virtual void | Clear () |
| Clear the image to the background color. More... | |
| int | VisibleActorCount () |
| Returns the number of visible actors. More... | |
| int | VisibleVolumeCount () |
| Returns the number of visible volumes. More... | |
| void | ComputeVisiblePropBounds (double bounds[6]) |
| Compute the bounding box of all the visible props Used in ResetCamera() and ResetCameraClippingRange() More... | |
| double * | ComputeVisiblePropBounds () |
| Wrapper-friendly version of ComputeVisiblePropBounds. More... | |
| void | ResetCameraClippingRange () |
| Reset the camera clipping range based on the bounds of the visible actors. More... | |
| virtual void | ResetCamera () |
| Automatically set up the camera based on the visible actors. More... | |
| virtual void | ResetCamera (double bounds[6]) |
| Automatically set up the camera based on a specified bounding box (xmin,xmax, ymin,ymax, zmin,zmax). More... | |
| virtual void | ResetCamera (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) |
| Alternative version of ResetCamera(bounds[6]);. More... | |
| int | Transparent () |
| Returns a boolean indicating if this renderer is transparent. More... | |
| void | WorldToView () |
| Convert world point coordinates to view coordinates. More... | |
| virtual void | WorldToView (double &wx, double &wy, double &wz) |
| Convert world point coordinates to view coordinates. More... | |
| double | GetZ (int x, int y) |
| Given a pixel location, return the Z value. More... | |
| vtkMTimeType | GetMTime () |
| Return the MTime of the renderer also considering its ivars. More... | |
| virtual void | StereoMidpoint () |
| Do anything necessary between rendering the left and right viewpoints in a stereo render. More... | |
| double | GetTiledAspectRatio () |
| Compute the aspect ratio of this renderer for the current tile. More... | |
| int | IsActiveCameraCreated () |
| This method returns 1 if the ActiveCamera has already been set or automatically created by the renderer. More... | |
| virtual void | ReleaseGraphicsResources (vtkWindow *) |
| void | SetPass (vtkRenderPass *p) |
| virtual vtkRenderPass * | GetPass () |
| void | AddActor (vtkProp *p) |
| Add/Remove different types of props to the renderer. More... | |
| void | AddVolume (vtkProp *p) |
| Add/Remove different types of props to the renderer. More... | |
| void | RemoveActor (vtkProp *p) |
| Add/Remove different types of props to the renderer. More... | |
| void | RemoveVolume (vtkProp *p) |
| Add/Remove different types of props to the renderer. More... | |
| virtual int | GetTwoSidedLighting () |
| Turn on/off two-sided lighting of surfaces. More... | |
| virtual void | SetTwoSidedLighting (int) |
| Turn on/off two-sided lighting of surfaces. More... | |
| virtual void | TwoSidedLightingOn () |
| Turn on/off two-sided lighting of surfaces. More... | |
| virtual void | TwoSidedLightingOff () |
| Turn on/off two-sided lighting of surfaces. More... | |
| virtual void | SetLightFollowCamera (int) |
| Turn on/off the automatic repositioning of lights as the camera moves. More... | |
| virtual int | GetLightFollowCamera () |
| Turn on/off the automatic repositioning of lights as the camera moves. More... | |
| virtual void | LightFollowCameraOn () |
| Turn on/off the automatic repositioning of lights as the camera moves. More... | |
| virtual void | LightFollowCameraOff () |
| Turn on/off the automatic repositioning of lights as the camera moves. More... | |
| virtual int | GetAutomaticLightCreation () |
| Turn on/off a flag which disables the automatic light creation capability. More... | |
| virtual void | SetAutomaticLightCreation (int) |
| Turn on/off a flag which disables the automatic light creation capability. More... | |
| virtual void | AutomaticLightCreationOn () |
| Turn on/off a flag which disables the automatic light creation capability. More... | |
| virtual void | AutomaticLightCreationOff () |
| Turn on/off a flag which disables the automatic light creation capability. More... | |
| virtual void | SetErase (int) |
| When this flag is off, the renderer will not erase the background or the Zbuffer. More... | |
| virtual int | GetErase () |
| When this flag is off, the renderer will not erase the background or the Zbuffer. More... | |
| virtual void | EraseOn () |
| When this flag is off, the renderer will not erase the background or the Zbuffer. More... | |
| virtual void | EraseOff () |
| When this flag is off, the renderer will not erase the background or the Zbuffer. More... | |
| virtual void | SetDraw (int) |
| When this flag is off, render commands are ignored. More... | |
| virtual int | GetDraw () |
| When this flag is off, render commands are ignored. More... | |
| virtual void | DrawOn () |
| When this flag is off, render commands are ignored. More... | |
| virtual void | DrawOff () |
| When this flag is off, render commands are ignored. More... | |
| virtual void | SetAmbient (double, double, double) |
| Set the intensity of ambient lighting. More... | |
| virtual void | SetAmbient (double[3]) |
| Set the intensity of ambient lighting. More... | |
| virtual double * | GetAmbient () |
| Set the intensity of ambient lighting. More... | |
| virtual void | GetAmbient (double data[3]) |
| Set the intensity of ambient lighting. More... | |
| virtual void | SetAllocatedRenderTime (double) |
| Set/Get the amount of time this renderer is allowed to spend rendering its scene. More... | |
| virtual double | GetAllocatedRenderTime () |
| Set/Get the amount of time this renderer is allowed to spend rendering its scene. More... | |
| void | ResetCameraClippingRange (double bounds[6]) |
| Reset the camera clipping range based on a bounding box. More... | |
| void | ResetCameraClippingRange (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) |
| Reset the camera clipping range based on a bounding box. More... | |
| virtual void | SetNearClippingPlaneTolerance (double) |
| Specify tolerance for near clipping plane distance to the camera as a percentage of the far clipping plane distance. More... | |
| virtual double | GetNearClippingPlaneTolerance () |
| Specify tolerance for near clipping plane distance to the camera as a percentage of the far clipping plane distance. More... | |
| virtual void | SetClippingRangeExpansion (double) |
| Specify enlargement of bounds when resetting the camera clipping range. More... | |
| virtual double | GetClippingRangeExpansion () |
| Specify enlargement of bounds when resetting the camera clipping range. More... | |
| void | SetRenderWindow (vtkRenderWindow *) |
| Specify the rendering window in which to draw. More... | |
| vtkRenderWindow * | GetRenderWindow () |
| Specify the rendering window in which to draw. More... | |
| virtual vtkWindow * | GetVTKWindow () |
| Specify the rendering window in which to draw. More... | |
| virtual void | SetBackingStore (int) |
| Turn on/off using backing store. More... | |
| virtual int | GetBackingStore () |
| Turn on/off using backing store. More... | |
| virtual void | BackingStoreOn () |
| Turn on/off using backing store. More... | |
| virtual void | BackingStoreOff () |
| Turn on/off using backing store. More... | |
| virtual void | SetInteractive (int) |
| Turn on/off interactive status. More... | |
| virtual int | GetInteractive () |
| Turn on/off interactive status. More... | |
| virtual void | InteractiveOn () |
| Turn on/off interactive status. More... | |
| virtual void | InteractiveOff () |
| Turn on/off interactive status. More... | |
| virtual void | SetLayer (int layer) |
| Set/Get the layer that this renderer belongs to. More... | |
| virtual int | GetLayer () |
| Set/Get the layer that this renderer belongs to. More... | |
| virtual int | GetPreserveColorBuffer () |
| By default, the renderer at layer 0 is opaque, and all non-zero layer renderers are transparent. More... | |
| virtual void | SetPreserveColorBuffer (int) |
| By default, the renderer at layer 0 is opaque, and all non-zero layer renderers are transparent. More... | |
| virtual void | PreserveColorBufferOn () |
| By default, the renderer at layer 0 is opaque, and all non-zero layer renderers are transparent. More... | |
| virtual void | PreserveColorBufferOff () |
| By default, the renderer at layer 0 is opaque, and all non-zero layer renderers are transparent. More... | |
| virtual void | SetPreserveDepthBuffer (int) |
| By default, the depth buffer is reset for each renderer. More... | |
| virtual int | GetPreserveDepthBuffer () |
| By default, the depth buffer is reset for each renderer. More... | |
| virtual void | PreserveDepthBufferOn () |
| By default, the depth buffer is reset for each renderer. More... | |
| virtual void | PreserveDepthBufferOff () |
| By default, the depth buffer is reset for each renderer. More... | |
| void | ViewToWorld () |
| Convert view point coordinates to world coordinates. More... | |
| virtual void | ViewToWorld (double &wx, double &wy, double &wz) |
| Convert view point coordinates to world coordinates. More... | |
| virtual double | GetLastRenderTimeInSeconds () |
| Get the time required, in seconds, for the last Render call. More... | |
| virtual int | GetNumberOfPropsRendered () |
| Should be used internally only during a render Get the number of props that were rendered using a RenderOpaqueGeometry or RenderTranslucentPolygonalGeometry call. More... | |
| vtkAssemblyPath * | PickProp (double selectionX, double selectionY) |
| Return the prop (via a vtkAssemblyPath) that has the highest z value at the given x, y position in the viewport. More... | |
| vtkAssemblyPath * | 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. More... | |
| virtual void | SetUseDepthPeeling (int) |
| Turn on/off rendering of translucent material with depth peeling technique. More... | |
| virtual int | GetUseDepthPeeling () |
| Turn on/off rendering of translucent material with depth peeling technique. More... | |
| virtual void | UseDepthPeelingOn () |
| Turn on/off rendering of translucent material with depth peeling technique. More... | |
| virtual void | UseDepthPeelingOff () |
| Turn on/off rendering of translucent material with depth peeling technique. More... | |
| virtual void | SetOcclusionRatio (double) |
| In case of use of depth peeling technique for rendering translucent material, define the threshold under which the algorithm stops to iterate over peel layers. More... | |
| virtual double | GetOcclusionRatio () |
| In case of use of depth peeling technique for rendering translucent material, define the threshold under which the algorithm stops to iterate over peel layers. More... | |
| virtual void | SetMaximumNumberOfPeels (int) |
| In case of depth peeling, define the maximum number of peeling layers. More... | |
| virtual int | GetMaximumNumberOfPeels () |
| In case of depth peeling, define the maximum number of peeling layers. More... | |
| virtual int | GetLastRenderingUsedDepthPeeling () |
| Tells if the last call to DeviceRenderTranslucentPolygonalGeometry() actually used depth peeling. More... | |
| void | SetDelegate (vtkRendererDelegate *d) |
| Set/Get a custom Render call. More... | |
| virtual vtkRendererDelegate * | GetDelegate () |
| Set/Get a custom Render call. More... | |
| virtual vtkHardwareSelector * | GetSelector () |
| Get the current hardware selector. More... | |
| virtual void | SetBackgroundTexture (vtkTexture *) |
| Set/Get the texture to be used for the background. More... | |
| virtual vtkTexture * | GetBackgroundTexture () |
| Set/Get the texture to be used for the background. More... | |
| virtual void | SetTexturedBackground (bool) |
| Set/Get whether this viewport should have a textured background. More... | |
| virtual bool | GetTexturedBackground () |
| Set/Get whether this viewport should have a textured background. More... | |
| virtual void | TexturedBackgroundOn () |
| Set/Get whether this viewport should have a textured background. More... | |
| virtual void | TexturedBackgroundOff () |
| Set/Get whether this viewport should have a textured background. More... | |
| virtual void | SetUseFXAA (bool) |
| Turn on/off FXAA anti-aliasing, if supported. More... | |
| virtual bool | GetUseFXAA () |
| Turn on/off FXAA anti-aliasing, if supported. More... | |
| virtual void | UseFXAAOn () |
| Turn on/off FXAA anti-aliasing, if supported. More... | |
| virtual void | UseFXAAOff () |
| Turn on/off FXAA anti-aliasing, if supported. More... | |
| virtual vtkFXAAOptions * | GetFXAAOptions () |
| The configuration object for FXAA antialiasing. More... | |
| virtual void | SetFXAAOptions (vtkFXAAOptions *) |
| The configuration object for FXAA antialiasing. More... | |
| virtual void | SetUseShadows (int) |
| Turn on/off rendering of shadows if supported Initial value is off. More... | |
| virtual int | GetUseShadows () |
| Turn on/off rendering of shadows if supported Initial value is off. More... | |
| virtual void | UseShadowsOn () |
| Turn on/off rendering of shadows if supported Initial value is off. More... | |
| virtual void | UseShadowsOff () |
| Turn on/off rendering of shadows if supported Initial value is off. More... | |
| virtual void | SetUseHiddenLineRemoval (int) |
| If this flag is true and the rendering engine supports it, wireframe geometry will be drawn using hidden line removal. More... | |
| virtual int | GetUseHiddenLineRemoval () |
| If this flag is true and the rendering engine supports it, wireframe geometry will be drawn using hidden line removal. More... | |
| virtual void | UseHiddenLineRemovalOn () |
| If this flag is true and the rendering engine supports it, wireframe geometry will be drawn using hidden line removal. More... | |
| virtual void | UseHiddenLineRemovalOff () |
| If this flag is true and the rendering engine supports it, wireframe geometry will be drawn using hidden line removal. More... | |
| virtual vtkInformation * | GetInformation () |
| Set/Get the information object associated with this algorithm. More... | |
| virtual void | SetInformation (vtkInformation *) |
| Set/Get the information object associated with this algorithm. More... | |
| Public Member Functions inherited from vtkViewport | |
| vtkViewport * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
| void | AddViewProp (vtkProp *) |
| Add a prop to the list of props. More... | |
| vtkPropCollection * | GetViewProps () |
| Return any props in this viewport. More... | |
| int | HasViewProp (vtkProp *) |
| Query if a prop is in the list of props. More... | |
| void | RemoveViewProp (vtkProp *) |
| Remove a prop from the list of props. More... | |
| void | RemoveAllViewProps (void) |
| Remove all props from the list of props. More... | |
| virtual double * | GetCenter () |
| Return the center of this viewport in display coordinates. More... | |
| virtual int | IsInViewport (int x, int y) |
| Is a given display point in this Viewport's viewport. More... | |
| virtual void | DisplayToView () |
| Convert display coordinates to view coordinates. More... | |
| virtual void | ViewToDisplay () |
| Convert view coordinates to display coordinates. More... | |
| void | DisplayToWorld () |
| Convert display (or screen) coordinates to world coordinates. More... | |
| void | WorldToDisplay () |
| Convert world point coordinates to display (or screen) coordinates. More... | |
| vtkAssemblyPath * | PickPropFrom (double selectionX, double selectionY, vtkPropCollection *) |
| Same as PickProp with two arguments, but selects from the given collection of Props instead of the Renderers props. More... | |
| vtkAssemblyPath * | PickPropFrom (double selectionX1, double selectionY1, double selectionX2, double selectionY2, vtkPropCollection *) |
| Same as PickProp with four arguments, but selects from the given collection of Props instead of the Renderers props. More... | |
| virtual double | GetPickedZ ()=0 |
| Return the Z value for the last picked Prop. More... | |
| void | AddActor2D (vtkProp *p) |
| Add/Remove different types of props to the renderer. More... | |
| void | RemoveActor2D (vtkProp *p) |
| Add/Remove different types of props to the renderer. More... | |
| vtkActor2DCollection * | GetActors2D () |
| Add/Remove different types of props to the renderer. More... | |
| virtual void | SetBackground (double, double, double) |
| Set/Get the background color of the rendering screen using an rgb color specification. More... | |
| virtual void | SetBackground (double[3]) |
| Set/Get the background color of the rendering screen using an rgb color specification. More... | |
| virtual double * | GetBackground () |
| Set/Get the background color of the rendering screen using an rgb color specification. More... | |
| virtual void | GetBackground (double &, double &, double &) |
| Set/Get the background color of the rendering screen using an rgb color specification. More... | |
| virtual void | GetBackground (double[3]) |
| Set/Get the background color of the rendering screen using an rgb color specification. More... | |
| virtual void | SetBackground2 (double, double, double) |
| Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification. More... | |
| virtual void | SetBackground2 (double[3]) |
| Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification. More... | |
| virtual double * | GetBackground2 () |
| Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification. More... | |
| virtual void | GetBackground2 (double &, double &, double &) |
| Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification. More... | |
| virtual void | GetBackground2 (double[3]) |
| Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification. More... | |
| virtual void | SetGradientBackground (bool) |
| Set/Get whether this viewport should have a gradient background using the Background (bottom) and Background2 (top) colors. More... | |
| virtual bool | GetGradientBackground () |
| Set/Get whether this viewport should have a gradient background using the Background (bottom) and Background2 (top) colors. More... | |
| virtual void | GradientBackgroundOn () |
| Set/Get whether this viewport should have a gradient background using the Background (bottom) and Background2 (top) colors. More... | |
| virtual void | GradientBackgroundOff () |
| Set/Get whether this viewport should have a gradient background using the Background (bottom) and Background2 (top) colors. More... | |
| virtual void | SetAspect (double, double) |
| Set the aspect ratio of the rendered image. More... | |
| void | SetAspect (double[2]) |
| Set the aspect ratio of the rendered image. More... | |
| virtual double * | GetAspect () |
| Set the aspect ratio of the rendered image. More... | |
| virtual void | GetAspect (double data[2]) |
| Set the aspect ratio of the rendered image. More... | |
| virtual void | ComputeAspect () |
| Set the aspect ratio of the rendered image. More... | |
| virtual void | SetPixelAspect (double, double) |
| Set the aspect ratio of a pixel in the rendered image. More... | |
| void | SetPixelAspect (double[2]) |
| Set the aspect ratio of a pixel in the rendered image. More... | |
| virtual double * | GetPixelAspect () |
| Set the aspect ratio of a pixel in the rendered image. More... | |
| virtual void | GetPixelAspect (double data[2]) |
| Set the aspect ratio of a pixel in the rendered image. More... | |
| virtual void | SetViewport (double, double, double, double) |
| Specify the viewport for the Viewport to draw in the rendering window. More... | |
| virtual void | SetViewport (double[4]) |
| Specify the viewport for the Viewport to draw in the rendering window. More... | |
| virtual double * | GetViewport () |
| Specify the viewport for the Viewport to draw in the rendering window. More... | |
| virtual void | GetViewport (double data[4]) |
| Specify the viewport for the Viewport to draw in the rendering window. More... | |
| virtual void | SetDisplayPoint (double, double, double) |
| Set/get a point location in display (or screen) coordinates. More... | |
| virtual void | SetDisplayPoint (double[3]) |
| Set/get a point location in display (or screen) coordinates. More... | |
| virtual double * | GetDisplayPoint () |
| Set/get a point location in display (or screen) coordinates. More... | |
| virtual void | GetDisplayPoint (double data[3]) |
| Set/get a point location in display (or screen) coordinates. More... | |
| virtual void | SetViewPoint (double, double, double) |
| Specify a point location in view coordinates. More... | |
| virtual void | SetViewPoint (double[3]) |
| Specify a point location in view coordinates. More... | |
| virtual double * | GetViewPoint () |
| Specify a point location in view coordinates. More... | |
| virtual void | GetViewPoint (double data[3]) |
| Specify a point location in view coordinates. More... | |
| virtual void | SetWorldPoint (double, double, double, double) |
| Specify a point location in world coordinates. More... | |
| virtual void | SetWorldPoint (double[4]) |
| Specify a point location in world coordinates. More... | |
| virtual double * | GetWorldPoint () |
| Specify a point location in world coordinates. More... | |
| virtual void | GetWorldPoint (double data[4]) |
| Specify a point location in world coordinates. More... | |
| virtual void | LocalDisplayToDisplay (double &x, double &y) |
| These methods map from one coordinate system to another. More... | |
| virtual void | DisplayToNormalizedDisplay (double &u, double &v) |
| These methods map from one coordinate system to another. More... | |
| virtual void | NormalizedDisplayToViewport (double &x, double &y) |
| These methods map from one coordinate system to another. More... | |
| virtual void | ViewportToNormalizedViewport (double &u, double &v) |
| These methods map from one coordinate system to another. More... | |
| virtual void | NormalizedViewportToView (double &x, double &y, double &z) |
| These methods map from one coordinate system to another. More... | |
| virtual void | DisplayToLocalDisplay (double &x, double &y) |
| These methods map from one coordinate system to another. More... | |
| virtual void | NormalizedDisplayToDisplay (double &u, double &v) |
| These methods map from one coordinate system to another. More... | |
| virtual void | ViewportToNormalizedDisplay (double &x, double &y) |
| These methods map from one coordinate system to another. More... | |
| virtual void | NormalizedViewportToViewport (double &u, double &v) |
| These methods map from one coordinate system to another. More... | |
| virtual void | ViewToNormalizedViewport (double &x, double &y, double &z) |
| These methods map from one coordinate system to another. More... | |
| virtual int * | GetSize () |
| Get the size and origin of the viewport in display coordinates. More... | |
| virtual int * | GetOrigin () |
| Get the size and origin of the viewport in display coordinates. More... | |
| void | GetTiledSize (int *width, int *height) |
| Get the size and origin of the viewport in display coordinates. More... | |
| virtual void | GetTiledSizeAndOrigin (int *width, int *height, int *lowerLeftX, int *lowerLeftY) |
| Get the size and origin of the viewport in display coordinates. More... | |
| double | GetPickX () const |
| Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More... | |
| double | GetPickY () const |
| Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More... | |
| double | GetPickWidth () const |
| Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More... | |
| double | GetPickHeight () const |
| Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More... | |
| double | GetPickX1 () const |
| Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More... | |
| double | GetPickY1 () const |
| Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More... | |
| double | GetPickX2 () const |
| Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More... | |
| double | GetPickY2 () const |
| Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More... | |
| virtual int | GetIsPicking () |
| Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More... | |
| virtual unsigned int | GetCurrentPickId () |
| Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More... | |
| void | SetCurrentPickId (unsigned int a) |
| Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More... | |
| virtual vtkPropCollection * | GetPickResultProps () |
| Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More... | |
| Public Member Functions inherited from vtkObject | |
| vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
| virtual void | DebugOn () |
| Turn debugging output on. More... | |
| virtual void | DebugOff () |
| Turn debugging output off. More... | |
| bool | GetDebug () |
| Get the value of the debug flag. More... | |
| void | SetDebug (bool debugFlag) |
| Set the value of the debug flag. More... | |
| virtual void | Modified () |
| Update the modification time for this object. More... | |
| void | RemoveObserver (unsigned long tag) |
| void | RemoveObservers (unsigned long event) |
| void | RemoveObservers (const char *event) |
| void | RemoveAllObservers () |
| int | HasObserver (unsigned long event) |
| int | HasObserver (const char *event) |
| int | InvokeEvent (unsigned long event) |
| int | InvokeEvent (const char *event) |
| unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkCommand * | GetCommand (unsigned long tag) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObserver (vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| int | HasObserver (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| int | HasObserver (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Allow user to set the AbortFlagOn() with the return value of the callback method. More... | |
| int | InvokeEvent (unsigned long event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| int | InvokeEvent (const char *event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| Public Member Functions inherited from vtkObjectBase | |
| const char * | GetClassName () const |
| Return the class name as a string. More... | |
| virtual void | Delete () |
| Delete a VTK object. More... | |
| virtual void | FastDelete () |
| Delete a reference to this object. More... | |
| void | InitializeObjectBase () |
| void | Print (ostream &os) |
| Print an object to an ostream. More... | |
| virtual void | Register (vtkObjectBase *o) |
| Increase the reference count (mark as used by another object). More... | |
| virtual void | UnRegister (vtkObjectBase *o) |
| Decrease the reference count (release by another object). More... | |
| int | GetReferenceCount () |
| Return the current reference count of this object. More... | |
| void | SetReferenceCount (int) |
| Sets the reference count. More... | |
| void | PrintRevisions (ostream &) |
| Legacy. More... | |
| virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkRenderer * | SafeDownCast (vtkObjectBase *o) |
| static vtkRenderer * | New () |
| Create a vtkRenderer with a black background, a white ambient light, two-sided lighting turned on, a viewport of (0,0,1,1), and backface culling turned off. More... | |
| Static Public Member Functions inherited from vtkViewport | |
| static int | IsTypeOf (const char *type) |
| static vtkViewport * | SafeDownCast (vtkObjectBase *o) |
| Static Public Member Functions inherited from vtkObject | |
| static vtkObject * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
| static void | BreakOnError () |
| This method is called when vtkErrorMacro executes. More... | |
| static void | SetGlobalWarningDisplay (int val) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOn () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOff () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static int | GetGlobalWarningDisplay () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| Static Public Member Functions inherited from vtkObjectBase | |
| static vtkTypeBool | IsTypeOf (const char *name) |
| Return 1 if this class type is the same type of (or a subclass of) the named class. More... | |
| static vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| vtkRenderer () | |
| ~vtkRenderer () | |
| virtual void | PickRender (vtkPropCollection *props) |
| virtual void | PickGeometry () |
| virtual void | ExpandBounds (double bounds[6], vtkMatrix4x4 *matrix) |
| void | AllocateTime () |
| virtual int | UpdateGeometry () |
| Ask all props to update and draw any opaque and translucent geometry. More... | |
| virtual int | UpdateTranslucentPolygonalGeometry () |
| Ask all props to update and draw any translucent polygonal geometry. More... | |
| virtual int | UpdateOpaquePolygonalGeometry () |
| Ask all props to update and draw any opaque polygonal geometry. More... | |
| virtual int | UpdateCamera (void) |
| Ask the active camera to do whatever it needs to do prior to rendering. More... | |
| virtual int | UpdateLightGeometry (void) |
| Update the geometry of the lights in the scene that are not in world space (for instance, Headlights or CameraLights that are attached to the camera). More... | |
| virtual int | UpdateLights (void) |
| Ask all lights to load themselves into rendering pipeline. More... | |
| vtkCamera * | GetActiveCameraAndResetIfCreated () |
| Get the current camera and reset it only if it gets created automatically (see GetActiveCamera). More... | |
| void | SetSelector (vtkHardwareSelector *selector) |
| Called by vtkHardwareSelector when it begins rendering for selection. More... | |
| Protected Member Functions inherited from vtkViewport | |
| vtkViewport () | |
| ~vtkViewport () | |
| virtual void | DevicePickRender ()=0 |
| virtual void | StartPick (unsigned int pickFromSize)=0 |
| virtual void | UpdatePickId ()=0 |
| virtual void | DonePick ()=0 |
| virtual unsigned int | GetPickedId ()=0 |
| virtual unsigned int | GetNumPickedIds ()=0 |
| virtual int | GetPickedIds (unsigned int atMost, unsigned int *callerBuffer)=0 |
| Protected Member Functions inherited from vtkObject | |
| vtkObject () | |
| ~vtkObject () override | |
| void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
| void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
| void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL) |
| These methods allow a command to exclusively grab all events. More... | |
| void | InternalReleaseFocus () |
| These methods allow a command to exclusively grab all events. More... | |
| Protected Member Functions inherited from vtkObjectBase | |
| vtkObjectBase () | |
| virtual | ~vtkObjectBase () |
| virtual void | CollectRevisions (ostream &) |
| virtual void | ReportReferences (vtkGarbageCollector *) |
| vtkObjectBase (const vtkObjectBase &) | |
| void | operator= (const vtkObjectBase &) |
Friends | |
| class | vtkHardwareSelector |
| class | vtkRendererDelegate |
| class | vtkRenderPass |
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.
- Examples:
- vtkRenderer (Examples)
- Tests:
- vtkRenderer (Tests)
Definition at line 63 of file vtkRenderer.h.
Member Typedef Documentation
| typedef vtkViewport vtkRenderer::Superclass |
Definition at line 66 of file vtkRenderer.h.
Constructor & Destructor Documentation
|
protected |
|
protected |
Member Function Documentation
|
static |
|
virtual |
Return 1 if this class is the same type of (or a subclass of) the named class.
Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkViewport.
Reimplemented in vtkExternalOpenGLRenderer, vtkOpenGLRenderer, vtkOpenGLRenderer, vtkOculusRenderer, and vtkOpenVRRenderer.
|
static |
|
protectedvirtual |
Reimplemented from vtkViewport.
Reimplemented in vtkExternalOpenGLRenderer, vtkOpenGLRenderer, vtkOpenGLRenderer, vtkOculusRenderer, and vtkOpenVRRenderer.
| vtkRenderer* vtkRenderer::NewInstance | ( | ) | const |
|
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 vtkObject.
Reimplemented in vtkExternalOpenGLRenderer, vtkOpenGLRenderer, and vtkOpenGLRenderer.
|
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.
| 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.
|
inline |
Return the collection of lights.
Definition at line 958 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 |
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.
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Create a new Camera sutible for use with this type of Renderer.
For example, a vtkMesaRenderer should create a vtkMesaCamera in this function. The default is to just call vtkCamera::New.
Reimplemented in vtkExternalOpenGLRenderer.
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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.
This function is called to capture an instance of vtkProp that requires special handling during vtkRenderWindow::CaptureGL2PSSpecialProps().
| void vtkRenderer::SetGL2PSSpecialPropCollection | ( | vtkPropCollection * | ) |
Set the prop collection object used during vtkRenderWindow::CaptureGL2PSSpecialProps().
Do not call manually, this is handled automatically by the render window.
| void vtkRenderer::AddCuller | ( | vtkCuller * | ) |
Add an culler to the list of cullers.
| void vtkRenderer::RemoveCuller | ( | vtkCuller * | ) |
Remove an actor from the list of cullers.
|
inline |
Return the collection of cullers.
Get the list of cullers for this renderer.
Definition at line 965 of file vtkRenderer.h.
Set the intensity of ambient lighting.
|
virtual |
Set the intensity of ambient lighting.
|
virtual |
Set the intensity of ambient lighting.
|
virtual |
Set the intensity of ambient lighting.
|
virtual |
Set/Get the amount of time this renderer is allowed to spend rendering its scene.
This is used by vtkLODActor's.
|
virtual |
Set/Get the amount of time this renderer is allowed to spend rendering its scene.
This is used by vtkLODActor's.
|
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 |
CALLED BY vtkRenderWindow ONLY.
End-user pass your way and call vtkRenderWindow::Render(). Create an image. This is a superclass method which will in turn call the DeviceRender method of Subclasses of vtkRenderer.
Reimplemented in vtkExternalOpenGLRenderer.
|
pure virtual |
Create an image.
Subclasses of vtkRenderer must implement this method.
Implemented in vtkOpenGLRenderer, and vtkOpenGLRenderer.
|
virtual |
Render opaque polygonal geometry.
Default implementation just calls UpdateOpaquePolygonalGeometry(). Subclasses of vtkRenderer that can deal with, e.g. hidden line removal must override this method.
Reimplemented in vtkOpenGLRenderer, and vtkOpenGLRenderer.
|
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, and vtkOpenGLRenderer.
|
inlinevirtual |
Internal method temporarily removes lights before reloading them into graphics pipeline.
Reimplemented in vtkOpenGLRenderer.
Definition at line 319 of file vtkRenderer.h.
|
inlinevirtual |
Clear the image to the background color.
Reimplemented in vtkOpenGLRenderer, and vtkOpenGLRenderer.
Definition at line 324 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() If Deering frustrum is used then the bounds get expanded by the camera's modelview matrix.
| 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() If Deering frustrum is used then the bounds get expanded by the camera's modelview matrix.
|
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 |
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 |
Specify enlargement of bounds when resetting the camera clipping range.
By default the range is not expanded by any percent of the (far - near) on the near and far sides
|
virtual |
Specify enlargement of bounds when resetting the camera clipping range.
By default the range is not expanded by any percent of the (far - near) on the near and far sides
|
virtual |
Automatically set up the camera based on the visible actors.
The camera will reposition itself to view the center point of the actors, and move along its initial view plane normal (i.e., vector defined from camera position to focal point) so that all of the actors can be seen.
Reimplemented in vtkOculusRenderer, and vtkOpenVRRenderer.
|
virtual |
Automatically set up the camera based on a specified bounding box (xmin,xmax, ymin,ymax, zmin,zmax).
Camera will reposition itself so that its focal point is the center of the bounding box, and adjust its distance and position to preserve its initial view plane normal (i.e., vector defined from camera position to focal point). Note: 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.
Reimplemented in vtkOculusRenderer, and vtkOpenVRRenderer.
|
virtual |
Alternative version of ResetCamera(bounds[6]);.
Reimplemented in vtkOculusRenderer, and vtkOpenVRRenderer.
| 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.
|
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 418 of file vtkRenderer.h.
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Set/Get the layer that this renderer belongs to.
This is only used if there are layered renderers.
Note: Changing the layer will update the PreserveColorBuffer setting. If the layer is 0, PreserveColorBuffer will be set to false, making the bottom renderer opaque. If the layer is non-zero, PreserveColorBuffer will be set to true, giving the renderer a transparent background. If other PreserveColorBuffer configurations are desired, they must be adjusted after the layer is set.
|
virtual |
Set/Get the layer that this renderer belongs to.
This is only used if there are layered renderers.
Note: Changing the layer will update the PreserveColorBuffer setting. If the layer is 0, PreserveColorBuffer will be set to false, making the bottom renderer opaque. If the layer is non-zero, PreserveColorBuffer will be set to true, giving the renderer a transparent background. If other PreserveColorBuffer configurations are desired, they must be adjusted after the layer is set.
|
virtual |
By default, the renderer at layer 0 is opaque, and all non-zero layer renderers are transparent.
This flag allows this behavior to be overridden. If true, this setting will force the renderer to preserve the existing color buffer regardless of layer. If false, it will always be cleared at the start of rendering.
This flag influences the Transparent() method, and is updated by calls to SetLayer(). For this reason it should only be set after changing the layer.
|
virtual |
By default, the renderer at layer 0 is opaque, and all non-zero layer renderers are transparent.
This flag allows this behavior to be overridden. If true, this setting will force the renderer to preserve the existing color buffer regardless of layer. If false, it will always be cleared at the start of rendering.
This flag influences the Transparent() method, and is updated by calls to SetLayer(). For this reason it should only be set after changing the layer.
|
virtual |
By default, the renderer at layer 0 is opaque, and all non-zero layer renderers are transparent.
This flag allows this behavior to be overridden. If true, this setting will force the renderer to preserve the existing color buffer regardless of layer. If false, it will always be cleared at the start of rendering.
This flag influences the Transparent() method, and is updated by calls to SetLayer(). For this reason it should only be set after changing the layer.
|
virtual |
By default, the renderer at layer 0 is opaque, and all non-zero layer renderers are transparent.
This flag allows this behavior to be overridden. If true, this setting will force the renderer to preserve the existing color buffer regardless of layer. If false, it will always be cleared at the start of rendering.
This flag influences the Transparent() method, and is updated by calls to SetLayer(). For this reason it should only be set after changing the layer.
|
virtual |
By default, the depth buffer is reset for each renderer.
If this flag is true, this renderer will use the existing depth buffer for its rendering.
|
virtual |
By default, the depth buffer is reset for each renderer.
If this flag is true, this renderer will use the existing depth buffer for its rendering.
|
virtual |
By default, the depth buffer is reset for each renderer.
If this flag is true, this renderer will use the existing depth buffer for its rendering.
|
virtual |
By default, the depth buffer is reset for each renderer.
If this flag is true, this renderer will use the existing depth buffer for its rendering.
| 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.
|
virtual |
Convert world point coordinates to view coordinates.
Reimplemented from vtkViewport.
|
virtual |
Convert view point coordinates to world coordinates.
Reimplemented from vtkViewport.
Convert view point coordinates to world coordinates.
Reimplemented from vtkViewport.
Convert world point coordinates to view coordinates.
Reimplemented from vtkViewport.
Given a pixel location, return the Z value.
The z value is normalized (0,1) between the front and back clipping planes.
|
virtual |
Return the MTime of the renderer also considering its ivars.
Reimplemented from vtkObject.
|
virtual |
Get the time required, in seconds, for the last Render call.
|
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.
|
inlinevirtual |
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 547 of file vtkRenderer.h.
|
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.
|
inlinevirtual |
Do anything necessary between rendering the left and right viewpoints in a stereo render.
Doesn't do anything except in the derived vtkIceTRenderer in ParaView.
Definition at line 560 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 different that the aspect ratio of the renderer when rendered in it entirity
|
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 575 of file vtkRenderer.h.
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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.
|
virtual |
Set/Get the texture to be used for the background.
If set and enabled this gets the priority over the gradient background.
|
virtual |
Set/Get the texture to be used for the background.
If set and enabled this gets the priority over the gradient background.
|
virtual |
Set/Get whether this viewport should have a textured background.
Default is off.
|
virtual |
Set/Get whether this viewport should have a textured background.
Default is off.
|
virtual |
Set/Get whether this viewport should have a textured background.
Default is off.
|
virtual |
Set/Get whether this viewport should have a textured background.
Default is off.
|
virtual |
Reimplemented in vtkOpenGLRenderer, and vtkOpenGLRenderer.
|
virtual |
Turn on/off FXAA anti-aliasing, if supported.
Initial value is off.
|
virtual |
Turn on/off FXAA anti-aliasing, if supported.
Initial value is off.
|
virtual |
Turn on/off FXAA anti-aliasing, if supported.
Initial value is off.
|
virtual |
Turn on/off FXAA anti-aliasing, if supported.
Initial value is off.
|
virtual |
The configuration object for FXAA antialiasing.
|
virtual |
The configuration object for FXAA antialiasing.
|
virtual |
Turn on/off rendering of shadows if supported Initial value is off.
|
virtual |
Turn on/off rendering of shadows if supported Initial value is off.
|
virtual |
Turn on/off rendering of shadows if supported Initial value is off.
|
virtual |
Turn on/off rendering of shadows if supported Initial value is off.
|
virtual |
If this flag is true and the rendering engine supports it, wireframe geometry will be drawn using hidden line removal.
|
virtual |
If this flag is true and the rendering engine supports it, wireframe geometry will be drawn using hidden line removal.
|
virtual |
If this flag is true and the rendering engine supports it, wireframe geometry will be drawn using hidden line removal.
|
virtual |
If this flag is true and the rendering engine supports it, wireframe geometry will be drawn using hidden line removal.
| void vtkRenderer::SetPass | ( | vtkRenderPass * | p | ) |
|
virtual |
|
virtual |
Set/Get the information object associated with this algorithm.
|
virtual |
Set/Get the information object associated with this algorithm.
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
|
protected |
|
protectedvirtual |
Ask all props to update and draw any opaque and translucent geometry.
This includes both vtkActors and vtkVolumes Returns the number of props that rendered geometry.
Reimplemented in vtkOpenGLRenderer.
|
protectedvirtual |
Ask all props to update and draw any translucent polygonal geometry.
This includes both vtkActors and vtkVolumes Return the number of rendered props. It is called once with alpha blending technique. It is called multiple times with depth peeling technique.
|
protectedvirtual |
Ask all props to update and draw any opaque polygonal geometry.
This includes both vtkActors and vtkVolumes Return the number of rendered props.
|
protectedvirtual |
Ask the active camera to do whatever it needs to do prior to rendering.
Creates a camera if none found active.
|
protectedvirtual |
Update the geometry of the lights in the scene that are not in world space (for instance, Headlights or CameraLights that are attached to the camera).
|
inlineprotectedvirtual |
Ask all lights to load themselves into rendering pipeline.
This method will return the actual number of lights that were on.
Reimplemented in vtkOpenGLRenderer, and vtkOpenGLRenderer.
Definition at line 862 of file vtkRenderer.h.
|
protected |
Get the current camera and reset it only if it gets created automatically (see GetActiveCamera).
This is only used internally.
|
inlineprotected |
Called by vtkHardwareSelector when it begins rendering for selection.
Definition at line 933 of file vtkRenderer.h.
Friends And Related Function Documentation
|
friend |
Definition at line 928 of file vtkRenderer.h.
|
friend |
Definition at line 940 of file vtkRenderer.h.
|
friend |
Definition at line 946 of file vtkRenderer.h.
Member Data Documentation
|
protected |
Definition at line 733 of file vtkRenderer.h.
|
protected |
Definition at line 734 of file vtkRenderer.h.
|
protected |
Definition at line 736 of file vtkRenderer.h.
|
protected |
Definition at line 737 of file vtkRenderer.h.
|
protected |
Definition at line 739 of file vtkRenderer.h.
|
protected |
Definition at line 740 of file vtkRenderer.h.
|
protected |
Definition at line 742 of file vtkRenderer.h.
|
protected |
Definition at line 743 of file vtkRenderer.h.
|
protected |
Definition at line 744 of file vtkRenderer.h.
|
protected |
Definition at line 745 of file vtkRenderer.h.
|
protected |
Definition at line 746 of file vtkRenderer.h.
|
protected |
Definition at line 747 of file vtkRenderer.h.
|
protected |
Definition at line 748 of file vtkRenderer.h.
|
protected |
Definition at line 749 of file vtkRenderer.h.
|
protected |
Definition at line 750 of file vtkRenderer.h.
|
protected |
Definition at line 751 of file vtkRenderer.h.
|
protected |
Definition at line 753 of file vtkRenderer.h.
|
protected |
Definition at line 755 of file vtkRenderer.h.
|
protected |
Definition at line 762 of file vtkRenderer.h.
|
protected |
Definition at line 766 of file vtkRenderer.h.
|
protected |
Definition at line 767 of file vtkRenderer.h.
|
protected |
Definition at line 770 of file vtkRenderer.h.
|
protected |
Definition at line 771 of file vtkRenderer.h.
|
protected |
Definition at line 775 of file vtkRenderer.h.
|
protected |
Definition at line 779 of file vtkRenderer.h.
|
protected |
Definition at line 780 of file vtkRenderer.h.
|
protected |
Definition at line 781 of file vtkRenderer.h.
|
protected |
Definition at line 785 of file vtkRenderer.h.
|
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 794 of file vtkRenderer.h.
|
protected |
Specify enlargement of bounds when resetting the camera clipping range.
Definition at line 800 of file vtkRenderer.h.
|
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 808 of file vtkRenderer.h.
|
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 815 of file vtkRenderer.h.
|
protected |
Temporary collection used by vtkRenderWindow::CaptureGL2PSSpecialProps.
Definition at line 820 of file vtkRenderer.h.
|
protected |
If this flag is on and the rendering engine supports it, FXAA will be used to antialias the scene.
Default is off.
Definition at line 875 of file vtkRenderer.h.
|
protected |
Holds the FXAA configuration.
Definition at line 880 of file vtkRenderer.h.
|
protected |
If this flag is on and the rendering engine supports it render shadows Initial value is off.
Definition at line 886 of file vtkRenderer.h.
|
protected |
When this flag is on and the rendering engine supports it, wireframe polydata will be rendered using hidden line removal.
Definition at line 892 of file vtkRenderer.h.
|
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 900 of file vtkRenderer.h.
|
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 911 of file vtkRenderer.h.
|
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 918 of file vtkRenderer.h.
|
protected |
Tells if the last call to DeviceRenderTranslucentPolygonalGeometry() actually used depth peeling.
Initial value is false.
Definition at line 925 of file vtkRenderer.h.
|
protected |
Definition at line 937 of file vtkRenderer.h.
|
protected |
Definition at line 941 of file vtkRenderer.h.
|
protected |
Definition at line 943 of file vtkRenderer.h.
|
protected |
Definition at line 944 of file vtkRenderer.h.
|
protected |
Definition at line 947 of file vtkRenderer.h.
|
protected |
Definition at line 950 of file vtkRenderer.h.
The documentation for this class was generated from the following file:
- /home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Rendering/Core/vtkRenderer.h
