Engauge Digitizer 2
Loading...
Searching...
No Matches
Document.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 DOCUMENT_H
8#define DOCUMENT_H
9
10#include "CoordSystemContext.h"
11#include "CoordSystemIndex.h"
12#include "CurvesGraphs.h"
13#include "CurveStyles.h"
17#include "DocumentModelCoords.h"
27#include "PointStyle.h"
28#include <QList>
29#include <QPixmap>
30#include <QString>
31#include <QXmlStreamReader>
32
33class CoordSystem;
34class Curve;
35class QByteArray;
36class QFile;
37class QImage;
38class QTransform;
39class QXmlStreamWriter;
40class Transformation;
41
44{
45public:
47 Document (const QImage &image);
48
50 Document (const QString &fileName);
51
54 void addCoordSystems(unsigned int numberCoordSystemToAdd);
55
57 void addGraphCurveAtEnd (const QString &curveName);
58
65 void addPointAxisWithGeneratedIdentifier (const QPointF &posScreen,
66 const QPointF &posGraph,
67 QString &identifier,
68 double ordinal,
69 bool isXOnly);
70
77 void addPointAxisWithSpecifiedIdentifier (const QPointF &posScreen,
78 const QPointF &posGraph,
79 const QString &identifier,
80 double ordinal,
81 bool isXOnly);
82
84 void addPointGraphWithGeneratedIdentifier (const QString &curveName,
85 const QPointF &posScreen,
86 QString &generatedIentifier,
87 double ordinal);
88
90 void addPointGraphWithSpecifiedIdentifier (const QString &curveName,
91 const QPointF &posScreen,
92 const QString &identifier,
93 double ordinal);
94
97
106 void addScaleWithGeneratedIdentifier (const QPointF &posScreen0,
107 const QPointF &posScreen1,
108 double scaleLength,
109 QString &identifier0,
110 QString &identifier1,
111 double ordinal0,
112 double ordinal1);
113
115 void checkAddPointAxis (const QPointF &posScreen,
116 const QPointF &posGraph,
117 bool &isError,
118 QString &errorMessage,
119 bool isXOnly);
120
122 void checkEditPointAxis (const QString &pointIdentifier,
123 const QPointF &posScreen,
124 const QPointF &posGraph,
125 bool &isError,
126 QString &errorMessage);
127
129 const CoordSystem &coordSystem() const;
130
132 unsigned int coordSystemCount() const;
133
136
138 const Curve &curveAxes () const;
139
141 const Curve *curveForCurveName (const QString &curveName) const;
142
144 const CurvesGraphs &curvesGraphs () const;
145
147 QStringList curvesGraphsNames () const;
148
150 int curvesGraphsNumPoints (const QString &curveName) const;
151
154
156 void editPointAxis (const QPointF &posGraph,
157 const QString &identifier);
158
160 void editPointGraph (bool isX,
161 bool isY,
162 double x,
163 double y,
164 const QStringList &identifiers,
165 const Transformation &transformation);
166
169
171 void initializeGridDisplay (const Transformation &transformation);
172
174 bool isXOnly (const QString &pointIdentifier) const;
175
177 void iterateThroughCurvePointsAxes (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback);
178
180 void iterateThroughCurvePointsAxes (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback) const;
181
183 void iterateThroughCurveSegments (const QString &curveName,
184 const Functor2wRet<const Point &, const Point &, CallbackSearchReturn> &ftorWithCallback) const;
185
187 void iterateThroughCurvesPointsGraphs (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback);
188
190 void iterateThroughCurvesPointsGraphs (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback) const;
191
193 bool loadCurvesFile (const QString &curvesFile);
194
197
200
203
206
209
212
215
218
221
224
227
230
233
235 void movePoint (const QString &pointIdentifier,
236 const QPointF &deltaScreen);
237
239 int nextOrdinalForCurve (const QString &curveName) const;
240
242 QPixmap pixmap () const;
243
245 QPointF positionGraph (const QString &pointIdentifier) const;
246
248 QPointF positionScreen (const QString &pointIdentifier) const;
249
251 void print () const;
252
254 void printStream (QString indentation,
255 QTextStream &str) const;
256
258 QString reasonForUnsuccessfulRead () const;
259
261 void removePointAxis (const QString &identifier);
262
264 void removePointGraph (const QString &identifier);
265
268
270 void saveXml (QXmlStreamWriter &writer) const;
271
273 QString selectedCurveName () const;
274
277
279 void setCurveAxes (const Curve &curveAxes);
280
283
287
290
293
296
299
302
305
308
311
314
317
320
323
326
328 void setPixmap (const QImage &image);
329
331 void setSelectedCurveName (const QString &selectedCurveName);
332
334 bool successfulRead () const;
335
338 void updatePointOrdinals (const Transformation &transformation);
339
340private:
341 Document ();
342
343 bool bytesIndicatePreVersion6 (const QByteArray &bytes) const;
344 Curve *curveForCurveName (const QString &curveName); // For use by Document only. External classes should use functors
345 void generateEmptyPixmap(const QXmlStreamAttributes &attributes);
346 void loadImage(QXmlStreamReader &reader);
347 void loadPreVersion6 (QDataStream &str);
348 void loadVersion6 (QFile *file);
349 void loadVersions7AndUp (QFile *file);
350 void overrideGraphDefaultsWithMapDefaults ();
351 int versionFromFile (QFile *file) const;
352
353 // Metadata
354 QString m_name;
355 QPixmap m_pixmap;
356
357 // Number of axes points used is set during creation/import
358 DocumentAxesPointsRequired m_documentAxesPointsRequired;
359
360 // Read variables
361 bool m_successfulRead;
362 QString m_reasonForUnsuccessfulRead;
363
364 CoordSystemContext m_coordSystemContext;
365 DocumentModelLoadViews m_modelLoadViews; // Not found in pre-version 13 in which case its own defaults are used
366};
367
368#endif // DOCUMENT_H
unsigned int CoordSystemIndex
Zero-based index for identifying CoordSystem instantiations.
This class plays the role of context class in a state machine, although the 'states' are actually dif...
Storage of data belonging to one coordinate system.
Definition CoordSystem.h:44
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.
Model for managing the coordinate values corresponding Guidelines.
Model for storing enabled/disabled states of views for optional restoration during loading.
Model for DlgSettingsPointMatch and CmdSettingsPointMatch.
Model for DlgSettingsSegments and CmdSettingsSegments.
QPointF positionScreen(const QString &pointIdentifier) const
See Curve::positionScreen.
Definition Document.cpp:853
unsigned int coordSystemCount() const
Number of CoordSystem.
Definition Document.cpp:313
void editPointAxis(const QPointF &posGraph, const QString &identifier)
Edit the graph coordinates of a single axis point. Call this after checkAddPointAxis to guarantee suc...
Definition Document.cpp:374
void iterateThroughCurveSegments(const QString &curveName, const Functor2wRet< const Point &, const Point &, CallbackSearchReturn > &ftorWithCallback) const
See Curve::iterateThroughCurveSegments, for any axes or graph curve.
Definition Document.cpp:469
void setModelGridRemoval(const DocumentModelGridRemoval &modelGridRemoval)
Set method for DocumentModelGridRemoval.
void setCoordSystemIndex(CoordSystemIndex coordSystemIndex)
Set the index of current active CoordSystem.
Definition Document.cpp:945
void iterateThroughCurvePointsAxes(const Functor2wRet< const QString &, const Point &, CallbackSearchReturn > &ftorWithCallback)
See Curve::iterateThroughCurvePoints, for the axes curve.
Definition Document.cpp:455
void printStream(QString indentation, QTextStream &str) const
Debugging method that supports print method of this class and printStream method of some other class(...
Definition Document.cpp:868
void updatePointOrdinals(const Transformation &transformation)
Update point ordinals after point addition/removal or dragging.
QPixmap pixmap() const
Return the image that is being digitized.
Definition Document.cpp:843
void setDocumentAxesPointsRequired(DocumentAxesPointsRequired documentAxesPointsRequired)
Set the number of axes points required.
Definition Document.cpp:966
DocumentModelGeneral modelGeneral() const
Get method for DocumentModelGeneral.
Definition Document.cpp:735
bool loadCurvesFile(const QString &curvesFile)
Load the curve names in the specified Engauge file into the current document. This is called near the...
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 Document.cpp:171
QPointF positionGraph(const QString &pointIdentifier) const
See Curve::positionGraph.
Definition Document.cpp:848
const Curve & curveAxes() const
Get method for axis curve.
Definition Document.cpp:327
CoordSystemIndex coordSystemIndex() const
Index of current active CoordSystem.
Definition Document.cpp:320
QString selectedCurveName() const
Currently selected curve name. This is used to set the selected curve combobox in MainWindow.
Definition Document.cpp:940
void iterateThroughCurvesPointsGraphs(const Functor2wRet< const QString &, const Point &, CallbackSearchReturn > &ftorWithCallback)
See Curve::iterateThroughCurvePoints, for all the graphs curves.
Definition Document.cpp:478
void addPointGraphWithSpecifiedIdentifier(const QString &curveName, const QPointF &posScreen, const QString &identifier, double ordinal)
Add a single graph point with the specified point identifier. Note that PointStyle is not applied to ...
Definition Document.cpp:214
QStringList curvesGraphsNames() const
See CurvesGraphs::curvesGraphsNames.
Definition Document.cpp:355
bool isXOnly(const QString &pointIdentifier) const
See Curve::isXOnly.
Definition Document.cpp:450
void setModelPointMatch(const DocumentModelPointMatch &modelPointMatch)
Set method for DocumentModelPointMatch.
Document(const QImage &image)
Constructor for imported images and dragged images. Only one coordinate system is create - others are...
Definition Document.cpp:54
void removePointGraph(const QString &identifier)
Perform the opposite of addPointGraph.
Definition Document.cpp:896
DocumentModelGuideline modelGuideline() const
Get method for DocumentModelGuideline.
Definition Document.cpp:756
void setModelCurveStyles(const CurveStyles &modelCurveStyles)
Set method for CurveStyles.
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 Document.cpp:186
const CoordSystem & coordSystem() const
Currently active CoordSystem.
Definition Document.cpp:306
void initializeGridDisplay(const Transformation &transformation)
Initialize grid display. This is called immediately after the transformation has been defined for the...
Definition Document.cpp:417
void setModelGridDisplay(const DocumentModelGridDisplay &modelGridDisplay)
Set method for DocumentModelGridDisplay.
DocumentModelPointMatch modelPointMatch() const
Get method for DocumentModelPointMatch.
Definition Document.cpp:770
DocumentModelDigitizeCurve modelDigitizeCurve() const
Get method for DocumentModelDigitizeCurve.
Definition Document.cpp:721
int nextOrdinalForCurve(const QString &curveName) const
Default next ordinal value for specified curve.
Definition Document.cpp:791
void setModelGuideline(const DocumentModelGuideline &modelGuideline)
Set method for DocumentModelGuideline.
void removePointsInCurvesGraphs(CurvesGraphs &curvesGraphs)
Remove all points identified in the specified CurvesGraphs. See also addPointsInCurvesGraphs.
Definition Document.cpp:903
void print() const
Debugging method for printing directly from symbolic debugger.
Definition Document.cpp:858
bool successfulRead() const
Return true if startup loading succeeded. If the loading failed then reasonForUnsuccessfulRed will ex...
void addCoordSystems(unsigned int numberCoordSystemToAdd)
Add some number (0 or more) of additional coordinate systems.
Definition Document.cpp:156
void addGraphCurveAtEnd(const QString &curveName)
Add new graph curve to the list of existing graph curves.
Definition Document.cpp:164
void setModelColorFilter(const DocumentModelColorFilter &modelColorFilter)
Set method for DocumentModelColorFilter.
Definition Document.cpp:985
void setModelDigitizeCurve(const DocumentModelDigitizeCurve &modelDigitizeCurve)
Set method for DocumentModelDigitizeCurve.
QString reasonForUnsuccessfulRead() const
Return an informative text message explaining why startup loading failed. Applies if successfulRead r...
Definition Document.cpp:882
void saveXml(QXmlStreamWriter &writer) const
Save document to xml.
Definition Document.cpp:910
void guidelinesSyncScreenToDocument(const DocumentModelGuideline &modelGuideline)
Sync all Guideline instances from screen to Document.
void addScaleWithGeneratedIdentifier(const QPointF &posScreen0, const QPointF &posScreen1, double scaleLength, QString &identifier0, QString &identifier1, double ordinal0, double ordinal1)
Add scale with a generated point identifier.
Definition Document.cpp:234
DocumentModelAxesChecker modelAxesChecker() const
Get method for DocumentModelAxesChecker.
Definition Document.cpp:693
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.
Definition Document.cpp:383
DocumentModelCoords modelCoords() const
Get method for DocumentModelCoords.
Definition Document.cpp:707
DocumentModelColorFilter modelColorFilter() const
Get method for DocumentModelColorFilter.
Definition Document.cpp:700
void checkEditPointAxis(const QString &pointIdentifier, const QPointF &posScreen, const QPointF &posGraph, bool &isError, QString &errorMessage)
Check before calling editPointAxis.
Definition Document.cpp:290
void setCurvesGraphs(const CurvesGraphs &curvesGraphs)
Let CmdAbstract classes overwrite CurvesGraphs.
Definition Document.cpp:959
CurveStyles modelCurveStyles() const
Get method for CurveStyles.
Definition Document.cpp:714
void setModelCoords(const DocumentModelCoords &modelCoords)
Set method for DocumentModelCoords.
DocumentModelLoadViews modelLoadViews() const
Get method for DocumentModelLoadViews.
Definition Document.cpp:763
void setModelAxesChecker(const DocumentModelAxesChecker &modelAxesChecker)
Set method for DocumentModelAxesChecker.
Definition Document.cpp:978
DocumentAxesPointsRequired documentAxesPointsRequired() const
Get method for DocumentAxesPointsRequired.
Definition Document.cpp:369
void setModelSegments(const DocumentModelSegments &modelSegments)
Set method for DocumentModelSegments.
void setCurveAxes(const Curve &curveAxes)
Let CmdAbstract classes overwrite axes Curve.
Definition Document.cpp:952
const CurvesGraphs & curvesGraphs() const
Make all Curves available, read only, for CmdAbstract classes only.
Definition Document.cpp:348
int curvesGraphsNumPoints(const QString &curveName) const
See CurvesGraphs::curvesGraphsNumPoints.
Definition Document.cpp:362
void setModelGeneral(const DocumentModelGeneral &modelGeneral)
Set method for DocumentModelGeneral.
void setModelExport(const DocumentModelExportFormat &modelExport)
Set method for DocumentModelExportFormat.
DocumentModelGridRemoval modelGridRemoval() const
Get method for DocumentModelGridRemoval.
Definition Document.cpp:749
DocumentModelGridDisplay modelGridDisplay() const
Get method for DocumentModelGridDisplay.
Definition Document.cpp:742
DocumentModelExportFormat modelExport() const
Get method for DocumentModelExportFormat.
Definition Document.cpp:728
void setSelectedCurveName(const QString &selectedCurveName)
Save curve name that is selected for the current coordinate system, for the next time the coordinate ...
void setModelLoadViews(const DocumentModelLoadViews &modelLoadViews)
Set method for DocumentModelLoadViews.
void movePoint(const QString &pointIdentifier, const QPointF &deltaScreen)
See Curve::movePoint.
Definition Document.cpp:784
const Curve * curveForCurveName(const QString &curveName) const
See CurvesGraphs::curveForCurveNames, although this also works for AXIS_CURVE_NAME.
Definition Document.cpp:341
DocumentModelSegments modelSegments() const
Get method for DocumentModelSegments.
Definition Document.cpp:777
void setPixmap(const QImage &image)
Set method for the background pixmap.
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...
Definition Document.cpp:274
void removePointAxis(const QString &identifier)
Perform the opposite of addPointAxis.
Definition Document.cpp:889
void addPointGraphWithGeneratedIdentifier(const QString &curveName, const QPointF &posScreen, QString &generatedIentifier, double ordinal)
Add a single graph point with a generated point identifier.
Definition Document.cpp:201
void addPointsInCurvesGraphs(CurvesGraphs &curvesGraphs)
Add all points identified in the specified CurvesGraphs. See also removePointsInCurvesGraphs.
Definition Document.cpp:227
Affine transformation between screen and graph coordinates, based on digitized axis points.