Perform part of the rendering of a vtkRenderer. More...

#include <vtkRenderPass.h>

Inheritance diagram for vtkRenderPass:

Collaboration diagram for vtkRenderPass:

Public Types
typedef vtkObject	Superclass

typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkRenderPass *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	ReleaseGraphicsResources (vtkWindow *w)

virtual int	IsA (const char *type)

vtkRenderPass *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	Render (const vtkRenderState *s)=0

virtual void	ReleaseGraphicsResources (vtkWindow *w)


virtual void	Render (const vtkRenderState *s)=0


virtual int	GetNumberOfRenderedProps ()


virtual int	GetNumberOfRenderedProps ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkRenderPass *	SafeDownCast (vtkObjectBase *o)

static int	IsTypeOf (const char *type)

static vtkRenderPass *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkRenderPass ()

virtual	~vtkRenderPass ()

void	UpdateCamera (vtkRenderer *renderer)

void	ClearLights (vtkRenderer *renderer)

void	UpdateLightGeometry (vtkRenderer *renderer)

void	UpdateLights (vtkRenderer *renderer)

void	UpdateGeometry (vtkRenderer *renderer)

virtual vtkObjectBase *	NewInstanceInternal () const

	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)


void	SetLastRenderingUsedDepthPeeling (vtkRenderer *renderer, bool value)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	NumberOfRenderedProps

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

Tests:
vtkRenderPass (Tests)

Definition at line 54 of file vtkRenderPass.h.

Member Typedef Documentation

typedef vtkObject vtkRenderPass::Superclass

Definition at line 57 of file vtkRenderPass.h.

typedef vtkObject vtkRenderPass::Superclass

Definition at line 60 of file vtkRenderPass.h.

Constructor & Destructor Documentation

vtkRenderPass::vtkRenderPass ( )

protected

Default constructor. Do nothing.

virtual vtkRenderPass::~vtkRenderPass ( )

protectedvirtual

Destructor. Do nothing.

vtkRenderPass::vtkRenderPass ( )

protected

Default constructor. Do nothing.

virtual vtkRenderPass::~vtkRenderPass ( )

protectedvirtual

Destructor. Do nothing.

Member Function Documentation

static int vtkRenderPass::IsTypeOf ( const char * type )

static

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 vtkSobelGradientMagnitudePass, vtkSobelGradientMagnitudePass, vtkShadowMapPass, vtkGaussianBlurPass, vtkGaussianBlurPass, vtkShadowMapBakerPass, vtkDepthPeelingPass, vtkCompositeZPass, vtkDepthPeelingPass, vtkCompositeRGBAPass, vtkDefaultPass, vtkRenderStepsPass, vtkDefaultPass, vtkCameraPass, vtkSequencePass, vtkLightsPass, vtkOpaquePass, vtkOverlayPass, vtkTranslucentPass, vtkVolumetricPass, vtkImageProcessingPass, vtkCameraPass, vtkSequencePass, vtkLightsPass, vtkOpaquePass, vtkOverlayPass, vtkTranslucentPass, vtkValuePasses, vtkVolumetricPass, vtkImageProcessingPass, vtkClearZPass, vtkClientServerCompositePass, vtkClearRGBPass, vtkClearZPass, vtkClearRGBPass, and vtkValuePass.

static vtkRenderPass* vtkRenderPass::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkRenderPass::NewInstanceInternal ( ) const

protectedvirtual

vtkRenderPass* vtkRenderPass::NewInstance ( ) const

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 vtkSobelGradientMagnitudePass, vtkSobelGradientMagnitudePass, vtkShadowMapPass, vtkGaussianBlurPass, vtkShadowMapBakerPass, vtkDepthPeelingPass, vtkCompositeZPass, vtkCompositeRGBAPass, vtkDefaultPass, vtkRenderStepsPass, vtkCameraPass, vtkSequencePass, vtkLightsPass, vtkOpaquePass, vtkOverlayPass, vtkTranslucentPass, vtkVolumetricPass, vtkSequencePass, vtkTranslucentPass, vtkValuePasses, vtkVolumetricPass, vtkImageProcessingPass, vtkClearZPass, vtkClientServerCompositePass, vtkClearRGBPass, and vtkValuePass.

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 vtkSobelGradientMagnitudePass, vtkSobelGradientMagnitudePass, vtkShadowMapBakerPass, vtkShadowMapPass, vtkGaussianBlurPass, vtkGaussianBlurPass, vtkDepthPeelingPass, vtkDepthPeelingPass, vtkCompositeZPass, vtkDefaultPass, vtkRenderStepsPass, vtkCompositeRGBAPass, vtkDefaultPass, vtkCameraPass, vtkSequencePass, vtkLightsPass, vtkOpaquePass, vtkOverlayPass, vtkTranslucentPass, vtkVolumetricPass, vtkCameraPass, vtkSequencePass, vtkLightsPass, vtkOpaquePass, vtkOverlayPass, vtkTranslucentPass, vtkVolumetricPass, vtkValuePass, vtkClearZPass, vtkValuePasses, vtkClientServerCompositePass, vtkClearZPass, vtkClearRGBPass, and vtkClearRGBPass.

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 vtkSobelGradientMagnitudePass, vtkSobelGradientMagnitudePass, vtkShadowMapBakerPass, vtkShadowMapPass, vtkGaussianBlurPass, vtkGaussianBlurPass, vtkDepthPeelingPass, vtkDepthPeelingPass, vtkCompositeZPass, vtkRenderStepsPass, vtkCompositeRGBAPass, vtkCameraPass, vtkSequencePass, vtkCameraPass, vtkSequencePass, vtkClientServerCompositePass, vtkImageProcessingPass, and vtkImageProcessingPass.

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

static int vtkRenderPass::IsTypeOf ( const char * type )

static

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 vtkSobelGradientMagnitudePass, vtkSobelGradientMagnitudePass, vtkShadowMapPass, vtkGaussianBlurPass, vtkGaussianBlurPass, vtkShadowMapBakerPass, vtkDepthPeelingPass, vtkCompositeZPass, vtkDepthPeelingPass, vtkCompositeRGBAPass, vtkDefaultPass, vtkRenderStepsPass, vtkDefaultPass, vtkCameraPass, vtkSequencePass, vtkLightsPass, vtkOpaquePass, vtkOverlayPass, vtkTranslucentPass, vtkVolumetricPass, vtkImageProcessingPass, vtkCameraPass, vtkSequencePass, vtkLightsPass, vtkOpaquePass, vtkOverlayPass, vtkTranslucentPass, vtkValuePasses, vtkVolumetricPass, vtkImageProcessingPass, vtkClearZPass, vtkClientServerCompositePass, vtkClearRGBPass, vtkClearZPass, vtkClearRGBPass, and vtkValuePass.

static vtkRenderPass* vtkRenderPass::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkRenderPass::NewInstanceInternal ( ) const

protectedvirtual

vtkRenderPass* vtkRenderPass::NewInstance ( ) const

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 vtkSobelGradientMagnitudePass, vtkCompositeZPass, vtkCompositeRGBAPass, vtkRenderStepsPass, vtkSequencePass, vtkTranslucentPass, vtkVolumetricPass, and vtkClientServerCompositePass.

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 vtkSobelGradientMagnitudePass, vtkSobelGradientMagnitudePass, vtkShadowMapBakerPass, vtkShadowMapPass, vtkGaussianBlurPass, vtkGaussianBlurPass, vtkDepthPeelingPass, vtkDepthPeelingPass, vtkCompositeZPass, vtkDefaultPass, vtkRenderStepsPass, vtkCompositeRGBAPass, vtkDefaultPass, vtkCameraPass, vtkSequencePass, vtkLightsPass, vtkOpaquePass, vtkOverlayPass, vtkTranslucentPass, vtkVolumetricPass, vtkCameraPass, vtkSequencePass, vtkLightsPass, vtkOpaquePass, vtkOverlayPass, vtkTranslucentPass, vtkVolumetricPass, vtkValuePass, vtkClearZPass, vtkValuePasses, vtkClientServerCompositePass, vtkClearZPass, vtkClearRGBPass, and vtkClearRGBPass.

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 vtkSobelGradientMagnitudePass, vtkSobelGradientMagnitudePass, vtkShadowMapBakerPass, vtkShadowMapPass, vtkGaussianBlurPass, vtkGaussianBlurPass, vtkDepthPeelingPass, vtkDepthPeelingPass, vtkCompositeZPass, vtkRenderStepsPass, vtkCompositeRGBAPass, vtkCameraPass, vtkSequencePass, vtkCameraPass, vtkSequencePass, vtkClientServerCompositePass, vtkImageProcessingPass, and vtkImageProcessingPass.

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 112 of file vtkRenderPass.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/OpenGL/vtkRenderPass.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation