vtkOverlayPass Class Reference

Render the overlay geometry with property key filtering. More...

#include <vtkOverlayPass.h>

Inheritance diagram for vtkOverlayPass:

Collaboration diagram for vtkOverlayPass:

Public Types
typedef vtkDefaultPass	Superclass
typedef vtkDefaultPass	Superclass
Public Types inherited from vtkDefaultPass
typedef vtkRenderPass	Superclass
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...
vtkOverlayPass *	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 int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...
vtkOverlayPass *	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...
Public Member Functions inherited from vtkDefaultPass
vtkDefaultPass *	NewInstance () const
vtkDefaultPass *	NewInstance () const
Public Member Functions inherited from vtkRenderPass
vtkRenderPass *	NewInstance () const
virtual void	ReleaseGraphicsResources (vtkWindow *w)
	Release graphics resources and ask components to release their own resources. More...
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 vtkOverlayPass *	New ()
static int	IsTypeOf (const char *type)
static vtkOverlayPass *	SafeDownCast (vtkObjectBase *o)
static vtkOverlayPass *	New ()
static int	IsTypeOf (const char *type)
static vtkOverlayPass *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkDefaultPass
static vtkDefaultPass *	New ()
static int	IsTypeOf (const char *type)
static vtkDefaultPass *	SafeDownCast (vtkObjectBase *o)
static vtkDefaultPass *	New ()
static int	IsTypeOf (const char *type)
static vtkDefaultPass *	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
	vtkOverlayPass ()
	Default constructor. More...
virtual	~vtkOverlayPass ()
	Destructor. More...
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkOverlayPass ()
	Default constructor. More...
virtual	~vtkOverlayPass ()
	Destructor. More...
Protected Member Functions inherited from vtkDefaultPass
	vtkDefaultPass ()
	Default constructor. More...
virtual	~vtkDefaultPass ()
	Destructor. More...
virtual void	RenderOpaqueGeometry (const vtkRenderState *s)
	Opaque pass without key checking. More...
virtual void	RenderFilteredOpaqueGeometry (const vtkRenderState *s)
	Opaque pass with key checking. More...
virtual void	RenderTranslucentPolygonalGeometry (const vtkRenderState *s)
	Translucent pass without key checking. More...
virtual void	RenderFilteredTranslucentPolygonalGeometry (const vtkRenderState *s)
	Translucent pass with key checking. More...
virtual void	RenderVolumetricGeometry (const vtkRenderState *s)
	Volume pass without key checking. More...
virtual void	RenderFilteredVolumetricGeometry (const vtkRenderState *s)
	Translucent pass with key checking. More...
virtual void	RenderOverlay (const vtkRenderState *s)
	Overlay pass without key checking. More...
virtual void	RenderFilteredOverlay (const vtkRenderState *s)
	Overlay pass with key checking. More...
	vtkDefaultPass ()
	Default constructor. More...
virtual	~vtkDefaultPass ()
	Destructor. More...
virtual void	RenderOpaqueGeometry (const vtkRenderState *s)
	Opaque pass without key checking. More...
virtual void	RenderFilteredOpaqueGeometry (const vtkRenderState *s)
	Opaque pass with key checking. More...
virtual void	RenderTranslucentPolygonalGeometry (const vtkRenderState *s)
	Translucent pass without key checking. More...
virtual void	RenderFilteredTranslucentPolygonalGeometry (const vtkRenderState *s)
	Translucent pass with key checking. More...
virtual void	RenderVolumetricGeometry (const vtkRenderState *s)
	Volume pass without key checking. More...
virtual void	RenderFilteredVolumetricGeometry (const vtkRenderState *s)
	Translucent pass with key checking. More...
virtual void	RenderOverlay (const vtkRenderState *s)
	Overlay pass without key checking. More...
virtual void	RenderFilteredOverlay (const vtkRenderState *s)
	Overlay pass with key checking. More...
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 &)

Additional Inherited Members
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

Render the overlay geometry with property key filtering.

vtkOverlayPass renders the overlay geometry of all the props that have the keys contained in vtkRenderState.

This pass expects an initialized depth buffer and color buffer. Initialized buffers means they have been cleared with farest z-value and background color/gradient/transparent color.

See also

vtkRenderPass vtkDefaultPass

vtkOverlayPass renders the overlay geometry of all the props that have the keys contained in vtkRenderState.

This pass expects an initialized depth buffer and color buffer. Initialized buffers means they have been cleared with farest z-value and background color/gradient/transparent color.

See also

vtkRenderPass vtkDefaultPass

Tests:

vtkOverlayPass (Tests)

Definition at line 37 of file vtkOverlayPass.h.

Member Typedef Documentation

typedef vtkDefaultPass vtkOverlayPass::Superclass

Definition at line 41 of file vtkOverlayPass.h.

typedef vtkDefaultPass vtkOverlayPass::Superclass

Definition at line 44 of file vtkOverlayPass.h.

Constructor & Destructor Documentation

vtkOverlayPass::vtkOverlayPass ( )

protected

Default constructor.

virtual vtkOverlayPass::~vtkOverlayPass ( )

protectedvirtual

Destructor.

vtkOverlayPass::vtkOverlayPass ( )

protected

Default constructor.

virtual vtkOverlayPass::~vtkOverlayPass ( )

protectedvirtual

Destructor.

Member Function Documentation

static vtkOverlayPass* vtkOverlayPass::New ( )

static

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

static

virtual int vtkOverlayPass::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 vtkDefaultPass.

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

static

virtual vtkObjectBase* vtkOverlayPass::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDefaultPass.

vtkOverlayPass* vtkOverlayPass::NewInstance

(

)

const

void vtkOverlayPass::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 vtkDefaultPass.

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

virtual

Perform rendering according to a render state s.

Precondition

s_exists: s!=0

Reimplemented from vtkDefaultPass.

static vtkOverlayPass* vtkOverlayPass::New ( )

static

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

static

virtual int vtkOverlayPass::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 vtkDefaultPass.

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

static

virtual vtkObjectBase* vtkOverlayPass::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDefaultPass.

vtkOverlayPass* vtkOverlayPass::NewInstance

(

)

const

void vtkOverlayPass::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 vtkDefaultPass.

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

virtual

Perform rendering according to a render state s.

Precondition

s_exists: s!=0

Reimplemented from vtkDefaultPass.

---

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

• /home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Rendering/OpenGL/vtkOverlayPass.h