rename params to match promaster

Author: Kinatzo

packages/abstract-3d/src/renderers/svg/svg-geometries/shared.ts

@@ -18,14 +18,15 @@ export type ImageDataUri =
 
 export type SvgOptions = {
   readonly view: View;
-  readonly stroke: number;
+  readonly stroke_thickness: number;
+  readonly only_stroke: boolean;
+  readonly gray_scale: boolean;
+  readonly only_stroke_fill: string;
+  readonly rotation: number;
+
   readonly scale: { readonly size: number; readonly scaleByWidth: boolean } | undefined;
-  readonly onlyStroke: boolean;
-  readonly grayScale: boolean;
-  readonly onlyStrokeFill: string;
   readonly font: string;
   readonly imageDataByUrl: Record<string, ImageDataUri>;
-  readonly rotation: number;
 };
 
 export function eulerToSvgMatrix(rot: Vec3, pos: Vec2): string {

packages/abstract-3d/src/renderers/svg/svg-geometries/svg-box.ts

@@ -21,7 +21,7 @@ export function box(
   opts: SvgOptions,
   parentPos: Vec3,
   parentRot: Vec3,
-  factor: number,
+  factor: number
 ): ReadonlyArray<zOrderElement> {
   const half = vec3Scale(b.size, 0.5);
   const pos = vec3TransRot(b.pos, parentPos, parentRot);
@@ -60,9 +60,9 @@ export function box(
 
   const color = material.normal;
   const opacity = material.opacity ?? 1.0;
-  const [strokeColor, fill, strokeUse] = opts.onlyStroke
-    ? [opts.grayScale ? gray : color, opts.onlyStrokeFill, opts.stroke]
-    : [black, opts.grayScale ? rgbGrayScale(color) : color, 0];
+  const [strokeColor, fill, strokeUse] = opts.only_stroke
+    ? [opts.gray_scale ? gray : color, opts.only_stroke_fill, opts.stroke_thickness]
+    : [black, opts.gray_scale ? rgbGrayScale(color) : color, 0];
 
   return [
     zElem(svgPolygon(factor, rot, frontBackPoints, fill, opacity, strokeColor, strokeUse, b.holes), frontBackMean),

packages/abstract-3d/src/renderers/svg/svg-geometries/svg-cone.ts

@@ -30,9 +30,9 @@ export function cone(
 
   const color = material.normal;
   const opacity = material.opacity ?? 1.0;
-  const [stroke, fill] = opts.onlyStroke
-    ? [opts.grayScale ? gray : color, opts.onlyStrokeFill]
-    : [transparent, opts.grayScale ? rgbGrayScale(color) : color];
+  const [stroke, fill] = opts.only_stroke
+    ? [opts.gray_scale ? gray : color, opts.only_stroke_fill]
+    : [transparent, opts.gray_scale ? rgbGrayScale(color) : color];
   const zOrderComponents = Array<zOrderElement>();
 
   const sides = 8;
@@ -52,7 +52,9 @@ export function cone(
         point(topPos.x, topPos.y),
         point(topPos.x, topPos.y),
       ];
-      zOrderComponents.push(zElem(svgPolygon(factor, rot, points, fill, opacity, stroke, stBW), vec3ZMean(currBot, prevBot, topPos)));
+      zOrderComponents.push(
+        zElem(svgPolygon(factor, rot, points, fill, opacity, stroke, stBW), vec3ZMean(currBot, prevBot, topPos))
+      );
     }
     currentAngle += angleStep;
   }
@@ -62,7 +64,10 @@ export function cone(
   const cylBottom = vec3tr(vec3(0, -half.y, 0));
   if (equals(cylTop.x, cylBottom.x, 0.1) && equals(cylTop.y, cylBottom.y, 0.1)) {
     zOrderComponents.push(
-      zElem(svgCircle(factor * c.radius, rot, point(cylBottom.x, cylBottom.y), fill, opacity, stroke, stBW, factor), cylBottom.z)
+      zElem(
+        svgCircle(factor * c.radius, rot, point(cylBottom.x, cylBottom.y), fill, opacity, stroke, stBW, factor),
+        cylBottom.z
+      )
     );
   }
 

packages/abstract-3d/src/renderers/svg/svg-geometries/svg-cylinder.ts

@@ -30,9 +30,9 @@ export function cylinder(
 
   const color = material.normal;
   const opacity = material.opacity ?? 1.0;
-  const [stroke, fill] = opts.onlyStroke
-    ? [opts.grayScale ? gray : color, opts.onlyStrokeFill]
-    : [transparent, opts.grayScale ? rgbGrayScale(color) : color];
+  const [stroke, fill] = opts.only_stroke
+    ? [opts.gray_scale ? gray : color, opts.only_stroke_fill]
+    : [transparent, opts.gray_scale ? rgbGrayScale(color) : color];
   const zOrderComponents = Array<zOrderElement>();
 
   const sides = 8;
@@ -59,7 +59,10 @@ export function cylinder(
         point(currTop.x, currTop.y),
       ];
       zOrderComponents.push(
-        zElem(svgPolygon(factor, rot, points, fill, opacity, stroke, stBW), vec3ZMean(currBot, prevBot, currTop, prevTop))
+        zElem(
+          svgPolygon(factor, rot, points, fill, opacity, stroke, stBW),
+          vec3ZMean(currBot, prevBot, currTop, prevTop)
+        )
       );
     }
     currentAngle += angleStep;
@@ -71,7 +74,20 @@ export function cylinder(
     if (equals(circleTop.x, circleBottom.x, 0.1) && equals(circleTop.y, circleBottom.y, 0.1)) {
       const circlePos = circleTop.z > circleBottom.z ? circleTop : circleBottom;
       zOrderComponents.push(
-        zElem(svgCircle(factor * c.radius, rot, point(circlePos.x, circlePos.y), fill, opacity, stroke, stBW, factor, c.holes), circlePos.z)
+        zElem(
+          svgCircle(
+            factor * c.radius,
+            rot,
+            point(circlePos.x, circlePos.y),
+            fill,
+            opacity,
+            stroke,
+            stBW,
+            factor,
+            c.holes
+          ),
+          circlePos.z
+        )
       );
     }
   }

packages/abstract-3d/src/renderers/svg/svg-geometries/svg-line.ts

@@ -15,7 +15,7 @@ export function line(
   const v2 = vec3TransRot(l.end, parentPos, parentRot);
   return [
     zElem(
-      svgLine(point(v1.x, v1.y), point(v2.x, v2.y), opts.grayScale ? rgbGrayScale(fill) : fill, l.thickness),
+      svgLine(point(v1.x, v1.y), point(v2.x, v2.y), opts.gray_scale ? rgbGrayScale(fill) : fill, l.thickness),
       vec3ZMean(v1, v2)
     ),
   ];

packages/abstract-3d/src/renderers/svg/svg-geometries/svg-plane.ts

@@ -60,9 +60,9 @@ export function plane(
 
   const points = [point(v1.x, v1.y), point(v2.x, v2.y), point(v3.x, v3.y), point(v4.x, v4.y)];
 
-  const [strokeColor, fill, strokeThickness] = opts.onlyStroke
-    ? [opts.grayScale ? gray : material.normal, opts.onlyStrokeFill, opts.stroke]
-    : [black, opts.grayScale ? rgbGrayScale(material.normal) : material.normal, 0];
+  const [strokeColor, fill, strokeThickness] = opts.only_stroke
+    ? [opts.gray_scale ? gray : material.normal, opts.only_stroke_fill, opts.stroke_thickness]
+    : [black, opts.gray_scale ? rgbGrayScale(material.normal) : material.normal, 0];
   return [
     zElem(
       svgPolygon(factor, rot, points, fill, material.opacity ?? 1.0, strokeColor, strokeThickness, holes),

packages/abstract-3d/src/renderers/svg/svg-geometries/svg-polygon.ts

@@ -1,4 +1,13 @@
-import { Polygon, vec3ZMean, Vec3, Vec2, vec3TransRot, vec3RotCombine, vec3Zero, Material } from "../../../abstract-3d.js";
+import {
+  Polygon,
+  vec3ZMean,
+  Vec3,
+  Vec2,
+  vec3TransRot,
+  vec3RotCombine,
+  vec3Zero,
+  Material,
+} from "../../../abstract-3d.js";
 import { gray, zElem, zOrderElement, transparent, SvgOptions } from "./shared.js";
 import { svgPolygon } from "../svg-encoding.js";
 import { rgbGrayScale } from "../../shared.js";
@@ -17,8 +26,13 @@ export function polygon(
   const rotatedPoints = p.points.map((p) => vec3TransRot(p, pos, rot));
   const points = rotatedPoints.map(({ x, y }) => point(x, y));
   const color = material.normal;
-  const [strokeColor, fill, strokeThickness] = opts.onlyStroke
-    ? [opts.grayScale ? gray : color, opts.onlyStrokeFill, opts.stroke]
-    : [transparent, opts.grayScale ? rgbGrayScale(color) : color, 0];
-  return [zElem(svgPolygon(factor, rot, points, fill, material.opacity ?? 1.0, strokeColor, strokeThickness), vec3ZMean(...rotatedPoints))];
+  const [strokeColor, fill, strokeThickness] = opts.only_stroke
+    ? [opts.gray_scale ? gray : color, opts.only_stroke_fill, opts.stroke_thickness]
+    : [transparent, opts.gray_scale ? rgbGrayScale(color) : color, 0];
+  return [
+    zElem(
+      svgPolygon(factor, rot, points, fill, material.opacity ?? 1.0, strokeColor, strokeThickness),
+      vec3ZMean(...rotatedPoints)
+    ),
+  ];
 }

packages/abstract-3d/src/renderers/svg/svg-geometries/svg-shape.ts

@@ -1,4 +1,14 @@
-import { vec3ZMean, Vec3, Vec2, vec3TransRot, vec3RotCombine, Shape, vec3, vec3Zero, Material } from "../../../abstract-3d.js";
+import {
+  vec3ZMean,
+  Vec3,
+  Vec2,
+  vec3TransRot,
+  vec3RotCombine,
+  Shape,
+  vec3,
+  vec3Zero,
+  Material,
+} from "../../../abstract-3d.js";
 import { gray, zElem, zOrderElement, transparent, SvgOptions } from "./shared.js";
 import { svgPolygon } from "../svg-encoding.js";
 import { rgbGrayScale } from "../../shared.js";
@@ -17,8 +27,10 @@ export function shape(
   const rotatedPoints = s.points.map((p) => vec3TransRot(vec3(p.x, p.y, 0), pos, rot));
   const points = rotatedPoints.map(({ x, y }) => point(x, y));
   const color = material.normal;
-  const [strokeColor, fill] = opts.onlyStroke
-    ? [opts.grayScale ? gray : color, opts.onlyStrokeFill]
-    : [transparent, opts.grayScale ? rgbGrayScale(color) : color];
-  return [zElem(svgPolygon(factor, rot, points, fill, material.opacity ?? 1.0, strokeColor, 0), vec3ZMean(...rotatedPoints))];
+  const [strokeColor, fill] = opts.only_stroke
+    ? [opts.gray_scale ? gray : color, opts.only_stroke_fill]
+    : [transparent, opts.gray_scale ? rgbGrayScale(color) : color];
+  return [
+    zElem(svgPolygon(factor, rot, points, fill, material.opacity ?? 1.0, strokeColor, 0), vec3ZMean(...rotatedPoints)),
+  ];
 }

packages/abstract-3d/src/renderers/svg/svg.ts

@@ -84,11 +84,11 @@ function renderInternal(
 ): { readonly elements: ReadonlyArray<zOrderElement>; readonly width: number; readonly height: number } {
   const opts: SvgOptions = {
     view: options?.view ?? "front",
-    stroke: options?.stroke ?? 2,
+    stroke_thickness: options?.stroke_thickness ?? 2,
     scale: options?.scale ?? undefined,
-    onlyStroke: options?.onlyStroke ?? false,
-    grayScale: options?.grayScale ?? false,
-    onlyStrokeFill: options?.onlyStrokeFill ?? "rgba(255,255,255,0)",
+    only_stroke: options?.only_stroke ?? false,
+    gray_scale: options?.gray_scale ?? false,
+    only_stroke_fill: options?.only_stroke_fill ?? "rgba(255,255,255,0)",
     font: options?.font ?? "",
     imageDataByUrl: options?.imageDataByUrl ?? {},
     rotation: options?.rotation ?? 0,
@@ -108,10 +108,10 @@ function renderInternal(
   const unitRot = opts.rotation ? vec3RotCombine(vec3(0, 0, (opts.rotation * Math.PI) / 180), baseRot) : baseRot;
   const unitPos = vec3Rot(scene.center_deprecated ?? vec3Zero, vec3Zero, scene.rotation_deprecated ?? vec3Zero);
   const [size, center] = sizeCenterForCameraPos(scene.size_deprecated, unitPos, unitRot, factor);
-  const width = size.x + 1.5 * opts.stroke;
-  const height = size.y + 1.5 * opts.stroke;
+  const width = size.x + 1.5 * opts.stroke_thickness;
+  const height = size.y + 1.5 * opts.stroke_thickness;
   const unitHalfSize = vec3Scale(size, 0.5);
-  const centerAdj = vec3(center.x - opts.stroke * 0.75, center.y + opts.stroke * 0.75, center.z);
+  const centerAdj = vec3(center.x - opts.stroke_thickness * 0.75, center.y + opts.stroke_thickness * 0.75, center.z);
   const elements = Array<zOrderElement>();
   const point = (x: number, y: number): Vec2 =>
     vec2(-centerAdj.x + unitHalfSize.x + x * factor + offset.x, centerAdj.y + unitHalfSize.y - y * factor + offset.y);
@@ -121,7 +121,7 @@ function renderInternal(
     const rot = vec3RotCombine(unitRot, g.rot ?? vec3Zero);
     elements.push(...svgGroup(g, pos, rot, point, factor, opts));
   }
-  const dimOpts: SvgOptions = { ...opts, onlyStroke: false, grayScale: false };
+  const dimOpts: SvgOptions = { ...opts, only_stroke: false, gray_scale: false };
   elements.sort((a, b) => a.zOrder - b.zOrder);
   const cameraPos = vec3Rot(vec3(1, 1, 1), vec3Zero, scene.rotation_deprecated ?? vec3Zero);
   for (const d of scene.dimensions_deprecated?.dimensions ?? []) {

packages/abstract-visuals-example/src/app/abstract-3d-example.tsx

@@ -32,7 +32,13 @@ export function Abstract3DExample(): React.ReactNode {
           onClick={() =>
             FileSaver.saveAs(
               new Blob(
-                [Svg.render(systemair, { view: "front", stroke: 2, scale: { size: 180, scaleByWidth: true } }).image],
+                [
+                  Svg.render(systemair, {
+                    view: "front",
+                    stroke_thickness: 2,
+                    scale: { size: 180, scaleByWidth: true },
+                  }).image,
+                ],
                 {
                   type: "text/plain",
                 }
@@ -49,7 +55,7 @@ export function Abstract3DExample(): React.ReactNode {
           dangerouslySetInnerHTML={{
             __html: Svg.render(systemair, {
               view: "front",
-              stroke: 1,
+              stroke_thickness: 1,
               scale: { size: 400, scaleByWidth: true },
               rotation: 270,
             }).image,