IlvPointLight Class Reference

Point Light. More...

#include <ilviews/bitmaps/filters/lights.h>

Inheritance diagram for IlvPointLight:

List of all members.

Public Member Functions
	IlvPointLight (IlFloat x=0.0, IlFloat y=0.0, IlFloat z=0.0, IlFloat r=1.0, IlFloat g=1.0, IlFloat b=1.0)
	Constructor.
void	getLightVector (IlFloat x, IlFloat y, IlFloat z, IlFloat *result)
	Returns the vector from this instance to a given point in 3D space.
IlFloat	getX () const
	Returns the x coordinate.
virtual void	getXYZ (IlFloat &x, IlFloat &y, IlFloat &z) const
	Returns the position.
IlFloat	getY () const
	Returns the y coordinate.
IlFloat	getZ () const
	Returns the z coordinate.
void	setX (IlFloat x)
	Sets the x coordinate.
virtual void	setXYZ (IlFloat x, IlFloat y, IlFloat z)
	Sets the position.
void	setY (IlFloat y)
	Sets the y coordinate.
void	setZ (IlFloat z)
	Sets the z coordinate.
void	update ()
	Called when the instance needs internal updating.

---

Detailed Description

Point Light.

Library: ilvbmpflt

This class allows you to model a positional light using three coordinates.

See also:

IlvDiffuseLightingFilter, IlvSpecularLightingFilter, IlvLightSource, IlvDistantLight, IlvSpotLight

---

Constructor & Destructor Documentation

IlvPointLight::IlvPointLight	(	IlFloat	x = 0.0,
		IlFloat	y = 0.0,
		IlFloat	z = 0.0,
		IlFloat	r = 1.0,
		IlFloat	g = 1.0,
		IlFloat	b = 1.0
	)

Constructor.

Initializes a new instance of the class IlvDistantLight.

The default position is <0,0,0>. The default light color is white.

---

Member Function Documentation

void IlvPointLight::getLightVector	(	IlFloat	x,
		IlFloat	y,
		IlFloat	z,
		IlFloat *	result
	)			[virtual]

Returns the vector from this instance to a given point in 3D space.

Parameters:

	x	The x position of the point.
	y	The y position of the point.
	z	The z position of the point.
	result	An array of 3 floating point values that will hold the vector.

Reimplemented from IlvLightSource.

Reimplemented in IlvSpotLight.

IlFloat IlvPointLight::getX

(

)

const

Returns the x coordinate.

Returns:

The x coordinate.

virtual void IlvPointLight::getXYZ	(	IlFloat &	x,
		IlFloat &	y,
		IlFloat &	z
	)			const [virtual]

Returns the position.

Parameters:

	x	The x coordinate.
	y	The y coordinate.
	z	The z coordinate.

IlFloat IlvPointLight::getY

(

)

const

Returns the y coordinate.

Returns:

The y coordinate.

IlFloat IlvPointLight::getZ

(

)

const

Returns the z coordinate.

Returns:

The z coordinate.

void IlvPointLight::setX

(

IlFloat

x

)

Sets the x coordinate.

Parameters:

x

The new x coordinate.

virtual void IlvPointLight::setXYZ	(	IlFloat	x,
		IlFloat	y,
		IlFloat	z
	)			[virtual]

Sets the position.

Parameters:

	x	The x coordinate.
	y	The y coordinate.
	z	The z coordinate.

void IlvPointLight::setY

(

IlFloat

y

)

Sets the y coordinate.

Parameters:

y

The new y coordinate.

void IlvPointLight::setZ

(

IlFloat

z

)

Sets the z coordinate.

Parameters:

z

The new z coordinate.