light.h

/*--License:
        Lilith 3D Engine
        Copyright Lee Thomason (Grinning Lizard Software) 2002-2003
        www.grinninglizard.com/lilith

        This program 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
        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 General Public License for more details.

        You should have received a copy of the GNU 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.

        The full text of the license can be found in license.txt
*/
#ifndef LILITH3D_LIGHT_INCLUDED
#define LILITH3D_LIGHT_INCLUDED

#include "../grinliz/glcolor.h"
#include "../grinliz/glvector.h"
#include "../grinliz/glrectangle.h"
#include "../grinliz/glinnercircle.h"

namespace lilith3d
{

/* Define a point light.

        A point light illuminates the terrain around the light. PointLights
        have a position and radius of illumination. 

        Once a light is new'd it will appear in the world until it is deleted.

        Lights are owned by the game, not the engine. The game is responsible
        for creating and later deleting the light. The exception is the
        FadeOutAndDelete() method which will fade the light and clean it up.

        @todo   Lights should illuminate Meshes.
        @todo   Consider that lights should be a Mesh
*/

//class PointLight
//{
//  public:
//      /// Create a point light.
//      PointLight(     float x, float y, float z, float radius, const grinliz::Color3F& color );
//      virtual ~PointLight();
//
//      /// The current location of the light.
//      const grinliz::Vector3F& Origin() const         {       return origin; }
//      /// The size of the light.
//      float Radius() const                            {       return radius; }
//      /// The bounding box of the light.
//      const grinliz::Rectangle3F&     AABB() const            {       return bounds; }
//
//      /** Sets the x, y, and z position of the light. Will take effect
//              at the next DoTick()
//      */
//      void SetPos( float x, float y, float z );
//
//      /// Change the color of the light.
//      void SetColor( const grinliz::Color3F& color );
//
//      virtual void DoTick();
//      virtual bool Done();
//      bool EngineDelete()             { return (fadeRate > 0.0f); }
//
//      /// Returns the color of the light computed at the last "DoTick"
//      const grinliz::Color3F& Color() const           {       return currentColor; }
//      /** Set the light to fade to black. After calling this the engine may
//              delete the light so be sure to throw away the pointer to the light.
//      */
//      void FadeOutAndDelete( float rate = 1.0f )      {       fadeRate = rate; }
//
//  private:
//      grinliz::InnerCircle<PointLight>        innerNode;
//      grinliz::Vector3F               origin;
//      float                                   radius;
//      grinliz::Rectangle3F    bounds;
//      grinliz::Color3F                color;  
//      grinliz::Color3F                currentColor;
//      float                                   intensity;
//      float                                   fadeRate;
//};
};      // namespace lilith3d

#endif

---