@flighthq/shape 0.3.0-next.1584.a68fe91 → 0.3.0-next.1593.a47f94a

package/dist/contract.d.ts

@@ -9,4 +9,5 @@ export * from './shapeStrokeOutline';
 export * from './shapeHitTestBuiltins';
 export * from './shapeHitTestRegistry';
 export * from './scale9ShapeCommands';
+export * from './explainShapeTessellation';
 //# sourceMappingURL=contract.d.ts.map

package/dist/contract.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"contract.d.ts","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,uBAAuB,CAAC;AACtC,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC"}
+{"version":3,"file":"contract.d.ts","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,uBAAuB,CAAC;AACtC,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC"}

package/dist/contract.js

@@ -9,4 +9,5 @@ export * from './shapeStrokeOutline';
 export * from './shapeHitTestBuiltins';
 export * from './shapeHitTestRegistry';
 export * from './scale9ShapeCommands';
+export * from './explainShapeTessellation';
 //# sourceMappingURL=contract.js.map

package/dist/contract.js.map

@@ -1 +1 @@
-{"version":3,"file":"contract.js","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,uBAAuB,CAAC;AACtC,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC"}
+{"version":3,"file":"contract.js","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,uBAAuB,CAAC;AACtC,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC"}

package/dist/explainShapeTessellation.d.ts

@@ -0,0 +1,3 @@
+import type { ShapeCommandToken, ShapeTessellationExplanation } from '@flighthq/types/contract';
+export declare function explainShapeTessellation(commands: readonly ShapeCommandToken[], strokePathTessellationEnabled?: boolean): ShapeTessellationExplanation;
+//# sourceMappingURL=explainShapeTessellation.d.ts.map

package/dist/explainShapeTessellation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"explainShapeTessellation.d.ts","sourceRoot":"","sources":["../src/explainShapeTessellation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,4BAA4B,EAAE,MAAM,0BAA0B,CAAC;AAYhG,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,SAAS,iBAAiB,EAAE,EACtC,6BAA6B,UAAQ,GACpC,4BAA4B,CAO9B"}

package/dist/explainShapeTessellation.js

@@ -0,0 +1,20 @@
+import { hasNonSolidShapeFill } from './shapeFill';
+import { hasNonSolidShapeStroke } from './shapeStroke';
+import { getShapeStrokeOutlineRegions } from './shapeStrokeOutline';
+// Reports whether a command stream can be drawn as mesh regions, and what stops it when it cannot.
+//
+// `strokePathTessellationEnabled` selects which stroke lane the answer describes, because the two
+// differ on exactly the case that catches authors out: the default lane declines a closed stroke — the
+// outline of any rectangle, circle, or closed path — while the opt-in stroke-path tessellator expresses
+// it. Fill alpha never matters to either; a solid fill tessellates at any alpha, including zero.
+export function explainShapeTessellation(commands, strokePathTessellationEnabled = false) {
+    if (hasNonSolidShapeFill(commands))
+        return { blockedBy: 'non-solid-fill', status: 'needs-rasterizer' };
+    if (hasNonSolidShapeStroke(commands))
+        return { blockedBy: 'non-solid-stroke', status: 'needs-rasterizer' };
+    if (!strokePathTessellationEnabled && getShapeStrokeOutlineRegions(commands) === null) {
+        return { blockedBy: 'stroke-outline', status: 'needs-rasterizer' };
+    }
+    return { blockedBy: 'none', status: 'tessellates' };
+}
+//# sourceMappingURL=explainShapeTessellation.js.map

package/dist/explainShapeTessellation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"explainShapeTessellation.js","sourceRoot":"","sources":["../src/explainShapeTessellation.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,4BAA4B,EAAE,MAAM,sBAAsB,CAAC;AAEpE,mGAAmG;AACnG,EAAE;AACF,kGAAkG;AAClG,uGAAuG;AACvG,wGAAwG;AACxG,iGAAiG;AACjG,MAAM,UAAU,wBAAwB,CACtC,QAAsC,EACtC,6BAA6B,GAAG,KAAK;IAErC,IAAI,oBAAoB,CAAC,QAAQ,CAAC;QAAE,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,EAAE,kBAAkB,EAAE,CAAC;IACvG,IAAI,sBAAsB,CAAC,QAAQ,CAAC;QAAE,OAAO,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,EAAE,kBAAkB,EAAE,CAAC;IAC3G,IAAI,CAAC,6BAA6B,IAAI,4BAA4B,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE,CAAC;QACtF,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,EAAE,kBAAkB,EAAE,CAAC;IACrE,CAAC;IACD,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC;AACtD,CAAC"}

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export { PathCommand, applyAnimationClipToMorphShape, applyMorphShapeAnimationSample, appendMorphShapePath, appendShapeArc, appendShapeArcTo, appendShapeBeginTextureFill, appendShapeBeginFill, appendShapeBeginGradientFill, appendShapeCircle, appendShapeCubicCurveTo, appendShapeCurveTo, appendShapeDrawTriangles, appendShapeEllipse, appendShapeEndFill, appendShapeGeometryCommand, appendShapeLineTextureStyle, appendShapeLineGradientStyle, appendShapeLineStyle, appendShapeLineTo, appendShapeMoveTo, appendShapePath, appendShapePolygon, appendShapePolyline, appendShapeRectangle, appendShapeRoundRectangle, appendShapeRoundRectangleVarying, clearShapeCommands, computeShapeLocalBoundsRectangle, copyShapeCommands, createMorphShape, createMorphShapeAnimationTarget, createScale9Shape, createShape, enableShapeHitTesting, getPathCommandOperandCount, getShapeBounds, getShapeCommandCount, getShapeFillRegions, getShapeStrokeRegions, getShapeStrokeOutlineRegions, hasNonSolidShapeFill, hasNonSolidShapeStroke, hasShapeFill, hitTestShapeCommandPoint, isShapeEmpty, registerShapeHitTestCommand, setMorphShapeProgress, } from './contract';
 export * from './scale9ShapeCommands';
+export * from './explainShapeTessellation';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,8BAA8B,EAC9B,8BAA8B,EAC9B,oBAAoB,EACpB,cAAc,EACd,gBAAgB,EAChB,2BAA2B,EAC3B,oBAAoB,EACpB,4BAA4B,EAC5B,iBAAiB,EACjB,uBAAuB,EACvB,kBAAkB,EAClB,wBAAwB,EACxB,kBAAkB,EAClB,kBAAkB,EAClB,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EACzB,gCAAgC,EAChC,kBAAkB,EAClB,gCAAgC,EAChC,iBAAiB,EACjB,gBAAgB,EAChB,+BAA+B,EAC/B,iBAAiB,EACjB,WAAW,EACX,qBAAqB,EACrB,0BAA0B,EAC1B,cAAc,EACd,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,EACrB,4BAA4B,EAC5B,oBAAoB,EACpB,sBAAsB,EACtB,YAAY,EACZ,wBAAwB,EACxB,YAAY,EACZ,2BAA2B,EAC3B,qBAAqB,GACtB,MAAM,YAAY,CAAC;AACpB,cAAc,uBAAuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,8BAA8B,EAC9B,8BAA8B,EAC9B,oBAAoB,EACpB,cAAc,EACd,gBAAgB,EAChB,2BAA2B,EAC3B,oBAAoB,EACpB,4BAA4B,EAC5B,iBAAiB,EACjB,uBAAuB,EACvB,kBAAkB,EAClB,wBAAwB,EACxB,kBAAkB,EAClB,kBAAkB,EAClB,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EACzB,gCAAgC,EAChC,kBAAkB,EAClB,gCAAgC,EAChC,iBAAiB,EACjB,gBAAgB,EAChB,+BAA+B,EAC/B,iBAAiB,EACjB,WAAW,EACX,qBAAqB,EACrB,0BAA0B,EAC1B,cAAc,EACd,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,EACrB,4BAA4B,EAC5B,oBAAoB,EACpB,sBAAsB,EACtB,YAAY,EACZ,wBAAwB,EACxB,YAAY,EACZ,2BAA2B,EAC3B,qBAAqB,GACtB,MAAM,YAAY,CAAC;AACpB,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC"}

package/dist/index.js

@@ -1,3 +1,4 @@
 export { PathCommand, applyAnimationClipToMorphShape, applyMorphShapeAnimationSample, appendMorphShapePath, appendShapeArc, appendShapeArcTo, appendShapeBeginTextureFill, appendShapeBeginFill, appendShapeBeginGradientFill, appendShapeCircle, appendShapeCubicCurveTo, appendShapeCurveTo, appendShapeDrawTriangles, appendShapeEllipse, appendShapeEndFill, appendShapeGeometryCommand, appendShapeLineTextureStyle, appendShapeLineGradientStyle, appendShapeLineStyle, appendShapeLineTo, appendShapeMoveTo, appendShapePath, appendShapePolygon, appendShapePolyline, appendShapeRectangle, appendShapeRoundRectangle, appendShapeRoundRectangleVarying, clearShapeCommands, computeShapeLocalBoundsRectangle, copyShapeCommands, createMorphShape, createMorphShapeAnimationTarget, createScale9Shape, createShape, enableShapeHitTesting, getPathCommandOperandCount, getShapeBounds, getShapeCommandCount, getShapeFillRegions, getShapeStrokeRegions, getShapeStrokeOutlineRegions, hasNonSolidShapeFill, hasNonSolidShapeStroke, hasShapeFill, hitTestShapeCommandPoint, isShapeEmpty, registerShapeHitTestCommand, setMorphShapeProgress, } from './contract';
 export * from './scale9ShapeCommands';
+export * from './explainShapeTessellation';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,8BAA8B,EAC9B,8BAA8B,EAC9B,oBAAoB,EACpB,cAAc,EACd,gBAAgB,EAChB,2BAA2B,EAC3B,oBAAoB,EACpB,4BAA4B,EAC5B,iBAAiB,EACjB,uBAAuB,EACvB,kBAAkB,EAClB,wBAAwB,EACxB,kBAAkB,EAClB,kBAAkB,EAClB,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EACzB,gCAAgC,EAChC,kBAAkB,EAClB,gCAAgC,EAChC,iBAAiB,EACjB,gBAAgB,EAChB,+BAA+B,EAC/B,iBAAiB,EACjB,WAAW,EACX,qBAAqB,EACrB,0BAA0B,EAC1B,cAAc,EACd,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,EACrB,4BAA4B,EAC5B,oBAAoB,EACpB,sBAAsB,EACtB,YAAY,EACZ,wBAAwB,EACxB,YAAY,EACZ,2BAA2B,EAC3B,qBAAqB,GACtB,MAAM,YAAY,CAAC;AACpB,cAAc,uBAAuB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,8BAA8B,EAC9B,8BAA8B,EAC9B,oBAAoB,EACpB,cAAc,EACd,gBAAgB,EAChB,2BAA2B,EAC3B,oBAAoB,EACpB,4BAA4B,EAC5B,iBAAiB,EACjB,uBAAuB,EACvB,kBAAkB,EAClB,wBAAwB,EACxB,kBAAkB,EAClB,kBAAkB,EAClB,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EACzB,gCAAgC,EAChC,kBAAkB,EAClB,gCAAgC,EAChC,iBAAiB,EACjB,gBAAgB,EAChB,+BAA+B,EAC/B,iBAAiB,EACjB,WAAW,EACX,qBAAqB,EACrB,0BAA0B,EAC1B,cAAc,EACd,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,EACrB,4BAA4B,EAC5B,oBAAoB,EACpB,sBAAsB,EACtB,YAAY,EACZ,wBAAwB,EACxB,YAAY,EACZ,2BAA2B,EAC3B,qBAAqB,GACtB,MAAM,YAAY,CAAC;AACpB,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flighthq/shape",
-  "version": "0.3.0-next.1584.a68fe91",
+  "version": "0.3.0-next.1593.a47f94a",
   "repository": {
     "type": "git",
     "url": "https://github.com/flighthq/flight.git",
@@ -36,12 +36,12 @@
     "clean:dist": "tsx ../../scripts/clean-package-dist.ts"
   },
   "dependencies": {
-    "@flighthq/animation": "0.3.0-next.1584.a68fe91",
-    "@flighthq/scene2d": "0.3.0-next.1584.a68fe91",
-    "@flighthq/geometry": "0.3.0-next.1584.a68fe91",
-    "@flighthq/node": "0.3.0-next.1584.a68fe91",
-    "@flighthq/path": "0.3.0-next.1584.a68fe91",
-    "@flighthq/types": "0.3.0-next.1584.a68fe91"
+    "@flighthq/animation": "0.3.0-next.1593.a47f94a",
+    "@flighthq/scene2d": "0.3.0-next.1593.a47f94a",
+    "@flighthq/geometry": "0.3.0-next.1593.a47f94a",
+    "@flighthq/node": "0.3.0-next.1593.a47f94a",
+    "@flighthq/path": "0.3.0-next.1593.a47f94a",
+    "@flighthq/types": "0.3.0-next.1593.a47f94a"
   },
   "devDependencies": {
     "typescript": "^5.3.0"

package/src/explainShapeTessellation.test.ts

@@ -0,0 +1,65 @@
+import { explainShapeTessellation } from './explainShapeTessellation';
+import { createShape } from './shape';
+import {
+  appendShapeBeginFill,
+  appendShapeBeginGradientFill,
+  appendShapeEndFill,
+  appendShapeLineStyle,
+  appendShapeLineTo,
+  appendShapeMoveTo,
+  appendShapeRectangle,
+} from './shapeCommands';
+
+describe('explainShapeTessellation', () => {
+  it('reports a solid fill as tessellating at any alpha, opaque or not', () => {
+    // Alpha is carried on the region, so it never moves a shape off the mesh lane — worth pinning,
+    // because a translucent shape that fails to draw invites blaming the alpha.
+    for (const alpha of [1, 0.25, 0]) {
+      const shape = createShape();
+      appendShapeBeginFill(shape, 0xff0000, alpha);
+      appendShapeRectangle(shape, 0, 0, 50, 50);
+      appendShapeEndFill(shape);
+
+      expect(explainShapeTessellation(shape.data.commands)).toEqual({ blockedBy: 'none', status: 'tessellates' });
+    }
+  });
+
+  it('reports an open stroke as tessellating', () => {
+    const shape = createShape();
+    appendShapeLineStyle(shape, 2, 0x000000);
+    appendShapeMoveTo(shape, 0, 0);
+    appendShapeLineTo(shape, 50, 0);
+
+    expect(explainShapeTessellation(shape.data.commands)).toEqual({ blockedBy: 'none', status: 'tessellates' });
+  });
+
+  it('names the closed stroke that the default lane declines, and clears it for the opt-in lane', () => {
+    const shape = createShape();
+    appendShapeBeginFill(shape, 0xff0000, 1);
+    appendShapeLineStyle(shape, 2, 0x000000);
+    appendShapeRectangle(shape, 0, 0, 50, 50);
+    appendShapeEndFill(shape);
+
+    expect(explainShapeTessellation(shape.data.commands)).toEqual({
+      blockedBy: 'stroke-outline',
+      status: 'needs-rasterizer',
+    });
+    expect(explainShapeTessellation(shape.data.commands, true)).toEqual({
+      blockedBy: 'none',
+      status: 'tessellates',
+    });
+  });
+
+  it('names a non-solid fill, which no stroke lane setting can rescue', () => {
+    const shape = createShape();
+    appendShapeBeginGradientFill(shape, 'linear', [0xff0000, 0x0000ff], [1, 1], [0, 255]);
+    appendShapeRectangle(shape, 0, 0, 50, 50);
+    appendShapeEndFill(shape);
+
+    expect(explainShapeTessellation(shape.data.commands)).toEqual({
+      blockedBy: 'non-solid-fill',
+      status: 'needs-rasterizer',
+    });
+    expect(explainShapeTessellation(shape.data.commands, true).status).toBe('needs-rasterizer');
+  });
+});