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