vtkRenderPass Class Reference
#include <vtkRenderPass.h>
Detailed Description
Perform part of the rendering of a vtkRenderer.vtkRenderPass is a deferred class with a simple deferred method Render. This method performs a rendering pass of the scene described in vtkRenderState. Subclasses define what really happens during rendering.
Directions to write a subclass of vtkRenderPass: It is up to the subclass to decide if it needs to delegate part of its job to some other vtkRenderPass objects ("delegates").
- The subclass has to define ivar to set/get its delegates.
- The documentation of the subclass has to describe:
- what each delegate is supposed to perform
- if a delegate is supposed to be used once or multiple times
- what it expects to have in the framebuffer before starting (status of colorbuffers, depth buffer, stencil buffer)
- what it will change in the framebuffer.
- A pass cannot modify the vtkRenderState where it will perform but it can build a new vtkRenderState (it can change the FrameBuffer, change the prop array, changed the required prop properties keys (usually adding some to a copy of the existing list) but it has to keep the same vtkRenderer object), make it current and pass it to its delegate.
- at the end of the execution of Render, the pass has to ensure the current vtkRenderState is the one it has in argument.
- See also:
- vtkRenderState vtkRenderer
Definition at line 53 of file vtkRenderPass.h.
Public Types | |
| typedef vtkObject | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual void | ReleaseGraphicsResources (vtkWindow *w) |
| virtual void | Render (const vtkRenderState *s)=0 |
| virtual int | GetNumberOfRenderedProps () |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkRenderPass * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkRenderPass () | |
| virtual | ~vtkRenderPass () |
| void | UpdateCamera (vtkRenderer *renderer) |
| void | ClearLights (vtkRenderer *renderer) |
| void | UpdateLightGeometry (vtkRenderer *renderer) |
| void | UpdateLights (vtkRenderer *renderer) |
| void | UpdateGeometry (vtkRenderer *renderer) |
| void | SetLastRenderingUsedDepthPeeling (vtkRenderer *renderer, bool value) |
Protected Attributes | |
| int | NumberOfRenderedProps |
Member Typedef Documentation
| typedef vtkObject vtkRenderPass::Superclass |
Reimplemented from vtkObject.
Reimplemented in vtkClientServerCompositePass, vtkCompositeRGBAPass, vtkCompositeZPass, vtkCameraPass, vtkClearZPass, vtkDefaultPass, vtkDepthPeelingPass, vtkGaussianBlurPass, vtkImageProcessingPass, vtkLightsPass, vtkOpaquePass, vtkOverlayPass, vtkSequencePass, vtkShadowMapBakerPass, vtkShadowMapPass, vtkSobelGradientMagnitudePass, vtkTranslucentPass, and vtkVolumetricPass.
Definition at line 56 of file vtkRenderPass.h.
Constructor & Destructor Documentation
| vtkRenderPass::vtkRenderPass | ( | ) | [protected] |
Default constructor. Do nothing.
| virtual vtkRenderPass::~vtkRenderPass | ( | ) | [protected, virtual] |
Destructor. Do nothing.
Member Function Documentation
| virtual const char* vtkRenderPass::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkObject.
Reimplemented in vtkClientServerCompositePass, vtkCompositeRGBAPass, vtkCompositeZPass, vtkCameraPass, vtkClearZPass, vtkDefaultPass, vtkDepthPeelingPass, vtkGaussianBlurPass, vtkImageProcessingPass, vtkLightsPass, vtkOpaquePass, vtkOverlayPass, vtkSequencePass, vtkShadowMapBakerPass, vtkShadowMapPass, vtkSobelGradientMagnitudePass, vtkTranslucentPass, and vtkVolumetricPass.
| static int vtkRenderPass::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
Reimplemented in vtkClientServerCompositePass, vtkCompositeRGBAPass, vtkCompositeZPass, vtkCameraPass, vtkClearZPass, vtkDefaultPass, vtkDepthPeelingPass, vtkGaussianBlurPass, vtkImageProcessingPass, vtkLightsPass, vtkOpaquePass, vtkOverlayPass, vtkSequencePass, vtkShadowMapBakerPass, vtkShadowMapPass, vtkSobelGradientMagnitudePass, vtkTranslucentPass, and vtkVolumetricPass.
| virtual int vtkRenderPass::IsA | ( | const char * | name | ) | [virtual] |
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
Reimplemented in vtkClientServerCompositePass, vtkCompositeRGBAPass, vtkCompositeZPass, vtkCameraPass, vtkClearZPass, vtkDefaultPass, vtkDepthPeelingPass, vtkGaussianBlurPass, vtkImageProcessingPass, vtkLightsPass, vtkOpaquePass, vtkOverlayPass, vtkSequencePass, vtkShadowMapBakerPass, vtkShadowMapPass, vtkSobelGradientMagnitudePass, vtkTranslucentPass, and vtkVolumetricPass.
| static vtkRenderPass* vtkRenderPass::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkObject.
Reimplemented in vtkClientServerCompositePass, vtkCompositeRGBAPass, vtkCompositeZPass, vtkCameraPass, vtkClearZPass, vtkDefaultPass, vtkDepthPeelingPass, vtkGaussianBlurPass, vtkImageProcessingPass, vtkLightsPass, vtkOpaquePass, vtkOverlayPass, vtkSequencePass, vtkShadowMapBakerPass, vtkShadowMapPass, vtkSobelGradientMagnitudePass, vtkTranslucentPass, and vtkVolumetricPass.
| void vtkRenderPass::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 vtkObject.
Reimplemented in vtkClientServerCompositePass, vtkCompositeRGBAPass, vtkCompositeZPass, vtkCameraPass, vtkClearZPass, vtkDefaultPass, vtkDepthPeelingPass, vtkGaussianBlurPass, vtkImageProcessingPass, vtkLightsPass, vtkOpaquePass, vtkOverlayPass, vtkSequencePass, vtkShadowMapBakerPass, vtkShadowMapPass, vtkSobelGradientMagnitudePass, vtkTranslucentPass, and vtkVolumetricPass.
| virtual void vtkRenderPass::Render | ( | const vtkRenderState * | s | ) | [pure virtual] |
Perform rendering according to a render state s. It modifies NumberOfRenderedProps.
- Precondition:
- s_exists: s!=0
Implemented in vtkClientServerCompositePass, vtkCompositeRGBAPass, vtkCompositeZPass, vtkCameraPass, vtkClearZPass, vtkDefaultPass, vtkDepthPeelingPass, vtkGaussianBlurPass, vtkLightsPass, vtkOpaquePass, vtkOverlayPass, vtkSequencePass, vtkShadowMapBakerPass, vtkShadowMapPass, vtkSobelGradientMagnitudePass, vtkTranslucentPass, and vtkVolumetricPass.
| virtual int vtkRenderPass::GetNumberOfRenderedProps | ( | ) | [virtual] |
Number of props rendered at the last Render call.
| virtual void vtkRenderPass::ReleaseGraphicsResources | ( | vtkWindow * | w | ) | [virtual] |
Release graphics resources and ask components to release their own resources. Default implementation is empty.
- Precondition:
- w_exists: w!=0
Reimplemented in vtkClientServerCompositePass, vtkCompositeRGBAPass, vtkCompositeZPass, vtkCameraPass, vtkDepthPeelingPass, vtkGaussianBlurPass, vtkImageProcessingPass, vtkSequencePass, vtkShadowMapBakerPass, vtkShadowMapPass, and vtkSobelGradientMagnitudePass.
| void vtkRenderPass::UpdateCamera | ( | vtkRenderer * | renderer | ) | [protected] |
Call UpdateCamera() on Renderer. This ugly mechanism gives access to a protected method of Renderer to subclasses of vtkRenderPass.
- Precondition:
- renderer_exists: renderer!=0
| void vtkRenderPass::ClearLights | ( | vtkRenderer * | renderer | ) | [protected] |
Call ClearLights() on Renderer. See note about UpdateCamera().
- Precondition:
- renderer_exists: renderer!=0
| void vtkRenderPass::UpdateLightGeometry | ( | vtkRenderer * | renderer | ) | [protected] |
Call UpdateLightGeometry() on Renderer. See note about UpdateCamera().
- Precondition:
- renderer_exists: renderer!=0
| void vtkRenderPass::UpdateLights | ( | vtkRenderer * | renderer | ) | [protected] |
Call UpdateLights() on Renderer. See note about UpdateCamera().
- Precondition:
- renderer_exists: renderer!=0
| void vtkRenderPass::UpdateGeometry | ( | vtkRenderer * | renderer | ) | [protected] |
Call UpdateGeometry() on Renderer. See note about UpdateCamera().
- Precondition:
- renderer_exists: renderer!=0
| void vtkRenderPass::SetLastRenderingUsedDepthPeeling | ( | vtkRenderer * | renderer, | |
| bool | value | |||
| ) | [protected] |
Modify protected member LastRenderingUsedDepthPeeling on Renderer. See note about UpdateCamera().
- Precondition:
- renderer_exists: renderer!=0
Member Data Documentation
int vtkRenderPass::NumberOfRenderedProps [protected] |
Definition at line 111 of file vtkRenderPass.h.
The documentation for this class was generated from the following file:
- dox/Rendering/vtkRenderPass.h
