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

/**********************************************************************
  GLPainter - drawing spheres, cylinders and text in a GLWidget

  Copyright (C) 2007 Benoit Jacob
  Copyright (C) 2007 Donald Ephraim Curtis
  Copyright (C) 2007-2009 Marcus D. Hanwell
  Copyright (C) 2010 Konstantin Tokarev
  Copyright (C) 2011 David C. Lonie

  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 GLPAINTER_H
#define GLPAINTER_H

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

namespace Avogadro
{

  class GLWidget;
  class Color3f;
  class GLPainterPrivate;
  class GLPainter : public Painter
  {
    friend class GLWidget;
  public:

    GLPainter (int quality=-1);

    ~GLPainter();

    void setQuality(int quality);

    int quality() const;

    void setName(const Primitive *primitive);

    void setName(Primitive::Type type, int id);

    void setColor(const Color *color);

    void setColor(const QColor *color);

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

    void setColor(QString name);

    void drawSphere(const Eigen::Vector3d &center, double radius);

    void drawCylinder(const Eigen::Vector3d &end1, const Eigen::Vector3d &end2,
                      double radius);

    void drawMultiCylinder(const Eigen::Vector3d &end1, const Eigen::Vector3d &end2,
                           double radius, int order, double shift);

    void drawCone(const Eigen::Vector3d &base, const Eigen::Vector3d &cap,
                  double baseRadius, double capRadius = 0.0);

    void drawLine(const Eigen::Vector3d &start, const Eigen::Vector3d &end,
                  double lineWidth);

    void drawMultiLine(const Eigen::Vector3d &start, const Eigen::Vector3d &end,
                       double lineWidth, int order, short stipple);

    void drawTriangle(const Eigen::Vector3d &p1, const Eigen::Vector3d &p2,
                      const Eigen::Vector3d &p3);

    void drawTriangle(const Eigen::Vector3d &p1, const Eigen::Vector3d &p2,
                      const Eigen::Vector3d &p3, const Eigen::Vector3d &n);

    void drawSpline(const QVector<Eigen::Vector3d>& pts, double radius);

    void drawShadedSector(const Eigen::Vector3d & origin,
                          const Eigen::Vector3d & direction1,
                          const Eigen::Vector3d & direction2, double radius,
                          bool alternateAngle = false);

    void drawArc(const Eigen::Vector3d & origin, const Eigen::Vector3d &direction1,
                 const Eigen::Vector3d & direction2,
                 double radius, double lineWidth, bool alternateAngle = false);

    void drawShadedQuadrilateral(const Eigen::Vector3d & point1,
                                 const Eigen::Vector3d & point2,
                                 const Eigen::Vector3d & point3,
                                 const Eigen::Vector3d & point4);

    void drawQuadrilateral(const Eigen::Vector3d & point1,
                           const Eigen::Vector3d & point2,
                           const Eigen::Vector3d & point3,
                           const Eigen::Vector3d & point4,
                           double lineWidth);

    void drawLineLoop(const QList<Eigen::Vector3d> & points,
                      const double lineWidth);

    void drawMesh(const Mesh & mesh, int mode = 0);

    void drawColorMesh(const Mesh & mesh, int mode = 0);

    int drawText (int x, int y, const QString &string);

    int drawText(const QPoint& pos, const QString &string);

    int drawText(const Eigen::Vector3d & pos, const QString &string);

    int drawText(const Eigen::Vector3d &pos, const QString &string, const QFont &font);

    void drawBox(const Eigen::Vector3d &corner1,
                 const Eigen::Vector3d &corner2);

    void drawBoxEdges(const Eigen::Vector3d &offset,
                      const Eigen::Vector3d &v1,
                      const Eigen::Vector3d &v2,
                      const Eigen::Vector3d &v3,
                      const double linewidth);

    void drawBoxEdges(const Eigen::Vector3d &c1,
                      const Eigen::Vector3d &c2,
                      const Eigen::Vector3d &c3,
                      const Eigen::Vector3d &c4,
                      const Eigen::Vector3d &c5,
                      const Eigen::Vector3d &c6,
                      const Eigen::Vector3d &c7,
                      const Eigen::Vector3d &c8,
                      const double linewidth);

    void drawTorus(const Eigen::Vector3d &pos,
                   double majorRadius, double minorRadius);

    void drawEllipsoid(const Eigen::Vector3d &position,
                               const Eigen::Matrix3d &matrix);

    void begin(GLWidget *widget);

    void end();

    bool isActive();

    bool isShared();

    static int defaultQuality();

    static int maxQuality();

    void setDynamicScaling(bool scaling);

  protected:
    GLPainterPrivate * const d;

    bool m_dynamicScaling;

    void incrementShare();

    void decrementShare();

    void pushName();

    void popName();

    void resetName();

    inline void apply(const Color3f &color);

    inline void applyAsMaterials(const Color3f &color, float alpha = 1.0);
  };
} // end namespace Avogadro

#endif