canvas3d.ts 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943
  1. /**
  2. * Copyright (c) 2018-2022 mol* contributors, licensed under MIT, See LICENSE file for more info.
  3. *
  4. * @author Alexander Rose <alexander.rose@weirdbyte.de>
  5. * @author David Sehnal <david.sehnal@gmail.com>
  6. * @author Gianluca Tomasello <giagitom@gmail.com>
  7. */
  8. import { BehaviorSubject, Subscription } from 'rxjs';
  9. import { now } from '../mol-util/now';
  10. import { Vec3, Vec2 } from '../mol-math/linear-algebra';
  11. import { InputObserver, ModifiersKeys, ButtonsType } from '../mol-util/input/input-observer';
  12. import { Renderer, RendererStats, RendererParams } from '../mol-gl/renderer';
  13. import { GraphicsRenderObject } from '../mol-gl/render-object';
  14. import { TrackballControls, TrackballControlsParams } from './controls/trackball';
  15. import { Viewport } from './camera/util';
  16. import { createContext, WebGLContext, getGLContext } from '../mol-gl/webgl/context';
  17. import { Representation } from '../mol-repr/representation';
  18. import { Scene } from '../mol-gl/scene';
  19. import { PickingId } from '../mol-geo/geometry/picking';
  20. import { MarkerAction } from '../mol-util/marker-action';
  21. import { Loci, EmptyLoci, isEmptyLoci } from '../mol-model/loci';
  22. import { Camera } from './camera';
  23. import { ParamDefinition as PD } from '../mol-util/param-definition';
  24. import { DebugHelperParams } from './helper/bounding-sphere-helper';
  25. import { SetUtils } from '../mol-util/set';
  26. import { Canvas3dInteractionHelper, Canvas3dInteractionHelperParams } from './helper/interaction-events';
  27. import { PostprocessingParams } from './passes/postprocessing';
  28. import { MultiSampleHelper, MultiSampleParams, MultiSamplePass } from './passes/multi-sample';
  29. import { PickData } from './passes/pick';
  30. import { PickHelper } from './passes/pick';
  31. import { ImagePass, ImageProps } from './passes/image';
  32. import { Sphere3D } from '../mol-math/geometry';
  33. import { isDebugMode, isTimingMode } from '../mol-util/debug';
  34. import { CameraHelperParams } from './helper/camera-helper';
  35. import { produce } from 'immer';
  36. import { HandleHelperParams } from './helper/handle-helper';
  37. import { StereoCamera, StereoCameraParams } from './camera/stereo';
  38. import { Helper } from './helper/helper';
  39. import { Passes } from './passes/passes';
  40. import { shallowEqual } from '../mol-util';
  41. import { MarkingParams } from './passes/marking';
  42. import { GraphicsRenderVariantsBlended, GraphicsRenderVariantsWboit, GraphicsRenderVariantsDpoit } from '../mol-gl/webgl/render-item';
  43. import { degToRad, radToDeg } from '../mol-math/misc';
  44. import { AssetManager } from '../mol-util/assets';
  45. import { deepClone } from '../mol-util/object';
  46. export const Canvas3DParams = {
  47. camera: PD.Group({
  48. mode: PD.Select('perspective', PD.arrayToOptions(['perspective', 'orthographic'] as const), { label: 'Camera' }),
  49. helper: PD.Group(CameraHelperParams, { isFlat: true }),
  50. stereo: PD.MappedStatic('off', {
  51. on: PD.Group(StereoCameraParams),
  52. off: PD.Group({})
  53. }, { cycle: true, hideIf: p => p?.mode !== 'perspective' }),
  54. fov: PD.Numeric(45, { min: 10, max: 130, step: 1 }, { label: 'Field of View' }),
  55. manualReset: PD.Boolean(false, { isHidden: true }),
  56. }, { pivot: 'mode' }),
  57. cameraFog: PD.MappedStatic('on', {
  58. on: PD.Group({
  59. intensity: PD.Numeric(15, { min: 1, max: 100, step: 1 }),
  60. }),
  61. off: PD.Group({})
  62. }, { cycle: true, description: 'Show fog in the distance' }),
  63. cameraClipping: PD.Group({
  64. radius: PD.Numeric(100, { min: 0, max: 99, step: 1 }, { label: 'Clipping', description: 'How much of the scene to show.' }),
  65. far: PD.Boolean(true, { description: 'Hide scene in the distance' }),
  66. minNear: PD.Numeric(5, { min: 0.1, max: 10, step: 0.1 }, { description: 'Note, may cause performance issues rendering impostors when set too small and cause issues with outline rendering when too close to 0.' }),
  67. }, { pivot: 'radius' }),
  68. viewport: PD.MappedStatic('canvas', {
  69. canvas: PD.Group({}),
  70. 'static-frame': PD.Group({
  71. x: PD.Numeric(0),
  72. y: PD.Numeric(0),
  73. width: PD.Numeric(128),
  74. height: PD.Numeric(128)
  75. }),
  76. 'relative-frame': PD.Group({
  77. x: PD.Numeric(0.33, { min: 0, max: 1, step: 0.01 }),
  78. y: PD.Numeric(0.33, { min: 0, max: 1, step: 0.01 }),
  79. width: PD.Numeric(0.5, { min: 0.01, max: 1, step: 0.01 }),
  80. height: PD.Numeric(0.5, { min: 0.01, max: 1, step: 0.01 })
  81. })
  82. }),
  83. cameraResetDurationMs: PD.Numeric(250, { min: 0, max: 1000, step: 1 }, { description: 'The time it takes to reset the camera.' }),
  84. sceneRadiusFactor: PD.Numeric(1, { min: 1, max: 10, step: 0.1 }),
  85. transparentBackground: PD.Boolean(false),
  86. dpoitIterations: PD.Numeric(2, { min: 1, max: 10, step: 1 }),
  87. multiSample: PD.Group(MultiSampleParams),
  88. postprocessing: PD.Group(PostprocessingParams),
  89. marking: PD.Group(MarkingParams),
  90. renderer: PD.Group(RendererParams),
  91. trackball: PD.Group(TrackballControlsParams),
  92. interaction: PD.Group(Canvas3dInteractionHelperParams),
  93. debug: PD.Group(DebugHelperParams),
  94. handle: PD.Group(HandleHelperParams),
  95. };
  96. export const DefaultCanvas3DParams = PD.getDefaultValues(Canvas3DParams);
  97. export type Canvas3DProps = PD.Values<typeof Canvas3DParams>
  98. export type PartialCanvas3DProps = {
  99. [K in keyof Canvas3DProps]?: Canvas3DProps[K] extends { name: string, params: any } ? Canvas3DProps[K] : Partial<Canvas3DProps[K]>
  100. }
  101. export { Canvas3DContext };
  102. /** Can be used to create multiple Canvas3D objects */
  103. interface Canvas3DContext {
  104. readonly canvas: HTMLCanvasElement
  105. readonly webgl: WebGLContext
  106. readonly input: InputObserver
  107. readonly passes: Passes
  108. readonly attribs: Readonly<Canvas3DContext.Attribs>
  109. readonly contextLost: BehaviorSubject<now.Timestamp>
  110. readonly contextRestored: BehaviorSubject<now.Timestamp>
  111. readonly assetManager: AssetManager
  112. dispose: (options?: Partial<{ doNotForceWebGLContextLoss: boolean }>) => void
  113. }
  114. namespace Canvas3DContext {
  115. export const DefaultAttribs = {
  116. powerPreference: 'high-performance' as WebGLContextAttributes['powerPreference'],
  117. failIfMajorPerformanceCaveat: false,
  118. /** true by default to avoid issues with Safari (Jan 2021) */
  119. antialias: true,
  120. /** true to support multiple Canvas3D objects with a single context */
  121. preserveDrawingBuffer: true,
  122. pixelScale: 1,
  123. pickScale: 0.25,
  124. /** extra pixels to around target to check in case target is empty */
  125. pickPadding: 1,
  126. enableWboit: true,
  127. enableDpoit: false,
  128. preferWebGl1: false
  129. };
  130. export type Attribs = typeof DefaultAttribs
  131. export function fromCanvas(canvas: HTMLCanvasElement, assetManager: AssetManager, attribs: Partial<Attribs> = {}): Canvas3DContext {
  132. const a = { ...DefaultAttribs, ...attribs };
  133. if (a.enableWboit && a.enableDpoit) throw new Error('Multiple transparency methods not allowed.');
  134. const { powerPreference, failIfMajorPerformanceCaveat, antialias, preserveDrawingBuffer, pixelScale, preferWebGl1 } = a;
  135. const gl = getGLContext(canvas, {
  136. powerPreference,
  137. failIfMajorPerformanceCaveat,
  138. antialias,
  139. preserveDrawingBuffer,
  140. alpha: true, // the renderer requires an alpha channel
  141. depth: true, // the renderer requires a depth buffer
  142. premultipliedAlpha: true, // the renderer outputs PMA
  143. preferWebGl1
  144. });
  145. if (gl === null) throw new Error('Could not create a WebGL rendering context');
  146. const input = InputObserver.fromElement(canvas, { pixelScale, preventGestures: true });
  147. const webgl = createContext(gl, { pixelScale });
  148. const passes = new Passes(webgl, assetManager, a);
  149. if (isDebugMode) {
  150. const loseContextExt = gl.getExtension('WEBGL_lose_context');
  151. if (loseContextExt) {
  152. // Hold down shift+ctrl+alt and press any mouse button to call `loseContext`.
  153. // After 1 second `restoreContext` will be called.
  154. canvas.addEventListener('mousedown', e => {
  155. if (webgl.isContextLost) return;
  156. if (!e.shiftKey || !e.ctrlKey || !e.altKey) return;
  157. if (isDebugMode) console.log('lose context');
  158. loseContextExt.loseContext();
  159. setTimeout(() => {
  160. if (!webgl.isContextLost) return;
  161. if (isDebugMode) console.log('restore context');
  162. loseContextExt.restoreContext();
  163. }, 1000);
  164. }, false);
  165. }
  166. }
  167. // https://www.khronos.org/webgl/wiki/HandlingContextLost
  168. const contextLost = new BehaviorSubject<now.Timestamp>(0 as now.Timestamp);
  169. const handleWebglContextLost = (e: Event) => {
  170. webgl.setContextLost();
  171. e.preventDefault();
  172. if (isDebugMode) console.log('context lost');
  173. contextLost.next(now());
  174. };
  175. const handlewWebglContextRestored = () => {
  176. if (!webgl.isContextLost) return;
  177. webgl.handleContextRestored(() => {
  178. passes.draw.reset();
  179. });
  180. if (isDebugMode) console.log('context restored');
  181. };
  182. canvas.addEventListener('webglcontextlost', handleWebglContextLost, false);
  183. canvas.addEventListener('webglcontextrestored', handlewWebglContextRestored, false);
  184. return {
  185. canvas,
  186. webgl,
  187. input,
  188. passes,
  189. attribs: a,
  190. contextLost,
  191. contextRestored: webgl.contextRestored,
  192. assetManager,
  193. dispose: (options?: Partial<{ doNotForceWebGLContextLoss: boolean }>) => {
  194. input.dispose();
  195. canvas.removeEventListener('webglcontextlost', handleWebglContextLost, false);
  196. canvas.removeEventListener('webglcontextrestored', handlewWebglContextRestored, false);
  197. webgl.destroy(options);
  198. }
  199. };
  200. }
  201. }
  202. export { Canvas3D };
  203. interface Canvas3D {
  204. readonly webgl: WebGLContext,
  205. add(repr: Representation.Any): void
  206. remove(repr: Representation.Any): void
  207. /**
  208. * This function must be called if animate() is not set up so that add/remove actions take place.
  209. */
  210. commit(isSynchronous?: boolean): void
  211. /**
  212. * Function for external "animation" control
  213. * Calls commit.
  214. */
  215. tick(t: now.Timestamp, options?: { isSynchronous?: boolean, manualDraw?: boolean }): void
  216. update(repr?: Representation.Any, keepBoundingSphere?: boolean): void
  217. clear(): void
  218. syncVisibility(): void
  219. requestDraw(): void
  220. /** Reset the timers, used by "animate" */
  221. resetTime(t: number): void
  222. animate(): void
  223. /**
  224. * Pause animation loop and optionally any rendering
  225. * @param noDraw pause any rendering (drawPaused = true)
  226. */
  227. pause(noDraw?: boolean): void
  228. /** Sets drawPaused = false without starting the built in animation loop */
  229. resume(): void
  230. identify(x: number, y: number): PickData | undefined
  231. mark(loci: Representation.Loci, action: MarkerAction): void
  232. getLoci(pickingId: PickingId | undefined): Representation.Loci
  233. notifyDidDraw: boolean,
  234. readonly didDraw: BehaviorSubject<now.Timestamp>
  235. readonly commited: BehaviorSubject<now.Timestamp>
  236. readonly reprCount: BehaviorSubject<number>
  237. readonly resized: BehaviorSubject<any>
  238. handleResize(): void
  239. /** performs handleResize on the next animation frame */
  240. requestResize(): void
  241. /** Focuses camera on scene's bounding sphere, centered and zoomed. */
  242. requestCameraReset(options?: { durationMs?: number, snapshot?: Camera.SnapshotProvider }): void
  243. readonly camera: Camera
  244. readonly boundingSphere: Readonly<Sphere3D>
  245. readonly boundingSphereVisible: Readonly<Sphere3D>
  246. setProps(props: PartialCanvas3DProps | ((old: Canvas3DProps) => Partial<Canvas3DProps> | void), doNotRequestDraw?: boolean /* = false */): void
  247. getImagePass(props: Partial<ImageProps>): ImagePass
  248. getRenderObjects(): GraphicsRenderObject[]
  249. /** Returns a copy of the current Canvas3D instance props */
  250. readonly props: Readonly<Canvas3DProps>
  251. readonly input: InputObserver
  252. readonly stats: RendererStats
  253. readonly interaction: Canvas3dInteractionHelper['events']
  254. dispose(): void
  255. }
  256. const requestAnimationFrame = typeof window !== 'undefined'
  257. ? window.requestAnimationFrame
  258. : (f: (time: number) => void) => setImmediate(() => f(Date.now())) as unknown as number;
  259. const cancelAnimationFrame = typeof window !== 'undefined'
  260. ? window.cancelAnimationFrame
  261. : (handle: number) => clearImmediate(handle as unknown as NodeJS.Immediate);
  262. namespace Canvas3D {
  263. export interface HoverEvent { current: Representation.Loci, buttons: ButtonsType, button: ButtonsType.Flag, modifiers: ModifiersKeys, page?: Vec2, position?: Vec3 }
  264. export interface DragEvent { current: Representation.Loci, buttons: ButtonsType, button: ButtonsType.Flag, modifiers: ModifiersKeys, pageStart: Vec2, pageEnd: Vec2 }
  265. export interface ClickEvent { current: Representation.Loci, buttons: ButtonsType, button: ButtonsType.Flag, modifiers: ModifiersKeys, page?: Vec2, position?: Vec3 }
  266. export function create({ webgl, input, passes, attribs, assetManager }: Canvas3DContext, props: Partial<Canvas3DProps> = {}): Canvas3D {
  267. const p: Canvas3DProps = { ...deepClone(DefaultCanvas3DParams), ...deepClone(props) };
  268. const reprRenderObjects = new Map<Representation.Any, Set<GraphicsRenderObject>>();
  269. const reprUpdatedSubscriptions = new Map<Representation.Any, Subscription>();
  270. const reprCount = new BehaviorSubject(0);
  271. let startTime = now();
  272. const didDraw = new BehaviorSubject<now.Timestamp>(0 as now.Timestamp);
  273. const commited = new BehaviorSubject<now.Timestamp>(0 as now.Timestamp);
  274. const { gl, contextRestored } = webgl;
  275. let x = 0;
  276. let y = 0;
  277. let width = 128;
  278. let height = 128;
  279. updateViewport();
  280. const scene = Scene.create(webgl, passes.draw.dpoitEnabled ? GraphicsRenderVariantsDpoit : (passes.draw.wboitEnabled ? GraphicsRenderVariantsWboit : GraphicsRenderVariantsBlended));
  281. function getSceneRadius() {
  282. return scene.boundingSphere.radius * p.sceneRadiusFactor;
  283. }
  284. const camera = new Camera({
  285. position: Vec3.create(0, 0, 100),
  286. mode: p.camera.mode,
  287. fog: p.cameraFog.name === 'on' ? p.cameraFog.params.intensity : 0,
  288. clipFar: p.cameraClipping.far,
  289. minNear: p.cameraClipping.minNear,
  290. fov: degToRad(p.camera.fov),
  291. }, { x, y, width, height }, { pixelScale: attribs.pixelScale });
  292. const stereoCamera = new StereoCamera(camera, p.camera.stereo.params);
  293. const controls = TrackballControls.create(input, camera, p.trackball);
  294. const renderer = Renderer.create(webgl, p.renderer);
  295. const helper = new Helper(webgl, scene, p);
  296. const pickHelper = new PickHelper(webgl, renderer, scene, helper, passes.pick, { x, y, width, height }, attribs.pickPadding);
  297. const interactionHelper = new Canvas3dInteractionHelper(identify, getLoci, input, camera, p.interaction);
  298. const multiSampleHelper = new MultiSampleHelper(passes.multiSample);
  299. passes.draw.postprocessing.background.update(camera, p.postprocessing.background, changed => {
  300. if (changed) requestDraw();
  301. });
  302. let cameraResetRequested = false;
  303. let nextCameraResetDuration: number | undefined = void 0;
  304. let nextCameraResetSnapshot: Camera.SnapshotProvider | undefined = void 0;
  305. let resizeRequested = false;
  306. let notifyDidDraw = true;
  307. function getLoci(pickingId: PickingId | undefined) {
  308. let loci: Loci = EmptyLoci;
  309. let repr: Representation.Any = Representation.Empty;
  310. if (pickingId) {
  311. const cameraHelperLoci = helper.camera.getLoci(pickingId);
  312. if (cameraHelperLoci !== EmptyLoci) return { loci: cameraHelperLoci, repr };
  313. loci = helper.handle.getLoci(pickingId);
  314. reprRenderObjects.forEach((_, _repr) => {
  315. const _loci = _repr.getLoci(pickingId);
  316. if (!isEmptyLoci(_loci)) {
  317. if (!isEmptyLoci(loci)) {
  318. console.warn('found another loci, this should not happen');
  319. }
  320. loci = _loci;
  321. repr = _repr;
  322. }
  323. });
  324. }
  325. return { loci, repr };
  326. }
  327. let markBuffer: [reprLoci: Representation.Loci, action: MarkerAction][] = [];
  328. function mark(reprLoci: Representation.Loci, action: MarkerAction) {
  329. // NOTE: might try to optimize a case with opposite actions for the
  330. // same loci. Tho this might end up being more expensive (and error prone)
  331. // then just applying everything "naively".
  332. markBuffer.push([reprLoci, action]);
  333. }
  334. function resolveMarking() {
  335. let changed = false;
  336. for (const [r, l] of markBuffer) {
  337. changed = applyMark(r, l) || changed;
  338. }
  339. markBuffer = [];
  340. if (changed) {
  341. scene.update(void 0, true);
  342. helper.handle.scene.update(void 0, true);
  343. helper.camera.scene.update(void 0, true);
  344. }
  345. return changed;
  346. }
  347. function applyMark(reprLoci: Representation.Loci, action: MarkerAction) {
  348. const { repr, loci } = reprLoci;
  349. let changed = false;
  350. if (repr) {
  351. changed = repr.mark(loci, action) || changed;
  352. } else {
  353. reprRenderObjects.forEach((_, _repr) => { changed = _repr.mark(loci, action) || changed; });
  354. }
  355. changed = helper.handle.mark(loci, action) || changed;
  356. changed = helper.camera.mark(loci, action) || changed;
  357. return changed;
  358. }
  359. function render(force: boolean) {
  360. if (webgl.isContextLost) return false;
  361. let resized = false;
  362. if (resizeRequested) {
  363. handleResize(false);
  364. resizeRequested = false;
  365. resized = true;
  366. }
  367. if (x > gl.drawingBufferWidth || x + width < 0 ||
  368. y > gl.drawingBufferHeight || y + height < 0
  369. ) return false;
  370. const markingUpdated = resolveMarking() && (renderer.props.colorMarker || p.marking.enabled);
  371. let didRender = false;
  372. controls.update(currentTime);
  373. const cameraChanged = camera.update();
  374. const shouldRender = force || cameraChanged || resized || forceNextRender;
  375. forceNextRender = false;
  376. const multiSampleChanged = multiSampleHelper.update(markingUpdated || shouldRender, p.multiSample);
  377. if (shouldRender || multiSampleChanged || markingUpdated) {
  378. let cam: Camera | StereoCamera = camera;
  379. if (p.camera.stereo.name === 'on') {
  380. stereoCamera.update();
  381. cam = stereoCamera;
  382. }
  383. if (isTimingMode) webgl.timer.mark('Canvas3D.render');
  384. const ctx = { renderer, camera: cam, scene, helper };
  385. if (MultiSamplePass.isEnabled(p.multiSample)) {
  386. const forceOn = !cameraChanged && markingUpdated && !controls.isAnimating;
  387. multiSampleHelper.render(ctx, p, true, forceOn);
  388. } else {
  389. passes.draw.render(ctx, p, true);
  390. }
  391. if (isTimingMode) webgl.timer.markEnd('Canvas3D.render');
  392. // if only marking has updated, do not set the flag to dirty
  393. pickHelper.dirty = pickHelper.dirty || shouldRender;
  394. didRender = true;
  395. }
  396. return didRender;
  397. }
  398. let forceNextRender = false;
  399. let forceDrawAfterAllCommited = false;
  400. let currentTime = 0;
  401. let drawPaused = false;
  402. function draw(options?: { force?: boolean }) {
  403. if (drawPaused) return;
  404. if (render(!!options?.force) && notifyDidDraw) {
  405. didDraw.next(now() - startTime as now.Timestamp);
  406. }
  407. }
  408. function requestDraw() {
  409. forceNextRender = true;
  410. }
  411. let animationFrameHandle = 0;
  412. function tick(t: now.Timestamp, options?: { isSynchronous?: boolean, manualDraw?: boolean }) {
  413. currentTime = t;
  414. commit(options?.isSynchronous);
  415. camera.transition.tick(currentTime);
  416. if (options?.manualDraw) {
  417. return;
  418. }
  419. draw();
  420. if (!camera.transition.inTransition && !webgl.isContextLost) {
  421. interactionHelper.tick(currentTime);
  422. }
  423. }
  424. function _animate() {
  425. tick(now());
  426. animationFrameHandle = requestAnimationFrame(_animate);
  427. }
  428. function resetTime(t: now.Timestamp) {
  429. startTime = t;
  430. controls.start(t);
  431. }
  432. function animate() {
  433. drawPaused = false;
  434. controls.start(now());
  435. if (animationFrameHandle === 0) _animate();
  436. }
  437. function pause(noDraw = false) {
  438. drawPaused = noDraw;
  439. cancelAnimationFrame(animationFrameHandle);
  440. animationFrameHandle = 0;
  441. }
  442. function identify(x: number, y: number): PickData | undefined {
  443. const cam = p.camera.stereo.name === 'on' ? stereoCamera : camera;
  444. return webgl.isContextLost ? undefined : pickHelper.identify(x, y, cam);
  445. }
  446. function commit(isSynchronous: boolean = false) {
  447. const allCommited = commitScene(isSynchronous);
  448. // Only reset the camera after the full scene has been commited.
  449. if (allCommited) {
  450. resolveCameraReset();
  451. if (forceDrawAfterAllCommited) {
  452. if (helper.debug.isEnabled) helper.debug.update();
  453. draw({ force: true });
  454. forceDrawAfterAllCommited = false;
  455. }
  456. commited.next(now());
  457. }
  458. }
  459. function resolveCameraReset() {
  460. if (!cameraResetRequested) return;
  461. const boundingSphere = scene.boundingSphereVisible;
  462. const { center, radius } = boundingSphere;
  463. const autoAdjustControls = controls.props.autoAdjustMinMaxDistance;
  464. if (autoAdjustControls.name === 'on') {
  465. const minDistance = autoAdjustControls.params.minDistanceFactor * radius + autoAdjustControls.params.minDistancePadding;
  466. const maxDistance = Math.max(autoAdjustControls.params.maxDistanceFactor * radius, autoAdjustControls.params.maxDistanceMin);
  467. controls.setProps({ minDistance, maxDistance });
  468. }
  469. if (radius > 0) {
  470. const duration = nextCameraResetDuration === undefined ? p.cameraResetDurationMs : nextCameraResetDuration;
  471. const focus = camera.getFocus(center, radius);
  472. const next = typeof nextCameraResetSnapshot === 'function' ? nextCameraResetSnapshot(scene, camera) : nextCameraResetSnapshot;
  473. const snapshot = next ? { ...focus, ...next } : focus;
  474. camera.setState({ ...snapshot, radiusMax: getSceneRadius() }, duration);
  475. }
  476. nextCameraResetDuration = void 0;
  477. nextCameraResetSnapshot = void 0;
  478. cameraResetRequested = false;
  479. }
  480. const oldBoundingSphereVisible = Sphere3D();
  481. const cameraSphere = Sphere3D();
  482. function shouldResetCamera() {
  483. if (camera.state.radiusMax === 0) return true;
  484. if (camera.transition.inTransition || nextCameraResetSnapshot) return false;
  485. let cameraSphereOverlapsNone = true, isEmpty = true;
  486. Sphere3D.set(cameraSphere, camera.state.target, camera.state.radius);
  487. // check if any renderable has moved outside of the old bounding sphere
  488. // and if no renderable is overlapping with the camera sphere
  489. for (const r of scene.renderables) {
  490. if (!r.state.visible) continue;
  491. const b = r.values.boundingSphere.ref.value;
  492. if (!b.radius) continue;
  493. isEmpty = false;
  494. const cameraDist = Vec3.distance(cameraSphere.center, b.center);
  495. if ((cameraDist > cameraSphere.radius || cameraDist > b.radius || b.radius > camera.state.radiusMax) && !Sphere3D.includes(oldBoundingSphereVisible, b)) return true;
  496. if (Sphere3D.overlaps(cameraSphere, b)) cameraSphereOverlapsNone = false;
  497. }
  498. return cameraSphereOverlapsNone || (!isEmpty && cameraSphere.radius <= 0.1);
  499. }
  500. const sceneCommitTimeoutMs = 250;
  501. function commitScene(isSynchronous: boolean) {
  502. if (!scene.needsCommit) return true;
  503. // snapshot the current bounding sphere of visible objects
  504. Sphere3D.copy(oldBoundingSphereVisible, scene.boundingSphereVisible);
  505. if (!scene.commit(isSynchronous ? void 0 : sceneCommitTimeoutMs)) return false;
  506. if (helper.debug.isEnabled) helper.debug.update();
  507. if (!p.camera.manualReset && (reprCount.value === 0 || shouldResetCamera())) {
  508. cameraResetRequested = true;
  509. }
  510. if (oldBoundingSphereVisible.radius === 0) nextCameraResetDuration = 0;
  511. if (!p.camera.manualReset) camera.setState({ radiusMax: getSceneRadius() }, 0);
  512. reprCount.next(reprRenderObjects.size);
  513. if (isDebugMode) consoleStats();
  514. return true;
  515. }
  516. function consoleStats() {
  517. console.table(scene.renderables.map(r => ({
  518. drawCount: r.values.drawCount.ref.value,
  519. instanceCount: r.values.instanceCount.ref.value,
  520. materialId: r.materialId,
  521. renderItemId: r.id,
  522. })));
  523. console.log(webgl.stats);
  524. const { texture, attribute, elements } = webgl.resources.getByteCounts();
  525. console.log({
  526. texture: `${(texture / 1024 / 1024).toFixed(3)} MiB`,
  527. attribute: `${(attribute / 1024 / 1024).toFixed(3)} MiB`,
  528. elements: `${(elements / 1024 / 1024).toFixed(3)} MiB`,
  529. });
  530. }
  531. function add(repr: Representation.Any) {
  532. registerAutoUpdate(repr);
  533. const oldRO = reprRenderObjects.get(repr);
  534. const newRO = new Set<GraphicsRenderObject>();
  535. repr.renderObjects.forEach(o => newRO.add(o));
  536. if (oldRO) {
  537. if (!SetUtils.areEqual(newRO, oldRO)) {
  538. newRO.forEach(o => { if (!oldRO.has(o)) scene.add(o); });
  539. oldRO.forEach(o => { if (!newRO.has(o)) scene.remove(o); });
  540. }
  541. } else {
  542. repr.renderObjects.forEach(o => scene.add(o));
  543. }
  544. reprRenderObjects.set(repr, newRO);
  545. scene.update(repr.renderObjects, false);
  546. forceDrawAfterAllCommited = true;
  547. if (isDebugMode) consoleStats();
  548. }
  549. function remove(repr: Representation.Any) {
  550. unregisterAutoUpdate(repr);
  551. const renderObjects = reprRenderObjects.get(repr);
  552. if (renderObjects) {
  553. renderObjects.forEach(o => scene.remove(o));
  554. reprRenderObjects.delete(repr);
  555. forceDrawAfterAllCommited = true;
  556. if (isDebugMode) consoleStats();
  557. }
  558. }
  559. function registerAutoUpdate(repr: Representation.Any) {
  560. if (reprUpdatedSubscriptions.has(repr)) return;
  561. reprUpdatedSubscriptions.set(repr, repr.updated.subscribe(_ => {
  562. if (!repr.state.syncManually) add(repr);
  563. }));
  564. }
  565. function unregisterAutoUpdate(repr: Representation.Any) {
  566. const updatedSubscription = reprUpdatedSubscriptions.get(repr);
  567. if (updatedSubscription) {
  568. updatedSubscription.unsubscribe();
  569. reprUpdatedSubscriptions.delete(repr);
  570. }
  571. }
  572. function getProps(): Canvas3DProps {
  573. const radius = scene.boundingSphere.radius > 0
  574. ? 100 - Math.round((camera.transition.target.radius / getSceneRadius()) * 100)
  575. : 0;
  576. return {
  577. camera: {
  578. mode: camera.state.mode,
  579. helper: { ...helper.camera.props },
  580. stereo: { ...p.camera.stereo },
  581. fov: Math.round(radToDeg(camera.state.fov)),
  582. manualReset: !!p.camera.manualReset
  583. },
  584. cameraFog: camera.state.fog > 0
  585. ? { name: 'on' as const, params: { intensity: camera.state.fog } }
  586. : { name: 'off' as const, params: {} },
  587. cameraClipping: { far: camera.state.clipFar, radius, minNear: camera.state.minNear },
  588. cameraResetDurationMs: p.cameraResetDurationMs,
  589. sceneRadiusFactor: p.sceneRadiusFactor,
  590. transparentBackground: p.transparentBackground,
  591. dpoitIterations: p.dpoitIterations,
  592. viewport: p.viewport,
  593. postprocessing: { ...p.postprocessing },
  594. marking: { ...p.marking },
  595. multiSample: { ...p.multiSample },
  596. renderer: { ...renderer.props },
  597. trackball: { ...controls.props },
  598. interaction: { ...interactionHelper.props },
  599. debug: { ...helper.debug.props },
  600. handle: { ...helper.handle.props },
  601. };
  602. }
  603. const contextRestoredSub = contextRestored.subscribe(() => {
  604. pickHelper.dirty = true;
  605. draw({ force: true });
  606. // Unclear why, but in Chrome with wboit enabled the first `draw` only clears
  607. // the drawingBuffer. Note that in Firefox the drawingBuffer is preserved after
  608. // context loss so it is unclear if it behaves the same.
  609. draw({ force: true });
  610. });
  611. const resized = new BehaviorSubject<any>(0);
  612. function handleResize(draw = true) {
  613. passes.updateSize();
  614. updateViewport();
  615. syncViewport();
  616. if (draw) requestDraw();
  617. resized.next(+new Date());
  618. }
  619. return {
  620. webgl,
  621. add,
  622. remove,
  623. commit,
  624. update: (repr, keepSphere) => {
  625. if (repr) {
  626. if (!reprRenderObjects.has(repr)) return;
  627. scene.update(repr.renderObjects, !!keepSphere);
  628. } else {
  629. scene.update(void 0, !!keepSphere);
  630. }
  631. forceDrawAfterAllCommited = true;
  632. },
  633. clear: () => {
  634. reprUpdatedSubscriptions.forEach(v => v.unsubscribe());
  635. reprUpdatedSubscriptions.clear();
  636. reprRenderObjects.clear();
  637. scene.clear();
  638. helper.debug.clear();
  639. requestDraw();
  640. reprCount.next(reprRenderObjects.size);
  641. },
  642. syncVisibility: () => {
  643. if (camera.state.radiusMax === 0) {
  644. cameraResetRequested = true;
  645. nextCameraResetDuration = 0;
  646. }
  647. if (scene.syncVisibility()) {
  648. if (helper.debug.isEnabled) helper.debug.update();
  649. }
  650. requestDraw();
  651. },
  652. requestDraw,
  653. tick,
  654. animate,
  655. resetTime,
  656. pause,
  657. resume: () => { drawPaused = false; },
  658. identify,
  659. mark,
  660. getLoci,
  661. handleResize,
  662. requestResize: () => {
  663. resizeRequested = true;
  664. },
  665. requestCameraReset: options => {
  666. nextCameraResetDuration = options?.durationMs;
  667. nextCameraResetSnapshot = options?.snapshot;
  668. cameraResetRequested = true;
  669. },
  670. camera,
  671. boundingSphere: scene.boundingSphere,
  672. boundingSphereVisible: scene.boundingSphereVisible,
  673. get notifyDidDraw() { return notifyDidDraw; },
  674. set notifyDidDraw(v: boolean) { notifyDidDraw = v; },
  675. didDraw,
  676. commited,
  677. reprCount,
  678. resized,
  679. setProps: (properties, doNotRequestDraw = false) => {
  680. const props: PartialCanvas3DProps = typeof properties === 'function'
  681. ? produce(getProps(), properties as any)
  682. : properties;
  683. if (props.sceneRadiusFactor !== undefined) {
  684. p.sceneRadiusFactor = props.sceneRadiusFactor;
  685. camera.setState({ radiusMax: getSceneRadius() }, 0);
  686. }
  687. const cameraState: Partial<Camera.Snapshot> = Object.create(null);
  688. if (props.camera && props.camera.mode !== undefined && props.camera.mode !== camera.state.mode) {
  689. cameraState.mode = props.camera.mode;
  690. }
  691. const oldFov = Math.round(radToDeg(camera.state.fov));
  692. if (props.camera && props.camera.fov !== undefined && props.camera.fov !== oldFov) {
  693. cameraState.fov = degToRad(props.camera.fov);
  694. }
  695. if (props.cameraFog !== undefined && props.cameraFog.params) {
  696. const newFog = props.cameraFog.name === 'on' ? props.cameraFog.params.intensity : 0;
  697. if (newFog !== camera.state.fog) cameraState.fog = newFog;
  698. }
  699. if (props.cameraClipping !== undefined) {
  700. if (props.cameraClipping.far !== undefined && props.cameraClipping.far !== camera.state.clipFar) {
  701. cameraState.clipFar = props.cameraClipping.far;
  702. }
  703. if (props.cameraClipping.minNear !== undefined && props.cameraClipping.minNear !== camera.state.minNear) {
  704. cameraState.minNear = props.cameraClipping.minNear;
  705. }
  706. if (props.cameraClipping.radius !== undefined) {
  707. const radius = (getSceneRadius() / 100) * (100 - props.cameraClipping.radius);
  708. if (radius > 0 && radius !== cameraState.radius) {
  709. // if radius = 0, NaNs happen
  710. cameraState.radius = Math.max(radius, 0.01);
  711. }
  712. }
  713. }
  714. if (Object.keys(cameraState).length > 0) camera.setState(cameraState);
  715. if (props.camera?.helper) helper.camera.setProps(props.camera.helper);
  716. if (props.camera?.manualReset !== undefined) p.camera.manualReset = props.camera.manualReset;
  717. if (props.camera?.stereo !== undefined) {
  718. Object.assign(p.camera.stereo, props.camera.stereo);
  719. stereoCamera.setProps(p.camera.stereo.params);
  720. }
  721. if (props.cameraResetDurationMs !== undefined) p.cameraResetDurationMs = props.cameraResetDurationMs;
  722. if (props.transparentBackground !== undefined) p.transparentBackground = props.transparentBackground;
  723. if (props.dpoitIterations !== undefined) p.dpoitIterations = props.dpoitIterations;
  724. if (props.viewport !== undefined) {
  725. const doNotUpdate = p.viewport === props.viewport ||
  726. (p.viewport.name === props.viewport.name && shallowEqual(p.viewport.params, props.viewport.params));
  727. if (!doNotUpdate) {
  728. p.viewport = props.viewport;
  729. updateViewport();
  730. syncViewport();
  731. }
  732. }
  733. if (props.postprocessing?.background) {
  734. Object.assign(p.postprocessing.background, props.postprocessing.background);
  735. passes.draw.postprocessing.background.update(camera, p.postprocessing.background, changed => {
  736. if (changed && !doNotRequestDraw) requestDraw();
  737. });
  738. }
  739. if (props.postprocessing) Object.assign(p.postprocessing, props.postprocessing);
  740. if (props.marking) Object.assign(p.marking, props.marking);
  741. if (props.multiSample) Object.assign(p.multiSample, props.multiSample);
  742. if (props.renderer) renderer.setProps(props.renderer);
  743. if (props.trackball) controls.setProps(props.trackball);
  744. if (props.interaction) interactionHelper.setProps(props.interaction);
  745. if (props.debug) helper.debug.setProps(props.debug);
  746. if (props.handle) helper.handle.setProps(props.handle);
  747. if (cameraState.mode === 'orthographic') {
  748. p.camera.stereo.name = 'off';
  749. }
  750. if (!doNotRequestDraw) {
  751. requestDraw();
  752. }
  753. },
  754. getImagePass: (props: Partial<ImageProps> = {}) => {
  755. return new ImagePass(webgl, assetManager, renderer, scene, camera, helper, passes.draw.wboitEnabled, passes.draw.dpoitEnabled, props);
  756. },
  757. getRenderObjects(): GraphicsRenderObject[] {
  758. const renderObjects: GraphicsRenderObject[] = [];
  759. scene.forEach((_, ro) => renderObjects.push(ro));
  760. return renderObjects;
  761. },
  762. get props() {
  763. return getProps();
  764. },
  765. get input() {
  766. return input;
  767. },
  768. get stats() {
  769. return renderer.stats;
  770. },
  771. get interaction() {
  772. return interactionHelper.events;
  773. },
  774. dispose: () => {
  775. contextRestoredSub.unsubscribe();
  776. markBuffer = [];
  777. scene.clear();
  778. helper.debug.clear();
  779. controls.dispose();
  780. renderer.dispose();
  781. interactionHelper.dispose();
  782. }
  783. };
  784. function updateViewport() {
  785. const oldX = x, oldY = y, oldWidth = width, oldHeight = height;
  786. if (p.viewport.name === 'canvas') {
  787. x = 0;
  788. y = 0;
  789. width = gl.drawingBufferWidth;
  790. height = gl.drawingBufferHeight;
  791. } else if (p.viewport.name === 'static-frame') {
  792. x = p.viewport.params.x * webgl.pixelRatio;
  793. height = p.viewport.params.height * webgl.pixelRatio;
  794. y = gl.drawingBufferHeight - height - p.viewport.params.y * webgl.pixelRatio;
  795. width = p.viewport.params.width * webgl.pixelRatio;
  796. } else if (p.viewport.name === 'relative-frame') {
  797. x = Math.round(p.viewport.params.x * gl.drawingBufferWidth);
  798. height = Math.round(p.viewport.params.height * gl.drawingBufferHeight);
  799. y = Math.round(gl.drawingBufferHeight - height - p.viewport.params.y * gl.drawingBufferHeight);
  800. width = Math.round(p.viewport.params.width * gl.drawingBufferWidth);
  801. }
  802. if (oldX !== x || oldY !== y || oldWidth !== width || oldHeight !== height) {
  803. forceNextRender = true;
  804. }
  805. }
  806. function syncViewport() {
  807. pickHelper.setViewport(x, y, width, height);
  808. renderer.setViewport(x, y, width, height);
  809. Viewport.set(camera.viewport, x, y, width, height);
  810. Viewport.set(controls.viewport, x, y, width, height);
  811. }
  812. }
  813. }