GeographicArea class abstract Core

Abstract base class for representing geographic areas on the WGS 84 ellipsoid.

Geographic areas define spatial regions used throughout the SDK for various purposes including map centering, search area restriction, geofencing, and representing the spatial extent of entities like landmarks, routes, and traffic events. The framework supports rectangles, circles, polygons, and tile collections as concrete implementations.

All geometric calculations are performed in two dimensions, with altitude values in Coordinates being ignored for containment and intersection tests. Geographic areas provide common operations for spatial queries and conversions between different area types where possible.

Common Operations

All geographic area implementations provide methods for:

• Point containment testing via containsCoordinates
• Bounding box calculation via boundingBox
• Center point computation via centerPoint
• Type conversion via convert
• Empty state checking via isDefault

See also:

• RectangleGeographicArea: Rectangular areas aligned with latitude/longitude.
• CircleGeographicArea: Circular areas defined by center and radius.
• PolygonGeographicArea: Complex polygonal areas with high precision.
• TilesCollectionGeographicArea: Areas represented as map tile collections.

Implementers

• CircleGeographicArea
• PolygonGeographicArea
• RectangleGeographicArea
• TilesCollectionGeographicArea

Constructors

GeographicArea.fromJson(Map<String, dynamic> json)

Deserializes a JSON-compatible map to create an instance.

factory

Properties

boundingBox → RectangleGeographicArea

Gets the smallest rectangle that completely encloses this geographic area.

no setter

centerPoint → Coordinates

Gets the representative center point of this geographic area.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

isDefault → bool

Indicates whether this geographic area is in a default or empty state.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

type → GeographicAreaType

Gets the specific type identifier for this geographic area implementation.

no setter

Methods

containsCoordinates(Coordinates point) → bool

Tests whether a coordinate point lies within this geographic area.

convert(GeographicAreaType toType) → GeographicArea?

Attempts to convert this geographic area to a different type.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

reset() → void

Resets this geographic area to its default empty state.

toJson() → Map<String, dynamic>

Serializes this instance to a JSON-compatible map.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited