vtkUniformVariables Class Reference

GLSL uniform variables. More...

#include <vtkUniformVariables.h>

Inheritance diagram for vtkUniformVariables:

Collaboration diagram for vtkUniformVariables:

Public Types
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkUniformVariables *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
template<typename T >
void	SetUniformit (const char *name, int numberOfComponents, T *value)
template<typename T >
void	SetUniformit (const char *name, T value)
template<typename T >
void	SetUniformft (const char *name, int numberOfComponents, T *value)
template<typename T >
void	SetUniformft (const char *name, T value)
void	RemoveUniform (const char *name)
void	RemoveAllUniforms ()
void	Start ()
bool	IsAtEnd ()
const char *	GetCurrentName ()
void	SendCurrentUniform (int uniformIndex)
void	Next ()
void	DeepCopy (vtkUniformVariables *other)
void	Merge (vtkUniformVariables *other)
void	SetUniformi (const char *name, int numberOfComponents, int *value)
void	SetUniformf (const char *name, int numberOfComponents, float *value)
void	SetUniformiv (const char *name, int numberOfComponents, int numberOfElements, int *value)
void	SetUniformfv (const char *name, int numberOfComponents, int numberOfElements, float *value)
void	SetUniformMatrix (const char *name, int rows, int columns, float *value)
void	Send (const char *name, int uniformIndex)
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
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)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
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)
int	InvokeEvent (unsigned long event, void *callData)
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
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

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 int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkUniformVariables ()
virtual	~vtkUniformVariables ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
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 &)

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 37 of file vtkUniformVariables.h.

Member Typedef Documentation

typedef vtkObject vtkUniformVariables::Superclass

Definition at line 41 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 vtkObject.

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

static

virtual vtkObjectBase* vtkUniformVariables::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

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 169 of file vtkUniformVariables.h.

template<typename T >

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

inline

Definition at line 60 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 183 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/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/OpenGL/vtkUniformVariables.h