ModelLayer

@UiThread

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

fun ModelLayer(layerId: String, sourceId: String)

Types

Companion

object Companion

Static variables and methods.

Functions

bindTo

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

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

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

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.

modelColor

open override fun modelColor(modelColor: Expression): ModelLayer

open override fun modelColor(@ColorInt modelColor: Int): ModelLayer

open override fun modelColor(modelColor: String): ModelLayer

The tint color of the model layer. model-color-mix-intensity (defaults to 0) defines tint(mix) intensity - this means that, this color is not used unless model-color-mix-intensity gets value greater than 0.

modelColorMixIntensity

open override fun modelColorMixIntensity(modelColorMixIntensity: Expression): ModelLayer

open override fun modelColorMixIntensity(modelColorMixIntensity: Double): ModelLayer

Intensity of model-color (on a scale from 0 to 1) in color mix with original 3D model's colors. Higher number will present a higher model-color contribution in mix.

modelColorMixIntensityTransition

open override fun modelColorMixIntensityTransition(options: StyleTransition): ModelLayer

Set the ModelColorMixIntensity property transition options

open override fun modelColorMixIntensityTransition(block: StyleTransition.Builder.() -> Unit): ModelLayer

DSL for modelColorMixIntensityTransition.

modelColorTransition

open override fun modelColorTransition(options: StyleTransition): ModelLayer

Set the ModelColor property transition options

open override fun modelColorTransition(block: StyleTransition.Builder.() -> Unit): ModelLayer

DSL for modelColorTransition.

modelId

open override fun modelId(modelId: Expression): ModelLayer

open override fun modelId(modelId: String): ModelLayer

Model to render.

modelOpacity

open override fun modelOpacity(modelOpacity: Expression): ModelLayer

open override fun modelOpacity(modelOpacity: Double): ModelLayer

The opacity of the model layer.

modelOpacityTransition

open override fun modelOpacityTransition(options: StyleTransition): ModelLayer

Set the ModelOpacity property transition options

open override fun modelOpacityTransition(block: StyleTransition.Builder.() -> Unit): ModelLayer

DSL for modelOpacityTransition.

modelRotation

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

open override fun modelRotationTransition(options: StyleTransition): ModelLayer

Set the ModelRotation property transition options

open override fun modelRotationTransition(block: StyleTransition.Builder.() -> Unit): ModelLayer

DSL for modelRotationTransition.

modelScale

open override fun modelScale(modelScale: Expression): ModelLayer

open override fun modelScale(modelScale: List<Double>): ModelLayer

The scale of the model.

modelScaleTransition

open override fun modelScaleTransition(options: StyleTransition): ModelLayer

Set the ModelScale property transition options

open override fun modelScaleTransition(block: StyleTransition.Builder.() -> Unit): ModelLayer

DSL for modelScaleTransition.

modelTranslation

open override fun modelTranslation(modelTranslation: Expression): ModelLayer

open override fun modelTranslation(modelTranslation: List<Double>): ModelLayer

The translation of the model in meters in form of longitudal, latitudal, altitude offsets.

modelTranslationTransition

open override fun modelTranslationTransition(options: StyleTransition): ModelLayer

Set the ModelTranslation property transition options

open override fun modelTranslationTransition(block: StyleTransition.Builder.() -> Unit): ModelLayer

DSL for modelTranslationTransition.

modelType

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

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

open override fun visibility(visibility: Visibility): ModelLayer

Whether this layer is displayed.

Properties

filter

val filter: Expression?

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

layerId

open override val layerId: String

maxZoom

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

open override val minZoom: Double?

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

modelColor

val modelColor: String?

modelColorAsColorInt

@get:ColorInt

val modelColorAsColorInt: Int?

modelColorAsExpression

val modelColorAsExpression: Expression?

modelColorMixIntensity

val modelColorMixIntensity: Double?

Intensity of model-color (on a scale from 0 to 1) in color mix with original 3D model's colors. Higher number will present a higher model-color contribution in mix.

modelColorMixIntensityAsExpression

val modelColorMixIntensityAsExpression: Expression?

Intensity of model-color (on a scale from 0 to 1) in color mix with original 3D model's colors. Higher number will present a higher model-color contribution in mix.

modelColorMixIntensityTransition

val modelColorMixIntensityTransition: StyleTransition?

Transition options for ModelColorMixIntensity.

modelColorTransition

val modelColorTransition: StyleTransition?

Transition options for ModelColor.

modelId

val modelId: String?

Model to render.

modelIdAsExpression

val modelIdAsExpression: Expression?

Model to render.