Home

nevrax.com

Nevrax.org

	News
	Mailing-list
	Documentation
	CVS
	Bugs
	License

Documentation

Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages Search

NL3D::CLightUser Class Reference

ULight implementation. More...

#include <light_user.h>

Inheritance diagram for NL3D::CLightUser:

List of all members.

Public Methods
Quick setup.
void	setupDirectional (const NLMISC::CRGBA &ambiant, const NLMISC::CRGBA &diffuse, const NLMISC::CRGBA &specular, const NLMISC::CVector &direction, float constant=1, float linear=0, float quadratic=0)
	Quick setup a directional light. More...
void	setupPointLight (const NLMISC::CRGBA &ambiant, const NLMISC::CRGBA &diffuse, const NLMISC::CRGBA &specular, const NLMISC::CVector &position, const NLMISC::CVector &direction, float constant=1, float linear=0, float quadratic=0)
	Quick setup a point light. More...
void	setupSpotLight (const NLMISC::CRGBA &ambiant, const NLMISC::CRGBA &diffuse, const NLMISC::CRGBA &specular, const NLMISC::CVector &position, const NLMISC::CVector &direction, float exponent, float cutoff, float constant=1, float linear=0, float quadratic=0)
	Quick setup a spotlight. More...
void	setupAttenuation (float farAttenuationBegin, float farAttenuationEnd)
	Setup attenuation with begin and end attenuation distance. More...
void	setNoAttenuation ()
	Set no attenuation. More...
void	setupSpotExponent (float hotSpotAngle)
	Setup spot exponent with angle of the hotspot. More...
Set methods.
void	setMode (ULight::TLightMode mode)
	Set the light mode. More...
void	setAmbiant (const NLMISC::CRGBA &ambiant)
	Set the ambiant color of the light. More...
void	setDiffuse (const NLMISC::CRGBA &diffuse)
	Set the diffuse color of the light. More...
void	setSpecular (const NLMISC::CRGBA &specular)
	Set the specular color of the light. More...
void	setPosition (const NLMISC::CVector &position)
	Set the position of the light. More...
void	setDirection (const NLMISC::CVector &direction)
	Set the direction of the light. More...
void	setExponent (float exponent)
	Set the Intensity distribution of the light. More...
void	setCutoff (float cutoff)
	Set the cutoff of the light in radian. More...
void	setConstantAttenuation (float constant)
	Set constant attenuation. More...
void	setLinearAttenuation (float linear)
	Set linear attenuation. More...
void	setQuadraticAttenuation (float quadratic)
	Set quadratic attenuation. More...
Get methods.
ULight::TLightMode	getMode () const
	Get the light mode. More...
NLMISC::CRGBA	getAmbiant () const
	Get the ambiant color of the light. More...
NLMISC::CRGBA	getDiffuse () const
	Get the diffuse color of the light. More...
NLMISC::CRGBA	getSpecular () const
	Get the specular color of the light. More...
NLMISC::CVector	getPosition () const
	Get the position of the light. More...
NLMISC::CVector	getDirection () const
	Get the direction of the light. More...
float	getExponent () const
	Get the exponent of the light. More...
float	getCutoff () const
	Get the cutoff of the light in radian. More...
float	getConstantAttenuation () const
	Get constant attenuation. More...
float	getLinearAttenuation () const
	Get linear attenuation. More...
float	getQuadraticAttenuation () const
	Get quadratic attenuation. More...
Protected Attributes
CLight	_Light
Friends
class	CDriverUser

Detailed Description

ULight implementation.

Author:: Lionel Berenguier , Nevrax France

Date:: 2001

Definition at line 48 of file light_user.h.

Member Function Documentation

NLMISC::CRGBA NL3D::CLightUser::getAmbiant ( ) const [inline, virtual]

Get the ambiant color of the light.

Implements NL3D::ULight.
Definition at line 253 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

float NL3D::CLightUser::getConstantAttenuation ( ) const [inline, virtual]

Get constant attenuation.
The intensity of the light is attenuated this way: light_intensity = light_intensity / ( CONSTANT_ATTENUATION + vertex_light_distance * LINEAR_ATTENUATION + vertex_light_distance * vertex_light_distance * QUADRATIC_ATTENUATION );
Implements NL3D::ULight.
Definition at line 320 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

float NL3D::CLightUser::getCutoff ( ) const [inline, virtual]

Get the cutoff of the light in radian.
Should be between [0, Pi/2]. Used only for SpotLight.
Implements NL3D::ULight.
Definition at line 307 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

NLMISC::CRGBA NL3D::CLightUser::getDiffuse ( ) const [inline, virtual]

Get the diffuse color of the light.

Implements NL3D::ULight.
Definition at line 262 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

NLMISC::CVector NL3D::CLightUser::getDirection ( ) const [inline, virtual]

Get the direction of the light.
Used only for DirectionalLight and SpotLight.
Implements NL3D::ULight.
Definition at line 289 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

float NL3D::CLightUser::getExponent ( ) const [inline, virtual]

Get the exponent of the light.
Used only for SpotLight.
Implements NL3D::ULight.
Definition at line 298 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

float NL3D::CLightUser::getLinearAttenuation ( ) const [inline, virtual]

Get linear attenuation.
The intensity of the light is attenuated this way: light_intensity = light_intensity / ( CONSTANT_ATTENUATION + vertex_light_distance * LINEAR_ATTENUATION + vertex_light_distance * vertex_light_distance * QUADRATIC_ATTENUATION );
Implements NL3D::ULight.
Definition at line 333 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

ULight::TLightMode NL3D::CLightUser::getMode ( ) const [inline, virtual]

Get the light mode.

Implements NL3D::ULight.
Definition at line 244 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

NLMISC::CVector NL3D::CLightUser::getPosition ( ) const [inline, virtual]

Get the position of the light.
Used only for SpotLight and PointLight.
Implements NL3D::ULight.
Definition at line 280 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

float NL3D::CLightUser::getQuadraticAttenuation ( ) const [inline, virtual]

Get quadratic attenuation.
The intensity of the light is attenuated this way: light_intensity = light_intensity / ( CONSTANT_ATTENUATION + vertex_light_distance * LINEAR_ATTENUATION + vertex_light_distance * vertex_light_distance * QUADRATIC_ATTENUATION );
Implements NL3D::ULight.
Definition at line 346 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

NLMISC::CRGBA NL3D::CLightUser::getSpecular ( ) const [inline, virtual]

Get the specular color of the light.

Implements NL3D::ULight.
Definition at line 271 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

void NL3D::CLightUser::setAmbiant ( const NLMISC::CRGBA & ambiant ) [inline, virtual]

Set the ambiant color of the light.

Implements NL3D::ULight.
Definition at line 137 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

void NL3D::CLightUser::setConstantAttenuation ( float constant ) [inline, virtual]

Set constant attenuation.
The intensity of the light is attenuated this way: light_intensity = light_intensity / ( CONSTANT_ATTENUATION + vertex_light_distance * LINEAR_ATTENUATION + vertex_light_distance * vertex_light_distance * QUADRATIC_ATTENUATION );
Implements NL3D::ULight.
Definition at line 204 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

void NL3D::CLightUser::setCutoff ( float cutoff ) [inline, virtual]

Set the cutoff of the light in radian.
Should be between [0, Pi/2]. Used only for SpotLight.
Implements NL3D::ULight.
Definition at line 191 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

void NL3D::CLightUser::setDiffuse ( const NLMISC::CRGBA & diffuse ) [inline, virtual]

Set the diffuse color of the light.

Implements NL3D::ULight.
Definition at line 146 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

void NL3D::CLightUser::setDirection ( const NLMISC::CVector & direction ) [inline, virtual]

Set the direction of the light.
Used only for DirectionalLight and SpotLight.
Implements NL3D::ULight.
Definition at line 173 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

void NL3D::CLightUser::setExponent ( float exponent ) [inline, virtual]

Set the Intensity distribution of the light.
Should be between [0, 1]. Used only for SpotLight.
Implements NL3D::ULight.
Definition at line 182 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

void NL3D::CLightUser::setLinearAttenuation ( float linear ) [inline, virtual]

Set linear attenuation.
The intensity of the light is attenuated this way: light_intensity = light_intensity / ( CONSTANT_ATTENUATION + vertex_light_distance * LINEAR_ATTENUATION + vertex_light_distance * vertex_light_distance * QUADRATIC_ATTENUATION );
Implements NL3D::ULight.
Definition at line 217 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

void NL3D::CLightUser::setMode ( ULight::TLightMode mode ) [inline, virtual]

Set the light mode.

Implements NL3D::ULight.
Definition at line 128 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

void NL3D::CLightUser::setNoAttenuation ( ) [inline, virtual]

Set no attenuation.
The light will not use attenuation.
Implements NL3D::ULight.
Definition at line 101 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

void NL3D::CLightUser::setPosition ( const NLMISC::CVector & position ) [inline, virtual]

Set the position of the light.
Used only for SpotLight and PointLight.
Implements NL3D::ULight.
Definition at line 164 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

void NL3D::CLightUser::setQuadraticAttenuation ( float quadratic ) [inline, virtual]

Set quadratic attenuation.
The intensity of the light is attenuated this way: light_intensity = light_intensity / ( CONSTANT_ATTENUATION + vertex_light_distance * LINEAR_ATTENUATION + vertex_light_distance * vertex_light_distance * QUADRATIC_ATTENUATION );
Implements NL3D::ULight.
Definition at line 230 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

void NL3D::CLightUser::setSpecular ( const NLMISC::CRGBA & specular ) [inline, virtual]

Set the specular color of the light.

Implements NL3D::ULight.
Definition at line 155 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

void NL3D::CLightUser::setupAttenuation ( float farAttenuationBegin,

float farAttenuationEnd

) [inline, virtual]

Setup attenuation with begin and end attenuation distance.

Parameters:

farAttenuationBegin is the distance of the begin of the attenuation (attenuation == 0.9f)

farAttenuationEnd is the distance of the end of the attenuation (attenuation == 0.1f)

Implements NL3D::ULight.
Definition at line 89 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

void NL3D::CLightUser::setupDirectional ( const NLMISC::CRGBA & ambiant,

const NLMISC::CRGBA & diffuse,

const NLMISC::CRGBA & specular,

const NLMISC::CVector & direction,

float constant = 1,

float linear = 0,

float quadratic = 0

) [inline, virtual]

Quick setup a directional light.

Implements NL3D::ULight.
Definition at line 60 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

void NL3D::CLightUser::setupPointLight ( const NLMISC::CRGBA & ambiant,

const NLMISC::CRGBA & diffuse,

const NLMISC::CRGBA & specular,

const NLMISC::CVector & position,

const NLMISC::CVector & direction,

float constant = 1,

float linear = 0,

float quadratic = 0

) [inline, virtual]

Quick setup a point light.

Implements NL3D::ULight.
Definition at line 68 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

void NL3D::CLightUser::setupSpotExponent ( float hotSpotAngle ) [inline, virtual]

Setup spot exponent with angle of the hotspot.

Parameters:

hotSpotAngle is the angle in radian between the axis of the spot and the vector from light where attenuation is == 0.9.

Implements NL3D::ULight.
Definition at line 113 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

void NL3D::CLightUser::setupSpotLight ( const NLMISC::CRGBA & ambiant,

const NLMISC::CRGBA & diffuse,

const NLMISC::CRGBA & specular,

const NLMISC::CVector & position,

const NLMISC::CVector & direction,

float exponent,

float cutoff,

float constant = 1,

float linear = 0,

float quadratic = 0

) [inline, virtual]

Quick setup a spotlight.

Implements NL3D::ULight.
Definition at line 76 of file light_user.h.
References _Light, and NL3D_MEM_LIGHT.

Friends And Related Function Documentation

friend class CDriverUser [friend]

Definition at line 52 of file light_user.h.

Member Data Documentation

CLight NL3D::CLightUser::_Light [protected]

Definition at line 51 of file light_user.h.
Referenced by getAmbiant, getConstantAttenuation, getCutoff, getDiffuse, getDirection, getExponent, getLinearAttenuation, getMode, getPosition, getQuadraticAttenuation, getSpecular, setAmbiant, setConstantAttenuation, setCutoff, setDiffuse, setDirection, setExponent, setLinearAttenuation, setMode, setNoAttenuation, setPosition, setQuadraticAttenuation, setSpecular, setupAttenuation, setupDirectional, setupPointLight, setupSpotExponent, and setupSpotLight.

The documentation for this class was generated from the following file:

light_user.h

NL3D::CLightUser Class Reference

Public Methods

Protected Attributes

Friends

Detailed Description

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation