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

Implement a post-processing DOF blur pass. More...

#include <vtkDepthOfFieldPass.h>

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

Public Types

typedef vtkDepthImageProcessingPass Superclass
 
- Public Types inherited from vtkDepthImageProcessingPass
typedef vtkImageProcessingPass Superclass
 
- Public Types inherited from vtkImageProcessingPass
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...
 
vtkDepthOfFieldPassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetAutomaticFocalDistance (bool)
 Use automatic focal distance calculation, this is on by default When on the center of the viewport will always be in focus regardless of where the focal point is. More...
 
virtual bool GetAutomaticFocalDistance ()
 
virtual void AutomaticFocalDistanceOn ()
 
virtual void AutomaticFocalDistanceOff ()
 
virtual void Render (const vtkRenderState *s)
 Perform rendering according to a render state s. More...
 
void ReleaseGraphicsResources (vtkWindow *w)
 Release graphics resources and ask components to release their own resources. More...
 
- Public Member Functions inherited from vtkDepthImageProcessingPass
virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkDepthImageProcessingPassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
void ReleaseGraphicsResources (vtkWindow *w)
 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)
 
- Public Member Functions inherited from vtkImageProcessingPass
virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkImageProcessingPassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
void ReleaseGraphicsResources (vtkWindow *w)
 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)
 
virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkImageProcessingPassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
void ReleaseGraphicsResources (vtkWindow *w)
 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)
 
- Public Member Functions inherited from vtkRenderPass
virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkRenderPassNewInstance () 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)=0
 Perform rendering according to a render state s. More...
 
virtual int GetNumberOfRenderedProps ()
 Number of props rendered at the last Render call. More...
 
virtual void ReleaseGraphicsResources (vtkWindow *w)
 Release graphics resources and ask components to release their own resources. 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 PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. 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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
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)
 
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 vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class. 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 PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. 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 vtkDepthOfFieldPassNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDepthOfFieldPassSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkDepthImageProcessingPass
static int IsTypeOf (const char *type)
 
static vtkDepthImageProcessingPassSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImageProcessingPass
static int IsTypeOf (const char *type)
 
static vtkImageProcessingPassSafeDownCast (vtkObjectBase *o)
 
static int IsTypeOf (const char *type)
 
static vtkImageProcessingPassSafeDownCast (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 ()
 
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
 
 vtkDepthOfFieldPass ()
 Default constructor. More...
 
virtual ~vtkDepthOfFieldPass ()
 Destructor. More...
 
- Protected Member Functions inherited from vtkDepthImageProcessingPass
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDepthImageProcessingPass ()
 Default constructor. More...
 
virtual ~vtkDepthImageProcessingPass ()
 Destructor. More...
 
virtual void RenderDelegate (const vtkRenderState *s, int width, int height, int newWidth, int newHeight, vtkFrameBufferObject *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
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkImageProcessingPass ()
 Default constructor. More...
 
virtual ~vtkImageProcessingPass ()
 Destructor. More...
 
void RenderDelegate (const vtkRenderState *s, int width, int height, int newWidth, int newHeight, vtkFrameBufferObject *fbo, vtkTextureObject *target)
 Render delegate with a image of different dimensions than the original one. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkImageProcessingPass ()
 Default constructor. More...
 
virtual ~vtkImageProcessingPass ()
 Destructor. More...
 
void RenderDelegate (const vtkRenderState *s, int width, int height, int newWidth, int newHeight, vtkFrameBufferObject *fbo, vtkTextureObject *target)
 Render delegate with a image of different dimensions than the original one. More...
 
- Protected Member Functions inherited from vtkRenderPass
virtual vtkObjectBaseNewInstanceInternal () const
 
 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkFrameBufferObjectFrameBufferObject
 Graphics resources. More...
 
vtkTextureObjectPass1
 
vtkTextureObjectPass1Depth
 
vtkOpenGLHelperBlurProgram
 
bool Supported
 
bool SupportProbed
 
bool AutomaticFocalDistance
 
- Protected Attributes inherited from vtkDepthImageProcessingPass
vtkRenderPassDelegatePass
 
int Width
 
int Height
 
int W
 
int H
 
int ExtraPixels
 
- Protected Attributes inherited from vtkImageProcessingPass
vtkRenderPassDelegatePass
 
- 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 a post-processing DOF blur pass.

Currently only does behind the focal plane

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.

The delegate is used once.

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

Implementation:
As the filter is separable, it first blurs the image horizontally and then vertically. This reduces the number of texture samples
See also
vtkRenderPass
Tests:
vtkDepthOfFieldPass (Tests)

Definition at line 52 of file vtkDepthOfFieldPass.h.

Member Typedef Documentation

◆ Superclass

Definition at line 56 of file vtkDepthOfFieldPass.h.

Constructor & Destructor Documentation

◆ vtkDepthOfFieldPass()

vtkDepthOfFieldPass::vtkDepthOfFieldPass ( )
protected

Default constructor.

DelegatePass is set to NULL.

◆ ~vtkDepthOfFieldPass()

virtual vtkDepthOfFieldPass::~vtkDepthOfFieldPass ( )
protectedvirtual

Destructor.

Member Function Documentation

◆ New()

static vtkDepthOfFieldPass * vtkDepthOfFieldPass::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkDepthOfFieldPass::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDepthImageProcessingPass.

◆ NewInstance()

vtkDepthOfFieldPass * vtkDepthOfFieldPass::NewInstance ( ) const

◆ PrintSelf()

void vtkDepthOfFieldPass::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 vtkDepthImageProcessingPass.

◆ SetAutomaticFocalDistance()

virtual void vtkDepthOfFieldPass::SetAutomaticFocalDistance ( bool  )
virtual

Use automatic focal distance calculation, this is on by default When on the center of the viewport will always be in focus regardless of where the focal point is.

◆ GetAutomaticFocalDistance()

virtual bool vtkDepthOfFieldPass::GetAutomaticFocalDistance ( )
virtual

◆ AutomaticFocalDistanceOn()

virtual void vtkDepthOfFieldPass::AutomaticFocalDistanceOn ( )
virtual

◆ AutomaticFocalDistanceOff()

virtual void vtkDepthOfFieldPass::AutomaticFocalDistanceOff ( )
virtual

◆ Render()

virtual void vtkDepthOfFieldPass::Render ( const vtkRenderState s)
virtual

Perform rendering according to a render state s.

Precondition
s_exists: s!=0

Implements vtkRenderPass.

◆ ReleaseGraphicsResources()

void vtkDepthOfFieldPass::ReleaseGraphicsResources ( vtkWindow w)
virtual

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

Precondition
w_exists: w!=0

Reimplemented from vtkDepthImageProcessingPass.

Member Data Documentation

◆ FrameBufferObject

vtkFrameBufferObject* vtkDepthOfFieldPass::FrameBufferObject
protected

Graphics resources.

Definition at line 97 of file vtkDepthOfFieldPass.h.

◆ Pass1

vtkTextureObject* vtkDepthOfFieldPass::Pass1
protected

Definition at line 98 of file vtkDepthOfFieldPass.h.

◆ Pass1Depth

vtkTextureObject* vtkDepthOfFieldPass::Pass1Depth
protected

Definition at line 99 of file vtkDepthOfFieldPass.h.

◆ BlurProgram

vtkOpenGLHelper* vtkDepthOfFieldPass::BlurProgram
protected

Definition at line 102 of file vtkDepthOfFieldPass.h.

◆ Supported

bool vtkDepthOfFieldPass::Supported
protected

Definition at line 104 of file vtkDepthOfFieldPass.h.

◆ SupportProbed

bool vtkDepthOfFieldPass::SupportProbed
protected

Definition at line 105 of file vtkDepthOfFieldPass.h.

◆ AutomaticFocalDistance

bool vtkDepthOfFieldPass::AutomaticFocalDistance
protected

Definition at line 107 of file vtkDepthOfFieldPass.h.


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