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
44 #ifdef SG_HAVE_STD_INCLUDES
49 # include <iostream.h>
56 // I don't understand ... <math.h> or <cmath> should be included
57 // already depending on how you defined SG_HAVE_STD_INCLUDES, but I
58 // can go ahead and add this -- CLO
60 SG_USING_NAMESPACE(std);
63 SG_USING_STD(ostream);
64 SG_USING_STD(istream);
67 const double fgPoint3_Epsilon = 0.0000001;
69 enum {PX, PY, PZ}; // axes
71 // Kludge for msvc++ 6.0 - requires forward decls of friend functions.
73 istream& operator>> ( istream&, Point3D& );
74 ostream& operator<< ( ostream&, const Point3D& );
75 Point3D operator- (const Point3D& p); // -p1
76 bool operator== (const Point3D& a, const Point3D& b); // p1 == p2?
91 /** Default constructor */
93 Point3D(const double x, const double y, const double z);
94 explicit Point3D(const double d);
95 Point3D(const Point3D &p);
97 static Point3D fromSGGeod(const SGGeod& geod);
98 static Point3D fromSGGeoc(const SGGeoc& geoc);
99 static Point3D fromSGVec3(const SGVec3<double>& cart);
101 // Assignment operators
103 Point3D& operator = ( const Point3D& p ); // assignment of a Point3D
104 Point3D& operator += ( const Point3D& p ); // incrementation by a Point3D
105 Point3D& operator -= ( const Point3D& p ); // decrementation by a Point3D
106 Point3D& operator *= ( const double d ); // multiplication by a constant
107 Point3D& operator /= ( const double d ); // division by a constant
109 void setx(const double x);
110 void sety(const double y);
111 void setz(const double z);
112 void setlon(const double x);
113 void setlat(const double y);
114 void setradius(const double z);
115 void setelev(const double z);
119 double& operator [] ( int i); // indexing
120 double operator[] (int i) const; // read-only indexing
122 inline const double *get_n() const { return n; };
123 double x() const; // cartesian x
124 double y() const; // cartesian y
125 double z() const; // cartesian z
127 double lon() const; // polar longitude
128 double lat() const; // polar latitude
129 double radius() const; // polar radius
130 double elev() const; // geodetic elevation (if specifying a surface point)
132 SGGeod toSGGeod(void) const;
133 SGGeoc toSGGeoc(void) const;
136 friend Point3D operator - (const Point3D& p); // -p1
137 friend bool operator == (const Point3D& a, const Point3D& b); // p1 == p2?
138 friend istream& operator>> ( istream&, Point3D& );
139 friend ostream& operator<< ( ostream&, const Point3D& );
142 double distance3D(const Point3D& a) const; // distance between
143 double distance3Dsquared(const Point3D& a) const; // distance between ^ 2
149 operator >> ( istream& in, Point3D& p)
155 // read past optional comma
156 while ( in.get(c) ) {
157 if ( (c != ' ') && (c != ',') ) {
158 // push back on the stream
166 // read past optional comma
167 while ( in.get(c) ) {
168 if ( (c != ' ') && (c != ',') ) {
169 // push back on the stream
181 operator<< ( ostream& out, const Point3D& p )
183 return out << p.n[PX] << ", " << p.n[PY] << ", " << p.n[PZ];
186 ///////////////////////////
188 // Point3D Member functions
190 ///////////////////////////
194 inline Point3D::Point3D()
200 inline Point3D::Point3D(const double x, const double y, const double z)
202 n[PX] = x; n[PY] = y; n[PZ] = z;
205 inline Point3D::Point3D(const double d)
207 n[PX] = n[PY] = n[PZ] = d;
210 inline Point3D::Point3D(const Point3D& p)
212 n[PX] = p.n[PX]; n[PY] = p.n[PY]; n[PZ] = p.n[PZ];
215 inline Point3D Point3D::fromSGGeod(const SGGeod& geod)
218 pt.setlon(geod.getLongitudeRad());
219 pt.setlat(geod.getLatitudeRad());
220 pt.setelev(geod.getElevationM());
224 inline Point3D Point3D::fromSGGeoc(const SGGeoc& geoc)
227 pt.setlon(geoc.getLongitudeRad());
228 pt.setlat(geoc.getLatitudeRad());
229 pt.setradius(geoc.getRadiusM());
233 inline Point3D Point3D::fromSGVec3(const SGVec3<double>& cart)
242 // ASSIGNMENT OPERATORS
244 inline Point3D& Point3D::operator = (const Point3D& p)
246 n[PX] = p.n[PX]; n[PY] = p.n[PY]; n[PZ] = p.n[PZ]; return *this;
249 inline Point3D& Point3D::operator += ( const Point3D& p )
251 n[PX] += p.n[PX]; n[PY] += p.n[PY]; n[PZ] += p.n[PZ]; return *this;
254 inline Point3D& Point3D::operator -= ( const Point3D& p )
256 n[PX] -= p.n[PX]; n[PY] -= p.n[PY]; n[PZ] -= p.n[PZ]; return *this;
259 inline Point3D& Point3D::operator *= ( const double d )
261 n[PX] *= d; n[PY] *= d; n[PZ] *= d; return *this;
264 inline Point3D& Point3D::operator /= ( const double d )
266 double d_inv = 1./d; n[PX] *= d_inv; n[PY] *= d_inv; n[PZ] *= d_inv;
270 inline void Point3D::setx(const double x) {
274 inline void Point3D::sety(const double y) {
278 inline void Point3D::setz(const double z) {
282 inline void Point3D::setlon(const double x) {
286 inline void Point3D::setlat(const double y) {
290 inline void Point3D::setradius(const double z) {
294 inline void Point3D::setelev(const double z) {
300 inline double& Point3D::operator [] ( int i)
302 assert(! (i < PX || i > PZ));
306 inline double Point3D::operator [] ( int i) const {
307 assert(! (i < PX || i > PZ));
312 inline double Point3D::x() const { return n[PX]; }
314 inline double Point3D::y() const { return n[PY]; }
316 inline double Point3D::z() const { return n[PZ]; }
318 inline double Point3D::lon() const { return n[PX]; }
320 inline double Point3D::lat() const { return n[PY]; }
322 inline double Point3D::radius() const { return n[PZ]; }
324 inline double Point3D::elev() const { return n[PZ]; }
326 inline SGGeod Point3D::toSGGeod(void) const
329 geod.setLongitudeRad(lon());
330 geod.setLatitudeRad(lat());
331 geod.setElevationM(elev());
335 inline SGGeoc Point3D::toSGGeoc(void) const
338 geoc.setLongitudeRad(lon());
339 geoc.setLatitudeRad(lat());
340 geoc.setRadiusM(radius());
346 inline Point3D operator - (const Point3D& a)
348 return Point3D(-a.n[PX],-a.n[PY],-a.n[PZ]);
351 inline Point3D operator + (const Point3D& a, const Point3D& b)
353 return Point3D(a) += b;
356 inline Point3D operator - (const Point3D& a, const Point3D& b)
358 return Point3D(a) -= b;
361 inline Point3D operator * (const Point3D& a, const double d)
363 return Point3D(a) *= d;
366 inline Point3D operator * (const double d, const Point3D& a)
371 inline Point3D operator / (const Point3D& a, const double d)
373 return Point3D(a) *= (1.0 / d );
376 inline bool operator == (const Point3D& a, const Point3D& b)
379 fabs(a.n[PX] - b.n[PX]) < fgPoint3_Epsilon &&
380 fabs(a.n[PY] - b.n[PY]) < fgPoint3_Epsilon &&
381 fabs(a.n[PZ] - b.n[PZ]) < fgPoint3_Epsilon;
384 inline bool operator != (const Point3D& a, const Point3D& b)
392 Point3D::distance3D(const Point3D& a ) const
400 return sqrt(x*x + y*y + z*z);
405 Point3D::distance3Dsquared(const Point3D& a ) const
413 return(x*x + y*y + z*z);
417 #endif // _POINT3D_HXX