HARP-13493: Make maxZoomLevel value in technique non inclusive (#2016)

Signed-off-by: German Zargaryan <german.zargaryan@here.com>
heremaps · Jan 11, 2021 · 9d2b004 · 9d2b004
1 parent 059999b
commit 9d2b004
Show file tree

Hide file tree

Showing 6 changed files with 117 additions and 15 deletions.
diff --git a/@here/harp-datasource-protocol/lib/StyleSetEvaluator.ts b/@here/harp-datasource-protocol/lib/StyleSetEvaluator.ts
@@ -693,7 +693,7 @@ export class StyleSetEvaluator {
                 }
             }
 
-            if (typeof maxZoomLevel === "number" && zoomLevel > maxZoomLevel) {
+            if (typeof maxZoomLevel === "number" && zoomLevel >= maxZoomLevel) {
                 return false;
             }
         }

diff --git a/@here/harp-datasource-protocol/lib/TechniqueParams.ts b/@here/harp-datasource-protocol/lib/TechniqueParams.ts
@@ -264,7 +264,7 @@ export interface BaseTechniqueParams {
     minZoomLevel?: DynamicProperty<number>;
 
     /**
-     * Maximum zoom level. If the current zoom level is larger, the technique will not be used.
+     * Maximum zoom level. If the current zoom level is equal to or greater, the technique will not be used.
      */
     maxZoomLevel?: DynamicProperty<number>;
 }

diff --git a/@here/harp-datasource-protocol/test/StyleSetEvaluatorTest.ts b/@here/harp-datasource-protocol/test/StyleSetEvaluatorTest.ts
@@ -588,8 +588,8 @@ describe("StyleSetEvaluator", function() {
             ])
         );
 
-        assert.isNotEmpty(
-            getMatchingTechniques({ ...defaultProperties, $zoom: 15 }, [
+        assert.isEmpty(
+            getMatchingTechniques({ ...defaultProperties, $zoom: 13.9 }, [
                 {
                     when: ["==", ["geometry-type"], "Polygon"],
                     technique: "extruded-polygon",
@@ -600,11 +600,11 @@ describe("StyleSetEvaluator", function() {
         );
 
         assert.isNotEmpty(
-            getMatchingTechniques({ ...defaultProperties, $zoom: 15 }, [
+            getMatchingTechniques({ ...defaultProperties, $zoom: 14 }, [
                 {
                     when: ["==", ["geometry-type"], "Polygon"],
                     technique: "extruded-polygon",
-                    minZoomLevel: 15,
+                    minZoomLevel: 14,
                     maxZoomLevel: 15
                 }
             ])
@@ -615,7 +615,8 @@ describe("StyleSetEvaluator", function() {
                 {
                     when: ["==", ["geometry-type"], "Polygon"],
                     technique: "extruded-polygon",
-                    minZoomLevel: 16
+                    minZoomLevel: 15,
+                    maxZoomLevel: 15
                 }
             ])
         );
@@ -625,22 +626,35 @@ describe("StyleSetEvaluator", function() {
                 {
                     when: ["==", ["geometry-type"], "Polygon"],
                     technique: "extruded-polygon",
-                    maxZoomLevel: 14
+                    minZoomLevel: 16
                 }
             ])
         );
 
-        assert.isNotEmpty(
-            getMatchingTechniques({ ...defaultProperties, $zoom: 15, minLevel: 14, maxLevel: 15 }, [
+        assert.isEmpty(
+            getMatchingTechniques({ ...defaultProperties, $zoom: 15 }, [
                 {
                     when: ["==", ["geometry-type"], "Polygon"],
                     technique: "extruded-polygon",
-                    minZoomLevel: ["get", "minLevel"],
-                    maxZoomLevel: ["get", "maxLevel"]
+                    maxZoomLevel: 14
                 }
             ])
         );
 
+        assert.isNotEmpty(
+            getMatchingTechniques(
+                { ...defaultProperties, $zoom: 14.5, minLevel: 14, maxLevel: 15 },
+                [
+                    {
+                        when: ["==", ["geometry-type"], "Polygon"],
+                        technique: "extruded-polygon",
+                        minZoomLevel: ["get", "minLevel"],
+                        maxZoomLevel: ["get", "maxLevel"]
+                    }
+                ]
+            )
+        );
+
         assert.isEmpty(
             getMatchingTechniques({ ...defaultProperties, $zoom: 15, maxLevel: 14 }, [
                 {

diff --git a/@here/harp-mapview/lib/TileObjectsRenderer.ts b/@here/harp-mapview/lib/TileObjectsRenderer.ts
@@ -238,7 +238,7 @@ export class TileObjectRenderer {
             return false;
         }
 
-        if (typeof maxZoomLevel === "number" && zoomLevel > maxZoomLevel) {
+        if (typeof maxZoomLevel === "number" && zoomLevel >= maxZoomLevel) {
             return false;
         }
 

diff --git a/@here/harp-mapview/lib/text/Placement.ts b/@here/harp-mapview/lib/text/Placement.ts
@@ -216,6 +216,7 @@ export function checkReadyForPlacement(
     // updatePoiFromPoiTable, since that function may change those values.
     if (
         !textElement.visible ||
+        viewState.zoomLevel === textElement.maxZoomLevel ||
         !MathUtils.isClamped(
             viewState.zoomLevel,
             textElement.minZoomLevel,

diff --git a/@here/harp-mapview/test/PlacementTest.ts b/@here/harp-mapview/test/PlacementTest.ts
@@ -32,14 +32,20 @@ import {
     WrappingMode
 } from "@here/harp-text-canvas";
 import { getAppBaseUrl } from "@here/harp-utils";
-import { expect } from "chai";
+import { assert, expect } from "chai";
 import * as path from "path";
 import * as sinon from "sinon";
 import * as THREE from "three";
 
 import { PoiBuffer } from "../lib/poi/PoiRenderer";
 import { ScreenCollisions } from "../lib/ScreenCollisions";
-import { placeIcon, PlacementResult, placePointLabel } from "../lib/text/Placement";
+import {
+    checkReadyForPlacement,
+    placeIcon,
+    PlacementResult,
+    placePointLabel,
+    PrePlacementResult
+} from "../lib/text/Placement";
 import { RenderState } from "../lib/text/RenderState";
 import { LoadingState, TextElement } from "../lib/text/TextElement";
 import { TextElementState } from "../lib/text/TextElementState";
@@ -1330,4 +1336,85 @@ describe("Placement", function() {
             expect(result).to.equal(PlacementResult.Ok);
         });
     });
+
+    describe("checkReadyForPlacement", () => {
+        let textElement: TextElement;
+        function checkPlacementResult(
+            textElement: TextElement,
+            viewState: any = {},
+            poiManager?: any
+        ) {
+            return checkReadyForPlacement(
+                textElement,
+                undefined,
+                {
+                    ...viewState,
+                    projection: {},
+                    worldCenter: new THREE.Vector3(),
+                    lookAtVector: new THREE.Vector3()
+                },
+                poiManager ?? {
+                    updatePoiFromPoiTable: () => true
+                },
+                1000
+            ).result;
+        }
+
+        before(async () => {
+            textElement = await createTextElement(textCanvas, "Test", new THREE.Vector3(), {}, {});
+        });
+
+        it("NotReady while if updatePoiFromPoiTable returns false", async () => {
+            assert.equal(
+                checkPlacementResult(
+                    textElement,
+                    {},
+                    {
+                        updatePoiFromPoiTable: () => false
+                    }
+                ),
+                PrePlacementResult.NotReady
+            );
+        });
+
+        it("Invisible if textElement is invisible", async () => {
+            textElement.visible = false;
+            assert.equal(checkPlacementResult(textElement), PrePlacementResult.Invisible);
+        });
+
+        it("Invisible if textElement is out of zoom range", async () => {
+            textElement.visible = true;
+            textElement.minZoomLevel = 6;
+            textElement.maxZoomLevel = 14;
+
+            assert.equal(
+                checkPlacementResult(textElement, { zoomLevel: 5 }),
+                PrePlacementResult.Invisible
+            );
+
+            assert.equal(
+                checkPlacementResult(textElement, { zoomLevel: 7 }),
+                PrePlacementResult.Ok
+            );
+
+            assert.equal(
+                checkPlacementResult(textElement, { zoomLevel: 14 }),
+                PrePlacementResult.Invisible
+            );
+
+            assert.equal(
+                checkPlacementResult(textElement, { zoomLevel: 14.1 }),
+                PrePlacementResult.Invisible
+            );
+        });
+
+        it("Invisible if both min and max zoom range are the same", () => {
+            textElement.minZoomLevel = 7;
+            textElement.maxZoomLevel = 7;
+            assert.equal(
+                checkPlacementResult(textElement, { zoomLevel: 7 }),
+                PrePlacementResult.Invisible
+            );
+        });
+    });
 });