feat: add type guard for DefaultCameraManager (#4680)

* docs: make note of necessary cast in camera manager settings * chore: add type guard for DefaultCameraManager * docs: add to docs * chore: add tsdoc * chore: bump reveal version to 4.16.0
cognitedata · Jul 26, 2024 · a35389e · a35389e
1 parent dd0890d
commit a35389e
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 4 deletions.
diff --git a/documentation/docs/examples/controlsmodes.mdx b/documentation/docs/examples/controlsmodes.mdx
@@ -31,10 +31,14 @@ Default value is `false`.
 Example of setting different camera controls options:
 
 ```jsx runnable
+// import { isDefaultCameraManager } from '@cognite/reveal';
+
 const newControlsOptions = {
   mouseWheelAction: 'zoomToCursor',
   changeCameraTargetOnClick: true,
 };
 
-viewer.cameraManager.setCameraControlsOptions(newControlsOptions);
+if (isDefaultCameraManager(viewer.cameraManager)) {
+  viewer.cameraManager.setCameraControlsOptions(newControlsOptions);
+}
 ```
diff --git a/documentation/versioned_docs/version-4.x/examples/controlsmodes.mdx b/documentation/versioned_docs/version-4.x/examples/controlsmodes.mdx
diff --git a/viewer/api-entry-points/core.ts b/viewer/api-entry-points/core.ts
@@ -13,6 +13,7 @@ export {
   CameraControlsOptions,
   DebouncedCameraStopEventTrigger,
   DefaultCameraManager,
+  isDefaultCameraManager,
   CameraManagerEventType,
   CameraManagerHelper,
   CameraManager,

diff --git a/viewer/package.json b/viewer/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cognite/reveal",
-  "version": "4.15.2",
+  "version": "4.16.0",
   "description": "WebGL based 3D viewer for CAD and point clouds processed in Cognite Data Fusion.",
   "homepage": "https://github.com/cognitedata/reveal/tree/master/viewer",
   "repository": {

diff --git a/viewer/packages/camera-manager/index.ts b/viewer/packages/camera-manager/index.ts
@@ -1,7 +1,7 @@
 /*!
  * Copyright 2021 Cognite AS
  */
-export { DefaultCameraManager } from './src/DefaultCameraManager';
+export { DefaultCameraManager, isDefaultCameraManager } from './src/DefaultCameraManager';
 export { ProxyCameraManager } from './src/ProxyCameraManager';
 export { StationaryCameraManager } from './src/StationaryCameraManager';
 export { CameraManagerHelper } from './src/CameraManagerHelper';

diff --git a/viewer/packages/camera-manager/src/DefaultCameraManager.ts b/viewer/packages/camera-manager/src/DefaultCameraManager.ts
@@ -668,3 +668,10 @@ export class DefaultCameraManager implements CameraManager {
     return clamp(duration, DefaultCameraManager.MinAnimationDuration, DefaultCameraManager.MaxAnimationDuration);
   }
 }
+
+/**
+ * type guard which determines if the provided camera manager is a @see { DefaultCameraManager }
+ */
+export function isDefaultCameraManager(cameraManager: CameraManager): cameraManager is DefaultCameraManager {
+  return cameraManager instanceof DefaultCameraManager;
+}
diff --git a/viewer/reveal.api.md b/viewer/reveal.api.md
@@ -1332,6 +1332,9 @@ export class InvertedNodeCollection extends NodeCollection {
     serialize(): SerializedNodeCollection;
 }
 
+// @public
+export function isDefaultCameraManager(cameraManager: CameraManager): cameraManager is DefaultCameraManager;
+
 // @beta
 export function isFlexibleCameraManager(manager: CameraManager): manager is IFlexibleCameraManager;