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

Implement OIT rendering using average color. More...

#include <vtkOrderIndependentTranslucentPass.h>

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

Public Types

typedef vtkOpenGLRenderPass Superclass
 
- Public Types inherited from vtkOpenGLRenderPass
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. More...
 
vtkOrderIndependentTranslucentPassNewInstance () 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...
 
void ReleaseGraphicsResources (vtkWindow *w) override
 Release graphics resources and ask components to release their own resources. More...
 
virtual vtkRenderPassGetTranslucentPass ()
 Delegate for rendering the translucent polygonal geometry. More...
 
virtual void SetTranslucentPass (vtkRenderPass *translucentPass)
 
bool PostReplaceShaderValues (std::string &vertexShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper *mapper, vtkProp *prop) override
 Use vtkShaderProgram::Substitute to replace //VTK::XXX:YYY declarations in the shader sources. More...
 
- Public Member Functions inherited from vtkOpenGLRenderPass
vtkOpenGLRenderPassNewInstance () const
 
virtual bool PreReplaceShaderValues (std::string &vertexShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper *mapper, vtkProp *prop)
 Use vtkShaderProgram::Substitute to replace //VTK::XXX:YYY declarations in the shader sources. More...
 
virtual bool SetShaderParameters (vtkShaderProgram *program, vtkAbstractMapper *mapper, vtkProp *prop, vtkOpenGLVertexArrayObject *VAO=nullptr)
 Update the uniforms of the shader program. More...
 
virtual vtkMTimeType GetShaderStageMTime ()
 For multi-stage render passes that need to change shader code during a single pass, use this method to notify a mapper that the shader needs to be rebuilt (rather than reuse the last cached shader. More...
 
virtual void SetActiveDrawBuffers (unsigned int)
 Number of active draw buffers. More...
 
virtual unsigned int GetActiveDrawBuffers ()
 
- Public Member Functions inherited from vtkRenderPass
vtkRenderPassNewInstance () 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkOrderIndependentTranslucentPassNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOrderIndependentTranslucentPassSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkOpenGLRenderPass
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenGLRenderPassSafeDownCast (vtkObjectBase *o)
 
static vtkInformationObjectBaseVectorKeyRenderPasses ()
 Key containing information about the current pass. More...
 
- 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. 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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
 
 vtkOrderIndependentTranslucentPass ()
 Default constructor. More...
 
 ~vtkOrderIndependentTranslucentPass () override
 Destructor. More...
 
void BlendFinalPeel (vtkOpenGLRenderWindow *renWin)
 
- Protected Member Functions inherited from vtkOpenGLRenderPass
 vtkOpenGLRenderPass ()
 
 ~vtkOpenGLRenderPass () override
 
void PreRender (const vtkRenderState *s)
 Call before rendering to update the actors' information keys. More...
 
void PostRender (const vtkRenderState *s)
 Call after rendering to clean up the actors' information keys. 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, vtkFrameBufferObjectBase *fbo=nullptr)
 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=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- 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

vtkRenderPassTranslucentPass
 
int ViewportX
 Cache viewport values for depth peeling. More...
 
int ViewportY
 
int ViewportWidth
 
int ViewportHeight
 
vtkOpenGLFramebufferObjectFramebuffer
 
vtkOpenGLQuadHelperFinalBlend
 
vtkTextureObjectTranslucentRGBATexture
 
vtkTextureObjectTranslucentRTexture
 
vtkTextureObjectTranslucentZTexture
 
vtkOpenGLStateState
 
- Protected Attributes inherited from vtkOpenGLRenderPass
unsigned int ActiveDrawBuffers = 0
 
- 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 OIT rendering using average color.

Simple version that uses average alpha weighted color and correct final computed alpha. Single pass approach.

See also
vtkRenderPass, vtkTranslucentPass, vtkFramebufferPass
Tests:
vtkOrderIndependentTranslucentPass (Tests)

Definition at line 41 of file vtkOrderIndependentTranslucentPass.h.

Member Typedef Documentation

◆ Superclass

Definition at line 46 of file vtkOrderIndependentTranslucentPass.h.

Constructor & Destructor Documentation

◆ vtkOrderIndependentTranslucentPass()

vtkOrderIndependentTranslucentPass::vtkOrderIndependentTranslucentPass ( )
protected

Default constructor.

TranslucentPass is set to NULL.

◆ ~vtkOrderIndependentTranslucentPass()

vtkOrderIndependentTranslucentPass::~vtkOrderIndependentTranslucentPass ( )
overrideprotected

Destructor.

Member Function Documentation

◆ New()

static vtkOrderIndependentTranslucentPass* vtkOrderIndependentTranslucentPass::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkOrderIndependentTranslucentPass::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 vtkOpenGLRenderPass.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOrderIndependentTranslucentPass::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkOpenGLRenderPass.

◆ NewInstance()

vtkOrderIndependentTranslucentPass* vtkOrderIndependentTranslucentPass::NewInstance ( ) const

◆ PrintSelf()

void vtkOrderIndependentTranslucentPass::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 vtkOpenGLRenderPass.

◆ Render()

void vtkOrderIndependentTranslucentPass::Render ( const vtkRenderState s)
overridevirtual

Perform rendering according to a render state s.

Precondition
s_exists: s!=0

Implements vtkRenderPass.

◆ ReleaseGraphicsResources()

void vtkOrderIndependentTranslucentPass::ReleaseGraphicsResources ( vtkWindow w)
overridevirtual

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

Precondition
w_exists: w!=0

Reimplemented from vtkRenderPass.

◆ GetTranslucentPass()

virtual vtkRenderPass* vtkOrderIndependentTranslucentPass::GetTranslucentPass ( )
virtual

Delegate for rendering the translucent polygonal geometry.

If it is NULL, nothing will be rendered and a warning will be emitted. It is usually set to a vtkTranslucentPass. Initial value is a NULL pointer.

◆ SetTranslucentPass()

virtual void vtkOrderIndependentTranslucentPass::SetTranslucentPass ( vtkRenderPass translucentPass)
virtual

◆ PostReplaceShaderValues()

bool vtkOrderIndependentTranslucentPass::PostReplaceShaderValues ( std::string &  vertexShader,
std::string &  geometryShader,
std::string &  fragmentShader,
vtkAbstractMapper mapper,
vtkProp prop 
)
overridevirtual

Use vtkShaderProgram::Substitute to replace //VTK::XXX:YYY declarations in the shader sources.

Gets called after other mapper shader replacements. Return false on error.

Reimplemented from vtkOpenGLRenderPass.

◆ BlendFinalPeel()

void vtkOrderIndependentTranslucentPass::BlendFinalPeel ( vtkOpenGLRenderWindow renWin)
protected

Member Data Documentation

◆ TranslucentPass

vtkRenderPass* vtkOrderIndependentTranslucentPass::TranslucentPass
protected

Definition at line 91 of file vtkOrderIndependentTranslucentPass.h.

◆ ViewportX

int vtkOrderIndependentTranslucentPass::ViewportX
protected

Cache viewport values for depth peeling.

Definition at line 97 of file vtkOrderIndependentTranslucentPass.h.

◆ ViewportY

int vtkOrderIndependentTranslucentPass::ViewportY
protected

Definition at line 98 of file vtkOrderIndependentTranslucentPass.h.

◆ ViewportWidth

int vtkOrderIndependentTranslucentPass::ViewportWidth
protected

Definition at line 99 of file vtkOrderIndependentTranslucentPass.h.

◆ ViewportHeight

int vtkOrderIndependentTranslucentPass::ViewportHeight
protected

Definition at line 100 of file vtkOrderIndependentTranslucentPass.h.

◆ Framebuffer

vtkOpenGLFramebufferObject* vtkOrderIndependentTranslucentPass::Framebuffer
protected

Definition at line 103 of file vtkOrderIndependentTranslucentPass.h.

◆ FinalBlend

vtkOpenGLQuadHelper* vtkOrderIndependentTranslucentPass::FinalBlend
protected

Definition at line 104 of file vtkOrderIndependentTranslucentPass.h.

◆ TranslucentRGBATexture

vtkTextureObject* vtkOrderIndependentTranslucentPass::TranslucentRGBATexture
protected

Definition at line 106 of file vtkOrderIndependentTranslucentPass.h.

◆ TranslucentRTexture

vtkTextureObject* vtkOrderIndependentTranslucentPass::TranslucentRTexture
protected

Definition at line 107 of file vtkOrderIndependentTranslucentPass.h.

◆ TranslucentZTexture

vtkTextureObject* vtkOrderIndependentTranslucentPass::TranslucentZTexture
protected

Definition at line 108 of file vtkOrderIndependentTranslucentPass.h.

◆ State

vtkOpenGLState* vtkOrderIndependentTranslucentPass::State
protected

Definition at line 113 of file vtkOrderIndependentTranslucentPass.h.


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