main.cesium.EllipsoidGeodesic.kt Maven / Gradle / Ivy
The newest version!
// Automatically generated - do not modify!
@file:JsModule("cesium")
@file:Suppress(
"EXTERNAL_CLASS_CONSTRUCTOR_PROPERTY_PARAMETER",
)
package cesium
/**
* Initializes a geodesic on the ellipsoid connecting the two provided planetodetic points.
* @see Online Documentation
*
* @constructor
* @property [start] The initial planetodetic point on the path.
* @property [end] The final planetodetic point on the path.
* @property [ellipsoid] The ellipsoid on which the geodesic lies.
* Default value - [Ellipsoid.WGS84]
* @see Online Documentation
*/
external class EllipsoidGeodesic(
val start: Cartographic = definedExternally,
val end: Cartographic = definedExternally,
val ellipsoid: Ellipsoid = definedExternally,
) {
/**
* Gets the surface distance between the start and end point
* @see Online Documentation
*/
val surfaceDistance: Double
/**
* Gets the heading at the initial point.
* @see Online Documentation
*/
val startHeading: Double
/**
* Gets the heading at the final point.
* @see Online Documentation
*/
val endHeading: Double
/**
* Sets the start and end points of the geodesic
* @param [start] The initial planetodetic point on the path.
* @param [end] The final planetodetic point on the path.
* @see Online Documentation
*/
fun setEndPoints(
start: Cartographic,
end: Cartographic,
)
/**
* Provides the location of a point at the indicated portion along the geodesic.
* @param [fraction] The portion of the distance between the initial and final points.
* @param [result] The object in which to store the result.
* @return The location of the point along the geodesic.
* @see Online Documentation
*/
fun interpolateUsingFraction(
fraction: Double,
result: Cartographic? = definedExternally,
): Cartographic
/**
* Provides the location of a point at the indicated distance along the geodesic.
* @param [distance] The distance from the inital point to the point of interest along the geodesic
* @param [result] The object in which to store the result.
* @return The location of the point along the geodesic.
* @see Online Documentation
*/
fun interpolateUsingSurfaceDistance(
distance: Double,
result: Cartographic? = definedExternally,
): Cartographic
}