Files
OpenSpace/include/openspace/util/ellipsoid.h
Alexander Bock 6dc738e54e Move functions about globe locations from the GlobeBrowsingModule into the core (#3613)
* Make GlobeRotation and GlobeTranslation work for non-globes and move them to the base module
* Move ellipsoid and geodetic classes into the core
* Allow more things to take scene graph nodes instead of RenderableGlobes
* Move goToGeo and related Lua functions into the core
* Move more functions from the pathnavigation namespace into the navigation namespace

---------

Co-authored-by: Emma Broman <emma.broman@liu.se>
2025-04-23 16:15:17 +02:00

120 lines
5.1 KiB
C++

/*****************************************************************************************
* *
* OpenSpace *
* *
* Copyright (c) 2014-2025 *
* *
* Permission is hereby granted, free of charge, to any person obtaining a copy of this *
* software and associated documentation files (the "Software"), to deal in the Software *
* without restriction, including without limitation the rights to use, copy, modify, *
* merge, publish, distribute, sublicense, and/or sell copies of the Software, and to *
* permit persons to whom the Software is furnished to do so, subject to the following *
* conditions: *
* *
* The above copyright notice and this permission notice shall be included in all copies *
* or substantial portions of the Software. *
* *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, *
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A *
* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT *
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF *
* CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE *
* OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
****************************************************************************************/
#ifndef __OPENSPACE_CORE___ELLIPSOID___H__
#define __OPENSPACE_CORE___ELLIPSOID___H__
#include <ghoul/glm.h>
#include <vector>
namespace openspace {
struct Geodetic2;
struct Geodetic3;
/**
* This class is based largely on the Ellipsoid class defined in the book
* "3D Engine Design for Virtual Globes". Most planets or planetary objects are better
* described using ellipsoids than spheres. All inputs and outputs to this class is based
* on the WGS84 standard coordinate system where the x-axis points towards geographic
* (lat = 0, lon = 0), the y-axis points towards (lat = 0, lon = 90deg) and the z-axis
* points towards the north pole. For other globes than earth of course the radii can
* differ.
*/
class Ellipsoid {
public:
/**
* Shadow configuration structure.
*/
struct ShadowConfiguration {
std::pair<std::string, double> source;
std::pair<std::string, double> caster;
};
/**
* \param radii defines three radii for the Ellipsoid
*/
explicit Ellipsoid(glm::dvec3 radii = glm::dvec3(1.0));
/**
* Scales a point along the geocentric normal and places it on the surface of the
* Ellipsoid.
*
* \param p is a point in the cartesian coordinate system to be placed on the surface
* of the Ellipsoid
*/
glm::dvec3 geocentricSurfaceProjection(const glm::dvec3& p) const;
/**
* Scales a point along the geodetic normal and places it on the surface of the
* Ellipsoid.
*
* \param p is a point in the cartesian coordinate system to be placed on the surface
* of the Ellipsoid
*/
glm::dvec3 geodeticSurfaceProjection(const glm::dvec3& p) const;
glm::dvec3 geodeticSurfaceNormalForGeocentricallyProjectedPoint(
const glm::dvec3& p) const;
glm::dvec3 geodeticSurfaceNormal(const Geodetic2& geodetic2) const;
const glm::dvec3& radii() const;
double minimumRadius() const;
double maximumRadius() const;
double longitudalDistance(double lat, double lon1, double lon2) const;
double greatCircleDistance(const Geodetic2& p1, const Geodetic2& p2) const;
Geodetic2 cartesianToGeodetic2(const glm::dvec3& p) const;
glm::dvec3 cartesianSurfacePosition(const Geodetic2& geodetic2) const;
glm::dvec3 cartesianPosition(const Geodetic3& geodetic3) const;
void setShadowConfigurationArray(
std::vector<Ellipsoid::ShadowConfiguration> shadowConfArray
);
const std::vector<Ellipsoid::ShadowConfiguration>& shadowConfigurationArray() const;
private:
struct EllipsoidCache {
glm::dvec3 radiiSquared = glm::dvec3(0.0);
glm::dvec3 oneOverRadiiSquared = glm::dvec3(0.0);
glm::dvec3 radiiToTheFourth = glm::dvec3(0.0);
double minimumRadius = 0.0;
double maximumRadius = 0.0;
} _cached;
void updateInternalCache();
glm::dvec3 _radii = glm::dvec3(0.0);
// Eclipse shadows conf
std::vector<Ellipsoid::ShadowConfiguration> _shadowConfArray;
};
} // namespace openspace
#endif // __OPENSPACE_CORE___ELLIPSOID___H__