Engauge Digitizer 2
Loading...
Searching...
No Matches
CoordSystemInterface.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_INTERFACE_H
8#define COORD_SYSTEM_INTERFACE_H
9
11#include "CurveStyles.h"
15#include "DocumentModelCoords.h"
23#include "functor.h"
24#include "Point.h"
25
26class Curve;
27class CurvesGraphs;
28class QPointF;
29class QString;
30class QStringList;
31class Transformation;
32
35{
36public:
39 virtual ~CoordSystemInterface ();
40
42 virtual void addGraphCurveAtEnd (const QString &curveName) = 0;
43
50 virtual void addPointAxisWithGeneratedIdentifier (const QPointF &posScreen,
51 const QPointF &posGraph,
52 QString &identifier,
53 double ordinal,
54 bool isXOnly) = 0;
55
62 virtual void addPointAxisWithSpecifiedIdentifier (const QPointF &posScreen,
63 const QPointF &posGraph,
64 const QString &identifier,
65 double ordinal,
66 bool isXOnly) = 0;
67
69 virtual void addPointGraphWithGeneratedIdentifier (const QString &curveName,
70 const QPointF &posScreen,
71 QString &generatedIentifier,
72 double ordinal) = 0;
73
75 virtual void addPointGraphWithSpecifiedIdentifier (const QString &curveName,
76 const QPointF &posScreen,
77 const QString &identifier,
78 double ordinal) = 0;
79
82
84 virtual void checkAddPointAxis (const QPointF &posScreen,
85 const QPointF &posGraph,
86 bool &isError,
87 QString &errorMessage,
88 bool isXOnly,
89 DocumentAxesPointsRequired documentAxesPointsRequired) = 0;
90
92 virtual void checkEditPointAxis (const QString &pointIdentifier,
93 const QPointF &posScreen,
94 const QPointF &posGraph,
95 bool &isError,
96 QString &errorMessage,
97 DocumentAxesPointsRequired documentAxesPointsRequired) = 0;
98
100 virtual const Curve &curveAxes () const = 0;
101
103 virtual Curve *curveForCurveName (const QString &curveName) = 0;
104
106 virtual const Curve *curveForCurveName (const QString &curveName) const = 0;
107
109 virtual const CurvesGraphs &curvesGraphs () const = 0;
110
112 virtual QStringList curvesGraphsNames () const = 0;
113
115 virtual int curvesGraphsNumPoints (const QString &curveName) const = 0;
116
118 virtual void editPointAxis (const QPointF &posGraph,
119 const QString &identifier) = 0;
120
122 virtual void editPointGraph (bool isX,
123 bool isY,
124 double x,
125 double y,
126 const QStringList &identifiers,
127 const Transformation &transformation) = 0;
128
130 virtual void iterateThroughCurvePointsAxes (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback) = 0;
131
133 virtual void iterateThroughCurvePointsAxes (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback) const = 0;
134
136 virtual void iterateThroughCurveSegments (const QString &curveName,
137 const Functor2wRet<const Point &, const Point &, CallbackSearchReturn> &ftorWithCallback) const = 0;
138
140 virtual void iterateThroughCurvesPointsGraphs (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback) = 0;
141
143 virtual void iterateThroughCurvesPointsGraphs (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback) const = 0;
144
146 virtual bool loadCurvesFile (const QString &curvesFile) = 0;
147
150
153
155 virtual DocumentModelCoords modelCoords () const = 0;
156
158 virtual CurveStyles modelCurveStyles() const = 0;
159
162
165
168
171
174
177
180
182 virtual void movePoint (const QString &pointIdentifier,
183 const QPointF &deltaScreen) = 0;
184
186 virtual int nextOrdinalForCurve (const QString &curveName) const = 0;
187
189 virtual QPointF positionGraph (const QString &pointIdentifier) const = 0;
190
192 virtual QPointF positionScreen (const QString &pointIdentifier) const = 0;
193
195 virtual void print () const = 0;
196
198 virtual void printStream (QString indentation,
199 QTextStream &str) const = 0;
200
202 virtual QString reasonForUnsuccessfulRead () const = 0;
203
205 virtual void removePointAxis (const QString &identifier) = 0;
206
208 virtual void removePointGraph (const QString &identifier) = 0;
209
212
214 virtual void saveXml (QXmlStreamWriter &writer) const = 0;
215
217 virtual QString selectedCurveName () const = 0;
218
220 virtual void setCurveAxes (const Curve &curveAxes) = 0;
221
223 virtual void setCurvesGraphs (const CurvesGraphs &curvesGraphs) = 0;
224
227
230
233
236
239
242
245
248
251
254
257
259 virtual void setSelectedCurveName(const QString &selectedCurveName) = 0;
260
262 virtual bool successfulRead () const = 0;
263
266 virtual void updatePointOrdinals (const Transformation &transformation) = 0;
267};
268
269#endif // COORD_SYSTEM_INTERFACE_H
Interface common to CoordSystemContext and CoordSystem classes.
virtual void movePoint(const QString &pointIdentifier, const QPointF &deltaScreen)=0
See Curve::movePoint.
virtual void setModelDigitizeCurve(const DocumentModelDigitizeCurve &modelDigitizeCurve)=0
Set method for DocumentModelDigitizeCurve.
virtual void setModelGridRemoval(const DocumentModelGridRemoval &modelGridRemoval)=0
Set method for DocumentModelGridRemoval.
virtual void printStream(QString indentation, QTextStream &str) const =0
Debugging method that supports print method of this class and printStream method of some other class(...
virtual void addPointsInCurvesGraphs(CurvesGraphs &curvesGraphs)=0
Add all points identified in the specified CurvesGraphs. See also removePointsInCurvesGraphs.
virtual void setModelColorFilter(const DocumentModelColorFilter &modelColorFilter)=0
Set method for DocumentModelColorFilter.
virtual void setSelectedCurveName(const QString &selectedCurveName)=0
Save curve name that is selected for the current coordinate system, for the next time the coordinate ...
virtual QPointF positionGraph(const QString &pointIdentifier) const =0
See Curve::positionGraph.
virtual void setModelAxesChecker(const DocumentModelAxesChecker &modelAxesChecker)=0
Set method for DocumentModelAxesChecker.
virtual void iterateThroughCurvePointsAxes(const Functor2wRet< const QString &, const Point &, CallbackSearchReturn > &ftorWithCallback)=0
See Curve::iterateThroughCurvePoints, for the axes curve.
virtual void updatePointOrdinals(const Transformation &transformation)=0
Update point ordinals after point addition/removal or dragging.
virtual const Curve * curveForCurveName(const QString &curveName) const =0
See CurvesGraphs::curveForCurveNames, although this also works for AXIS_CURVE_NAME.
virtual void saveXml(QXmlStreamWriter &writer) const =0
Save graph to xml.
CoordSystemInterface()
Single constructor.
virtual Curve * curveForCurveName(const QString &curveName)=0
See CurvesGraphs::curveForCurveName, although this also works for AXIS_CURVE_NAME.
virtual void setModelSegments(const DocumentModelSegments &modelSegments)=0
Set method for DocumentModelSegments.
virtual void removePointGraph(const QString &identifier)=0
Perform the opposite of addPointGraph.
virtual void iterateThroughCurveSegments(const QString &curveName, const Functor2wRet< const Point &, const Point &, CallbackSearchReturn > &ftorWithCallback) const =0
See Curve::iterateThroughCurveSegments, for any axes or graph curve.
virtual CurveStyles modelCurveStyles() const =0
Get method for CurveStyles.
virtual void checkAddPointAxis(const QPointF &posScreen, const QPointF &posGraph, bool &isError, QString &errorMessage, bool isXOnly, DocumentAxesPointsRequired documentAxesPointsRequired)=0
Check before calling addPointAxis. Also returns the next available ordinal number (to prevent clashes...
virtual QString reasonForUnsuccessfulRead() const =0
Return an informative text message explaining why startup loading failed. Applies if successfulRead r...
virtual void removePointAxis(const QString &identifier)=0
Perform the opposite of addPointAxis.
virtual void iterateThroughCurvesPointsGraphs(const Functor2wRet< const QString &, const Point &, CallbackSearchReturn > &ftorWithCallback) const =0
See Curve::iterateThroughCurvePoints, for all the graphs curves.
virtual void print() const =0
Debugging method for printing directly from symbolic debugger.
virtual void setModelExport(const DocumentModelExportFormat &modelExport)=0
Set method for DocumentModelExportFormat.
virtual void setModelGeneral(const DocumentModelGeneral &modelGeneral)=0
Set method for DocumentModelGeneral.
virtual void setModelGridDisplay(const DocumentModelGridDisplay &modelGridDisplay)=0
Set method for DocumentModelGridDisplay.
virtual DocumentModelGridDisplay modelGridDisplay() const =0
Get method for DocumentModelGridDisplay.
virtual const CurvesGraphs & curvesGraphs() const =0
Make all Curves available, read only, for CmdAbstract classes only.
virtual void iterateThroughCurvesPointsGraphs(const Functor2wRet< const QString &, const Point &, CallbackSearchReturn > &ftorWithCallback)=0
See Curve::iterateThroughCurvePoints, for all the graphs curves.
virtual DocumentModelColorFilter modelColorFilter() const =0
Get method for DocumentModelColorFilter.
virtual DocumentModelGridRemoval modelGridRemoval() const =0
Get method for DocumentModelGridRemoval.
virtual void setModelCoords(const DocumentModelCoords &modelCoords)=0
Set method for DocumentModelCoords.
virtual QPointF positionScreen(const QString &pointIdentifier) const =0
See Curve::positionScreen.
virtual QStringList curvesGraphsNames() const =0
See CurvesGraphs::curvesGraphsNames.
virtual void checkEditPointAxis(const QString &pointIdentifier, const QPointF &posScreen, const QPointF &posGraph, bool &isError, QString &errorMessage, DocumentAxesPointsRequired documentAxesPointsRequired)=0
Check before calling editPointAxis.
virtual void addPointAxisWithSpecifiedIdentifier(const QPointF &posScreen, const QPointF &posGraph, const QString &identifier, double ordinal, bool isXOnly)=0
Add a single axis point with the specified point identifier.
virtual void editPointAxis(const QPointF &posGraph, const QString &identifier)=0
Edit the graph coordinates of a single axis point. Call this after checkAddPointAxis to guarantee suc...
virtual void editPointGraph(bool isX, bool isY, double x, double y, const QStringList &identifiers, const Transformation &transformation)=0
Edit the graph coordinates of one or more graph points.
virtual void iterateThroughCurvePointsAxes(const Functor2wRet< const QString &, const Point &, CallbackSearchReturn > &ftorWithCallback) const =0
See Curve::iterateThroughCurvePoints, for the axes curve.
virtual int curvesGraphsNumPoints(const QString &curveName) const =0
See CurvesGraphs::curvesGraphsNumPoints.
virtual DocumentModelPointMatch modelPointMatch() const =0
Get method for DocumentModelPointMatch.
virtual void addPointGraphWithSpecifiedIdentifier(const QString &curveName, const QPointF &posScreen, const QString &identifier, double ordinal)=0
Add a single graph point with the specified point identifer. Note that PointStyle is not applied to t...
virtual void setCurveAxes(const Curve &curveAxes)=0
Let CmdAbstract classes overwrite axes Curve. Applies to current coordinate system.
virtual void removePointsInCurvesGraphs(CurvesGraphs &curvesGraphs)=0
Remove all points identified in the specified CurvesGraphs. See also addPointsInCurvesGraphs.
virtual DocumentModelSegments modelSegments() const =0
Get method for DocumentModelSegments.
virtual void setCurvesGraphs(const CurvesGraphs &curvesGraphs)=0
Let CmdAbstract classes overwrite CurvesGraphs. Applies to current coordinate system.
virtual DocumentModelAxesChecker modelAxesChecker() const =0
Get method for DocumentModelAxesChecker.
virtual bool successfulRead() const =0
Return true if startup loading succeeded. If the loading failed then reasonForUnsuccessfulRed will ex...
virtual QString selectedCurveName() const =0
Currently selected curve name. This is used to set the selected curve combobox in MainWindow.
virtual DocumentModelGeneral modelGeneral() const =0
Get method for DocumentModelGeneral.
virtual void setModelPointMatch(const DocumentModelPointMatch &modelPointMatch)=0
Set method for DocumentModelPointMatch.
virtual void addPointGraphWithGeneratedIdentifier(const QString &curveName, const QPointF &posScreen, QString &generatedIentifier, double ordinal)=0
Add a single graph point with a generated point identifier.
virtual void addGraphCurveAtEnd(const QString &curveName)=0
Add new graph curve to the list of existing graph curves.
virtual const Curve & curveAxes() const =0
Get method for axis curve.
virtual DocumentModelDigitizeCurve modelDigitizeCurve() const =0
Get method for DocumentModelDigitizeCurve.
virtual DocumentModelExportFormat modelExport() const =0
Get method for DocumentModelExportFormat.
virtual void addPointAxisWithGeneratedIdentifier(const QPointF &posScreen, const QPointF &posGraph, QString &identifier, double ordinal, bool isXOnly)=0
Add a single axis point with a generated point identifier.
virtual DocumentModelCoords modelCoords() const =0
Get method for DocumentModelCoords.
virtual bool loadCurvesFile(const QString &curvesFile)=0
Load the curve names in the specified Engauge file into the current graph. This is called near the en...
virtual void setModelCurveStyles(const CurveStyles &modelCurveStyles)=0
Set method for CurveStyles.
virtual int nextOrdinalForCurve(const QString &curveName) const =0
Default next ordinal value for specified curve.
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.