KeosLight.h

Go to the documentation of this file.

/*
 * This source file is part of KEOS (Free 3D Engine)
 * For the latest info, see http://www.keosengine.org/
 * E-mails : thierry.vouriot@keosengine.org, yeri@keosengine.org
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option) any later
 * version.
 *
 * This program 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place - Suite 330, Boston, MA 02111-1307, USA, or go to
 * http://www.gnu.org/copyleft/lesser.txt.
 *
 */

#ifndef KEOS_LIGHT_H
#define KEOS_LIGHT_H

#include "KeosPrerequisites.h"
#include "KeosColor.h"
#include "KeosMath.h"

namespace Keos
{
  //-----------------------------------------------------------------------
  class KEOS_EXPORT CLight
  {
  public:

    enum TLightType
    {
      LT_POINT,
      LT_DIRECTIONAL,
      LT_SPOT
    };

    CLight();

    ~CLight();

    void SetType(TLightType nType);

    TLightType GetType(void) const;

    void SetDiffuseColor(float fRed, float fGreen, float fBlue);

    void SetDiffuseColor(const CColor& Color);

    const CColor& GetDiffuseColor(void) const;

    void SetSpecularColor(float fRed, float fGreen, float fBlue);

    void SetSpecularColor(const CColor& Color);

    const CColor& GetSpecularColor(void) const;

    void SetAttenuation(Real range, Real constant, Real linear, Real quadratic);

    Real GetAttenuationRange(void) const;

    Real GetAttenuationConstant(void) const;

    Real GetAttenuationLinear(void) const;

    Real GetAttenuationQuadric(void) const;

    void SetSpotRange(const CRadian& innerAngle, const CRadian& outerAngle, Real falloff = 1.0);

    const CRadian& GetSpotInnerAngle(void) const;

    const CRadian& GetSpotOuterAngle(void) const;

    Real GetSpotFalloff(void) const;

    void SetSpotInnerAngle(const CRadian& val);

    void SetSpotOuterAngle(const CRadian& val);

    void SetSpotFalloff(Real val);


    void SetPosition(float x, float y, float z);

    void SetPosition(const TVector3F& Vec);

    const TVector3F& GetPosition(void) const;

    void SetDirection(float x, float y, float z);

    void SetDirection(const TVector3F& Vec);

    const TVector3F& GetDirection(void) const;

  private:

    TLightType m_nLightType;
    TVector3F m_Position;
    CColor m_Diffuse;
    CColor m_Specular;

    TVector3F m_Direction;

    CRadian m_SpotOuter;
    CRadian m_SpotInner;
    Real m_SpotFalloff;

    Real m_Range;
    Real m_AttenuationConst;
    Real m_AttenuationLinear;
    Real m_AttenuationQuad;
  };

  typedef CSmartPtr<CLight, CRefCount> TLightPtr;

} // namespace Keos

#endif // KEOS_LIGHT_H

---