GLSL uniform variables. More...

#include <vtkUniformVariables.h>

Inheritance diagram for vtkUniformVariables:

Collaboration diagram for vtkUniformVariables:

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

vtkUniformVariables *	NewInstance () const

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

void	SetUniformi (const char name, int numberOfComponents, int value)
	Set an integer uniform variable. More...

template<typename T >
void	SetUniformit (const char name, int numberOfComponents, T value)

template<typename T >
void	SetUniformit (const char *name, T value)

void	SetUniformf (const char name, int numberOfComponents, float value)
	Set an float uniform variable. More...

template<typename T >
void	SetUniformft (const char name, int numberOfComponents, T value)

template<typename T >
void	SetUniformft (const char *name, T value)

void	SetUniformiv (const char name, int numberOfComponents, int numberOfElements, int value)
	Set an array of integer uniform variables. More...

void	SetUniformfv (const char name, int numberOfComponents, int numberOfElements, float value)
	Set an array of float uniform variables. More...

void	SetUniformMatrix (const char name, int rows, int columns, float value)
	Set a matrix uniform variable. More...

void	RemoveUniform (const char *name)
	Remove uniform `name' from the list. More...

void	RemoveAllUniforms ()
	Remove all uniforms from the list. More...

void	Send (const char *name, int uniformIndex)

void	Start ()
	Place the internal cursor on the first uniform. More...

bool	IsAtEnd ()
	Is the iteration done? More...

const char *	GetCurrentName ()
	Name of the uniform at the current cursor position. More...

void	SendCurrentUniform (int uniformIndex)

void	Next ()
	Move the cursor to the next uniform. More...

void	DeepCopy (vtkUniformVariables *other)
	Copy all the variables from `other'. More...

void	Merge (vtkUniformVariables *other)
	Copy all the variables from `other'. 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 vtkUniformVariables *	New ()

static int	IsTypeOf (const char *type)

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

	vtkUniformVariables ()

virtual	~vtkUniformVariables ()

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

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

GLSL uniform variables.

vtkUniformVariables is a list of uniform variables attached to either a vtkShader2 object or to a vtkShaderProgram2. Uniform variables on a vtkShaderProgram2 override values of uniform variables on a vtkShader2.

See also: vtkShader2 vtkShaderProgram2

Tests:: vtkUniformVariables (Tests)

Definition at line 38 of file vtkUniformVariables.h.

Member Typedef Documentation

typedef vtkObject vtkUniformVariables::Superclass

Definition at line 42 of file vtkUniformVariables.h.

Constructor & Destructor Documentation

vtkUniformVariables::vtkUniformVariables ( )

protected

virtual vtkUniformVariables::~vtkUniformVariables ( )

protectedvirtual

Member Function Documentation

static vtkUniformVariables* vtkUniformVariables::New ( )

static

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

static

virtual int vtkUniformVariables::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 vtkUniformVariables* vtkUniformVariables::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkUniformVariables::NewInstanceInternal ( ) const

protectedvirtual

vtkUniformVariables* vtkUniformVariables::NewInstance ( ) const

void vtkUniformVariables::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.

void vtkUniformVariables::SetUniformi	(	const char *	name,
		int	numberOfComponents,
		int *	value
	)

Set an integer uniform variable.

Precondition: name_exists: name!=0; value_exists: value!=0; valid_numberOfComponents: numberOfComponents>=1 && numberOfComponents<=4

template<typename T >

void vtkUniformVariables::SetUniformit	(	const char *	name,
		int	numberOfComponents,
		T *	value
	)

Definition at line 194 of file vtkUniformVariables.h.

template<typename T >

void vtkUniformVariables::SetUniformit	(	const char *	name,
		T	value
	)

inline

Definition at line 61 of file vtkUniformVariables.h.

void vtkUniformVariables::SetUniformf	(	const char *	name,
		int	numberOfComponents,
		float *	value
	)

Set an float uniform variable.

Precondition: name_exists: name!=0; value_exists: value!=0; valid_numberOfComponents: numberOfComponents>=1 && numberOfComponents<=4

template<typename T >

void vtkUniformVariables::SetUniformft	(	const char *	name,
		int	numberOfComponents,
		T *	value
	)

Definition at line 208 of file vtkUniformVariables.h.

template<typename T >

void vtkUniformVariables::SetUniformft	(	const char *	name,
		T	value
	)

inline

Definition at line 80 of file vtkUniformVariables.h.

void vtkUniformVariables::SetUniformiv	(	const char *	name,
		int	numberOfComponents,
		int	numberOfElements,
		int *	value
	)

Set an array of integer uniform variables.

The array `value' is of size `numberOfElements'*`numberOfComponents.'.

Precondition: name_exists: name!=0; value_exists: value!=0; valid_numberOfComponents: numberOfComponents>=1 && numberOfComponents<=4; valid_numberOfElements: numberOfElements>=1

void vtkUniformVariables::SetUniformfv	(	const char *	name,
		int	numberOfComponents,
		int	numberOfElements,
		float *	value
	)

Set an array of float uniform variables.

The array `value' is of size `numberOfElements'*`numberOfComponents.'.

Precondition: name_exists: name!=0; value_exists: value!=0; valid_numberOfComponents: numberOfComponents>=1 && numberOfComponents<=4; valid_numberOfElements: numberOfElements>=1

void vtkUniformVariables::SetUniformMatrix	(	const char *	name,
		int	rows,
		int	columns,
		float *	value
	)

Set a matrix uniform variable.

Precondition: name_exists: name!=0; value_exists: value!=0; valid_rows: rows>=2 && rows<=4; valid_columns: columns>=2 && columns<=4

void vtkUniformVariables::RemoveUniform ( const char * name )

Remove uniform `name' from the list.

void vtkUniformVariables::RemoveAllUniforms ( )

Remove all uniforms from the list.

void vtkUniformVariables::Send	(	const char *	name,
		int	uniformIndex
	)

Precondition: need a valid OpenGL context and a shader program in use.

void vtkUniformVariables::Start ( )

Place the internal cursor on the first uniform.

bool vtkUniformVariables::IsAtEnd ( )

Is the iteration done?

const char* vtkUniformVariables::GetCurrentName ( )

Name of the uniform at the current cursor position.

Precondition: not_done: !this->IsAtEnd()

void vtkUniformVariables::SendCurrentUniform ( int uniformIndex )

Precondition: need a valid OpenGL context and a shader program in use.; not_done: !this->IsAtEnd()

void vtkUniformVariables::Next ( )

Move the cursor to the next uniform.

Precondition: not_done: !this->IsAtEnd()

void vtkUniformVariables::DeepCopy ( vtkUniformVariables * other )

Copy all the variables from `other'.

Any existing variable will be deleted first.

Precondition: other_exists: other!=0; not_self: other!=this

void vtkUniformVariables::Merge ( vtkUniformVariables * other )

Copy all the variables from `other'.

Any existing variable will be overwritten.

Precondition: other_exists: other!=0; not_self: other!=this

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Rendering/OpenGL/vtkUniformVariables.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation