vtkRenderPass Class Reference

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

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkRenderPass *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	Render (const vtkRenderState *s)=0
	Perform rendering according to a render state s.
virtual void	ReleaseGraphicsResources (vtkWindow *w)
	Release graphics resources and ask components to release their own resources.
virtual int	GetNumberOfRenderedProps ()
	Number of props rendered at the last Render call.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	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.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkTypeBool	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.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkRenderPass ()
	Default constructor.
	~vtkRenderPass () override
	Destructor.
void	UpdateCamera (vtkRenderer *renderer)
	Call UpdateCamera() on Renderer.
void	ClearLights (vtkRenderer *renderer)
	Call ClearLights() on Renderer.
void	UpdateLightGeometry (vtkRenderer *renderer)
	Call UpdateLightGeometry() on Renderer.
void	UpdateLights (vtkRenderer *renderer)
	Call UpdateLights() on Renderer.
void	UpdateGeometry (vtkRenderer *renderer, vtkFrameBufferObjectBase *fbo=nullptr)
	Call UpdateGeometry() on Renderer.
void	SetLastRenderingUsedDepthPeeling (vtkRenderer *renderer, bool value)
	Modify protected member LastRenderingUsedDepthPeeling on Renderer.
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=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
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
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

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

Member Typedef Documentation

Superclass

typedef vtkObject vtkRenderPass::Superclass

Definition at line 59 of file vtkRenderPass.h.

Constructor & Destructor Documentation

vtkRenderPass()

vtkRenderPass::vtkRenderPass ( )

protected

Default constructor.

Do nothing.

~vtkRenderPass()

vtkRenderPass::~vtkRenderPass ( )

overrideprotected

Destructor.

Do nothing.

Member Function Documentation

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool 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 vtkObjectBase.

Reimplemented in vtkCameraPass, vtkClearRGBPass, vtkClearZPass, vtkDefaultPass, vtkDepthImageProcessingPass, vtkDepthOfFieldPass, vtkDepthPeelingPass, vtkDualDepthPeelingPass, vtkEDLShading, vtkFramebufferPass, vtkGaussianBlurPass, vtkHiddenLineRemovalPass, vtkImageProcessingPass, vtkLightingMapPass, vtkLightsPass, vtkOpaquePass, vtkOpenGLFXAAPass, vtkOpenGLRenderPass, vtkOrderIndependentTranslucentPass, vtkOutlineGlowPass, vtkOverlayPass, vtkPanoramicProjectionPass, vtkPointFillPass, vtkRenderStepsPass, vtkSequencePass, vtkShadowMapBakerPass, vtkShadowMapPass, vtkSimpleMotionBlurPass, vtkSobelGradientMagnitudePass, vtkSSAAPass, vtkSSAOPass, vtkToneMappingPass, vtkTranslucentPass, vtkValuePass, vtkVolumetricPass, vtkClientServerCompositePass, vtkCompositeRGBAPass, vtkCompositeZPass, and vtkOSPRayPass.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkRenderPass::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkCameraPass, vtkClearRGBPass, vtkClearZPass, vtkDefaultPass, vtkDepthImageProcessingPass, vtkDepthOfFieldPass, vtkDepthPeelingPass, vtkDualDepthPeelingPass, vtkEDLShading, vtkFramebufferPass, vtkGaussianBlurPass, vtkHiddenLineRemovalPass, vtkImageProcessingPass, vtkLightingMapPass, vtkLightsPass, vtkOpaquePass, vtkOpenGLFXAAPass, vtkOpenGLRenderPass, vtkOrderIndependentTranslucentPass, vtkOutlineGlowPass, vtkOverlayPass, vtkPanoramicProjectionPass, vtkPointFillPass, vtkRenderStepsPass, vtkSequencePass, vtkShadowMapBakerPass, vtkShadowMapPass, vtkSimpleMotionBlurPass, vtkSobelGradientMagnitudePass, vtkSSAAPass, vtkSSAOPass, vtkToneMappingPass, vtkTranslucentPass, vtkValuePass, vtkVolumetricPass, vtkClientServerCompositePass, vtkCompositeRGBAPass, vtkCompositeZPass, and vtkOSPRayPass.

NewInstance()

vtkRenderPass * vtkRenderPass::NewInstance

(

)

const

PrintSelf()

void vtkRenderPass::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

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 vtkCameraPass, vtkClearRGBPass, vtkClearZPass, vtkDefaultPass, vtkDepthImageProcessingPass, vtkDepthOfFieldPass, vtkDepthPeelingPass, vtkDualDepthPeelingPass, vtkEDLShading, vtkFramebufferPass, vtkGaussianBlurPass, vtkHiddenLineRemovalPass, vtkImageProcessingPass, vtkLightingMapPass, vtkLightsPass, vtkOpaquePass, vtkOpenGLFXAAPass, vtkOpenGLRenderPass, vtkOrderIndependentTranslucentPass, vtkOutlineGlowPass, vtkOverlayPass, vtkPanoramicProjectionPass, vtkPointFillPass, vtkRenderStepsPass, vtkSequencePass, vtkShadowMapBakerPass, vtkShadowMapPass, vtkSimpleMotionBlurPass, vtkSobelGradientMagnitudePass, vtkSSAAPass, vtkSSAOPass, vtkToneMappingPass, vtkTranslucentPass, vtkValuePass, vtkVolumetricPass, vtkClientServerCompositePass, vtkCompositeRGBAPass, vtkCompositeZPass, and vtkOSPRayPass.

Render()

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 vtkCameraPass, vtkClearRGBPass, vtkClearZPass, vtkDefaultPass, vtkDepthOfFieldPass, vtkDepthPeelingPass, vtkDualDepthPeelingPass, vtkEDLShading, vtkFramebufferPass, vtkGaussianBlurPass, vtkHiddenLineRemovalPass, vtkLightingMapPass, vtkLightsPass, vtkOpaquePass, vtkOpenGLFXAAPass, vtkOrderIndependentTranslucentPass, vtkOutlineGlowPass, vtkOverlayPass, vtkPanoramicProjectionPass, vtkPointFillPass, vtkRenderStepsPass, vtkSequencePass, vtkShadowMapBakerPass, vtkShadowMapPass, vtkSimpleMotionBlurPass, vtkSobelGradientMagnitudePass, vtkSSAAPass, vtkSSAOPass, vtkToneMappingPass, vtkTranslucentPass, vtkValuePass, vtkVolumetricPass, vtkClientServerCompositePass, vtkCompositeRGBAPass, vtkCompositeZPass, and vtkOSPRayPass.

GetNumberOfRenderedProps()

virtual int vtkRenderPass::GetNumberOfRenderedProps ( )

virtual

Number of props rendered at the last Render call.

ReleaseGraphicsResources()

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 vtkCameraPass, vtkDepthOfFieldPass, vtkDepthPeelingPass, vtkDualDepthPeelingPass, vtkEDLShading, vtkFramebufferPass, vtkGaussianBlurPass, vtkImageProcessingPass, vtkOrderIndependentTranslucentPass, vtkOutlineGlowPass, vtkPanoramicProjectionPass, vtkPointFillPass, vtkRenderStepsPass, vtkSequencePass, vtkShadowMapBakerPass, vtkShadowMapPass, vtkSimpleMotionBlurPass, vtkSobelGradientMagnitudePass, vtkSSAAPass, vtkSSAOPass, vtkToneMappingPass, vtkClientServerCompositePass, vtkCompositeRGBAPass, vtkCompositeZPass, and vtkValuePass.

UpdateCamera()

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

ClearLights()

void vtkRenderPass::ClearLights ( vtkRenderer *  renderer )

protected

Call ClearLights() on Renderer.

See note about UpdateCamera().

Precondition

renderer_exists: renderer!=0

UpdateLightGeometry()

void vtkRenderPass::UpdateLightGeometry ( vtkRenderer *  renderer )

protected

Call UpdateLightGeometry() on Renderer.

See note about UpdateCamera().

Precondition

renderer_exists: renderer!=0

UpdateLights()

void vtkRenderPass::UpdateLights ( vtkRenderer *  renderer )

protected

Call UpdateLights() on Renderer.

See note about UpdateCamera().

Precondition

renderer_exists: renderer!=0

UpdateGeometry()

void vtkRenderPass::UpdateGeometry ( vtkRenderer *  renderer, vtkFrameBufferObjectBase *  fbo = nullptr  )

protected

Call UpdateGeometry() on Renderer.

See note about UpdateCamera().

Precondition

renderer_exists: renderer!=0

SetLastRenderingUsedDepthPeeling()

void vtkRenderPass::SetLastRenderingUsedDepthPeeling ( vtkRenderer *  renderer, bool  value  )

protected

Modify protected member LastRenderingUsedDepthPeeling on Renderer.

See note about UpdateCamera().

Precondition

renderer_exists: renderer!=0 Note - OpenGL1 specific, remove when completely switched to OpenGL2

Member Data Documentation

NumberOfRenderedProps

int vtkRenderPass::NumberOfRenderedProps

protected

Definition at line 133 of file vtkRenderPass.h.

---

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

• Rendering/Core/vtkRenderPass.h