geodeticCS.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: geodCrdSys.h,v $ $Revision: 1.13 $ $State: Exp $
*********************************************************************/
#ifndef geodeticCS_H_
#define geodeticCS_H_

//
// \file geodCrdSys.h Contains the geodetic coordinate system class declaration.
// 
#include "terrainCS/terrainCSDefines.h"
#include "terrainCS/coordSystem.h"

// class DtGeodeticCS:
//
// Instances of DtGeodeticCS are used by the terrain objects
// for performing coordinate conversions from geocentric to geodetic.
class DT_DLL_terrainCS DtGeodeticCS : public Coordinate_System
{
public:
   // constructor
   DtGeodeticCS(bool setUseDynamicSceneOrigin = false,
      double dynamicSceneOriginDeadband = 0.0);

   // copy constructor
   DtGeodeticCS(const DtGeodeticCS& orig);

   // destructor
   virtual ~DtGeodeticCS() override;

   // assignment operator
   DtGeodeticCS& operator=(
      const DtGeodeticCS& orig);

   // Clone operator
   virtual Coordinate_System *clone() const override;

   // coordinates in the local (i.e., projected) coordinate system only
   // consist of X and Y, but we use a three element vector to store them so a
   // programmer can use the Z value for height above terrain.
   virtual void dis2local(const DtVector &in, DtVector &out) const override;
   virtual void local2dis(const DtVector &in, DtVector &out) const override;

   // Returns the geodetic coordinate for a given local position.  Local position
   // must be specified with x-component as longitude (in radians), y-component
   // as latitude (in radians), and z-component as altitude (in meters).
   virtual void localToGeodetic(const DtVector &localPosition,
                   DtGeodeticCoord &geodeticPosition) const override;

   // Returns the local coordinate for a given geodetic position.  Returned local
   // position x-component is longitude (in radians), y-component is latitude 
   // (in radians), and z-component is altitude (in meters).  
   virtual void geodeticToLocal(const DtGeodeticCoord &geodeticPosition,
                                DtVector &localPosition) const override;

   // Returns a unit vector pointing downward (gravity) at a given
   // location.
   virtual DtVector down(const DtVector &location) const override;

   // Returns a coordinate transformation object for going between 
   // topo and local coordinates, at a given location.  It is up to the
   // caller to ensure that topoToLocal and localToTopo are valid pointers.
   virtual void topoToLocal(const DtVector &localPosition,
                            DtDcm &topoToLocal) const override;
   virtual void localToTopo(const DtVector &localPosition,
                            DtDcm &localToTopo) const override;

   // Returns name of coordinate system
   virtual DtString coordinateSystemName() const override;

private:
   // These functions are not implemented for this class, so they are hidden.
   using Coordinate_System::dis2local;
   using Coordinate_System::local2dis;
   using Coordinate_System::localToGeodetic;
   using Coordinate_System::geodeticToLocal;
};

#endif