Engauge Digitizer  2
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 "DocumentModelGridDisplay.h"
21 #include "DocumentModelGridRemoval.h"
22 #include "DocumentModelPointMatch.h"
23 #include "DocumentModelSegments.h"
24 #include "PointStyle.h"
25 #include <QList>
26 #include <QPixmap>
27 #include <QString>
28 #include <QStringList>
29 #include <QXmlStreamReader>
30 
31 class Curve;
32 class QByteArray;
33 class QDataStream;
34 class QImage;
35 class QTransform;
36 class QXmlStreamReader;
37 class QXmlStreamWriter;
38 class Transformation;
39 
43 {
44 public:
46  CoordSystem (DocumentAxesPointsRequired documentAxesPointsRequired);
47 
49  CoordSystem (const QString &fileName);
50 
51  virtual void addGraphCurveAtEnd (const QString &curveName);
52  virtual void addPointAxisWithGeneratedIdentifier (const QPointF &posScreen,
53  const QPointF &posGraph,
54  QString &identifier,
55  double ordinal,
56  bool isXOnly);
57  virtual void addPointAxisWithSpecifiedIdentifier (const QPointF &posScreen,
58  const QPointF &posGraph,
59  const QString &identifier,
60  double ordinal,
61  bool isXOnly);
62  virtual void addPointGraphWithGeneratedIdentifier (const QString &curveName,
63  const QPointF &posScreen,
64  QString &generatedIentifier,
65  double ordinal);
66  virtual void addPointGraphWithSpecifiedIdentifier (const QString &curveName,
67  const QPointF &posScreen,
68  const QString &identifier,
69  double ordinal);
71  virtual void checkAddPointAxis (const QPointF &posScreen,
72  const QPointF &posGraph,
73  bool &isError,
74  QString &errorMessage,
75  bool isXOnly);
76  virtual void checkEditPointAxis (const QString &pointIdentifier,
77  const QPointF &posScreen,
78  const QPointF &posGraph,
79  bool &isError,
80  QString &errorMessage);
81  virtual const Curve &curveAxes () const;
82  virtual Curve *curveForCurveName (const QString &curveName);
83  virtual const Curve *curveForCurveName (const QString &curveName) const;
84  virtual const CurvesGraphs &curvesGraphs () const;
85  virtual QStringList curvesGraphsNames () const;
86  virtual int curvesGraphsNumPoints (const QString &curveName) const;
87  virtual DocumentAxesPointsRequired documentAxesPointsRequired () const;
88  virtual void editPointAxis (const QPointF &posGraph,
89  const QString &identifier);
90  virtual void editPointGraph (bool isX,
91  bool isY,
92  double x,
93  double y,
94  const QStringList &identifiers,
95  const Transformation &transformation);
96 
99  bool isXOnly (const QString &pointIdentifier) const;
100 
101  virtual void iterateThroughCurvePointsAxes (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback);
102  virtual void iterateThroughCurvePointsAxes (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback) const;
103  virtual void iterateThroughCurveSegments (const QString &curveName,
104  const Functor2wRet<const Point &, const Point &, CallbackSearchReturn> &ftorWithCallback) const;
105  virtual void iterateThroughCurvesPointsGraphs (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback);
106  virtual void iterateThroughCurvesPointsGraphs (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback) const;
107  virtual bool loadCurvesFile (const QString &curvesFile);
108 
110  void loadPreVersion6 (QDataStream &str,
111  double version);
113  void loadVersion6 (QXmlStreamReader &reader);
115  void loadVersions7AndUp (QXmlStreamReader &reader,
116  DocumentAxesPointsRequired documentAxesPointsRequired);
117 
120  virtual DocumentModelCoords modelCoords () const;
121  virtual CurveStyles modelCurveStyles() const;
123  virtual DocumentModelExportFormat modelExport() const;
124  virtual DocumentModelGeneral modelGeneral() const;
128  virtual DocumentModelSegments modelSegments() const;
129  virtual void movePoint (const QString &pointIdentifier,
130  const QPointF &deltaScreen);
131  virtual int nextOrdinalForCurve (const QString &curveName) const;
132  virtual QPointF positionGraph (const QString &pointIdentifier) const;
133  virtual QPointF positionScreen (const QString &pointIdentifier) const;
134  virtual void print () const;
135  virtual void printStream (QString indentation,
136  QTextStream &str) const;
137  virtual QString reasonForUnsuccessfulRead () const;
138  virtual void removePointAxis (const QString &identifier);
139  virtual void removePointGraph (const QString &identifier);
140  virtual void removePointsInCurvesGraphs (CurvesGraphs &curvesGraphs);
141  virtual void saveXml (QXmlStreamWriter &writer) const;
142  virtual QString selectedCurveName () const;
143  virtual void setCurveAxes (const Curve &curveAxes);
144  virtual void setCurvesGraphs (const CurvesGraphs &curvesGraphs);
145  virtual void setModelAxesChecker(const DocumentModelAxesChecker &modelAxesChecker);
146  virtual void setModelColorFilter(const DocumentModelColorFilter &modelColorFilter);
147  virtual void setModelCoords (const DocumentModelCoords &modelCoords);
148  virtual void setModelCurveStyles(const CurveStyles &modelCurveStyles);
149  virtual void setModelDigitizeCurve (const DocumentModelDigitizeCurve &modelDigitizeCurve);
150  virtual void setModelExport(const DocumentModelExportFormat &modelExport);
151  virtual void setModelGeneral (const DocumentModelGeneral &modelGeneral);
152  virtual void setModelGridDisplay(const DocumentModelGridDisplay &modelGridDisplay);
153  virtual void setModelGridRemoval(const DocumentModelGridRemoval &modelGridRemoval);
154  void setModelPointMatch(const DocumentModelPointMatch &modelPointMatch);
155  virtual void setModelSegments(const DocumentModelSegments &modelSegments);
156  virtual void setSelectedCurveName(const QString &selectedCurveName);
157  virtual bool successfulRead () const;
158  virtual void updatePointOrdinals (const Transformation &transformation);
159 
160 private:
161  CoordSystem();
162 
163  bool bytesIndicatePreVersion6 (const QByteArray &bytes) const;
164  void resetSelectedCurveNameIfNecessary ();
165 
166  // Read variables
167  bool m_successfulRead;
168  QString m_reasonForUnsuccessfulRead;
169 
170  // Curves
171  Curve *m_curveAxes;
172  CurvesGraphs m_curvesGraphs;
173 
174  // Model objects for the various settings
175  DocumentModelAxesChecker m_modelAxesChecker;
176  // DocumentModelColorFilter is not here since filtering settings are stored inside the Curve class
177  DocumentModelCoords m_modelCoords;
178  // CurveStyles is not here since curve properties are stored inside the Curve class
179  DocumentModelDigitizeCurve m_modelDigitizeCurve;
180  DocumentModelExportFormat m_modelExport;
181  DocumentModelGeneral m_modelGeneral;
182  DocumentModelGridDisplay m_modelGridDisplay;
183  DocumentModelGridRemoval m_modelGridRemoval;
184  DocumentModelPointMatch m_modelPointMatch;
185  DocumentModelSegments m_modelSegments;
186 
187  // Save the number of required axes points
188  DocumentAxesPointsRequired m_documentAxesPointsRequired;
189 
190  // Each coordinate systems manages its own selected curve name
191  QString m_selectedCurveName;
192 };
193 
194 #endif // COORD_SYSTEM_H
void loadVersion6(QXmlStreamReader &reader)
Load from file in version 6 format.
Model for DlgSettingsGeneral and CmdSettingsGeneral.
Model for DlgSettingsPointMatch and CmdSettingsPointMatch.
Model for DlgSettingsGridDisplay and CmdSettingsGridDisplay.
virtual void setModelAxesChecker(const DocumentModelAxesChecker &modelAxesChecker)
Set method for DocumentModelAxesChecker.
virtual void printStream(QString indentation, QTextStream &str) const
Debugging method that supports print method of this class and printStream method of some other class(...
Model for DlgSettingsExportFormat and CmdSettingsExportFormat.
virtual DocumentModelGridRemoval modelGridRemoval() const
Get method for DocumentModelGridRemoval.
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 DocumentModelGridDisplay modelGridDisplay() const
Get method for DocumentModelGridDisplay.
virtual void checkEditPointAxis(const QString &pointIdentifier, const QPointF &posScreen, const QPointF &posGraph, bool &isError, QString &errorMessage)
Check before calling editPointAxis.
virtual const CurvesGraphs & curvesGraphs() const
Make all Curves available, read only, for CmdAbstract classes only.
virtual QString reasonForUnsuccessfulRead() const
Return an informative text message explaining why startup loading failed. Applies if successfulRead r...
virtual void setModelGridDisplay(const DocumentModelGridDisplay &modelGridDisplay)
Set method for DocumentModelGridDisplay.
virtual DocumentModelPointMatch modelPointMatch() const
Get method for DocumentModelPointMatch.
Storage of data belonging to one coordinate system.
Definition: CoordSystem.h:42
virtual bool successfulRead() const
Return true if startup loading succeeded. If the loading failed then reasonForUnsuccessfulRed will ex...
Interface common to CoordSystemContext and CoordSystem classes.
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 QStringList curvesGraphsNames() const
See CurvesGraphs::curvesGraphsNames.
bool isXOnly(const QString &pointIdentifier) const
Return true if y coordinate is undefined, otherwise x coordinae is undefined in DOCUMENT_AXES_POINT_R...
virtual DocumentModelDigitizeCurve modelDigitizeCurve() const
Get method for DocumentModelDigitizeCurve.
virtual void setModelSegments(const DocumentModelSegments &modelSegments)
Set method for DocumentModelSegments.
virtual void setModelGridRemoval(const DocumentModelGridRemoval &modelGridRemoval)
Set method for DocumentModelGridRemoval.
virtual void iterateThroughCurveSegments(const QString &curveName, const Functor2wRet< const Point &, const Point &, CallbackSearchReturn > &ftorWithCallback) const
See Curve::iterateThroughCurveSegments, for any axes or graph curve.
void loadVersions7AndUp(QXmlStreamReader &reader, DocumentAxesPointsRequired documentAxesPointsRequired)
Load from file in versions 7 and 8 formats.
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 addPointGraphWithGeneratedIdentifier(const QString &curveName, const QPointF &posScreen, QString &generatedIentifier, double ordinal)
Add a single graph point with a generated point identifier.
virtual int nextOrdinalForCurve(const QString &curveName) const
Default next ordinal value for specified curve.
virtual void setModelGeneral(const DocumentModelGeneral &modelGeneral)
Set method for DocumentModelGeneral.
virtual DocumentModelCoords modelCoords() const
Get method for DocumentModelCoords.
Model for DlgSettingsDigitizeCurve and CmdSettingsDigitizeCurve.
virtual void setCurvesGraphs(const CurvesGraphs &curvesGraphs)
Let CmdAbstract classes overwrite CurvesGraphs. Applies to current coordinate system.
virtual DocumentModelSegments modelSegments() const
Get method for DocumentModelSegments.
Affine transformation between screen and graph coordinates, based on digitized axis points...
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 setCurveAxes(const Curve &curveAxes)
Let CmdAbstract classes overwrite axes Curve. Applies to current coordinate system.
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:95
virtual DocumentModelAxesChecker modelAxesChecker() const
Get method for DocumentModelAxesChecker.
virtual void removePointsInCurvesGraphs(CurvesGraphs &curvesGraphs)
Remove all points identified in the specified CurvesGraphs. See also addPointsInCurvesGraphs.
virtual void saveXml(QXmlStreamWriter &writer) const
Save graph to xml.
virtual void setModelColorFilter(const DocumentModelColorFilter &modelColorFilter)
Set method for DocumentModelColorFilter.
virtual DocumentModelColorFilter modelColorFilter() const
Get method for DocumentModelColorFilter.
virtual void removePointGraph(const QString &identifier)
Perform the opposite of addPointGraph.
Model for DlgSettingsCoords and CmdSettingsCoords.
Container for one set of digitized Points.
Definition: Curve.h:33
virtual QPointF positionGraph(const QString &pointIdentifier) const
See Curve::positionGraph.
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:63
virtual QPointF positionScreen(const QString &pointIdentifier) const
See Curve::positionScreen.
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:73
virtual void print() const
Debugging method for printing directly from symbolic debugger.
virtual void movePoint(const QString &pointIdentifier, const QPointF &deltaScreen)
See Curve::movePoint.
virtual void editPointGraph(bool isX, bool isY, double x, double y, const QStringList &identifiers, const Transformation &transformation)
Edit the graph coordinates of one or more graph points.
virtual DocumentModelGeneral modelGeneral() const
Get method for DocumentModelGeneral.
virtual void addPointsInCurvesGraphs(CurvesGraphs &curvesGraphs)
Add all points identified in the specified CurvesGraphs. See also removePointsInCurvesGraphs.
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 DocumentModelExportFormat modelExport() const
Get method for DocumentModelExportFormat.
virtual int curvesGraphsNumPoints(const QString &curveName) const
See CurvesGraphs::curvesGraphsNumPoints.
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 void setModelCurveStyles(const CurveStyles &modelCurveStyles)
Set method for CurveStyles.
virtual void setSelectedCurveName(const QString &selectedCurveName)
Save curve name that is selected for the current coordinate system, for the next time the coordinate ...
virtual CurveStyles modelCurveStyles() const
Get method for CurveStyles.
virtual const Curve & curveAxes() const
Get method for axis curve.
Model for DlgSettingsGridRemoval and CmdSettingsGridRemoval. The settings are unstable until the user...
virtual QString selectedCurveName() const
Currently selected curve name. This is used to set the selected curve combobox in MainWindow...
virtual void iterateThroughCurvePointsAxes(const Functor2wRet< const QString &, const Point &, CallbackSearchReturn > &ftorWithCallback)
See Curve::iterateThroughCurvePoints, for the axes curve.
virtual DocumentAxesPointsRequired documentAxesPointsRequired() const
Number of axes points for map or graph. This value is returned after opening a file.
virtual void setModelCoords(const DocumentModelCoords &modelCoords)
Set method for DocumentModelCoords.
virtual void setModelDigitizeCurve(const DocumentModelDigitizeCurve &modelDigitizeCurve)
Set method for DocumentModelDigitizeCurve.