Skip to content

Commit 8951402

Browse files
lyydikoigithub-actions[bot]
authored andcommitted
[sdk-base] Fix incorrect KDoc default value for modelScaleMode. (#13128)
KDoc said Default value: "map" but the actual default is VIEWPORT. Aligns the comment with the code and the official migration guide. GitOrigin-RevId: e2237ae936bea7290ac44b486ec338b78bdd95f2
1 parent 77dec95 commit 8951402

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

plugin-locationcomponent/src/main/res-public/values/public.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@
7878
<public name="mapbox_locationComponentLocationPuckLocationPuck3DModelCastShadows" type="attr" />
7979
<!-- Enable/Disable shadow receiving for the 3D location puck. Default value: true. -->
8080
<public name="mapbox_locationComponentLocationPuckLocationPuck3DModelReceiveShadows" type="attr" />
81-
<!-- Defines scaling mode. Only applies to location-indicator type layers. Default value: "map". -->
81+
<!-- Defines scaling mode. Only applies to location-indicator type layers. Default value: "viewport". -->
8282
<public name="mapbox_locationComponentLocationPuckLocationPuck3DModelScaleMode" type="attr" />
8383
<!-- 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] -->
8484
<public name="mapbox_locationComponentLocationPuckLocationPuck3DModelEmissiveStrength" type="attr" />

plugin-locationcomponent/src/main/res/values/attrs.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@
7979
<attr name="mapbox_locationComponentLocationPuckLocationPuck3DModelCastShadows" format="boolean"/>
8080
<!-- Enable/Disable shadow receiving for the 3D location puck. Default value: true. -->
8181
<attr name="mapbox_locationComponentLocationPuckLocationPuck3DModelReceiveShadows" format="boolean"/>
82-
<!-- Defines scaling mode. Only applies to location-indicator type layers. Default value: "map". -->
82+
<!-- Defines scaling mode. Only applies to location-indicator type layers. Default value: "viewport". -->
8383
<attr name="mapbox_locationComponentLocationPuckLocationPuck3DModelScaleMode" format="enum">
8484
<!-- Model is scaled so that it's always the same size relative to other map features. The property model-scale specifies how many meters each unit in the model file should cover. -->
8585
<enum name="map" value="0"/>

sdk-base/src/main/java/com/mapbox/maps/plugin/ConfigProperties.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ data class LocationPuck3D @JvmOverloads constructor(
121121
@MapboxExperimental
122122
var modelReceiveShadows: Boolean = true,
123123
/**
124-
* Defines scaling mode. Only applies to location-indicator type layers. Default value: "map".
124+
* Defines scaling mode. Only applies to location-indicator type layers. Default value: "viewport".
125125
*/
126126
@MapboxExperimental
127127
var modelScaleMode: ModelScaleMode = ModelScaleMode.VIEWPORT,

0 commit comments

Comments
 (0)