chore(web): Basic layer features API (#683)

reearth · Sep 12, 2023 · ba4409c · ba4409c
1 parent 3a35cbc
commit ba4409c
Show file tree

Hide file tree

Showing 15 changed files with 196 additions and 56 deletions.
diff --git a/web/src/beta/lib/core/Crust/Plugins/api.ts b/web/src/beta/lib/core/Crust/Plugins/api.ts
@@ -345,6 +345,8 @@ export function commonReearth({
   moveRight,
   moveOverTerrain,
   flyToGround,
+  findFeatureById,
+  findFeaturesByIds,
 }: {
   engineName?: string;
   events: Events<ReearthEventType>;
@@ -390,6 +392,8 @@ export function commonReearth({
   moveRight: GlobalThis["reearth"]["camera"]["moveRight"];
   moveOverTerrain: GlobalThis["reearth"]["camera"]["moveOverTerrain"];
   flyToGround: GlobalThis["reearth"]["camera"]["flyToGround"];
+  findFeatureById: GlobalThis["reearth"]["layers"]["findFeatureById"];
+  findFeaturesByIds: GlobalThis["reearth"]["layers"]["findFeaturesByIds"];
 }): CommonReearth {
   return {
     version: window.REEARTH_CONFIG?.version || "",
@@ -572,6 +576,8 @@ export function commonReearth({
       get add() {
         return addLayer;
       },
+      findFeatureById,
+      findFeaturesByIds,
     },
     plugins: {
       get instances() {

diff --git a/web/src/beta/lib/core/Crust/Plugins/hooks.ts b/web/src/beta/lib/core/Crust/Plugins/hooks.ts
@@ -247,6 +247,20 @@ export default function ({
     [engineRef],
   );
 
+  const findFeatureById = useCallback(
+    (layerId: string, featureId: string) => {
+      return engineRef?.findFeatureById(layerId, featureId);
+    },
+    [engineRef],
+  );
+
+  const findFeaturesByIds = useCallback(
+    (layerId: string, featureIds: string[]) => {
+      return engineRef?.findFeaturesByIds(layerId, featureIds);
+    },
+    [engineRef],
+  );
+
   const addLayer = useCallback(
     (layer: NaiveLayer) => {
       return layersRef?.add(layer)?.id;
@@ -333,6 +347,8 @@ export default function ({
         moveRight,
         moveOverTerrain,
         flyToGround,
+        findFeatureById,
+        findFeaturesByIds,
       }),
       overrideSceneProperty,
       pluginInstances,
@@ -388,6 +404,8 @@ export default function ({
       pluginInstances,
       clientStorage,
       useExperimentalSandbox,
+      findFeatureById,
+      findFeaturesByIds,
     ],
   );
 

diff --git a/web/src/beta/lib/core/Crust/Plugins/plugin_types.ts b/web/src/beta/lib/core/Crust/Plugins/plugin_types.ts
@@ -20,6 +20,7 @@ import type {
   OverriddenLayer,
   Undefinable,
   WrappedRef,
+  Feature,
 } from "@reearth/beta/lib/core/Map";
 
 import { Block } from "../Infobox";
@@ -82,6 +83,8 @@ export type Reearth = {
         layerId: string | undefined,
         reason?: LayerSelectionReason | undefined,
       ) => void;
+      findFeatureById?: (layerId: string, featureId: string) => Feature | undefined;
+      findFeaturesByIds?: (layerId: string, featureId: string[]) => Feature[] | undefined;
       selectionReason?: LayerSelectionReason;
       // For compat
       overriddenInfobox?: LayerSelectionReason["defaultInfobox"];

diff --git a/web/src/beta/lib/core/Map/Layer/hooks.ts b/web/src/beta/lib/core/Map/Layer/hooks.ts
@@ -11,7 +11,15 @@ import {
   evalFeature,
   type Data,
 } from "../../mantle";
-import type { Atom, DataRange, Layer, ComputedLayer, ComputedFeature, Feature } from "../types";
+import type {
+  Atom,
+  DataRange,
+  Layer,
+  ComputedLayer,
+  ComputedFeature,
+  Feature,
+  LayerSimple,
+} from "../types";
 
 export type { Atom as Atom } from "../types";
 
@@ -35,6 +43,10 @@ export default function useHooks({
   selectedFeatureId?: string;
 }) {
   const [computedLayer, set] = useAtom(useMemo(() => atom ?? createAtom(), [atom]));
+  const writeLayer = useCallback(
+    (value: Partial<Pick<LayerSimple, "properties">>) => set({ type: "writeLayer", value }),
+    [set],
+  );
   const writeFeatures = useCallback(
     (features: Feature[]) => set({ type: "writeFeatures", features }),
     [set],
@@ -131,6 +143,7 @@ export default function useHooks({
   return {
     computedLayer,
     handleFeatureRequest: requestFetch,
+    handleLayerFetch: writeLayer,
     handleFeatureFetch: writeFeatures,
     handleComputedFeatureFetch: writeComputedFeatures,
     handleFeatureDelete: deleteFeatures,

diff --git a/web/src/beta/lib/core/Map/Layer/index.tsx b/web/src/beta/lib/core/Map/Layer/index.tsx
@@ -7,6 +7,7 @@ import type {
   Layer,
   DataType,
   ComputedFeature,
+  LayerSimple,
 } from "../../mantle";
 import { SceneProperty } from "../types";
 
@@ -30,6 +31,7 @@ export type FeatureComponentProps = {
   layer: ComputedLayer;
   sceneProperty?: SceneProperty;
   onFeatureRequest?: (range: DataRange) => void;
+  onLayerFetch?: (value: Partial<Pick<LayerSimple, "properties">>) => void;
   onFeatureFetch?: (features: Feature[]) => void;
   onComputedFeatureFetch?: (feature: Feature[], computed: ComputedFeature[]) => void;
   onFeatureDelete?: (features: string[]) => void;
@@ -59,6 +61,7 @@ export default function LayerComponent({
   const {
     computedLayer,
     handleFeatureDelete,
+    handleLayerFetch,
     handleComputedFeatureDelete,
     handleFeatureFetch,
     handleComputedFeatureFetch,
@@ -78,6 +81,7 @@ export default function LayerComponent({
       layer={computedLayer}
       onFeatureDelete={handleFeatureDelete}
       onComputedFeatureDelete={handleComputedFeatureDelete}
+      onLayerFetch={handleLayerFetch}
       onFeatureFetch={handleFeatureFetch}
       onComputedFeatureFetch={handleComputedFeatureFetch}
       onFeatureRequest={handleFeatureRequest}

diff --git a/web/src/beta/lib/core/Map/Layers/hooks.ts b/web/src/beta/lib/core/Map/Layers/hooks.ts
@@ -200,6 +200,8 @@ export default function useHooks({
       // compat
       if (key === "pluginId") return layer.compat?.extensionId ? "reearth" : undefined;
       else if (key === "extensionId") return layer.compat?.extensionId;
+      // TODO: Support normal layer's properties
+      else if (key === "properties") return layer.type === "simple" ? layer.properties : undefined;
       else if (key === "property") return layer.compat?.property;
       else if (key === "propertyId") return layer.compat?.propertyId;
       else if (key === "isVisible") return layer.visible;

diff --git a/web/src/beta/lib/core/Map/Layers/index.test.tsx b/web/src/beta/lib/core/Map/Layers/index.test.tsx
@@ -28,6 +28,7 @@ test("simple", () => {
     },
     onFeatureDelete: expect.any(Function),
     onFeatureFetch: expect.any(Function),
+    onLayerFetch: expect.any(Function),
     onComputedFeatureFetch: expect.any(Function),
     onComputedFeatureDelete: expect.any(Function),
     onFeatureRequest: expect.any(Function),
@@ -45,6 +46,7 @@ test("simple", () => {
     },
     onFeatureDelete: expect.any(Function),
     onFeatureFetch: expect.any(Function),
+    onLayerFetch: expect.any(Function),
     onComputedFeatureFetch: expect.any(Function),
     onComputedFeatureDelete: expect.any(Function),
     onFeatureRequest: expect.any(Function),

diff --git a/web/src/beta/lib/core/Map/ref.ts b/web/src/beta/lib/core/Map/ref.ts
@@ -60,6 +60,8 @@ const engineRefKeys: FunctionKeys<EngineRef> = {
   inViewport: 1,
   onTick: 1,
   removeTickEventListener: 1,
+  findFeaturesByIds: 1,
+  findFeatureById: 1,
 };
 
 const layersRefKeys: FunctionKeys<LayersRef> = {

diff --git a/web/src/beta/lib/core/Map/types/index.ts b/web/src/beta/lib/core/Map/types/index.ts
@@ -15,6 +15,7 @@ import type {
   LatLng,
   DataType,
   SelectedFeatureInfo,
+  Feature,
 } from "../../mantle";
 import type {
   FeatureComponentType,
@@ -96,6 +97,8 @@ export type EngineRef = {
   onTick: TickEvent;
   tickEventCallback?: RefObject<TickEventCallback[]>;
   removeTickEventListener: TickEvent;
+  findFeatureById: (layerId: string, featureId: string) => Feature | undefined;
+  findFeaturesByIds: (layerId: string, featureId: string[]) => Feature[] | undefined;
 };
 
 export type EngineProps = {