vtkUniformVariables Class Reference

#include <vtkUniformVariables.h>

Inheritance diagram for vtkUniformVariables:

[legend]

Collaboration diagram for vtkUniformVariables:

[legend]

List of all members.

---

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

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
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)
Static Public Member Functions
static vtkUniformVariables *	New ()
static int	IsTypeOf (const char *type)
static vtkUniformVariables *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkUniformVariables ()
virtual	~vtkUniformVariables ()

---

Member Typedef Documentation

typedef vtkObject vtkUniformVariables::Superclass

Reimplemented from vtkObject.

Definition at line 40 of file vtkUniformVariables.h.

---

Constructor & Destructor Documentation

vtkUniformVariables::vtkUniformVariables

(

)

[protected]

virtual vtkUniformVariables::~vtkUniformVariables

(

)

[protected, virtual]

---

Member Function Documentation

static vtkUniformVariables* vtkUniformVariables::New

(

)

[static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkUniformVariables::GetClassName

(

)

[virtual]

Reimplemented from vtkObject.

static int vtkUniformVariables::IsTypeOf

(

const char *

name

)

[static]

Return 1 if this class type 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.

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

(

vtkObject *

o

)

[static]

Reimplemented from vtkObject.

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

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

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:

• dox/Rendering/vtkUniformVariables.h