vtkRenderStepsPass Class Reference

Execute render passes sequentially. More...

#include <vtkRenderStepsPass.h>

Inheritance diagram for vtkRenderStepsPass:

Collaboration diagram for vtkRenderStepsPass:

Public Types
typedef vtkRenderPass	Superclass
Public Types inherited from vtkRenderPass
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...
vtkRenderStepsPass *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...
virtual void	Render (const vtkRenderState *s)
	Perform rendering according to a render state s. More...
virtual void	ReleaseGraphicsResources (vtkWindow *w)
	Release graphics resources and ask components to release their own resources. More...
virtual vtkCameraPass *	GetCameraPass ()
	Get the RenderPass used for the Camera Step. More...
void	SetCameraPass (vtkCameraPass *)
	Get the RenderPass used for the Camera Step. More...
virtual vtkRenderPass *	GetLightsPass ()
	Get the RenderPass used for the Lights Step. More...
void	SetLightsPass (vtkRenderPass *)
	Get the RenderPass used for the Lights Step. More...
virtual vtkRenderPass *	GetOpaquePass ()
	Get the RenderPass used for the Opaque Step. More...
void	SetOpaquePass (vtkRenderPass *)
	Get the RenderPass used for the Opaque Step. More...
virtual vtkRenderPass *	GetTranslucentPass ()
	Get the RenderPass used for the translucent Step. More...
void	SetTranslucentPass (vtkRenderPass *)
	Get the RenderPass used for the translucent Step. More...
virtual vtkRenderPass *	GetVolumetricPass ()
	Get the RenderPass used for the Volume Step. More...
void	SetVolumetricPass (vtkRenderPass *)
	Get the RenderPass used for the Volume Step. More...
virtual vtkRenderPass *	GetOverlayPass ()
	Get the RenderPass used for the Overlay Step. More...
void	SetOverlayPass (vtkRenderPass *)
	Get the RenderPass used for the Overlay Step. More...
virtual vtkRenderPass *	GetPostProcessPass ()
	Get the RenderPass used for the PostProcess Step. More...
void	SetPostProcessPass (vtkRenderPass *)
	Get the RenderPass used for the PostProcess Step. More...
Public Member Functions inherited from vtkRenderPass
vtkRenderPass *	NewInstance () const
virtual int	GetNumberOfRenderedProps ()
	Number of props rendered at the last Render call. 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...
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. 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 vtkRenderStepsPass *	New ()
static int	IsTypeOf (const char *type)
static vtkRenderStepsPass *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkRenderPass
static int	IsTypeOf (const char *type)
static vtkRenderPass *	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
	vtkRenderStepsPass ()
virtual	~vtkRenderStepsPass ()
Protected Member Functions inherited from vtkRenderPass
	vtkRenderPass ()
	Default constructor. More...
virtual	~vtkRenderPass ()
	Destructor. More...
void	UpdateCamera (vtkRenderer *renderer)
	Call UpdateCamera() on Renderer. More...
void	ClearLights (vtkRenderer *renderer)
	Call ClearLights() on Renderer. More...
void	UpdateLightGeometry (vtkRenderer *renderer)
	Call UpdateLightGeometry() on Renderer. More...
void	UpdateLights (vtkRenderer *renderer)
	Call UpdateLights() on Renderer. More...
void	UpdateGeometry (vtkRenderer *renderer)
	Call UpdateGeometry() on Renderer. More...
void	SetLastRenderingUsedDepthPeeling (vtkRenderer *renderer, bool value)
	Modify protected member LastRenderingUsedDepthPeeling on Renderer. More...
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 &)

Protected Attributes
vtkCameraPass *	CameraPass
vtkRenderPass *	LightsPass
vtkRenderPass *	OpaquePass
vtkRenderPass *	TranslucentPass
vtkRenderPass *	VolumetricPass
vtkRenderPass *	OverlayPass
vtkRenderPass *	PostProcessPass
vtkSequencePass *	SequencePass
Protected Attributes inherited from vtkRenderPass
int	NumberOfRenderedProps
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

Execute render passes sequentially.

vtkRenderStepsPass executes a standard list of render passes sequentially. This class allows to define a sequence of render passes at run time. You can set a step to NULL in order to skip that step. Likewise you can replace any of the default steps with your own step. Typically in such a case you would get the current step, replace it with your own and likely have your step call the current step as a delegate. For example to replace the translucent step with a depthpeeling step you would get the current tranlucent step and set it as a delegate on the depthpeeling step. Then set this classes translparent step to the depthpeelnig step.

See also

vtkRenderPass

Tests:

vtkRenderStepsPass (Tests)

Definition at line 45 of file vtkRenderStepsPass.h.

Member Typedef Documentation

typedef vtkRenderPass vtkRenderStepsPass::Superclass

Definition at line 49 of file vtkRenderStepsPass.h.

Constructor & Destructor Documentation

vtkRenderStepsPass::vtkRenderStepsPass ( )

protected

virtual vtkRenderStepsPass::~vtkRenderStepsPass ( )

protectedvirtual

Member Function Documentation

static vtkRenderStepsPass* vtkRenderStepsPass::New ( )

static

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

static

virtual int vtkRenderStepsPass::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 vtkRenderPass.

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

static

virtual vtkObjectBase* vtkRenderStepsPass::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkRenderPass.

vtkRenderStepsPass* vtkRenderStepsPass::NewInstance

(

)

const

void vtkRenderStepsPass::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 vtkRenderPass.

virtual void vtkRenderStepsPass::Render ( const vtkRenderState *  s )

virtual

Perform rendering according to a render state s.

Precondition

s_exists: s!=0

Implements vtkRenderPass.

virtual void vtkRenderStepsPass::ReleaseGraphicsResources ( vtkWindow *  w )

virtual

Release graphics resources and ask components to release their own resources.

Precondition

w_exists: w!=0

Reimplemented from vtkRenderPass.

virtual vtkCameraPass* vtkRenderStepsPass::GetCameraPass ( )

virtual

Get the RenderPass used for the Camera Step.

void vtkRenderStepsPass::SetCameraPass

(

vtkCameraPass *

)

Get the RenderPass used for the Camera Step.

virtual vtkRenderPass* vtkRenderStepsPass::GetLightsPass ( )

virtual

Get the RenderPass used for the Lights Step.

void vtkRenderStepsPass::SetLightsPass

(

vtkRenderPass *

)

Get the RenderPass used for the Lights Step.

virtual vtkRenderPass* vtkRenderStepsPass::GetOpaquePass ( )

virtual

Get the RenderPass used for the Opaque Step.

void vtkRenderStepsPass::SetOpaquePass

(

vtkRenderPass *

)

Get the RenderPass used for the Opaque Step.

virtual vtkRenderPass* vtkRenderStepsPass::GetTranslucentPass ( )

virtual

Get the RenderPass used for the translucent Step.

void vtkRenderStepsPass::SetTranslucentPass

(

vtkRenderPass *

)

Get the RenderPass used for the translucent Step.

virtual vtkRenderPass* vtkRenderStepsPass::GetVolumetricPass ( )

virtual

Get the RenderPass used for the Volume Step.

void vtkRenderStepsPass::SetVolumetricPass

(

vtkRenderPass *

)

Get the RenderPass used for the Volume Step.

virtual vtkRenderPass* vtkRenderStepsPass::GetOverlayPass ( )

virtual

Get the RenderPass used for the Overlay Step.

void vtkRenderStepsPass::SetOverlayPass

(

vtkRenderPass *

)

Get the RenderPass used for the Overlay Step.

virtual vtkRenderPass* vtkRenderStepsPass::GetPostProcessPass ( )

virtual

Get the RenderPass used for the PostProcess Step.

void vtkRenderStepsPass::SetPostProcessPass

(

vtkRenderPass *

)

Get the RenderPass used for the PostProcess Step.

Member Data Documentation

vtkCameraPass* vtkRenderStepsPass::CameraPass

protected

Definition at line 125 of file vtkRenderStepsPass.h.

vtkRenderPass* vtkRenderStepsPass::LightsPass

protected

Definition at line 126 of file vtkRenderStepsPass.h.

vtkRenderPass* vtkRenderStepsPass::OpaquePass

protected

Definition at line 127 of file vtkRenderStepsPass.h.

vtkRenderPass* vtkRenderStepsPass::TranslucentPass

protected

Definition at line 128 of file vtkRenderStepsPass.h.

vtkRenderPass* vtkRenderStepsPass::VolumetricPass

protected

Definition at line 129 of file vtkRenderStepsPass.h.

vtkRenderPass* vtkRenderStepsPass::OverlayPass

protected

Definition at line 130 of file vtkRenderStepsPass.h.

vtkRenderPass* vtkRenderStepsPass::PostProcessPass

protected

Definition at line 131 of file vtkRenderStepsPass.h.

vtkSequencePass* vtkRenderStepsPass::SequencePass

protected

Definition at line 132 of file vtkRenderStepsPass.h.

---

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

• /home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Rendering/OpenGL2/vtkRenderStepsPass.h