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

CircleGeographicArea

class CircleGeographicArea : GeographicArea

Circle geographic area. This class represents a circular geographical area on WGS 84 Ellipsoid.

Constructors

Link copied to clipboard
constructor()
constructor(address: Long, isRef: Boolean)
constructor(center: Coordinates, radius: Int)

Construct from center and radius in meters

Properties

Link copied to clipboard
val address: Long

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

Link copied to clipboard
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.

Link copied to clipboard
val centerPoint: Coordinates?

Center of the geographic area.

Link copied to clipboard
var radius: Int

Radius of the circular geographic area in meters.

Link copied to clipboard
val type: EGeographicAreaType

Type of the geographic area.

Functions

Link copied to clipboard
open external override fun containsCoordinates(value: Coordinates): Boolean

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

Link copied to clipboard
open external override fun convert(area: GeographicArea): Int

Convert to area of the given type

Link copied to clipboard
open external override fun equalsTo(value: GeographicArea): Boolean

Check if two geographic areas are equal.

Link copied to clipboard
fun finalize()

Overrides finalize that garbage collector will call when needed.

Link copied to clipboard
open external override fun isDefault(): Boolean

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

Link copied to clipboard
open external override fun isEmpty(): Boolean

Check empty area

Link copied to clipboard
fun isReference(): Boolean

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

Link copied to clipboard
operator fun not(): Boolean

Checks if this object is valid.

Link copied to clipboard
fun release()

Releases the native referenced value of this object if:

Link copied to clipboard
open external override fun reset()

Resets the object to default

Link copied to clipboard
external fun set(center: Coordinates, radius: Int)

Set the center & radius

Link copied to clipboard
external fun setCenterPoint(value: Coordinates)

Set the center of the circular geographic area.