Use half-resolution mode for performance-critical applications. This will cause the AO to be calculated at half the resolution of the screen, and then upscaled to the full resolution. This is a great way to get a performance boost (generally 2x-4x) at the cost of some quality (the AO will lack fine details and temporal stability will be slightly reduced).

AMBIENT_OCCLUSION_RESOLUTION_SERIALIZER

@ExperimentalSerializationApi

@Serializer(forClass = MPIOptions.AMBIENT_OCCLUSION_RESOLUTION::class)

object AMBIENT_OCCLUSION_RESOLUTION_SERIALIZER

serializer for ambient occlusion resolution

AmbientOcclusionConfiguration

@Serializable

data class AmbientOcclusionConfiguration(val aoEnabled: Boolean? = null, val aoQuality: MPIOptions.AMBIENT_OCCLUSION_QUALITY? = null, val aoRadius: Double? = null, val aoResolution: MPIOptions.AMBIENT_OCCLUSION_RESOLUTION? = null, val aoSamples: Double? = null, val autoRenderBeauty: Boolean? = null, val color: String? = null, val denoiseIterations: Double? = null, val denoiseRadius: Double? = null, val denoiseSamples: Double? = null, val depthAwareUpsampling: Boolean? = null, val gammaCorrection: Boolean? = null, val intensity: Double? = null, val logarithmicDepthBuffer: Boolean? = null, val renderMode: Double? = null, val screenSpaceRadius: Boolean? = null)

Configuration for an ambient occlusion.

ANTI_ALIAS_QUALITY

@Serializable(with = MPIOptions.ANTI_ALIAS_QUALITY_SERIALIZER::class)

enum ANTI_ALIAS_QUALITY : Enum<MPIOptions.ANTI_ALIAS_QUALITY>

Anti alias quality level. Greater quality means less artifacts(less aliasing), but higher performance requirements.

ANTI_ALIAS_QUALITY_SERIALIZER

@ExperimentalSerializationApi

@Serializer(forClass = MPIOptions.ANTI_ALIAS_QUALITY::class)

object ANTI_ALIAS_QUALITY_SERIALIZER

serializer for anti alias quality

AntialiasConfiguration

@Serializable

data class AntialiasConfiguration(val antialias: Boolean? = null, val antialiasQuality: MPIOptions.ANTI_ALIAS_QUALITY? = null)

Configuration for an anti aliasing.

BlueDot

@Serializable

data class BlueDot(val allowImplicitFloorLevel: Boolean? = false, val smoothing: Boolean? = true, val showBearing: Boolean? = false, val baseColor: String? = "#2266ff", val useRotationMode: Boolean? = false)

BlueDot holds the properties of values to be set when enabling blue dot

CAMERA_DIRECTION

@Serializable(with = MPIOptions.CAMERA_DIRECTION_SERIALIZER::class)

enum CAMERA_DIRECTION : Enum<MPIOptions.CAMERA_DIRECTION>

CAMERA_DIRECTION_SERIALIZER

@ExperimentalSerializationApi

@Serializer(forClass = MPIOptions.CAMERA_DIRECTION::class)

object CAMERA_DIRECTION_SERIALIZER

serializer for camera direction

CameraAnimation

@Serializable

data class CameraAnimation(val duration: Double? = null, val easing: MPIOptions.EASING_MODE? = null)

Configuration for an animation.

CameraInteractionsSetOptions

@Serializable

data class CameraInteractionsSetOptions(val pan: Boolean? = null, val rotationAndTilt: Boolean? = null, val zoom: Boolean? = null)

CameraPadding

@Serializable

data class CameraPadding(val top: Double, val bottom: Double, val left: Double, val right: Double)

Focus padding for focus

CameraTargets

@Serializable

data class CameraTargets(val nodes: List<MPINavigatable.MPINode>? = null, val polygons: List<MPINavigatable.MPIPolygon>? = null, val coordinates: List<MPIMap.MPICoordinate>? = null)

Things that the camera can be positioned to focus on.

CameraTransformCoordinate

@Serializable

data class CameraTransformCoordinate(val zoom: Double? = null, val tilt: Double? = null, val rotation: Double? = null, val position: MPIMap.MPICoordinate? = null)

A configuration of the camera in space.

CameraTransformNode

@Serializable

data class CameraTransformNode(val zoom: Double? = null, val tilt: Double? = null, val rotation: Double? = null, val position: MPINavigatable.MPINode? = null)

A configuration of the camera in space.

COLLISION_RANK

@Serializable(with = MPIOptions.COLLISION_RANK_SERIALIZER::class)

enum COLLISION_RANK : Enum<MPIOptions.COLLISION_RANK>

COLLISION_RANK Defines the priority levels for displaying colliders. The COLLISION_RANK determines which colliders are displayed when there are multiple colliders in the same space. A higher rank ensures higher visibility, and colliders with higher ranks will be displayed over lower-priority ones.

COLLISION_RANK_SERIALIZER

@ExperimentalSerializationApi

@Serializer(forClass = MPIOptions.COLLISION_RANK::class)

object COLLISION_RANK_SERIALIZER

serializer for COLLISION_RANK

Companion

object Companion

ConnectionPath

@Serializable

data class ConnectionPath @JvmOverloads constructor(val drawDuration: Double? = null, val nearRadius: Double? = null, val farRadius: Double? = null, val color: String? = null)

Connection path object - No longer used.

EASING_MODE

@Serializable(with = MPIOptions.EASING_MODE_SERIALIZER::class)

enum EASING_MODE : Enum<MPIOptions.EASING_MODE>

EASING_MODE_SERIALIZER

@ExperimentalSerializationApi

@Serializer(forClass = MPIOptions.EASING_MODE::class)

object EASING_MODE_SERIALIZER

serializer for easing mode

FlatLabel

@Serializable

data class FlatLabel(val text: String? = null, val appearance: MPIOptions.FlatLabelAppearance? = null) : MPIOptions.AbstractFlatLabel

FlatLabel holds the properties of flat labels to be set when setting flat label to polygons

FlatLabelAllLocations

@Serializable

data class FlatLabelAllLocations(val appearance: MPIOptions.FlatLabelAppearance? = null, val locations: List<String>? = null) : MPIOptions.AbstractFlatLabelAllLocations

FlatLabelAllLocations holds the properties of flat labels to be set when setting flat labels to a collection of polygons

FlatLabelAllLocationsInternal

@Serializable

data class FlatLabelAllLocationsInternal(var legacyLabels: Boolean, val appearance: MPIOptions.FlatLabelAppearance? = null, val locations: List<String>? = null) : MPIOptions.AbstractFlatLabelAllLocations

FlatLabelAllLocationsInternal exposes the flat labels flag to be true internally while setting flat labels to a collection of polygons

FlatLabelAppearance

@Serializable

data class FlatLabelAppearance @JvmOverloads constructor(val height: Float? = null, val margin: Float? = 5.0f, val color: String? = null, val fontSize: Float? = 12.0f, val scaleMin: Float? = 0.25f, var scaleStep: Float? = 0.25f)

FlatLabelAppearance holds the appearance properties of flat labels to be set when labeling polygons

FlatLabelInternal

@Serializable

data class FlatLabelInternal(var flatLabels: Boolean, val text: String? = null, val appearance: MPIOptions.FlatLabelAppearance? = null) : MPIOptions.AbstractFlatLabel

FlatLabelInternal exposes the flat labels flag to be true internally while setting flat labels to polygons

FloatingLabel

@Serializable

data class FloatingLabel @JvmOverloads constructor(val text: String, val shortText: String? = null, val stateText: String? = null, val rank: MPIOptions.COLLISION_RANK? = null, val appearance: MPIOptions.FloatingLabelAppearance? = null)

FloatingLabel holds the properties of floating labels to be set when setting labels to polygons

FloatingLabelAllLocations

@Serializable

data class FloatingLabelAllLocations @JvmOverloads constructor(val appearance: MPIOptions.FloatingLabelAppearance? = null, val locations: List<String>? = null, val interactive: Boolean? = false)

FloatingLabelAllLocations holds the properties of floating labels to be set at a collection of locations

FloatingLabelAppearance

@Serializable

data class FloatingLabelAppearance @JvmOverloads constructor(val margin: Double? = 6.0, val text: MPIOptions.FloatingLabelAppearance.Text? = null, val marker: MPIOptions.FloatingLabelAppearance.Marker? = null)

FloatingLabelAppearance holds the appearance properties of floating labels to be set when labeling polygons

FocusOn

@Serializable

data class FocusOn(val changeZoom: Boolean? = null, val minZoom: Double? = null, val rotation: Double? = null, val tilt: Double? = null, val padding: MPIOptions.CameraPadding? = null, val duration: Double? = null, val easing: MPIOptions.EASING_MODE? = null)

Options that change the behaviour of MPICamera.focusOn

GetPolygonsAtCoordinate

@Serializable

data class GetPolygonsAtCoordinate(val includeNonInteractive: Boolean? = false)

Init

@Serializable

data class Init @JvmOverloads constructor(val clientId: String = "", val clientSecret: String = "", val venue: String = "", val perspective: String? = "Website", val baseUrl: String = "", val noAuth: Boolean = false, val firstMapId: String? = null, val headers: List<MPIHeader>? = null, val useBundle: Boolean? = false, val emitAnalyticsEvents: Boolean? = true, val useDraftData: Boolean? = false, val language: String? = null, val things: Map<MPIOptions.THING_KEY, List<String>> = emptyMap())

This class hold the properties of values to be used when initialzing a map

Journey

@Serializable

data class Journey @JvmOverloads constructor(val connectionPathOptions: MPIOptions.Path? = null, val connectionTemplateString: String? = null, val destinationMarkerTemplateString: String? = null, val departureMarkerTemplateString: String? = null, val pathOptions: MPIOptions.Path? = null, val polygonHighlightColor: String? = "#ff834c", val inactivePathOptions: MPIOptions.Path? = null)

Journey holds the properties of journey when drawing jouney

Marker

@Serializable

data class Marker(val rank: MPIOptions.COLLISION_RANK? = null, val anchor: MPIOptions.MARKER_ANCHOR? = null, val interactive: Boolean? = false)

Marker holds the properties of values when adding markers containing arbitrary HTML

MARKER_ANCHOR

@Serializable(with = MPIOptions.MARKER_ANCHOR_SERIALIZER::class)

enum MARKER_ANCHOR : Enum<MPIOptions.MARKER_ANCHOR>

MARKER_ANCHOR holds the properties of anchor when adding markers

MARKER_ANCHOR_SERIALIZER

@ExperimentalSerializationApi

@Serializer(forClass = MPIOptions.MARKER_ANCHOR::class)

object MARKER_ANCHOR_SERIALIZER

serializer for marker anchor

MarkerAnimationOptions

@Serializable

data class MarkerAnimationOptions(val duration: Double? = null, val easing: MPIOptions.EASING_MODE? = null)

OUTDOOR_ATTRIBUTION_POSITION

@Serializable(with = MPIOptions.OUTDOOR_ATTRIBUTION_POSITION_SERIALIZER::class)

enum OUTDOOR_ATTRIBUTION_POSITION : Enum<MPIOptions.OUTDOOR_ATTRIBUTION_POSITION>

OUTDOOR_ATTRIBUTION_POSITION_SERIALIZER

@ExperimentalSerializationApi

@Serializer(forClass = MPIOptions.OUTDOOR_ATTRIBUTION_POSITION::class)

object OUTDOOR_ATTRIBUTION_POSITION_SERIALIZER

serializer for outdoor attribution position

OutdoorView

@Serializable

data class OutdoorView(val enabled: Boolean? = false, val attributionPosition: MPIOptions.OUTDOOR_ATTRIBUTION_POSITION? = null, val authURL: String? = null, val customAttribution: String? = null, val headers: Map<String, String>? = null, var layersHiddenByGeometry: List<String>? = null, val lowDpi: Boolean? = false, val url: String? = null)

Configuration for Outdoor view. Outdoor view Requires MPIOptions.ShowVenue.multibufferRendering to be enabled.

Path

@Serializable

data class Path @JvmOverloads constructor(val color: String? = "#4b90e2", var pulseColor: String? = "#ffffff", var nearRadius: Double? = 1.8, var farRadius: Double? = null, var drawDuration: Double? = 1500.0, var drawConnectionSegments: Boolean? = null, var pulseIterations: Double? = null, var connectionPathOptions: MPIOptions.ConnectionPath? = null, var displayArrowsOnPath: Boolean? = true, var interactive: Boolean? = false, var animateDrawing: Boolean? = true, var farZoom: Double = 10000.0, var flattenPath: Boolean = false, var nearZoom: Double = 375.0, var pulsePauseDuration: Double = 750.0, var showPulse: Boolean = true)

Path holds the properties of values to be set when path is drawn

ShowVenue

@Serializable

data class ShowVenue(val firstMapId: String? = null, val labelAllLocationsOnInit: Boolean = true, val backgroundColor: String? = null, val backgroundAlpha: Double? = null, val multiBufferRendering: Boolean? = false, val xRayPath: Boolean? = true, val antialiasConfig: MPIOptions.AntialiasConfiguration? = null, val ambientOcclusionConfig: MPIOptions.AmbientOcclusionConfiguration? = null, val outdoorView: MPIOptions.OutdoorView? = null, val shadingAndOutlines: Boolean? = false)

ShowVenue holds the properties of values to be set when showing a venue.

THING_KEY

@Serializable(with = MPIOptions.THING_KEY_SERIALIZER::class)

enum THING_KEY : Enum<MPIOptions.THING_KEY>

The thing keys used in MPIOptions.Init.things

THING_KEY_SERIALIZER

@ExperimentalSerializationApi

@Serializer(forClass = MPIOptions.THING_KEY::class)

object THING_KEY_SERIALIZER

serializer for thing key.

Tooltip

@Serializable

data class Tooltip(val collisionRank: MPIOptions.COLLISION_RANK? = null, val interactive: Boolean? = false, val padding: Double? = null, val enabledAnchorTypes: MPIOptions.TooltipAnchor? = null, val defaultAnchorType: String? = null)

Tooltip holds the properties of values when adding tooltips containing arbitrary HTML

TooltipAnchor

@Serializable

data class TooltipAnchor(val top: Boolean? = null, val left: Boolean? = null, val topLeft: Boolean? = null, val right: Boolean? = null, val topRight: Boolean? = null, val bottom: Boolean? = null, val bottomLeft: Boolean? = null, val bottomRight: Boolean? = null)

TooltipAnchor An object used to disable certain anchor positions from being used.

Functions

toString

open override fun toString(): String

convert Marker to string