Engauge Digitizer  2
 All Classes Files Functions Variables Enumerations Enumerator Friends Pages
CoordSystem.h
1 /******************************************************************************************************
2  * (C) 2014 markummitchell@github.com. This file is part of Engauge Digitizer, which is released *
3  * under GNU General Public License version 2 (GPLv2) or (at your option) any later version. See file *
4  * LICENSE or go to gnu.org/licenses for details. Distribution requires prior written permission. *
5  ******************************************************************************************************/
6 
7 #ifndef COORD_SYSTEM_H
8 #define COORD_SYSTEM_H
9 
10 #include "CoordSystemInterface.h"
11 #include "CurvesGraphs.h"
12 #include "CurveStyles.h"
13 #include "DocumentAxesPointsRequired.h"
14 #include "DocumentModelAxesChecker.h"
15 #include "DocumentModelColorFilter.h"
16 #include "DocumentModelCoords.h"
17 #include "DocumentModelDigitizeCurve.h"
18 #include "DocumentModelExportFormat.h"
19 #include "DocumentModelGeneral.h"
20 #include "DocumentModelGridRemoval.h"
21 #include "DocumentModelPointMatch.h"
22 #include "DocumentModelSegments.h"
23 #include "PointStyle.h"
24 #include <QList>
25 #include <QPixmap>
26 #include <QString>
27 #include <QXmlStreamReader>
28 
29 class Curve;
30 class QByteArray;
31 class QDataStream;
32 class QImage;
33 class QTransform;
34 class QXmlStreamReader;
35 class QXmlStreamWriter;
36 class Transformation;
37 
41 {
42 public:
44  CoordSystem (DocumentAxesPointsRequired documentAxesPointsRequired);
45 
47  CoordSystem (const QString &fileName);
48 
49  virtual void addGraphCurveAtEnd (const QString &curveName);
50  virtual void addPointAxisWithGeneratedIdentifier (const QPointF &posScreen,
51  const QPointF &posGraph,
52  QString &identifier,
53  double ordinal,
54  bool isXOnly);
55  virtual void addPointAxisWithSpecifiedIdentifier (const QPointF &posScreen,
56  const QPointF &posGraph,
57  const QString &identifier,
58  double ordinal,
59  bool isXOnly);
60  virtual void addPointGraphWithGeneratedIdentifier (const QString &curveName,
61  const QPointF &posScreen,
62  QString &generatedIentifier,
63  double ordinal);
64  virtual void addPointGraphWithSpecifiedIdentifier (const QString &curveName,
65  const QPointF &posScreen,
66  const QString &identifier,
67  double ordinal);
69  virtual void checkAddPointAxis (const QPointF &posScreen,
70  const QPointF &posGraph,
71  bool &isError,
72  QString &errorMessage,
73  bool isXOnly);
74  virtual void checkEditPointAxis (const QString &pointIdentifier,
75  const QPointF &posScreen,
76  const QPointF &posGraph,
77  bool &isError,
78  QString &errorMessage);
79  virtual const Curve &curveAxes () const;
80  virtual Curve *curveForCurveName (const QString &curveName);
81  virtual const Curve *curveForCurveName (const QString &curveName) const;
82  virtual const CurvesGraphs &curvesGraphs () const;
83  virtual QStringList curvesGraphsNames () const;
84  virtual int curvesGraphsNumPoints (const QString &curveName) const;
85  virtual void editPointAxis (const QPointF &posGraph,
86  const QString &identifier);
87 
90  bool isXOnly (const QString &pointIdentifier) const;
91 
92  virtual void iterateThroughCurvePointsAxes (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback);
93  virtual void iterateThroughCurvePointsAxes (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback) const;
94  virtual void iterateThroughCurveSegments (const QString &curveName,
95  const Functor2wRet<const Point &, const Point &, CallbackSearchReturn> &ftorWithCallback) const;
96  virtual void iterateThroughCurvesPointsGraphs (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback);
97  virtual void iterateThroughCurvesPointsGraphs (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback) const;
98  virtual bool loadCurvesFile (const QString &curvesFile);
99 
101  void loadPreVersion6 (QDataStream &str,
102  double version);
104  void loadVersion6 (QXmlStreamReader &reader);
106  void loadVersion7 (QXmlStreamReader &reader,
107  DocumentAxesPointsRequired documentAxesPointsRequired);
108 
111  virtual DocumentModelCoords modelCoords () const;
112  virtual CurveStyles modelCurveStyles() const;
114  virtual DocumentModelExportFormat modelExport() const;
115  virtual DocumentModelGeneral modelGeneral() const;
118  virtual DocumentModelSegments modelSegments() const;
119  virtual void movePoint (const QString &pointIdentifier,
120  const QPointF &deltaScreen);
121  virtual int nextOrdinalForCurve (const QString &curveName) const;
122  virtual QPointF positionGraph (const QString &pointIdentifier) const;
123  virtual QPointF positionScreen (const QString &pointIdentifier) const;
124  virtual void print () const;
125  virtual void printStream (QString indentation,
126  QTextStream &str) const;
127  virtual QString reasonForUnsuccessfulRead () const;
128  virtual void removePointAxis (const QString &identifier);
129  virtual void removePointGraph (const QString &identifier);
130  virtual void removePointsInCurvesGraphs (CurvesGraphs &curvesGraphs);
131  virtual void saveXml (QXmlStreamWriter &writer) const;
132  virtual void setCurvesGraphs (const CurvesGraphs &curvesGraphs);
133  virtual void setModelAxesChecker(const DocumentModelAxesChecker &modelAxesChecker);
134  virtual void setModelColorFilter(const DocumentModelColorFilter &modelColorFilter);
135  virtual void setModelCoords (const DocumentModelCoords &modelCoords);
136  virtual void setModelCurveStyles(const CurveStyles &modelCurveStyles);
137  virtual void setModelDigitizeCurve (const DocumentModelDigitizeCurve &modelDigitizeCurve);
138  virtual void setModelExport(const DocumentModelExportFormat &modelExport);
139  virtual void setModelGeneral (const DocumentModelGeneral &modelGeneral);
140  virtual void setModelGridRemoval(const DocumentModelGridRemoval &modelGridRemoval);
141  void setModelPointMatch(const DocumentModelPointMatch &modelPointMatch);
142  virtual void setModelSegments(const DocumentModelSegments &modelSegments);
143  virtual bool successfulRead () const;
144  virtual void updatePointOrdinals (const Transformation &transformation);
145 
146 private:
147  CoordSystem();
148 
149  bool bytesIndicatePreVersion6 (const QByteArray &bytes) const;
150 
151  // Read variables
152  bool m_successfulRead;
153  QString m_reasonForUnsuccessfulRead;
154 
155  // Curves
156  Curve *m_curveAxes;
157  CurvesGraphs m_curvesGraphs;
158 
159  // Model objects for the various settings
160  DocumentModelAxesChecker m_modelAxesChecker;
161  // DocumentModelColorFilter is not here since filtering settings are stored inside the Curve class
162  DocumentModelCoords m_modelCoords;
163  // CurveStyles is not here since curve properties are stored inside the Curve class
164  DocumentModelDigitizeCurve m_modelDigitizeCurve;
165  DocumentModelExportFormat m_modelExport;
166  DocumentModelGeneral m_modelGeneral;
167  DocumentModelGridRemoval m_modelGridRemoval;
168  DocumentModelPointMatch m_modelPointMatch;
169  DocumentModelSegments m_modelSegments;
170 
171  // Save the number of required axes points
172  DocumentAxesPointsRequired m_documentAxesPointsRequired;
173 };
174 
175 #endif // COORD_SYSTEM_H
void loadVersion6(QXmlStreamReader &reader)
Load from file in version 6 format.
virtual DocumentModelSegments modelSegments() const
Get method for DocumentModelSegments.
Model for DlgSettingsGeneral and CmdSettingsGeneral.
Model for DlgSettingsPointMatch and CmdSettingsPointMatch.
virtual QString reasonForUnsuccessfulRead() const
Return an informative text message explaining why startup loading failed. Applies if successfulRead r...
virtual void setModelAxesChecker(const DocumentModelAxesChecker &modelAxesChecker)
Set method for DocumentModelAxesChecker.
void loadVersion7(QXmlStreamReader &reader, DocumentAxesPointsRequired documentAxesPointsRequired)
Load from file in version 7 format.
virtual DocumentModelPointMatch modelPointMatch() const
Get method for DocumentModelPointMatch.
Model for DlgSettingsExportFormat and CmdSettingsExportFormat.
Model for DlgSettingsCurveProperties and CmdSettingsCurveProperties.
Definition: CurveStyles.h:22
void setModelPointMatch(const DocumentModelPointMatch &modelPointMatch)
Set method for DocumentModelPointMatch.
void loadPreVersion6(QDataStream &str, double version)
Load from file in pre-version 6 format.
virtual void checkEditPointAxis(const QString &pointIdentifier, const QPointF &posScreen, const QPointF &posGraph, bool &isError, QString &errorMessage)
Check before calling editPointAxis.
virtual DocumentModelCoords modelCoords() const
Get method for DocumentModelCoords.
Storage of data belonging to one coordinate system.
Definition: CoordSystem.h:40
Interface common to CoordSystemContext and CoordSystem classes.
virtual bool successfulRead() const
Return true if startup loading succeeded. If the loading failed then reasonForUnsuccessfulRed will ex...
virtual void updatePointOrdinals(const Transformation &transformation)
Update point ordinals after point addition/removal or dragging.
virtual void setModelExport(const DocumentModelExportFormat &modelExport)
Set method for DocumentModelExportFormat.
virtual DocumentModelDigitizeCurve modelDigitizeCurve() const
Get method for DocumentModelDigitizeCurve.
virtual DocumentModelGeneral modelGeneral() const
Get method for DocumentModelGeneral.
virtual void setModelSegments(const DocumentModelSegments &modelSegments)
Set method for DocumentModelSegments.
virtual void setModelGridRemoval(const DocumentModelGridRemoval &modelGridRemoval)
Set method for DocumentModelGridRemoval.
virtual void checkAddPointAxis(const QPointF &posScreen, const QPointF &posGraph, bool &isError, QString &errorMessage, bool isXOnly)
Check before calling addPointAxis. Also returns the next available ordinal number (to prevent clashes...
virtual void saveXml(QXmlStreamWriter &writer) const
Save graph to xml.
virtual void addPointGraphWithGeneratedIdentifier(const QString &curveName, const QPointF &posScreen, QString &generatedIentifier, double ordinal)
Add a single graph point with a generated point identifier.
virtual void setModelGeneral(const DocumentModelGeneral &modelGeneral)
Set method for DocumentModelGeneral.
Model for DlgSettingsDigitizeCurve and CmdSettingsDigitizeCurve.
virtual void setCurvesGraphs(const CurvesGraphs &curvesGraphs)
Let CmdAbstract classes overwrite CurvesGraphs.
Affine transformation between screen and graph coordinates, based on digitized axis points...
virtual DocumentModelAxesChecker modelAxesChecker() const
Get method for DocumentModelAxesChecker.
Container for all graph curves. The axes point curve is external to this class.
Definition: CurvesGraphs.h:24
Model for DlgSettingsColorFilter and CmdSettingsColorFilter.
virtual void print() const
Debugging method for printing directly from symbolic debugger.
virtual int nextOrdinalForCurve(const QString &curveName) const
Default next ordinal value for specified curve.
virtual void addPointAxisWithSpecifiedIdentifier(const QPointF &posScreen, const QPointF &posGraph, const QString &identifier, double ordinal, bool isXOnly)
Add a single axis point with the specified point identifier.
Definition: CoordSystem.cpp:86
virtual void removePointsInCurvesGraphs(CurvesGraphs &curvesGraphs)
Remove all points identified in the specified CurvesGraphs. See also addPointsInCurvesGraphs.
bool isXOnly(const QString &pointIdentifier) const
Return true if y coordinate is undefined, otherwise x coordinae is undefined in DOCUMENT_AXES_POINT_R...
virtual CurveStyles modelCurveStyles() const
Get method for CurveStyles.
virtual const CurvesGraphs & curvesGraphs() const
Make all Curves available, read only, for CmdAbstract classes only.
virtual void setModelColorFilter(const DocumentModelColorFilter &modelColorFilter)
Set method for DocumentModelColorFilter.
virtual int curvesGraphsNumPoints(const QString &curveName) const
See CurvesGraphs::curvesGraphsNumPoints.
virtual void removePointGraph(const QString &identifier)
Perform the opposite of addPointGraph.
Model for DlgSettingsCoords and CmdSettingsCoords.
virtual QStringList curvesGraphsNames() const
See CurvesGraphs::curvesGraphsNames.
virtual const Curve & curveAxes() const
Get method for axis curve.
Container for one set of digitized Points.
Definition: Curve.h:32
virtual QPointF positionGraph(const QString &pointIdentifier) const
See Curve::positionGraph.
virtual void printStream(QString indentation, QTextStream &str) const
Debugging method that supports print method of this class and printStream method of some other class(...
virtual Curve * curveForCurveName(const QString &curveName)
See CurvesGraphs::curveForCurveName, although this also works for AXIS_CURVE_NAME.
virtual void removePointAxis(const QString &identifier)
Perform the opposite of addPointAxis.
Model for DlgSettingsAxesChecker and CmdSettingsAxesChecker.
virtual void addGraphCurveAtEnd(const QString &curveName)
Add new graph curve to the list of existing graph curves.
Definition: CoordSystem.cpp:56
virtual bool loadCurvesFile(const QString &curvesFile)
Load the curve names in the specified Engauge file into the current graph. This is called near the en...
virtual void addPointGraphWithSpecifiedIdentifier(const QString &curveName, const QPointF &posScreen, const QString &identifier, double ordinal)
Add a single graph point with the specified point identifer. Note that PointStyle is not applied to t...
virtual void addPointAxisWithGeneratedIdentifier(const QPointF &posScreen, const QPointF &posGraph, QString &identifier, double ordinal, bool isXOnly)
Add a single axis point with a generated point identifier.
Definition: CoordSystem.cpp:64
virtual void movePoint(const QString &pointIdentifier, const QPointF &deltaScreen)
See Curve::movePoint.
virtual void addPointsInCurvesGraphs(CurvesGraphs &curvesGraphs)
Add all points identified in the specified CurvesGraphs. See also removePointsInCurvesGraphs.
virtual DocumentModelColorFilter modelColorFilter() const
Get method for DocumentModelColorFilter.
virtual void iterateThroughCurvesPointsGraphs(const Functor2wRet< const QString &, const Point &, CallbackSearchReturn > &ftorWithCallback)
See Curve::iterateThroughCurvePoints, for all the graphs curves.
Model for DlgSettingsSegments and CmdSettingsSegments.
virtual void editPointAxis(const QPointF &posGraph, const QString &identifier)
Edit the graph coordinates of a single axis point. Call this after checkAddPointAxis to guarantee suc...
virtual QPointF positionScreen(const QString &pointIdentifier) const
See Curve::positionScreen.
virtual void setModelCurveStyles(const CurveStyles &modelCurveStyles)
Set method for CurveStyles.
virtual void iterateThroughCurveSegments(const QString &curveName, const Functor2wRet< const Point &, const Point &, CallbackSearchReturn > &ftorWithCallback) const
See Curve::iterateThroughCurveSegments, for any axes or graph curve.
virtual DocumentModelGridRemoval modelGridRemoval() const
Get method for DocumentModelGridRemoval.
Model for DlgSettingsGridRemoval and CmdSettingsGridRemoval. The settings are unstable until the user...
virtual DocumentModelExportFormat modelExport() const
Get method for DocumentModelExportFormat.
virtual void iterateThroughCurvePointsAxes(const Functor2wRet< const QString &, const Point &, CallbackSearchReturn > &ftorWithCallback)
See Curve::iterateThroughCurvePoints, for the axes curve.
virtual void setModelCoords(const DocumentModelCoords &modelCoords)
Set method for DocumentModelCoords.
virtual void setModelDigitizeCurve(const DocumentModelDigitizeCurve &modelDigitizeCurve)
Set method for DocumentModelDigitizeCurve.