CesiumGeospatial::EllipsoidTangentPlane Class Reference

A plane tangent to an Ellipsoid at a certain origin position. More...

#include <CesiumGeospatial/EllipsoidTangentPlane.h>

Public Member Functions
	EllipsoidTangentPlane (const glm::dvec3 &origin, const Ellipsoid &ellipsoid=CesiumGeospatial::Ellipsoid::WGS84)
	Creates a new instance.
	EllipsoidTangentPlane (const glm::dmat4 &eastNorthUpToFixedFrame, const Ellipsoid &ellipsoid=CesiumGeospatial::Ellipsoid::WGS84)
	Creates a new instance.
const Ellipsoid &	getEllipsoid () const noexcept
	Returns the Ellipsoid.
const glm::dvec3 &	getOrigin () const noexcept
	Returns the origin, in cartesian coordinates.
const glm::dvec3 &	getXAxis () const noexcept
	Returns the x-axis of this plane.
const glm::dvec3 &	getYAxis () const noexcept
	Returns the y-axis of this plane.
const glm::dvec3 &	getZAxis () const noexcept
	Returns the z-axis (i.e. the normal) of this plane.
const CesiumGeometry::Plane &	getPlane () const noexcept
	Returns a CesiumGeometry::Plane representation of this plane.
glm::dvec2	projectPointToNearestOnPlane (const glm::dvec3 &cartesian) const noexcept
	Computes the position of the projection of the given point on this plane.

Detailed Description

A plane tangent to an Ellipsoid at a certain origin position.

If the origin is not on the surface of the ellipsoid, its surface projection will be used.

Definition at line 20 of file EllipsoidTangentPlane.h.

Constructor & Destructor Documentation

EllipsoidTangentPlane() [1/2]

CesiumGeospatial::EllipsoidTangentPlane::EllipsoidTangentPlane	(	const glm::dvec3 &	origin,
		const Ellipsoid &	ellipsoid = CesiumGeospatial::Ellipsoid::WGS84 )

Creates a new instance.

Parameters

origin	The origin, in cartesian coordinates.
ellipsoid	The ellipsoid. Default value: Ellipsoid::WGS84.

Exceptions

An	std::invalid_argument if the given origin is at the center of the ellipsoid.

EllipsoidTangentPlane() [2/2]

CesiumGeospatial::EllipsoidTangentPlane::EllipsoidTangentPlane	(	const glm::dmat4 &	eastNorthUpToFixedFrame,
		const Ellipsoid &	ellipsoid = CesiumGeospatial::Ellipsoid::WGS84 )

Creates a new instance.

Parameters

eastNorthUpToFixedFrame	A transform that was computed with GlobeTransforms::eastNorthUpToFixedFrame.
ellipsoid	The ellipsoid. Default value: Ellipsoid::WGS84.

Member Function Documentation

getEllipsoid()

const Ellipsoid & CesiumGeospatial::EllipsoidTangentPlane::getEllipsoid ( ) const

inlinenoexcept

Returns the Ellipsoid.

Definition at line 48 of file EllipsoidTangentPlane.h.

getOrigin()

const glm::dvec3 & CesiumGeospatial::EllipsoidTangentPlane::getOrigin ( ) const

inlinenoexcept

Returns the origin, in cartesian coordinates.

Definition at line 53 of file EllipsoidTangentPlane.h.

getPlane()

const CesiumGeometry::Plane & CesiumGeospatial::EllipsoidTangentPlane::getPlane ( ) const

inlinenoexcept

Returns a CesiumGeometry::Plane representation of this plane.

Definition at line 76 of file EllipsoidTangentPlane.h.

getXAxis()

const glm::dvec3 & CesiumGeospatial::EllipsoidTangentPlane::getXAxis ( ) const

inlinenoexcept

Returns the x-axis of this plane.

Definition at line 58 of file EllipsoidTangentPlane.h.

getYAxis()

const glm::dvec3 & CesiumGeospatial::EllipsoidTangentPlane::getYAxis ( ) const

inlinenoexcept

Returns the y-axis of this plane.

Definition at line 63 of file EllipsoidTangentPlane.h.

getZAxis()

const glm::dvec3 & CesiumGeospatial::EllipsoidTangentPlane::getZAxis ( ) const

inlinenoexcept

Returns the z-axis (i.e. the normal) of this plane.

Definition at line 68 of file EllipsoidTangentPlane.h.

projectPointToNearestOnPlane()

glm::dvec2 CesiumGeospatial::EllipsoidTangentPlane::projectPointToNearestOnPlane ( const glm::dvec3 & cartesian ) const

noexcept

Computes the position of the projection of the given point on this plane.

Projects the given point on this plane, along the normal. The result will be a 2D point, referring to the local coordinate system of the plane that is given by the x- and y-axis.

Parameters

cartesian

The point in cartesian coordinates.

Returns

The 2D representation of the point on the plane that is closest to the given position.

---

The documentation for this class was generated from the following file:

• /home/runner/work/cesium-native/cesium-native/CesiumGeospatial/include/CesiumGeospatial/EllipsoidTangentPlane.h