Engauge Digitizer  2
CallbackAxisPointsAbstract.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 CALLBACK_AXIS_POINTS_ABSTRACT
8 #define CALLBACK_AXIS_POINTS_ABSTRACT
9 
10 #include "CallbackSearchReturn.h"
11 #include "DocumentAxesPointsRequired.h"
12 #include "DocumentModelCoords.h"
13 #include <QList>
14 #include <QString>
15 #include <QTransform>
16 
17 typedef QList<QPointF> CoordPairVector;
18 typedef QList<double> CoordSingleVector;
19 
20 class Point;
21 
36 {
38  friend class TestGraphCoords;
39 
40 public:
43  DocumentAxesPointsRequired documentAxesPointsRequired);
44 
47  const QString pointIdentifierOverride,
48  const QPointF &posGraphOverride,
49  const QPointF &posScreenOverride,
50  DocumentAxesPointsRequired documentAxesPointsRequired);
51 
53  CallbackSearchReturn callback (const QString &curveName,
54  const Point &point);
55 
58  QTransform matrixGraph () const;
59 
62  QTransform matrixScreen () const;
63 
65  double xGraphRange () const { return m_xGraphHigh - m_xGraphLow; }
66 
68  double yGraphRange () const { return m_yGraphHigh - m_yGraphLow; }
69 
70 protected:
71 
73  DocumentAxesPointsRequired documentAxesPointsRequired() const;
74 
76  QString errorMessage () const { return m_errorMessage; }
77 
80  bool isError () const { return m_isError; }
81 
83  unsigned int numberAxisPoints () const;
84 
85 private:
86 
87  bool anyPointsRepeatPair (const CoordPairVector &vector) const;
88  bool anyPointsRepeatSingle (const CoordSingleVector &vector) const;
89  CallbackSearchReturn callbackRequire3AxisPoints (const QPointF &posScreen,
90  const QPointF &posGraph);
91  CallbackSearchReturn callbackRequire4AxisPoints (bool isXOnly,
92  const QPointF &posScreen,
93  const QPointF &posGraph);
94  void computeTransforms3();
95  void computeTransforms4();
96  void loadTransforms3();
97  void loadTransforms4();
98  bool threePointsAreCollinear (const QTransform &transform);
99 
100  // Coordinates information that will be applied to the coordinates before they are used to compute the transformation
101  DocumentModelCoords m_modelCoords;
102 
103  // For overriding one existing Point. Identifier is empty for no overriding
104  QString m_pointIdentifierOverride;
105  QPointF m_posScreenOverride;
106  QPointF m_posGraphOverride;
107 
108  // Storage of (x,y) axes points for DOCUMENT_AXES_POINTS_REQUIRED_3
109  CoordPairVector m_screenInputs;
110  CoordPairVector m_graphOutputs;
111 
112  // Storage of (x) and (y) axes points for DOCUMENT_AXES_POINTS_REQUIRED_4
113  CoordPairVector m_screenInputsX; // Accumulated screen coordinates for x axis points
114  CoordPairVector m_screenInputsY; // Accumulated screen coordinates for y axis points
115  CoordSingleVector m_graphOutputsX; // Accumulated x values for x axis points
116  CoordSingleVector m_graphOutputsY; // Accumulated y values for y axis points
117 
118  // Transforms computed from DOCUMENT_AXES_POINTS_REQUIRED_3 or DOCUMENT_AXES_POINTS_REQUIRED_4 variables
119  QTransform m_screenInputsTransform;
120  QTransform m_graphOutputsTransform;
121 
122  // Errors
123  bool m_isError;
124  QString m_errorMessage;
125 
126  // For computing the ranges of the graph coordinates
127  double m_xGraphLow;
128  double m_yGraphLow;
129  double m_xGraphHigh;
130  double m_yGraphHigh;
131 
132  // Either 3 points (each having x AND y coordinates) or 4 points (each having x OR y coordinate) define the transform
133  DocumentAxesPointsRequired m_documentAxesPointsRequired;
134 };
135 
136 #endif // CALLBACK_AXIS_POINTS_ABSTRACT
QTransform matrixGraph() const
Returns graph coordinates matrix after transformIsDefined has already indicated success.
DocumentAxesPointsRequired documentAxesPointsRequired() const
Number of axes points required for the transformation.
Unit tests of graph coordinate sanity checking.
Class that represents one digitized point. The screen-to-graph coordinate transformation is always ex...
Definition: Point.h:23
CallbackSearchReturn
Return values for search callback methods.
double xGraphRange() const
Return the range of the x graph coordinate from low to high, after the transform is defined...
Model for DlgSettingsCoords and CmdSettingsCoords.
CallbackAxisPointsAbstract(const DocumentModelCoords &modelCoords, DocumentAxesPointsRequired documentAxesPointsRequired)
Constructor for when all of the existing axis points are to be processed as is.
bool isError() const
This value is checked after iterating to see if the axis data is correct.
unsigned int numberAxisPoints() const
Number of axis points which is less than 3 if the axes curve is incomplete.
double yGraphRange() const
Return the range of the y graph coordinate from low to high, after the transform is defined...
Callback for collecting axis points and then performing common calculations on those axis points...
QString errorMessage() const
This value is checked after iterating to see what was wrong if the axis data was incorrect.
CallbackSearchReturn callback(const QString &curveName, const Point &point)
Callback method.
QTransform matrixScreen() const
Returns screen coordinates matrix after transformIsDefined has already indicated success.