kalzium/libavogadro-kalzium/src/engines/sphereengine.h

   1 /**********************************************************************
   2   SphereEngine - Engine for "spheres" display
   3
   4   Copyright (C) 2006-2007 Geoffrey R. Hutchison
   5   Copyright (C) 2007      Benoit Jacob
   6   Copyright (C) 2007      Marcus D. Hanwell
   7
   8   This file is part of the Avogadro molecular editor project.
   9   For more information, see <http://avogadro.sourceforge.net/>
  10
  11   Avogadro is free software; you can redistribute it and/or modify
  12   it under the terms of the GNU General Public License as published by
  13   the Free Software Foundation; either version 2 of the License, or
  14   (at your option) any later version.
  15
  16   Avogadro is distributed in the hope that it will be useful,
  17   but WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19   GNU General Public License for more details.
  20
  21   You should have received a copy of the GNU General Public License
  22   along with this program; if not, write to the Free Software
  23   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  24   02110-1301, USA.
  25  **********************************************************************/
  26
  27 #ifndef __SPHEREENGINE_H
  28 #define __SPHEREENGINE_H
  29
  30 #include <avogadro/global.h>
  31 #include <avogadro/engine.h>
  32
  33
  34 #include "ui_spheresettingswidget.h"
  35
  36 namespace Avogadro {
  37
  38   //! Sphere Engine class.
  39   class SphereSettingsWidget;
  40   class SphereEngine : public Engine
  41   {
  42     Q_OBJECT
  43     AVOGADRO_ENGINE(tr("Van der Waals Spheres"))
  44
  45     public:
  46       //! Constructor
  47       SphereEngine(QObject *parent=0);
  48       //! Deconstructor
  49       ~SphereEngine();
  50
  51       //! Copy
  52       Engine *clone() const;
  53
  54       //! \name Render Methods
  55       //@{
  56       bool renderOpaque(PainterDevice *pd);
  57       bool renderTransparent(PainterDevice *pd);
  58       //! Render an Atom.
  59       bool render(PainterDevice *pd, const Atom *a);
  60       //@}
  61
  62       double transparencyDepth() const;
  63       EngineFlags flags() const;
  64
  65       double radius(const PainterDevice *pd, const Primitive *p = 0) const;
  66
  67       QWidget* settingsWidget();
  68       /**
  69        * Write the engine settings so that they can be saved between sessions.
  70        */
  71       void writeSettings(QSettings &settings) const;
  72
  73       /**
  74        * Read in the settings that have been saved for the engine instance.
  75        */
  76       void readSettings(QSettings &settings);
  77
  78     private:
  79       inline double radius(const Atom *a) const;
  80
  81       SphereSettingsWidget *m_settingsWidget;
  82
  83       double m_alpha; // transparency of the VdW spheres
  84
  85     private Q_SLOTS:
  86       void settingsWidgetDestroyed();
  87
  88
  89       /**
  90        * @param value opacity of the VdW spheres / 20
  91        */
  92       void setOpacity(int value);
  93
  94   };
  95
  96   class SphereSettingsWidget : public QWidget, public Ui::SphereSettingsWidget
  97   {
  98     public:
  99       SphereSettingsWidget(QWidget *parent=0) : QWidget(parent) {
 100         setupUi(this);
 101       }
 102   };
 103
 104   //! Generates instances of our SphereEngine class
 105   class SphereEngineFactory : public QObject, public EngineFactory
 106   {
 107     Q_OBJECT
 108     Q_INTERFACES(Avogadro::EngineFactory)
 109     AVOGADRO_ENGINE_FACTORY(SphereEngine)
 110   };
 111
 112 } // end namespace Avogadro
 113
 114 #endif