VV: UI + Design

- Add 4, 8, 16, 32, and 64 example to Storybook - Add Histogram range slider - Add params to overall Viewer - Fix scroll bug - Inline OrbitControls import - Incorporate Figma Styles
zooniverse · Dec 19, 2024 · 069b614 · 069b614
1 parent c9ecdc9
commit 069b614
Show file tree

Hide file tree

Showing 25 changed files with 1,984 additions and 634 deletions.
diff --git a/.../Classifier/components/SubjectViewer/components/VolumetricViewer/VolumetricViewer.spec.js b/.../Classifier/components/SubjectViewer/components/VolumetricViewer/VolumetricViewer.spec.js
@@ -13,7 +13,7 @@ describe('Component > VolumetricViewer', function () {
         subjectJSON: 'mock-subject-json'
       }}
     />)
-    expect(screen.getByText('Suspense boundary')).to.exist()
+    expect(screen.getByText('Loading Volumetric Viewer...')).to.exist()
     expect(await screen.findByTestId('subject-viewer-volumetric')).to.exist()
   })
 })
diff --git a/...lassifier/components/SubjectViewer/components/VolumetricViewer/VolumetricViewerWrapper.js b/...lassifier/components/SubjectViewer/components/VolumetricViewer/VolumetricViewerWrapper.js
@@ -3,8 +3,8 @@ import { lazy, Suspense } from 'react'
 import { MobXProviderContext } from 'mobx-react'
 import { useContext } from 'react'
 
-const VolumetricViewer = lazy(() => import('@zooniverse/subject-viewers/VolumetricViewer'))
 const DEFAULT_HANDLER = () => {}
+const VolumetricViewer = lazy(() => import('@zooniverse/subject-viewers/VolumetricViewer'))
 
 function VolumetricViewerWrapper({
   loadingState = asyncStates.initialized,
@@ -21,14 +21,17 @@ function VolumetricViewerWrapper({
       addAnnotation(activeStepTasks[0], annotations)
   }
 
-  return <Suspense fallback={<p>Suspense boundary</p>}>
-    <VolumetricViewer
-      loadingState={loadingState}
-      onAnnotation={onAnnotationUpdate}
-      onError={onError}
-      onReady={onReady}
-      subject={subject}
-    />
+  const config = {
+    annotations: [],
+    loadingState,
+    onAnnotation: onAnnotationUpdate,
+    onError,
+    onReady,
+    subject,
+  }
+
+  return <Suspense fallback={<p>Loading Volumetric Viewer...</p>}>
+    <VolumetricViewer {...config} />
   </Suspense>
 }
 

diff --git a/packages/lib-subject-viewers/src/VolumetricViewer/README.md b/packages/lib-subject-viewers/src/VolumetricViewer/README.md
@@ -4,3 +4,5 @@ This directory holds all the relevant code for rendering the VolumetricViewer. T
 
 - `VolumetricViewerComponent` - a React component for the VolumetricViewer
 - `VolumetricViewerData` - a function that returns the data with instantiated models along with the React Component
+
+NOTE: Webpack has trouble importing from a node_module package from dependent package chains (`lib-subject-viewers` => `lib-classifier` => `app-project`), therefore we have inlined `OrbitControls.js` file so that it works without Webpack issues. When updating the `three` dependency in `package.json` make sure to copy the file from `node_modules/three/examples/jsm/controls/OrbitControls.js` to `lib-subject-viewers/src/VolumetricViewer/helpers/OrbitControls.js`.
diff --git a/packages/lib-subject-viewers/src/VolumetricViewer/VolumetricViewer.js b/packages/lib-subject-viewers/src/VolumetricViewer/VolumetricViewer.js
@@ -17,37 +17,37 @@ export default function VolumetricViewer ({
   subject
 }) {
   const { data, loading, error } = useVolumetricSubject({ onError, onReady, subject })
-  
+
   const [modelState] = useState({
     annotations: ModelAnnotations({ onAnnotation }),
     tool: ModelTool(),
     viewer: ModelViewer()
   })
-  
-  const isLoading = loadingState === asyncStates.initialized
-    || loadingState === asyncStates.loading
-    || loading;
-  const isError = loadingState === asyncStates.error
-    || error
-    || data === null;
+
+  const isLoading = loadingState === asyncStates.initialized ||
+    loadingState === asyncStates.loading ||
+    loading
+  const isError = loadingState === asyncStates.error ||
+    error ||
+    data === null
 
   // Specs should skip rendering the VolumetricViewer component
   // WebGL/Canvas throws exceptions when running specs due to non-browser environment
   return (data === 'mock-subject-json')
-    ? <div data-testid="subject-viewer-volumetric"></div>
+    ? <div data-testid='subject-viewer-volumetric' />
     : (isLoading)
-    ? <p>Loading...</p>
-    : (isError)
-      ? <p>Error</p>
-      : <ComponentViewer
-        data-testid="subject-viewer-volumetric"
-        config={{}}
-        data={data}
-        models={modelState}
-      />
+        ? <p>Loading...</p>
+        : (isError)
+            ? <p>Error</p>
+            : <ComponentViewer
+                data-testid='subject-viewer-volumetric'
+                config={{}}
+                data={data}
+                models={modelState}
+              />
 }
 
-export const VolumetricViewerData = ({ 
+export const VolumetricViewerData = ({
   onAnnotation = DEFAULT_HANDLER,
   subjectData = '',
   subjectUrl = ''
@@ -69,6 +69,7 @@ export const VolumetricViewerData = ({
 
 VolumetricViewer.propTypes = {
   loadingState: string,
+  onAnnotation: func,
   onError: func,
   onReady: func,
   subject: object

diff --git a/packages/lib-subject-viewers/src/VolumetricViewer/components/ComponentViewer.js b/packages/lib-subject-viewers/src/VolumetricViewer/components/ComponentViewer.js
@@ -1,60 +1,109 @@
-import { object, string } from 'prop-types'
 import { AlgorithmAStar } from './../helpers/AlgorithmAStar.js'
+import { Box } from 'grommet'
 import { Cube } from './Cube.js'
+import { Histogram } from './Histogram.js'
+import { Orientation } from './Orientation.js'
+import { object, string } from 'prop-types'
 import { Plane } from './Plane.js'
-import { Box } from 'grommet'
+import styled, { css } from 'styled-components'
+
+const StyledBox = styled(Box)`
+  ${props => props.theme.dark
+    ? css`
+      background-color: none;
+      color: #FFFFFF;
+    `
+    : css`
+      background-color: #FFFFFF;
+      color: #000000;
+    `
+  }
+  
+  border: 1px solid #E2E5E9;
+  border-bottom-left-radius: 16px;
+  border-top-left-radius: 16px;
+  max-width: 975px;
+  width: 100%;
+
+  .planes-container {
+    margin: 20px;
+  }
+  
+  .volume-container {
+    background-color: #000000;
+    border-top-left-radius: 16px;
+    border-bottom-left-radius: 16px;
+    height: 590px;
+    padding: 25px;
+    position: relative;
+
+    .volume-controls {
+      margin-top: 25px;
+      max-height: 60px;
+      width: 100%;
+    }
+
+    .volume-cube {
+      max-width: 430px;
+      width: 100%;
+    }
+  }
+`
 
 export const ComponentViewer = ({
   data,
   models
 }) => {
-  // Initialize Annotations
-  if (models.annotations) {
-    models.annotations.initialize({
-      algorithm: AlgorithmAStar,
-      data: [], // will come from Caesar if they exist
-      viewer: models.viewer
-    })
-  }
+  models.annotations.initialize({
+    algorithm: AlgorithmAStar,
+    data: [],
+    viewer: models.viewer
+  })
 
-  // Initialize Tool
-  if (models.tool) {
-    models.tool.initialize({
-      annotations: models.annotations
-    })
-  }
+  models.tool.initialize({
+    annotations: models.annotations
+  })
 
-  // Initialize Viewer
-  if (models.viewer) {
-    models.viewer.initialize({
-      annotations: models.annotations,
-      data,
-      tool: models.tool
-    })
-  }
+  models.viewer.initialize({
+    annotations: models.annotations,
+    data,
+    tool: models.tool
+  })
 
   return (
-    <Box direction='row' style={{ maxWidth: '800px', padding: '20px' }}>
-      <Box flex>
-        {models.viewer.dimensions.map((dimensionName, dimension) => {
-          return (
-            <Plane
+    <Box flex align='end'>
+      <StyledBox direction='row'>
+        <Box className='planes-container'>
+          {models.viewer.dimensions.map((dimensionName, dimension) => {
+            return (
+              <Plane
+                annotations={models.annotations}
+                dimension={dimension}
+                key={`dimension-${dimensionName}`}
+                tool={models.tool}
+                viewer={models.viewer}
+              />
+            )
+          })}
+        </Box>
+        <Box className='volume-container' flex align='center' justify='between'>
+          <Box className='volume-cube'>
+            <Cube
+              annotations={models.annotations}
+              tool={models.tool}
+              viewer={models.viewer}
+            />
+          </Box>
+          <Box className='volume-controls' flex direction='row' justify='between'>
+            <Orientation />
+            <Histogram
               annotations={models.annotations}
-              dimension={dimension}
-              key={`dimension-${dimensionName}`}
               tool={models.tool}
               viewer={models.viewer}
             />
-          )
-        })}
-      </Box>
-      <Box flex>
-        <Cube
-          annotations={models.annotations}
-          tool={models.tool}
-          viewer={models.viewer}
-        />
-      </Box>
+          </Box>
+        </Box>
+      </StyledBox>
     </Box>
   )
 }

diff --git a/packages/lib-subject-viewers/src/VolumetricViewer/components/Config.js b/packages/lib-subject-viewers/src/VolumetricViewer/components/Config.js
@@ -1,7 +1,7 @@
-import { object } from 'prop-types'
-import { useEffect, useState } from 'react'
 import { AnnotationView } from './AnnotationView.js'
 import { InputRangeDual } from './InputRangeDual.js'
+import { object } from 'prop-types'
+import { useEffect, useState } from 'react'
 
 export const Config = ({
   annotations,
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,3 +4,5 @@ This directory holds all the relevant code for rendering the VolumetricViewer. T

		- `VolumetricViewerComponent` - a React component for the VolumetricViewer
		- `VolumetricViewerData` - a function that returns the data with instantiated models along with the React Component

		NOTE: Webpack has trouble importing from a node_module package from dependent package chains (`lib-subject-viewers` => `lib-classifier` => `app-project`), therefore we have inlined `OrbitControls.js` file so that it works without Webpack issues. When updating the `three` dependency in `package.json` make sure to copy the file from `node_modules/three/examples/jsm/controls/OrbitControls.js` to `lib-subject-viewers/src/VolumetricViewer/helpers/OrbitControls.js`.