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

Render opaque objects with the vtkValuePainter. More...

#include <vtkValuePass.h>

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

Public Types

enum  Mode { INVERTIBLE_LUT = 1, FLOATING_POINT = 2 }
 
typedef vtkOpaquePass Superclass
 
typedef vtkDefaultPass Superclass
 
- Public Types inherited from vtkDefaultPass
typedef vtkRenderPass Superclass
 
typedef vtkRenderPass Superclass
 
- Public Types inherited from vtkRenderPass
typedef vtkObject Superclass
 
- Public Types inherited from vtkOpaquePass
typedef vtkDefaultPass Superclass
 
typedef vtkDefaultPass 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...
 
vtkValuePassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetInputArrayToProcess (int fieldAssociation, const char *name)
 Set the array to be drawn. More...
 
void SetInputArrayToProcess (int fieldAssociation, int fieldAttributeType)
 
void SetInputComponentToProcess (int comp)
 
void SetScalarRange (double min, double max)
 
virtual void Render (const vtkRenderState *s)
 Render. More...
 
virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkValuePassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetRenderingMode (int)
 
virtual int GetRenderingMode ()
 
void SetInputArrayToProcess (int fieldAssociation, const char *name)
 
void SetInputArrayToProcess (int fieldAssociation, int fieldAttributeType)
 
void SetInputComponentToProcess (int component)
 
void SetScalarRange (double min, double max)
 
virtual void Render (const vtkRenderState *s)
 Perform rendering according to a render state s. More...
 
vtkFloatArrayGetFloatImageDataArray (vtkRenderer *ren)
 Interface to get the rendered image in FLOATING_POINT mode. More...
 
void GetFloatImageData (int const format, int const width, int const height, void *data)
 Interface to get the rendered image in FLOATING_POINT mode. More...
 
intGetFloatImageExtents ()
 Interface to get the rendered image in FLOATING_POINT mode. More...
 
bool IsFloatingPointModeSupported (vtkRenderWindow *renWin)
 
- Public Member Functions inherited from vtkDefaultPass
vtkDefaultPassNewInstance () const
 
vtkDefaultPassNewInstance () const
 
- Public Member Functions inherited from vtkRenderPass
vtkRenderPassNewInstance () const
 
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...
 
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 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...
 
- Public Member Functions inherited from vtkOpaquePass
vtkOpaquePassNewInstance () const
 
vtkOpaquePassNewInstance () const
 

Static Public Member Functions

static vtkValuePassNew ()
 
static int IsTypeOf (const char *type)
 
static vtkValuePassSafeDownCast (vtkObjectBase *o)
 
static vtkValuePassNew ()
 
static int IsTypeOf (const char *type)
 
static vtkValuePassSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyRENDER_VALUES ()
 
static vtkInformationIntegerKeySCALAR_MODE ()
 Passed down the rendering pipeline to control what data array to draw. More...
 
static vtkInformationIntegerKeyARRAY_MODE ()
 
static vtkInformationIntegerKeyARRAY_ID ()
 
static vtkInformationStringKeyARRAY_NAME ()
 
static vtkInformationIntegerKeyARRAY_COMPONENT ()
 
static vtkInformationDoubleVectorKeySCALAR_RANGE ()
 
static vtkInformationIntegerKeyRELOAD_DATA ()
 
- Static Public Member Functions inherited from vtkDefaultPass
static vtkDefaultPassNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDefaultPassSafeDownCast (vtkObjectBase *o)
 
static vtkDefaultPassNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDefaultPassSafeDownCast (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...
 
- Static Public Member Functions inherited from vtkOpaquePass
static vtkOpaquePassNew ()
 
static int IsTypeOf (const char *type)
 
static vtkOpaquePassSafeDownCast (vtkObjectBase *o)
 
static vtkOpaquePassNew ()
 
static int IsTypeOf (const char *type)
 
static vtkOpaquePassSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkValuePass ()
 Default constructor. More...
 
virtual ~vtkValuePass ()
 Destructor. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkValuePass ()
 Default constructor. More...
 
virtual ~vtkValuePass ()
 Destructor. More...
 
virtual void RenderOpaqueGeometry (const vtkRenderState *s)
 Opaque pass with key checking. More...
 
void BeginPass (vtkRenderer *ren)
 Manages graphics resources depending on the rendering mode. More...
 
void EndPass ()
 Unbinds internal FBO when FLOATING_POINT mode is enabled. More...
 
bool HasWindowSizeChanged (vtkRenderer *ren)
 Methods managing graphics resources required during FLOATING_POINT mode. More...
 
bool InitializeFloatingPointMode (vtkRenderer *ren)
 
void ReleaseFloatingPointMode (vtkRenderer *ren)
 
- Protected Member Functions inherited from vtkDefaultPass
 vtkDefaultPass ()
 Default constructor. More...
 
virtual ~vtkDefaultPass ()
 Destructor. More...
 
virtual void RenderFilteredOpaqueGeometry (const vtkRenderState *s)
 Opaque pass with key checking. More...
 
virtual void RenderTranslucentPolygonalGeometry (const vtkRenderState *s)
 Translucent pass without key checking. More...
 
virtual void RenderFilteredTranslucentPolygonalGeometry (const vtkRenderState *s)
 Translucent pass with key checking. More...
 
virtual void RenderVolumetricGeometry (const vtkRenderState *s)
 Volume pass without key checking. More...
 
virtual void RenderFilteredVolumetricGeometry (const vtkRenderState *s)
 Translucent pass with key checking. More...
 
virtual void RenderOverlay (const vtkRenderState *s)
 Overlay pass without key checking. More...
 
virtual void RenderFilteredOverlay (const vtkRenderState *s)
 Overlay pass with key checking. More...
 
 vtkDefaultPass ()
 Default constructor. More...
 
virtual ~vtkDefaultPass ()
 Destructor. More...
 
virtual void RenderFilteredOpaqueGeometry (const vtkRenderState *s)
 Opaque pass with key checking. More...
 
virtual void RenderTranslucentPolygonalGeometry (const vtkRenderState *s)
 Translucent pass without key checking. More...
 
virtual void RenderFilteredTranslucentPolygonalGeometry (const vtkRenderState *s)
 Translucent pass with key checking. More...
 
virtual void RenderVolumetricGeometry (const vtkRenderState *s)
 Volume pass without key checking. More...
 
virtual void RenderFilteredVolumetricGeometry (const vtkRenderState *s)
 Translucent pass with key checking. More...
 
virtual void RenderOverlay (const vtkRenderState *s)
 Overlay pass without key checking. More...
 
virtual void RenderFilteredOverlay (const vtkRenderState *s)
 Overlay pass with key checking. More...
 
- Protected Member Functions inherited from vtkRenderPass
 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 ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 
- Protected Member Functions inherited from vtkOpaquePass
 vtkOpaquePass ()
 Default constructor. More...
 
virtual ~vtkOpaquePass ()
 Destructor. More...
 
 vtkOpaquePass ()
 Default constructor. More...
 
virtual ~vtkOpaquePass ()
 Destructor. More...
 

Protected Attributes

int RenderingMode
 
- 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

Render opaque objects with the vtkValuePainter.

This is a render pass draws polygonal data with the vtkValuePainter.

See also
vtkValuePainter, vtkValuePass
Tests:
vtkValuePass (Tests)

Renders geometry using the values of a field array as fragment colors. The output can be used for deferred color mapping. It supports using arrays of either point or cell data. The target array can be selected by setting an array name/id and a component number. Only opaque geometry is supported.

There are two rendering modes available:

See also
vtkRenderPass vtkDefaultPass vtkValuePassHelper vtkMapper

Definition at line 34 of file vtkValuePass.h.

Member Typedef Documentation

◆ Superclass [1/2]

Definition at line 38 of file vtkValuePass.h.

◆ Superclass [2/2]

Definition at line 59 of file vtkValuePass.h.

Member Enumeration Documentation

◆ Mode

Enumerator
INVERTIBLE_LUT 
FLOATING_POINT 

Definition at line 54 of file vtkValuePass.h.

Constructor & Destructor Documentation

◆ vtkValuePass() [1/2]

vtkValuePass::vtkValuePass ( )
protected

Default constructor.

◆ ~vtkValuePass() [1/2]

virtual vtkValuePass::~vtkValuePass ( )
protectedvirtual

Destructor.

◆ vtkValuePass() [2/2]

vtkValuePass::vtkValuePass ( )
protected

Default constructor.

◆ ~vtkValuePass() [2/2]

virtual vtkValuePass::~vtkValuePass ( )
protectedvirtual

Destructor.

Member Function Documentation

◆ New() [1/2]

static vtkValuePass* vtkValuePass::New ( )
static

◆ IsTypeOf() [1/2]

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

◆ IsA() [1/2]

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

◆ SafeDownCast() [1/2]

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

◆ NewInstanceInternal() [1/2]

virtual vtkObjectBase* vtkValuePass::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDefaultPass.

◆ NewInstance() [1/2]

vtkValuePass* vtkValuePass::NewInstance ( ) const

◆ PrintSelf() [1/2]

void vtkValuePass::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 vtkDefaultPass.

◆ SetInputArrayToProcess() [1/4]

void vtkValuePass::SetInputArrayToProcess ( int  fieldAssociation,
const char *  name 
)

Set the array to be drawn.

◆ SetInputArrayToProcess() [2/4]

void vtkValuePass::SetInputArrayToProcess ( int  fieldAssociation,
int  fieldAttributeType 
)

◆ SetInputComponentToProcess() [1/2]

void vtkValuePass::SetInputComponentToProcess ( int  comp)

◆ SetScalarRange() [1/2]

void vtkValuePass::SetScalarRange ( double  min,
double  max 
)

◆ Render() [1/2]

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

Render.

Reimplemented from vtkDefaultPass.

◆ New() [2/2]

static vtkValuePass* vtkValuePass::New ( )
static

◆ IsTypeOf() [2/2]

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

◆ IsA() [2/2]

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

◆ SafeDownCast() [2/2]

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

◆ NewInstanceInternal() [2/2]

virtual vtkObjectBase* vtkValuePass::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDefaultPass.

◆ NewInstance() [2/2]

vtkValuePass* vtkValuePass::NewInstance ( ) const

◆ PrintSelf() [2/2]

void vtkValuePass::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 vtkDefaultPass.

◆ RENDER_VALUES()

static vtkInformationIntegerKey* vtkValuePass::RENDER_VALUES ( )
static

◆ SetRenderingMode()

virtual void vtkValuePass::SetRenderingMode ( int  )
virtual

◆ GetRenderingMode()

virtual int vtkValuePass::GetRenderingMode ( )
virtual

◆ SetInputArrayToProcess() [3/4]

void vtkValuePass::SetInputArrayToProcess ( int  fieldAssociation,
const char *  name 
)

◆ SetInputArrayToProcess() [4/4]

void vtkValuePass::SetInputArrayToProcess ( int  fieldAssociation,
int  fieldAttributeType 
)

◆ SetInputComponentToProcess() [2/2]

void vtkValuePass::SetInputComponentToProcess ( int  component)

◆ SetScalarRange() [2/2]

void vtkValuePass::SetScalarRange ( double  min,
double  max 
)

◆ SCALAR_MODE()

static vtkInformationIntegerKey* vtkValuePass::SCALAR_MODE ( )
static

Passed down the rendering pipeline to control what data array to draw.

◆ ARRAY_MODE()

static vtkInformationIntegerKey* vtkValuePass::ARRAY_MODE ( )
static

◆ ARRAY_ID()

static vtkInformationIntegerKey* vtkValuePass::ARRAY_ID ( )
static

◆ ARRAY_NAME()

static vtkInformationStringKey* vtkValuePass::ARRAY_NAME ( )
static

◆ ARRAY_COMPONENT()

static vtkInformationIntegerKey* vtkValuePass::ARRAY_COMPONENT ( )
static

◆ SCALAR_RANGE()

static vtkInformationDoubleVectorKey* vtkValuePass::SCALAR_RANGE ( )
static

◆ RELOAD_DATA()

static vtkInformationIntegerKey* vtkValuePass::RELOAD_DATA ( )
static

◆ Render() [2/2]

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

Perform rendering according to a render state s.

Precondition
s_exists: s!=0

Reimplemented from vtkDefaultPass.

◆ GetFloatImageDataArray()

vtkFloatArray* vtkValuePass::GetFloatImageDataArray ( vtkRenderer ren)

Interface to get the rendered image in FLOATING_POINT mode.

Returns a single component array containing the rendered values. The returned array is owned by vtkValuePass so it is intended to be deep copied.

◆ GetFloatImageData()

void vtkValuePass::GetFloatImageData ( int const  format,
int const  width,
int const  height,
void *  data 
)

Interface to get the rendered image in FLOATING_POINT mode.

Low level API, a format for the internal glReadPixels call can be specified. 'data' is expected to be allocated and cleaned-up by the caller.

◆ GetFloatImageExtents()

int* vtkValuePass::GetFloatImageExtents ( )

Interface to get the rendered image in FLOATING_POINT mode.

Image extents of the value array.

◆ IsFloatingPointModeSupported()

bool vtkValuePass::IsFloatingPointModeSupported ( vtkRenderWindow renWin)

◆ RenderOpaqueGeometry()

virtual void vtkValuePass::RenderOpaqueGeometry ( const vtkRenderState s)
protectedvirtual

Opaque pass with key checking.

Precondition
s_exists: s!=0

Reimplemented from vtkDefaultPass.

◆ BeginPass()

void vtkValuePass::BeginPass ( vtkRenderer ren)
protected

Manages graphics resources depending on the rendering mode.

Binds internal FBO when FLOATING_POINT mode is enabled.

◆ EndPass()

void vtkValuePass::EndPass ( )
protected

Unbinds internal FBO when FLOATING_POINT mode is enabled.

◆ HasWindowSizeChanged()

bool vtkValuePass::HasWindowSizeChanged ( vtkRenderer ren)
protected

Methods managing graphics resources required during FLOATING_POINT mode.

◆ InitializeFloatingPointMode()

bool vtkValuePass::InitializeFloatingPointMode ( vtkRenderer ren)
protected

◆ ReleaseFloatingPointMode()

void vtkValuePass::ReleaseFloatingPointMode ( vtkRenderer ren)
protected

Member Data Documentation

◆ RenderingMode

int vtkValuePass::RenderingMode
protected

Definition at line 153 of file vtkValuePass.h.


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