cesium/packages/engine/Specs/DataSources/StaticGroundGeometryPerMaterialBatchSpec.js

import {
  ApproximateTerrainHeights,
  Cartesian2,
  Cartesian3,
  Color,
  DistanceDisplayCondition,
  JulianDate,
  Math as CesiumMath,
  TimeInterval,
  TimeIntervalCollection,
  ConstantProperty,
  EllipseGeometryUpdater,
  EllipseGraphics,
  Entity,
  GridMaterialProperty,
  StaticGroundGeometryPerMaterialBatch,
  TimeIntervalCollectionProperty,
  ClassificationType,
  GroundPrimitive,
  MaterialAppearance,
  GeometryVisualizer,
  EntityCollection,
} from "../../index.js";

import createScene from "../../../../Specs/createScene.js";
import pollToPromise from "../../../../Specs/pollToPromise.js";

describe("DataSources/StaticGroundGeometryPerMaterialBatch", function () {
  const time = JulianDate.now();
  let scene;
  beforeAll(function () {
    scene = createScene();

    return GroundPrimitive.initializeTerrainHeights();
  });

  afterAll(function () {
    scene.destroyForSpecs();

    // Leave ground primitive uninitialized
    GroundPrimitive._initialized = false;
    GroundPrimitive._initPromise = undefined;
    ApproximateTerrainHeights._initPromise = undefined;
    ApproximateTerrainHeights._terrainHeights = undefined;
  });

  it("handles shared material being invalidated with geometry", function () {
    if (
      !GroundPrimitive.isSupported(scene) ||
      !GroundPrimitive.supportsMaterials(scene)
    ) {
      // Don't fail if materials on GroundPrimitive not supported
      return;
    }

    const entityCollection = new EntityCollection();
    const geometryVisualizer = new GeometryVisualizer(scene, entityCollection);

    const ellipse = new EllipseGraphics();
    ellipse.semiMajorAxis = new ConstantProperty(2);
    ellipse.semiMinorAxis = new ConstantProperty(1);
    ellipse.material = new GridMaterialProperty();

    const entity = new Entity({
      position: new Cartesian3(1234, 5678, 9101112),
      ellipse: ellipse,
    });

    const ellipse2 = new EllipseGraphics();
    ellipse2.semiMajorAxis = new ConstantProperty(3);
    ellipse2.semiMinorAxis = new ConstantProperty(2);
    ellipse2.material = new GridMaterialProperty();

    const entity2 = new Entity({
      position: new Cartesian3(123, 456, 789),
      ellipse: ellipse2,
    });

    entityCollection.add(entity);
    entityCollection.add(entity2);

    return pollToPromise(function () {
      scene.initializeFrame();
      const isUpdated = geometryVisualizer.update(time);
      scene.render(time);
      return isUpdated;
    })
      .then(function () {
        expect(scene.groundPrimitives.length).toEqual(1);
        ellipse.material.cellAlpha = new ConstantProperty(0.5);

        return pollToPromise(function () {
          scene.initializeFrame();
          const isUpdated = geometryVisualizer.update(time);
          scene.render(time);
          return isUpdated;
        });
      })
      .then(function () {
        expect(scene.groundPrimitives.length).toEqual(2);
        geometryVisualizer.destroy();
      });
  });

  it("updates with sampled distance display condition out of range", function () {
    if (
      !GroundPrimitive.isSupported(scene) ||
      !GroundPrimitive.supportsMaterials(scene)
    ) {
      // Don't fail if materials on GroundPrimitive not supported
      return;
    }

    const validTime = JulianDate.fromIso8601("2018-02-14T04:10:00+1100");
    const outOfRangeTime = JulianDate.fromIso8601("2018-02-14T04:20:00+1100");
    const ddc = new TimeIntervalCollectionProperty();
    ddc.intervals.addInterval(
      TimeInterval.fromIso8601({
        iso8601: "2018-02-14T04:00:00+1100/2018-02-14T04:15:00+1100",
        data: new DistanceDisplayCondition(1.0, 2.0),
      }),
    );
    const entity = new Entity({
      availability: new TimeIntervalCollection([
        TimeInterval.fromIso8601({
          iso8601: "2018-02-14T04:00:00+1100/2018-02-14T04:30:00+1100",
        }),
      ]),
      position: new Cartesian3(1234, 5678, 9101112),
      ellipse: {
        semiMajorAxis: 2,
        semiMinorAxis: 1,
        material: new GridMaterialProperty(),
        distanceDisplayCondition: ddc,
      },
    });

    const batch = new StaticGroundGeometryPerMaterialBatch(
      scene.groundPrimitives,
      ClassificationType.BOTH,
      MaterialAppearance,
    );

    const updater = new EllipseGeometryUpdater(entity, scene);
    batch.add(validTime, updater);

    return pollToPromise(function () {
      scene.initializeFrame();
      const isUpdated = batch.update(validTime);
      scene.render(validTime);
      return isUpdated;
    }).then(function () {
      expect(scene.groundPrimitives.length).toEqual(1);
      let primitive = scene.groundPrimitives.get(0);
      let attributes = primitive.getGeometryInstanceAttributes(entity);
      expect(attributes.distanceDisplayCondition).toEqualEpsilon(
        [1.0, 2.0],
        CesiumMath.EPSILON6,
      );

      batch.update(outOfRangeTime);
      scene.render(outOfRangeTime);

      primitive = scene.groundPrimitives.get(0);
      attributes = primitive.getGeometryInstanceAttributes(entity);
      expect(attributes.distanceDisplayCondition).toEqual([0.0, Infinity]);

      batch.removeAllPrimitives();
    });
  });

  it("updates with sampled show out of range", function () {
    if (
      !GroundPrimitive.isSupported(scene) ||
      !GroundPrimitive.supportsMaterials(scene)
    ) {
      // Don't fail if materials on GroundPrimitive not supported
      return;
    }

    const validTime = JulianDate.fromIso8601("2018-02-14T04:10:00+1100");
    const outOfRangeTime = JulianDate.fromIso8601("2018-02-14T04:20:00+1100");
    const show = new TimeIntervalCollectionProperty();
    show.intervals.addInterval(
      TimeInterval.fromIso8601({
        iso8601: "2018-02-14T04:00:00+1100/2018-02-14T04:15:00+1100",
        data: true,
      }),
    );
    const entity = new Entity({
      availability: new TimeIntervalCollection([
        TimeInterval.fromIso8601({
          iso8601: "2018-02-14T04:00:00+1100/2018-02-14T04:30:00+1100",
        }),
      ]),
      position: new Cartesian3(1234, 5678, 9101112),
      ellipse: {
        semiMajorAxis: 2,
        semiMinorAxis: 1,
        material: new GridMaterialProperty(),
        show: show,
      },
    });

    const batch = new StaticGroundGeometryPerMaterialBatch(
      scene.groundPrimitives,
      ClassificationType.BOTH,
      MaterialAppearance,
    );

    const updater = new EllipseGeometryUpdater(entity, scene);
    batch.add(validTime, updater);

    return pollToPromise(function () {
      scene.initializeFrame();
      const isUpdated = batch.update(validTime);
      scene.render(validTime);
      return isUpdated;
    }).then(function () {
      expect(scene.groundPrimitives.length).toEqual(1);
      let primitive = scene.groundPrimitives.get(0);
      let attributes = primitive.getGeometryInstanceAttributes(entity);
      expect(attributes.show).toEqual([1]);

      batch.update(outOfRangeTime);
      scene.render(outOfRangeTime);

      primitive = scene.groundPrimitives.get(0);
      attributes = primitive.getGeometryInstanceAttributes(entity);
      expect(attributes.show).toEqual([0]);

      batch.removeAllPrimitives();
    });
  });

  it("shows only one primitive while rebuilding primitive", function () {
    if (
      !GroundPrimitive.isSupported(scene) ||
      !GroundPrimitive.supportsMaterials(scene)
    ) {
      // Don't fail if materials on GroundPrimitive not supported
      return;
    }

    const batch = new StaticGroundGeometryPerMaterialBatch(
      scene.groundPrimitives,
      ClassificationType.BOTH,
      MaterialAppearance,
    );

    function buildEntity(x, y, z) {
      const material = new GridMaterialProperty({
        color: Color.YELLOW,
        cellAlpha: 0.3,
        lineCount: new Cartesian2(8, 8),
        lineThickness: new Cartesian2(2.0, 2.0),
      });

      return new Entity({
        position: new Cartesian3(x, y, z),
        ellipse: {
          semiMajorAxis: 2,
          semiMinorAxis: 1,
          material: material,
        },
      });
    }

    function renderScene() {
      scene.initializeFrame();
      const isUpdated = batch.update(time);
      scene.render(time);
      return isUpdated;
    }

    const entity1 = buildEntity(1234, 5678, 9101112);
    const entity2 = buildEntity(123, 456, 789);

    const updater1 = new EllipseGeometryUpdater(entity1, scene);
    const updater2 = new EllipseGeometryUpdater(entity2, scene);

    batch.add(time, updater1);
    return pollToPromise(renderScene)
      .then(function () {
        expect(scene.groundPrimitives.length).toEqual(1);
        const primitive = scene.groundPrimitives.get(0);
        expect(primitive.show).toBeTruthy();
      })
      .then(function () {
        batch.add(time, updater2);
      })
      .then(function () {
        return pollToPromise(function () {
          renderScene();
          return scene.groundPrimitives.length === 2;
        });
      })
      .then(function () {
        let showCount = 0;
        expect(scene.groundPrimitives.length).toEqual(2);
        showCount += !!scene.groundPrimitives.get(0).show;
        showCount += !!scene.groundPrimitives.get(1).show;
        expect(showCount).toEqual(1);
      })
      .then(function () {
        return pollToPromise(renderScene);
      })
      .then(function () {
        expect(scene.groundPrimitives.length).toEqual(1);
        const primitive = scene.groundPrimitives.get(0);
        expect(primitive.show).toBeTruthy();

        batch.removeAllPrimitives();
      });
  });

  it("batches overlapping entities with the same material separately", function () {
    if (
      !GroundPrimitive.isSupported(scene) ||
      !GroundPrimitive.supportsMaterials(scene)
    ) {
      // Don't fail if materials on GroundPrimitive not supported
      return;
    }

    const batch = new StaticGroundGeometryPerMaterialBatch(
      scene.groundPrimitives,
      ClassificationType.BOTH,
      MaterialAppearance,
    );

    const ellipse = new EllipseGraphics();
    ellipse.semiMajorAxis = new ConstantProperty(2);
    ellipse.semiMinorAxis = new ConstantProperty(1);
    ellipse.material = new GridMaterialProperty();

    const entity = new Entity({
      position: new Cartesian3(1234, 5678, 9101112),
      ellipse: ellipse,
    });

    const ellipse2 = new EllipseGraphics();
    ellipse2.semiMajorAxis = new ConstantProperty(3);
    ellipse2.semiMinorAxis = new ConstantProperty(2);
    ellipse2.material = new GridMaterialProperty();

    const entity2 = new Entity({
      position: new Cartesian3(1234, 5678, 9101112),
      ellipse: ellipse2,
    });

    const updater = new EllipseGeometryUpdater(entity, scene);
    const updater2 = new EllipseGeometryUpdater(entity2, scene);
    batch.add(time, updater);
    batch.add(time, updater2);

    return pollToPromise(function () {
      scene.initializeFrame();
      const isUpdated = batch.update(time);
      scene.render(time);
      return isUpdated;
    }).then(function () {
      expect(scene.groundPrimitives.length).toEqual(2);

      batch.removeAllPrimitives();
    });
  });

  it("batches nonoverlapping entities that both use color materials", function () {
    if (
      !GroundPrimitive.isSupported(scene) ||
      !GroundPrimitive.supportsMaterials(scene)
    ) {
      // Don't fail if materials on GroundPrimitive not supported
      return;
    }

    const batch = new StaticGroundGeometryPerMaterialBatch(
      scene.groundPrimitives,
      ClassificationType.BOTH,
      MaterialAppearance,
    );
    const entity = new Entity({
      position: new Cartesian3(1234, 5678, 9101112),
      ellipse: {
        semiMajorAxis: 2,
        semiMinorAxis: 1,
        material: Color.RED,
      },
    });

    const entity2 = new Entity({
      position: new Cartesian3(123, 456, 789),
      ellipse: {
        semiMajorAxis: 2,
        semiMinorAxis: 1,
        material: Color.BLUE,
      },
    });

    const updater = new EllipseGeometryUpdater(entity, scene);
    const updater2 = new EllipseGeometryUpdater(entity2, scene);
    batch.add(time, updater);
    batch.add(time, updater2);

    return pollToPromise(function () {
      scene.initializeFrame();
      const isUpdated = batch.update(time);
      scene.render(time);
      return isUpdated;
    }).then(function () {
      expect(scene.groundPrimitives.length).toEqual(1);

      batch.removeAllPrimitives();
    });
  });

  it("has correct show attribute after rebuilding primitive", function () {
    if (!GroundPrimitive.isSupported(scene)) {
      return;
    }

    if (
      !GroundPrimitive.isSupported(scene) ||
      !GroundPrimitive.supportsMaterials(scene)
    ) {
      // Don't fail if materials on GroundPrimitive not supported
      return;
    }

    const batch = new StaticGroundGeometryPerMaterialBatch(
      scene.groundPrimitives,
      ClassificationType.BOTH,
      MaterialAppearance,
    );

    function buildEntity(x, y, z) {
      const material = new GridMaterialProperty({
        color: Color.YELLOW,
        cellAlpha: 0.3,
        lineCount: new Cartesian2(8, 8),
        lineThickness: new Cartesian2(2.0, 2.0),
      });

      return new Entity({
        position: new Cartesian3(x, y, z),
        ellipse: {
          semiMajorAxis: 2,
          semiMinorAxis: 1,
          material: material,
        },
      });
    }

    function renderScene() {
      scene.initializeFrame();
      const isUpdated = batch.update(time);
      scene.render(time);
      return isUpdated;
    }

    const entity1 = buildEntity(1234, 5678, 9101112);
    const updater1 = new EllipseGeometryUpdater(entity1, scene);
    batch.add(time, updater1);

    const entity2 = buildEntity(123, 456, 789);
    const updater2 = new EllipseGeometryUpdater(entity2, scene);

    return pollToPromise(renderScene)
      .then(function () {
        expect(scene.groundPrimitives.length).toEqual(1);
        const primitive = scene.groundPrimitives.get(0);
        const attributes = primitive.getGeometryInstanceAttributes(entity1);
        expect(attributes.show).toEqual([1]);

        entity1.show = false;
        updater1._onEntityPropertyChanged(entity1, "isShowing");
        return pollToPromise(renderScene);
      })
      .then(function () {
        expect(scene.groundPrimitives.length).toEqual(1);
        const primitive = scene.groundPrimitives.get(0);
        const attributes = primitive.getGeometryInstanceAttributes(entity1);
        expect(attributes.show).toEqual([0]);

        batch.add(time, updater2);
        return pollToPromise(renderScene);
      })
      .then(function () {
        expect(scene.groundPrimitives.length).toEqual(1);
        const primitive = scene.groundPrimitives.get(0);
        let attributes = primitive.getGeometryInstanceAttributes(entity1);
        expect(attributes.show).toEqual([0]);

        attributes = primitive.getGeometryInstanceAttributes(entity2);
        expect(attributes.show).toEqual([1]);

        batch.removeAllPrimitives();
      });
  });

  /**
   * Written originally in response to issue #1640, where materials flashed white and transparent when changing their properties,
   * because doing so caused a batch to be destroyed and recreated prematurely which, in turn, caused the associated
   * material (and primitive) to be destroyed and recreated.
   */
  it("doesn't immediately remove an empty batch that may be reused before the next update", async function () {
    if (
      !GroundPrimitive.isSupported(scene) ||
      !GroundPrimitive.supportsMaterials(scene)
    ) {
      // Don't fail if materials on GroundPrimitive not supported
      return;
    }

    const batch = new StaticGroundGeometryPerMaterialBatch(
      scene.groundPrimitives,
      ClassificationType.BOTH,
      MaterialAppearance,
    );

    const ellipse = new EllipseGraphics();
    const ellipseMaterial = new GridMaterialProperty();
    ellipse.semiMajorAxis = new ConstantProperty(2);
    ellipse.semiMinorAxis = new ConstantProperty(1);
    ellipse.material = ellipseMaterial;

    const entity = new Entity({
      position: new Cartesian3(1234, 5678, 9101112),
      ellipse: ellipse,
    });

    const updater = new EllipseGeometryUpdater(entity, scene);
    batch.add(time, updater);

    await pollToPromise(function () {
      scene.initializeFrame();
      const isUpdated = batch.update(time);
      scene.render(time);
      return isUpdated;
    });

    // Remove and add back the updater before the next batch update
    // Removal should defer deletion of the batch, and the updater should find the old batch still works upon re-adding
    // Thus, the material should not be destroyed and recreated (and will have the same guid / be the same object)
    const materialBefore = scene.groundPrimitives.get(0).appearance.material;
    batch.remove(updater);
    batch.add(time, updater);

    await pollToPromise(function () {
      scene.initializeFrame();
      const isUpdated = batch.update(time);
      scene.render(time);
      return isUpdated;
    });

    const groundPrimitives = scene.groundPrimitives;
    const materialAfter = groundPrimitives.get(0).appearance.material;
    expect(materialBefore).toEqual(materialAfter);
    expect(groundPrimitives.length).toEqual(1);

    batch.removeAllPrimitives();
  });
});