mapbox-maps-android/com.mapbox.maps.plugin/LocationPuck3D

LocationPuck3D

data class LocationPuck3D @JvmOverloads constructor(var modelUri: String, var position: List<Float> = listOf(0f, 0f), var modelOpacity: Float = 1.0f, var modelScale: List<Float> = listOf(1f, 1f, 1f), var modelScaleExpression: String? = null, var modelTranslation: List<Float> = listOf(0f, 0f, 0f), var modelRotation: List<Float> = listOf(0f, 0f, 90f), var modelCastShadows: Boolean = true, var modelReceiveShadows: Boolean = true, var modelScaleMode: ModelScaleMode = ModelScaleMode.VIEWPORT, var modelEmissiveStrength: Float = 1.0f, var modelEmissiveStrengthExpression: String? = null, var modelOpacityExpression: String? = null, var modelRotationExpression: String? = null, var modelColor: Int = Color.parseColor("#ffffff"), var modelColorExpression: String? = null, var modelColorMixIntensity: Float = 0.0f, var modelColorMixIntensityExpression: String? = null, var materialOverrides: List<String> = emptyList(), var nodeOverrides: List<String> = emptyList()) : LocationPuck

Definition of a location_puck_3_d.

Constructors

LocationPuck3D

@JvmOverloads

fun LocationPuck3D(modelUri: String, position: List<Float> = listOf(0f, 0f), modelOpacity: Float = 1.0f, modelScale: List<Float> = listOf(1f, 1f, 1f), modelScaleExpression: String? = null, modelTranslation: List<Float> = listOf(0f, 0f, 0f), modelRotation: List<Float> = listOf(0f, 0f, 90f), modelCastShadows: Boolean = true, modelReceiveShadows: Boolean = true, modelScaleMode: ModelScaleMode = ModelScaleMode.VIEWPORT, modelEmissiveStrength: Float = 1.0f, modelEmissiveStrengthExpression: String? = null, modelOpacityExpression: String? = null, modelRotationExpression: String? = null, modelColor: Int = Color.parseColor("#ffffff"), modelColorExpression: String? = null, modelColorMixIntensity: Float = 0.0f, modelColorMixIntensityExpression: String? = null, materialOverrides: List<String> = emptyList(), nodeOverrides: List<String> = emptyList())

Functions

describeContents

abstract fun describeContents(): Int

writeToParcel

abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

materialOverrides

@MapboxExperimental

var materialOverrides: List<String>

The material overrides for the model. Default value: [].

modelCastShadows

@MapboxExperimental

var modelCastShadows: Boolean = true

Enable/Disable shadow casting for the 3D location puck. Default value: true.

modelColor

var modelColor: Int

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. Expressions that depend on measure-light are not supported when using GeoJSON or vector tile as the model layer source. Default value: "#ffffff".

modelColorExpression

var modelColorExpression: String? = null

The color expression of the model, which will overwrite the default model color.

modelColorMixIntensity

var modelColorMixIntensity: Float = 0.0f

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. Expressions that depend on measure-light are not supported when using GeoJSON or vector tile as the model layer source. Default value: 0. Value range: 0, 1

modelColorMixIntensityExpression

var modelColorMixIntensityExpression: String? = null

The color mix expression of the model, which will overwrite the default model color mix.

modelEmissiveStrength

var modelEmissiveStrength: Float = 1.0f

Strength of the emission. There is no emission for value 0. For value 1.0, only emissive component (no shading) is displayed and values above 1.0 produce light contribution to surrounding area, for some of the parts (e.g. doors). Expressions that depend on measure-light are only supported as a global layer value (and not for each feature) when using GeoJSON or vector tile as the model layer source. Default value: 1. Value range: 0, 5

modelEmissiveStrengthExpression

var modelEmissiveStrengthExpression: String? = null

The emissive strength expression of the model, which will overwrite the default model emissive strength.

modelOpacity

var modelOpacity: Float = 1.0f

The opacity of the model. Default value: 1. Value range: 0, 1

modelOpacityExpression

var modelOpacityExpression: String? = null

The opacity expression of the model, which will overwrite the default model opacity.

modelReceiveShadows

@MapboxExperimental

var modelReceiveShadows: Boolean = true