Engauge Digitizer 2
Loading...
Searching...
No Matches
DocumentModelCoords.cpp
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#include "CmdMediator.h"
8#include "CoordUnitsDate.h"
9#include "CoordUnitsTime.h"
10#include "DocumentModelCoords.h"
11#include "DocumentSerialize.h"
12#include "EngaugeAssert.h"
13#include "Logger.h"
14#include <QObject>
15#include <QTextStream>
16#include "QtToString.h"
17#include <QXmlStreamWriter>
18#include "Xml.h"
19
20const double PI = 3.1415926535;
21const double TWO_PI = 2.0 * PI;
22
23// Zero default for origin radius, which is usually wanted for COORD_SCALE_LINEAR, it is illegal
24// for COORD_SCALE_LOG (for which 1.0 is probably preferred as the default. Note linear is more common than log
26
28 m_coordsType (COORDS_TYPE_CARTESIAN),
29 m_originRadius (DEFAULT_ORIGIN_RADIUS_LINEAR),
30 m_coordScaleXTheta (COORD_SCALE_LINEAR),
31 m_coordScaleYRadius (COORD_SCALE_LINEAR),
34 m_coordUnitsTheta (COORD_UNITS_POLAR_THETA_DEGREES),
35 m_coordUnitsRadius (COORD_UNITS_NON_POLAR_THETA_NUMBER),
36 m_coordUnitsDate (COORD_UNITS_DATE_YEAR_MONTH_DAY),
38{
39}
40
42 m_coordsType (document.modelCoords().coordsType()),
43 m_originRadius(document.modelCoords().originRadius()),
44 m_coordScaleXTheta(document.modelCoords().coordScaleXTheta()),
45 m_coordScaleYRadius(document.modelCoords().coordScaleYRadius()),
46 m_coordUnitsX(document.modelCoords().coordUnitsX()),
47 m_coordUnitsY(document.modelCoords().coordUnitsY()),
48 m_coordUnitsTheta(document.modelCoords().coordUnitsTheta()),
49 m_coordUnitsRadius(document.modelCoords().coordUnitsRadius()),
50 m_coordUnitsDate(document.modelCoords().coordUnitsDate()),
51 m_coordUnitsTime(document.modelCoords().coordUnitsTime())
52{
53}
54
56 m_coordsType (other.coordsType ()),
57 m_originRadius (other.originRadius ()),
58 m_coordScaleXTheta (other.coordScaleXTheta()),
59 m_coordScaleYRadius (other.coordScaleYRadius ()),
60 m_coordUnitsX (other.coordUnitsX()),
61 m_coordUnitsY (other.coordUnitsY()),
62 m_coordUnitsTheta (other.coordUnitsTheta ()),
63 m_coordUnitsRadius (other.coordUnitsRadius ()),
64 m_coordUnitsDate (other.coordUnitsDate ()),
65 m_coordUnitsTime (other.coordUnitsTime ())
66{
67}
68
70{
71 m_coordsType = other.coordsType();
72 m_originRadius = other.originRadius();
73 m_coordScaleXTheta = other.coordScaleXTheta();
74 m_coordScaleYRadius = other.coordScaleYRadius();
75 m_coordUnitsX = other.coordUnitsX();
76 m_coordUnitsY = other.coordUnitsY();
77 m_coordUnitsTheta = other.coordUnitsTheta();
78 m_coordUnitsRadius = other.coordUnitsRadius();
79 m_coordUnitsDate = other.coordUnitsDate();
80 m_coordUnitsTime = other.coordUnitsTime();
81
82 return *this;
83}
84
86{
87 return m_coordScaleXTheta;
88}
89
91{
92 return m_coordScaleYRadius;
93}
94
96{
97 return m_coordsType;
98}
99
101{
102 return m_coordUnitsDate;
103}
104
106{
107 return m_coordUnitsRadius;
108}
109
111{
112 return m_coordUnitsTheta;
113}
114
116{
117 return m_coordUnitsTime;
118}
119
121{
122 return m_coordUnitsX;
123}
124
126{
127 return m_coordUnitsY;
128}
129
131{
132 LOG4CPP_INFO_S ((*mainCat)) << "DocumentModelCoords::loadXml";
133
134 bool success = true;
135
137
138 if (attributes.hasAttribute(DOCUMENT_SERIALIZE_COORDS_TYPE) &&
148
159
160 // Read until end of this subtree
161 while ((reader.tokenType() != QXmlStreamReader::EndElement) ||
164 if (reader.atEnd()) {
165 success = false;
166 break;
167 }
168 }
169 }
170
171 if (!success) {
172 reader.raiseError (QObject::tr ("Cannot read coordinates data"));
173 }
174}
175
177{
178 return m_originRadius;
179}
180
182 QTextStream &str) const
183{
184 str << indentation << "DocumentModelCoords\n";
185
187
188 str << indentation << "coordsType=" << coordsTypeToString (m_coordsType) << "\n";
189 str << indentation << "originRadius=" << m_originRadius << "\n";
190 str << indentation << "coordScaleXTheta=" << coordScaleToString (m_coordScaleXTheta) << "\n";
191 str << indentation << "coordScaleYRadius=" << coordScaleToString (m_coordScaleYRadius) << "\n";
192 str << indentation << "coordUnitsX=" << coordUnitsNonPolarThetaToString (m_coordUnitsX) << "\n";
193 str << indentation << "coordUnitsY=" << coordUnitsNonPolarThetaToString (m_coordUnitsY) << "\n";
194 str << indentation << "coordUnitsTheta=" << coordUnitsPolarThetaToString (m_coordUnitsTheta) << "\n";
195 str << indentation << "coordUnitsRadius=" << coordUnitsNonPolarThetaToString (m_coordUnitsRadius) << "\n";
196 str << indentation << "coordUnitsDate=" << coordUnitsDateToString (m_coordUnitsDate) << "\n";
197 str << indentation << "coordUnitsTime=" << coordUnitsTimeToString (m_coordUnitsTime) << "\n";
198}
199
201{
202 LOG4CPP_INFO_S ((*mainCat)) << "DocumentModelCoords::saveXml";
203
204 writer.writeStartElement(DOCUMENT_SERIALIZE_COORDS);
205 writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_TYPE, QString::number (m_coordsType));
207 writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_ORIGIN_RADIUS, QString::number (m_originRadius));
208 writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_SCALE_X_THETA, QString::number (m_coordScaleXTheta));
210 writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_SCALE_Y_RADIUS, QString::number (m_coordScaleYRadius));
212 writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_X, QString::number (m_coordUnitsX));
214 writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_Y, QString::number (m_coordUnitsY));
216 writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_THETA, QString::number (m_coordUnitsTheta));
218 writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_RADIUS, QString::number (m_coordUnitsRadius));
220 writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_DATE, QString::number (m_coordUnitsDate));
222 writer.writeAttribute(DOCUMENT_SERIALIZE_COORDS_UNITS_TIME, QString::number (m_coordUnitsTime));
224 writer.writeEndElement();
225}
226
231
236
238{
239 m_coordsType = coordsType;
240}
241
246
251
256
261
266
271
273{
274 m_originRadius = originRadius;
275}
276
278{
279 switch (m_coordUnitsTheta) {
284 return 360;
285
287 return 400;
288
290 return TWO_PI;
291
293 return 1;
294
295 default:
296 break;
297 }
298
299 LOG4CPP_ERROR_S ((*mainCat)) << "DocumentModelCoords::thetaPeriod";
300
301 ENGAUGE_ASSERT(false);
302 return 0;
303}
QString coordScaleToString(CoordScale coordScale)
Definition CoordScale.cpp:9
CoordScale
Definition CoordScale.h:12
@ COORD_SCALE_LINEAR
Definition CoordScale.h:13
QString coordUnitsDateToString(CoordUnitsDate coordUnits)
CoordUnitsDate
@ COORD_UNITS_DATE_YEAR_MONTH_DAY
QString coordUnitsNonPolarThetaToString(CoordUnitsNonPolarTheta coordUnits)
CoordUnitsNonPolarTheta
@ COORD_UNITS_NON_POLAR_THETA_NUMBER
QString coordUnitsPolarThetaToString(CoordUnitsPolarTheta coordUnits)
CoordUnitsPolarTheta
@ COORD_UNITS_POLAR_THETA_DEGREES_MINUTES_SECONDS_NSEW
@ COORD_UNITS_POLAR_THETA_TURNS
@ COORD_UNITS_POLAR_THETA_RADIANS
@ COORD_UNITS_POLAR_THETA_DEGREES_MINUTES
@ COORD_UNITS_POLAR_THETA_DEGREES
@ COORD_UNITS_POLAR_THETA_DEGREES_MINUTES_SECONDS
@ COORD_UNITS_POLAR_THETA_GRADIANS
QString coordUnitsTimeToString(CoordUnitsTime coordUnits)
CoordUnitsTime
@ COORD_UNITS_TIME_HOUR_MINUTE_SECOND
QString coordsTypeToString(CoordsType coordsType)
Definition CoordsType.cpp:9
CoordsType
Definition CoordsType.h:12
@ COORDS_TYPE_CARTESIAN
Definition CoordsType.h:13
const int INNER_RADIUS_MIN
const double DEFAULT_ORIGIN_RADIUS_LINEAR
const double TWO_PI
const double PI
const QString DOCUMENT_SERIALIZE_COORDS_UNITS_DATE
const QString DOCUMENT_SERIALIZE_COORDS_SCALE_X_THETA_STRING
const QString DOCUMENT_SERIALIZE_COORDS_UNITS_RADIUS_STRING
const QString DOCUMENT_SERIALIZE_COORDS_UNITS_RADIUS
const QString DOCUMENT_SERIALIZE_COORDS_UNITS_X
const QString DOCUMENT_SERIALIZE_COORDS_SCALE_Y_RADIUS_STRING
const QString DOCUMENT_SERIALIZE_COORDS_ORIGIN_RADIUS
const QString DOCUMENT_SERIALIZE_COORDS_UNITS_DATE_STRING
const QString DOCUMENT_SERIALIZE_COORDS_UNITS_TIME_STRING
const QString DOCUMENT_SERIALIZE_COORDS_SCALE_Y_RADIUS
const QString DOCUMENT_SERIALIZE_COORDS_UNITS_X_STRING
const QString DOCUMENT_SERIALIZE_COORDS_UNITS_THETA
const QString DOCUMENT_SERIALIZE_COORDS_SCALE_X_THETA
const QString DOCUMENT_SERIALIZE_COORDS_TYPE_STRING
const QString DOCUMENT_SERIALIZE_COORDS_UNITS_TIME
const QString DOCUMENT_SERIALIZE_COORDS
const QString DOCUMENT_SERIALIZE_COORDS_UNITS_Y_STRING
const QString DOCUMENT_SERIALIZE_COORDS_TYPE
const QString DOCUMENT_SERIALIZE_COORDS_UNITS_Y
const QString DOCUMENT_SERIALIZE_COORDS_UNITS_THETA_STRING
#define ENGAUGE_ASSERT(cond)
Drop in replacement for Q_ASSERT if defined(QT_NO_DEBUG) && !defined(QT_FORCE_ASSERTS) define ENGAUGE...
log4cpp::Category * mainCat
Definition Logger.cpp:14
const QString INDENTATION_DELTA
QXmlStreamReader::TokenType loadNextFromReader(QXmlStreamReader &reader)
Load next token from xml reader.
Definition Xml.cpp:14
Model for DlgSettingsCoords and CmdSettingsCoords.
virtual void saveXml(QXmlStreamWriter &writer) const
Save entire model as xml into stream.
CoordScale coordScaleYRadius() const
Get method for linear/log scale on y/radius.
void setCoordUnitsY(CoordUnitsNonPolarTheta coordUnits)
Set method for y units.
void setOriginRadius(double originRadius)
Set method for origin radius in polar mode.
CoordUnitsNonPolarTheta coordUnitsRadius() const
Get method for radius units.
void setCoordUnitsX(CoordUnitsNonPolarTheta coordUnits)
Set method for x units.
CoordUnitsPolarTheta coordUnitsTheta() const
Get method for theta unit.
void setCoordUnitsRadius(CoordUnitsNonPolarTheta coordUnits)
Set method for radius units.
CoordScale coordScaleXTheta() const
Get method for linear/log scale on x/theta.
double thetaPeriod() const
Return the period of the theta value for polar coordinates, consistent with CoordThetaUnits.
void printStream(QString indentation, QTextStream &str) const
Debugging method that supports print method of this class and printStream method of some other class(...
CoordUnitsNonPolarTheta coordUnitsY() const
Get method for x units.
CoordUnitsTime coordUnitsTime() const
Get method for time format when used.
CoordUnitsNonPolarTheta coordUnitsX() const
Get method for x units.
void setCoordUnitsDate(CoordUnitsDate coordUnits)
Set method for date units.
void setCoordsType(CoordsType coordsType)
Set method for coordinates type.
DocumentModelCoords()
Default constructor.
CoordsType coordsType() const
Get method for coordinates type.
void setCoordScaleXTheta(CoordScale coordScale)
Set method for linear/log scale on x/theta.
void setCoordUnitsTime(CoordUnitsTime coordUnits)
Set method for time units.
DocumentModelCoords & operator=(const DocumentModelCoords &other)
Assignment constructor.
void setCoordScaleYRadius(CoordScale coordScale)
Set method for linear/log scale on y/radius.
double originRadius() const
Get method for origin radius in polar mode.
CoordUnitsDate coordUnitsDate() const
Get method for date format when used.
void setCoordUnitsTheta(CoordUnitsPolarTheta coordUnits)
Set method for theta units.
virtual void loadXml(QXmlStreamReader &reader)
Load model from serialized xml.
Storage of one imported image and the data attached to that image.
Definition Document.h:42
#define LOG4CPP_INFO_S(logger)
Definition convenience.h:18
#define LOG4CPP_ERROR_S(logger)
Definition convenience.h:12