WemapCoreSDK/com.getwemap.sdk.core.model.entities

Package-level declarations

Types

Attitude

@Serializable

data class Attitude(val quaternion: Quaternion = Quaternion(), val time: Long? = null, val accuracy: Double? = null)

Represents a device orientation, backed by an EUS quaternion.

Category

@Serializable

data class Category(val name: String, val slug: String)

A category used to group and filter points of interest.

Coordinate

class Coordinate(point: Point, val levels: Levels = Levels.Outdoor, val altitude: Double? = null, val bearing: Double? = null, val horizontalAccuracy: Double = 0.0, val timestamp: Long = System.currentTimeMillis(), val heightFromFloor: Double? = null, val heightFromGround: Double? = null) : CompactStringConvertible

A geographic location — a 2D point plus indoor levels, altitude, bearing, horizontal accuracy and time.

Destination

@Serializable

data class Destination(val coordinate: Coordinate, val name: String? = null)

A destination of an itinerary, defined by a coordinate and an optional name.

DistanceFormula

enum DistanceFormula : Enum<DistanceFormula>

GeoJsonItinerarySerializer

object GeoJsonItinerarySerializer : KSerializer<Itinerary>

Serializes an Itinerary to and from its GeoJSON representation.

Heading

class Heading(val value: Double, val time: Long?, val accuracy: Double?)

A heading that can be created from a true heading or derived from an EUS quaternion.

Incline

@Serializable

enum Incline : Enum<Incline>

The incline direction of a step: UP for an upward incline, DOWN for a downward incline.

Itinerary

@Serializable(with = ItinerarySerializer::class)

data class Itinerary(val origin: Coordinate, val destination: Coordinate, val distance: Double, val duration: Double, val transitMode: TravelMode, val legs: List<Leg>) : CompactStringConvertible

An itinerary between an origin and a destination, composed of one or more Legs.

Leg

@Serializable

data class Leg(val start: Destination, val end: Destination, val transitMode: TravelMode, val distance: Double, val duration: Double, val coordinates: List<@Serializable(with = CompressedCoordinateSerializer::class) Coordinate>, val steps: List<Step>)

A single leg of an itinerary, travelled with one transit mode between two destinations.

LegSegment

class LegSegment(p1: Coordinate, p2: Coordinate, val levelDifference: Float? = null, val stepKind: Step.Kind? = null, val stepDirection: Step.Direction? = null) : Segment

A Segment belonging to a navigation leg, carrying step-related metadata.

Levels

sealed class Levels

Represents the level(s) an entity is located on: outdoor, a single level, or a range of levels.

PaginationContainer

@Serializable

data class PaginationContainer<T>

A page of results returned by a Wemap backend service.

PointOfInterest

@Serializable(with = PointOfInterestSerializer::class)

data class PointOfInterest : CompactStringConvertible

A point of interest located on a map.

PointOfInterestType

@Serializable

enum PointOfInterestType : CompactStringConvertible, Enum<PointOfInterestType>

Type of a point of interest, which determines how the POI is represented on the map and in AR.

PointSpan

data class PointSpan(val latitudeDelta: Double, val longitudeDelta: Double)

Projection

class Projection

The projection of a coordinate onto the navigation graph.

Segment

open class Segment(val p1: Coordinate, val p2: Coordinate)

A straight segment between two coordinates.

Step

@Serializable

data class Step

A single step of a navigation leg.

Tag

@Serializable

data class Tag(val name: String, val icon: String?, val slug: String, val color: String, val visibility: String?, val category: String? = null)

A tag used to categorize and filter points of interest.

TravelMode

@Serializable(with = TravelModeSerializer::class)

sealed class TravelMode : CompactStringConvertible

The mode of travel used to compute an itinerary: walking, driving, or cycling.

UseTags

@Serializable

data class UseTags(val tags: List<Tag>, val active: Boolean, val clickable: Boolean, val categories: List<Category>, val filteringLogic: String = "DEFAULT")

Configuration describing the tags and categories available to filter points of interest on a map.