-
Notifications
You must be signed in to change notification settings - Fork 687
/
GizmoHelper.tsx
162 lines (137 loc) · 4.94 KB
/
GizmoHelper.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
import * as React from 'react'
import { createPortal, useFrame, useThree } from '@react-three/fiber'
import {
Camera,
Color,
Group,
Intersection,
Matrix4,
Object3D,
Quaternion,
Raycaster,
Scene,
Texture,
Vector3,
} from 'three'
import { OrthographicCamera } from './OrthographicCamera'
import { useCamera } from './useCamera'
type GizmoHelperContext = {
tweenCamera: (direction: Vector3) => void
raycast: (raycaster: Raycaster, intersects: Intersection[]) => void
}
const Context = React.createContext<GizmoHelperContext>({} as GizmoHelperContext)
export const useGizmoContext = () => {
return React.useContext<GizmoHelperContext>(Context)
}
const turnRate = 2 * Math.PI // turn rate in angles per second
const dummy = new Object3D()
const matrix = new Matrix4()
const [q1, q2] = [new Quaternion(), new Quaternion()]
const target = new Vector3()
const targetPosition = new Vector3()
type ControlsProto = { update(): void; target: THREE.Vector3 }
export type GizmoHelperProps = JSX.IntrinsicElements['group'] & {
alignment?: 'top-left' | 'top-right' | 'bottom-right' | 'bottom-left'
margin?: [number, number]
onUpdate?: () => void // update controls during animation
// TODO: in a new major state.controls should be the only means of consuming controls, the
// onTarget prop can then be removed!
onTarget?: () => Vector3 // return the target to rotate around
}
export const GizmoHelper = ({
alignment = 'bottom-right',
margin = [80, 80],
onUpdate,
onTarget,
children: GizmoHelperComponent,
}: GizmoHelperProps): any => {
const size = useThree(({ size }) => size)
const mainCamera = useThree(({ camera }) => camera)
// @ts-expect-error new in @react-three/fiber@7.0.5
const defaultControls = useThree(({ controls }) => controls) as ControlsProto
const gl = useThree(({ gl }) => gl)
const scene = useThree(({ scene }) => scene)
const invalidate = useThree(({ invalidate }) => invalidate)
const backgroundRef = React.useRef<null | Color | Texture>()
const gizmoRef = React.useRef<Group>()
const virtualCam = React.useRef<Camera>(null!)
const [virtualScene] = React.useState(() => new Scene())
const animating = React.useRef(false)
const radius = React.useRef(0)
const focusPoint = React.useRef(new Vector3(0, 0, 0))
const tweenCamera = (direction: Vector3) => {
animating.current = true
if (defaultControls || onTarget) focusPoint.current = defaultControls?.target || onTarget?.()
radius.current = mainCamera.position.distanceTo(target)
// Rotate from current camera orientation
q1.copy(mainCamera.quaternion)
// To new current camera orientation
targetPosition.copy(direction).multiplyScalar(radius.current).add(target)
dummy.lookAt(targetPosition)
q2.copy(dummy.quaternion)
invalidate()
}
const animateStep = (delta: number) => {
if (!animating.current) return
if (q1.angleTo(q2) < 0.01) {
animating.current = false
return
}
const step = delta * turnRate
// animate position by doing a slerp and then scaling the position on the unit sphere
q1.rotateTowards(q2, step)
// animate orientation
mainCamera.position.set(0, 0, 1).applyQuaternion(q1).multiplyScalar(radius.current).add(focusPoint.current)
mainCamera.up.set(0, 1, 0).applyQuaternion(q1).normalize()
mainCamera.quaternion.copy(q1)
if (onUpdate) onUpdate()
else if (defaultControls) defaultControls.update()
invalidate()
}
React.useEffect(() => {
if (scene.background) {
//Interchange the actual scene background with the virtual scene
backgroundRef.current = scene.background
scene.background = null
virtualScene.background = backgroundRef.current
}
return () => {
// reset on unmount
if (backgroundRef.current) {
scene.background = backgroundRef.current
}
}
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [])
const beforeRender = () => {
// Sync gizmo with main camera orientation
matrix.copy(mainCamera.matrix).invert()
gizmoRef.current?.quaternion.setFromRotationMatrix(matrix)
}
useFrame((_, delta) => {
if (virtualCam.current && gizmoRef.current) {
animateStep(delta)
beforeRender()
gl.autoClear = false
gl.clearDepth()
gl.render(virtualScene, virtualCam.current)
}
})
const gizmoHelperContext = {
tweenCamera,
raycast: useCamera(virtualCam),
}
// Position gizmo component within scene
const [marginX, marginY] = margin
const x = alignment.endsWith('-left') ? -size.width / 2 + marginX : size.width / 2 - marginX
const y = alignment.startsWith('top-') ? size.height / 2 - marginY : -size.height / 2 + marginY
return createPortal(
<Context.Provider value={gizmoHelperContext}>
<OrthographicCamera ref={virtualCam} makeDefault={false} position={[0, 0, 200]} />
<group ref={gizmoRef} position={[x, y, 0]}>
{GizmoHelperComponent}
</group>
</Context.Provider>,
virtualScene
)
}