VisioMoveEssential/com.visioglobe.visiomoveessential.models

Package com.visioglobe.visiomoveessential.models

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(id: String, name: String, shortName: String, description: String, floors: List<VMEFloorInfo>, defaultFloorId: String, groundFloorId: String, displayIndex: Int)

VMECameraContext

data class VMECameraContext(target: VMELatLng, altitude: Double, radius: Double, pitch: Double, 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(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(categories: Map<String, VMECategory>)

Represents a map of VMECategory associated with there id

VMECategory

@Serializable

data class VMECategory(id: String, name: String, icon: String)

Represents a category that can be associated with a poi.

VMEFloorInfo

@Serializable

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

VMEIcon

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

Used to update icons

VMEInstruction

class VMEInstruction(mText: String, mIconResource: Int)

VMELatLng

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

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

VMELocation

class VMELocation(position: VMEPosition, bearing: Double, 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(id: String, data: String?)

Represents a physical POI within the map

VMEPoiFilter

class VMEPoiFilter

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

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(latitude: Double, longitude: Double, altitude: Double, scene: VMESceneContext)

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

VMERouteRequest

class VMERouteRequest(requestType: VMERouteRequestType, routeDestinationOrder: VMERouteDestinationsOrder, isAccessible: Boolean, animateAllRoute: Boolean, distanceThreshold: Double)

Represents an instance of route request

VMERouteResult

data class VMERouteResult(destinations: <ERROR CLASS><Any>, duration: Double, length: Double, segments: <ERROR CLASS><VMESegment>)

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(duration: Double, length: Double, maneuverType: VMEManeuverType, floorTransitionType: VMEFloorTransitionType, floorTransitionId: String, mPath: MutableList<VMEPosition>)

A segment describes a part of a computed route.

VMEThemeConstant

object VMEThemeConstant

VMEVenueInfo

@Serializable

data class VMEVenueInfo(mapName: String, mapShortName: String, defaultBuildingId: String, globalLayerName: String, 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