abstract-3d 4.0.0-beta.7 → 4.0.0-beta.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/README.md +32 -0
  2. package/lib/abstract-3d.d.ts +6 -1
  3. package/lib/abstract-3d.d.ts.map +1 -1
  4. package/lib/abstract-3d.js +24 -2
  5. package/lib/abstract-3d.js.map +1 -1
  6. package/lib/renderers/react/react.d.ts.map +1 -1
  7. package/lib/renderers/react/react.js +7 -1
  8. package/lib/renderers/react/react.js.map +1 -1
  9. package/lib/renderers/three/build/materials.d.ts.map +1 -1
  10. package/lib/renderers/three/build/materials.js +43 -14
  11. package/lib/renderers/three/build/materials.js.map +1 -1
  12. package/lib/renderers/three/environment/studio.d.ts +3 -2
  13. package/lib/renderers/three/environment/studio.d.ts.map +1 -1
  14. package/lib/renderers/three/environment/studio.js +4 -3
  15. package/lib/renderers/three/environment/studio.js.map +1 -1
  16. package/lib/renderers/three/geometry/geometry.d.ts.map +1 -1
  17. package/lib/renderers/three/geometry/geometry.js +11 -5
  18. package/lib/renderers/three/geometry/geometry.js.map +1 -1
  19. package/lib/renderers/three/shadow/key-light.d.ts.map +1 -1
  20. package/lib/renderers/three/shadow/key-light.js +4 -2
  21. package/lib/renderers/three/shadow/key-light.js.map +1 -1
  22. package/lib/renderers/three/viewer/options.d.ts +1 -1
  23. package/lib/renderers/three/viewer/viewer.d.ts +5 -0
  24. package/lib/renderers/three/viewer/viewer.d.ts.map +1 -1
  25. package/lib/renderers/three/viewer/viewer.js +29 -6
  26. package/lib/renderers/three/viewer/viewer.js.map +1 -1
  27. package/package.json +1 -1
  28. package/src/abstract-3d.ts +30 -2
  29. package/src/renderers/react/react.tsx +12 -2
  30. package/src/renderers/three/build/materials.ts +46 -14
  31. package/src/renderers/three/environment/studio.ts +4 -3
  32. package/src/renderers/three/geometry/geometry.test.ts +17 -5
  33. package/src/renderers/three/geometry/geometry.ts +12 -5
  34. package/src/renderers/three/shadow/key-light.ts +4 -2
  35. package/src/renderers/three/viewer/options.ts +1 -1
  36. package/src/renderers/three/viewer/viewer.ts +32 -6
@@ -17,7 +17,12 @@ const bounds = (mesh: Mesh): ReadonlyArray<number> => {
17
17
  return [...geometry.boundingBox!.min.toArray(), ...geometry.boundingBox!.max.toArray()].map((v) => Math.round(v * 1000) / 1000 + 0);
18
18
  };
19
19
 
20
- const bevel = (mesh: Mesh): ReadonlyArray<number> => [...new Set(createSolidGeometry(mesh.geometry).getAttribute("bevel").array)];
20
+ /** The radius and joined sides' bits, the same for every vertex */
21
+ const bevel = (mesh: Mesh): ReadonlyArray<number> => {
22
+ const attribute = createSolidGeometry(mesh.geometry).getAttribute("bevel");
23
+ const pairs = new Set(Array.from({ length: attribute.count }, (_, i) => `${attribute.getX(i)} ${attribute.getY(i)}`));
24
+ return [...pairs].flatMap((pair) => pair.split(" ").map(Number));
25
+ };
21
26
 
22
27
  describe("getSolidShape", () => {
23
28
  it("shares unit geometries between primitives of any size, scaled by the local matrix", () => {
@@ -81,15 +86,22 @@ describe("createSolidGeometry", () => {
81
86
  });
82
87
 
83
88
  it("gives boxes with a radius it as the radius their edges are shaded rounded by, with a geometry per radius", () => {
84
- expect(bevel(box(vec3(1, 1, 1), m, vec3Zero, vec3Zero, [], 4))).toEqual([4]);
89
+ expect(bevel(box(vec3(1, 1, 1), m, vec3Zero, vec3Zero, [], 4))).toEqual([4, 2 ** 12 - 1]);
85
90
  expect(key(box(vec3(1, 1, 1), m, vec3Zero, vec3Zero, [], 4))).toBe(key(box(vec3(9, 9, 9), m, vec3Zero, vec3Zero, [], 4)));
86
91
  expect(key(box(vec3(1, 1, 1), m, vec3Zero, vec3Zero, [], 4))).not.toBe(key(box(vec3(1, 1, 1), m)));
87
92
  });
88
93
 
94
+ it("rounds all edges of boxes with a radius, or only their rounded edges, a bit each in the order of boxEdges, with a geometry per edges", () => {
95
+ expect(bevel(box(vec3(1, 1, 1), m, vec3Zero, vec3Zero, [], 4, ["BottomBack", "FrontRight", "TopRight"]))).toEqual([4, 1 + 2 ** 7 + 2 ** 11]);
96
+ expect(bevel(box(vec3(1, 1, 1), m, vec3Zero, vec3Zero, [], 4, []))).toEqual([4, 0]);
97
+ expect(key(box(vec3(1, 1, 1), m, vec3Zero, vec3Zero, [], 4, ["TopFront"]))).not.toBe(key(box(vec3(1, 1, 1), m, vec3Zero, vec3Zero, [], 4)));
98
+ });
99
+
89
100
  it("keeps boxes without a radius, with holes, and other shapes sharp", () => {
90
- expect(bevel(box(vec3(1, 1, 1), m))).toEqual([0]);
91
- expect(bevel(box(vec3(1, 1, 1), m, vec3Zero, vec3Zero, [roundHole(vec2(0, 0), 0.1)], 4))).toEqual([0]);
92
- expect(bevel(sphere(1, m))).toEqual([0]);
101
+ expect(bevel(box(vec3(1, 1, 1), m))).toEqual([0, 0]);
102
+ expect(bevel(box(vec3(1, 1, 1), m, vec3Zero, vec3Zero, [], undefined, ["TopFront"]))).toEqual([0, 0]);
103
+ expect(bevel(box(vec3(1, 1, 1), m, vec3Zero, vec3Zero, [roundHole(vec2(0, 0), 0.1)], 4))).toEqual([0, 0]);
104
+ expect(bevel(sphere(1, m))).toEqual([0, 0]);
93
105
  });
94
106
  });
95
107
 
@@ -16,7 +16,7 @@ import {
16
16
  } from "three";
17
17
  import { mergeGeometries } from "three/addons/utils/BufferGeometryUtils.js";
18
18
  import type { Hole, Mesh } from "../../../abstract-3d.js";
19
- import { isZero, vec3, vec3Zero } from "../../../abstract-3d.js";
19
+ import { boxEdges, isZero, vec3, vec3Zero } from "../../../abstract-3d.js";
20
20
  import { addHoles, CircleCurve, CYLINDER_SEGMENTS, cylinderCutPositions, holeIsZero } from "../../shared/three-geometry.js";
21
21
  import { transform } from "../compile/compile.js";
22
22
 
@@ -42,7 +42,10 @@ export function getSolidShape(g: Mesh["geometry"]): SolidShape | undefined {
42
42
  const size = g.type === "Box" ? g.size : vec3(g.size.x, g.size.y, 1);
43
43
  return g.holes?.some((h) => !holeIsZero(h))
44
44
  ? { key: JSON.stringify([g.type, g.size, g.holes]), local: transform(g.pos, g.rot) }
45
- : { key: g.type === "Box" && g.radius ? `Box ${g.radius}` : g.type, local: transform(g.pos, g.rot, undefined, size) };
45
+ : {
46
+ key: g.type === "Box" && g.radius ? `Box ${g.radius} ${g.roundedEdges?.join() ?? ""}` : g.type,
47
+ local: transform(g.pos, g.rot, undefined, size),
48
+ };
46
49
  }
47
50
  case "Image":
48
51
  return { key: "Plane", local: transform(g.pos, g.rot, undefined, vec3(g.size.x, g.size.y, 1)) };
@@ -86,9 +89,13 @@ export function createSolidGeometry(g: Mesh["geometry"]): BufferGeometry {
86
89
  if (!geometry.hasAttribute("uv")) {
87
90
  geometry.setAttribute("uv", new Float32BufferAttribute(new Float32Array(count * 2), 2));
88
91
  }
89
- // The radius a unit box's edges are shaded as rounded by, 0 for sharp; every geometry has it, as a batch's geometries share their attributes
90
- const radius = geometry instanceof BoxGeometry && g.type === "Box" ? (g.radius ?? 0) : 0;
91
- geometry.setAttribute("bevel", new Float32BufferAttribute(new Float32Array(count).fill(radius), 1));
92
+ // The radius a unit box's edges are shaded as rounded by, 0 for sharp, and a bit per rounded edge, in the order of `boxEdges`; every geometry has
93
+ // it, as a batch's geometries share their attributes
94
+ const bevel =
95
+ geometry instanceof BoxGeometry && g.type === "Box" && g.radius
96
+ ? [g.radius, boxEdges.reduce((edges, edge, i) => ((g.roundedEdges?.includes(edge) ?? true) ? edges + 2 ** i : edges), 0)]
97
+ : [0, 0];
98
+ geometry.setAttribute("bevel", new Float32BufferAttribute(Array.from({ length: count }, () => bevel).flat(), 2));
92
99
  Object.keys(geometry.attributes).forEach((name) => {
93
100
  if (name !== "position" && name !== "normal" && name !== "uv" && name !== "bevel") {
94
101
  geometry.deleteAttribute(name);
@@ -8,8 +8,10 @@ import { getShadowCasters } from "./shadow.js";
8
8
  */
9
9
 
10
10
  const direction = new Vector3(-1, 2, 1.2).normalize();
11
- const intensity = 3.5;
11
+ const intensity = 1.6;
12
12
  const mapSize = 2048;
13
+ /** Of the key light kept out of its shadows, so faces under an overhang, e.g. a recessed base frame, aren't black */
14
+ const shadowIntensity = 0.6;
13
15
 
14
16
  /** The light and its target, to add to the scene, with or without shadows; undefined for a scene without solids */
15
17
  export function createKeyLight(built: BuiltScene, shadows: boolean): Group | undefined {
@@ -27,7 +29,7 @@ export function createKeyLight(built: BuiltScene, shadows: boolean): Group | und
27
29
  light.shadow.camera.updateProjectionMatrix();
28
30
  light.shadow.mapSize.set(mapSize, mapSize);
29
31
  // Offsets along the normal by three texels, against shadow acne on the lit faces
30
- Object.assign(light.shadow, { bias: -0.0005, normalBias: (radius * 6) / mapSize, radius: 3 });
32
+ Object.assign(light.shadow, { bias: -0.0005, normalBias: (radius * 6) / mapSize, radius: 3, intensity: shadowIntensity });
31
33
  return new Group().add(light, light.target);
32
34
  }
33
35
 
@@ -43,7 +43,7 @@ export type ViewerOptions<Content> = {
43
43
  readonly gizmo?: ControlsHelper;
44
44
  /** Lights added to the photographed studio and key light that light the scene; none by default */
45
45
  readonly lights?: ReadonlyArray<Object3D> | ((scene: Scene) => ReadonlyArray<Object3D>);
46
- /** Of the studio's light, 0.5 by default, the key light giving the rest */
46
+ /** Of the studio's light, 0.8 by default, the key light giving the rest */
47
47
  readonly environmentIntensity?: number;
48
48
  /** A soft shadow on the ground under the scene, rendered once per build; on by default */
49
49
  readonly groundShadow?: boolean;
@@ -71,6 +71,8 @@ export type Viewer<Content> = {
71
71
  structure: StructureState;
72
72
  compiled?: CompiledScene;
73
73
  built?: BuiltScene;
74
+ /** The previous build and ground shadow, out of the scene, disposed once the next frame has given their shader programs to the new ones */
75
+ readonly retired: { built?: BuiltScene; shadow?: GroundShadow };
74
76
  gizmo?: ViewportGizmo;
75
77
  shadow?: GroundShadow;
76
78
  /** The key light that casts the solids' shadows on themselves */
@@ -127,11 +129,14 @@ export function createViewer<Content>(container: HTMLElement, options: ViewerOpt
127
129
  stats: { frames: 0, frameMs: 0, drawCalls: 0, pickMs: 0, paintMs: 0 },
128
130
  structure: { activeComponents: options.activeComponents, relationsActive: options.activeRelations !== undefined },
129
131
  studio: {},
132
+ retired: {},
130
133
  loaded: false,
131
134
  fitted: false,
132
135
  disposed: false,
133
136
  };
134
137
  v.scene.add(v.lights);
138
+ // Loaded while the first frame builds the scene
139
+ loadStudio(v).catch(() => undefined);
135
140
  const signal = { signal: v.listeners.signal };
136
141
  canvas.addEventListener("pointermove", (e) => onPointerMove(v, e), signal);
137
142
  canvas.addEventListener("pointerleave", (e) => setHovered(v, undefined, e), signal);
@@ -164,6 +169,7 @@ export function disposeViewer<Content>(v: Viewer<Content>): void {
164
169
  v.resizeObserver.disconnect();
165
170
  v.controls.orbit.dispose();
166
171
  v.gizmo?.dispose();
172
+ disposeRetired(v);
167
173
  if (v.built) {
168
174
  disposeScene(v.built);
169
175
  }
@@ -195,9 +201,12 @@ function apply<Content>(v: Viewer<Content>, changes: ReadonlySet<Change>): void
195
201
  rebuild(v);
196
202
  }
197
203
  if (changes.has("shadow") || changes.has("build")) {
198
- if (v.shadow) {
199
- disposeGroundShadow(v.shadow);
204
+ if (v.retired.shadow) {
205
+ disposeGroundShadow(v.retired.shadow);
200
206
  }
207
+ v.retired.shadow = v.shadow;
208
+ v.shadow?.mesh.removeFromParent();
209
+ v.shadow?.floor.removeFromParent();
201
210
  v.shadow = v.built && options.groundShadow !== false ? createGroundShadow(v.renderer, v.scene, v.built) : undefined;
202
211
  if (v.keyLight) {
203
212
  disposeKeyLight(v.keyLight);
@@ -253,9 +262,11 @@ function apply<Content>(v: Viewer<Content>, changes: ReadonlySet<Change>): void
253
262
  }
254
263
 
255
264
  function rebuild<Content>(v: Viewer<Content>): void {
256
- if (v.built) {
257
- disposeScene(v.built);
265
+ if (v.retired.built) {
266
+ disposeScene(v.retired.built);
258
267
  }
268
+ v.retired.built = v.built;
269
+ v.built?.root.removeFromParent();
259
270
  const { options, compiled } = v;
260
271
  v.built =
261
272
  compiled &&
@@ -279,6 +290,17 @@ function rebuild<Content>(v: Viewer<Content>): void {
279
290
  }
280
291
  }
281
292
 
293
+ /** Three deletes a shader program once no material uses it, so the previous build's are disposed after the new build's took the programs over */
294
+ function disposeRetired<Content>(v: Viewer<Content>): void {
295
+ if (v.retired.built) {
296
+ disposeScene(v.retired.built);
297
+ }
298
+ if (v.retired.shadow) {
299
+ disposeGroundShadow(v.retired.shadow);
300
+ }
301
+ Object.assign(v.retired, { built: undefined, shadow: undefined });
302
+ }
303
+
282
304
  function onLoaded<Content>(v: Viewer<Content>): void {
283
305
  if (!v.disposed) {
284
306
  v.loaded = true;
@@ -315,6 +337,7 @@ function renderFrame<Content>(v: Viewer<Content>, now: number): void {
315
337
  }
316
338
  if (v.loaded) {
317
339
  renderer.render(v.scene, camera);
340
+ disposeRetired(v);
318
341
  }
319
342
  gizmo?.render();
320
343
  v.overlays.renderer.render(v.overlays.scene, camera);
@@ -500,7 +523,6 @@ function updateLights<Content>(v: Viewer<Content>): void {
500
523
  v.lights.clear();
501
524
  (typeof lights === "function" ? (scene ? lights(scene) : []) : (lights ?? [])).forEach((o) => v.lights.add(o));
502
525
  v.scene.environmentIntensity = environmentIntensity;
503
- loadStudio(v).catch(() => undefined);
504
526
  }
505
527
 
506
528
  /** The studio, loaded once, its own chunk; set when it arrives, so the scene's shaders are compiled after it, with it */
@@ -508,6 +530,10 @@ function loadStudio<Content>(v: Viewer<Content>): Promise<unknown> {
508
530
  v.studio.loading ??= import("../environment/studio.js")
509
531
  .then(({ loadStudio: load }) => load())
510
532
  .then((texture) => {
533
+ if (v.disposed) {
534
+ texture.dispose();
535
+ return texture;
536
+ }
511
537
  v.studio.texture = texture;
512
538
  v.scene.environment = texture;
513
539
  invalidate(v);
@@ -538,7 +564,7 @@ function updateOverlays<Content>(v: Viewer<Content>): void {
538
564
  }
539
565
 
540
566
  /** The studio's share of the light, the key light giving the rest, so the key light's shadows show */
541
- const studioIntensity = 0.5;
567
+ const studioIntensity = 0.6;
542
568
 
543
569
  const raycaster = new Raycaster();
544
570
  const ndc = new Vector2();