Engauge Digitizer 2
Loading...
Searching...
No Matches
CoordSystemContext.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_CONTEXT_H
8#define COORD_SYSTEM_CONTEXT_H
9
10#include "CoordSystem.h"
11#include "CoordSystemIndex.h"
12#include "CoordSystemInterface.h"
13#include "DocumentAxesPointsRequired.h"
14#include <QVector>
15
16class QDataStream;
17class QXmlStreamReader;
18class QXmlStreamWriter;
19
20typedef QVector<CoordSystem*> CoordSystems;
21
25{
26 public:
29
31
33 void addCoordSystems(DocumentAxesPointsRequired documentAxesPointsRequired,
34 unsigned int numberCoordSystemToAdd);
35
36 virtual void addGraphCurveAtEnd (const QString &curveName);
37 virtual void addPointAxisWithGeneratedIdentifier (const QPointF &posScreen,
38 const QPointF &posGraph,
39 QString &identifier,
40 double ordinal,
41 bool isXOnly);
42 virtual void addPointAxisWithSpecifiedIdentifier (const QPointF &posScreen,
43 const QPointF &posGraph,
44 const QString &identifier,
45 double ordinal,
46 bool isXOnly);
47 virtual void addPointGraphWithGeneratedIdentifier (const QString &curveName,
48 const QPointF &posScreen,
49 QString &generatedIentifier,
50 double ordinal);
51 virtual void addPointGraphWithSpecifiedIdentifier (const QString &curveName,
52 const QPointF &posScreen,
53 const QString &identifier,
54 double ordinal);
56 virtual void checkAddPointAxis (const QPointF &posScreen,
57 const QPointF &posGraph,
58 bool &isError,
59 QString &errorMessage,
60 bool isXOnly);
61 virtual void checkEditPointAxis (const QString &pointIdentifier,
62 const QPointF &posScreen,
63 const QPointF &posGraph,
64 bool &isError,
65 QString &errorMessage);
66
68 const CoordSystem &coordSystem () const;
69
71 unsigned int coordSystemCount() const;
72
74 CoordSystemIndex coordSystemIndex () const;
75
76 virtual const Curve &curveAxes () const;
77 virtual Curve *curveForCurveName (const QString &curveName);
78 virtual const Curve *curveForCurveName (const QString &curveName) const;
79 virtual const CurvesGraphs &curvesGraphs () const;
80 virtual QStringList curvesGraphsNames () const;
81 virtual int curvesGraphsNumPoints (const QString &curveName) const;
82 virtual void editPointAxis (const QPointF &posGraph,
83 const QString &identifier);
84
86 bool isXOnly (const QString &pointIdentifier) const;
87
88 virtual void iterateThroughCurvePointsAxes (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback);
89 virtual void iterateThroughCurvePointsAxes (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback) const;
90 virtual void iterateThroughCurveSegments (const QString &curveName,
91 const Functor2wRet<const Point &, const Point &, CallbackSearchReturn> &ftorWithCallback) const;
92 virtual void iterateThroughCurvesPointsGraphs (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback);
93 virtual void iterateThroughCurvesPointsGraphs (const Functor2wRet<const QString &, const Point &, CallbackSearchReturn> &ftorWithCallback) const;
94 virtual bool loadCurvesFile (const QString &curvesFile);
95
97 void loadPreVersion6 (QDataStream &str,
98 double version);
100 void loadVersion6 (QXmlStreamReader &reader);
102 void loadVersion7 (QXmlStreamReader &reader,
103 DocumentAxesPointsRequired documentAxesPointsRequired);
104
107 virtual DocumentModelCoords modelCoords () const;
108 virtual CurveStyles modelCurveStyles() const;
111 virtual DocumentModelGeneral modelGeneral() const;
114 virtual DocumentModelSegments modelSegments() const;
115 virtual void movePoint (const QString &pointIdentifier,
116 const QPointF &deltaScreen);
117 virtual int nextOrdinalForCurve (const QString &curveName) const;
118 virtual QPointF positionGraph (const QString &pointIdentifier) const;
119 virtual QPointF positionScreen (const QString &pointIdentifier) const;
120 virtual void print () const;
121 virtual void printStream (QString indentation,
122 QTextStream &str) const;
123 virtual QString reasonForUnsuccessfulRead () const;
124 virtual void removePointAxis (const QString &identifier);
125 virtual void removePointGraph (const QString &identifier);
127 virtual void saveXml (QXmlStreamWriter &writer) const;
128
130 void setCoordSystemIndex (CoordSystemIndex coordSystemIndex);
131
133 void setCurvesGraphs (CoordSystemIndex coordSystemIndex,
135 virtual void setCurvesGraphs (const CurvesGraphs &curvesGraphs); // Applies to current coordinate system
138 virtual void setModelCoords (const DocumentModelCoords &modelCoords);
146 virtual bool successfulRead () const;
147 virtual void updatePointOrdinals (const Transformation &transformation);
148
149 private:
150
151 CoordSystemIndex m_coordSystemIndex;
152 CoordSystems m_coordSystems;
153
154};
155
156#endif // COORD_SYSTEM_CONTEXT_H
This class plays the role of context class in a state machine, although the 'states' are actually dif...
unsigned int coordSystemCount() const
Number of CoordSystem.
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 DocumentModelColorFilter modelColorFilter() const
Get method for DocumentModelColorFilter.
CoordSystemIndex coordSystemIndex() const
Index of current CoordSystem.
virtual void setModelCurveStyles(const CurveStyles &modelCurveStyles)
Set method for CurveStyles.
virtual CurveStyles modelCurveStyles() const
Get method for CurveStyles.
virtual void setModelAxesChecker(const DocumentModelAxesChecker &modelAxesChecker)
Set method for DocumentModelAxesChecker.
virtual void iterateThroughCurvePointsAxes(const Functor2wRet< const QString &, const Point &, CallbackSearchReturn > &ftorWithCallback)
See Curve::iterateThroughCurvePoints, for the axes curve.
virtual const CurvesGraphs & curvesGraphs() const
Make all Curves available, read only, for CmdAbstract classes only.
void setCurvesGraphs(CoordSystemIndex coordSystemIndex, const CurvesGraphs &curvesGraphs)
Applies to current coordinate system.
const CoordSystem & coordSystem() const
Current CoordSystem.
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 editPointAxis(const QPointF &posGraph, const QString &identifier)
Edit the graph coordinates of a single axis point. Call this after checkAddPointAxis to guarantee suc...
void setModelPointMatch(const DocumentModelPointMatch &modelPointMatch)
Set method for DocumentModelPointMatch.
virtual void setModelGeneral(const DocumentModelGeneral &modelGeneral)
Set method for DocumentModelGeneral.
virtual void setModelColorFilter(const DocumentModelColorFilter &modelColorFilter)
Set method for DocumentModelColorFilter.
virtual const Curve & curveAxes() const
Get method for axis curve.
virtual void addPointsInCurvesGraphs(CurvesGraphs &curvesGraphs)
Add all points identified in the specified CurvesGraphs. See also removePointsInCurvesGraphs.
virtual void setModelCoords(const DocumentModelCoords &modelCoords)
Set method for DocumentModelCoords.
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.
CoordSystemContext()
Default constructor for constructing from opened file.
virtual DocumentModelAxesChecker modelAxesChecker() const
Get method for DocumentModelAxesChecker.
virtual void print() const
Debugging method for printing directly from symbolic debugger.
virtual int curvesGraphsNumPoints(const QString &curveName) const
See CurvesGraphs::curvesGraphsNumPoints.
void loadVersion6(QXmlStreamReader &reader)
Load from file in version 6 format, into the single CoordSystem.
virtual QPointF positionScreen(const QString &pointIdentifier) const
See Curve::positionScreen.
bool isXOnly(const QString &pointIdentifier) const
True/false if y/x value is empty.
virtual void setModelSegments(const DocumentModelSegments &modelSegments)
Set method for DocumentModelSegments.
virtual DocumentModelDigitizeCurve modelDigitizeCurve() const
Get method for DocumentModelDigitizeCurve.
virtual DocumentModelCoords modelCoords() const
Get method for DocumentModelCoords.
virtual Curve * curveForCurveName(const QString &curveName)
See CurvesGraphs::curveForCurveName, although this also works for AXIS_CURVE_NAME.
virtual int nextOrdinalForCurve(const QString &curveName) const
Default next ordinal value for specified curve.
virtual DocumentModelSegments modelSegments() const
Get method for DocumentModelSegments.
virtual DocumentModelExportFormat modelExport() const
Get method for DocumentModelExportFormat.
virtual void addGraphCurveAtEnd(const QString &curveName)
Add new graph curve to the list of existing graph curves.
virtual void movePoint(const QString &pointIdentifier, const QPointF &deltaScreen)
See Curve::movePoint.
virtual QString reasonForUnsuccessfulRead() const
Return an informative text message explaining why startup loading failed. Applies if successfulRead r...
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...
void loadVersion7(QXmlStreamReader &reader, DocumentAxesPointsRequired documentAxesPointsRequired)
Load one CoordSystem from file in version 7 format, into the most recent CoordSystem which was just c...
void addCoordSystems(DocumentAxesPointsRequired documentAxesPointsRequired, unsigned int numberCoordSystemToAdd)
Add specified number of coordinate systems to the original one created by the constructor.
virtual void saveXml(QXmlStreamWriter &writer) const
Save graph to xml.
virtual void setModelExport(const DocumentModelExportFormat &modelExport)
Set method for DocumentModelExportFormat.
virtual void removePointGraph(const QString &identifier)
Perform the opposite of addPointGraph.
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 checkEditPointAxis(const QString &pointIdentifier, const QPointF &posScreen, const QPointF &posGraph, bool &isError, QString &errorMessage)
Check before calling editPointAxis.
void setCoordSystemIndex(CoordSystemIndex coordSystemIndex)
Index of current CoordSystem.
virtual bool successfulRead() const
Return true if startup loading succeeded. If the loading failed then reasonForUnsuccessfulRed will ex...
virtual DocumentModelGridRemoval modelGridRemoval() const
Get method for DocumentModelGridRemoval.
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 DocumentModelPointMatch modelPointMatch() const
Get method for DocumentModelPointMatch.
virtual QStringList curvesGraphsNames() const
See CurvesGraphs::curvesGraphsNames.
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 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 removePointsInCurvesGraphs(CurvesGraphs &curvesGraphs)
Remove all points identified in the specified CurvesGraphs. See also addPointsInCurvesGraphs.
virtual void removePointAxis(const QString &identifier)
Perform the opposite of addPointAxis.
virtual void iterateThroughCurvesPointsGraphs(const Functor2wRet< const QString &, const Point &, CallbackSearchReturn > &ftorWithCallback)
See Curve::iterateThroughCurvePoints, for all the graphs curves.
void loadPreVersion6(QDataStream &str, double version)
Load from file in pre-version 6 format.
virtual void setModelGridRemoval(const DocumentModelGridRemoval &modelGridRemoval)
Set method for DocumentModelGridRemoval.
virtual DocumentModelGeneral modelGeneral() const
Get method for DocumentModelGeneral.
virtual QPointF positionGraph(const QString &pointIdentifier) const
See Curve::positionGraph.
virtual void setModelDigitizeCurve(const DocumentModelDigitizeCurve &modelDigitizeCurve)
Set method for DocumentModelDigitizeCurve.
Interface common to CoordSystemContext and CoordSystem classes.
Storage of data belonging to one coordinate system.
Definition CoordSystem.h:41
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.