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 Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkColorMaterialHelper *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

void	Initialize (vtkShaderProgram2 *)

virtual vtkShaderProgram2 *	GetShader ()

void	SetUniformVariables ()
	Capture current OpenGL state and initialize uniform variables used by the helper shader. More...

void	PrepareForRendering ()
	Captures current OpenGL state. More...

void	Render ()
	Initializes uniform variables with the last captured OpenGL state. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

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 vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

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 ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

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 37 of file vtkColorMaterialHelper.h.

Member Typedef Documentation

typedef vtkObject vtkColorMaterialHelper::Superclass

Definition at line 41 of file vtkColorMaterialHelper.h.

Member Enumeration Documentation

enum vtkColorMaterialHelper::eMaterialParamater

protected

Enumerator
DISABLED
AMBIENT
DIFFUSE
SPECULAR
AMBIENT_AND_DIFFUSE
EMISSION

Definition at line 74 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 vtkObjectBase.

static vtkColorMaterialHelper* vtkColorMaterialHelper::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkColorMaterialHelper::NewInstanceInternal ( ) const

protectedvirtual

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 72 of file vtkColorMaterialHelper.h.

eMaterialParamater vtkColorMaterialHelper::Mode

protected

Definition at line 83 of file vtkColorMaterialHelper.h.

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Rendering/OpenGL/vtkColorMaterialHelper.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation