---

sglFog.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: sglFog.hpp
 *   Author: Scott McMillan and Michael Morrison.
 *  Created: 28 November 2000
 *  Summary: sglStatelet to encapsulate fog functionality.
 *****************************************************************************/

#ifndef __SGL_FOG_HPP
#define __SGL_FOG_HPP

#include <sgl.h>
#include <sglStatelet.hpp>
#include <sglVector.hpp>

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

class SGL_DLL_API sglFog : public sglStatelet
{
public:
   enum ModeEnum
   {
      eOFF    = 0,

      eEXP    = GL_EXP,

      eEXP2   = GL_EXP2,

      eLINEAR = GL_LINEAR
   };

   enum DistanceEqEnum
   {
      eEYE_PLANE_ABSOLUTE = GL_EYE_PLANE_ABSOLUTE_NV,

      eEYE_RADIAL = GL_EYE_RADIAL_NV
   };


public:
   sglFog();

   virtual ~sglFog();

   void setMode(ModeEnum mode);

   ModeEnum getMode() const { return m_mode; }

   void setDistanceEquation(DistanceEqEnum eq);

   DistanceEqEnum getDistanceEquation() const { return m_distance_equation; }

   void setExtent(float start, float end);

   void getExtent(float &start, float &end) const
      { start = m_start; end = m_end; }

   void setDensity(float density);

   float getDensity() const { return m_density; }

   void setColor(const sglVec4f &color) { m_color = color; }

   void setColor(float r, float g, float b, float a) { m_color.set(r,g,b,a); }

   const sglVec4f &getColor() const { return m_color; }

   // See sglStatelet::apply() for details.
   void apply(sglCurrState*) const;

   // See sglStatelet::getSorted() for details.
   virtual bool getSorted() const { return true; }

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

protected:

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

   void setIndex() { m_index = ((m_mode == eOFF) ? 0 : UINT_MAX); }

protected: // variables
   ModeEnum m_mode;

   float    m_start;
   float    m_end;
   float    m_density;
   DistanceEqEnum m_distance_equation;

   sglVec4f m_color;
};

#endif

---