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:

List of all members.

Public Types
enum	{ VTK_MAX_LIGHTS = 8 }
typedef vtkObject	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 ()
Static Public Member Functions
static vtkLightingHelper *	New ()
static int	IsTypeOf (const char *type)
static vtkLightingHelper *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkLightingHelper ()
	~vtkLightingHelper ()
void	SetShader (vtkShaderProgram2 *shader)
Protected Attributes
vtkShaderProgram2 *	Shader

---

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

Reimplemented from vtkObject.

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]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

static int vtkLightingHelper::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 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]

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkLightingHelper::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkObject.

vtkLightingHelper* vtkLightingHelper::NewInstance

(

)

const

Reimplemented from vtkObject.

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:

• dox/Rendering/OpenGL/vtkLightingHelper.h