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

Implement an EDL offscreen shading. More...

#include <vtkEDLShading.h>

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

Public Types

typedef vtkDepthImageProcessingPass Superclass
 
- Public Types inherited from vtkDepthImageProcessingPass
typedef vtkImageProcessingPass Superclass
 
- Public Types inherited from vtkImageProcessingPass
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...
 
vtkEDLShadingNewInstance () 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...
 
- Public Member Functions inherited from vtkDepthImageProcessingPass
vtkDepthImageProcessingPassNewInstance () const
 
- Public Member Functions inherited from vtkImageProcessingPass
vtkImageProcessingPassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void ReleaseGraphicsResources (vtkWindow *w) override
 Release graphics resources and ask components to release their own resources. More...
 
virtual vtkRenderPassGetDelegatePass ()
 Delegate for rendering the image to be processed. More...
 
virtual void SetDelegatePass (vtkRenderPass *delegatePass)
 Delegate for rendering the image to be processed. More...
 
- Public Member Functions inherited from vtkOpenGLRenderPass
vtkOpenGLRenderPassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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 PostReplaceShaderValues (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...
 
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. 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...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool 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 vtkEDLShadingNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkEDLShadingSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkDepthImageProcessingPass
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDepthImageProcessingPassSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImageProcessingPass
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageProcessingPassSafeDownCast (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 ()
 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
 
 vtkEDLShading ()
 Default constructor. More...
 
 ~vtkEDLShading () override
 Destructor. More...
 
void EDLInitializeFramebuffers (vtkRenderState &s)
 Initialization of required framebuffer objects. More...
 
void EDLInitializeShaders (vtkOpenGLRenderWindow *)
 Initialization of required GLSL shaders. More...
 
bool EDLShadeHigh (vtkRenderState &s, vtkOpenGLRenderWindow *)
 Render EDL in full resolution buffer. More...
 
bool EDLShadeLow (vtkRenderState &s, vtkOpenGLRenderWindow *)
 Render EDL in middle resolution buffer. More...
 
bool EDLBlurLow (vtkRenderState &s, vtkOpenGLRenderWindow *)
 Render EDL in middle resolution buffer. More...
 
bool EDLCompose (const vtkRenderState *s, vtkOpenGLRenderWindow *)
 Compose color and shaded images. More...
 
- Protected Member Functions inherited from vtkDepthImageProcessingPass
 vtkDepthImageProcessingPass ()
 Default constructor. More...
 
 ~vtkDepthImageProcessingPass () override
 Destructor. More...
 
virtual void RenderDelegate (const vtkRenderState *s, int width, int height, int newWidth, int newHeight, vtkOpenGLFramebufferObject *fbo, vtkTextureObject *colortarget, vtkTextureObject *depthtarget)
 Render delegate with a image of different dimensions than the original one. More...
 
void ReadWindowSize (const vtkRenderState *s)
 Read parent size - for sake of code clarity This function is generic, can be useful in multiple image-based rendering classes. More...
 
- Protected Member Functions inherited from vtkImageProcessingPass
 vtkImageProcessingPass ()
 Default constructor. More...
 
 ~vtkImageProcessingPass () override
 Destructor. More...
 
void RenderDelegate (const vtkRenderState *s, int width, int height, int newWidth, int newHeight, vtkOpenGLFramebufferObject *fbo, vtkTextureObject *target)
 Render delegate with a image of different dimensions than the original one. More...
 
- 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 ()
 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 &)
 

Protected Attributes

vtkOpenGLFramebufferObjectEDLHighFBO
 
vtkTextureObjectEDLHighShadeTexture
 
vtkOpenGLFramebufferObjectEDLLowFBO
 
vtkTextureObjectEDLLowShadeTexture
 
vtkTextureObjectEDLLowBlurTexture
 
vtkOpenGLHelper EDLShadeProgram
 
vtkOpenGLHelper EDLComposeProgram
 
vtkOpenGLHelper BilateralProgram
 
float EDLNeighbours [8][4]
 
bool EDLIsFiltered
 
int EDLLowResFactor
 
float Zn
 
float Zf
 
vtkOpenGLFramebufferObjectProjectionFBO
 Framebuffer object and textures for initial projection. More...
 
vtkTextureObjectProjectionColorTexture
 Framebuffer object and textures for initial projection. More...
 
vtkTextureObjectProjectionDepthTexture
 Framebuffer object and textures for initial projection. More...
 
- Protected Attributes inherited from vtkDepthImageProcessingPass
int Origin [2]
 
int Width
 
int Height
 
int W
 
int H
 
int ExtraPixels
 
- Protected Attributes inherited from vtkImageProcessingPass
vtkRenderPassDelegatePass
 
- 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 an EDL offscreen shading.

Shade the image renderered by its delegate. Two image resolutions are used

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. An opaque pass may have been performed right after the initialization.

The delegate is used once.

Its delegate is usually set to a vtkCameraPass or to a post-processing pass.

Tests:
vtkEDLShading (Tests)

Definition at line 57 of file vtkEDLShading.h.

Member Typedef Documentation

Definition at line 61 of file vtkEDLShading.h.

Constructor & Destructor Documentation

vtkEDLShading::vtkEDLShading ( )
protected

Default constructor.

DelegatePass is set to NULL.

vtkEDLShading::~vtkEDLShading ( )
overrideprotected

Destructor.

Member Function Documentation

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

static vtkEDLShading* vtkEDLShading::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkEDLShading::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDepthImageProcessingPass.

vtkEDLShading* vtkEDLShading::NewInstance ( ) const
void vtkEDLShading::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 vtkDepthImageProcessingPass.

void vtkEDLShading::Render ( const vtkRenderState s)
overridevirtual

Perform rendering according to a render state s.

Precondition
s_exists: s!=0

Implements vtkRenderPass.

void vtkEDLShading::ReleaseGraphicsResources ( vtkWindow w)
overridevirtual

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

Precondition
w_exists: w!=0

Reimplemented from vtkRenderPass.

void vtkEDLShading::EDLInitializeFramebuffers ( vtkRenderState s)
protected

Initialization of required framebuffer objects.

void vtkEDLShading::EDLInitializeShaders ( vtkOpenGLRenderWindow )
protected

Initialization of required GLSL shaders.

bool vtkEDLShading::EDLShadeHigh ( vtkRenderState s,
vtkOpenGLRenderWindow  
)
protected

Render EDL in full resolution buffer.

bool vtkEDLShading::EDLShadeLow ( vtkRenderState s,
vtkOpenGLRenderWindow  
)
protected

Render EDL in middle resolution buffer.

bool vtkEDLShading::EDLBlurLow ( vtkRenderState s,
vtkOpenGLRenderWindow  
)
protected

Render EDL in middle resolution buffer.

bool vtkEDLShading::EDLCompose ( const vtkRenderState s,
vtkOpenGLRenderWindow  
)
protected

Compose color and shaded images.

Member Data Documentation

vtkOpenGLFramebufferObject* vtkEDLShading::ProjectionFBO
protected

Framebuffer object and textures for initial projection.

Definition at line 122 of file vtkEDLShading.h.

vtkTextureObject* vtkEDLShading::ProjectionColorTexture
protected

Framebuffer object and textures for initial projection.

Definition at line 124 of file vtkEDLShading.h.

vtkTextureObject* vtkEDLShading::ProjectionDepthTexture
protected

Framebuffer object and textures for initial projection.

Definition at line 126 of file vtkEDLShading.h.

vtkOpenGLFramebufferObject* vtkEDLShading::EDLHighFBO
protected

Definition at line 131 of file vtkEDLShading.h.

vtkTextureObject* vtkEDLShading::EDLHighShadeTexture
protected

Definition at line 133 of file vtkEDLShading.h.

vtkOpenGLFramebufferObject* vtkEDLShading::EDLLowFBO
protected

Definition at line 135 of file vtkEDLShading.h.

vtkTextureObject* vtkEDLShading::EDLLowShadeTexture
protected

Definition at line 137 of file vtkEDLShading.h.

vtkTextureObject* vtkEDLShading::EDLLowBlurTexture
protected

Definition at line 139 of file vtkEDLShading.h.

vtkOpenGLHelper vtkEDLShading::EDLShadeProgram
protected

Definition at line 144 of file vtkEDLShading.h.

vtkOpenGLHelper vtkEDLShading::EDLComposeProgram
protected

Definition at line 145 of file vtkEDLShading.h.

vtkOpenGLHelper vtkEDLShading::BilateralProgram
protected

Definition at line 146 of file vtkEDLShading.h.

float vtkEDLShading::EDLNeighbours[8][4]
protected

Definition at line 148 of file vtkEDLShading.h.

bool vtkEDLShading::EDLIsFiltered
protected

Definition at line 149 of file vtkEDLShading.h.

int vtkEDLShading::EDLLowResFactor
protected

Definition at line 150 of file vtkEDLShading.h.

float vtkEDLShading::Zn
protected

Definition at line 152 of file vtkEDLShading.h.

float vtkEDLShading::Zf
protected

Definition at line 153 of file vtkEDLShading.h.


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