3 * A 3d point class (depricated). This class is depricated and we are
4 * in the process of removing all usage of it in favor of plib's "sg"
5 * library of point, vector, and math routines. Plib's sg lib is less
6 * object oriented, but integrates more seamlessly with opengl.
8 * Adapted from algebra3 by Jean-Francois Doue, started October 1998.
11 // Copyright (C) 1998 Curtis L. Olson - http://www.flightgear.org/~curt
13 // This library is free software; you can redistribute it and/or
14 // modify it under the terms of the GNU Library General Public
15 // License as published by the Free Software Foundation; either
16 // version 2 of the License, or (at your option) any later version.
18 // This library is distributed in the hope that it will be useful,
19 // but WITHOUT ANY WARRANTY; without even the implied warranty of
20 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 // Library General Public License for more details.
23 // You should have received a copy of the GNU General Public License
24 // along with this program; if not, write to the Free Software
25 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
35 # error This library requires C++
38 #include <simgear/compiler.h>
40 #ifdef SG_MATH_EXCEPTION_CLASH
41 # define exception c_exception
51 const double fgPoint3_Epsilon = 0.0000001;
53 enum {PX, PY, PZ}; // axes
55 // Kludge for msvc++ 6.0 - requires forward decls of friend functions.
57 std::istream& operator>> ( std::istream&, Point3D& );
58 std::ostream& operator<< ( std::ostream&, const Point3D& );
59 Point3D operator- (const Point3D& p); // -p1
60 bool operator== (const Point3D& a, const Point3D& b); // p1 == p2?
75 /** Default constructor */
77 Point3D(const double x, const double y, const double z);
78 explicit Point3D(const double d);
79 Point3D(const Point3D &p);
81 static Point3D fromSGGeod(const SGGeod& geod);
82 static Point3D fromSGGeoc(const SGGeoc& geoc);
83 static Point3D fromSGVec3(const SGVec3<double>& cart);
84 static Point3D fromSGVec3(const SGVec3<float>& cart);
85 static Point3D fromSGVec2(const SGVec2<double>& cart);
87 // Assignment operators
89 Point3D& operator = ( const Point3D& p ); // assignment of a Point3D
90 Point3D& operator += ( const Point3D& p ); // incrementation by a Point3D
91 Point3D& operator -= ( const Point3D& p ); // decrementation by a Point3D
92 Point3D& operator *= ( const double d ); // multiplication by a constant
93 Point3D& operator /= ( const double d ); // division by a constant
95 void setx(const double x);
96 void sety(const double y);
97 void setz(const double z);
98 void setlon(const double x);
99 void setlat(const double y);
100 void setradius(const double z);
101 void setelev(const double z);
105 double& operator [] ( int i); // indexing
106 double operator[] (int i) const; // read-only indexing
108 inline const double *get_n() const { return n; };
109 double x() const; // cartesian x
110 double y() const; // cartesian y
111 double z() const; // cartesian z
113 double lon() const; // polar longitude
114 double lat() const; // polar latitude
115 double radius() const; // polar radius
116 double elev() const; // geodetic elevation (if specifying a surface point)
118 SGGeod toSGGeod(void) const;
119 SGGeoc toSGGeoc(void) const;
121 SGVec3d toSGVec3d(void) const;
122 SGVec3f toSGVec3f(void) const;
123 SGVec2f toSGVec2f(void) const;
126 friend Point3D operator - (const Point3D& p); // -p1
127 friend bool operator == (const Point3D& a, const Point3D& b); // p1 == p2?
128 friend std::istream& operator>> ( std::istream&, Point3D& );
129 friend std::ostream& operator<< ( std::ostream&, const Point3D& );
132 double distance3D(const Point3D& a) const; // distance between
133 double distance3Dsquared(const Point3D& a) const; // distance between ^ 2
139 operator >> ( std::istream& in, Point3D& p)
145 // read past optional comma
146 while ( in.get(c) ) {
147 if ( (c != ' ') && (c != ',') ) {
148 // push back on the stream
156 // read past optional comma
157 while ( in.get(c) ) {
158 if ( (c != ' ') && (c != ',') ) {
159 // push back on the stream
171 operator<< ( std::ostream& out, const Point3D& p )
173 return out << p.n[PX] << ", " << p.n[PY] << ", " << p.n[PZ];
176 ///////////////////////////
178 // Point3D Member functions
180 ///////////////////////////
184 inline Point3D::Point3D()
190 inline Point3D::Point3D(const double x, const double y, const double z)
192 n[PX] = x; n[PY] = y; n[PZ] = z;
195 inline Point3D::Point3D(const double d)
197 n[PX] = n[PY] = n[PZ] = d;
200 inline Point3D::Point3D(const Point3D& p)
202 n[PX] = p.n[PX]; n[PY] = p.n[PY]; n[PZ] = p.n[PZ];
205 inline Point3D Point3D::fromSGGeod(const SGGeod& geod)
208 pt.setlon(geod.getLongitudeRad());
209 pt.setlat(geod.getLatitudeRad());
210 pt.setelev(geod.getElevationM());
214 inline Point3D Point3D::fromSGGeoc(const SGGeoc& geoc)
217 pt.setlon(geoc.getLongitudeRad());
218 pt.setlat(geoc.getLatitudeRad());
219 pt.setradius(geoc.getRadiusM());
223 inline Point3D Point3D::fromSGVec3(const SGVec3<double>& cart)
232 inline Point3D Point3D::fromSGVec3(const SGVec3<float>& cart)
241 inline Point3D Point3D::fromSGVec2(const SGVec2<double>& cart)
250 // ASSIGNMENT OPERATORS
252 inline Point3D& Point3D::operator = (const Point3D& p)
254 n[PX] = p.n[PX]; n[PY] = p.n[PY]; n[PZ] = p.n[PZ]; return *this;
257 inline Point3D& Point3D::operator += ( const Point3D& p )
259 n[PX] += p.n[PX]; n[PY] += p.n[PY]; n[PZ] += p.n[PZ]; return *this;
262 inline Point3D& Point3D::operator -= ( const Point3D& p )
264 n[PX] -= p.n[PX]; n[PY] -= p.n[PY]; n[PZ] -= p.n[PZ]; return *this;
267 inline Point3D& Point3D::operator *= ( const double d )
269 n[PX] *= d; n[PY] *= d; n[PZ] *= d; return *this;
272 inline Point3D& Point3D::operator /= ( const double d )
274 double d_inv = 1./d; n[PX] *= d_inv; n[PY] *= d_inv; n[PZ] *= d_inv;
278 inline void Point3D::setx(const double x) {
282 inline void Point3D::sety(const double y) {
286 inline void Point3D::setz(const double z) {
290 inline void Point3D::setlon(const double x) {
294 inline void Point3D::setlat(const double y) {
298 inline void Point3D::setradius(const double z) {
302 inline void Point3D::setelev(const double z) {
308 inline double& Point3D::operator [] ( int i)
310 assert(! (i < PX || i > PZ));
314 inline double Point3D::operator [] ( int i) const {
315 assert(! (i < PX || i > PZ));
320 inline double Point3D::x() const { return n[PX]; }
322 inline double Point3D::y() const { return n[PY]; }
324 inline double Point3D::z() const { return n[PZ]; }
326 inline double Point3D::lon() const { return n[PX]; }
328 inline double Point3D::lat() const { return n[PY]; }
330 inline double Point3D::radius() const { return n[PZ]; }
332 inline double Point3D::elev() const { return n[PZ]; }
334 inline SGGeod Point3D::toSGGeod(void) const
337 geod.setLongitudeRad(lon());
338 geod.setLatitudeRad(lat());
339 geod.setElevationM(elev());
343 inline SGGeoc Point3D::toSGGeoc(void) const
346 geoc.setLongitudeRad(lon());
347 geoc.setLatitudeRad(lat());
348 geoc.setRadiusM(radius());
352 inline SGVec3d Point3D::toSGVec3d(void) const
354 return SGVec3d(x(), y(), z());
357 inline SGVec3f Point3D::toSGVec3f(void) const
359 return SGVec3f(x(), y(), z());
362 inline SGVec2f Point3D::toSGVec2f(void) const
364 return SGVec2f(x(), y());
369 inline Point3D operator - (const Point3D& a)
371 return Point3D(-a.n[PX],-a.n[PY],-a.n[PZ]);
374 inline Point3D operator + (const Point3D& a, const Point3D& b)
376 return Point3D(a) += b;
379 inline Point3D operator - (const Point3D& a, const Point3D& b)
381 return Point3D(a) -= b;
384 inline Point3D operator * (const Point3D& a, const double d)
386 return Point3D(a) *= d;
389 inline Point3D operator * (const double d, const Point3D& a)
394 inline Point3D operator / (const Point3D& a, const double d)
396 return Point3D(a) *= (1.0 / d );
399 inline bool operator == (const Point3D& a, const Point3D& b)
402 fabs(a.n[PX] - b.n[PX]) < fgPoint3_Epsilon &&
403 fabs(a.n[PY] - b.n[PY]) < fgPoint3_Epsilon &&
404 fabs(a.n[PZ] - b.n[PZ]) < fgPoint3_Epsilon;
407 inline bool operator != (const Point3D& a, const Point3D& b)
415 Point3D::distance3D(const Point3D& a ) const
423 return sqrt(x*x + y*y + z*z);
428 Point3D::distance3Dsquared(const Point3D& a ) const
436 return(x*x + y*y + z*z);
440 #endif // _POINT3D_HXX