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

#include <vtkValuePass.h>

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

Public Types

enum  Mode { INVERTIBLE_LUT = 1, FLOATING_POINT = 2 }
 
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...
 
vtkValuePassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 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 fieldId)
 
void SetInputComponentToProcess (int component)
 
void SetScalarRange (double min, double max)
 
void Render (const vtkRenderState *s) override
 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 ()
 Check for extension support. More...
 
void ReleaseGraphicsResources (vtkWindow *win) override
 Release graphics resources and ask components to release their own resources. More...
 
void ColorToValue (unsigned char const *color, double const min, double const scale, double &value)
 Convert an RGB triplet to a floating point value. More...
 
- Public Member Functions inherited from vtkOpenGLRenderPass
vtkOpenGLRenderPassNewInstance () const
 
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 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...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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...
 

Static Public Member Functions

static vtkValuePassNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkValuePassSafeDownCast (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 ()
 
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
 
 vtkValuePass ()
 
 ~vtkValuePass () override
 
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...
 
void RenderOpaqueGeometry (const vtkRenderState *s)
 Opaque pass with key checking. More...
 
void RenderPieceFinish ()
 Unbind textures, etc. More...
 
void RenderPieceStart (vtkDataArray *dataArr, vtkMapper *m)
 Upload new data if necessary, bind textures, etc. More...
 
void BeginMapperRender (vtkMapper *mapper, vtkDataArray *dataArray, vtkProperty *property)
 Setup the mapper state, buffer objects or property variables necessary to render the active rendering mode. More...
 
void EndMapperRender (vtkMapper *mapper, vtkProperty *property)
 Revert any changes made in BeginMapperRender. More...
 
void InitializeBuffers (vtkRenderer *ren)
 
bool UpdateShaders (std::string &VSSource, std::string &FSSource)
 Add necessary shader definitions. More...
 
void BindAttributes (vtkShaderProgram *prog, vtkOpenGLVertexArrayObject *VAO)
 Bind shader variables. More...
 
void BindUniforms (vtkShaderProgram *prog)
 
bool HasWindowSizeChanged (vtkRenderer *ren)
 Methods managing graphics resources required during FLOATING_POINT mode. More...
 
bool InitializeFBO (vtkRenderer *ren)
 
void ReleaseFBO (vtkWindow *win)
 
bool PostReplaceShaderValues (std::string &vertexShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper *mapper, vtkProp *prop) override
 vtkOpenGLRenderPass API. More...
 
bool SetShaderParameters (vtkShaderProgram *program, vtkAbstractMapper *mapper, vtkProp *prop, vtkOpenGLVertexArrayObject *VAO=nullptr) override
 Update the uniforms of the shader program. More...
 
vtkMTimeType GetShaderStageMTime () override
 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...
 
- 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 ()
 
- 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

vtkInternalsFloat * ImplFloat
 
vtkInternalsInvertible * ImplInv
 
Parameters * PassState
 
int RenderingMode
 
- 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
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

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 vtkOpenGLRenderPass
Tests:
vtkValuePass (Tests)

Definition at line 64 of file vtkValuePass.h.

Member Typedef Documentation

◆ Superclass

Definition at line 75 of file vtkValuePass.h.

Member Enumeration Documentation

◆ Mode

Enumerator
INVERTIBLE_LUT 
FLOATING_POINT 

Definition at line 68 of file vtkValuePass.h.

Constructor & Destructor Documentation

◆ vtkValuePass()

vtkValuePass::vtkValuePass ( )
protected

◆ ~vtkValuePass()

vtkValuePass::~vtkValuePass ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkValuePass* vtkValuePass::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool 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 vtkOpenGLRenderPass.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkValuePass::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkOpenGLRenderPass.

◆ NewInstance()

vtkValuePass* vtkValuePass::NewInstance ( ) const

◆ PrintSelf()

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

◆ SetRenderingMode()

virtual void vtkValuePass::SetRenderingMode ( int  )
virtual

◆ GetRenderingMode()

virtual int vtkValuePass::GetRenderingMode ( )
virtual

◆ SetInputArrayToProcess() [1/2]

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

◆ SetInputArrayToProcess() [2/2]

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

◆ SetInputComponentToProcess()

void vtkValuePass::SetInputComponentToProcess ( int  component)

◆ SetScalarRange()

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

◆ Render()

void vtkValuePass::Render ( const vtkRenderState s)
overridevirtual

Perform rendering according to a render state s.

Precondition
s_exists: s!=0

Implements vtkRenderPass.

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

Warning
The returned array is owned by this class.

◆ 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 ( )

Check for extension support.

Deprecated:
As of 9.0, All platforms support FLOATING_POINT.

◆ ReleaseGraphicsResources()

void vtkValuePass::ReleaseGraphicsResources ( vtkWindow w)
overridevirtual

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

Default implementation is empty.

Precondition
w_exists: w!=0

Reimplemented from vtkRenderPass.

◆ ColorToValue()

void vtkValuePass::ColorToValue ( unsigned char const *  color,
double const  min,
double const  scale,
double value 
)

Convert an RGB triplet to a floating point value.

This method is exposed as a convenience function for testing (TestValuePass2).

Deprecated:
As of 9.0, not necessary with FLOATING_POINT.

◆ PostReplaceShaderValues()

bool vtkValuePass::PostReplaceShaderValues ( std::string &  vertexShader,
std::string &  geometryShader,
std::string &  fragmentShader,
vtkAbstractMapper mapper,
vtkProp prop 
)
overrideprotectedvirtual

vtkOpenGLRenderPass API.

Use vtkShaderProgram::Substitute to replace //VTK::XXX:YYY declarations in the shader sources. Gets called after other mapper shader replacements. Return false on error.

Reimplemented from vtkOpenGLRenderPass.

◆ SetShaderParameters()

bool vtkValuePass::SetShaderParameters ( vtkShaderProgram program,
vtkAbstractMapper mapper,
vtkProp prop,
vtkOpenGLVertexArrayObject VAO = nullptr 
)
overrideprotectedvirtual

Update the uniforms of the shader program.

Return false on error.

Reimplemented from vtkOpenGLRenderPass.

◆ GetShaderStageMTime()

vtkMTimeType vtkValuePass::GetShaderStageMTime ( )
overrideprotectedvirtual

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.

This method should return the last time that the shader stage changed, or 0 if the shader is single-stage.

Reimplemented from vtkOpenGLRenderPass.

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

◆ RenderOpaqueGeometry()

void vtkValuePass::RenderOpaqueGeometry ( const vtkRenderState s)
protected

Opaque pass with key checking.

Precondition
s_exists: s!=0

◆ RenderPieceFinish()

void vtkValuePass::RenderPieceFinish ( )
protected

Unbind textures, etc.

◆ RenderPieceStart()

void vtkValuePass::RenderPieceStart ( vtkDataArray dataArr,
vtkMapper m 
)
protected

Upload new data if necessary, bind textures, etc.

◆ BeginMapperRender()

void vtkValuePass::BeginMapperRender ( vtkMapper mapper,
vtkDataArray dataArray,
vtkProperty property 
)
protected

Setup the mapper state, buffer objects or property variables necessary to render the active rendering mode.

◆ EndMapperRender()

void vtkValuePass::EndMapperRender ( vtkMapper mapper,
vtkProperty property 
)
protected

Revert any changes made in BeginMapperRender.

◆ InitializeBuffers()

void vtkValuePass::InitializeBuffers ( vtkRenderer ren)
protected

◆ UpdateShaders()

bool vtkValuePass::UpdateShaders ( std::string &  VSSource,
std::string &  FSSource 
)
protected

Add necessary shader definitions.

◆ BindAttributes()

void vtkValuePass::BindAttributes ( vtkShaderProgram prog,
vtkOpenGLVertexArrayObject VAO 
)
protected

Bind shader variables.

◆ BindUniforms()

void vtkValuePass::BindUniforms ( vtkShaderProgram prog)
protected

◆ HasWindowSizeChanged()

bool vtkValuePass::HasWindowSizeChanged ( vtkRenderer ren)
protected

Methods managing graphics resources required during FLOATING_POINT mode.

◆ InitializeFBO()

bool vtkValuePass::InitializeFBO ( vtkRenderer ren)
protected

◆ ReleaseFBO()

void vtkValuePass::ReleaseFBO ( vtkWindow win)
protected

Member Data Documentation

◆ ImplFloat

vtkInternalsFloat* vtkValuePass::ImplFloat
protected

Definition at line 227 of file vtkValuePass.h.

◆ ImplInv

vtkInternalsInvertible* vtkValuePass::ImplInv
protected

Definition at line 230 of file vtkValuePass.h.

◆ PassState

Parameters* vtkValuePass::PassState
protected

Definition at line 233 of file vtkValuePass.h.

◆ RenderingMode

int vtkValuePass::RenderingMode
protected

Definition at line 236 of file vtkValuePass.h.


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