---

sglLight.hpp

/*****************************************************************************
 * SGL: A Scene Graph Library
 *
 * Copyright (C) 1997-2001  Scott McMillan   All Rights Reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *****************************************************************************
 *     File: sglLight.hpp
 *   Author: Scott McMillan
 *  Created: 28 November 2000
 *  Summary: abstract base class for all types of SGL lights.  Derived from
 *           sglNode, it is a leaf node of the scene graph, equivalent to
 *           sglGeode or sglText.
 *****************************************************************************/

#ifndef __SGL_LIGHT_HPP
#define __SGL_LIGHT_HPP

#include <sgl.h>
#include <sglNode.hpp>

//----------------------------------------------------------------------------

class SGL_DLL_API sglLight : public sglNode
{
public:
   sglLight();
   virtual ~sglLight();

   void setOn(bool on);  // true = on; false = off

   bool getOn() const { return m_on_flag; }

   void setAmbient(const sglVec4f &color) { m_ambient = color; }

   void setAmbient(float r, float g, float b, float a)
      { m_ambient.set(r,g,b,a); }

   const sglVec4f &getAmbient() const { return m_ambient; }

   void setDiffuse(const sglVec4f &color) { m_diffuse = color; }

   void setDiffuse(float r, float g, float b, float a)
      { m_diffuse.set(r,g,b,a); }

   const sglVec4f &getDiffuse() const { return m_diffuse; }

   void setSpecular(const sglVec4f &color) { m_specular = color; }

   void setSpecular(float r, float g, float b, float a)
      { m_specular.set(r,g,b,a); }

   const sglVec4f &getSpecular() const { return m_specular; }

   virtual void setup(GLenum gl_light_number) const;

   // See sglObject::printInfo() for details.
   virtual void printInfo(ostream &ostrm, const char *indent_string) const;

   // I am not sure what to do with these yet.  I can leave them here, and they
   // affect all scene graphs at once, or I can put them as a traversal mode
   // or I can leave it up to the user (external to SGL).
   //
   //static void setGlobalAmbient(const sglVec4f &color);
   //static const sglVec4f &getGlobalAmbient() { return s_global_ambient; }
   //static void enableLocal(bool on);
   //static bool getLocal() { return s_local_flag; }
   //static void enableTwoSided(bool on);
   //static bool getTwoSided() { return s_two_sided; }

protected:
   virtual void cull(sglCull<float> &trav_state,
                     unsigned int cull_flags) const;
   virtual void cull(sglCull<double> &trav_state,
                     unsigned int cull_flags) const;

   void copyTo(sglLight *dst, unsigned int mode) const;

private: // methods - not implemented
   sglLight(const sglLight &);
   sglLight &operator=(const sglLight &);

protected: // variables
   bool     m_on_flag;

   sglVec4f m_ambient;
   sglVec4f m_diffuse;
   sglVec4f m_specular;
};

#endif

---