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

/**********************************************************************
  Primitive - Wrapper class around the OpenBabel classes

  Copyright (C) 2007 Donald Ephraim Curtis
  Copyright (C) 2008 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 PRIMITIVE_H
#define PRIMITIVE_H

#include "global.h"

#include <QObject>
#include <QMetaType>

#include <Eigen/Core>
#include <limits> // To get the maximum size of long for FALSE_ID

namespace Avogadro {

  // Define the overflow resulting from long (-1) as the error/not found
  const unsigned long FALSE_ID = std::numeric_limits<unsigned long>::max();

  class PrimitivePrivate;
  class A_EXPORT Primitive : public QObject
  {
  Q_OBJECT
  Q_PROPERTY(Type type READ type)
  Q_ENUMS(Type)

  public:
    enum Type {
      OtherType=0,
      MoleculeType,
      AtomType,
      BondType,
      ResidueType,
      ChainType,
      FragmentType,
      SurfaceType,
      MeshType,
      CubeType,
      PlaneType,
      GridType,
      PointType,
      LineType,
      VectorType,
      NonbondedType,
      TextType,
      LastType,
      FirstType=OtherType
    };

    Primitive(QObject *parent = 0);

    explicit Primitive(Type type, QObject *parent=0);

    virtual ~Primitive();

    void update();

    Type type() const;

    unsigned long id() const { return m_id; }

    unsigned long index() const { return m_index; }

  Q_SIGNALS:
    void updated();

  protected:
    void setId(unsigned long m_id);

    void setIndex(unsigned long m_index);

    PrimitivePrivate * const d_ptr;
    Primitive(PrimitivePrivate &dd, QObject *parent = 0);
    Primitive(PrimitivePrivate &dd, Type type, QObject *parent=0);

    enum Primitive::Type m_type;
    unsigned long m_id;
    unsigned long m_index;

  private:
    Q_DECLARE_PRIVATE(Primitive)
  };

} // namespace Avogadro

Q_DECLARE_METATYPE(Avogadro::Primitive*)

#endif // PRIMITIVE_H