helper class to set custom uniform variables in GPU shaders. More...

#include <vtkUniforms.h>

Inheritance diagram for vtkUniforms:

Collaboration diagram for vtkUniforms:

Public Types
enum	TupleType { TupleTypeInvalid = 0 , TupleTypeScalar , TupleTypeVector , TupleTypeMatrix , NumberOfTupleTypes }
	Types of tuples that can be stored : scalar, vector, matrix. More...

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.

vtkUniforms *	NewInstance () const

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

virtual vtkMTimeType	GetUniformListMTime ()=0

virtual void	RemoveUniform (const char *name)=0
	Remove uniform variable named `name`.

virtual void	RemoveAllUniforms ()=0
	Remove all uniform variables.

virtual int	GetNumberOfUniforms ()=0
	Get number of all uniforms stored in this class.

virtual const char *	GetNthUniformName (vtkIdType uniformIndex)=0
	Get number of all uniforms stored in this class.

virtual int	GetUniformScalarType (const char *name)=0
	Get type of scalars stored in uniform `name`.

virtual TupleType	GetUniformTupleType (const char *name)=0
	Get the tuple type stored in uniform `name`.

virtual int	GetUniformNumberOfComponents (const char *name)=0
	Get the number of components stored in each tuple of uniform `name`.

virtual int	GetUniformNumberOfTuples (const char *name)=0
	Number of tuples of uniform `name` that contains a variable-size vector.


virtual void	SetUniform (const char *name, vtkUniforms::TupleType tt, int nbComponents, const std::vector< int > &value)=0
	Generic setters and getter.

virtual void	SetUniform (const char *name, vtkUniforms::TupleType tt, int nbComponents, const std::vector< float > &value)=0
	Generic setters and getter.

virtual bool	GetUniform (const char *name, std::vector< int > &value)=0
	Generic setters and getter.

virtual bool	GetUniform (const char *name, std::vector< float > &value)=0
	Generic setters and getter.


virtual void	SetUniformi (const char *name, int v)=0
	Set the `name` uniform value to `v`.

virtual void	SetUniformf (const char *name, float v)=0
	Set the `name` uniform value to `v`.

virtual void	SetUniform2i (const char *name, const int v[2])=0
	Set the `name` uniform value to `v`.

virtual void	SetUniform2f (const char *name, const float v[2])=0
	Set the `name` uniform value to `v`.

virtual void	SetUniform3f (const char *name, const float v[3])=0
	Set the `name` uniform value to `v`.

virtual void	SetUniform4f (const char *name, const float v[4])=0
	Set the `name` uniform value to `v`.

virtual void	SetUniformMatrix3x3 (const char name, float v)=0
	Set the `name` uniform value to `v`.

virtual void	SetUniformMatrix4x4 (const char name, float v)=0
	Set the `name` uniform value to `v`.


virtual void	SetUniform1iv (const char name, int count, const int f)=0
	Set the `name` uniform array to `f` with `count` elements.

virtual void	SetUniform1fv (const char name, int count, const float f)=0
	Set the `name` uniform array to `f` with `count` elements.

virtual void	SetUniform2fv (const char name, int count, const float(f)[2])=0
	Set the `name` uniform array to `f` with `count` elements.

virtual void	SetUniform3fv (const char name, int count, const float(f)[3])=0
	Set the `name` uniform array to `f` with `count` elements.

virtual void	SetUniform4fv (const char name, int count, const float(f)[4])=0
	Set the `name` uniform array to `f` with `count` elements.

virtual void	SetUniformMatrix4x4v (const char name, int count, float v)=0
	Set the `name` uniform array to `f` with `count` elements.


virtual void	SetUniform3f (const char *name, const double v[3])=0
	Set the `name` uniform to `v`.

virtual void	SetUniform3uc (const char *name, const unsigned char v[3])=0
	Set the `name` uniform to `v`.

virtual void	SetUniform4uc (const char *name, const unsigned char v[4])=0
	Set the `name` uniform to `v`.

virtual void	SetUniformMatrix (const char name, vtkMatrix3x3 v)=0
	Set the `name` uniform to `v`.

virtual void	SetUniformMatrix (const char name, vtkMatrix4x4 v)=0
	Set the `name` uniform to `v`.


virtual bool	GetUniformi (const char *name, int &v)=0
	Get the `name` uniform value.

virtual bool	GetUniformf (const char *name, float &v)=0
	Get the `name` uniform value.

virtual bool	GetUniform2i (const char *name, int v[2])=0
	Get the `name` uniform value.

virtual bool	GetUniform2f (const char *name, float v[2])=0
	Get the `name` uniform value.

virtual bool	GetUniform3f (const char *name, float v[3])=0
	Get the `name` uniform value.

virtual bool	GetUniform4f (const char *name, float v[4])=0
	Get the `name` uniform value.

virtual bool	GetUniformMatrix3x3 (const char name, float v)=0
	Get the `name` uniform value.

virtual bool	GetUniformMatrix4x4 (const char name, float v)=0
	Get the `name` uniform value.


virtual bool	GetUniform3f (const char *name, double v[3])=0
	Get the `name` uniform to `v`.

virtual bool	GetUniform3uc (const char *name, unsigned char v[3])=0
	Get the `name` uniform to `v`.

virtual bool	GetUniform4uc (const char *name, unsigned char v[4])=0
	Get the `name` uniform to `v`.

virtual bool	GetUniformMatrix (const char name, vtkMatrix3x3 v)=0
	Get the `name` uniform to `v`.

virtual bool	GetUniformMatrix (const char name, vtkMatrix4x4 v)=0
	Get the `name` uniform to `v`.


virtual bool	GetUniform1iv (const char *name, std::vector< int > &f)=0
	Get the `name` uniform vector to `f` with.

virtual bool	GetUniform1fv (const char *name, std::vector< float > &f)=0
	Get the `name` uniform vector to `f` with.

virtual bool	GetUniform2fv (const char *name, std::vector< float > &f)=0
	Get the `name` uniform vector to `f` with.

virtual bool	GetUniform3fv (const char *name, std::vector< float > &f)=0
	Get the `name` uniform vector to `f` with.

virtual bool	GetUniform4fv (const char *name, std::vector< float > &f)=0
	Get the `name` uniform vector to `f` with.

virtual bool	GetUniformMatrix4x4v (const char *name, std::vector< float > &f)=0
	Get the `name` uniform vector to `f` with.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

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

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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

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

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

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

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

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

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.

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.

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.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

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

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

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkUniforms *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkUniforms *	SafeDownCast (vtkObjectBase *o)

static std::string	TupleTypeToString (TupleType tt)
	Convert between TupleType and string.

static TupleType	StringToTupleType (const std::string &s)

static std::string	ScalarTypeToString (int scalarType)
	Convert between scalar types an string.

static int	StringToScalarType (const std::string &s)

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.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

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

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

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

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

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.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkUniforms ()=default

	~vtkUniforms () override=default

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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

helper class to set custom uniform variables in GPU shaders.

This class implements a generic mechanism to declare and set the value of custom uniform variables to be used in GPU shader programs used by mappers. It allows users who specify custom shader code for mappers to change the value of the variable they define without triggering a costly rebuild of the shader. This class is used mostly as an interface and the implementation is found in graphics api specific derived classes (e.g.: vtkOpenGLUniforms).

See also: vtkOpenGLUniforms vtkShaderProperty

Thanks:: Developed by Simon Drouin (sdrou.nosp@m.in2@.nosp@m.bwh.h.nosp@m.arva.nosp@m.rd.ed.nosp@m.u) at Brigham and Women's Hospital.

Definition at line 32 of file vtkUniforms.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkUniforms::Superclass

Definition at line 36 of file vtkUniforms.h.

Member Enumeration Documentation

◆ TupleType

enum vtkUniforms::TupleType

Types of tuples that can be stored : scalar, vector, matrix.

Enumerator
TupleTypeInvalid
TupleTypeScalar
TupleTypeVector
TupleTypeMatrix
NumberOfTupleTypes

Definition at line 46 of file vtkUniforms.h.

Constructor & Destructor Documentation

◆ vtkUniforms()

vtkUniforms::vtkUniforms ( )

protecteddefault

◆ ~vtkUniforms()

vtkUniforms::~vtkUniforms ( )

overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkUniforms * vtkUniforms::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkUniforms::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.

Reimplemented in vtkOpenGLUniforms.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkUniforms::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkOpenGLUniforms.

◆ NewInstance()

vtkUniforms * vtkUniforms::NewInstance ( ) const

◆ PrintSelf()

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

◆ GetUniformListMTime()

virtual vtkMTimeType vtkUniforms::GetUniformListMTime ( )

pure virtual

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ TupleType

Constructor & Destructor Documentation

◆ vtkUniforms()

◆ ~vtkUniforms()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetUniformListMTime()

◆ TupleTypeToString()

◆ StringToTupleType()

◆ ScalarTypeToString()

◆ StringToScalarType()

◆ RemoveUniform()

◆ RemoveAllUniforms()

◆ SetUniform() [1/2]

◆ SetUniform() [2/2]

◆ GetUniform() [1/2]

◆ GetUniform() [2/2]

◆ SetUniformi()

◆ SetUniformf()

◆ SetUniform2i()

◆ SetUniform2f()

◆ SetUniform3f() [1/2]

◆ SetUniform4f()

◆ SetUniformMatrix3x3()

◆ SetUniformMatrix4x4()

◆ SetUniform1iv()

◆ SetUniform1fv()

◆ SetUniform2fv()

◆ SetUniform3fv()

◆ SetUniform4fv()

◆ SetUniformMatrix4x4v()

◆ SetUniform3f() [2/2]

◆ SetUniform3uc()

◆ SetUniform4uc()

◆ SetUniformMatrix() [1/2]

◆ SetUniformMatrix() [2/2]

◆ GetUniformi()

◆ GetUniformf()

◆ GetUniform2i()

◆ GetUniform2f()

◆ GetUniform3f() [1/2]

◆ GetUniform4f()

◆ GetUniformMatrix3x3()

◆ GetUniformMatrix4x4()

◆ GetUniform3f() [2/2]

◆ GetUniform3uc()

◆ GetUniform4uc()

◆ GetUniformMatrix() [1/2]

◆ GetUniformMatrix() [2/2]

◆ GetUniform1iv()

◆ GetUniform1fv()

◆ GetUniform2fv()

◆ GetUniform3fv()

◆ GetUniform4fv()

◆ GetUniformMatrix4x4v()

◆ GetNumberOfUniforms()

◆ GetNthUniformName()

◆ GetUniformScalarType()

◆ GetUniformTupleType()

◆ GetUniformNumberOfComponents()

◆ GetUniformNumberOfTuples()