diff --git a/api/android-sdk-core.api b/api/android-sdk-core.api index 3ce5b82..851d2f0 100644 --- a/api/android-sdk-core.api +++ b/api/android-sdk-core.api @@ -1117,15 +1117,22 @@ public final class com.mapconductor.core.map.MapOverlayRegistry { } public class com.mapconductor.core.map.MapPaddings implements com.mapconductor.core.map.MapPaddingsInterface { public static final com.mapconductor.core.map.MapPaddings$Companion Companion; + public com.mapconductor.core.map.MapPaddings(java.lang.Double, java.lang.Double, java.lang.Double, java.lang.Double); + public com.mapconductor.core.map.MapPaddings(java.lang.Double, java.lang.Double, java.lang.Double, java.lang.Double, int, kotlin.jvm.internal.DefaultConstructorMarker); public com.mapconductor.core.map.MapPaddings(double, double, double, double); - public com.mapconductor.core.map.MapPaddings(double, double, double, double, int, kotlin.jvm.internal.DefaultConstructorMarker); public double getTop(); public double getLeft(); public double getBottom(); public double getRight(); - public com.mapconductor.core.map.MapPaddings(double, double, double); - public com.mapconductor.core.map.MapPaddings(double, double); - public com.mapconductor.core.map.MapPaddings(double); + public final boolean isTopSpecified(); + public final boolean isLeftSpecified(); + public final boolean isBottomSpecified(); + public final boolean isRightSpecified(); + public final boolean isFullySpecified(); + public final com.mapconductor.core.map.MapPaddings resolvedOnto(com.mapconductor.core.map.MapPaddingsInterface); + public com.mapconductor.core.map.MapPaddings(java.lang.Double, java.lang.Double, java.lang.Double); + public com.mapconductor.core.map.MapPaddings(java.lang.Double, java.lang.Double); + public com.mapconductor.core.map.MapPaddings(java.lang.Double); public com.mapconductor.core.map.MapPaddings(); } public final class com.mapconductor.core.map.MapPaddings$Companion { diff --git a/src/main/java/com/mapconductor/core/map/MapCameraPositionBase.kt b/src/main/java/com/mapconductor/core/map/MapCameraPositionBase.kt index f95db02..eb1f93c 100644 --- a/src/main/java/com/mapconductor/core/map/MapCameraPositionBase.kt +++ b/src/main/java/com/mapconductor/core/map/MapCameraPositionBase.kt @@ -81,18 +81,21 @@ class MapCameraPosition( val isTiltSpecified: Boolean get() = givenTilt != null /** - * 未指定の `zoom` / `bearing` / `tilt` を [current] の値で埋めたカメラを返す。 + * 未指定の `zoom` / `bearing` / `tilt` と、[paddings] の省略した辺を [current] の値で + * 埋めたカメラを返す。 * - * 明示されたプロパティは、0 であってもそのまま使う。 + * 明示されたプロパティは、0 であってもそのまま使う。余白は辺ごとに埋める + * ([MapPaddings.resolvedOnto])。 */ fun resolvedOnto(current: MapCameraPositionInterface): MapCameraPosition { - if (isZoomSpecified && isBearingSpecified && isTiltSpecified) return this + val partialPaddings = (paddings as? MapPaddings)?.takeUnless { it.isFullySpecified } + if (isZoomSpecified && isBearingSpecified && isTiltSpecified && partialPaddings == null) return this return MapCameraPosition( position = position, zoom = givenZoom ?: current.zoom, bearing = givenBearing ?: current.bearing, tilt = givenTilt ?: current.tilt, - paddings = paddings, + paddings = partialPaddings?.resolvedOnto(current.paddings) ?: paddings, visibleRegion = visibleRegion, fov = fov, ) diff --git a/src/main/java/com/mapconductor/core/map/MapPaddingsImpl.kt b/src/main/java/com/mapconductor/core/map/MapPaddingsImpl.kt index bbb8534..f9e747d 100644 --- a/src/main/java/com/mapconductor/core/map/MapPaddingsImpl.kt +++ b/src/main/java/com/mapconductor/core/map/MapPaddingsImpl.kt @@ -7,17 +7,81 @@ interface MapPaddingsInterface { val right: Double } +/** + * 地図の端から空ける幅(dp)。 + * + * 4 辺はそれぞれ省略できる。省略した辺は、カメラを動かすときに + * [MapViewState.moveCameraTo] が**今のカメラの同じ辺**から引き継ぐ + * ([MapCameraPosition.resolvedOnto])。`MapPaddings(top = 300.0)` なら上だけが + * 300 になり、左・下・右は今のまま。明示された 0 はそのまま 0 として使う。 + * + * 読むときは省略した辺も 0 を返す。省略したかどうかは [isTopSpecified] などで区別する。 + * `paddings` 自体を渡さなかったとき([MapCameraPosition] の既定 [Zeros])は従来どおり + * 4 辺とも 0 で、余白を外す意味になる。 + */ open class MapPaddings @JvmOverloads constructor( - override val top: Double = 0.0, - override val left: Double = 0.0, - override val bottom: Double = 0.0, - override val right: Double = 0.0, + top: Double? = null, + left: Double? = null, + bottom: Double? = null, + right: Double? = null, ) : MapPaddingsInterface { + /** + * 4 辺すべてを指定するコンストラクタ。 + * + * 以前の `MapPaddings(double, double, double, double)` と同じ JVM シグネチャを残して、 + * それを呼んでいた Java / コンパイル済みのコードを壊さないために持つ。 + */ + constructor(top: Double, left: Double, bottom: Double, right: Double) : + this(top as Double?, left as Double?, bottom as Double?, right as Double?) + + // 指定された値。null は省略。 + private val givenTop: Double? = top + private val givenLeft: Double? = left + private val givenBottom: Double? = bottom + private val givenRight: Double? = right + + /** 省略したときは 0。省略したかどうかは [isTopSpecified] で区別する。 */ + override val top: Double = top ?: 0.0 + + /** 省略したときは 0。省略したかどうかは [isLeftSpecified] で区別する。 */ + override val left: Double = left ?: 0.0 + + /** 省略したときは 0。省略したかどうかは [isBottomSpecified] で区別する。 */ + override val bottom: Double = bottom ?: 0.0 + + /** 省略したときは 0。省略したかどうかは [isRightSpecified] で区別する。 */ + override val right: Double = right ?: 0.0 + + val isTopSpecified: Boolean get() = givenTop != null + val isLeftSpecified: Boolean get() = givenLeft != null + val isBottomSpecified: Boolean get() = givenBottom != null + val isRightSpecified: Boolean get() = givenRight != null + + /** 4 辺とも指定されているか。 */ + val isFullySpecified: Boolean + get() = isTopSpecified && isLeftSpecified && isBottomSpecified && isRightSpecified + + /** + * 省略した辺を [current] の同じ辺で埋めた余白を返す。[current] が null なら 0 で埋める。 + * + * 4 辺とも指定されていれば自分自身を返す。 + */ + fun resolvedOnto(current: MapPaddingsInterface?): MapPaddings { + if (isFullySpecified) return this + return MapPaddings( + top = givenTop ?: current?.top ?: 0.0, + left = givenLeft ?: current?.left ?: 0.0, + bottom = givenBottom ?: current?.bottom ?: 0.0, + right = givenRight ?: current?.right ?: 0.0, + ) + } + companion object { val Zeros: MapPaddings = MapPaddings(0.0, 0.0, 0.0, 0.0) + /** [MapPaddings] はそのまま返す(省略した辺は省略したまま)。それ以外は 4 辺とも指定扱い。 */ fun from(paddings: MapPaddingsInterface) = when (paddings) { is MapPaddings -> paddings diff --git a/src/test/java/com/mapconductor/core/map/PartialPaddingsTest.kt b/src/test/java/com/mapconductor/core/map/PartialPaddingsTest.kt new file mode 100644 index 0000000..c3d7cad --- /dev/null +++ b/src/test/java/com/mapconductor/core/map/PartialPaddingsTest.kt @@ -0,0 +1,92 @@ +package com.mapconductor.core.map + +import com.mapconductor.core.features.GeoPoint +import org.junit.Assert.assertEquals +import org.junit.Assert.assertFalse +import org.junit.Assert.assertNotSame +import org.junit.Assert.assertSame +import org.junit.Assert.assertTrue +import org.junit.Test + +/** + * 省略した余白の辺だけが現在のカメラから引き継がれ、明示された 0 はそのまま使われることを確認する。 + * + * ios-sdk / js-sdk の同名テストと同じ観点。 + */ +class PartialPaddingsTest { + private val tokyo = GeoPoint(latitude = 35.6812, longitude = 139.7671) + private val current = + MapCameraPosition( + position = tokyo, + zoom = 12.0, + bearing = 30.0, + tilt = 45.0, + paddings = MapPaddings(10.0, 20.0, 30.0, 40.0), + ) + + private fun MapPaddingsInterface?.sides() = listOf(this!!.top, left, bottom, right) + + @Test + fun unsetSidesCopyFromCurrent() { + val resolved = + MapCameraPosition(position = tokyo, zoom = 12.0, bearing = 0.0, tilt = 0.0, paddings = MapPaddings(top = 300.0)) + .resolvedOnto(current) + assertEquals(listOf(300.0, 20.0, 30.0, 40.0), resolved.paddings.sides()) + assertTrue((resolved.paddings as MapPaddings).isFullySpecified) + } + + @Test + fun allUnsetCopiesAll() { + val resolved = MapCameraPosition(position = tokyo, paddings = MapPaddings()).resolvedOnto(current) + assertEquals(listOf(10.0, 20.0, 30.0, 40.0), resolved.paddings.sides()) + } + + @Test + fun explicitZeroIsHonoured() { + val resolved = + MapCameraPosition(position = tokyo, paddings = MapPaddings(top = 0.0, right = 0.0)).resolvedOnto(current) + assertEquals(listOf(0.0, 20.0, 30.0, 0.0), resolved.paddings.sides()) + } + + @Test + fun omittedPaddingsStillMeanZeros() { + val resolved = MapCameraPosition(position = tokyo).resolvedOnto(current) + assertEquals(listOf(0.0, 0.0, 0.0, 0.0), resolved.paddings.sides()) + } + + @Test + fun unresolvedReadsZeroAndKeepsFlags() { + val partial = MapPaddings(top = 300.0) + assertEquals(listOf(300.0, 0.0, 0.0, 0.0), partial.sides()) + assertTrue(partial.isTopSpecified) + assertFalse(partial.isLeftSpecified) + assertFalse(partial.isBottomSpecified) + assertFalse(partial.isRightSpecified) + assertSame(partial, MapPaddings.from(partial)) + val copied = MapCameraPosition(position = tokyo, paddings = partial).copy(zoom = 5.0) + assertFalse((copied.paddings as MapPaddings).isLeftSpecified) + } + + @Test + fun nullCurrentPaddingsFillWithZero() { + val noPaddings = MapCameraPosition(position = tokyo, paddings = null) + val resolved = MapCameraPosition(position = tokyo, paddings = MapPaddings(bottom = 50.0)).resolvedOnto(noPaddings) + assertEquals(listOf(0.0, 0.0, 50.0, 0.0), resolved.paddings.sides()) + } + + @Test + fun fastPathNeedsAllSides() { + val full = + MapCameraPosition(position = tokyo, zoom = 1.0, bearing = 0.0, tilt = 0.0, paddings = MapPaddings(1.0, 2.0, 3.0, 4.0)) + assertSame(full, full.resolvedOnto(current)) + val partial = MapCameraPosition(position = tokyo, zoom = 1.0, bearing = 0.0, tilt = 0.0, paddings = MapPaddings(top = 1.0)) + assertNotSame(partial, partial.resolvedOnto(current)) + } + + @Test + fun fourArgumentConstructorIsFullySpecified() { + assertTrue(MapPaddings(0.0, 0.0, 0.0, 0.0).isFullySpecified) + assertTrue(MapPaddings.Zeros.isFullySpecified) + assertTrue(MapPaddings(top = 1.0, left = 2.0, bottom = 3.0, right = 4.0).isFullySpecified) + } +}