1
0
Fork 0
Commit graph

266 commits

Author SHA1 Message Date
joostdecock
eded9e9d3a fix(core): Handle path splits on start or end points
In some edge cases, like when splitting a path on or very close to its
start or end point, `Path.split()` will return an array in which one of
the elements is not a Path object, but rather an empty array.

That is rather combersome to check for, so this changes that behaviour
and will return null for such cases.

I've also updated the documentation to clarify this behaviour.

Fixes #6816

This also fixes a bug when a path was being split on its end point.
2024-06-12 13:24:42 +02:00
Jonathan Haas
ed608b52a0
Add documentation and rename method 2024-04-18 10:53:30 +02:00
Jonathan Haas
849563d1ec
add(core): Add Path.rotate(...) function analogue to Point.rotate(...) 2024-04-05 14:45:20 +02:00
Benjamin Fan
23b87ad208 fix(markdown): Typo in doc for utils.beamIntersectsCurve() 2024-03-16 21:39:31 -07:00
Benjamin Fan
8075a4bd14 fix(markdown): Correct and normalize utils docs 2024-02-22 05:19:22 -08:00
Benjamin Fan
1c38b4518b fix(markdown): Correct mergeOptions() signature 2024-02-21 19:47:27 -08:00
Joost De Cock
fac2cc3424
Merge pull request #6030 from BenJamesBen/design-options-menu-order
feat(shared): Optional ordering for design options and menus
2024-02-13 19:00:21 +01:00
Benjamin Fan
ca0947d486 fix(markdown): Add alphabetic sort information to doc 2024-02-12 10:55:54 -08:00
Benjamin Fan
e4a07a0c93 fix(shared): Use order attribute instead of sort. Add freesewing.org UI behavior info. 2024-02-12 08:45:09 -08:00
Joost De Cock
8f7fffb81e
Merge pull request #6019 from BenJamesBen/path-combine-typo
fix(markdown): Typo in Path.combine() doc
2024-02-12 17:44:02 +01:00
Joost De Cock
1c05607f97
Merge pull request #6021 from BenJamesBen/pattern-draftpartforset-doc
fix(markdown): Add Pattern.draftPartForSet() documentation
2024-02-12 17:43:28 +01:00
Benjamin Fan
a1392cba2e feat(shared): Optional ordering for design options and menus 2024-02-12 08:29:04 -08:00
Benjamin Fan
85c858d824 fix(markdown): Typo in Path.combine() doc 2024-02-11 09:39:48 -08:00
Joost De Cock
2d43e0408e
Merge pull request #5990 from BenJamesBen/path-doc-update
fix(markdown): Path doc updates for optional parameters
2024-02-11 17:37:39 +01:00
Joost De Cock
9208ad7513
Merge pull request #6013 from BenJamesBen/part-path-excluded
fix(markdown): Typo in Part and Path docs
2024-02-11 17:36:58 +01:00
Benjamin Fan
ab83799c2c chore(markdown): Revert Join doc to develop version 2024-02-11 06:52:59 -08:00
Benjamin Fan
c2d5b943b6 fix(markdown): Change optional parameter doc format from man page to JavaScript 2024-02-11 06:48:51 -08:00
Benjamin Fan
bf4b4c8755 fix(markdown): Clarify optional parameters for Path methods docs 2024-02-11 06:48:50 -08:00
Benjamin Fan
7bc8e0c76a fix(markdown): Add closed parameter to Path.join() doc 2024-02-11 06:48:50 -08:00
Joost De Cock
10588d312c
Merge pull request #5992 from BenJamesBen/attributes-defs-properties-docs
fix(markdown): Add missing list property to Attributes and Defs docs
2024-02-11 15:41:55 +01:00
Benjamin Fan
74d30ec8b6 fix(markdown): In Attributes and Defs docs, correct list property description 2024-02-11 06:23:18 -08:00
Benjamin Fan
fb03e18ed9 fix(markdown): Typo in Part and Path docs 2024-02-11 06:07:51 -08:00
Joost De Cock
4d94b8d8ca
Merge pull request #6001 from freesewing/joost
feat(core): Added Path.combine and related changes, closes #5976
2024-02-10 16:00:27 +01:00
joostdecock
a30b08371c feat(core): Added Path.combine and related changes, closes #5976
The discussion in #5976 is whether `Path.join()` should use a line
segment to close any gaps in the path caused by move operations, or by
differences in the end and start points of paths being joined.

The answer is yes, that is the intended behaviour, but people who read
_join_ might expect differently.

So I have made a few changes to clarify this:

- The new `Path.combine()` method combines multiple path instances into
  a single instance without making any changes to the drawing operations
- Since `Path.combine()` is variadic, I have also updated `Path.join()`
  to be variadic too, since that is more consistent.
- The old way of calling `Path.join(path, bool)` is deprecated and will
  log a warning. Calling `Path.join()` this way will be removed in v4.
- Related to this change is how `Path.length()` should behave when there
  are gaps in the path. Currently, it skips those. So I've added a
  parameter that when set to `true` will include them.
- Added documentation for `Path.combine()`
- Updated documentation for `Path.join()`
- Updated documentation for `Path.length()`
2024-02-10 15:40:41 +01:00
Joost De Cock
60c5f652cd
Merge pull request #5995 from BenJamesBen/part-docs-update
fix(markdown): In Part doc, add properties and methods
2024-02-10 14:23:24 +01:00
Joost De Cock
bc39e00558
Merge pull request #5994 from BenJamesBen/asprops-docs-removal
chore(markdown): Remove obsolete Part.asProps() doc
2024-02-10 14:22:03 +01:00
Benjamin Fan
095d6a8253 fix(markdown): In Part doc, add properties and methods 2024-02-09 07:23:08 -08:00
Benjamin Fan
07e0f21f30 fix(markdown): Typo in Path doc 2024-02-09 07:18:26 -08:00
Benjamin Fan
300bfee04c chore(markdown): Remove obsolete Part.asProps() doc 2024-02-09 05:55:11 -08:00
Benjamin Fan
e10b665f36 fix(markdown): Add missing list property to Attributes and Defs docs 2024-02-08 12:43:45 -08:00
Benjamin Fan
75f5376019 fix(markdown): In Store doc, add link to new Store Methods doc 2024-02-07 08:47:54 -08:00
Benjamin Fan
97002a74a7 fix(markdown): Correct logging links to new Store Methods doc 2024-02-07 08:47:48 -08:00
Joost De Cock
6c0a579a35
Merge pull request #5899 from BenJamesBen/add-svg-render-doc
chore(markdown): Add Svg.render() documentation
2024-02-03 17:10:07 +01:00
Benjamin Fan
c7bee798d0 fix(markdown): Add Pattern.draftPartForSet() documentation 2024-02-02 10:05:59 -08:00
Joost De Cock
1b2605c274
Merge pull request #5930 from BenJamesBen/readmore-remove-list-attribute
fix(markdown): Remove unused list attribute from ReadMore tags
2024-01-30 19:11:34 +01:00
Joost De Cock
4bd94950fd
Merge pull request #5931 from BenJamesBen/extend-options-doc
fix(markdown): Add more info to Extending Options part doc
2024-01-30 19:11:06 +01:00
Benjamin Fan
576f1e5baf fix(markdown): Add cbqc and goldenRatio links and info to core API 2024-01-29 15:40:33 -08:00
Benjamin Fan
06b460cf9c fix(markdown): Add more info to Extending Options part doc 2024-01-29 14:03:04 -08:00
Benjamin Fan
83ae88c5d5 fix(markdown): Remove unused list attribute from ReadMore tags 2024-01-29 08:43:38 -08:00
Benjamin Fan
c5498b93f5 chore(markdown): Document Svg.render() as a mostly-internal method 2024-01-27 07:06:19 -08:00
Benjamin Fan
21cca5e270 fix(markdown): Fix Svg.asRenderProps() documentation grammar 2024-01-24 20:21:08 -08:00
Benjamin Fan
9593e8d078 chore(markdown): Add Svg.render() documentation 2024-01-24 20:20:10 -08:00
Benjamin Fan
5828e53937 fix(core): Remove Svg.body property 2024-01-24 20:18:03 -08:00
Benjamin Fan
4d404dd3cc fix(markdown) Fix typos 2024-01-21 11:16:40 -08:00
Wouter van Wageningen
be24625373
Merge pull request #17 from freesewing/develop
catchup
2024-01-08 22:34:30 -08:00
joostdecock
42a4d39807 fix(markdown): Remove stack example 2024-01-07 17:25:07 +01:00
Wouter van Wageningen
e22b97c18a
Update freesewing/markdown/dev/reference/api/part/config/dependencies/en.md
Missing 'r' in 'From:'
2024-01-05 13:19:16 -08:00
Thrunic
4ecbbbddb0 Replaced path.addClass(...) with path.setClass(...) in the example. 2023-12-08 13:28:42 -05:00
joostdecock
dae323b697 fix(markdown): Broken links. Closes #5463 2023-11-12 11:13:38 +01:00
joostdecock
e35bda36f7 chore(markdown): Changes to refer less to models 2023-10-30 19:27:24 +01:00