point_light.h

Go to the documentation of this file.

/* Copyright, 2001 Nevrax Ltd.
 *
 * This file is part of NEVRAX NEL.
 * NEVRAX NEL is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.

 * NEVRAX NEL is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with NEVRAX NEL; see the file COPYING. If not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
 * MA 02111-1307, USA.
 */

#ifndef NL_POINT_LIGHT_H
#define NL_POINT_LIGHT_H

#include "nel/misc/types_nl.h"
#include "nel/misc/rgba.h"
#include "nel/misc/vector.h"
#include "nel/misc/stl_block_list.h"


namespace NL3D
{


using NLMISC::CVector;
using NLMISC::CRGBA;


class   CLight;
class   CTransform;


// ***************************************************************************
// Size of a block for allocation of lighted models nodes.
#define NL3D_LIGHTED_MODEL_ALLOC_BLOCKSIZE  1024


// ***************************************************************************
class CPointLight
{
public:
    //typedef   NLMISC::CSTLBlockList<CTransform*>  TTransformList;
    typedef std::list<CTransform*>  TTransformList;
    typedef TTransformList::iterator            ItTransformList;

    enum    TType
    {
        // The light is a point.
        PointLight= 0,

        // The light is a spotlight with a cone.
        SpotLight,

        // The light is an Ambient PointLight in an Ig.
        AmbientLight
    };


public:

    CPointLight();
    ~CPointLight();
    CPointLight(const CPointLight &o);
    CPointLight &operator=(const CPointLight &o);


    // @{

    void            setType(TType type);
    TType           getType() const;

    void            setPosition(const CVector &v) {_Position= v;}
    const CVector   &getPosition() const {return _Position;}


    void            setAmbient (NLMISC::CRGBA ambient)  {_Ambient=ambient;}
    void            setDiffuse (NLMISC::CRGBA diffuse)  {_Diffuse=diffuse;}
    void            setSpecular (NLMISC::CRGBA specular)    {_Specular=specular;}
    void            setColor (NLMISC::CRGBA color)  {_Diffuse= _Specular= color;}

    NLMISC::CRGBA   getAmbient () const {return _Ambient;}
    NLMISC::CRGBA   getDiffuse () const {return _Diffuse;}
    NLMISC::CRGBA   getSpecular () const    {return _Specular;}


    void            setupAttenuation(float attenuationBegin, float attenuationEnd);
    float           getAttenuationBegin() const {return _AttenuationBegin;}
    float           getAttenuationEnd() const {return _AttenuationEnd;}


    void            setupSpotAngle(float spotAngleBegin, float spotAngleEnd);
    float           getSpotAngleBegin() const {return _SpotAngleBegin;}
    float           getSpotAngleEnd() const {return _SpotAngleEnd;}


    void            setupSpotDirection(const CVector &dir);
    const CVector   &getSpotDirection() const {return _SpotDirection;}


    // serial
    void            serial(NLMISC::IStream &f);


    // @}



    // @{

    float           computeLinearAttenuation(const CVector &pos) const;

    float           computeLinearAttenuation(const CVector &pos, float precomputedDist, float modelRadius=0) const;

    void            setupDriverLight(CLight &light, uint8 factor);

    void            setupDriverLightUserAttenuation(CLight &light, uint8 factor);

    void            resetLightedModels();

    ItTransformList appendLightedModel(CTransform *model);
    void            removeLightedModel(ItTransformList it);

    // @}

    // Purge static memory
    static void     purge ();

    // Specific For Ambient light
    bool            getAddAmbientWithSun() const {return _AddAmbientWithSun;}
    void            setAddAmbientWithSun(bool state);

// ******************
private:

    // Type of the light
    TType           _Type;

    // The position.
    CVector         _Position;

    // The light color.
    NLMISC::CRGBA   _Ambient;
    NLMISC::CRGBA   _Diffuse;
    NLMISC::CRGBA   _Specular;

    // Attenuation. setup / preComputed.
    float           _AttenuationBegin, _AttenuationEnd;
    float           _OODeltaAttenuation;
    float           _ConstantAttenuation;
    float           _LinearAttenuation;
    float           _QuadraticAttenuation;

    // Spot Setup
    CVector         _SpotDirection;
    float           _SpotAngleBegin;
    float           _SpotAngleEnd;
    float           _CosSpotAngleEnd;
    // 1 / (_CosSpotAngleBegin * _CosSpotAngleEnd)
    float           _OOCosSpotAngleDelta;
    float           _SpotExponent;

    // Ambient specific
    bool            _AddAmbientWithSun;

    // The memory for list of LightedModels
    //static    NLMISC::CBlockMemory<CTransform*, false>        _LightedModelListMemory;
    // LightedModels. NB: do not contains models that have this light in their FrozenStaticLightSetup
    TTransformList      _LightedModels;


    void        computeAttenuationFactors();
    void        computeSpotAttenuationFactors();

};


} // NL3D


#endif // NL_POINT_LIGHT_H

/* End of point_light.h */