org.cesiumjs.cs.core

Class EllipsoidRhumbLine

java.lang.Object

org.cesiumjs.cs.core.EllipsoidRhumbLine

@JsType(isNative=true,
        namespace="Cesium",
        name="EllipsoidRhumbLine")
public class EllipsoidRhumbLine
extends Object

Initializes a rhumb line on the ellipsoid connecting the two provided planetodetic points.

Author:

Serge Silaev aka iSergio

Constructor Summary

Constructors

Constructor and Description
EllipsoidRhumbLine() Initializes a rhumb line on the ellipsoid connecting the two provided planetodetic points.
EllipsoidRhumbLine(Cartographic start) Initializes a rhumb line on the ellipsoid connecting the two provided planetodetic points.
EllipsoidRhumbLine(Cartographic start, Cartographic end) Initializes a rhumb line on the ellipsoid connecting the two provided planetodetic points.
EllipsoidRhumbLine(Cartographic start, Cartographic end, Ellipsoid ellipsoid) Initializes a rhumb line on the ellipsoid connecting the two provided planetodetic points.

Method Summary

Modifier and Type	Method and Description
Ellipsoid	ellipsoid() Gets the ellipsoid.
Cartographic	end() Gets the final planetodetic point on the path.
Cartographic	findIntersectionWithLatitude(double intersectionLatitude) Provides the location of a point at the indicated latitude along the rhumb line.
Cartographic	findIntersectionWithLatitude(double intersectionLatitude, Cartographic result) Provides the location of a point at the indicated latitude along the rhumb line.
Cartographic	findIntersectionWithLongitude(double intersectionLongitude) Provides the location of a point at the indicated longitude along the rhumb line.
Cartographic	findIntersectionWithLongitude(double intersectionLongitude, Cartographic result) Provides the location of a point at the indicated longitude along the rhumb line.
static EllipsoidRhumbLine	fromStartHeadingDistance(Cartographic start, double heading, double distance) Create a rhumb line using an initial position with a heading and distance.
static EllipsoidRhumbLine	fromStartHeadingDistance(Cartographic start, double heading, double distance, Ellipsoid ellipsoid) Create a rhumb line using an initial position with a heading and distance.
static EllipsoidRhumbLine	fromStartHeadingDistance(Cartographic start, double heading, double distance, Ellipsoid ellipsoid, EllipsoidRhumbLine result) Create a rhumb line using an initial position with a heading and distance.
double	heading() Gets the heading from the start point to the end point.
Cartographic	interpolateUsingFraction(double fraction) Provides the location of a point at the indicated portion along the rhumb line.
Cartographic	interpolateUsingSurfaceDistance(double distance) Provides the location of a point at the indicated distance along the rhumb line.
Cartographic	interpolateUsingSurfaceDistance(double distance, Cartographic result) Provides the location of a point at the indicated distance along the rhumb line.
void	setEndPoints(Cartographic start, Cartographic end) Sets the start and end points of the rhumb line.
Cartographic	start() Gets the initial planetodetic point on the path.
double	surfaceDistance() Gets the surface distance between the start and end point

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EllipsoidRhumbLine

@JsConstructor
public EllipsoidRhumbLine()

Initializes a rhumb line on the ellipsoid connecting the two provided planetodetic points.

EllipsoidRhumbLine

@JsConstructor
public EllipsoidRhumbLine(Cartographic start)

Initializes a rhumb line on the ellipsoid connecting the two provided planetodetic points.

Parameters:

start - The initial planetodetic point on the path.

EllipsoidRhumbLine

@JsConstructor
public EllipsoidRhumbLine(Cartographic start,
                                         Cartographic end)

Initializes a rhumb line on the ellipsoid connecting the two provided planetodetic points.

Parameters:

start - The initial planetodetic point on the path.

end - The final planetodetic point on the path.

EllipsoidRhumbLine

@JsConstructor
public EllipsoidRhumbLine(Cartographic start,
                                         Cartographic end,
                                         Ellipsoid ellipsoid)

Initializes a rhumb line on the ellipsoid connecting the two provided planetodetic points.

Parameters:

start - The initial planetodetic point on the path.

end - The final planetodetic point on the path.

ellipsoid - The ellipsoid on which the rhumb line lies.

Method Detail

ellipsoid

@JsProperty(name="ellipsoid")
public Ellipsoid ellipsoid()

Gets the ellipsoid.

end

@JsProperty(name="end")
public Cartographic end()

Gets the final planetodetic point on the path.

heading

@JsProperty(name="heading")
public double heading()

Gets the heading from the start point to the end point.

start

@JsProperty(name="start")
public Cartographic start()

Gets the initial planetodetic point on the path.

surfaceDistance

@JsProperty(name="surfaceDistance")
public double surfaceDistance()

Gets the surface distance between the start and end point

fromStartHeadingDistance

@JsMethod
public static EllipsoidRhumbLine fromStartHeadingDistance(Cartographic start,
                                                                    double heading,
                                                                    double distance)

Create a rhumb line using an initial position with a heading and distance.

Parameters:

start - The initial planetodetic point on the path.

heading - The heading in radians.

distance - The rhumb line distance between the start and end point.

Returns:

The EllipsoidRhumbLine object.

fromStartHeadingDistance

@JsMethod
public static EllipsoidRhumbLine fromStartHeadingDistance(Cartographic start,
                                                                    double heading,
                                                                    double distance,
                                                                    Ellipsoid ellipsoid)

Create a rhumb line using an initial position with a heading and distance.

Parameters:

start - The initial planetodetic point on the path.

heading - The heading in radians.

distance - The rhumb line distance between the start and end point.

ellipsoid - The ellipsoid on which the rhumb line lies.

Returns:

The EllipsoidRhumbLine object.

fromStartHeadingDistance

@JsMethod
public static EllipsoidRhumbLine fromStartHeadingDistance(Cartographic start,
                                                                    double heading,
                                                                    double distance,
                                                                    Ellipsoid ellipsoid,
                                                                    EllipsoidRhumbLine result)

Create a rhumb line using an initial position with a heading and distance.

Parameters:

start - The initial planetodetic point on the path.

heading - The heading in radians.

distance - The rhumb line distance between the start and end point.

ellipsoid - The ellipsoid on which the rhumb line lies.

result - The object in which to store the result.

Returns:

The EllipsoidRhumbLine object.

findIntersectionWithLatitude

@JsMethod
public Cartographic findIntersectionWithLatitude(double intersectionLatitude)

Provides the location of a point at the indicated latitude along the rhumb line. If the latitude is outside the range of start and end points, the first intersection with the latitude from that start point in the direction of the heading is returned. This follows the spiral property of a rhumb line.

Parameters:

intersectionLatitude - The latitude, in radians, at which to find the intersection point from the starting point using the heading.

Returns:

The location of the intersection point along the rhumb line, undefined if there is no intersection or infinite intersections.

findIntersectionWithLatitude

@JsMethod
public Cartographic findIntersectionWithLatitude(double intersectionLatitude,
                                                           Cartographic result)

Provides the location of a point at the indicated latitude along the rhumb line. If the latitude is outside the range of start and end points, the first intersection with the latitude from that start point in the direction of the heading is returned. This follows the spiral property of a rhumb line.

Parameters:

intersectionLatitude - The latitude, in radians, at which to find the intersection point from the starting point using the heading.

result - The object in which to store the result.

Returns:

The location of the intersection point along the rhumb line, undefined if there is no intersection or infinite intersections.

findIntersectionWithLongitude

@JsMethod
public Cartographic findIntersectionWithLongitude(double intersectionLongitude)

Provides the location of a point at the indicated longitude along the rhumb line. If the longitude is outside the range of start and end points, the first intersection with the longitude from the start point in the direction of the heading is returned. This follows the spiral property of a rhumb line.

Parameters:

intersectionLongitude - The longitude, in radians, at which to find the intersection point from the starting point using the heading.

Returns:

The location of the intersection point along the rhumb line, undefined if there is no intersection or infinite intersections.

findIntersectionWithLongitude

@JsMethod
public Cartographic findIntersectionWithLongitude(double intersectionLongitude,
                                                            Cartographic result)

Provides the location of a point at the indicated longitude along the rhumb line. If the longitude is outside the range of start and end points, the first intersection with the longitude from the start point in the direction of the heading is returned. This follows the spiral property of a rhumb line.

Parameters:

intersectionLongitude - The longitude, in radians, at which to find the intersection point from the starting point using the heading.

result - The object in which to store the result.

Returns:

The location of the intersection point along the rhumb line, undefined if there is no intersection or infinite intersections.

interpolateUsingFraction

@JsMethod
public Cartographic interpolateUsingFraction(double fraction)

Provides the location of a point at the indicated portion along the rhumb line.

Parameters:

fraction - The portion of the distance between the initial and final points.

Returns:

The location of the point along the rhumb line.

interpolateUsingSurfaceDistance

@JsMethod
public Cartographic interpolateUsingSurfaceDistance(double distance)

Provides the location of a point at the indicated distance along the rhumb line.

Parameters:

distance - The distance from the inital point to the point of interest along the rhumbLine.

Returns:

The location of the point along the rhumb line.

interpolateUsingSurfaceDistance

@JsMethod
public Cartographic interpolateUsingSurfaceDistance(double distance,
                                                              Cartographic result)

Provides the location of a point at the indicated distance along the rhumb line.

Parameters:

distance - The distance from the inital point to the point of interest along the rhumbLine.

result - The object in which to store the result.

Returns:

The location of the point along the rhumb line.

setEndPoints

@JsMethod
public void setEndPoints(Cartographic start,
                                   Cartographic end)

Sets the start and end points of the rhumb line.

Parameters:

start - The initial planetodetic point on the path.

end - The final planetodetic point on the path.