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
 
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkDepthOfFieldPassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void ReleaseGraphicsResources (vtkWindow *w)
 
virtual void SetAutomaticFocalDistance (bool)
 
virtual bool GetAutomaticFocalDistance ()
 
virtual void AutomaticFocalDistanceOn ()
 
virtual void AutomaticFocalDistanceOff ()
 
virtual void Render (const vtkRenderState *s)
 
- Public Member Functions inherited from vtkDepthImageProcessingPass
vtkDepthImageProcessingPassNewInstance () const
 
virtual vtkRenderPassGetDelegatePass ()
 
virtual void SetDelegatePass (vtkRenderPass *delegatePass)
 
- Public Member Functions inherited from vtkImageProcessingPass
vtkImageProcessingPassNewInstance () const
 
vtkImageProcessingPassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void ReleaseGraphicsResources (vtkWindow *w)
 
- Public Member Functions inherited from vtkRenderPass
vtkRenderPassNewInstance () const
 
vtkRenderPassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int GetNumberOfRenderedProps ()
 
virtual int GetNumberOfRenderedProps ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
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)
 
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)
 
int InvokeEvent (unsigned long event, void *callData)
 
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
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

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 int IsTypeOf (const char *type)
 
static vtkRenderPassSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDepthOfFieldPass ()
 
virtual ~vtkDepthOfFieldPass ()
 
- Protected Member Functions inherited from vtkDepthImageProcessingPass
 vtkDepthImageProcessingPass ()
 
virtual ~vtkDepthImageProcessingPass ()
 
void ReadWindowSize (const vtkRenderState *s)
 
virtual void RenderDelegate (const vtkRenderState *s, int width, int height, int newWidth, int newHeight, vtkFrameBufferObject *fbo, vtkTextureObject *colortarget, vtkTextureObject *depthtarget)
 
- Protected Member Functions inherited from vtkImageProcessingPass
 vtkImageProcessingPass ()
 
virtual ~vtkImageProcessingPass ()
 
 vtkImageProcessingPass ()
 
virtual ~vtkImageProcessingPass ()
 
void RenderDelegate (const vtkRenderState *s, int width, int height, int newWidth, int newHeight, vtkFrameBufferObject *fbo, vtkTextureObject *target)
 
void RenderDelegate (const vtkRenderState *s, int width, int height, int newWidth, int newHeight, vtkFrameBufferObject *fbo, vtkTextureObject *target)
 
- Protected Member Functions inherited from vtkRenderPass
 vtkRenderPass ()
 
virtual ~vtkRenderPass ()
 
void UpdateCamera (vtkRenderer *renderer)
 
void ClearLights (vtkRenderer *renderer)
 
void UpdateLightGeometry (vtkRenderer *renderer)
 
void UpdateLights (vtkRenderer *renderer)
 
void UpdateGeometry (vtkRenderer *renderer)
 
 vtkRenderPass ()
 
virtual ~vtkRenderPass ()
 
void UpdateCamera (vtkRenderer *renderer)
 
void ClearLights (vtkRenderer *renderer)
 
void UpdateLightGeometry (vtkRenderer *renderer)
 
void UpdateLights (vtkRenderer *renderer)
 
void UpdateGeometry (vtkRenderer *renderer)
 
void SetLastRenderingUsedDepthPeeling (vtkRenderer *renderer, bool value)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
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

vtkOpenGLHelperBlurProgram
 
bool Supported
 
bool SupportProbed
 
bool AutomaticFocalDistance
 
vtkFrameBufferObjectFrameBufferObject
 
vtkTextureObjectPass1
 
vtkTextureObjectPass1Depth
 
- 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 51 of file vtkDepthOfFieldPass.h.

Member Typedef Documentation

Definition at line 55 of file vtkDepthOfFieldPass.h.

Constructor & Destructor Documentation

vtkDepthOfFieldPass::vtkDepthOfFieldPass ( )
protected

Default constructor. DelegatePass is set to NULL.

virtual vtkDepthOfFieldPass::~vtkDepthOfFieldPass ( )
protectedvirtual

Destructor.

Member Function Documentation

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

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

Reimplemented from vtkDepthImageProcessingPass.

vtkDepthOfFieldPass* vtkDepthOfFieldPass::NewInstance ( ) const
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.

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.

virtual bool vtkDepthOfFieldPass::GetAutomaticFocalDistance ( )
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.

virtual void vtkDepthOfFieldPass::AutomaticFocalDistanceOn ( )
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.

virtual void vtkDepthOfFieldPass::AutomaticFocalDistanceOff ( )
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.

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

Perform rendering according to a render state s.

Precondition
s_exists: s!=0

Implements vtkRenderPass.

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

vtkFrameBufferObject* vtkDepthOfFieldPass::FrameBufferObject
protected

Graphics resources.

Definition at line 88 of file vtkDepthOfFieldPass.h.

vtkTextureObject* vtkDepthOfFieldPass::Pass1
protected

Graphics resources.

Definition at line 89 of file vtkDepthOfFieldPass.h.

vtkTextureObject* vtkDepthOfFieldPass::Pass1Depth
protected

Graphics resources.

Definition at line 90 of file vtkDepthOfFieldPass.h.

vtkOpenGLHelper* vtkDepthOfFieldPass::BlurProgram
protected

Definition at line 94 of file vtkDepthOfFieldPass.h.

bool vtkDepthOfFieldPass::Supported
protected

Definition at line 96 of file vtkDepthOfFieldPass.h.

bool vtkDepthOfFieldPass::SupportProbed
protected

Definition at line 97 of file vtkDepthOfFieldPass.h.

bool vtkDepthOfFieldPass::AutomaticFocalDistance
protected

Definition at line 99 of file vtkDepthOfFieldPass.h.


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