feat: add built field in scene in plugin api (#584)

* feat: add built field in scene in plugin api * fix
reearth · Mar 27, 2023 · e8050c6 · e8050c6
1 parent 3494b4d
commit e8050c6
Show file tree

Hide file tree

Showing 12 changed files with 25 additions and 4 deletions.
diff --git a/src/components/molecules/Visualizer/Plugin/api.ts b/src/components/molecules/Visualizer/Plugin/api.ts
@@ -297,6 +297,7 @@ export function commonReearth({
   layersInViewport,
   layers,
   sceneProperty,
+  built,
   inEditor,
   tags,
   camera,
@@ -364,6 +365,7 @@ export function commonReearth({
   captureScreen: GlobalThis["reearth"]["scene"]["captureScreen"];
   getLocationFromScreen: GlobalThis["reearth"]["scene"]["getLocationFromScreen"];
   inEditor: () => GlobalThis["reearth"]["scene"]["inEditor"];
+  built: () => GlobalThis["reearth"]["scene"]["built"];
   enableScreenSpaceCameraController: GlobalThis["reearth"]["camera"]["enableScreenSpaceController"];
   lookHorizontal: GlobalThis["reearth"]["camera"]["lookHorizontal"];
   lookVertical: GlobalThis["reearth"]["camera"]["lookVertical"];
@@ -418,6 +420,9 @@ export function commonReearth({
       get inEditor() {
         return inEditor();
       },
+      get built() {
+        return built();
+      },
       get property() {
         return sceneProperty();
       },

diff --git a/src/components/molecules/Visualizer/Plugin/context.tsx b/src/components/molecules/Visualizer/Plugin/context.tsx
@@ -48,6 +48,7 @@ export type Props = {
   engineName: string;
   sceneProperty?: any;
   inEditor: boolean;
+  built: boolean;
   tags?: Tag[];
   camera?: CameraPosition;
   clock: Clock | undefined;
@@ -113,6 +114,7 @@ export function Provider({
   engineName,
   sceneProperty,
   inEditor,
+  built,
   tags,
   camera,
   clock,
@@ -164,6 +166,7 @@ export function Provider({
   const getLayers = useGet(layers);
   const getSceneProperty = useGet(sceneProperty);
   const getInEditor = useGet(inEditor);
+  const getBuilt = useGet(built);
   const getTags = useGet(tags ?? []);
   const getCamera = useGet(camera);
   const getClock = useGet(clock);
@@ -192,6 +195,7 @@ export function Provider({
         layers: getLayers,
         sceneProperty: getSceneProperty,
         inEditor: getInEditor,
+        built: getBuilt,
         tags: getTags,
         camera: getCamera,
         clock: getClock,

diff --git a/src/components/molecules/Visualizer/Plugin/types.ts b/src/components/molecules/Visualizer/Plugin/types.ts
@@ -120,8 +120,8 @@ export type LatLngHeight = {
 };
 
 export type Scene = {
-  /** Current scene property */
   readonly inEditor: boolean;
+  readonly built: boolean;
   readonly property?: any;
   readonly overrideProperty: (property: any) => void;
   readonly captureScreen: (type?: string, encoderOptions?: number) => string | undefined;

diff --git a/src/components/molecules/Visualizer/hooks.ts b/src/components/molecules/Visualizer/hooks.ts
@@ -230,6 +230,7 @@ export default ({
       engineName: engineType || "",
       sceneProperty: overriddenSceneProperty,
       inEditor: !!inEditor,
+      built: !!isBuilt,
       tags,
       camera: innerCamera,
       clock: innerClock,

diff --git a/src/components/molecules/Visualizer/storybook.tsx b/src/components/molecules/Visualizer/storybook.tsx
@@ -59,6 +59,7 @@ export const context: ProviderProps = {
   engineName: "cesium",
   engine: {},
   inEditor: false,
+  built: false,
   hideLayer: act("layers.hide"),
   showLayer: act("layers.show"),
   selectLayer: act("layers.select"),

diff --git a/src/components/pages/Preview/index.tsx b/src/components/pages/Preview/index.tsx
@@ -27,8 +27,7 @@ const PreviewPage: React.FC<Props> = () => {
     <ThemeProvider>
       <DndProvider>
         <AuthenticationRequiredPage>
-          {typeof core === "boolean" &&
-            (core ? <CoreCanvasArea isBuilt /> : <CanvasArea isBuilt />)}
+          {typeof core === "boolean" && (core ? <CoreCanvasArea /> : <CanvasArea />)}
         </AuthenticationRequiredPage>
       </DndProvider>
     </ThemeProvider>

diff --git a/src/core/Crust/Plugins/api.ts b/src/core/Crust/Plugins/api.ts
@@ -299,6 +299,7 @@ export function commonReearth({
   layers,
   sceneProperty,
   inEditor,
+  built,
   tags,
   camera,
   clock,
@@ -365,6 +366,7 @@ export function commonReearth({
   getLocationFromScreen: GlobalThis["reearth"]["scene"]["getLocationFromScreen"];
   sampleTerrainHeight: GlobalThis["reearth"]["scene"]["sampleTerrainHeight"];
   inEditor: () => GlobalThis["reearth"]["scene"]["inEditor"];
+  built: () => GlobalThis["reearth"]["scene"]["built"];
   enableScreenSpaceCameraController: GlobalThis["reearth"]["camera"]["enableScreenSpaceController"];
   lookHorizontal: GlobalThis["reearth"]["camera"]["lookHorizontal"];
   lookVertical: GlobalThis["reearth"]["camera"]["lookVertical"];
@@ -419,6 +421,9 @@ export function commonReearth({
       get inEditor() {
         return !!inEditor?.();
       },
+      get built() {
+        return !!built?.();
+      },
       get property() {
         return sceneProperty?.();
       },

diff --git a/src/core/Crust/Plugins/hooks.ts b/src/core/Crust/Plugins/hooks.ts
@@ -29,6 +29,7 @@ export default function ({
   mapRef,
   sceneProperty,
   inEditor,
+  built,
   tags,
   viewport,
   selectedLayer,
@@ -55,6 +56,7 @@ export default function ({
   const getLayers = useGet(layersRef);
   const getSceneProperty = useGet(sceneProperty);
   const getInEditor = useGet(!!inEditor);
+  const getBuilt = useGet(!!built);
   const getTags = useGet(tags ?? []);
   const getCamera = useGet(camera);
   const getClock = useCallback(() => {
@@ -276,6 +278,7 @@ export default function ({
         layers: getLayers,
         sceneProperty: getSceneProperty,
         inEditor: getInEditor,
+        built: getBuilt,
         tags: getTags,
         camera: getCamera,
         clock: getClock,

diff --git a/src/core/Crust/Plugins/plugin_types.ts b/src/core/Crust/Plugins/plugin_types.ts
@@ -112,8 +112,8 @@ export type Reearth = {
 };
 
 export type Scene = {
-  /** Current scene property */
   readonly inEditor: boolean;
+  readonly built: boolean;
   readonly property?: any;
   readonly overrideProperty: (property: any) => void;
   readonly captureScreen: (type?: string, encoderOptions?: number) => string | undefined;

diff --git a/src/core/Crust/Plugins/storybook.tsx b/src/core/Crust/Plugins/storybook.tsx
@@ -89,6 +89,7 @@ export const context: Context = {
     },
     scene: {
       inEditor: false,
+      built: false,
       overrideProperty: act("overrideSceneProperty"),
       captureScreen: act("captureScreen"),
       getLocationFromScreen: act("getLocationFromScreen"),

diff --git a/src/core/Crust/Plugins/types.ts b/src/core/Crust/Plugins/types.ts
@@ -16,6 +16,7 @@ export type Props = PropsWithChildren<{
   mapRef?: RefObject<MapRef>;
   sceneProperty?: any;
   inEditor?: boolean;
+  built?: boolean;
   tags?: Tag[];
   selectedLayer?: ComputedLayer;
   selectedFeature?: ComputedFeature;

diff --git a/src/core/Crust/index.tsx b/src/core/Crust/index.tsx
@@ -175,6 +175,7 @@ export default function Crust({
       engineName={engineName}
       mapRef={mapRef}
       sceneProperty={sceneProperty}
+      built={isBuilt}
       inEditor={inEditor}
       tags={tags}
       selectedLayer={selectedComputedLayer}