VisioMoveEssential/com.visioglobe.visiomoveessential.models

Package-level declarations

Models are simple abstract data types that allow information to be passed back and forth between VisioMoveEssential and the integrator.

Types

VMEBuildingInfo

@Serializable

data class VMEBuildingInfo(val id: String, val name: String, val shortName: String, val description: String, val floors: List<VMEFloorInfo>, val defaultFloorId: String, val groundFloorId: String, val displayIndex: Int)

VMECameraContext

data class VMECameraContext(val target: VMELatLng, val altitude: Double, val radius: Double, val pitch: Double, val bearing: Double)

An immutable class that aggregates all camera context such as target, altitude, bearing, pitch, and radius.

VMECameraDistanceRange

open class VMECameraDistanceRange

VMECameraDistanceRange represents a distance element that may be associated with a VMECameraUpdate object.

VMECameraHeading

open class VMECameraHeading

VMECameraHeading represents a heading element that may be associated with a VMECameraUpdate object.

VMECameraPitch

open class VMECameraPitch

VMECameraPitch represents a pitch element that may be associated with a VMECameraUpdate object.

VMECameraUpdate

data class VMECameraUpdate(var builder: VMECameraUpdateBuilder)

Represents a camera update that can be applied to the VMEMapView.

VMECameraUpdateBuilder

class VMECameraUpdateBuilder

Used to build a VMECameraUpdate object.

VMECategories

@Serializable

data class VMECategories(val categories: Map<String, VMECategory>)

Represents a map of VMECategory associated with there id

VMECategory

@Serializable

data class VMECategory(val id: String = "", val name: String = "", val icon: String = "")

Represents a category that can be associated with a poi.

VMEDestinationDetail

data class VMEDestinationDetail(val index: Int, val duration: Double, val length: Double)

VMEError

data class VMEError(val domain: String, val code: Int, val userInfo: Map<String, String>) : Parcelable

Encapsulates error information from VisioMove Essential SDK operations. This is the Kotlin equivalent of NSError.

VMEFloorInfo

@Serializable

data class VMEFloorInfo(val id: String, val name: String, val shortName: String, val description: String, val levelIndex: Int, val connectedFloorsId: List<String>)

VMEIcon

data class VMEIcon(@DrawableRes val resId: Int, val useTheme: Boolean = false)

Used to update icons

VMEInstruction

class VMEInstruction(val mText: String, val mIconResource: Int)

VMELatLng

data class VMELatLng(val latitude: Double, val longitude: Double)

An immutable class representing a pair of latitude and longitude coordinates, stored as degrees.

VMELocation

class VMELocation(val position: VMEPosition, val bearing: Double, val accuracy: Double)

VMELocation object incorporates the position within the map as well as values indicating the accuracy of the measurements and the bearing in which the location is moving.

VMEMapDescriptor

class VMEMapDescriptor

The map descriptor object contains information related to it's associated map bundle.

VMEPoi

open class VMEPoi(val id: String, val data: String?)

Represents a physical POI within the map

VMEPoiFilter

class VMEPoiFilter

An object that defines the criteria for performing a poi query.

VMEPoiFilterResult

data class VMEPoiFilterResult(val poiID: String, val duration: Double, val length: Double) : Parcelable

Contains information related to a POI filtered result.

VMEPoiOrientation

open class VMEPoiOrientation

A class cluster for creating a poi orientation object.

VMEPoiSize

class VMEPoiSize

An object that determines the size of the poi within the map

VMEPoiVisibilityRamp

class VMEPoiVisibilityRamp

An object that controls the poi's visibility as a function of the camera's altitude.

VMEPosition

class VMEPosition(val latitude: Double, val longitude: Double, val altitude: Double, val scene: VMESceneContext)

A VMEPosition object represents a position incorporating the geographical coordinates, altitude and associated building and floor.

VMERouteRequest

class VMERouteRequest(var requestType: VMERouteRequestType, var routeDestinationOrder: VMERouteDestinationsOrder, var isAccessible: Boolean = false, var animateAllRoute: Boolean = false, var distanceThreshold: Double = -1.0, var doNotComputeNavigation: Boolean = false)

Represents an instance of route request

VMERouteResult

data class VMERouteResult(var destinations: ArrayList<Any>, var duration: Double, var length: Double, var segments: ArrayList<VMESegment>, val destinationDetails: List<VMEDestinationDetail> = emptyList())

Contains information related to a computed route.

VMESceneContext

class VMESceneContext

A VMESceneContext object represents a physical location within the map. The scene context may be either outside or within a building.

VMESceneUpdate

open class VMESceneUpdate : Serializable

Represents a scene update that can be applied to the VMEMapView.

VMESegment

class VMESegment(val duration: Double, val length: Double, val maneuverType: VMEManeuverType, val floorTransitionType: VMEFloorTransitionType, val floorTransitionId: String, val mPath: MutableList<VMEPosition>, val modality: String)

A segment describes a part of a computed route.

VMEThemeConstant

object VMEThemeConstant

VMEVenueInfo

@Serializable

data class VMEVenueInfo(val mapName: String, val mapShortName: String, val defaultBuildingId: String, val globalLayerName: String, val buildings: List<VMEBuildingInfo>)

This class holds the information about a venue.

Functions

toJsonObject

fun VMEVenueInfo.toJsonObject(): JSONObject

Utility method to convert VMEVenueInfo to a JSONObject prefer the use of kotlinx.serialization. keep only to compatibility