GeoTessGreatCircle.h

Go to the documentation of this file.

//- ****************************************************************************
//- 
//- Copyright 2009 Sandia Corporation. Under the terms of Contract
//- DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government
//- retains certain rights in this software.
//- 
//- BSD Open Source License.
//- All rights reserved.
//- 
//- Redistribution and use in source and binary forms, with or without
//- modification, are permitted provided that the following conditions are met:
//- 
//-    * Redistributions of source code must retain the above copyright notice,
//-      this list of conditions and the following disclaimer.
//-    * Redistributions in binary form must reproduce the above copyright
//-      notice, this list of conditions and the following disclaimer in the
//-      documentation and/or other materials provided with the distribution.
//-    * Neither the name of Sandia National Laboratories nor the names of its
//-      contributors may be used to endorse or promote products derived from
//-      this software without specific prior written permission.
//- 
//- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
//- AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
//- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
//- ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
//- LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
//- CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
//- SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
//- INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
//- CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
//- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
//- POSSIBILITY OF SUCH DAMAGE.
//-
//- ****************************************************************************
 
#ifndef GREATCIRCLE_H_
#define GREATCIRCLE_H_
 
// **** _SYSTEM INCLUDES_ ******************************************************
 
//#include <cstdio>
#include <iostream>
#include <string>
 
// use standard library objects
using namespace std;
 
// **** _LOCAL INCLUDES_ *******************************************************
 
#include "CPPUtils.h"
#include "GeoTessUtils.h"
 
// **** _BEGIN GEOTESS NAMESPACE_ **********************************************
 
namespace geotess {
 
// **** _FORWARD REFERENCES_ ***************************************************
 
// **** _CLASS DEFINITION_ *****************************************************
 
class GEOTESS_EXP_IMP GeoTessGreatCircle
{
  private:
 
    double distance;
 
    double* firstPoint;
 
    double* lastPoint;
 
    double normal[3];
 
    double moveDirection[3];
 
    bool deleteFirst;
 
    bool deleteLast;
 
    double** trnsfrm;
 
    void initialize(const double* intermediatePoint, const bool &shortestPath);
 
    void clear();
 
  public:
 
    virtual ~GeoTessGreatCircle();
 
    GeoTessGreatCircle() : firstPoint(NULL), lastPoint(NULL), deleteFirst(true), deleteLast(true), trnsfrm(NULL)
    {}
 
    GeoTessGreatCircle(const double* firstPoint, const double& distance, const double& direction);
 
    GeoTessGreatCircle(const double* firstPoint, const double* intermediatePoint, const double* lastPoint,
            const bool &shortestPath=true);
 
    GeoTessGreatCircle(const double* firstPoint, const double* lastPoint, const bool &shortestPath=true);
 
    GeoTessGreatCircle(GeoTessGreatCircle& other);
 
    void operator= (GeoTessGreatCircle& other);
 
    bool operator == (const GeoTessGreatCircle& other) const
        {
        return firstPoint[0] == other.firstPoint[0]
        && firstPoint[1] == other.firstPoint[1]
        && firstPoint[2] == other.firstPoint[2]
        && lastPoint[0] == other.lastPoint[0]
        && lastPoint[1] == other.lastPoint[1]
        && lastPoint[2] == other.lastPoint[2]
        && normal[0] == other.normal[0]
        && normal[1] == other.normal[1]
        && normal[2] == other.normal[2];
        };
 
 
    void set(double* firstPoint, double* intermediatePoint, double* lastPoint,
            const bool& shortestPath=true, const bool& deleteWhenDone=false);
 
    void set(double* frstPoint, double* lstPoint,
            const bool& shortestPath=true, const bool& deleteWhenDone=false)
    { set (frstPoint, NULL, lstPoint, shortestPath, deleteWhenDone); }
 
    void set(double* firstPoint, const double& distance, const double& azimuth,
            const bool& deleteWhenDone=false);
 
    double getDistance()
    {
        if (distance < 0.)
        {
            distance = GeoTessUtils::angle(firstPoint, lastPoint);
            if (GeoTessUtils::scalarTripleProduct(firstPoint, lastPoint, normal) < 0.)
                distance = 2*PI - distance;
        }
        return distance;
    }
 
    double getDistanceDegrees()
    {
        return CPPUtils::toDegrees(getDistance());
    }
 
    double getDistance(const double *position)
    {
        // find the shortest distance from firstPoint to unit vector
        double d = GeoTessUtils::angle(firstPoint, position);
 
        if (GeoTessUtils::scalarTripleProduct(firstPoint, position, normal) < 0.)
            d = 2 * PI - d;
 
        return d;
    }
 
    double getDistanceDegrees(const double *position)
    {
        return CPPUtils::toDegrees(getDistance(position));
    }
 
    double* getFirst()
    {
        return firstPoint;
    }
 
    double* getLast()
    {
        return lastPoint;
    }
 
    const double* getNormal()
    {
        return normal;
    }
 
    double* getPoint(const double &dist)
    {
        double* location = new double[3];
        GeoTessUtils::move(firstPoint, moveDirection, dist, location);
        return location;
    }
 
    void getPoint(const double &dist, double* location)
    {
        GeoTessUtils::move(firstPoint, moveDirection, dist, location);
    }
 
    static int getNPoints(const double& dist, const double& spacing, const bool& onCenters=false)
    {
        if (dist <= 0.) return onCenters ? 1 : 2;
        return onCenters ? (int)ceil(dist/spacing) : ((int)ceil(dist/spacing))+1;
    }
 
    int getNPoints(const double& spacing, const bool& onCenters=false)
    {
        return getNPoints(getDistance(), spacing, onCenters);
    }
 
    double getPoints(double** points, const int &npoints, const bool& onCenters=false)
    {
        double dx;
        if (onCenters)
        {
            dx = getDistance()/npoints;
            for (int i=0; i<npoints; ++i) getPoint((i+0.5)*dx, points[i]);
        }
        else
        {
            dx = getDistance()/(npoints-1);
            for (int i=0; i<npoints; ++i) getPoint(i*dx, points[i]);
        }
        return dx;
    }
 
    double getPoints(const double &spacing, double** points, int &npoints, const bool& onCenters=false)
    {
        npoints = getNPoints(spacing, onCenters);
 
        double dx;
        if (onCenters)
        {
            dx = getDistance()/npoints;
            for (int i=0; i<npoints; ++i) getPoint((i+0.5)*dx, points[i]);
        }
        else
        {
            dx = getDistance()/(npoints-1);
            for (int i=0; i<npoints; ++i) getPoint(i*dx, points[i]);
        }
        return dx;
    }
 
    bool getIntersection(GeoTessGreatCircle& other, const bool& inRange, double* intersection)
    {
        if (GeoTessUtils::crossNormal(normal, other.normal, intersection) == 0.)
        {
            intersection[0] = intersection[1] = intersection[2] = NaN_DOUBLE;
            return false;
        }
 
        if (GeoTessUtils::scalarTripleProduct(firstPoint, intersection, normal) < 0.)
        {
            intersection[0] = -intersection[0];
            intersection[1] = -intersection[1];
            intersection[2] = -intersection[2];
        }
 
        if (inRange && (getDistance(intersection) >= getDistance()
                || other.getDistance(intersection) >= other.getDistance()))
        {
            intersection[0] = intersection[1] = intersection[2] = NaN_DOUBLE;
            return false;
        }
 
        return true;
    }
 
    double** getTransform();
 
    void transform(const double* x, double* v)
    {
        // make sure that trnsfrm has been calculated
        getTransform();
        v[0] = x[0] * trnsfrm[0][0] + x[1] * trnsfrm[0][1] + x[2]
                * trnsfrm[0][2];
        v[1] = x[0] * trnsfrm[1][0] + x[1] * trnsfrm[1][1] + x[2]
                * trnsfrm[1][2];
        v[2] = x[0] * trnsfrm[2][0] + x[1] * trnsfrm[2][1] + x[2]
                    * trnsfrm[2][2];
    }
 
    double* transform(const double* x)
    {
        double* v = new double[3];
        transform(x, v);
        return v;
    }
 
    string toString();
 
}; // end class GreatCircle
 
} // end namespace geotess
 
#endif /* GREATCIRCLE_H_ */