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 "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 <QXmlStreamReader>
29 
30 class Curve;
31 class QByteArray;
32 class QDataStream;
33 class QImage;
34 class QTransform;
35 class QXmlStreamReader;
36 class QXmlStreamWriter;
37 class Transformation;
38 
42 {
43 public:
45  CoordSystem (DocumentAxesPointsRequired documentAxesPointsRequired);
46 
48  CoordSystem (const QString &fileName);
49 
50  virtual void addGraphCurveAtEnd (const QString &curveName);
51  virtual void addPointAxisWithGeneratedIdentifier (const QPointF &posScreen,
52  const QPointF &posGraph,
53  QString &identifier,
54  double ordinal,
55  bool isXOnly);
56  virtual void addPointAxisWithSpecifiedIdentifier (const QPointF &posScreen,
57  const QPointF &posGraph,
58  const QString &identifier,
59  double ordinal,
60  bool isXOnly);
61  virtual void addPointGraphWithGeneratedIdentifier (const QString &curveName,
62  const QPointF &posScreen,
63  QString &generatedIentifier,
64  double ordinal);
65  virtual void addPointGraphWithSpecifiedIdentifier (const QString &curveName,
66  const QPointF &posScreen,
67  const QString &identifier,
68  double ordinal);
70  virtual void checkAddPointAxis (const QPointF &posScreen,
71  const QPointF &posGraph,
72  bool &isError,
73  QString &errorMessage,
74  bool isXOnly);
75  virtual void checkEditPointAxis (const QString &pointIdentifier,
76  const QPointF &posScreen,
77  const QPointF &posGraph,
78  bool &isError,
79  QString &errorMessage);
80  virtual const Curve &curveAxes () const;
81  virtual Curve *curveForCurveName (const QString &curveName);
82  virtual const Curve *curveForCurveName (const QString &curveName) const;
83  virtual const CurvesGraphs &curvesGraphs () const;
84  virtual QStringList curvesGraphsNames () const;
85  virtual int curvesGraphsNumPoints (const QString &curveName) const;
86  virtual void editPointAxis (const QPointF &posGraph,
87  const QString &identifier);
88 
91  bool isXOnly (const QString &pointIdentifier) const;
92 
93  virtual void iterateThroughCurvePointsAxes (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback);
94  virtual void iterateThroughCurvePointsAxes (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback) const;
95  virtual void iterateThroughCurveSegments (const QString &curveName,
96  const Functor2wRet<const Point &, const Point &, CallbackSearchReturn> &ftorWithCallback) const;
97  virtual void iterateThroughCurvesPointsGraphs (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback);
98  virtual void iterateThroughCurvesPointsGraphs (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback) const;
99  virtual bool loadCurvesFile (const QString &curvesFile);
100 
102  void loadPreVersion6 (QDataStream &str,
103  double version);
105  void loadVersion6 (QXmlStreamReader &reader);
107  void loadVersions7AndUp (QXmlStreamReader &reader,
108  DocumentAxesPointsRequired documentAxesPointsRequired);
109 
112  virtual DocumentModelCoords modelCoords () const;
113  virtual CurveStyles modelCurveStyles() const;
115  virtual DocumentModelExportFormat modelExport() const;
116  virtual DocumentModelGeneral modelGeneral() const;
120  virtual DocumentModelSegments modelSegments() const;
121  virtual void movePoint (const QString &pointIdentifier,
122  const QPointF &deltaScreen);
123  virtual int nextOrdinalForCurve (const QString &curveName) const;
124  virtual QPointF positionGraph (const QString &pointIdentifier) const;
125  virtual QPointF positionScreen (const QString &pointIdentifier) const;
126  virtual void print () const;
127  virtual void printStream (QString indentation,
128  QTextStream &str) const;
129  virtual QString reasonForUnsuccessfulRead () const;
130  virtual void removePointAxis (const QString &identifier);
131  virtual void removePointGraph (const QString &identifier);
132  virtual void removePointsInCurvesGraphs (CurvesGraphs &curvesGraphs);
133  virtual void saveXml (QXmlStreamWriter &writer) const;
134  virtual QString selectedCurveName () const;
135  virtual void setCurveAxes (const Curve &curveAxes);
136  virtual void setCurvesGraphs (const CurvesGraphs &curvesGraphs);
137  virtual void setModelAxesChecker(const DocumentModelAxesChecker &modelAxesChecker);
138  virtual void setModelColorFilter(const DocumentModelColorFilter &modelColorFilter);
139  virtual void setModelCoords (const DocumentModelCoords &modelCoords);
140  virtual void setModelCurveStyles(const CurveStyles &modelCurveStyles);
141  virtual void setModelDigitizeCurve (const DocumentModelDigitizeCurve &modelDigitizeCurve);
142  virtual void setModelExport(const DocumentModelExportFormat &modelExport);
143  virtual void setModelGeneral (const DocumentModelGeneral &modelGeneral);
144  virtual void setModelGridDisplay(const DocumentModelGridDisplay &modelGridDisplay);
145  virtual void setModelGridRemoval(const DocumentModelGridRemoval &modelGridRemoval);
146  void setModelPointMatch(const DocumentModelPointMatch &modelPointMatch);
147  virtual void setModelSegments(const DocumentModelSegments &modelSegments);
148  virtual void setSelectedCurveName(const QString &selectedCurveName);
149  virtual bool successfulRead () const;
150  virtual void updatePointOrdinals (const Transformation &transformation);
151 
152 private:
153  CoordSystem();
154 
155  bool bytesIndicatePreVersion6 (const QByteArray &bytes) const;
156  void resetSelectedCurveNameIfNecessary ();
157 
158  // Read variables
159  bool m_successfulRead;
160  QString m_reasonForUnsuccessfulRead;
161 
162  // Curves
163  Curve *m_curveAxes;
164  CurvesGraphs m_curvesGraphs;
165 
166  // Model objects for the various settings
167  DocumentModelAxesChecker m_modelAxesChecker;
168  // DocumentModelColorFilter is not here since filtering settings are stored inside the Curve class
169  DocumentModelCoords m_modelCoords;
170  // CurveStyles is not here since curve properties are stored inside the Curve class
171  DocumentModelDigitizeCurve m_modelDigitizeCurve;
172  DocumentModelExportFormat m_modelExport;
173  DocumentModelGeneral m_modelGeneral;
174  DocumentModelGridDisplay m_modelGridDisplay;
175  DocumentModelGridRemoval m_modelGridRemoval;
176  DocumentModelPointMatch m_modelPointMatch;
177  DocumentModelSegments m_modelSegments;
178 
179  // Save the number of required axes points
180  DocumentAxesPointsRequired m_documentAxesPointsRequired;
181 
182  // Each coordinate systems manages its own selected curve name
183  QString m_selectedCurveName;
184 };
185 
186 #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...
Model for DlgSettingsGridDisplay and CmdSettingsGridDisplay.
virtual void setModelAxesChecker(const DocumentModelAxesChecker &modelAxesChecker)
Set method for DocumentModelAxesChecker.
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 void setModelGridDisplay(const DocumentModelGridDisplay &modelGridDisplay)
Set method for DocumentModelGridDisplay.
virtual DocumentModelCoords modelCoords() const
Get method for DocumentModelCoords.
Storage of data belonging to one coordinate system.
Definition: CoordSystem.h:41
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.
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 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. Applies to current coordinate system.
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 void setCurveAxes(const Curve &curveAxes)
Let CmdAbstract classes overwrite axes Curve. Applies to current coordinate system.
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:90
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 QString selectedCurveName() const
Currently selected curve name. This is used to set the selected curve combobox in MainWindow...
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:58
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:68
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 DocumentModelGridDisplay modelGridDisplay() const
Get method for DocumentModelGridDisplay.
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 setSelectedCurveName(const QString &selectedCurveName)
Save curve name that is selected for the current coordinate system, for the next time the coordinate ...
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.