Implementation of both rendering modes of vtkValuePass for the vtkOpenGLPolyDataMapper. More...

#include <vtkValuePassHelper.h>

Inheritance diagram for vtkValuePassHelper:

Collaboration diagram for vtkValuePassHelper:

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

vtkValuePassHelper *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. 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 ()

int	HasObserver (unsigned long event)

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

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

int	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 vtkValuePassHelper *	New ()

static int	IsTypeOf (const char *type)

static vtkValuePassHelper *	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

	vtkValuePassHelper ()

	~vtkValuePassHelper ()

virtual int	GetRenderingMode ()

void	UpdateConfiguration (vtkRenderer ren, vtkActor act, vtkMapper mapper, vtkPolyData input)
	Configure the internal state depending on the settings defined by the vtkValuePass (RenderingMode, RENDER_VALUES, SCALAR_MODE, etc.). More...

void	RenderPieceStart (vtkActor actor, vtkDataSet input)
	Upload new data if necessary, bind textures, etc. More...

void	UpdateShaders (std::string &VSSource, std::string &FSSource, std::string &required)
	Add necessary shader definitions. More...

void	RenderPieceFinish ()
	Unbind textures, etc. More...

bool	RequiresShaderRebuild ()
	Query whether a shader rebuild will be required. More...

void	ReleaseGraphicsResources (vtkWindow *win)


void	BindAttributes (vtkOpenGLHelper &cellBO)
	Bind shader variables. More...

void	BindUniforms (vtkOpenGLHelper &cellBO)
	Bind shader variables. 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 ()
	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 &)

Friends
class	vtkOpenGLPolyDataMapper

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Implementation of both rendering modes of vtkValuePass for the vtkOpenGLPolyDataMapper.

The mapper is intended to call various methods of this helper in order to setup the appropriate rendering state.

INVERTIBLE_LUT It uses a texture as a color LUT to map the values to RGB data. Texture size constraints limit its precision (currently 12-bit). Most of the implementation of this mode is in vtkMapper (InvertibleLookupTable) where the color LUT is generated.
FLOATING_POINT 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: vtkValuePass vtkOpenGLPolyDataMapper vtkMapper

Definition at line 52 of file vtkValuePassHelper.h.

Member Typedef Documentation

typedef vtkObject vtkValuePassHelper::Superclass

Definition at line 59 of file vtkValuePassHelper.h.

Constructor & Destructor Documentation

vtkValuePassHelper::vtkValuePassHelper ( )

protected

vtkValuePassHelper::~vtkValuePassHelper ( )

protected

Member Function Documentation

static vtkValuePassHelper* vtkValuePassHelper::New ( )

static

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

static

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

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

static

virtual vtkObjectBase* vtkValuePassHelper::NewInstanceInternal ( ) const

protectedvirtual

vtkValuePassHelper* vtkValuePassHelper::NewInstance ( ) const

void vtkValuePassHelper::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 vtkObject.

virtual int vtkValuePassHelper::GetRenderingMode ( )

protectedvirtual

void vtkValuePassHelper::UpdateConfiguration	(	vtkRenderer *	ren,
		vtkActor *	act,
		vtkMapper *	mapper,
		vtkPolyData *	input
	)

protected

Configure the internal state depending on the settings defined by the vtkValuePass (RenderingMode, RENDER_VALUES, SCALAR_MODE, etc.).

void vtkValuePassHelper::RenderPieceStart	(	vtkActor *	actor,
		vtkDataSet *	input
	)

protected

Upload new data if necessary, bind textures, etc.

void vtkValuePassHelper::UpdateShaders	(	std::string &	VSSource,
		std::string &	FSSource,
		std::string &	required
	)

protected

Add necessary shader definitions.

void vtkValuePassHelper::BindAttributes ( vtkOpenGLHelper & cellBO )

protected

Bind shader variables.

void vtkValuePassHelper::BindUniforms ( vtkOpenGLHelper & cellBO )

protected

Bind shader variables.

void vtkValuePassHelper::RenderPieceFinish ( )

protected

Unbind textures, etc.

bool vtkValuePassHelper::RequiresShaderRebuild ( )

protected

Query whether a shader rebuild will be required.

void vtkValuePassHelper::ReleaseGraphicsResources ( vtkWindow * win )

protected

Friends And Related Function Documentation

friend class vtkOpenGLPolyDataMapper

friend

Definition at line 54 of file vtkValuePassHelper.h.

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Rendering/OpenGL2/vtkValuePassHelper.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation