/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2003 Robert Osfield 
 *
 * This library is open source and may be redistributed and/or modified under  
 * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or 
 * (at your option) any later version.  The full license is in LICENSE file
 * included with this distribution, and on the openscenegraph.org website.
 * 
 * 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 
 * OpenSceneGraph Public License for more details.
*/

#ifndef OSG_COLORMASK
#define OSG_COLORMASK 1

#include <osg/Export>
#include <osg/StateAttribute>

namespace osg {

/** Encapsulate OpenGL glColorMaskFunc/Op/Mask functions.
*/     
class SG_EXPORT ColorMask : public StateAttribute
{
    public :
    
    
        ColorMask();

        ColorMask(bool red,bool green,bool blue,bool alpha):
            _red(red),
            _green(green),
            _blue(blue),
            _alpha(alpha) {}
            

        /** Copy constructor using CopyOp to manage deep vs shallow copy.*/
        ColorMask(const ColorMask& cm,const CopyOp& copyop=CopyOp::SHALLOW_COPY):
            StateAttribute(cm,copyop),
            _red(cm._red),
            _green(cm._green),
            _blue(cm._blue),
            _alpha(cm._alpha) {}
        
        META_StateAttribute(osg, ColorMask, COLORMASK);
        
        /** return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.*/
        virtual int compare(const StateAttribute& sa) const
        {
            // check the types are equal and then create the rhs variable
            // used by the COMPARE_StateAttribute_Paramter macro's below.
            COMPARE_StateAttribute_Types(ColorMask,sa)

            // compare each paramter in turn against the rhs.
            COMPARE_StateAttribute_Parameter(_red)
            COMPARE_StateAttribute_Parameter(_green)
            COMPARE_StateAttribute_Parameter(_blue)
            COMPARE_StateAttribute_Parameter(_alpha)

            return 0; // passed all the above comparison macro's, must be equal.
        }

        inline void setMask(bool red,bool green,bool blue,bool alpha)
        {
            _red = red;
            _green = green;
            _blue = blue;
            _alpha = alpha;
            
        }
        
        inline bool getRedMask() const { return _red; }

        inline bool getGreenMask() const { return _green; }

        inline bool getBlueMask() const { return _blue; }
        
        inline bool getAlphaMask() const { return _alpha; }

        virtual void apply(State& state) const;

    protected:
    
        virtual ~ColorMask();

        bool                _red;
        bool                _green;
        bool                _blue;
        bool                _alpha;

};

}

#endif