MapsIndoorsSDK/com.mapsindoors.core/MPDisplayRule

MPDisplayRule

open class MPDisplayRule : IDisplayRule

This class represents a Display Rule, a MapsIndoors concept which describes a number of styling values for MapsIndoors objects. The values contained within dictates how the MapsIndoors SDK renders a given object on the map (POI, area, selection, model, etc.). Display Rule data can be edited through the MapsIndoors CMS, and can be modified on runtime in SDKs. Invoke reset on a MPDisplayRule to reset all values to those from the CMS.

Constructors

open fun MPDisplayRule(@NonNull id: String, @NonNull parent: WeakReference<MPDisplayRule>, @NonNull options: MPDisplayRuleOptions)

Create an empty MPDisplayRule.

open fun MPDisplayRule(@NonNull id: String, @NonNull options: MPDisplayRuleOptions)

Create an empty MPDisplayRule.

open fun MPDisplayRule(@NonNull id: String, @NonNull parent: WeakReference<MPDisplayRule>)

Create an empty MPDisplayRule.

open fun MPDisplayRule(@NonNull id: String)

Create an empty MPDisplayRule.

Functions

open fun applyOptions(options: MPDisplayRuleOptions)

Bulk update this Rule with the fields set in the MPDisplayRuleOptions

getExtrusionColor

open fun getExtrusionColor(): String

Get extrusion color (hex color code e.g.

getExtrusionHeight

open fun getExtrusionHeight(): Float

Get extrusion height in meters

getExtrusionZoomFrom

open fun getExtrusionZoomFrom(): Float

Get extrusion "zoom from" value, dictating from which zoom level the extrusion should stop being shown

getExtrusionZoomTo

open fun getExtrusionZoomTo(): Float

Get extrusion "zoom to" value, dictating from which zoom level the extrusion should stop being shown

open fun getIconAsync(@NonNull listener: OnResultAndDataReadyListener<Bitmap>)

Get the display rule's icon asynchronously

open fun getIconSize(): MPIconSize

Get icon size

open fun getIconUrl(): String

Get the icon URL

open fun getId(): String

The ID of this rule, it can take the following forms

Default rule: "default"
CMS main rule: "main"
CMS type rule: The name of the type
CMS location rule: The location Id of the location
Custom rule: No clear form

open fun getLabel(): String

Get label text

getLabelMaxWidth

open fun getLabelMaxWidth(): Integer

Get the max width for label text (in dp).

getLabelZoomFrom

open fun getLabelZoomFrom(): Float

Get the label "zoom from" value, dictating from which zoom level the label should start being shown

open fun getLabelZoomTo(): Float

Get the label "zoom to" value, dictating from which zoom level the label should stop being shown

getModel2DBearing

open fun getModel2DBearing(): Double

Get 2D model bearing (rotation in degrees)

getModel2DHeightMeters

open fun getModel2DHeightMeters(): Double

Get 2D model height in meters

getModel2DModel

open fun getModel2DModel(): String

Get 2D model URL

getModel2DWidthMeters

open fun getModel2DWidthMeters(): Double

Get 2D model width in meters

getModel2DZoomFrom

open fun getModel2DZoomFrom(): Float

Get 2D model "zoom from" value, dictating from which zoom level the model should start being shown

getModel2DZoomTo

open fun getModel2DZoomTo(): Float

Get 2D model "zoom to" value, dictating from which zoom level the model should stop being shown

getModel3DModel

open fun getModel3DModel(): String

Get 3D model URL

getModel3DRotationX

open fun getModel3DRotationX(): Float

Get 3D model rotation around the X-axis in degrees

getModel3DRotationY

open fun getModel3DRotationY(): Float

Get 3D model rotation around the Y-axis in degrees

getModel3DRotationZ

open fun getModel3DRotationZ(): Float

Get 3D model rotation around the Z-axis in degrees

getModel3DScale

open fun getModel3DScale(): Float

Get 3D model scale

getModel3DZoomFrom

open fun getModel3DZoomFrom(): Float

Get 3D model "zoom from" value, dictating from which zoom level the 3D model should start being shown

getModel3DZoomTo

open fun getModel3DZoomTo(): Float

Get 3D model "zoom to" value, dictating from which zoom level the 3D model should stop being shown

getPolygonFillColor

open fun getPolygonFillColor(): String

Get polygon fill color (hex color code e.g.

getPolygonFillOpacity

open fun getPolygonFillOpacity(): Float

Get polygon fill opacity (0.0 = invisible, 1.

getPolygonStrokeColor

open fun getPolygonStrokeColor(): String

Get polygon stroke color (hex color code e.g.

getPolygonStrokeOpacity

open fun getPolygonStrokeOpacity(): Float

Get polygon stroke opacity (0.0 = invisible, 1.

getPolygonStrokeWidth

open fun getPolygonStrokeWidth(): Float

Get polygon stroke width

getPolygonZoomFrom

open fun getPolygonZoomFrom(): Float

Get the polygon "zoom from" value, dictating from which zoom level the polygon should start being shown

getPolygonZoomTo

open fun getPolygonZoomTo(): Float

Get the polygon "zoom to" value, dictating from which zoom level the polygon should stop being shown

open fun getWallColor(): String

Get wall color (hex color code e.g.

open fun getWallHeight(): Float

Get wall height in meters

getWallZoomFrom

open fun getWallZoomFrom(): Float

Get wall "zoom from" value, dictating from which zoom level the wall should start being shown

open fun getWallZoomTo(): Float

Get wall "zoom to" value, dictating from which zoom level the wall should stop being shown

open fun getZoomFrom(): Float

Get the "zoom from" value.

open fun getZoomTo(): Float

Get the "zoom to" value.

isExtrusionVisible

open fun isExtrusionVisible(): Boolean

Set extrusion visibility

open fun isIconVisible(): Boolean

Get icon visibility

open fun isLabelVisible(): Boolean

Get label visibility

isModel2DVisible

open fun isModel2DVisible(): Boolean

Get 2D model visibility

isModel3DVisible

open fun isModel3DVisible(): Boolean

Get 3D model visibility

isPolygonVisible

open fun isPolygonVisible(): Boolean

Get polygon visibility

open fun isValid(): Boolean

Validate the current state of MPDisplayRule values

open fun isVisible(): Boolean

Get general visibility value

open fun isWallVisible(): Boolean

Get wall visiblity

open fun reset()

Resets the display rule to the original state.

setExtrusionColor

open fun setExtrusionColor(@ColorInt color: Int)

Set extrusion color

open fun setExtrusionColor(color: String)

Set extrusion color (hex color code e.g.

setExtrusionHeight

open fun setExtrusionHeight(height: Float)

Set extrusion height in meters

setExtrusionVisible

open fun setExtrusionVisible(visible: Boolean)

Set extrusion visibility

setExtrusionZoomFrom

open fun setExtrusionZoomFrom(zoomFrom: Float)

Set extrusion "zoom from" value, dictating from which zoom level the extrusion should stop being shown

setExtrusionZoomTo

open fun setExtrusionZoomTo(zoomTo: Float)

Set extrusion "zoom to" value, dictating from which zoom level the extrusion should stop being shown

open fun setIcon(@NonNull bitmap: Bitmap)

Set icon from bitmap

open fun setIcon(@NonNull drawable: Drawable)

open fun setIcon(@NonNull drawable: Drawable, @ColorInt tint: Int)

open fun setIcon(@NonNull drawable: Drawable, tint: String)

Set icon from drawable

open fun setIcon(@DrawableRes resId: Int)

open fun setIcon(@DrawableRes resId: Int, @ColorInt tint: Int)

open fun setIcon(@DrawableRes resId: Int, tint: String)

Set icon from resource ID

open fun setIcon(@NonNull iconUrl: String)

Set icon URL (will be used to download the icon asset)

open fun setIconSize(width: Int, height: Int)

Set icon size (dp)

open fun setIconVisible(visible: Boolean)

Set icon visibility

open fun setLabel(label: String)

Set label text

setLabelMaxWidth

open fun setLabelMaxWidth(labelMaxWidth: Integer)

Set the max width for label text (in dp).

setLabelVisible

open fun setLabelVisible(visible: Boolean)

Set label visibility

setLabelZoomFrom

open fun setLabelZoomFrom(labelZoomFrom: Float)

Set the label "zoom from" value, dictating from which zoom level the label should start being shown

open fun setLabelZoomTo(labelZoomTo: Float)

Set the label "zoom to" value, dictating from which zoom level the label should stop being shown

setModel2DBearing

open fun setModel2DBearing(bearing: Double)

Set 2D model bearing (rotation in degrees)

setModel2DHeightMeters

open fun setModel2DHeightMeters(heightMeters: Double)

Set 2D model height in meters

setModel2DModel

open fun setModel2DModel(model: String)

Set 2D model URL

setModel2DVisible

open fun setModel2DVisible(visible: Boolean)

Set 2D model visibility

setModel2DWidthMeters

open fun setModel2DWidthMeters(widthMeters: Double)

Set 2D model width in meters

setModel2DZoomFrom

open fun setModel2DZoomFrom(zoomFrom: Float)

Set 2D model "zoom from" value, dictating from which zoom level the model should start being shown

setModel2DZoomTo

open fun setModel2DZoomTo(zoomTo: Float)

Set 2D model "zoom to" value, dictating from which zoom level the model should stop being shown

setModel3DModel

open fun setModel3DModel(model: String)

Set 3D model URL

setModel3DRotationX

open fun setModel3DRotationX(rotationX: Float)

Set 3D model rotation around the X-axis in degrees

setModel3DRotationY

open fun setModel3DRotationY(rotationY: Float)

Set 3D model rotation around the Y-axis in degrees

setModel3DRotationZ

open fun setModel3DRotationZ(rotationZ: Float)

Set 3D model rotation around the Z-axis in degrees

setModel3DScale

open fun setModel3DScale(scale: Float)

Set 3D model scale as a multiple of its original size (1 is original size, 2 is double that, etc.

setModel3DVisible

open fun setModel3DVisible(visible: Boolean)

Set 3D model visibility

setModel3DZoomFrom

open fun setModel3DZoomFrom(zoomFrom: Float)

Set 3D model "zoom from" value, dictating from which zoom level the 3D model should start being shown

setModel3DZoomTo

open fun setModel3DZoomTo(zoomTo: Float)

Set 3D model "zoom to" value, dictating from which zoom level the 3D model should stop being shown

setPolygonFillColor

open fun setPolygonFillColor(@ColorInt color: Int)

Set polygon fill color

open fun setPolygonFillColor(color: String)

Set polygon fill color (hex color code e.g.

setPolygonFillOpacity

open fun setPolygonFillOpacity(opacity: Float)

Set polygon fill opacity (0.0 = invisible, 1.

setPolygonStrokeColor

open fun setPolygonStrokeColor(@ColorInt color: Int)

Set polygon stroke color

open fun setPolygonStrokeColor(color: String)

Set polygon stroke color (hex color code e.g.

setPolygonStrokeOpacity

open fun setPolygonStrokeOpacity(opacity: Float)

Set polygon stroke opacity (0.0 = invisible, 1.

setPolygonStrokeWidth

open fun setPolygonStrokeWidth(strokeWidth: Float)

Set polygon stroke width

setPolygonVisible

open fun setPolygonVisible(visible: Boolean)

Set polygon visibility

setPolygonZoomFrom

open fun setPolygonZoomFrom(zoomFrom: Float)

Set the polygon "zoom from" value, dictating from which zoom level the polygon should start being shown

setPolygonZoomTo

open fun setPolygonZoomTo(zoomTo: Float)

Set the polygon "zoom to" value, dictating from which zoom level the polygon should stop being shown

open fun setVisible(visible: Boolean)

Set general visibility value

open fun setWallColor(@ColorInt color: Int)

Set wall color

open fun setWallColor(color: String)

Set wall color (hex color code e.g.

open fun setWallHeight(height: Float)

Set wall height in meters

open fun setWallVisible(visible: Boolean)

Set wall visibility

setWallZoomFrom

open fun setWallZoomFrom(zoomFrom: Float)

Set wall "zoom from" value, dictating from which zoom level the wall should start being shown

open fun setWallZoomTo(zoomTo: Float)

Set wall "zoom to" value, dictating from which zoom level the wall should stop being shown

open fun setZoomFrom(zoomFrom: Float)

Set the "zoom from" value.

open fun setZoomTo(zoomTo: Float)

Set the "zoom to" value.