Maps SDK for Android/com.magiclane.sdk.core/RectangleGeographicArea

RectangleGeographicArea

class RectangleGeographicArea : GeographicArea

Rectangle geographic area. This interface represents a geographical area on the surface on WGS 84 Ellipsoid.

Constructors

RectangleGeographicArea

constructor(minLat: Double, maxLat: Double, minLon: Double, maxLon: Double)

Constructs a RectangleGeographicArea object with minimum and maximum latitudes and longitudes.

constructor(topLeft: Coordinates, bottomRight: Coordinates)

Constructs a RectangleGeographicArea object from top-left and bottom-right coordinates.

constructor(coords: Coordinates, horizRadius: Double, vertRadius: Double)

Constructs a RectangleGeographicArea object from center coordinates and horizontal/vertical radii.

constructor(address: Long)

Properties

val address: Long

Address of native referenced object. nullptr if not referencing any native allocated object. Note native allocation will happen only once.

var bottomRight: Coordinates?

Coordinates for the bottom-right point.

val boundingBox: RectangleGeographicArea?

Bounding box. This is the smallest rectangle that can be drawn around the area such that it surrounds this geographic area completely. If the area is bigger than what is allowed in the WGS 84 coordinate system, the rectangle is truncated to valid WGS 84 coordinate values. The RectangleGeographicArea is always aligned with parallels and meridians.

val centerPoint: Coordinates?

Center of the geographic area.

var topLeft: Coordinates?

Coordinates for the top-left point.

val type: EGeographicAreaType

Type of the geographic area.

Functions

external fun contains(value: RectangleGeographicArea): Boolean

Check if contains the given rectangle geographic area

containsCoordinates

open external override fun containsCoordinates(value: Coordinates): Boolean

Check if the provided point is contained by the geographic area.

open external override fun convert(area: GeographicArea): Int

Convert to area of the given type

open external override fun equalsTo(value: GeographicArea): Boolean

Check if two geographic areas are equal.

Overrides finalize that garbage collector will call when needed.

external fun intersects(value: RectangleGeographicArea): Boolean

Check if intersects with the given rectangle geographic area

open external override fun isDefault(): Boolean

Returns true if this is a default geographic area and false otherwise.

open external override fun isEmpty(): Boolean

Check empty area

fun isReference(): Boolean

True if keeps a reference to a C++ SDK object False if keeps a C++ SDK object

makeIntersection

external fun makeIntersection(area: RectangleGeographicArea): RectangleGeographicArea?

Create a new area as the result of intersection with the given rectangle geographic area

external fun makeUnion(area: RectangleGeographicArea): RectangleGeographicArea?

Create a new area as the result of union with the given rectangle geographic area

operator fun not(): Boolean

Checks if this object is valid.

Releases the native referenced value of this object if:

open external override fun reset()

Resets the object to default

external fun set(coords: Coordinates, horizontalRadius: Double, verticalRadius: Double)

external fun set(minLat: Double, maxLat: Double, minLon: Double, maxLon: Double)

Set the rectangle given by individual latitudes and longitudes

setIntersection

external fun setIntersection(value: RectangleGeographicArea)

Set the current object as the intersection with the given rectangle geographic area

external fun setUnion(value: RectangleGeographicArea)

Set the current object as the union with the given rectangle geographic area