---

sglTexCombinerParams.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: sglTexCombinerParams.hpp
 *   Author: Tom Stimson
 *  Created: 31 December 2001
 *  Summary: Paramters to control the texture environment mode eCOMBINE.
 *****************************************************************************/

#ifndef __SGL_TEXCOMBINERPARAMS_HPP
#define __SGL_TEXCOMBINERPARAMS_HPP

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

class sglTexEnv;

//============================================================================

class SGL_DLL_API sglTexCombinerParams : public sglObject
{
public:
   class SGL_DLL_API RGB
   {
   public:
      enum FuncEnum
      {
         eREPLACE      = GL_REPLACE,

         eMODULATE     = GL_MODULATE,

         eADD          = GL_ADD,

         eADD_SIGNED   = GL_ADD_SIGNED,

         eINTERPOLATE  = GL_INTERPOLATE,

         eSUBTRACT     = GL_SUBTRACT,

         eDOT3_RGB     = GL_DOT3_RGB,

         eDOT3_RGBA    = GL_DOT3_RGBA
      };

      enum OperandEnum
      {
         eSRC_COLOR           = GL_SRC_COLOR,
         eONE_MINUS_SRC_COLOR = GL_ONE_MINUS_SRC_COLOR,
         eSRC_ALPHA           = GL_SRC_ALPHA,
         eONE_MINUS_SRC_ALPHA = GL_ONE_MINUS_SRC_ALPHA
      };
   };

   class SGL_DLL_API Alpha
   {
   public:
      enum FuncEnum
      {
         eREPLACE      = GL_REPLACE,

         eMODULATE     = GL_MODULATE,

         eADD          = GL_ADD,

         eADD_SIGNED   = GL_ADD_SIGNED,

         eINTERPOLATE  = GL_INTERPOLATE,

         eSUBTRACT     = GL_SUBTRACT
      };

      enum OperandEnum
      {
         eSRC_ALPHA           = GL_SRC_ALPHA,
         eONE_MINUS_SRC_ALPHA = GL_ONE_MINUS_SRC_ALPHA
      };
   };

   enum ArgEnum
   {
      eARG0 = 0,
      eARG1,
      eARG2
   };

   enum SourceEnum
   {
      eTEXTURE        = GL_TEXTURE,

      eCONSTANT       = GL_CONSTANT,

      ePRIMARY_COLOR  = GL_PRIMARY_COLOR,

      ePREVIOUS       = GL_PREVIOUS
   };

public:
   sglTexCombinerParams();

   virtual ~sglTexCombinerParams();

   sglTexCombinerParams(const sglTexCombinerParams &rhs);

   sglTexCombinerParams &operator=(const sglTexCombinerParams &rhs);

   void setRGBFunc(RGB::FuncEnum func);

   RGB::FuncEnum getRGBFunc() const { return m_rgb_func; }

   void setAlphaFunc(Alpha::FuncEnum func);

   Alpha::FuncEnum getAlphaFunc() const { return m_alpha_func; }

   void setRGBScale(float scale);

   float getRGBScale() const { return m_rgb_scale; }

   void setAlphaScale(float scale);

   float getAlphaScale() const { return m_alpha_scale; }

   void setRGBParameter(ArgEnum arg, SourceEnum src, RGB::OperandEnum op);

   void getRGBParameter(
      ArgEnum arg, SourceEnum &src, RGB::OperandEnum &op) const;

   void setAlphaParameter(ArgEnum arg, SourceEnum src, Alpha::OperandEnum op);

   void getAlphaParameter(
      ArgEnum arg, SourceEnum &src, Alpha::OperandEnum &op) const;

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

private:
   friend class sglTexEnv;
   void apply() const;

private:
   RGB::FuncEnum       m_rgb_func;
   Alpha::FuncEnum     m_alpha_func;
   float               m_rgb_scale;
   float               m_alpha_scale;
   int                 m_rgb_num_args;
   SourceEnum          m_rgb_src[3];
   RGB::OperandEnum    m_rgb_op[3];
   int                 m_alpha_num_args;
   SourceEnum          m_alpha_src[3];
   Alpha::OperandEnum  m_alpha_op[3];
};

#endif

---