Vis::Effect Class Reference

#include <VisEffect.h>

List of all members.

Public Member Functions

 Effect (const CGcontext &context, const string &filename)
virtual ~Effect ()
void setFirstPass ()
bool setNextPass ()
void beginPass ()
void endPass ()
void setTechnique (const string &name)
void setMatrixMVP (const string &name)
void setMatrixNormal (const string &name)
void setMatrixTexture (const string &name)
void setFloat1 (const string &name, const float value)
void setFloat3 (const string &name, const V3f &value)
void setTexture1D (const string &name, Texture1D &tex)
void setTexture2D (const string &name, Texture2D &tex)
void setTexture3D (const string &name, Texture3D &tex)


Detailed Description

Effect handling.

Constructor & Destructor Documentation

Vis::Effect::Effect ( const CGcontext &  context,
const string &  filename 
)

ctor.

Parameters:
context CG context
filename name of the effect file.

Vis::Effect::~Effect (  )  [virtual]

dtor.


Member Function Documentation

void Vis::Effect::beginPass (  ) 

Begin rendering for this pass and initialize states.

void Vis::Effect::endPass (  ) 

End rendering for this pass.

void Vis::Effect::setFirstPass (  ) 

Set the first rendering pass.

void Vis::Effect::setFloat1 ( const string &  name,
const float  value 
)

Set a single float value to an effect parameter.

Parameters:
associated parameter name single float value

void Vis::Effect::setFloat3 ( const string &  name,
const V3f &  value 
)

Set a V3f value for an effect parameter.

Parameters:
associated parameter name 3D vector

void Vis::Effect::setMatrixMVP ( const string &  name  ) 

Set the model-view-projection matrix to an affect parameter.

Parameters:
associated parameter name

void Vis::Effect::setMatrixNormal ( const string &  name  ) 

Set the normal matrix (inverse transpose model view matrix) to an affect parameter.

Parameters:
associated parameter name

void Vis::Effect::setMatrixTexture ( const string &  name  ) 

Set the texture matrix to an affect parameter.

Parameters:
associated parameter name

bool Vis::Effect::setNextPass (  ) 

Set the next rendering pass.

Returns:
true if another rendering pass exists, false otherwise.

void Vis::Effect::setTechnique ( const string &  name  ) 

Acitvate the effect technique.

Parameters:
name name of the technique.

void Vis::Effect::setTexture1D ( const string &  name,
Texture1D tex 
)

Set a texture to an effect parameter.

Parameters:
name associated parameter name
tex 1D Texture

void Vis::Effect::setTexture2D ( const string &  name,
Texture2D tex 
)

Set a texture to an effect parameter.

Parameters:
name associated parameter name
tex 2D Texture

void Vis::Effect::setTexture3D ( const string &  name,
Texture3D tex 
)

Set a texture to an effect parameter.

Parameters:
name associated parameter name
tex 3D Texture


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

Generated on Mon Jan 26 15:00:41 2009 for FlowVis by  doxygen 1.5.7.1