helper to assist in simulating lighting similar to default OpenGL pipeline. More...

#include <vtkLightingHelper.h>

Inheritance diagram for vtkLightingHelper:

Collaboration diagram for vtkLightingHelper:

Public Types
enum	{ VTK_MAX_LIGHTS =8 }

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...

vtkLightingHelper *	NewInstance () const

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

void	EncodeLightState ()
	Encodes light state in diffuse component 3, where the shader looks for it. More...

void	PrepareForRendering ()


void	Initialize (vtkShaderProgram2 *shader, vtkShader2Type mode)
	Get/Set the shader program to which we want to add the lighting kernels. More...

virtual vtkShaderProgram2 *	GetShader ()
	Get/Set the shader program to which we want to add the lighting kernels. 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 vtkLightingHelper *	New ()

static int	IsTypeOf (const char *type)

static vtkLightingHelper *	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 Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkLightingHelper ()

	~vtkLightingHelper ()

void	SetShader (vtkShaderProgram2 *shader)

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

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

helper to assist in simulating lighting similar to default OpenGL pipeline.

vtkLightingHelper is an helper to assist in simulating lighting similar to default OpenGL pipeline. Look at vtkLightingHelper_s for available GLSL functions.

See also: vtkShaderProgram2

Tests:: vtkLightingHelper (Tests)

Definition at line 41 of file vtkLightingHelper.h.

Member Typedef Documentation

typedef vtkObject vtkLightingHelper::Superclass

Definition at line 45 of file vtkLightingHelper.h.

Member Enumeration Documentation

anonymous enum

Enumerator
VTK_MAX_LIGHTS

Definition at line 48 of file vtkLightingHelper.h.

Constructor & Destructor Documentation

vtkLightingHelper::vtkLightingHelper ( )

protected

vtkLightingHelper::~vtkLightingHelper ( )

protected

Member Function Documentation

static vtkLightingHelper* vtkLightingHelper::New ( )

static

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

static

virtual int vtkLightingHelper::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 vtkLightingHelper* vtkLightingHelper::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkLightingHelper::NewInstanceInternal ( ) const

protectedvirtual

vtkLightingHelper* vtkLightingHelper::NewInstance ( ) const

void vtkLightingHelper::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 vtkLightingHelper::Initialize	(	vtkShaderProgram2 *	shader,
		vtkShader2Type	mode
	)

Get/Set the shader program to which we want to add the lighting kernels.

mode = VTK_SHADER_TYPE_VERTEX or VTK_SHADER_TYPE_FRAGMENT depending on whether the vertex lighting or fragment lighting is to be used.

virtual vtkShaderProgram2* vtkLightingHelper::GetShader ( )

virtual

Get/Set the shader program to which we want to add the lighting kernels.

mode = VTK_SHADER_TYPE_VERTEX or VTK_SHADER_TYPE_FRAGMENT depending on whether the vertex lighting or fragment lighting is to be used.

void vtkLightingHelper::EncodeLightState ( )

inline

Encodes light state in diffuse component 3, where the shader looks for it.

Definition at line 66 of file vtkLightingHelper.h.

void vtkLightingHelper::PrepareForRendering ( )

void vtkLightingHelper::SetShader ( vtkShaderProgram2 * shader )

protected

Member Data Documentation

vtkShaderProgram2* vtkLightingHelper::Shader

protected

Definition at line 74 of file vtkLightingHelper.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation