A coordinate system created from a local horizontal plane at a particular origin point on the globe. More...

#include <CesiumGeospatial/LocalHorizontalCoordinateSystem.h>

Public Member Functions
	LocalHorizontalCoordinateSystem (const Cartographic &origin, LocalDirection xAxisDirection=LocalDirection::East, LocalDirection yAxisDirection=LocalDirection::North, LocalDirection zAxisDirection=LocalDirection::Up, double scaleToMeters=1.0, const Ellipsoid &ellipsoid=CesiumGeospatial::Ellipsoid::WGS84)
	Create a new coordinate system centered at a given longitude, latitude, and ellipsoidal height. More...

	LocalHorizontalCoordinateSystem (const glm::dvec3 &originEcef, LocalDirection xAxisDirection=LocalDirection::East, LocalDirection yAxisDirection=LocalDirection::North, LocalDirection zAxisDirection=LocalDirection::Up, double scaleToMeters=1.0, const Ellipsoid &ellipsoid=CesiumGeospatial::Ellipsoid::WGS84)
	Create a new coordinate system centered at a Earth-Centered, Earth-Fixed position. More...

	LocalHorizontalCoordinateSystem (const glm::dmat4 &localToEcef)
	Create a new coordinate system with a specified transformation to the Earth-Centered, Earth-Fixed frame. This is an advanced constructor and should be avoided in most cases. More...

	LocalHorizontalCoordinateSystem (const glm::dmat4 &localToEcef, const glm::dmat4 &ecefToLocal)
	Create a new coordinate system with the specified transformations between the local frame and the Earth-Centered, Earth-Fixed frame. This is an advanced constructor and should be avoided in most cases. More...

const glm::dmat4 &	getLocalToEcefTransformation () const noexcept
	Gets the transformation matrix from the local horizontal coordinate system managed by this instance to the Earth-Centered, Earth-fixed coordinate system. More...

const glm::dmat4 &	getEcefToLocalTransformation () const noexcept
	Gets the transformation matrix from the Earth-Centered, Earth-Fixed (ECEF) coordinate system to the local horizontal coordinate system managed by this instance. More...

glm::dvec3	localPositionToEcef (const glm::dvec3 &localPosition) const noexcept
	Converts a position in the local horizontal coordinate system managed by this instance to Earth-Centered, Earth-Fixed (ECEF). More...

glm::dvec3	ecefPositionToLocal (const glm::dvec3 &ecefPosition) const noexcept
	Converts a position in the Earth-Centered, Earth-Fixed (ECEF) coordinate system to the local horizontal coordinate system managed by this instance. More...

glm::dvec3	localDirectionToEcef (const glm::dvec3 &localDirection) const noexcept
	Converts a direction in the local horizontal coordinate system managed by this instance to Earth-Centered, Earth-Fixed (ECEF). More...

glm::dvec3	ecefDirectionToLocal (const glm::dvec3 &ecefDirection) const noexcept
	Converts a direction in the Earth-Centered, Earth-Fixed (ECEF) coordinate system to the local horizontal coordinate system managed by this instance. More...

glm::dmat4	computeTransformationToAnotherLocal (const LocalHorizontalCoordinateSystem &target) const noexcept
	Computes the transformation matrix from this local horizontal coordinate system to another one. For example, if the returned matrix is multiplied with a vector representing a position in this coordinate system, the result will be a new vector representing the position in the target coordinate system. More...

Detailed Description

A coordinate system created from a local horizontal plane at a particular origin point on the globe.

Each principal axis in the new coordinate system can be specified to point in a particular compass direction, or it can point up or down. In this way, a right-handed or left-handed coordinate system can be created.

Definition at line 25 of file LocalHorizontalCoordinateSystem.h.

Constructor & Destructor Documentation

◆ LocalHorizontalCoordinateSystem() [1/4]

CesiumGeospatial::LocalHorizontalCoordinateSystem::LocalHorizontalCoordinateSystem	(	const Cartographic &	origin,
		LocalDirection	xAxisDirection = `LocalDirection::East`,
		LocalDirection	yAxisDirection = `LocalDirection::North`,
		LocalDirection	zAxisDirection = `LocalDirection::Up`,
		double	scaleToMeters = `1.0`,
		const Ellipsoid &	ellipsoid = `CesiumGeospatial::Ellipsoid::WGS84`
	)

Create a new coordinate system centered at a given longitude, latitude, and ellipsoidal height.

Parameters

origin	The origin of the coordinate system.
xAxisDirection	The local direction in which the X axis points at the origin.
yAxisDirection	The local direction in which the Y axis points at the origin.
zAxisDirection	The local direction in which the Z axis points at the origin.
scaleToMeters	Local units are converted to meters by multiplying them by this factor. For example, if the local units are centimeters, this parameter should be 1.0 / 100.0.
ellipsoid	The ellipsoid on which the coordinate system is based.

◆ LocalHorizontalCoordinateSystem() [2/4]

CesiumGeospatial::LocalHorizontalCoordinateSystem::LocalHorizontalCoordinateSystem	(	const glm::dvec3 &	originEcef,
		LocalDirection	xAxisDirection = `LocalDirection::East`,
		LocalDirection	yAxisDirection = `LocalDirection::North`,
		LocalDirection	zAxisDirection = `LocalDirection::Up`,
		double	scaleToMeters = `1.0`,
		const Ellipsoid &	ellipsoid = `CesiumGeospatial::Ellipsoid::WGS84`
	)

Create a new coordinate system centered at a Earth-Centered, Earth-Fixed position.

Parameters

originEcef	The origin of the coordinate system.
xAxisDirection	The local direction in which the X axis points at the origin.
yAxisDirection	The local direction in which the Y axis points at the origin.
zAxisDirection	The local direction in which the Z axis points at the origin.
scaleToMeters	Local units are converted to meters by multiplying them by this factor. For example, if the local units are centimeters, this parameter should be 1.0 / 100.0.
ellipsoid	The ellipsoid on which the coordinate system is based.

◆ LocalHorizontalCoordinateSystem() [3/4]

CesiumGeospatial::LocalHorizontalCoordinateSystem::LocalHorizontalCoordinateSystem ( const glm::dmat4 & localToEcef )

explicit

Create a new coordinate system with a specified transformation to the Earth-Centered, Earth-Fixed frame. This is an advanced constructor and should be avoided in most cases.

This constructor can be used to save/restore the state of an instance. It can also be used to create unusual coordinate systems that can't be created by the other constructors, such as coordinate systems where the axes aren't aligned with compass directions.

Parameters

localToEcef The transformation matrix from this coordinate system to the ECEF frame.

◆ LocalHorizontalCoordinateSystem() [4/4]

CesiumGeospatial::LocalHorizontalCoordinateSystem::LocalHorizontalCoordinateSystem	(	const glm::dmat4 &	localToEcef,
		const glm::dmat4 &	ecefToLocal
	)

Create a new coordinate system with the specified transformations between the local frame and the Earth-Centered, Earth-Fixed frame. This is an advanced constructor and should be avoided in most cases.

This constructor can be used to save/restore the state of an instance. It can also be used to create unusual coordinate systems that can't be created by the other constructors, such as coordinate systems where the axes aren't aligned with compass directions.

Parameters

localToEcef	The transformation matrix from this coordinate system to the ECEF frame. This must be the inverse of `ecefToLocal` or behavior is undefined, but this is not enforced.
ecefToLocal	The transformation matrix from the ECEF frame to this coordinate system. This must be the inverse of `localToEcef` or behavior is undefined, but this is not enforced.

Member Function Documentation

◆ computeTransformationToAnotherLocal()

glm::dmat4 CesiumGeospatial::LocalHorizontalCoordinateSystem::computeTransformationToAnotherLocal ( const LocalHorizontalCoordinateSystem & target ) const

noexcept

Computes the transformation matrix from this local horizontal coordinate system to another one. For example, if the returned matrix is multiplied with a vector representing a position in this coordinate system, the result will be a new vector representing the position in the target coordinate system.

Parameters

target The other local horizontal coordinate system.

Returns: The transformation.

◆ ecefDirectionToLocal()

glm::dvec3 CesiumGeospatial::LocalHorizontalCoordinateSystem::ecefDirectionToLocal ( const glm::dvec3 & ecefDirection ) const

noexcept

Converts a direction in the Earth-Centered, Earth-Fixed (ECEF) coordinate system to the local horizontal coordinate system managed by this instance.

Because the vector is treated as a direction only, the translation portion of the transformation is ignored.

Parameters

ecefDirection The direction in the ECEF coordinate system.

Returns: The equivalent direction in the local coordinate system.

◆ ecefPositionToLocal()

glm::dvec3 CesiumGeospatial::LocalHorizontalCoordinateSystem::ecefPositionToLocal ( const glm::dvec3 & ecefPosition ) const

noexcept

Converts a position in the Earth-Centered, Earth-Fixed (ECEF) coordinate system to the local horizontal coordinate system managed by this instance.

Parameters

ecefPosition The position in the ECEF coordinate system.

Returns: The equivalent position in the local coordinate system.

◆ getEcefToLocalTransformation()

const glm::dmat4& CesiumGeospatial::LocalHorizontalCoordinateSystem::getEcefToLocalTransformation ( ) const

inlinenoexcept

Gets the transformation matrix from the Earth-Centered, Earth-Fixed (ECEF) coordinate system to the local horizontal coordinate system managed by this instance.

Returns: The transformation.

Definition at line 131 of file LocalHorizontalCoordinateSystem.h.

◆ getLocalToEcefTransformation()

const glm::dmat4& CesiumGeospatial::LocalHorizontalCoordinateSystem::getLocalToEcefTransformation ( ) const

inlinenoexcept

Gets the transformation matrix from the local horizontal coordinate system managed by this instance to the Earth-Centered, Earth-fixed coordinate system.

Returns: The transformation.

Definition at line 120 of file LocalHorizontalCoordinateSystem.h.

◆ localDirectionToEcef()

glm::dvec3 CesiumGeospatial::LocalHorizontalCoordinateSystem::localDirectionToEcef ( const glm::dvec3 & localDirection ) const

noexcept

Converts a direction in the local horizontal coordinate system managed by this instance to Earth-Centered, Earth-Fixed (ECEF).

Because the vector is treated as a direction only, the translation portion of the transformation is ignored.

Parameters

localDirection The direction in the local coordinate system.

Returns: The equivalent direction in the ECEF coordinate system.

◆ localPositionToEcef()

glm::dvec3 CesiumGeospatial::LocalHorizontalCoordinateSystem::localPositionToEcef ( const glm::dvec3 & localPosition ) const

noexcept

Converts a position in the local horizontal coordinate system managed by this instance to Earth-Centered, Earth-Fixed (ECEF).

Parameters

localPosition The position in the local coordinate system.

Returns: The equivalent position in the ECEF coordinate system.

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

/home/runner/work/cesium-native/cesium-native/CesiumGeospatial/include/CesiumGeospatial/LocalHorizontalCoordinateSystem.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ LocalHorizontalCoordinateSystem() [1/4]

◆ LocalHorizontalCoordinateSystem() [2/4]

◆ LocalHorizontalCoordinateSystem() [3/4]

◆ LocalHorizontalCoordinateSystem() [4/4]

Member Function Documentation

◆ computeTransformationToAnotherLocal()

◆ ecefDirectionToLocal()

◆ ecefPositionToLocal()

◆ getEcefToLocalTransformation()

◆ getLocalToEcefTransformation()

◆ localDirectionToEcef()

◆ localPositionToEcef()