VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkDefaultPass Class Reference

Implement the basic render passes. More...

#include <vtkDefaultPass.h>

Inheritance diagram for vtkDefaultPass:
[legend]
Collaboration diagram for vtkDefaultPass:
[legend]

Public Types

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...
 
vtkDefaultPassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Render (const vtkRenderState *s) override
 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...
 
vtkDefaultPassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Render (const vtkRenderState *s) override
 Perform rendering according to a render state s. More...
 
- Public Member Functions inherited from vtkRenderPass
vtkRenderPassNewInstance () 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...
 
vtkCommandGetCommand (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 vtkDefaultPassNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDefaultPassSafeDownCast (vtkObjectBase *o)
 
static vtkDefaultPassNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDefaultPassSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkRenderPass
static int IsTypeOf (const char *type)
 
static vtkRenderPassSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDefaultPass ()
 Default constructor. More...
 
 ~vtkDefaultPass () override
 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...
 
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDefaultPass ()
 Default constructor. More...
 
 ~vtkDefaultPass () override
 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...
 
 ~vtkRenderPass () override
 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

Implement the basic render passes.

vtkDefaultPass implements the basic standard render passes of VTK. Subclasses can easily be implemented by reusing some parts of the basic implementation.

It implements classic Render operations as well as versions with property key checking.

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
Tests:
vtkDefaultPass (Tests)

vtkDefaultPass implements the basic standard render passes of VTK. Subclasses can easily be implemented by reusing some parts of the basic implementation.

It implements classic Render operations as well as versions with property key checking.

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

Definition at line 46 of file vtkDefaultPass.h.

Member Typedef Documentation

Definition at line 50 of file vtkDefaultPass.h.

Definition at line 47 of file vtkDefaultPass.h.

Constructor & Destructor Documentation

vtkDefaultPass::vtkDefaultPass ( )
protected

Default constructor.

vtkDefaultPass::~vtkDefaultPass ( )
overrideprotected

Destructor.

vtkDefaultPass::vtkDefaultPass ( )
protected

Default constructor.

vtkDefaultPass::~vtkDefaultPass ( )
overrideprotected

Destructor.

Member Function Documentation

static vtkDefaultPass* vtkDefaultPass::New ( )
static
static int vtkDefaultPass::IsTypeOf ( const char *  type)
static
virtual int vtkDefaultPass::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.

Reimplemented in vtkValuePass, vtkLightingMapPass, vtkOpaquePass, vtkOverlayPass, vtkTranslucentPass, vtkVolumetricPass, vtkOpaquePass, vtkOverlayPass, vtkTranslucentPass, vtkVolumetricPass, and vtkValuePass.

static vtkDefaultPass* vtkDefaultPass::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkDefaultPass::NewInstanceInternal ( ) const
protectedvirtual
vtkDefaultPass* vtkDefaultPass::NewInstance ( ) const
void vtkDefaultPass::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 vtkRenderPass.

Reimplemented in vtkValuePass, vtkLightingMapPass, vtkOpaquePass, vtkOverlayPass, vtkTranslucentPass, vtkVolumetricPass, vtkOpaquePass, vtkOverlayPass, vtkTranslucentPass, vtkVolumetricPass, and vtkValuePass.

void vtkDefaultPass::Render ( const vtkRenderState s)
overridevirtual
virtual void vtkDefaultPass::RenderOpaqueGeometry ( const vtkRenderState s)
protectedvirtual

Opaque pass without key checking.

Precondition
s_exists: s!=0

Reimplemented in vtkValuePass, and vtkLightingMapPass.

virtual void vtkDefaultPass::RenderFilteredOpaqueGeometry ( const vtkRenderState s)
protectedvirtual

Opaque pass with key checking.

Precondition
s_exists: s!=0
virtual void vtkDefaultPass::RenderTranslucentPolygonalGeometry ( const vtkRenderState s)
protectedvirtual

Translucent pass without key checking.

Precondition
s_exists: s!=0
virtual void vtkDefaultPass::RenderFilteredTranslucentPolygonalGeometry ( const vtkRenderState s)
protectedvirtual

Translucent pass with key checking.

Precondition
s_exists: s!=0
virtual void vtkDefaultPass::RenderVolumetricGeometry ( const vtkRenderState s)
protectedvirtual

Volume pass without key checking.

Precondition
s_exists: s!=0
virtual void vtkDefaultPass::RenderFilteredVolumetricGeometry ( const vtkRenderState s)
protectedvirtual

Translucent pass with key checking.

Precondition
s_exists: s!=0
virtual void vtkDefaultPass::RenderOverlay ( const vtkRenderState s)
protectedvirtual

Overlay pass without key checking.

Precondition
s_exists: s!=0
virtual void vtkDefaultPass::RenderFilteredOverlay ( const vtkRenderState s)
protectedvirtual

Overlay pass with key checking.

Precondition
s_exists: s!=0
static vtkDefaultPass* vtkDefaultPass::New ( )
static
static int vtkDefaultPass::IsTypeOf ( const char *  type)
static
virtual int vtkDefaultPass::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.

Reimplemented in vtkValuePass, vtkLightingMapPass, vtkOpaquePass, vtkOverlayPass, vtkTranslucentPass, vtkVolumetricPass, vtkOpaquePass, vtkOverlayPass, vtkTranslucentPass, vtkVolumetricPass, and vtkValuePass.

static vtkDefaultPass* vtkDefaultPass::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkDefaultPass::NewInstanceInternal ( ) const
protectedvirtual
vtkDefaultPass* vtkDefaultPass::NewInstance ( ) const
void vtkDefaultPass::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 vtkRenderPass.

Reimplemented in vtkValuePass, vtkLightingMapPass, vtkOpaquePass, vtkOverlayPass, vtkTranslucentPass, and vtkVolumetricPass.

void vtkDefaultPass::Render ( const vtkRenderState s)
overridevirtual
virtual void vtkDefaultPass::RenderOpaqueGeometry ( const vtkRenderState s)
protectedvirtual

Opaque pass without key checking.

Precondition
s_exists: s!=0

Reimplemented in vtkValuePass, and vtkLightingMapPass.

virtual void vtkDefaultPass::RenderFilteredOpaqueGeometry ( const vtkRenderState s)
protectedvirtual

Opaque pass with key checking.

Precondition
s_exists: s!=0
virtual void vtkDefaultPass::RenderTranslucentPolygonalGeometry ( const vtkRenderState s)
protectedvirtual

Translucent pass without key checking.

Precondition
s_exists: s!=0
virtual void vtkDefaultPass::RenderFilteredTranslucentPolygonalGeometry ( const vtkRenderState s)
protectedvirtual

Translucent pass with key checking.

Precondition
s_exists: s!=0
virtual void vtkDefaultPass::RenderVolumetricGeometry ( const vtkRenderState s)
protectedvirtual

Volume pass without key checking.

Precondition
s_exists: s!=0
virtual void vtkDefaultPass::RenderFilteredVolumetricGeometry ( const vtkRenderState s)
protectedvirtual

Translucent pass with key checking.

Precondition
s_exists: s!=0
virtual void vtkDefaultPass::RenderOverlay ( const vtkRenderState s)
protectedvirtual

Overlay pass without key checking.

Precondition
s_exists: s!=0
virtual void vtkDefaultPass::RenderFilteredOverlay ( const vtkRenderState s)
protectedvirtual

Overlay pass with key checking.

Precondition
s_exists: s!=0

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