EllipsoidTangentPlane - Cesium Documentation

# EllipsoidTangentPlane

#### new EllipsoidTangentPlane(ellipsoid, origin)

  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 as at the center of the ellipsoid, an exception will be thrown.

  Name | Type | Description
  --- | --- | ---
  `ellipsoid` | Ellipsoid | The ellipsoid to use.
  `origin` | Cartesian3 | The point on the surface of the ellipsoid where the tangent plane touches.

  ##### Throws:

  - DeveloperError : origin must not be at the center of the ellipsoid.
  Source: Core/EllipsoidTangentPlane.js, line 49

### Members

#### ellipsoid :Ellipsoid

  Gets the ellipsoid.
  Source: Core/EllipsoidTangentPlane.js, line 81

#### origin :Cartesian3

  Gets the origin.
  Source: Core/EllipsoidTangentPlane.js, line 92

#### readonlyplane :Plane

  Gets the plane which is tangent to the ellipsoid.
  Source: Core/EllipsoidTangentPlane.js, line 104

#### readonlyxAxis :Cartesian3

  Gets the local X-axis (east) of the tangent plane.
  Source: Core/EllipsoidTangentPlane.js, line 116

#### readonlyyAxis :Cartesian3

  Gets the local Y-axis (north) of the tangent plane.
  Source: Core/EllipsoidTangentPlane.js, line 128

### Methods

#### staticEllipsoidTangentPlane.fromPoints(ellipsoid, cartesians)

  Creates a new instance from the provided ellipsoid and the center point of the provided Cartesians.

  Name | Type | Description
  --- | --- | ---
  `ellipsoid` | Ellipsoid | The ellipsoid to use.
  `cartesians` | Cartesian3 | The list of positions surrounding the center point.

  Source: Core/EllipsoidTangentPlane.js, line 155

#### projectPointOntoPlane(cartesian, result) → Cartesian2

  Computes the projection of the provided 3D position onto the 2D plane, radially outward from the `EllipsoidTangentPlane.ellipsoid` coordinate system origin.

  Name | Type | Description
  --- | --- | ---
  `cartesian` | Cartesian3 | The point to project.
  `result` | Cartesian2 | optional The object onto which to store the result.

  ##### Returns:

  The modified result parameter or a new Cartesian2 instance if none was provided. Undefined if there is no intersection point
  Source: Core/EllipsoidTangentPlane.js, line 176

#### projectPointsOntoEllipsoid(cartesians, result) → Array.<Cartesian3>

  Computes the projection of the provided 2D positions onto the 3D ellipsoid.

  Name | Type | Description
  --- | --- | ---
  `cartesians` | Array.<Cartesian2> | The array of points to project.
  `result` | Array.<Cartesian3> | optional The array of Cartesian3 instances onto which to store results.

  ##### Returns:

  The modified result parameter or a new array of Cartesian3 instances if none was provided.
  Source: Core/EllipsoidTangentPlane.js, line 315

#### projectPointsOntoPlane(cartesians, result) → 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.

  Name | Type | Description
  --- | --- | ---
  `cartesians` | Array.<Cartesian3> | The array of points to project.
  `result` | Array.<Cartesian2> | optional The array of Cartesian2 instances onto which to store results.

  ##### Returns:

  The modified result parameter or a new array of Cartesian2 instances if none was provided.

  ##### See:

  - EllipsoidTangentPlane.projectPointOntoPlane
  Source: Core/EllipsoidTangentPlane.js, line 218

#### projectPointsToNearestOnPlane(cartesians, result) → Array.<Cartesian2>

  Computes the projection of the provided 3D positions onto the 2D plane, along the plane normal.

  Name | Type | Description
  --- | --- | ---
  `cartesians` | Array.<Cartesian3> | The array of points to project.
  `result` | Array.<Cartesian2> | optional The array of Cartesian2 instances onto which to store results.

  ##### Returns:

  The modified result parameter or a new array of Cartesian2 instances if none was provided. This will have the same length as `cartesians`.

  ##### See:

  - EllipsoidTangentPlane.projectPointToNearestOnPlane
  Source: Core/EllipsoidTangentPlane.js, line 288

#### projectPointToNearestOnPlane(cartesian, result) → Cartesian2

  Computes the projection of the provided 3D position onto the 2D plane, along the plane normal.

  Name | Type | Description
  --- | --- | ---
  `cartesian` | Cartesian3 | The point to project.
  `result` | Cartesian2 | optional The object onto which to store the result.

  ##### Returns:

  The modified result parameter or a new Cartesian2 instance if none was provided.
  Source: Core/EllipsoidTangentPlane.js, line 249