treewide: Release 0.3.3 (#820)

johannes-wolf · hooyuser · web-flow · commit b60e7e970d7a · 2025-03-02T17:20:56.000+01:00
* treewide: Bump version to 0.3.3 * canvas: Add background field to canvas context for background-aware drawing (#823) Add background to canvas context Add background to canvas context * background: Update changelog & add documentation * mark: Fix mark styling issues with incomplete dict (#825) * matrix: Add a diag function (#824) * matrix: Add a diag function * matrix: Improve ident * mark: Add missing test case * bezier: Possible fix for div by zero bug --------- Co-authored-by: Derived Cat <hooyuser@outlook.com>
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,8 +1,14 @@
 # 0.3.3
+- Circle supports two-point construction, using the distance as radius
 - Require Typst 0.13.0, port test cases over to Tytanic
 - Add note about contents `auto-scale` feature
 - Various performance improvements
 - Make use of the new `curve` API
+- **BREAKING** Matrix `ident` function signature changed
+- New `matrix.diag` function
+- Added a `background` to the context, set to the canvas background
+- Fixed mark styling issues with empty or incomplete style dictionaries
+- Fixes a division by zero bug when trying to calculate some intersections
 
 # 0.3.2
 
diff --git a/README.md b/README.md
@@ -61,7 +61,7 @@ For information, see the [online manual](https://cetz-package.github.io/docs).
 
 To use this package, simply add the following code to your document:
 ```
-#import "@preview/cetz:0.3.2"
+#import "@preview/cetz:0.3.3"
 
 #cetz.canvas({
   import cetz.draw: *
@@ -85,7 +85,7 @@ just install
 The installed version can be imported by prefixing the package name with `@local`.
 
 ```typ
-#import "@local/cetz:0.3.2"
+#import "@local/cetz:0.3.3"
 
 #cetz.canvas({
   import cetz.draw: *
diff --git a/docs/advanced/custom-types.mdx b/docs/advanced/custom-types.mdx
@@ -6,9 +6,9 @@ A {{dictionary}} that holds the internal state of the canvas such as the element
 The following fields are considered stable:
 - length (length): Length of one canvas unit as typst length
 - transform (matrix): Current 4x4 transformation matrix
+- background (none,color,gradient,tiling): The canvas' background
 - debug (bool): True if the canvas' debug flag is set
 
-
 ## <Type>element</Type>
 
 A function that, when called with a <Type>context</Type>, returns some data that effects the canvas. Can also be an <Type>array</Type> of this type.
diff --git a/docs/getting-started.mdx b/docs/getting-started.mdx
@@ -8,7 +8,7 @@ sidebar_position: 1
 This is the minimal starting point in a `.typ` file:
 
 ```typ
-#import "@preview/cetz:0.3.2"
+#import "@preview/cetz:0.3.3"
 #cetz.canvas({
   import cetz.draw: *
   ...
diff --git a/docs/tutorials/karl.mdx b/docs/tutorials/karl.mdx
@@ -20,7 +20,7 @@ In CeTZ, to draw a picture, two imports and a function call is all you need. Kar
 
 ```typ
 #set page(width: auto, height: auto)
-#import "@preview/cetz:0.3.2"
+#import "@preview/cetz:0.3.3"
 
 We are working on
 #cetz.canvas({
diff --git a/gallery/karls-picture.png b/gallery/karls-picture.png
diff --git a/gallery/karls-picture.typ b/gallery/karls-picture.typ
@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.3.2"
+#import "@preview/cetz:0.3.3"
 #set page(width: auto, height: auto, margin: .5cm)
 
 #show math.equation: block.with(fill: white, inset: 1pt)
diff --git a/gallery/paciolis.png b/gallery/paciolis.png
diff --git a/gallery/paciolis.typ b/gallery/paciolis.typ
@@ -1,5 +1,5 @@
 // Example by @samuelireson
-#import "@preview/cetz:0.3.2": canvas, draw, tree
+#import "@preview/cetz:0.3.3": canvas, draw, tree
 
 #set page(width: auto, height: auto, margin: .5cm)
 
diff --git a/gallery/periodic-table.png b/gallery/periodic-table.png
diff --git a/gallery/periodic-table.typ b/gallery/periodic-table.typ
@@ -1,6 +1,6 @@
 // Copied from https://github.com/janosh/tikz/blob/da1b4582/assets/periodic-table/periodic-table.typ
 
-#import "@preview/cetz:0.3.2": canvas, draw
+#import "@preview/cetz:0.3.3": canvas, draw
 
 #set page(width: auto, height: auto, margin: 15pt)
 
diff --git a/gallery/plate-capacitor.png b/gallery/plate-capacitor.png
diff --git a/gallery/plate-capacitor.typ b/gallery/plate-capacitor.typ
@@ -1,6 +1,6 @@
 // Copied from https://github.com/janosh/tikz/blob/87754ea/assets/plate-capacitor/plate-capacitor.typ
 
-#import "@preview/cetz:0.3.2": canvas, draw
+#import "@preview/cetz:0.3.3": canvas, draw
 #import draw: line, rect, content, bezier, group, anchor
 
 #set page(width: auto, height: auto, margin: 5pt)
diff --git a/gallery/tree.typ b/gallery/tree.typ
@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.3.2": canvas, draw, tree
+#import "@preview/cetz:0.3.3": canvas, draw, tree
 
 #set page(width: auto, height: auto, margin: .5cm)
 
diff --git a/gallery/waves.png b/gallery/waves.png
diff --git a/gallery/waves.typ b/gallery/waves.typ
@@ -1,4 +1,4 @@
-#import "@preview/cetz:0.3.2": canvas, draw, vector, matrix
+#import "@preview/cetz:0.3.3": canvas, draw, vector, matrix
 
 #set page(width: auto, height: auto, margin: .5cm)
 
diff --git a/src/anchor.typ b/src/anchor.typ
@@ -206,7 +206,7 @@
     }
   }
 
-  return (if transform == none { matrix.ident() } else { transform }, calculate-anchor.with(transform: transform))
+  return (if transform == none { matrix.ident(4) } else { transform }, calculate-anchor.with(transform: transform))
 }
 
 
diff --git a/src/bezier.typ b/src/bezier.typ
@@ -531,9 +531,9 @@
 ///
 /// -> array Array of roots
 #let _cubic-roots(a, b, c, d) = {
-  let epsilon = 0.000001
-  if calc.abs(a) < 1e-6 {
-    if calc.abs(b) < 1e-6 {
+  let epsilon = 1e-6
+  if calc.abs(a) < epsilon {
+    if calc.abs(b) < epsilon {
       // Constant
       if c == 0 {
         return ()
@@ -554,6 +554,9 @@
       let roots = (-1 * (dq + c) / (2 * b),
                         (dq - c) / (2 * b))
       return roots.filter(t => t >= 0 - epsilon and t <= 1 + epsilon)
+    } else {
+      // No real roots
+      return ()
     }
   }
 
diff --git a/src/canvas.typ b/src/canvas.typ
@@ -37,6 +37,7 @@
     version: version.version,
     length: length,
     debug: debug,
+    background: background,
     // Previous element position & bbox
     prev: (pt: (0, 0, 0)),
     style: styles.default,
diff --git a/src/draw/projection.typ b/src/draw/projection.typ
@@ -8,7 +8,7 @@
 
 // Get an orthographic view matrix for 3 angles
 #let ortho-matrix(x, y, z) = matrix.mul-mat(
-  matrix.ident(),
+  matrix.ident(4),
   matrix.transform-rotate-x(x),
   matrix.transform-rotate-y(y),
   matrix.transform-rotate-z(z),
@@ -148,7 +148,7 @@
   let z = util.resolve-number(ctx, z)
   scoped-transform(body, if z != 0 {
     matrix.transform-translate(0, 0, z)
-  }, matrix.ident())
+  }, matrix.ident(4))
 })
 
 /// Draw elements on the xz-plane with optional y offset.
diff --git a/src/draw/transformations.typ b/src/draw/transformations.typ
@@ -26,7 +26,7 @@
 /// - mat (none, matrix): The 4x4 transformation matrix to set. If `none` is passed, the transformation matrix is set to the identity matrix (`matrix.ident()`).
 #let set-transform(mat) = {
   let mat = if mat == none {
-    matrix.ident()
+    matrix.ident(4)
   } else {
     matrix.round(mat)
   }
diff --git a/src/mark.typ b/src/mark.typ
@@ -10,7 +10,10 @@
 /// Checks if a mark should be drawn according to the current style.
 /// - style (style): The current style.
 /// -> bool
-#let check-mark(style) = style != none and (style.start, style.end, style.symbol).any(v => v != none)
+#let check-mark(style) = {
+  style != none and ("start", "end", "symbol").any(key =>
+    style.at(key, default: none) != none)
+}
 
 /// Processes the mark styling.
 /// TODO: remember what is actually going on here.
@@ -173,7 +176,7 @@
 
   ctx.groups = ()
   ctx.nodes = (:)
-  ctx.transform = matrix.ident()
+  ctx.transform = matrix.ident(4)
 
   import "/src/draw.typ"
   let body = draw.group({
@@ -379,14 +382,22 @@
   let snap-to = (none, none)
   let drawables = ()
 
-  let (path, is-transformed) = if not style.transform-shape and transform != none {
+  if style == none {
+    style = (start: none, end: none, symbol: none)
+  }
+  let start-symbol = style.at("start",
+    default: style.at("symbol", default: none))
+  let end-symbol = style.at("end",
+    default: style.at("symbol", default: none))
+
+  let (path, is-transformed) = if not style.at("transform-shape", default: true) and transform != none {
     (drawable.apply-transform(transform, path).first(), true)
   } else {
     (path, false)
   }
 
   let segments = path.segments
-  if style.start != none or style.symbol != none {
+  if start-symbol != none {
     let (drawables: start-drawables, distance: start-distance, pos: pt) = place-mark-on-path(
       ctx,
       process-style(ctx, style, "start", path-util.length(segments)),
@@ -396,7 +407,7 @@
     distance.first() = start-distance
     snap-to.first() = pt
   }
-  if style.end != none or style.symbol != none {
+  if end-symbol != none {
     let (drawables: end-drawables, distance: end-distance, pos: pt) = place-mark-on-path(
       ctx,
       process-style(ctx, style, "end", path-util.length(segments)),
diff --git a/src/matrix.typ b/src/matrix.typ
@@ -15,19 +15,31 @@
 
 #let pi = calc.pi
 
-/// Create identity matrix with dimensions $m \times n$
+/// Create a (square) identity matrix with dimensions $size \times size$
 ///
-/// - m (int): The number of rows
-/// - n (int): The number of columns
-/// - one (float): Value to set as $1$
-/// - zero (float): Value to set as $0$
+/// - size (int): Size of the matrix
 /// -> matrix
-#let ident(m: 4, n: 4, one: 1, zero: 0) = {
-  ({for m in range(0, m) {
-    ({for n in range(0, n) {
-        if m == n { (one,) } else { (zero,) }
-     }},)
-    }})
+#let ident(size) = {
+  assert(size >= 1, message: "Invalid dimension")
+
+  range(0, size).map(j => range(0, size).map(k => {
+    if j == k { 1 } else { 0 }
+  }))
+}
+
+/// Create a square matrix with the diagonal set to the
+/// given values
+///
+/// - ..diag (float): Diagonal values
+/// -> matrix
+#let diag(..diag) = {
+  assert(diag.pos().len() >= 1, message: "Invalid dimension")
+  assert.eq(diag.named(), (), messaged: "Unexpected named argument")
+
+  let diag = diag.pos()
+  range(0, diag.len()).map(m => range(0, diag.len()).map(n => {
+    if n == m { diag.at(m) } else { 0 }
+  }))
 }
 
 /// Returns the dimension of the given matrix as `(m, n)`
@@ -291,7 +303,7 @@
   }
 
   let N = range(n)
-  let inverted = ident(m: n, n: n)
+  let inverted = ident(n)
   let p
   for j in N {
     for i in range(j, n) {
diff --git a/src/version.typ b/src/version.typ
@@ -1 +1 @@
-#let version = version(0,3,2)
+#let version = version(0,3,3)
diff --git a/tests/mark-style/ref/1.png b/tests/mark-style/ref/1.png
diff --git a/tests/mark-style/test.typ b/tests/mark-style/test.typ
@@ -0,0 +1,46 @@
+#set page(width: auto, height: auto)
+#import "/src/lib.typ": *
+#import "/tests/helper.typ": *
+
+// Test various style combinations that produce
+// no marks but must compile
+#test-case({
+  import draw: *
+
+  let styles = (
+    (mark: none),
+    (mark: (:)),
+    (mark: (symbol: none)),
+    (mark: (start: none)),
+    (mark: (end: none)),
+    (mark: (symbol: ">")),
+    (line: (mark: none)),
+    (line: (mark: (symbol: none))),
+  )
+
+  for s in styles {
+    scope({
+      set-style(..s)
+      hide(line((0,0), (1,0)))
+    })
+  }
+})
+
+// Test various style combinations that produce a mark
+#test-case({
+  import draw: *
+
+  let styles = (
+    (mark: (end: ">")),
+    (mark: (start: ">")),
+    (mark: (start: ">", end: ">")),
+  )
+
+  for s in styles {
+    translate((0, 1))
+    scope({
+      set-style(..s)
+      line((0,0), (1,0))
+    })
+  }
+})
diff --git a/typst.toml b/typst.toml
@@ -1,6 +1,6 @@
 [package]
 name = "cetz"
-version = "0.3.2"
+version = "0.3.3"
 compiler = "0.13.0"
 repository = "https://github.com/cetz-package/cetz"
 homepage = "https://cetz-package.github.io/"

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-#import "@preview/cetz:0.3.2"`
	`1`	`+#import "@preview/cetz:0.3.3"`
`2`	`2`	`#set page(width: auto, height: auto, margin: .5cm)`
`3`	`3`
`4`	`4`	`#show math.equation: block.with(fill: white, inset: 1pt)`