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:

Collaboration diagram for vtkColorMaterialHelper:

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

Public Member Functions
virtual int	IsA (const char *type)
vtkColorMaterialHelper *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	Initialize (vtkShaderProgram2 *)
virtual vtkShaderProgram2 *	GetShader ()
void	SetUniformVariables ()
void	PrepareForRendering ()
void	Render ()
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 vtkColorMaterialHelper *	New ()
static int	IsTypeOf (const char *type)
static vtkColorMaterialHelper *	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 Types
enum	eMaterialParamater {   DISABLED = 0, AMBIENT = 1, DIFFUSE = 2, SPECULAR = 3,   AMBIENT_AND_DIFFUSE = 4, EMISSION = 5 }

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

Protected Attributes
vtkShaderProgram2 *	Shader
eMaterialParamater	Mode
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	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 36 of file vtkColorMaterialHelper.h.

Member Typedef Documentation

typedef vtkObject vtkColorMaterialHelper::Superclass

Definition at line 40 of file vtkColorMaterialHelper.h.

Member Enumeration Documentation

enum vtkColorMaterialHelper::eMaterialParamater

protected

Enumerator
DISABLED
AMBIENT
DIFFUSE
SPECULAR
AMBIENT_AND_DIFFUSE
EMISSION

Definition at line 69 of file vtkColorMaterialHelper.h.

Constructor & Destructor Documentation

vtkColorMaterialHelper::vtkColorMaterialHelper ( )

protected

vtkColorMaterialHelper::~vtkColorMaterialHelper ( )

protected

Member Function Documentation

static vtkColorMaterialHelper* vtkColorMaterialHelper::New ( )

static

static int vtkColorMaterialHelper::IsTypeOf ( const char *  type )

static

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 ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkColorMaterialHelper::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkColorMaterialHelper* vtkColorMaterialHelper::NewInstance

(

)

const

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::SetUniformVariables

(

)

Capture current OpenGL state and initialize uniform variables used by the helper shader.

void vtkColorMaterialHelper::PrepareForRendering

(

)

Captures current OpenGL state. DEPRECATED (Use PrepareForRendering2 instead)

void vtkColorMaterialHelper::Render

(

)

Initializes uniform variables with the last captured OpenGL state. NOTHING IS RENDERED THIS SETS UNIFORMS. DEPRECATED: Use SetUnformVariables instead.

void vtkColorMaterialHelper::SetShader ( vtkShaderProgram2 *  )

protected

Member Data Documentation

vtkShaderProgram2* vtkColorMaterialHelper::Shader

protected

Definition at line 67 of file vtkColorMaterialHelper.h.

eMaterialParamater vtkColorMaterialHelper::Mode

protected

Definition at line 78 of file vtkColorMaterialHelper.h.

---

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/vtkColorMaterialHelper.h