Point.h

/******************************************************************************************************
 * (C) 2014 markummitchell@github.com. This file is part of Engauge Digitizer, which is released      *
 * under GNU General Public License version 2 (GPLv2) or (at your option) any later version. See file *
 * LICENSE or go to gnu.org/licenses for details. Distribution requires prior written permission.     *
 ******************************************************************************************************/
 
#ifndef POINT_H
#define POINT_H
 
#include <QPointF>
#include <QString>
 
class QTextStream;
class QXmlStreamReader;
class QXmlStreamWriter;
 
enum ApplyHasCheck {
  KEEP_HAS_CHECK,
  SKIP_HAS_CHECK
};
 
class Point
{
public:
  Point ();
 
  Point (const QString &curveName,
         const QPointF &posScreen);
 
  Point (const QString &curveName,
         const QPointF &posScreen,
         const QPointF &posGraph,
         bool isXOnly);
 
  Point (const QString &curveName,
         const QString &identifier,
         const QPointF &posScreen,
         const QPointF &posGraph,
         double ordinal,
         bool isXOnly);
 
  Point (const QString &curveName,
         const QPointF &posScreen,
         const QPointF &posGraph,
         double ordinal,
         bool isXOnly);
 
  Point (const QString &curveName,
         const QString &identifier,
         const QPointF &posScreen,
         double ordinal);
 
  Point (const QString &curveName,
         const QPointF &posScreen,
         double ordinal);
 
  Point (QXmlStreamReader &reader);
 
  Point &operator=(const Point &point);
 
  Point (const Point &point);
 
  static QString curveNameFromPointIdentifier (const QString &pointIdentifier);
 
  bool hasOrdinal () const;
 
  bool hasPosGraph () const;
 
  QString identifier () const;
 
  bool isXOnly() const;
 
  static unsigned int identifierIndex ();
 
  bool isAxisPoint () const;
 
  double ordinal (ApplyHasCheck applyHasCheck = KEEP_HAS_CHECK) const;
 
  QPointF posGraph (ApplyHasCheck applyHasCheck = KEEP_HAS_CHECK) const;
 
  QPointF posScreen () const;
 
  void printStream (QString indentation,
                    QTextStream &str) const;
 
  void saveXml(QXmlStreamWriter &writer) const;
 
  void setCurveName (const QString &curveName);
 
  static void setIdentifierIndex (unsigned int identifierIndex);
 
  void setOrdinal (double ordinal);
 
  void setPosGraph (const QPointF &posGraph);
 
  void setPosScreen (const QPointF &posScreen);
 
  static QString temporaryPointIdentifier ();
 
  static double UNDEFINED_ORDINAL () { return -1.0; }
 
private:
 
  void loadXml(QXmlStreamReader &reader);
 
  static QString uniqueIdentifierGenerator(const QString &curveName);
 
  bool m_isAxisPoint;
  QString m_identifier;
  QPointF m_posScreen;
  bool m_hasPosGraph;
  QPointF m_posGraph;
  bool m_hasOrdinal;
  double m_ordinal;
  bool m_isXOnly; // For DOCUMENT_AXES_POINTS_REQUIRED_4, true/false when x/y coordinate is undefed
 
  static unsigned int m_identifierIndex; // For generating unique identifiers
};
 
#endif // POINT_H