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) : LocationPuck

Definition of a location_puck_3_d.

Constructors

Link copied to clipboard
@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)

Functions

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

Link copied to clipboard
@MapboxExperimental
var modelCastShadows: Boolean = true

Enable/Disable shadow casting for the 3D location puck.

Link copied to clipboard
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).

Link copied to clipboard
var modelEmissiveStrengthExpression: String? = null

Strength of the emission as Expression string, note that when modelEmissiveStrengthExpression is specified, it will overwrite the modelEmissiveStrength property. 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).

Link copied to clipboard
var modelOpacity: Float = 1.0f

The opacity of the model.

Link copied to clipboard
@MapboxExperimental
var modelReceiveShadows: Boolean = true

Enable/Disable shadow receiving for the 3D location puck.

Link copied to clipboard
var modelRotation: List<Float>

The rotation of the model.

Link copied to clipboard
var modelScale: List<Float>

The scale of the model.

Link copied to clipboard
var modelScaleExpression: String? = null

The scale expression of the model, which will overwrite the default scale expression that keeps the model size constant during zoom.

Link copied to clipboard
@MapboxExperimental
var modelScaleMode: ModelScaleMode

Defines scaling mode. Only applies to location-indicator type layers.

Link copied to clipboard
var modelTranslation: List<Float>

The translation of the model lon, lat, z

Link copied to clipboard
var modelUri: String

An URL for the model file in gltf format.

Link copied to clipboard
var position: List<Float>

The position of the model.