Many Minor Fixes (#156)

* remove workshop wings, free up wasd on textinput unmount * suppress pointer lock errors, general cleanup * add open in oculus menu button, enter vr on clicking continue in headset * change direction state from input space to player space, map left button to fly, fix xr movement * mute audio on page hide, pause menu dev mode * add .preload to useImage and useModel * comments and small refactors
musehq · Jan 6, 2023 · cbc73ee · cbc73ee
1 parent 7e26481
commit cbc73ee
Show file tree

Hide file tree

Showing 19 changed files with 346 additions and 271 deletions.
diff --git a/examples/ideas/PreloadImage.tsx b/examples/ideas/PreloadImage.tsx
@@ -0,0 +1,28 @@
+import { useState } from "react";
+import { Image, useImage, useKeypress } from "spacesvr";
+import { useThree } from "@react-three/fiber";
+
+const IMAGE_URL =
+  "https://d1htv66kutdwsl.cloudfront.net/e7edec86-52b6-4734-9c43-ffd70bc5bef6/9d1e5c18-3fb5-4844-8b31-1a08b800976e.ktx2";
+
+export default function PreloadImage() {
+  const gl = useThree((st) => st.gl);
+
+  const [mounted, setMounted] = useState(false);
+  useKeypress("m", () => setMounted(!mounted), [mounted]);
+
+  useImage.preload(IMAGE_URL, gl);
+
+  if (!mounted) return null;
+
+  return (
+    <Image
+      src={IMAGE_URL}
+      framed
+      frameWidth={0.75}
+      size={12}
+      rotation-y={0}
+      position={[-1.4, 1.5, -12]}
+    />
+  );
+}
diff --git a/examples/ideas/Wings.tsx b/examples/ideas/Wings.tsx
diff --git a/examples/worlds/Hub.tsx b/examples/worlds/Hub.tsx
@@ -10,15 +10,16 @@ export default function Hub() {
     >
       <Analytics />
       <LostWorld />
-      <group position-z={-1.5}>
+      <group position-z={-2.25}>
         <Title
           position-y={1.2}
+          position-z={-0.75}
           image="https://d27rt3a60hh1lx.cloudfront.net/spacesvr/spacesvr.png"
         >
           welcome to spacesvr
         </Title>
         <group position-y={0.8}>
-          <Link href="/multiplayer" position-x={-2}>
+          <Link href="/multiplayer" position-x={-1.5} position-z={0.75}>
             visit multiplayer page
           </Link>
           <Link href="/media" position-x={-1}>
@@ -27,7 +28,11 @@ export default function Hub() {
           <Link href="/workshop" position-x={1}>
             visit workshop page
           </Link>
-          <Link href="https://github.com/musehq/spacesvr" position-x={2}>
+          <Link
+            href="https://github.com/musehq/spacesvr"
+            position-x={1.5}
+            position-z={0.75}
+          >
             visit github
           </Link>
         </group>

diff --git a/examples/worlds/Workshop.tsx b/examples/worlds/Workshop.tsx
@@ -14,7 +14,7 @@ import Title from "../ideas/Title";
 import Link from "../ideas/Link";
 import Analytics from "../ideas/Analytics";
 import Bloom from "../ideas/Bloom";
-import Wings from "../ideas/Wings";
+import PreloadImage from "../ideas/PreloadImage";
 
 export default function Workshop() {
   const [value, setValue] = useState("hello world");
@@ -94,12 +94,6 @@ export default function Workshop() {
         position={[-9.5, 2, 6.4]}
         rotation={[0, Math.PI, 0]}
       />
-      <Image
-        src="https://d1htv66kutdwsl.cloudfront.net/e7edec86-52b6-4734-9c43-ffd70bc5bef6/9d1e5c18-3fb5-4844-8b31-1a08b800976e.ktx2"
-        position={[-12.5, 2, 6.4]}
-        rotation={[0, Math.PI, 0]}
-        framed
-      />
       <group position={[1, 0.9, -5.5]}>
         <TextInput
           placeholder="First Name"
@@ -134,15 +128,7 @@ export default function Workshop() {
         />
         <Switch position={[1, -0.3, 0]} onChange={(b) => console.log(b)} />
       </group>
-      <Image
-        name="outside-eddie"
-        src="https://d27rtd3a60hh1lx.cloudfront.net/content/muse.place/jasonmatias/EddieWave.jpg"
-        framed
-        frameWidth={0.75}
-        size={12}
-        rotation-y={0}
-        position={[-1.4, 1.5, -12]}
-      />
+      <PreloadImage />
       <Video
         src="https://dwvo2npct47gg.cloudfront.net/videos/AWGEDVD-final.mp4"
         size={4}

diff --git a/src/layers/Environment/components/MuteOnHide.tsx b/src/layers/Environment/components/MuteOnHide.tsx
@@ -0,0 +1,17 @@
+import { useEffect } from "react";
+import { AudioContext } from "three";
+
+export default function MuteOnHide() {
+  useEffect(() => {
+    function handleChange() {
+      const context = AudioContext.getContext();
+      if (document.hidden) context.suspend();
+      else context.resume();
+    }
+
+    document.addEventListener("visibilitychange", handleChange);
+    return () => document.removeEventListener("visibilitychange", handleChange);
+  }, []);
+
+  return null;
+}
diff --git a/src/layers/Environment/index.tsx b/src/layers/Environment/index.tsx
@@ -9,6 +9,7 @@ import { Props as ContainerProps } from "@react-three/fiber/dist/declarations/sr
 import { XRCanvas } from "@react-three/xr";
 import { defaultCanvasProps } from "./logic/canvas";
 import { EnvironmentContext, useEnvironmentState } from "./logic/environment";
+import MuteOnHide from "./components/MuteOnHide";
 export * from "./logic/environment";
 
 export type EnvironmentProps = {
@@ -38,6 +39,7 @@ export function Environment(props: EnvironmentLayerProps) {
   return (
     <>
       <GlobalStyles />
+      <MuteOnHide />
       <Container ref={state.containerRef}>
         <EnvironmentContext.Provider value={state}>
           {loadingScreen || <LoadingScreen />}

diff --git a/src/layers/Environment/logic/environment.ts b/src/layers/Environment/logic/environment.ts
@@ -1,6 +1,7 @@
 import {
   createContext,
   MutableRefObject,
+  useCallback,
   useContext,
   useMemo,
   useRef,
@@ -9,7 +10,17 @@ import {
 import { Device, DeviceState, useDevice } from "./device";
 import { AudioContext } from "three";
 
-export type MenuItem = { text: string; action: () => void };
+interface MenuLink {
+  text: string;
+  link: string;
+  action?: never;
+}
+interface MenuAction {
+  text: string;
+  link?: never;
+  action: () => void;
+}
+export type MenuItem = MenuLink | MenuAction;
 
 export type PauseEvent = (p: boolean) => void;
 export type EnvironmentState = {
@@ -32,17 +43,26 @@ export const useEnvironmentState = (name: string): EnvironmentState => {
   const [paused, setPausedValue] = useState(true);
   const events = useMemo<PauseEvent[]>(() => [], []);
 
-  const setPaused = (p: boolean) => {
-    setPausedValue(p);
+  const [played, setPlayed] = useState(false);
 
-    // hook into paused click event to make sure global context is running
-    // https://github.com/mrdoob/three.js/blob/342946c8392639028da439b6dc0597e58209c696/src/audio/AudioContext.js#L9
-    const context = AudioContext.getContext();
-    if (context.state !== "running") context.resume();
+  const setPaused = useCallback(
+    (p: boolean) => {
+      setPausedValue(p);
 
-    // call all pause events
-    events.map((ev: PauseEvent) => ev.apply(null, [p]));
-  };
+      // hook into paused click event to make sure global context is running.
+      // https://github.com/mrdoob/three.js/blob/342946c8392639028da439b6dc0597e58209c696/src/audio/AudioContext.js#L9
+      // local state to only do once so we don't interfere with MuteOnHide
+      if (!played) {
+        const context = AudioContext.getContext();
+        if (context.state !== "running") context.resume();
+        setPlayed(true);
+      }
+
+      // call all pause events
+      events.map((ev: PauseEvent) => ev.apply(null, [p]));
+    },
+    [events, played]
+  );
 
   const device = useDevice();
 

diff --git a/src/layers/Environment/logic/menu.tsx b/src/layers/Environment/logic/menu.tsx
@@ -1,8 +1,9 @@
 import { MenuItem, useEnvironment } from "../logic/environment";
 import { useThree } from "@react-three/fiber";
 import { XRSession } from "three";
-import { useEffect, useRef, useState } from "react";
+import { useCallback, useEffect, useRef, useState } from "react";
 import { isMobile } from "react-device-detect";
+import { isStandaloneVR } from "../../../logic/browser";
 
 /**
  * Component to register menu items to the environment.
@@ -14,15 +15,17 @@ export function RegisterMenuItems() {
   const { setMenuItems } = useEnvironment();
   const vrMenu = useVRMenuItem();
   const fsMenu = useFsMenuItem();
+  const oqMenu = useOculusMenuItem();
 
   useEffect(() => {
     const arr: MenuItem[] = [];
 
     if (vrMenu) arr.push(vrMenu);
     if (fsMenu) arr.push(fsMenu);
+    if (oqMenu) arr.push(oqMenu);
 
     setMenuItems(arr);
-  }, [vrMenu?.text, fsMenu?.text]);
+  }, [vrMenu?.text, fsMenu?.text, oqMenu?.text, setMenuItems]);
 
   return null;
 }
@@ -31,32 +34,10 @@ export const useVRMenuItem = (): MenuItem | undefined => {
   const gl = useThree((state) => state.gl);
   const { setDevice, setPaused } = useEnvironment();
 
-  // @ts-ignore
-  const xr = navigator.xr;
-
   const session = useRef<XRSession>();
   const [text, setText] = useState("Enter VR");
-  const [supported, setSupported] = useState(false);
-
-  useEffect(() => {
-    const isSupported = async () => {
-      if (!("xr" in window.navigator)) {
-        setSupported(false);
-        return;
-      }
 
-      const support = await xr.isSessionSupported("immersive-vr");
-      setSupported(support);
-    };
-
-    isSupported();
-  }, []);
-
-  if (!supported) {
-    return undefined;
-  }
-
-  const action = () => {
+  const action = useCallback(() => {
     async function onSessionStarted(sesh: XRSession) {
       sesh.addEventListener("end", onSessionEnded);
       await gl.xr.setSession(sesh);
@@ -83,22 +64,37 @@ export const useVRMenuItem = (): MenuItem | undefined => {
           "layers",
         ],
       };
+      // @ts-ignore
+      const xr = navigator.xr;
       xr.requestSession("immersive-vr", sessionInit).then(onSessionStarted);
     } else {
       session.current?.end();
     }
-  };
+  }, [gl.xr, setDevice, setPaused]);
+
+  if (!isStandaloneVR()) {
+    return undefined;
+  }
 
   return {
     text,
     action,
   };
 };
 
+export const useOculusMenuItem = (): MenuItem | undefined => {
+  if (isStandaloneVR()) return;
+
+  return {
+    text: "Open in Meta Quest",
+    link: "https://www.oculus.com/open_url/?url=" + window.location.href,
+  };
+};
+
 export const useFsMenuItem = (): MenuItem | undefined => {
   const domElement = document.body;
 
-  const getRFS = () =>
+  const rfs =
     domElement.requestFullscreen ||
     // @ts-ignore
     domElement.webkitRequestFullScreen ||
@@ -109,7 +105,7 @@ export const useFsMenuItem = (): MenuItem | undefined => {
     undefined;
 
   const [isFullscreen, setIsFullscreen] = useState(false);
-  const [fullscreenAvailable] = useState(getRFS() !== undefined);
+  const [fullscreenAvailable] = useState(rfs !== undefined);
 
   useEffect(() => {
     const handleFullscreenChange = () =>
@@ -121,21 +117,23 @@ export const useFsMenuItem = (): MenuItem | undefined => {
     };
   }, []);
 
-  if (!fullscreenAvailable) {
+  const action = useCallback(() => {
+    if (!rfs) return;
+    if (!document.fullscreenElement) {
+      rfs.apply(domElement, [{ navigationUI: "hide" }]);
+    } else {
+      if (document.exitFullscreen) {
+        document.exitFullscreen();
+      }
+    }
+  }, [domElement, rfs]);
+
+  if (!fullscreenAvailable || isStandaloneVR()) {
     return undefined;
   }
 
   return {
     text: `${isFullscreen ? "Exit" : "Enter"} Fullscreen`,
-    action: () => {
-      if (!document.fullscreenElement) {
-        const rfs = getRFS();
-        rfs.apply(domElement, [{ navigationUI: "hide" }]);
-      } else {
-        if (document.exitFullscreen) {
-          document.exitFullscreen();
-        }
-      }
-    },
+    action,
   };
 };