Engauge Digitizer 2
Loading...
Searching...
No Matches
CoordSystemInterface.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_INTERFACE_H
8#define COORD_SYSTEM_INTERFACE_H
9
11#include "CurveStyles.h"
12#include "DocumentModelAxesChecker.h"
13#include "DocumentModelColorFilter.h"
14#include "DocumentModelCoords.h"
15#include "DocumentModelDigitizeCurve.h"
16#include "DocumentModelExportFormat.h"
17#include "DocumentModelGeneral.h"
18#include "DocumentModelGridRemoval.h"
19#include "DocumentModelPointMatch.h"
20#include "DocumentModelSegments.h"
21#include "functor.h"
22#include "Point.h"
23
24class Curve;
25class CurvesGraphs;
26class QPointF;
27class QString;
28class QStringList;
29class Transformation;
30
33{
34public:
37 virtual ~CoordSystemInterface ();
38
40 virtual void addGraphCurveAtEnd (const QString &curveName) = 0;
41
48 virtual void addPointAxisWithGeneratedIdentifier (const QPointF &posScreen,
49 const QPointF &posGraph,
50 QString &identifier,
51 double ordinal,
52 bool isXOnly) = 0;
53
60 virtual void addPointAxisWithSpecifiedIdentifier (const QPointF &posScreen,
61 const QPointF &posGraph,
62 const QString &identifier,
63 double ordinal,
64 bool isXOnly) = 0;
65
67 virtual void addPointGraphWithGeneratedIdentifier (const QString &curveName,
68 const QPointF &posScreen,
69 QString &generatedIentifier,
70 double ordinal) = 0;
71
73 virtual void addPointGraphWithSpecifiedIdentifier (const QString &curveName,
74 const QPointF &posScreen,
75 const QString &identifier,
76 double ordinal) = 0;
77
80
82 virtual void checkAddPointAxis (const QPointF &posScreen,
83 const QPointF &posGraph,
84 bool &isError,
85 QString &errorMessage,
86 bool isXOnly) = 0;
87
89 virtual void checkEditPointAxis (const QString &pointIdentifier,
90 const QPointF &posScreen,
91 const QPointF &posGraph,
92 bool &isError,
93 QString &errorMessage) = 0;
94
96 virtual const Curve &curveAxes () const = 0;
97
99 virtual Curve *curveForCurveName (const QString &curveName) = 0;
100
102 virtual const Curve *curveForCurveName (const QString &curveName) const = 0;
103
105 virtual const CurvesGraphs &curvesGraphs () const = 0;
106
108 virtual QStringList curvesGraphsNames () const = 0;
109
111 virtual int curvesGraphsNumPoints (const QString &curveName) const = 0;
112
114 virtual void editPointAxis (const QPointF &posGraph,
115 const QString &identifier) = 0;
116
118 virtual void iterateThroughCurvePointsAxes (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback) = 0;
119
121 virtual void iterateThroughCurvePointsAxes (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback) const = 0;
122
124 virtual void iterateThroughCurveSegments (const QString &curveName,
125 const Functor2wRet<const Point &, const Point &, CallbackSearchReturn> &ftorWithCallback) const = 0;
126
128 virtual void iterateThroughCurvesPointsGraphs (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback) = 0;
129
131 virtual void iterateThroughCurvesPointsGraphs (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback) const = 0;
132
134 virtual bool loadCurvesFile (const QString &curvesFile) = 0;
135
138
141
143 virtual DocumentModelCoords modelCoords () const = 0;
144
146 virtual CurveStyles modelCurveStyles() const = 0;
147
150
153
156
159
162
165
167 virtual void movePoint (const QString &pointIdentifier,
168 const QPointF &deltaScreen) = 0;
169
171 virtual int nextOrdinalForCurve (const QString &curveName) const = 0;
172
174 virtual QPointF positionGraph (const QString &pointIdentifier) const = 0;
175
177 virtual QPointF positionScreen (const QString &pointIdentifier) const = 0;
178
180 virtual void print () const = 0;
181
183 virtual void printStream (QString indentation,
184 QTextStream &str) const = 0;
185
187 virtual QString reasonForUnsuccessfulRead () const = 0;
188
190 virtual void removePointAxis (const QString &identifier) = 0;
191
193 virtual void removePointGraph (const QString &identifier) = 0;
194
197
199 virtual void saveXml (QXmlStreamWriter &writer) const = 0;
200
202 virtual void setCurvesGraphs (const CurvesGraphs &curvesGraphs) = 0;
203
206
209
212
215
218
221
224
227
230
233
235 virtual bool successfulRead () const = 0;
236
239 virtual void updatePointOrdinals (const Transformation &transformation) = 0;
240};
241
242#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 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 void checkAddPointAxis(const QPointF &posScreen, const QPointF &posGraph, bool &isError, QString &errorMessage, bool isXOnly)=0
Check before calling addPointAxis. Also returns the next available ordinal number (to prevent clashes...
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 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 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 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 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 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.
virtual DocumentModelAxesChecker modelAxesChecker() const =0
Get method for DocumentModelAxesChecker.
virtual void checkEditPointAxis(const QString &pointIdentifier, const QPointF &posScreen, const QPointF &posGraph, bool &isError, QString &errorMessage)=0
Check before calling editPointAxis.
virtual bool successfulRead() const =0
Return true if startup loading succeeded. If the loading failed then reasonForUnsuccessfulRed will ex...
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:33
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 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.