Class: EllipsoidTangentPlane

EllipsoidTangentPlane

new EllipsoidTangentPlane(origin, ellipsoidopt)

A plane tangent to the provided ellipsoid at the provided origin. If origin is not on the surface of the ellipsoid, it's surface projection will be used. If origin is at the center of the ellipsoid, an exception will be thrown.
Parameters:
Name Type Attributes Default Description
origin Cartesian3 The point on the surface of the ellipsoid where the tangent plane touches.
ellipsoid Ellipsoid <optional>
 Ellipsoid.WGS84 The ellipsoid to use.
Source:
Throws:
origin must not be at the center of the ellipsoid.
Type
DeveloperError

Members

ellipsoid :Ellipsoid

Gets the ellipsoid.
Type:
Source:

origin :Cartesian3

Gets the origin.
Type:
Source:

(readonly) plane :Plane

Gets the plane which is tangent to the ellipsoid.
Type:
Source:

(readonly) xAxis :Cartesian3

Gets the local X-axis (east) of the tangent plane.
Type:
Source:

(readonly) yAxis :Cartesian3

Gets the local Y-axis (north) of the tangent plane.
Type:
Source:

Methods

(static) fromPoints(ellipsoid, cartesians)

Creates a new instance from the provided ellipsoid and the center point of the provided Cartesians.
Parameters:
Name Type Description
ellipsoid Ellipsoid The ellipsoid to use.
cartesians Cartesian3 The list of positions surrounding the center point.
Source:

projectPointOntoPlane(cartesian, resultopt) → {Cartesian2}

Computes the projection of the provided 3D position onto the 2D plane, radially outward from the EllipsoidTangentPlane.ellipsoid coordinate system origin.
Parameters:
Name Type Attributes Description
cartesian Cartesian3 The point to project.
result Cartesian2 <optional>
 The object onto which to store the result.
Source:
Returns:
The modified result parameter or a new Cartesian2 instance if none was provided. Undefined if there is no intersection point
Type
Cartesian2

projectPointsOntoEllipsoid(cartesians, resultopt) → {Array.<Cartesian3>}

Computes the projection of the provided 2D positions onto the 3D ellipsoid.
Parameters:
Name Type Attributes Description
cartesians Array.<Cartesian2> The array of points to project.
result Array.<Cartesian3> <optional>
 The array of Cartesian3 instances onto which to store results.
Source:
Returns:
The modified result parameter or a new array of Cartesian3 instances if none was provided.
Type
Array.<Cartesian3>

projectPointsOntoPlane(cartesians, resultopt) → {Array.<Cartesian2>}

Computes the projection of the provided 3D positions onto the 2D plane (where possible), radially outward from the global origin. The resulting array may be shorter than the input array - if a single projection is impossible it will not be included.
Parameters:
Name Type Attributes Description
cartesians Array.<Cartesian3> The array of points to project.
result Array.<Cartesian2> <optional>
 The array of Cartesian2 instances onto which to store results.
Source:
See:
  • EllipsoidTangentPlane.projectPointOntoPlane
Returns:
The modified result parameter or a new array of Cartesian2 instances if none was provided.
Type
Array.<Cartesian2>

projectPointsToNearestOnPlane(cartesians, resultopt) → {Array.<Cartesian2>}

Computes the projection of the provided 3D positions onto the 2D plane, along the plane normal.
Parameters:
Name Type Attributes Description
cartesians Array.<Cartesian3> The array of points to project.
result Array.<Cartesian2> <optional>
 The array of Cartesian2 instances onto which to store results.
Source:
See:
  • EllipsoidTangentPlane.projectPointToNearestOnPlane
Returns:
The modified result parameter or a new array of Cartesian2 instances if none was provided. This will have the same length as cartesians.
Type
Array.<Cartesian2>

projectPointToNearestOnPlane(cartesian, resultopt) → {Cartesian2}

Computes the projection of the provided 3D position onto the 2D plane, along the plane normal.
Parameters:
Name Type Attributes Description
cartesian Cartesian3 The point to project.
result Cartesian2 <optional>
 The object onto which to store the result.
Source:
Returns:
The modified result parameter or a new Cartesian2 instance if none was provided.
Type
Cartesian2