Renders geometry using the values of a field array as fragment colors. More...

#include <vtkValuePass.h>

Inheritance diagram for vtkValuePass:

Collaboration diagram for vtkValuePass:

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

vtkValuePass *	NewInstance () 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...

vtkFloatArray *	GetFloatImageDataArray (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...

int *	GetFloatImageExtents ()
	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
vtkOpenGLRenderPass *	NewInstance () 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
vtkRenderPass *	NewInstance () 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...

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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)
	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, 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)
	This method invokes an event and return whether the event was aborted or not. More...

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

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkValuePass *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkValuePass *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkOpenGLRenderPass
static vtkTypeBool	IsTypeOf (const char *type)

static vtkOpenGLRenderPass *	SafeDownCast (vtkObjectBase *o)

static vtkInformationObjectBaseVectorKey *	RenderPasses ()
	Key containing information about the current pass. More...

Static Public Member Functions inherited from vtkRenderPass
static vtkTypeBool	IsTypeOf (const char *type)

static vtkRenderPass *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () 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	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...


bool	HasWindowSizeChanged (vtkRenderer *ren)
	Methods managing graphics resources required during FLOATING_POINT mode. More...

bool	InitializeFBO (vtkRenderer *ren)
	Methods managing graphics resources required during FLOATING_POINT mode. More...

void	ReleaseFBO (vtkWindow *win)
	Methods managing graphics resources required during FLOATING_POINT mode. 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)
	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 ()
	These methods allow a command to exclusively grab all events. More...

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
vtkAtomicInt32	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:

INVERTIBLE_LUT Encodes array values as RGB data and renders the result to the default framebuffer. It uses a texture as a color LUT to map the values to RGB data. Texture size constraints limit its precision (currently 12-bit). The implementation of this mode is in vtkInternalsInvertible.
FLOATING_POINT Renders actual array values as floating point data to an internal RGBA32F framebuffer. This class binds and unbinds the framebuffer on each render pass. Resources are allocated on demand. When rendering point data values are uploaded to the GPU as vertex attributes. When rendering cell data values are uploaded as a texture buffer. Custom vertex and fragment shaders are defined in order to adjust its behavior for either type of data.

See also: vtkRenderPass vtkOpenGLRenderPass

Tests:: vtkValuePass (Tests)

Definition at line 62 of file vtkValuePass.h.

Member Typedef Documentation

typedef vtkOpenGLRenderPass vtkValuePass::Superclass

Definition at line 73 of file vtkValuePass.h.

Member Enumeration Documentation

enum vtkValuePass::Mode

Enumerator
INVERTIBLE_LUT
FLOATING_POINT

Definition at line 66 of file vtkValuePass.h.

Constructor & Destructor Documentation

vtkValuePass::vtkValuePass ( )

protected

vtkValuePass::~vtkValuePass ( )

overrideprotected

Member Function Documentation

static vtkValuePass* vtkValuePass::New ( )

static

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

static

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.

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

static

virtual vtkObjectBase* vtkValuePass::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkOpenGLRenderPass.

vtkValuePass* vtkValuePass::NewInstance ( ) const

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.

virtual void vtkValuePass::SetRenderingMode ( int )

virtual

virtual int vtkValuePass::GetRenderingMode ( )

virtual

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

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

void vtkValuePass::SetInputComponentToProcess ( int component )

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

void vtkValuePass::Render ( const vtkRenderState * s )

overridevirtual

Perform rendering according to a render state s.

Precondition: s_exists: s!=0

Implements vtkRenderPass.

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.

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.

int* vtkValuePass::GetFloatImageExtents ( )

Interface to get the rendered image in FLOATING_POINT mode.

Image extents of the value array.

bool vtkValuePass::IsFloatingPointModeSupported ( )

Check for extension support.

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.

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

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.

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.

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.

void vtkValuePass::BeginPass ( vtkRenderer * ren )

protected

Manages graphics resources depending on the rendering mode.

Binds internal FBO when FLOATING_POINT mode is enabled.

void vtkValuePass::EndPass ( )

protected

Unbinds internal FBO when FLOATING_POINT mode is enabled.

void vtkValuePass::RenderOpaqueGeometry ( const vtkRenderState * s )

protected

Opaque pass with key checking.

Precondition: s_exists: s!=0

void vtkValuePass::RenderPieceFinish ( )

protected

Unbind textures, etc.

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

protected

Upload new data if necessary, bind textures, etc.

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.

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

protected

Revert any changes made in BeginMapperRender.

void vtkValuePass::InitializeBuffers ( vtkRenderer * ren )

protected

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

protected

Add necessary shader definitions.

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

protected

Bind shader variables.

void vtkValuePass::BindUniforms ( vtkShaderProgram * prog )

protected

bool vtkValuePass::HasWindowSizeChanged ( vtkRenderer * ren )

protected

Methods managing graphics resources required during FLOATING_POINT mode.

bool vtkValuePass::InitializeFBO ( vtkRenderer * ren )

protected

Methods managing graphics resources required during FLOATING_POINT mode.

void vtkValuePass::ReleaseFBO ( vtkWindow * win )

protected

Methods managing graphics resources required during FLOATING_POINT mode.

Member Data Documentation

vtkInternalsFloat* vtkValuePass::ImplFloat

protected

Definition at line 221 of file vtkValuePass.h.

vtkInternalsInvertible* vtkValuePass::ImplInv

protected

Definition at line 224 of file vtkValuePass.h.

Parameters* vtkValuePass::PassState

protected

Definition at line 227 of file vtkValuePass.h.

int vtkValuePass::RenderingMode

protected

Definition at line 230 of file vtkValuePass.h.

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

/home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Rendering/OpenGL2/vtkValuePass.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation