MapsIndoorsSDK/com.mapsindoors.core/MPDisplayRuleOptions

MPDisplayRuleOptions

open class MPDisplayRuleOptions

A collection of settings that can be applied to a MPDisplayRule

Can be used with MPDisplayRule to create a custom DisplayRule with these options

Alternatively, use applyOptions to update an existing DisplayRule with these options

Constructors

Link copied to clipboard
open fun MPDisplayRuleOptions()
Create a new MPDisplayRuleOptions that can be used to bulk edit fields on a MPDisplayRule

Functions

Link copied to clipboard
open fun setExtrusionColor(@ColorInt color: Int): MPDisplayRuleOptions
Set extrusion color
open fun setExtrusionColor(color: String): MPDisplayRuleOptions
Set extrusion color (hex color code e.g.
Link copied to clipboard
open fun setExtrusionHeight(height: Float): MPDisplayRuleOptions
Set extrusion height in meters
Link copied to clipboard
open fun setExtrusionVisible(visible: Boolean): MPDisplayRuleOptions
Set extrusion visibility
Link copied to clipboard
open fun setExtrusionZoomFrom(zoom: Float): MPDisplayRuleOptions
Set extrusion "zoom from" value, dictating from which zoom level the extrusion should stop being shown
Link copied to clipboard
open fun setExtrusionZoomTo(zoom: Float): MPDisplayRuleOptions
Set extrusion "zoom to" value, dictating from which zoom level the extrusion should stop being shown
Link copied to clipboard
open fun setIcon(bitmap: Bitmap): MPDisplayRuleOptions
Set icon from bitmap
open fun setIcon(drawable: Drawable): MPDisplayRuleOptions
open fun setIcon(drawable: Drawable, @ColorInt tint: Int): MPDisplayRuleOptions
open fun setIcon(drawable: Drawable, tint: String): MPDisplayRuleOptions
Set icon from drawable
open fun setIcon(@DrawableRes resId: Int): MPDisplayRuleOptions
open fun setIcon(@DrawableRes resId: Int, @ColorInt tint: Int): MPDisplayRuleOptions
open fun setIcon(@DrawableRes resId: Int, tint: String): MPDisplayRuleOptions
Set icon from resource ID
open fun setIcon(url: String): MPDisplayRuleOptions
Set icon URL (will be used to download the icon asset)
Link copied to clipboard
open fun setIconSize(width: Int, height: Int): MPDisplayRuleOptions
Set icon size (dp)
Link copied to clipboard
open fun setIconVisible(visible: Boolean): MPDisplayRuleOptions
Set icon visibility
Link copied to clipboard
open fun setLabel(label: String): MPDisplayRuleOptions
Set label text
Link copied to clipboard
open fun setLabelMaxWidth(width: Int): MPDisplayRuleOptions
Set the max width for label text (in dp).
Link copied to clipboard
open fun setLabelVisible(visible: Boolean): MPDisplayRuleOptions
Set label visibility
Link copied to clipboard
open fun setLabelZoomFrom(zoom: Float): MPDisplayRuleOptions
Set the label "zoom from" value, dictating from which zoom level the label should start being shown
Link copied to clipboard
open fun setLabelZoomTo(zoom: Float): MPDisplayRuleOptions
Set the label "zoom to" value, dictating from which zoom level the label should stop being shown
Link copied to clipboard
open fun setModel2DBearing(bearing: Double): MPDisplayRuleOptions
Set 2D model bearing (rotation in degrees)
Link copied to clipboard
open fun setModel2DHeightMeters(height: Double): MPDisplayRuleOptions
Set 2D model height in meters
Link copied to clipboard
open fun setModel2DModel(model: String): MPDisplayRuleOptions
Set 2D model URL
Link copied to clipboard
open fun setModel2DVisible(visible: Boolean): MPDisplayRuleOptions
Set 2D model visibility
Link copied to clipboard
open fun setModel2DWidthMeters(width: Double): MPDisplayRuleOptions
Set 2D model width in meters
Link copied to clipboard
open fun setModel2DZoomFrom(zoom: Float): MPDisplayRuleOptions
Set 2D model "zoom from" value, dictating from which zoom level the model should start being shown
Link copied to clipboard
open fun setModel2DZoomTo(zoom: Float): MPDisplayRuleOptions
Set 2D model "zoom to" value, dictating from which zoom level the model should stop being shown
Link copied to clipboard
open fun setModel3DModel(model: String): MPDisplayRuleOptions
Set 3D model URL
Link copied to clipboard
open fun setModel3DRotationX(x: Float): MPDisplayRuleOptions
Set 3D model rotation around the X-axis in degrees
Link copied to clipboard
open fun setModel3DRotationY(y: Float): MPDisplayRuleOptions
Set 3D model rotation around the Y-axis in degrees
Link copied to clipboard
open fun setModel3DRotationZ(z: Float): MPDisplayRuleOptions
Set 3D model rotation around the Z-axis in degrees
Link copied to clipboard
open fun setModel3DScale(@FloatRange(from = 0.0) scale: Float): MPDisplayRuleOptions
Set 3D model scale as a multiple of its original size (1 is original size, 2 is double that, etc.
Link copied to clipboard
open fun setModel3DVisible(visible: Boolean): MPDisplayRuleOptions
Set 3D model visibility
Link copied to clipboard
open fun setModel3DZoomFrom(zoom: Float): MPDisplayRuleOptions
Set 3D model "zoom from" value, dictating from which zoom level the 3D model should start being shown
Link copied to clipboard
open fun setModel3DZoomTo(zoom: Float): MPDisplayRuleOptions
Set 3D model "zoom to" value, dictating from which zoom level the 3D model should stop being shown
Link copied to clipboard
open fun setPolygonFillColor(@ColorInt color: Int): MPDisplayRuleOptions
Set polygon fill color
open fun setPolygonFillColor(color: String): MPDisplayRuleOptions
Set polygon fill color (hex color code e.g.
Link copied to clipboard
open fun setPolygonFillOpacity(@FloatRange(from = 0.0, to = 1.0) opacity: Float): MPDisplayRuleOptions
Set polygon fill opacity (0.0 = invisible, 1.
Link copied to clipboard
open fun setPolygonStrokeColor(@ColorInt color: Int): MPDisplayRuleOptions
Set polygon stroke color
open fun setPolygonStrokeColor(color: String): MPDisplayRuleOptions
Set polygon stroke color (hex color code e.g.
Link copied to clipboard
open fun setPolygonStrokeOpacity(@FloatRange(from = 0.0, to = 1.0) opacity: Float): MPDisplayRuleOptions
Set polygon stroke opacity (0.0 = invisible, 1.
Link copied to clipboard
open fun setPolygonStrokeWidth(width: Float): MPDisplayRuleOptions
Set polygon stroke width
Link copied to clipboard
open fun setPolygonVisible(visible: Boolean): MPDisplayRuleOptions
Set polygon visibility
Link copied to clipboard
open fun setPolygonZoomFrom(zoom: Float): MPDisplayRuleOptions
Set the polygon "zoom from" value, dictating from which zoom level the polygon should start being shown
Link copied to clipboard
open fun setPolygonZoomTo(zoom: Float): MPDisplayRuleOptions
Get the polygon "zoom to" value, dictating from which zoom level the polygon should stop being shown
Link copied to clipboard
open fun setVisible(visible: Boolean): MPDisplayRuleOptions
Set general visibility value
Link copied to clipboard
open fun setWallColor(@ColorInt color: Int): MPDisplayRuleOptions
Set wall color
open fun setWallColor(color: String): MPDisplayRuleOptions
Set wall color (hex color code e.g.
Link copied to clipboard
open fun setWallHeight(height: Float): MPDisplayRuleOptions
Set wall height in meters
Link copied to clipboard
open fun setWallVisible(visible: Boolean): MPDisplayRuleOptions
Set wall visibility
Link copied to clipboard
open fun setWallZoomFrom(zoom: Float): MPDisplayRuleOptions
Set wall "zoom from" value, dictating from which zoom level the wall should start being shown
Link copied to clipboard
open fun setWallZoomTo(zoom: Float): MPDisplayRuleOptions
Set wall "zoom to" value, dictating from which zoom level the wall should stop being shown
Link copied to clipboard
open fun setZoomFrom(zoom: Float): MPDisplayRuleOptions
Set the "zoom from" value.
Link copied to clipboard
open fun setZoomTo(zoom: Float): MPDisplayRuleOptions
Set the "zoom to" value.