//C++ header - Open Scene Graph - Copyright (C) 1998-2001 Robert Osfield
//Distributed under the terms of the GNU Library General Public License (LGPL)
//as published by the Free Software Foundation.

#ifndef OSG_COLORMATRIX
#define OSG_COLORMATRIX 1

#include <osg/Matrix>
#include <osg/StateAttribute>

namespace osg {

/** Texture Matrix state class for encapsulating OpenGL texture matrix functionality.*/
class SG_EXPORT ColorMatrix : public StateAttribute
{
    public :
    
        ColorMatrix();

        /** Copy constructor using CopyOp to manage deep vs shallow copy.*/
        ColorMatrix(const ColorMatrix& cm,const CopyOp& copyop=CopyOp::SHALLOW_COPY):
            StateAttribute(cm,copyop),
            _matrix(cm._matrix) {}

        META_StateAttribute(ColorMatrix, COLORMATRIX);
        
        /** 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(ColorMatrix,sa)

            // compare each paramter in turn against the rhs.
            COMPARE_StateAttribute_Parameter(_matrix)

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

        /** Set the color matrix */
        inline void setMatrix(const Matrix& matrix) { _matrix = matrix; }

        /** Get the color matrix */
        inline Matrix& getMatrix() { return _matrix; }

        /** Get the const color matrix */
        inline const Matrix& getMatrix() const { return _matrix; }

        /** apply as OpenGL texture matrix.*/
        virtual void apply(State& state) const;

    protected:

        virtual ~ColorMatrix( void );

        Matrix _matrix;

};

}


#endif