-
Notifications
You must be signed in to change notification settings - Fork 20
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(react-components): Move global camera controls to Reveal context #4745
Merged
haakonflatval-cognite
merged 6 commits into
master
from
hflatval/move-camera-control-to-reveal-context
Sep 9, 2024
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
0d89ab4
feat(react-components): Move global camera controls to Reveal context
haakonflatval-cognite ac6abe6
chore: implement state updates properly
haakonflatval-cognite fec00d0
test: add test file
haakonflatval-cognite 3e3d16c
chore: add changes related to test
haakonflatval-cognite 9b5a83e
chore: move out viewer provider props into its own type
haakonflatval-cognite 80e4ddf
chore: improve path
haakonflatval-cognite File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
21 changes: 0 additions & 21 deletions
21
react-components/src/components/RevealCanvas/ViewerContext.ts
This file was deleted.
Oops, something went wrong.
54 changes: 54 additions & 0 deletions
54
react-components/src/components/RevealCanvas/ViewerContext.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
/*! | ||
* Copyright 2023 Cognite AS | ||
*/ | ||
import { type Cognite3DViewer } from '@cognite/reveal'; | ||
import { createContext, type ReactElement, type ReactNode, useContext } from 'react'; | ||
import { type RevealRenderTarget } from '../../architecture/base/renderTarget/RevealRenderTarget'; | ||
import { type CameraStateParameters, useCameraStateControl } from './hooks/useCameraStateControl'; | ||
|
||
const ViewerContext = createContext<RevealRenderTarget | null>(null); | ||
|
||
export type ViewerContextProviderProps = { | ||
cameraState?: CameraStateParameters; | ||
setCameraState?: (cameraState?: CameraStateParameters) => void; | ||
value: RevealRenderTarget | null; | ||
children: ReactNode; | ||
}; | ||
|
||
export const ViewerContextProvider = ({ | ||
cameraState, | ||
setCameraState, | ||
value, | ||
children | ||
}: ViewerContextProviderProps): ReactElement => { | ||
return ( | ||
<ViewerContext.Provider value={value}> | ||
<ViewerControls cameraState={cameraState} setCameraState={setCameraState} /> | ||
{children} | ||
</ViewerContext.Provider> | ||
); | ||
}; | ||
|
||
const ViewerControls = ({ | ||
cameraState, | ||
setCameraState | ||
}: { | ||
cameraState?: CameraStateParameters; | ||
setCameraState?: (cameraState?: CameraStateParameters) => void; | ||
}): ReactNode => { | ||
useCameraStateControl(cameraState, setCameraState); | ||
return null; | ||
}; | ||
|
||
export const useReveal = (): Cognite3DViewer => { | ||
const renderTarget = useRenderTarget(); | ||
return renderTarget.viewer; | ||
}; | ||
|
||
export const useRenderTarget = (): RevealRenderTarget => { | ||
const renderTarget = useContext(ViewerContext); | ||
if (renderTarget === null) { | ||
throw new Error('useRenderTarget must be used within a ViewerProvider'); | ||
} | ||
return renderTarget; | ||
}; |
98 changes: 98 additions & 0 deletions
98
react-components/src/components/RevealCanvas/hooks/useCameraStateControl.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
/*! | ||
* Copyright 2023 Cognite AS | ||
*/ | ||
|
||
import { type MutableRefObject, useEffect, useRef } from 'react'; | ||
import { useReveal } from '../ViewerContext'; | ||
import { type CameraState } from '@cognite/reveal'; | ||
|
||
export type CameraStateParameters = Omit<Required<CameraState>, 'rotation'>; | ||
|
||
export const useCameraStateControl = ( | ||
externalCameraState?: CameraStateParameters, | ||
setCameraState?: (cameraState?: CameraStateParameters) => void | ||
): void => { | ||
const lastSetExternalState = useRef<CameraStateParameters | undefined>( | ||
externalCameraState === undefined | ||
? undefined | ||
: { | ||
position: externalCameraState.position.clone(), | ||
target: externalCameraState.target.clone() | ||
} | ||
); | ||
|
||
useSetInternalCameraStateOnExternalUpdate(externalCameraState, lastSetExternalState); | ||
|
||
useSetExternalCameraStateOnCameraMove(setCameraState, externalCameraState, lastSetExternalState); | ||
}; | ||
|
||
const useSetInternalCameraStateOnExternalUpdate = ( | ||
externalCameraState: CameraStateParameters | undefined, | ||
lastSetExternalState: MutableRefObject<CameraStateParameters | undefined> | ||
): void => { | ||
const reveal = useReveal(); | ||
|
||
useEffect(() => { | ||
if ( | ||
externalCameraState === undefined || | ||
isCameraStatesEqual(externalCameraState, lastSetExternalState.current) | ||
) { | ||
return; | ||
} | ||
|
||
reveal.cameraManager.setCameraState(externalCameraState); | ||
}, [externalCameraState]); | ||
}; | ||
|
||
const useSetExternalCameraStateOnCameraMove = ( | ||
setCameraState: ((cameraState?: CameraStateParameters) => void) | undefined, | ||
externalCameraState: CameraStateParameters | undefined, | ||
lastSetExternalState: MutableRefObject<CameraStateParameters | undefined> | ||
): void => { | ||
const reveal = useReveal(); | ||
useEffect(() => { | ||
const updateStateOnCameraStop = (): void => { | ||
const currentCameraManagerState = reveal.cameraManager.getCameraState(); | ||
|
||
if ( | ||
externalCameraState !== undefined && | ||
isCameraStatesEqual(externalCameraState, currentCameraManagerState) | ||
) { | ||
return; | ||
} | ||
|
||
lastSetExternalState.current = { | ||
position: currentCameraManagerState.position.clone(), | ||
target: currentCameraManagerState.target.clone() | ||
}; | ||
|
||
setCameraState?.(currentCameraManagerState); | ||
}; | ||
|
||
reveal.cameraManager.on('cameraStop', updateStateOnCameraStop); | ||
return () => { | ||
reveal.cameraManager.off('cameraStop', updateStateOnCameraStop); | ||
}; | ||
}, [externalCameraState, setCameraState, lastSetExternalState]); | ||
}; | ||
|
||
function isCameraStatesEqual( | ||
previous: CameraStateParameters | undefined, | ||
current: CameraStateParameters | undefined | ||
): boolean { | ||
if (previous === undefined && current === undefined) { | ||
return true; | ||
} | ||
|
||
if (previous === undefined || current === undefined) { | ||
return false; | ||
} | ||
|
||
const epsilon = 0.001; | ||
const { position: previousPosition, target: previousTarget } = previous; | ||
const { position: currentPosition, target: currentTarget } = current; | ||
return ( | ||
previousPosition.distanceToSquared(currentPosition) <= epsilon && | ||
previousTarget.distanceToSquared(currentTarget) <= epsilon | ||
); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
56 changes: 0 additions & 56 deletions
56
react-components/src/higher-order-components/withCameraStateUrlParam.tsx
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
97 changes: 97 additions & 0 deletions
97
...t-components/tests/unit-tests/components/RevealCanvas/hooks/useCameraStateControl.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
import { describe, expect, test, vi, beforeEach, beforeAll, afterAll } from 'vitest'; | ||
|
||
import { renderHook } from '@testing-library/react'; | ||
|
||
import { viewerMock } from '../../../fixtures/viewer'; | ||
import { | ||
CameraStateParameters, | ||
useCameraStateControl | ||
} from '../../../../../src/components/RevealCanvas/hooks/useCameraStateControl'; | ||
import { Vector3 } from 'three'; | ||
import { cameraManagerGlobalCameraEvents } from '../../../fixtures/cameraManager'; | ||
|
||
vi.mock('../../../../../src/components/RevealCanvas/ViewerContext', () => ({ | ||
useReveal: () => viewerMock | ||
})); | ||
|
||
describe(useCameraStateControl.name, () => { | ||
beforeEach(() => { | ||
vi.resetAllMocks(); | ||
}); | ||
|
||
beforeAll(() => { | ||
vi.useFakeTimers(); | ||
}); | ||
|
||
afterAll(() => { | ||
vi.useRealTimers(); | ||
}); | ||
|
||
test('does nothing when inputs are undefined', () => { | ||
const { rerender } = renderHook(() => useCameraStateControl()); | ||
|
||
vi.runAllTimers(); | ||
rerender(); | ||
vi.runAllTimers(); | ||
|
||
cameraManagerGlobalCameraEvents.cameraStop.forEach((mockCallback) => | ||
expect(mockCallback).not.toBeCalled() | ||
); | ||
}); | ||
|
||
test('does nothing if external camera state is undefined', () => { | ||
const setter = vi.fn(); | ||
const { rerender } = renderHook(() => useCameraStateControl(undefined, setter)); | ||
|
||
vi.runAllTimers(); | ||
rerender(); | ||
vi.runAllTimers(); | ||
|
||
expect(setter).not.toBeCalled(); | ||
}); | ||
|
||
test('calls internal cameraStop delegates but not external setter on applying external camera state', () => { | ||
const setter = vi.fn<[CameraStateParameters | undefined], void>(); | ||
|
||
const { rerender } = renderHook( | ||
({ position }: { position: Vector3 }) => | ||
useCameraStateControl({ position: position.clone(), target: new Vector3(1, 1, 1) }, setter), | ||
{ initialProps: { position: new Vector3(0, 0, 0) } } | ||
); | ||
|
||
vi.runAllTimers(); | ||
rerender({ position: new Vector3(1, 0, 0) }); | ||
|
||
vi.runAllTimers(); | ||
expect(setter).not.toBeCalled(); | ||
|
||
cameraManagerGlobalCameraEvents.cameraStop.forEach((mockCallback) => | ||
expect(mockCallback).toBeCalledTimes(1) | ||
); | ||
}); | ||
|
||
test('provided setter is called after updating camera state internally', () => { | ||
const setter = vi.fn<[CameraStateParameters | undefined], void>(); | ||
|
||
const { rerender } = renderHook(() => | ||
useCameraStateControl( | ||
{ position: new Vector3(0, 0, 0), target: new Vector3(1, 1, 1) }, | ||
setter | ||
) | ||
); | ||
|
||
vi.runAllTimers(); | ||
|
||
viewerMock.cameraManager.setCameraState({ | ||
position: new Vector3(1, 0, 0), | ||
target: new Vector3(1, 1, 1) | ||
}); | ||
|
||
vi.runAllTimers(); | ||
|
||
rerender(); | ||
vi.runAllTimers(); | ||
|
||
expect(setter).toHaveBeenCalled(); | ||
}); | ||
}); |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be in
hooks
folder?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think so, the convention we have been using so far, is that hooks that are sort-of exposing values from a Context, are put together with that Context. That's how this hook was placed before this PR as well, in ViewerContext.ts