feat: add sampleTerrainHeight on reearht/core (#466)

feat: add sampleTerrainHeight api on reeath/core
reearth · Feb 16, 2023 · 55334ec · 55334ec
1 parent 4c89aa2
commit 55334ec
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 1 deletion.
diff --git a/src/core/Crust/Plugins/PluginFrame/hooks.ts b/src/core/Crust/Plugins/PluginFrame/hooks.ts
@@ -45,6 +45,8 @@ export type Ref = {
   arena: () => Arena | undefined;
 };
 
+const AsyncFunction = (async () => {}).constructor;
+
 // restrict any classes
 export const defaultIsMarshalable = (obj: any): boolean => {
   return (
@@ -53,7 +55,8 @@ export const defaultIsMarshalable = (obj: any): boolean => {
     Object.getPrototypeOf(obj) === Function.prototype ||
     Object.getPrototypeOf(obj) === Object.prototype ||
     obj instanceof Date ||
-    obj instanceof Promise
+    obj instanceof Promise ||
+    obj instanceof AsyncFunction
   );
 };
 

diff --git a/src/core/Crust/Plugins/api.ts b/src/core/Crust/Plugins/api.ts
@@ -309,6 +309,7 @@ export function commonReearth({
   rotateRight,
   captureScreen,
   getLocationFromScreen,
+  sampleTerrainHeight,
   enableScreenSpaceCameraController,
   lookHorizontal,
   lookVertical,
@@ -350,6 +351,7 @@ export function commonReearth({
   cameraViewport?: () => GlobalThis["reearth"]["camera"]["viewport"];
   captureScreen: GlobalThis["reearth"]["scene"]["captureScreen"];
   getLocationFromScreen: GlobalThis["reearth"]["scene"]["getLocationFromScreen"];
+  sampleTerrainHeight: GlobalThis["reearth"]["scene"]["sampleTerrainHeight"];
   inEditor: () => GlobalThis["reearth"]["scene"]["inEditor"];
   enableScreenSpaceCameraController: GlobalThis["reearth"]["camera"]["enableScreenSpaceController"];
   lookHorizontal: GlobalThis["reearth"]["camera"]["lookHorizontal"];
@@ -411,6 +413,7 @@ export function commonReearth({
       overrideProperty: overrideSceneProperty,
       captureScreen,
       getLocationFromScreen,
+      sampleTerrainHeight,
     },
     get viewport() {
       return viewport?.();

diff --git a/src/core/Crust/Plugins/hooks.ts b/src/core/Crust/Plugins/hooks.ts
@@ -147,6 +147,13 @@ export default function ({
     [engineRef],
   );
 
+  const sampleTerrainHeight = useCallback(
+    async (lng: number, lat: number) => {
+      return await engineRef?.sampleTerrainHeight(lng, lat);
+    },
+    [engineRef],
+  );
+
   const enableScreenSpaceCameraController = useCallback(
     (enabled: boolean) => engineRef?.enableScreenSpaceCameraController(enabled),
     [engineRef],
@@ -298,6 +305,7 @@ export default function ({
         orbit,
         captureScreen,
         getLocationFromScreen,
+        sampleTerrainHeight,
         enableScreenSpaceCameraController,
         lookHorizontal,
         lookVertical,
@@ -341,6 +349,7 @@ export default function ({
       flyTo,
       flyToGround,
       getLocationFromScreen,
+      sampleTerrainHeight,
       hideLayer,
       lookHorizontal,
       lookVertical,

diff --git a/src/core/Crust/Plugins/plugin_types.ts b/src/core/Crust/Plugins/plugin_types.ts
@@ -121,6 +121,7 @@ export type Scene = {
     y: number,
     withTerrain?: boolean,
   ) => LatLngHeight | undefined;
+  readonly sampleTerrainHeight: (lng: number, lat: number) => Promise<number | undefined>;
 };
 
 export type Camera = {

diff --git a/src/core/Crust/Plugins/storybook.tsx b/src/core/Crust/Plugins/storybook.tsx
@@ -92,6 +92,7 @@ export const context: Context = {
       overrideProperty: act("overrideSceneProperty"),
       captureScreen: act("captureScreen"),
       getLocationFromScreen: act("getLocationFromScreen"),
+      sampleTerrainHeight: act("sampleTerrainHeight"),
     },
     layers: {
       hide: act("layers.hide"),

diff --git a/src/core/Map/ref.ts b/src/core/Map/ref.ts
@@ -19,6 +19,7 @@ const engineRefKeys: FunctionKeys<EngineRef> = {
   getCamera: 1,
   getClock: 1,
   getLocationFromScreen: 1,
+  sampleTerrainHeight: 1,
   getViewport: 1,
   lookAt: 1,
   lookAtLayer: 1,

diff --git a/src/core/Map/types/index.ts b/src/core/Map/types/index.ts
@@ -48,6 +48,7 @@ export type EngineRef = {
   getViewport: () => Rect | undefined;
   getCamera: () => Camera | undefined;
   getLocationFromScreen: (x: number, y: number, withTerrain?: boolean) => LatLngHeight | undefined;
+  sampleTerrainHeight: (lng: number, lat: number) => Promise<number | undefined>;
   flyTo: (target: string | FlyToDestination, options?: CameraOptions) => void;
   lookAt: (destination: LookAtDestination, options?: CameraOptions) => void;
   lookAtLayer: (layerId: string) => void;

diff --git a/src/core/engines/Cesium/useEngineRef.ts b/src/core/engines/Cesium/useEngineRef.ts
@@ -26,6 +26,7 @@ import {
   getCenterCamera,
   zoom,
   lookAtWithoutAnimation,
+  sampleTerrainHeight,
 } from "./common";
 import { findEntity } from "./utils";
 
@@ -69,6 +70,11 @@ export default function useEngineRef(
         if (!viewer || viewer.isDestroyed()) return;
         return getLocationFromScreen(viewer.scene, x, y, withTerrain);
       },
+      sampleTerrainHeight: async (lng, lat) => {
+        const viewer = cesium.current?.cesiumElement;
+        if (!viewer || viewer.isDestroyed()) return;
+        return await sampleTerrainHeight(viewer.scene, lng, lat);
+      },
       flyTo: (target, options) => {
         if (target && typeof target === "object") {
           const viewer = cesium.current?.cesiumElement;