IlvPointLight Class Reference

Point Light. More...

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

Inheritance diagram for IlvPointLight:

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. More...
void	getLightVector (IlFloat x, IlFloat y, IlFloat z, IlFloat *result)
	Returns the vector from this instance to a given point in 3D space. More...
IlFloat	getX () const
	Returns the x coordinate. More...
virtual void	getXYZ (IlFloat &x, IlFloat &y, IlFloat &z) const
	Returns the position. More...
IlFloat	getY () const
	Returns the y coordinate. More...
IlFloat	getZ () const
	Returns the z coordinate. More...
void	setX (IlFloat x)
	Sets the x coordinate. More...
virtual void	setXYZ (IlFloat x, IlFloat y, IlFloat z)
	Sets the position. More...
void	setY (IlFloat y)
	Sets the y coordinate. More...
void	setZ (IlFloat z)
	Sets the z coordinate. More...
void	update ()
	Called when the instance needs internal updating.
Public Member Functions inherited from IlvLightSource
	IlvLightSource (IlFloat r=1.0, IlFloat g=1.0, IlFloat b=1.0)
	Constructor. More...
virtual	~IlvLightSource ()
	Destructor. More...
IlFloat	getB () const
	Returns the blue component value. More...
IlFloat	getG () const
	Returns the green component value. More...
IlFloat	getR () const
	Returns the red component value. More...
void	setB (IlFloat b)
	Sets the blue component value. More...
void	setG (IlFloat g)
	Sets the green component value. More...
void	setR (IlFloat r)
	Sets the red component value. More...
Public Member Functions inherited from IlvValueInterface
virtual IlBoolean	applyValue (const IlvValue &value)
	Apply an accessor. More...
virtual IlBoolean	changeValue (const IlvValue &val)
	Changes the value of an accessor. More...
virtual IlBoolean	changeValues (const IlvValue *values, IlUShort count=0)
	Changes several accessor values simultaneously. More...
virtual void	getAccessors (const IlSymbol *const **names, const IlvValueTypeClass *const **types, IlUInt &count) const
	Retrieves the list of available accessors of an object. More...
virtual const char *	getName () const
	Returns the name of the instance. The semantic and implementation of this method are defined by concrete subclasses. The default implementation returns 0. More...
virtual IlvValue &	queryValue (IlvValue &val) const
	Retrieves an accessor value. More...
virtual void	queryValues (IlvValue *values, IlUShort count) const
	Retrieves multiple accessor values simultaneously. More...

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

getLightVector()

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.

getX()

IlFloat IlvPointLight::getX

(

)

const

Returns the x coordinate.

Returns

The x coordinate.

getXYZ()

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.

getY()

IlFloat IlvPointLight::getY

(

)

const

Returns the y coordinate.

Returns

The y coordinate.

getZ()

IlFloat IlvPointLight::getZ

(

)

const

Returns the z coordinate.

Returns

The z coordinate.

setX()

void IlvPointLight::setX

(

IlFloat

x

)

Sets the x coordinate.

Parameters

x	The new x coordinate.

setXYZ()

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.

setY()

void IlvPointLight::setY

(

IlFloat

y

)

Sets the y coordinate.

Parameters

y	The new y coordinate.

setZ()

void IlvPointLight::setZ

(

IlFloat

z

)

Sets the z coordinate.

Parameters

z	The new z coordinate.