NL3D::CPointLightNamed Class Reference

A pointLight with a name, and a default color setup. More...

#include <point_light_named.h>

Inherits NL3D::CPointLight.

List of all members.

Public Member Functions

 CPointLightNamed ()
 Constructor.
void setDefaultAmbient (NLMISC::CRGBA ambient)
 Set the Default ambient color of the light. Default to Black.
void setDefaultDiffuse (NLMISC::CRGBA diffuse)
 Set the Default diffuse color of the light. Default to White.
void setDefaultSpecular (NLMISC::CRGBA specular)
 Set the Default specular color of the light. Default to White.
NLMISC::CRGBA getDefaultAmbient () const
 Get the Default ambient color of the light.
NLMISC::CRGBA getDefaultDiffuse () const
 Get the Default diffuse color of the light.
NLMISC::CRGBA getDefaultSpecular () const
 Get the Default specular color of the light.
NLMISC::CRGBA getUnAnimatedDiffuse () const
 get the unanimated diffuse (used for Landscape)
void setLightFactor (NLMISC::CRGBA nFactor)
 modulate the default color setup with nFactor, and set to the current setup.
void setLightFactor (NLMISC::CRGBA nAnimatedFactor, NLMISC::CRGBA nUnAnimatedFactor)
 modulate the default color setup with nFactor, and set to the current setup.
void serial (NLMISC::IStream &f)

Public Attributes

std::string AnimatedLight
 Animation used by this light.
uint32 LightGroup
 Group of the light.

Private Attributes

sint _IdInInfluenceList
NLMISC::CRGBA _DefaultAmbient
NLMISC::CRGBA _DefaultDiffuse
NLMISC::CRGBA _DefaultSpecular
NLMISC::CRGBA _UnAnimatedDiffuse

Friends

class CLightInfluenceInterpolator

Detailed Description

A pointLight with a name, and a default color setup.

The current setup is the setup in CPointLight. A CPointLightNamed influence can also be interpolated with a CLightInfluenceInterpolator.

Author:
Lionel Berenguier
Nevrax France
Date:
2001

Definition at line 46 of file point_light_named.h.


Constructor & Destructor Documentation

NL3D::CPointLightNamed::CPointLightNamed (  ) 

Member Function Documentation

NLMISC::CRGBA NL3D::CPointLightNamed::getDefaultAmbient (  )  const [inline]

Get the Default ambient color of the light.

Definition at line 69 of file point_light_named.h.

References _DefaultAmbient.

NLMISC::CRGBA NL3D::CPointLightNamed::getDefaultDiffuse (  )  const [inline]

Get the Default diffuse color of the light.

Definition at line 71 of file point_light_named.h.

References _DefaultDiffuse.

NLMISC::CRGBA NL3D::CPointLightNamed::getDefaultSpecular (  )  const [inline]

Get the Default specular color of the light.

Definition at line 73 of file point_light_named.h.

References _DefaultSpecular.

NLMISC::CRGBA NL3D::CPointLightNamed::getUnAnimatedDiffuse (  )  const [inline]

get the unanimated diffuse (used for Landscape)

Definition at line 76 of file point_light_named.h.

References _UnAnimatedDiffuse.

Referenced by NL3D::CVegetableLightEx::computeCurrentColors(), and NL3D::CPatch::getCurrentTLIColor().

void NL3D::CPointLightNamed::serial ( NLMISC::IStream f  ) 
void NL3D::CPointLightNamed::setDefaultAmbient ( NLMISC::CRGBA  ambient  )  [inline]

Set the Default ambient color of the light. Default to Black.

Definition at line 62 of file point_light_named.h.

References _DefaultAmbient.

void NL3D::CPointLightNamed::setDefaultDiffuse ( NLMISC::CRGBA  diffuse  )  [inline]

Set the Default diffuse color of the light. Default to White.

Definition at line 64 of file point_light_named.h.

References _DefaultDiffuse.

void NL3D::CPointLightNamed::setDefaultSpecular ( NLMISC::CRGBA  specular  )  [inline]

Set the Default specular color of the light. Default to White.

Definition at line 66 of file point_light_named.h.

References _DefaultSpecular.

void NL3D::CPointLightNamed::setLightFactor ( NLMISC::CRGBA  nAnimatedFactor,
NLMISC::CRGBA  nUnAnimatedFactor 
)

modulate the default color setup with nFactor, and set to the current setup.

give 2 params the second is the "not animated" factor. used for Landscape.

Definition at line 51 of file point_light_named.cpp.

References _DefaultAmbient, _DefaultDiffuse, _DefaultSpecular, _UnAnimatedDiffuse, NLMISC::CRGBA::modulateFromColor(), NL3D::CPointLight::setAmbient(), NL3D::CPointLight::setDiffuse(), and NL3D::CPointLight::setSpecular().

void NL3D::CPointLightNamed::setLightFactor ( NLMISC::CRGBA  nFactor  ) 

modulate the default color setup with nFactor, and set to the current setup.

NB: getUnAnimatedDiffuse() == getDiffuse()

Definition at line 44 of file point_light_named.cpp.


Friends And Related Function Documentation

friend class CLightInfluenceInterpolator [friend]

Definition at line 96 of file point_light_named.h.


Member Data Documentation

Definition at line 97 of file point_light_named.h.

Referenced by NL3D::CLightInfluenceInterpolator::interpolate().

Animation used by this light.

Definition at line 50 of file point_light_named.h.

Referenced by NL3D::CPointLightNamedSort::operator<(), and serial().

Group of the light.

Definition at line 53 of file point_light_named.h.

Referenced by NL3D::CPointLightNamedSort::operator<(), and serial().


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

Generated on Thu Jan 7 08:30:07 2010 for NeL by  doxygen 1.6.1