VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
vtkColorMaterialHelper Class Reference

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

#include <vtkColorMaterialHelper.h>

Inheritance diagram for vtkColorMaterialHelper:
[legend]
Collaboration diagram for vtkColorMaterialHelper:
[legend]

Public Types

typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase 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 ()
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
vtkCommandGetCommand (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)
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 &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkColorMaterialHelperNew ()
static int IsTypeOf (const char *type)
static vtkColorMaterialHelperSafeDownCast (vtkObject *o)
- Static Public Member Functions inherited from vtkObject
static void BreakOnError ()
static void SetGlobalWarningDisplay (int val)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static int GetGlobalWarningDisplay ()

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 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 &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkShaderProgram2Shader
eMaterialParamater Mode
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

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.

Member Typedef Documentation

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

vtkShaderProgram2* vtkColorMaterialHelper::Shader
protected

Definition at line 61 of file vtkColorMaterialHelper.h.

eMaterialParamater vtkColorMaterialHelper::Mode
protected

Definition at line 72 of file vtkColorMaterialHelper.h.


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