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

Convenient class for post-processing passes. More...

#include <vtkImageProcessingPass.h>

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

Public Types

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

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

Convenient class for post-processing passes.

render pass.

Abstract class with some convenient methods frequently used in subclasses.

See also
vtkRenderPass vtkGaussianBlurPass vtkSobelGradientMagnitudePass

Definition at line 40 of file vtkImageProcessingPass.h.

Member Typedef Documentation

◆ Superclass [1/2]

Definition at line 43 of file vtkImageProcessingPass.h.

◆ Superclass [2/2]

Definition at line 41 of file vtkImageProcessingPass.h.

Constructor & Destructor Documentation

◆ vtkImageProcessingPass() [1/2]

vtkImageProcessingPass::vtkImageProcessingPass ( )
protected

Default constructor.

DelegatePass is set to NULL.

◆ ~vtkImageProcessingPass() [1/2]

virtual vtkImageProcessingPass::~vtkImageProcessingPass ( )
protectedvirtual

Destructor.

◆ vtkImageProcessingPass() [2/2]

vtkImageProcessingPass::vtkImageProcessingPass ( )
protected

Default constructor.

DelegatePass is set to NULL.

◆ ~vtkImageProcessingPass() [2/2]

virtual vtkImageProcessingPass::~vtkImageProcessingPass ( )
protectedvirtual

Destructor.

Member Function Documentation

◆ IsTypeOf() [1/2]

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

◆ IsA() [1/2]

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

Reimplemented in vtkGaussianBlurPass, vtkSobelGradientMagnitudePass, vtkDepthImageProcessingPass, vtkDepthOfFieldPass, vtkEDLShading, vtkGaussianBlurPass, vtkPointFillPass, and vtkSobelGradientMagnitudePass.

◆ SafeDownCast() [1/2]

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

◆ NewInstanceInternal() [1/2]

virtual vtkObjectBase * vtkImageProcessingPass::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance() [1/2]

vtkImageProcessingPass * vtkImageProcessingPass::NewInstance ( ) const

◆ PrintSelf() [1/2]

void vtkImageProcessingPass::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 vtkRenderPass.

Reimplemented in vtkSobelGradientMagnitudePass, vtkDepthImageProcessingPass, vtkDepthOfFieldPass, vtkEDLShading, vtkGaussianBlurPass, vtkPointFillPass, and vtkSobelGradientMagnitudePass.

◆ ReleaseGraphicsResources() [1/2]

void vtkImageProcessingPass::ReleaseGraphicsResources ( vtkWindow w)
virtual

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

Precondition
w_exists: w!=0

Reimplemented from vtkRenderPass.

Reimplemented in vtkSobelGradientMagnitudePass, vtkDepthImageProcessingPass, vtkDepthOfFieldPass, vtkEDLShading, vtkGaussianBlurPass, vtkPointFillPass, and vtkSobelGradientMagnitudePass.

◆ GetDelegatePass() [1/2]

virtual vtkRenderPass * vtkImageProcessingPass::GetDelegatePass ( )
virtual

Delegate for rendering the image to be processed.

If it is NULL, nothing will be rendered and a warning will be emitted. It is usually set to a vtkCameraPass or to a post-processing pass. Initial value is a NULL pointer.

Reimplemented in vtkDepthImageProcessingPass.

◆ SetDelegatePass() [1/2]

virtual void vtkImageProcessingPass::SetDelegatePass ( vtkRenderPass delegatePass)
virtual

Reimplemented in vtkDepthImageProcessingPass.

◆ RenderDelegate() [1/2]

void vtkImageProcessingPass::RenderDelegate ( const vtkRenderState s,
int  width,
int  height,
int  newWidth,
int  newHeight,
vtkFrameBufferObject fbo,
vtkTextureObject target 
)
protected

Render delegate with a image of different dimensions than the original one.

Precondition
s_exists: s!=0
fbo_exists: fbo!=0
fbo_has_context: fbo->GetContext()!=0
target_exists: target!=0
target_has_context: target->GetContext()!=0

◆ IsTypeOf() [2/2]

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

◆ IsA() [2/2]

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

Reimplemented in vtkGaussianBlurPass, vtkSobelGradientMagnitudePass, vtkDepthImageProcessingPass, vtkDepthOfFieldPass, vtkEDLShading, vtkGaussianBlurPass, vtkPointFillPass, and vtkSobelGradientMagnitudePass.

◆ SafeDownCast() [2/2]

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

◆ NewInstanceInternal() [2/2]

virtual vtkObjectBase * vtkImageProcessingPass::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance() [2/2]

vtkImageProcessingPass * vtkImageProcessingPass::NewInstance ( ) const

◆ PrintSelf() [2/2]

void vtkImageProcessingPass::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 vtkRenderPass.

Reimplemented in vtkPointFillPass, and vtkSobelGradientMagnitudePass.

◆ ReleaseGraphicsResources() [2/2]

void vtkImageProcessingPass::ReleaseGraphicsResources ( vtkWindow w)
virtual

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

Precondition
w_exists: w!=0

Reimplemented from vtkRenderPass.

Reimplemented in vtkPointFillPass, and vtkSobelGradientMagnitudePass.

◆ GetDelegatePass() [2/2]

virtual vtkRenderPass * vtkImageProcessingPass::GetDelegatePass ( )
virtual

Delegate for rendering the image to be processed.

If it is NULL, nothing will be rendered and a warning will be emitted. It is usually set to a vtkCameraPass or to a post-processing pass. Initial value is a NULL pointer.

Reimplemented in vtkDepthImageProcessingPass.

◆ SetDelegatePass() [2/2]

virtual void vtkImageProcessingPass::SetDelegatePass ( vtkRenderPass delegatePass)
virtual

Reimplemented in vtkDepthImageProcessingPass.

◆ RenderDelegate() [2/2]

void vtkImageProcessingPass::RenderDelegate ( const vtkRenderState s,
int  width,
int  height,
int  newWidth,
int  newHeight,
vtkFrameBufferObject fbo,
vtkTextureObject target 
)
protected

Render delegate with a image of different dimensions than the original one.

Precondition
s_exists: s!=0
fbo_exists: fbo!=0
fbo_has_context: fbo->GetContext()!=0
target_exists: target!=0
target_has_context: target->GetContext()!=0

Member Data Documentation

◆ DelegatePass

vtkRenderPass * vtkImageProcessingPass::DelegatePass
protected

Definition at line 93 of file vtkImageProcessingPass.h.


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