VTK  9.3.20240618
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkRenderStepsPass Class Reference

Execute render passes sequentially. More...

#include <vtkRenderStepsPass.h>

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

Public Types

typedef vtkRenderPass Superclass
 
- Public Types inherited from vtkRenderPass
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.
 
vtkRenderStepsPassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void Render (const vtkRenderState *s) override
 Perform rendering according to a render state s.
 
void ReleaseGraphicsResources (vtkWindow *w) override
 Release graphics resources and ask components to release their own resources.
 
virtual vtkCameraPassGetCameraPass ()
 Get the RenderPass used for the Camera Step.
 
void SetCameraPass (vtkCameraPass *)
 Get the RenderPass used for the Camera Step.
 
virtual vtkRenderPassGetLightsPass ()
 Get the RenderPass used for the Lights Step.
 
void SetLightsPass (vtkRenderPass *)
 Get the RenderPass used for the Lights Step.
 
virtual vtkRenderPassGetOpaquePass ()
 Get the RenderPass used for the Opaque Step.
 
void SetOpaquePass (vtkRenderPass *)
 Get the RenderPass used for the Opaque Step.
 
virtual vtkRenderPassGetTranslucentPass ()
 Get the RenderPass used for the translucent Step.
 
void SetTranslucentPass (vtkRenderPass *)
 Get the RenderPass used for the translucent Step.
 
virtual vtkRenderPassGetVolumetricPass ()
 Get the RenderPass used for the Volume Step.
 
void SetVolumetricPass (vtkRenderPass *)
 Get the RenderPass used for the Volume Step.
 
virtual vtkRenderPassGetOverlayPass ()
 Get the RenderPass used for the Overlay Step.
 
void SetOverlayPass (vtkRenderPass *)
 Get the RenderPass used for the Overlay Step.
 
virtual vtkRenderPassGetPostProcessPass ()
 Get the RenderPass used for the PostProcess Step.
 
void SetPostProcessPass (vtkRenderPass *)
 Get the RenderPass used for the PostProcess Step.
 
- Public Member Functions inherited from vtkRenderPass
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkRenderPassNewInstance () 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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
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.
 
vtkCommandGetCommand (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.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
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.
 
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.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkRenderStepsPassNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRenderStepsPassSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkRenderPass
static vtkTypeBool 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.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool 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 vtkTypeBool 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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkRenderStepsPass ()
 
 ~vtkRenderStepsPass () override
 
- Protected Member Functions inherited from vtkRenderPass
virtual vtkObjectBaseNewInstanceInternal () 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 *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkCameraPassCameraPass
 
vtkRenderPassLightsPass
 
vtkRenderPassOpaquePass
 
vtkRenderPassTranslucentPass
 
vtkRenderPassVolumetricPass
 
vtkRenderPassOverlayPass
 
vtkRenderPassPostProcessPass
 
vtkSequencePassSequencePass
 
- Protected Attributes inherited from vtkRenderPass
int NumberOfRenderedProps
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- 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

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
Online Examples:

Tests:
vtkRenderStepsPass (Tests)

Definition at line 74 of file vtkRenderStepsPass.h.

Member Typedef Documentation

◆ Superclass

Definition at line 78 of file vtkRenderStepsPass.h.

Constructor & Destructor Documentation

◆ vtkRenderStepsPass()

vtkRenderStepsPass::vtkRenderStepsPass ( )
protected

◆ ~vtkRenderStepsPass()

vtkRenderStepsPass::~vtkRenderStepsPass ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkRenderStepsPass * vtkRenderStepsPass::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkRenderStepsPass::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkRenderPass.

◆ NewInstance()

vtkRenderStepsPass * vtkRenderStepsPass::NewInstance ( ) const

◆ PrintSelf()

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

◆ Render()

void vtkRenderStepsPass::Render ( const vtkRenderState s)
overridevirtual

Perform rendering according to a render state s.

Precondition
s_exists: s!=0

Implements vtkRenderPass.

◆ ReleaseGraphicsResources()

void vtkRenderStepsPass::ReleaseGraphicsResources ( vtkWindow w)
overridevirtual

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

Precondition
w_exists: w!=0

Reimplemented from vtkRenderPass.

◆ GetCameraPass()

virtual vtkCameraPass * vtkRenderStepsPass::GetCameraPass ( )
virtual

Get the RenderPass used for the Camera Step.

◆ SetCameraPass()

void vtkRenderStepsPass::SetCameraPass ( vtkCameraPass )

Get the RenderPass used for the Camera Step.

◆ GetLightsPass()

virtual vtkRenderPass * vtkRenderStepsPass::GetLightsPass ( )
virtual

Get the RenderPass used for the Lights Step.

◆ SetLightsPass()

void vtkRenderStepsPass::SetLightsPass ( vtkRenderPass )

Get the RenderPass used for the Lights Step.

◆ GetOpaquePass()

virtual vtkRenderPass * vtkRenderStepsPass::GetOpaquePass ( )
virtual

Get the RenderPass used for the Opaque Step.

◆ SetOpaquePass()

void vtkRenderStepsPass::SetOpaquePass ( vtkRenderPass )

Get the RenderPass used for the Opaque Step.

◆ GetTranslucentPass()

virtual vtkRenderPass * vtkRenderStepsPass::GetTranslucentPass ( )
virtual

Get the RenderPass used for the translucent Step.

◆ SetTranslucentPass()

void vtkRenderStepsPass::SetTranslucentPass ( vtkRenderPass )

Get the RenderPass used for the translucent Step.

◆ GetVolumetricPass()

virtual vtkRenderPass * vtkRenderStepsPass::GetVolumetricPass ( )
virtual

Get the RenderPass used for the Volume Step.

◆ SetVolumetricPass()

void vtkRenderStepsPass::SetVolumetricPass ( vtkRenderPass )

Get the RenderPass used for the Volume Step.

◆ GetOverlayPass()

virtual vtkRenderPass * vtkRenderStepsPass::GetOverlayPass ( )
virtual

Get the RenderPass used for the Overlay Step.

◆ SetOverlayPass()

void vtkRenderStepsPass::SetOverlayPass ( vtkRenderPass )

Get the RenderPass used for the Overlay Step.

◆ GetPostProcessPass()

virtual vtkRenderPass * vtkRenderStepsPass::GetPostProcessPass ( )
virtual

Get the RenderPass used for the PostProcess Step.

◆ SetPostProcessPass()

void vtkRenderStepsPass::SetPostProcessPass ( vtkRenderPass )

Get the RenderPass used for the PostProcess Step.

Member Data Documentation

◆ CameraPass

vtkCameraPass* vtkRenderStepsPass::CameraPass
protected

Definition at line 154 of file vtkRenderStepsPass.h.

◆ LightsPass

vtkRenderPass* vtkRenderStepsPass::LightsPass
protected

Definition at line 155 of file vtkRenderStepsPass.h.

◆ OpaquePass

vtkRenderPass* vtkRenderStepsPass::OpaquePass
protected

Definition at line 156 of file vtkRenderStepsPass.h.

◆ TranslucentPass

vtkRenderPass* vtkRenderStepsPass::TranslucentPass
protected

Definition at line 157 of file vtkRenderStepsPass.h.

◆ VolumetricPass

vtkRenderPass* vtkRenderStepsPass::VolumetricPass
protected

Definition at line 158 of file vtkRenderStepsPass.h.

◆ OverlayPass

vtkRenderPass* vtkRenderStepsPass::OverlayPass
protected

Definition at line 159 of file vtkRenderStepsPass.h.

◆ PostProcessPass

vtkRenderPass* vtkRenderStepsPass::PostProcessPass
protected

Definition at line 160 of file vtkRenderStepsPass.h.

◆ SequencePass

vtkSequencePass* vtkRenderStepsPass::SequencePass
protected

Definition at line 161 of file vtkRenderStepsPass.h.


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