feat: shape clipping #1411
Merged
feat: shape clipping #1411
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Deploying with
|
| Latest commit: |
0fc40c9
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://26508e65.penrose-72l.pages.dev |
| Branch Preview URL: | https://clip.penrose-72l.pages.dev |
± Registry diff📊 PerformanceKeyNote that each bar component rounds up to the nearest 100ms, so each full bar is an overestimate by up to 400ms. If a row has only one bar instead of four, that means it's not a trio and the bar just shows the total time spent for that example, again rounded up to the nearest 100ms. Data |
Codecov Report
@@ Coverage Diff @@
## main #1411 +/- ##
==========================================
- Coverage 64.77% 64.42% -0.36%
==========================================
Files 64 64
Lines 7515 7586 +71
Branches 1760 1775 +15
==========================================
+ Hits 4868 4887 +19
- Misses 2521 2570 +49
- Partials 126 129 +3
|
|
This looks good from the language design end. It's a bit unfortunate we can't just do |
docs: add a line that explains the image makeIdsUnique call
|
Merged
|
|
Thanks for catching this! |
wodeni
approved these changes
Jun 2, 2023
There was a problem hiding this comment.
Looks great! Thanks for adding this feature. As mentioned, I fixed one issue with id-uniqueness. I also added inline comments for makeIdsUnique to clarify its purpose (which is not used in this case so I explained why there) and for the implicit group membership of clipping shapes.
This was referenced Jul 20, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Resolves #1405.
We implement shape-clipping and improve a couple of library computation and constraint functions to work with clipped shapes.
GroupShapeclipPathPropertyA
Groupshape now has an additionalclipPathproperty that takes aClipDataVvalue. AClipDataVvalue has two variants:NoClip(which takes no additional data) andClip(which takes in aShapeobject). AClipDataVcan be constructed using one of two computation functions:noCliptakes no parameters and returns theNoClipvariant.cliptakes in a shape and returns theClipvariant with the given shape.The default value of the
Groupshape'sclipPathproperty is theNoClipvariant.As an example, suppose we have shapes
s1ands2in a group, and we want to clip the group by shapes3. We can write,A shape involved in the
clipPathfield of aGroupis considered a part of the group through all stages of the compilation, including the construction of theGroupGraph, so all the usual rules of shapes not belonging to multiple groups still apply. That is,clipPathof a group cannot appear in any other group, and cannot be used to clip another group; andCorresponding SVG
Since a shape in
clipPathis considered a group member, we render them with all other group members. For a group withclipPath, the generated SVG has structure,The
clipPathSVG object idsome-idis the name of the clipping shape, with suffix-clip. For example, if the clipping shape name ismyShape, then theclipPathSVG object id ismyShape-clip.Bounding Box
Previously, the bounding box of a
Groupshape is simply the min-max-bbox. That is, take the bounding boxes of all group members, and then find the min-x, min-y, max-x, max-y, and use those to construct a new bounding box.If a
Groupshape has a clipping shape, we compute the new bounding box as the previous bounding box, intersecting the bounding box of the clipping shape.In the picture above, the bounding box of the yellow region (the larger ellipse clipped by the smaller ellipse) is computed as the bolded blue rectangle. One may observe that this bounding box is not optimum. Indeed, this box is not a "minimum bounding box" as it can overestimate the object. But this is relatively simple to compute.
Constraint
containsWe add a branch to the
containsconstraint to deal with groups.If a group does not have a clipping shape, checking whether a group contains a shape is equivalent to checking whether some group member contains the shape. We simply compute the
containsconstraint penalty between all of the group members and the shape, and take the minimum. If the minimum of the penalties is small, then one group member must contain the shape.If a group has a clipping shape, then the
containsconstraint between the group and another shape just requires:We compute both constraints, and require that both constraints hold.
Examples with steps to reproduce them
https://clip.penrose-72l.pages.dev/try/?gist=11c14ac7a7e0cf45a13ec68066925b18
This example shows two sets, with their intersection between marked out using clipping. We also demonstrate the bounding box of the intersection (see the rectangle) and the
containsconstraint (the small, red circle is within the intersection).Checklist