vtkColorMaterialHelper Class Reference

#include <vtkColorMaterialHelper.h>

Inheritance diagram for vtkColorMaterialHelper:

Inheritance graph
[legend]
Collaboration diagram for vtkColorMaterialHelper:

Collaboration graph
[legend]

List of all members.


Detailed Description

a helper to assist in simulating the ColorMaterial behaviour of the default OpenGL pipeline.

vtkColorMaterialHelper is a helper to assist in simulating the ColorMaterial behaviour of the default OpenGL pipeline. Look at vtkColorMaterialHelper_s for available GLSL functions.

See also:
vtkShaderProgram2

Definition at line 35 of file vtkColorMaterialHelper.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 Initialize (vtkShaderProgram2 *)
virtual vtkShaderProgram2GetShader ()
void PrepareForRendering ()
void Render ()

Static Public Member Functions

static vtkColorMaterialHelperNew ()
static int IsTypeOf (const char *type)
static vtkColorMaterialHelperSafeDownCast (vtkObject *o)

Protected Types

enum  eMaterialParamater {
  DISABLED = 0, AMBIENT = 1, DIFFUSE = 2, SPECULAR = 3,
  AMBIENT_AND_DIFFUSE = 4, EMISSION = 5
}

Protected Member Functions

 vtkColorMaterialHelper ()
 ~vtkColorMaterialHelper ()
void SetShader (vtkShaderProgram2 *)

Protected Attributes

vtkShaderProgram2Shader
eMaterialParamater Mode

Member Typedef Documentation

Reimplemented from vtkObject.

Definition at line 39 of file vtkColorMaterialHelper.h.


Member Enumeration Documentation

Enumerator:
DISABLED 
AMBIENT 
DIFFUSE 
SPECULAR 
AMBIENT_AND_DIFFUSE 
EMISSION 

Definition at line 63 of file vtkColorMaterialHelper.h.


Constructor & Destructor Documentation

vtkColorMaterialHelper::vtkColorMaterialHelper (  )  [protected]

vtkColorMaterialHelper::~vtkColorMaterialHelper (  )  [protected]


Member Function Documentation

static vtkColorMaterialHelper* vtkColorMaterialHelper::New (  )  [static]

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

Reimplemented from vtkObject.

virtual const char* vtkColorMaterialHelper::GetClassName (  )  [virtual]

Reimplemented from vtkObject.

static int vtkColorMaterialHelper::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 vtkColorMaterialHelper::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 vtkColorMaterialHelper* vtkColorMaterialHelper::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkObject.

void vtkColorMaterialHelper::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 vtkColorMaterialHelper::Initialize ( vtkShaderProgram2  ) 

virtual vtkShaderProgram2* vtkColorMaterialHelper::GetShader (  )  [virtual]

void vtkColorMaterialHelper::PrepareForRendering (  ) 

Prepares the shader i.e. reads color material parameters state from OpenGL. This must be called before the shader is bound.

void vtkColorMaterialHelper::Render (  ) 

Uploads any uniforms needed. This must be called only after the shader has been bound, but before rendering the geometry.

void vtkColorMaterialHelper::SetShader ( vtkShaderProgram2  )  [protected]


Member Data Documentation

Definition at line 61 of file vtkColorMaterialHelper.h.

Definition at line 72 of file vtkColorMaterialHelper.h.


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

Generated on Wed Aug 24 11:31:31 2011 for VTK by  doxygen 1.5.6