IlvDistantLight Class Reference

Distant Light. More...

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

Inheritance diagram for IlvDistantLight:

List of all members.

Public Member Functions
	IlvDistantLight (IlFloat azimuth=0.0, IlFloat elevation=0.0, IlFloat r=1.0, IlFloat g=1.0, IlFloat b=1.0)
	Constructor.
IlFloat	getAzimuth () const
	Returns the azimuth.
IlFloat	getElevation () const
	Returns the elevation.
void	getLightVector (IlFloat x, IlFloat y, IlFloat z, IlFloat *result)
	Returns the vector from this instance to a given point in 3D space.
void	setAzimuth (IlFloat azimuth)
	Sets the azimuth.
void	setElevation (IlFloat elevation)
	Sets the elevation.
void	update ()
	Called when the instance needs internal updating.

---

Detailed Description

Distant Light.

Library: ilvbmpflt

This class allows you to model an infinitely distant light using an elevation and an azimuth.

See also:

IlvDiffuseLightingFilter, IlvSpecularLightingFilter, IlvLightSource, IlvPointLight, IlvSpotLight

---

Constructor & Destructor Documentation

IlvDistantLight::IlvDistantLight	(	IlFloat	azimuth = 0.0,
		IlFloat	elevation = 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 azimuth and elevation are 0.0. The default light color is white.

---

Member Function Documentation

IlFloat IlvDistantLight::getAzimuth

(

)

const

Returns the azimuth.

Returns:

The azimuth.

IlFloat IlvDistantLight::getElevation

(

)

const

Returns the elevation.

Returns:

The elevation.

void IlvDistantLight::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.

void IlvDistantLight::setAzimuth

(

IlFloat

azimuth

)

Sets the azimuth.

Parameters:

azimuth

The new azimuth.

void IlvDistantLight::setElevation

(

IlFloat

elevation

)

Sets the elevation.

Parameters:

elevation

The new elevation.