Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add type guard for DefaultCameraManager and bump to 4.16.0 #4680

Merged
merged 5 commits into from
Jul 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion documentation/docs/examples/controlsmodes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
```

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions viewer/api-entry-points/core.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ export {
CameraControlsOptions,
DebouncedCameraStopEventTrigger,
DefaultCameraManager,
isDefaultCameraManager,
CameraManagerEventType,
CameraManagerHelper,
CameraManager,
Expand Down
2 changes: 1 addition & 1 deletion viewer/package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
2 changes: 1 addition & 1 deletion viewer/packages/camera-manager/index.ts
Original file line number Diff line number Diff line change
@@ -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';
Expand Down
7 changes: 7 additions & 0 deletions viewer/packages/camera-manager/src/DefaultCameraManager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
3 changes: 3 additions & 0 deletions viewer/reveal.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
Loading