KCL: Patterns of patterns can use the original sketch/solid as target

[adamchalmers]

Right now, if you model something like this box with a button:

Let's say you want to pattern the button, and repeat it a second time. If you try, you'll actually pattern the entire model (box + button).

Why? Because right now, when you sketch on a face (like the button was), both the box and the button share the same ID. All extrusions from a solid will share the same ID, because they all refer to the same composite solid.

This is helpful in some ways -- arguably the solid is just one big complex shape now -- but it's not helpful in other ways. What if I want to only pattern the button? Luckily there's an original ID for the button part, which is still stored. So we just need a way to tell the pattern stdlib functions whether to use the target's main ID or its original ID. This PR adds a new optional bool, useOriginal, to patterns. It's false by default, to keep backwards-compatibility (make sure that old KCL code doesn't change).

This PR is based on #3914. It's based on work Serena and I are doing to fix a bug (engine does not allow patterning a 3D solid which was sketched on a face of another solid). @gserena01 our test program is now:

w = 400

case = startSketchOn('XY')
  |> startProfileAt([-w, -w], %)
  |> line(endAbsolute = [-w, w])
  |> line(endAbsolute = [w, -w])
  |> line(endAbsolute = [-w, -w])
  |> close()
  |> extrude(length = 200)

bump1 = startSketchOn(case, 'end')
  |> circle({ center = [-50, -50], radius = 40 }, %)
  |> extrude(length = 20)

// We pass in "bump1" here since we want to pattern just this object on the face.
useOriginal = true
target = bump1
transform = {
  axis = [1, 0, 0],
  instances = 3,
  distance = -100
}
patternLinear3d(transform, target, useOriginal)

If you change the useOriginal = true to false you can see the difference.

[qa-wolf]

QA Wolf here! As you write new code it's important that your test coverage is keeping up.
Click here to request test coverage for this PR!

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
modeling-app	✅ Ready (Inspect)	Visit Preview	Feb 6, 2025 5:13pm

[codecov]

Codecov Report

Attention: Patch coverage is 80.32787% with 12 lines in your changes missing coverage. Please review.

Project coverage is 86.04%. Comparing base (11cac0c) to head (9e243c4).
Report is 9 commits behind head on main.

Files with missing lines	Patch %	Lines
src/wasm-lib/kcl/src/std/patterns.rs	86.00%	7 Missing ⚠️
src/wasm-lib/kcl/src/execution/geometry.rs	0.00%	5 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5284      +/-   ##
==========================================
- Coverage   86.05%   86.04%   -0.02%     
==========================================
  Files          92       92              
  Lines       33204    33251      +47     
==========================================
+ Hits        28575    28610      +35     
- Misses       4629     4641      +12     

Flag	Coverage Δ
wasm-lib	86.04% <80.32%> (-0.02%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[jtran]

If I were reading code that uses useOriginal, I think I'd always need to look up the docs. I was trying to think of another name that might make it clearer what the option does. useSketch? Not sure. I can't think of something better.

[jtran]

These two fields are technically a duplicate of each other. That's why I renamed it in #5205. I guess it's fine, though, because they're semantically representing two different things.

[adamchalmers]

Hmm. Yeah I'm OK leaving it because one might change in the future, but we could also come back and remove it. Whatever you'd prefer.