Viewer API Improvements

packages/frontend-2/components/viewer/explorer/TreeItem.vue

@@ -181,7 +181,7 @@ const { hideObjects, showObjects, isolateObjects, unIsolateObjects } =
 
 const isAtomic = computed(() => props.treeItem.atomic === true)
 const speckleData = props.treeItem?.raw as SpeckleObject
-const rawSpeckleData = props.treeItem?.raw as Record<string, unknown>
+const rawSpeckleData = props.treeItem?.raw as SpeckleObject
 
 const headerAndSubheader = computed(() => {
   return getHeaderAndSubheaderForSpeckleObject(rawSpeckleData)

packages/frontend-2/components/viewer/selection/Object.vue

@@ -77,7 +77,7 @@
         class="pl-2"
       >
         <ViewerSelectionObject
-          :object="(kvp.value as Record<string,unknown>) || {}"
+          :object="(kvp.value as SpeckleObject) || {}"
           :title="(kvp.key as string)"
           :unfold="false"
         />

packages/frontend-2/components/viewer/settings/Menu.vue

@@ -29,8 +29,8 @@ const localViewerSettings = useSynchronizedCookie<ViewerUserSettings>(
 const { instance } = useInjectedViewer()
 
 const setViewerCameraHandlerControlsMaxPolarAngle = (angle: number) => {
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-  instance.getExtension(CameraController).controls.maxPolarAngle = angle
+  const extension = instance.getExtension(CameraController)
+  if (extension) extension.controls.maxPolarAngle = angle
 }
 
 const toggleTurntableMode = () => {

packages/frontend-2/lib/common/helpers/sceneExplorer.ts

@@ -1,3 +1,5 @@
+import { type SpeckleObject, type SpeckleReference } from '@speckle/viewer'
+
 // Note: minor typing hacks for less squiggly lines in the explorer.
 // TODO: ask alex re viewer data tree types
 
@@ -10,15 +12,4 @@ export type ExplorerNode = {
   children: ExplorerNode[]
 }
 
-export type SpeckleReference = {
-  referencedId: string
-}
-
-export interface SpeckleObject {
-  id?: string
-  elements?: SpeckleReference[]
-  children?: SpeckleObject[] | SpeckleReference[]
-  name?: string
-  speckle_type?: string
-  [key: string]: unknown
-}
+export type { SpeckleObject, SpeckleReference }

packages/frontend-2/lib/viewer/composables/setup/postSetup.ts

@@ -306,13 +306,14 @@ function useViewerCameraIntegration() {
 
   const loadCameraDataFromViewer = () => {
     const controls = instance.getExtension(CameraController).controls
+    let cameraManuallyChanged = false
+
     const viewerPos = new Vector3()
     const viewerTarget = new Vector3()
 
     controls.getPosition(viewerPos)
     controls.getTarget(viewerTarget)
 
-    let cameraManuallyChanged = false
     if (!areVectorsLooselyEqual(position.value, viewerPos)) {
       if (hasInitialLoadFired.value) position.value = viewerPos.clone()
       cameraManuallyChanged = true

packages/frontend-2/lib/viewer/composables/ui.ts

@@ -1,4 +1,4 @@
-import { SpeckleViewer, timeoutAt, type Optional } from '@speckle/shared'
+import { SpeckleViewer, timeoutAt } from '@speckle/shared'
 import type { TreeNode } from '@speckle/viewer'
 import { CameraController, MeasurementsExtension } from '@speckle/viewer'
 import type { MeasurementOptions, PropertyInfo } from '@speckle/viewer'
@@ -64,14 +64,14 @@ export function useCameraUtilities() {
     instance.setView(...args)
   }
 
-  let cameraController: Optional<CameraController> = undefined
+  let cameraController: CameraController | null = null
   const truck = (
     ...args: Parameters<NonNullable<typeof cameraController>['controls']['truck']>
   ) => {
     if (!cameraController) {
       cameraController = instance.getExtension(CameraController)
     }
-    cameraController.controls.truck(...args)
+    cameraController?.controls.truck(...args)
   }
 
   const zoomExtentsOrSelection = () => {

packages/frontend-2/lib/viewer/composables/viewer.ts

@@ -11,7 +11,7 @@ import { TimeoutError, timeoutAt } from '@speckle/shared'
 import type { MaybeAsync, Nullable } from '@speckle/shared'
 import { Vector3 } from 'three'
 import { areVectorsLooselyEqual } from '~~/lib/viewer/helpers/three'
-import { CameraController } from '@speckle/viewer'
+import { CameraController, type ViewerEventPayload } from '@speckle/viewer'
 import type { TreeNode } from '@speckle/viewer'
 import type { SpeckleObject } from '~~/lib/common/helpers/sceneExplorer'
 
@@ -78,9 +78,9 @@ function getFirstVisibleSelectionHit(
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export function useViewerEventListener<A = any>(
-  name: ViewerEvent | ViewerEvent[],
-  listener: (...args: A[]) => MaybeAsync<void>,
+export function useViewerEventListener<K extends ViewerEvent>(
+  name: K | K[],
+  listener: (args: ViewerEventPayload[K]) => MaybeAsync<void>,
   options?: Partial<{
     state: InitialStateWithRequestAndResponse
   }>
@@ -135,7 +135,8 @@ export function useViewerCameraTracker(
     }
 
     // Only invoke callback if position/target changed in a meaningful way
-    const controls = instance.getExtension(CameraController).controls
+    const extension = instance.getExtension(CameraController)
+    const controls = extension.controls
     const viewerPos = new Vector3()
     const viewerTarget = new Vector3()
 
@@ -165,7 +166,6 @@ export function useViewerCameraTracker(
 
   onMounted(() => {
     const extension = instance.getExtension(CameraController)
-
     extension.controls.addEventListener('update', finalCallback)
   })
 

packages/objectloader/types/index.d.ts

@@ -46,6 +46,6 @@ export default class ObjectLoader {
   ): SpeckleObject | SpeckleObject[]
 
   async *getObjectIterator(): Generator<SpeckleObject, SpeckleObject>
-
+  async getObject(id: string): Promise<Record<string, unknown>>
   dispose(): void
 }

packages/viewer-sandbox/.eslintrc.js

@@ -11,6 +11,9 @@ const config = {
   parserOptions: {
     sourceType: 'module'
   },
+  rules: {
+    '@typescript-eslint/no-non-null-assertion': 'error'
+  },
   overrides: [
     {
       files: '*.ts',

packages/viewer-sandbox/src/Extensions/BoxSelection.ts

@@ -4,13 +4,7 @@ import { ObjectLayers } from '@speckle/viewer'
 import { NodeRenderView } from '@speckle/viewer'
 import { SelectionExtension } from '@speckle/viewer'
 import { BatchObject } from '@speckle/viewer'
-import {
-  Extension,
-  IViewer,
-  GeometryType,
-  MeshBatch,
-  CameraController
-} from '@speckle/viewer'
+import { Extension, IViewer, GeometryType, CameraController } from '@speckle/viewer'
 import {
   Matrix4,
   ShaderMaterial,
@@ -113,17 +107,18 @@ export class BoxSelection extends Extension {
 
   /** Gets the object ids that fall withing the provided selection box */
   private getSelectionIds(selectionBox: Box3) {
+    /** Get the renderer */
+    const renderer = this.viewer.getRenderer()
     /** Get the mesh batches */
-    const batches = this.viewer
-      .getRenderer()
-      .batcher.getBatches(undefined, GeometryType.MESH) as MeshBatch[]
-
+    const batches = renderer.batcher.getBatches(undefined, GeometryType.MESH)
     /** Compute the clip matrix */
     const clipMatrix = new Matrix4()
-    clipMatrix.multiplyMatrices(
-      this.viewer.getRenderer().renderingCamera.projectionMatrix,
-      this.viewer.getRenderer().renderingCamera.matrixWorldInverse
-    )
+    if (renderer.renderingCamera) {
+      clipMatrix.multiplyMatrices(
+        renderer.renderingCamera.projectionMatrix,
+        renderer.renderingCamera.matrixWorldInverse
+      )
+    }
 
     /** We're using three-mesh-bvh library for out BVH
      *  Go over each batch and test it against the TAS only.

packages/viewer-sandbox/src/Extensions/CameraPlanes.ts

@@ -3,7 +3,6 @@ import {
   Extension,
   GeometryType,
   IViewer,
-  MeshBatch,
   Vector3
 } from '@speckle/viewer'
 import { PerspectiveCamera } from 'three'
@@ -20,17 +19,18 @@ export class CameraPlanes extends Extension {
 
   public constructor(viewer: IViewer) {
     super(viewer)
-    this.camerController = viewer.getExtension(
-      CameraController as new () => CameraController
-    )
+    this.camerController = viewer.getExtension(CameraController) as CameraController
   }
 
   public onEarlyUpdate(): void {
     this.computePerspectiveCameraPlanes()
   }
 
   public computePerspectiveCameraPlanes() {
-    const camera = this.viewer.getRenderer().renderingCamera as PerspectiveCamera
+    const renderer = this.viewer.getRenderer()
+    if (!renderer.renderingCamera) return
+
+    const camera = renderer.renderingCamera as PerspectiveCamera
     const minDist = this.getClosestGeometryDistance(camera)
     if (minDist === Number.POSITIVE_INFINITY) return
 
@@ -42,7 +42,7 @@ export class CameraPlanes extends Extension {
         1 +
           Math.pow(Math.tan(((fov / 180) * Math.PI) / 2), 2) * (Math.pow(aspect, 2) + 1)
       )
-    this.viewer.getRenderer().renderingCamera.near = nearPlane
+    renderer.renderingCamera.near = nearPlane
     console.log(minDist, nearPlane)
   }
 
@@ -55,11 +55,13 @@ export class CameraPlanes extends Extension {
 
     const batches = this.viewer
       .getRenderer()
-      .batcher.getBatches(undefined, GeometryType.MESH) as MeshBatch[]
+      .batcher.getBatches(undefined, GeometryType.MESH)
     let minDist = Number.POSITIVE_INFINITY
     const minPoint = new Vector3()
     for (let b = 0; b < batches.length; b++) {
       const result = batches[b].mesh.TAS.closestPointToPoint(cameraPosition)
+      if (!result) continue
+
       const planarity = cameraDir.dot(
         new Vector3().subVectors(result.point, cameraPosition).normalize()
       )

packages/viewer-sandbox/src/Extensions/ExtendedSelection.ts

@@ -34,10 +34,14 @@ export class ExtendedSelection extends SelectionExtension {
   }
 
   private initGizmo() {
+    const rendeder = this.viewer.getRenderer()
+    if (!rendeder.renderingCamera)
+      throw new Error('Cannot use ExtendedSelection without a rendering camera')
+
     /** Create a new TransformControls gizmo */
     this.transformControls = new TransformControls(
-      this.viewer.getRenderer().renderingCamera,
-      this.viewer.getRenderer().renderer.domElement
+      rendeder.renderingCamera,
+      rendeder.renderer.domElement
     )
     /** The gizmo creates an entire hierarchy of children internally,
      *  and three.js objects do not inherit parent layer values, so