/home/kitware/dashboards/avogadro/libavogadro/src/color.h

/**********************************************************************
  Color - Base class for handling color changes in OpenGL

    Copyright (c) 2006-2008 Benoit Jacob
    Copyright (c) 2007-2009 Geoff Hutchison
    Copyright (c) 2007-2008 Donald Ephraim Curtis
    Copyright (c) 2007 Carsten Niehaus
    Copyright (c) 2007-2009 Marcus D. Hanwell

  This file is part of the Avogadro molecular editor project.
  For more information, see <http://avogadro.openmolecules.net/>

  Avogadro is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  Avogadro 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 General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  02110-1301, USA.
 **********************************************************************/

#ifndef COLOR_H
#define COLOR_H

#include <avogadro/global.h>
#include <avogadro/plugin.h>

#include <QColor> // for returning QColor

#define AVOGADRO_COLOR(i, t, d)                 \
  public: \
    static QString staticIdentifier() { return i; }          \
    QString identifier() const { return i; }                 \
    static QString staticName() { return t; }                \
    QString name() const { if (m_name.isEmpty()) return t; else return m_name; } \
    static QString staticDescription() { return d; }         \
    QString description() const { return d; }

#define AVOGADRO_COLOR_FACTORY(c)         \
  public: \
    Avogadro::Plugin *createInstance(QObject *parent = 0) { Q_UNUSED(parent); return new c(); } \
    Avogadro::Plugin::Type type() const { return Avogadro::Plugin::ColorType; }; \
    QString identifier() const { return c::staticIdentifier(); } \
    QString name() const { return c::staticName(); }         \
    QString description() const { return c::staticDescription(); }

namespace Avogadro {

  class Primitive;
  class ColorPrivate; // for future expansion

  class A_EXPORT Color : public Plugin
  {
    Q_OBJECT
  public:
    Color();
    virtual ~Color();

    Color(float red, float green, float blue, float alpha = 1.0 );

    Color( const Primitive *p);

    virtual void setFromPrimitive(const Primitive *p);

    virtual void setFromIndex(const unsigned int index);

    virtual void setFromGradient(const double value, const double lo,
                                 const double mid, const double hi);

    virtual void setFromRgba(float red, float green,float blue,
                             float alpha = 1.0);

    virtual void setFromQColor(const QColor &color);

    virtual void setToSelectionColor();

    virtual void setAlpha(double alpha);

    virtual void apply();
    virtual void applyAsMaterials();

    virtual void applyAsFlatMaterials();

    inline QColor color() const
    { QColor returnColor;
      returnColor.setRgbF(m_channels[0],
                          m_channels[1],
                          m_channels[2],
                          m_channels[3]);
        return returnColor; }

    inline float red() const { return m_channels[0]; }
    inline float green() const { return m_channels[1]; }
    inline float blue() const { return m_channels[2]; }
    inline float alpha() const { return m_channels[3]; }

    virtual void setName(const QString& name);
    virtual QString name() const;
    virtual QString identifier() const;
    virtual Plugin::Type type() const { return Plugin::ColorType; }

  Q_SIGNALS:
      void changed();

  protected:
    float m_channels[4];

    QString m_name;

    ColorPrivate *d;
  };

}

#endif