ModelLayerDsl

interface ModelLayerDsl

This Interface contains all the functions that will be exposed to Koltin DSL.

Separated the DSL receiver class to this interface to avoid IDE code suggestion for property getters.

Functions

filter
Link copied to clipboard
abstract 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
abstract 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
abstract 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
Link copied to clipboard
abstract fun modelColor(modelColor: Expression): ModelLayer
abstract fun modelColor(@ColorInt modelColor: Int): ModelLayer
abstract fun modelColor(modelColor: String = "#ffffff"): 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
Link copied to clipboard
abstract fun modelColorMixIntensity(modelColorMixIntensity: Expression): ModelLayer
abstract fun modelColorMixIntensity(modelColorMixIntensity: Double = 0.0): 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
Link copied to clipboard
abstract fun modelColorMixIntensityTransition(options: StyleTransition): ModelLayer
abstract fun modelColorMixIntensityTransition(block: StyleTransition.Builder.() -> Unit): 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.

modelColorTransition
Link copied to clipboard
abstract fun modelColorTransition(options: StyleTransition): ModelLayer
abstract fun modelColorTransition(block: StyleTransition.Builder.() -> Unit): 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.

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

Model to render.

modelOpacity
Link copied to clipboard
abstract fun modelOpacity(modelOpacity: Expression): ModelLayer
abstract fun modelOpacity(modelOpacity: Double = 1.0): ModelLayer

The opacity of the model layer.

modelOpacityTransition
Link copied to clipboard
abstract fun modelOpacityTransition(options: StyleTransition): ModelLayer
abstract fun modelOpacityTransition(block: StyleTransition.Builder.() -> Unit): ModelLayer

The opacity of the model layer.

modelRotation
Link copied to clipboard
abstract fun modelRotation(modelRotation: Expression): ModelLayer
abstract fun modelRotation(modelRotation: List<Double> = listOf(0.0, 0.0, 0.0)): ModelLayer

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

modelRotationTransition
Link copied to clipboard
abstract fun modelRotationTransition(options: StyleTransition): ModelLayer
abstract fun modelRotationTransition(block: StyleTransition.Builder.() -> Unit): ModelLayer

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

modelScale
Link copied to clipboard
abstract fun modelScale(modelScale: Expression): ModelLayer
abstract fun modelScale(modelScale: List<Double> = listOf(1.0, 1.0, 1.0)): ModelLayer

The scale of the model.

modelScaleTransition
Link copied to clipboard
abstract fun modelScaleTransition(options: StyleTransition): ModelLayer
abstract fun modelScaleTransition(block: StyleTransition.Builder.() -> Unit): ModelLayer

The scale of the model.

modelTranslation
Link copied to clipboard
abstract fun modelTranslation(modelTranslation: Expression): ModelLayer
abstract fun modelTranslation(modelTranslation: List<Double> = listOf(0.0, 0.0, 0.0)): ModelLayer

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

modelTranslationTransition
Link copied to clipboard
abstract fun modelTranslationTransition(options: StyleTransition): ModelLayer
abstract fun modelTranslationTransition(block: StyleTransition.Builder.() -> Unit): ModelLayer

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

modelType
Link copied to clipboard
abstract fun modelType(modelType: Expression): ModelLayer
abstract fun modelType(modelType: ModelType = ModelType.COMMON_3D): ModelLayer

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

sourceLayer
Link copied to clipboard
abstract 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
abstract fun visibility(visibility: Visibility): ModelLayer

Whether this layer is displayed.

Inheritors

ModelLayer
Link copied to clipboard