ModelLayer

class ModelLayer(layerId: String, sourceId: String) : Layer, ModelLayerDsl

A layer to render 3D Models.

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

ModelLayer
Link copied to clipboard
fun ModelLayer(layerId: String, sourceId: String)

Types

Companion
Link copied to clipboard
object Companion

Static variables and methods.

Functions

bindTo
Link copied to clipboard
fun bindTo(delegate: StyleInterface)

Bind the layer to the Style.

open override fun bindTo(delegate: StyleInterface, position: LayerPosition?)

Bind the layer to the map controller.

filter
Link copied to clipboard
open override fun filter(filter: Expression): ModelLayer

A filter is a property at the layer level that determines which features should be rendered in a style layer.

maxZoom
Link copied to clipboard
open override fun maxZoom(maxZoom: Double): ModelLayer

The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden.

minZoom
Link copied to clipboard
open override fun minZoom(minZoom: Double): ModelLayer

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.

modelId
Link copied to clipboard
open override fun modelId(modelId: Expression): ModelLayer
open override fun modelId(modelId: String): ModelLayer

Model to render.

modelRotation
Link copied to clipboard
open override fun modelRotation(modelRotation: Expression): ModelLayer
open override fun modelRotation(modelRotation: List<Double>): ModelLayer

The rotation of the model in euler angles lon, lat, z.

modelRotationTransition
Link copied to clipboard
open override fun modelRotationTransition(options: StyleTransition): ModelLayer

Set the ModelRotation property transition options

open override fun modelRotationTransition(block: StyleTransition.Builder.() -> Unit): ModelLayer
modelScale
Link copied to clipboard
open override fun modelScale(modelScale: Expression): ModelLayer
open override fun modelScale(modelScale: List<Double>): ModelLayer

The scale of the model.

modelScaleTransition
Link copied to clipboard
open override fun modelScaleTransition(options: StyleTransition): ModelLayer

Set the ModelScale property transition options

open override fun modelScaleTransition(block: StyleTransition.Builder.() -> Unit): ModelLayer
modelType
Link copied to clipboard
open override fun modelType(modelType: Expression): ModelLayer
open override fun modelType(modelType: ModelType): ModelLayer

Defines rendering behavior of model in respect to other 3D scene objects.

sourceLayer
Link copied to clipboard
open override fun sourceLayer(sourceLayer: String): ModelLayer

A source layer is an individual layer of data within a vector source. A vector source can have multiple source layers.

visibility
Link copied to clipboard
open override fun visibility(visibility: Visibility): ModelLayer

Whether this layer is displayed.

Properties

filter
Link copied to clipboard
val filter: Expression?

A filter is a property at the layer level that determines which features should be rendered in a style layer.

layerId
Link copied to clipboard
open override val layerId: String
maxZoom
Link copied to clipboard
open override val maxZoom: Double?

The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden.

minZoom
Link copied to clipboard
open override val minZoom: Double?

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.

modelId
Link copied to clipboard
val modelId: String?

Model to render.

modelIdAsExpression
Link copied to clipboard
val modelIdAsExpression: Expression?

Model to render.

modelRotation
Link copied to clipboard
val modelRotation: List<Double>?

The rotation of the model in euler angles lon, lat, z.

modelRotationAsExpression
Link copied to clipboard
val modelRotationAsExpression: Expression?

The rotation of the model in euler angles lon, lat, z.

modelRotationTransition
Link copied to clipboard
val modelRotationTransition: StyleTransition?

Transition options for ModelRotation.

modelScale
Link copied to clipboard
val modelScale: List<Double>?

The scale of the model.

modelScaleAsExpression
Link copied to clipboard
val modelScaleAsExpression: Expression?

The scale of the model.

modelScaleTransition
Link copied to clipboard
val modelScaleTransition: StyleTransition?

Transition options for ModelScale.

modelType
Link copied to clipboard
val modelType: ModelType?

Defines rendering behavior of model in respect to other 3D scene objects.

modelTypeAsExpression
Link copied to clipboard
val modelTypeAsExpression: Expression?

Defines rendering behavior of model in respect to other 3D scene objects.

sourceId
Link copied to clipboard
val sourceId: String
sourceLayer
Link copied to clipboard
val sourceLayer: String?

A source layer is an individual layer of data within a vector source. A vector source can have multiple source layers.

visibility
Link copied to clipboard
open override val visibility: Visibility?

Whether this layer is displayed.