vtkLightingHelper Class Reference

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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkLightingHelper *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	Initialize (vtkShaderProgram2 *shader, vtkShader2Type mode)
virtual vtkShaderProgram2 *	GetShader ()
void	EncodeLightState ()
void	PrepareForRendering ()
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 vtkLightingHelper *	New ()
static int	IsTypeOf (const char *type)
static vtkLightingHelper *	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 Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkLightingHelper ()
	~vtkLightingHelper ()
void	SetShader (vtkShaderProgram2 *shader)
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
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 40 of file vtkLightingHelper.h.

Member Typedef Documentation

typedef vtkObject vtkLightingHelper::Superclass

Definition at line 44 of file vtkLightingHelper.h.

Member Enumeration Documentation

anonymous enum

Enumerator
VTK_MAX_LIGHTS

Definition at line 47 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 vtkObject.

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

static

virtual vtkObjectBase* vtkLightingHelper::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

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 63 of file vtkLightingHelper.h.

void vtkLightingHelper::PrepareForRendering

(

)

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

void vtkLightingHelper::SetShader ( vtkShaderProgram2 *  shader )

protected

Member Data Documentation

vtkShaderProgram2* vtkLightingHelper::Shader

protected

Definition at line 73 of file vtkLightingHelper.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/vtkLightingHelper.h