paper 0.16.0 → 0.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. package/CHANGELOG.md +95 -0
  2. package/dist/docs/assets/js/paper.js +4565 -733
  3. package/dist/docs/classes/AreaText.html +720 -242
  4. package/dist/docs/classes/ChangeFlag.html +1 -1
  5. package/dist/docs/classes/Color.html +218 -21
  6. package/dist/docs/classes/CompoundPath.html +1146 -296
  7. package/dist/docs/classes/Curve.html +1 -1
  8. package/dist/docs/classes/CurveLocation.html +1 -1
  9. package/dist/docs/classes/DrawEvent.html +69 -0
  10. package/dist/docs/classes/Effect.html +434 -0
  11. package/dist/docs/classes/EffectInstance.html +304 -0
  12. package/dist/docs/classes/Event.html +1 -1
  13. package/dist/docs/classes/Gradient.html +1 -1
  14. package/dist/docs/classes/GradientStop.html +1 -1
  15. package/dist/docs/classes/Group.html +792 -243
  16. package/dist/docs/classes/HitResult.html +1 -1
  17. package/dist/docs/classes/HostItem.html +720 -242
  18. package/dist/docs/classes/Item.html +777 -242
  19. package/dist/docs/classes/Key.html +1 -1
  20. package/dist/docs/classes/KeyEvent.html +1 -1
  21. package/dist/docs/classes/Layer.html +734 -185
  22. package/dist/docs/classes/Matrix.html +1 -1
  23. package/dist/docs/classes/MouseEvent.html +1 -1
  24. package/dist/docs/classes/PaperScope.html +1 -1
  25. package/dist/docs/classes/PaperScript.html +4 -2
  26. package/dist/docs/classes/Path.html +1195 -252
  27. package/dist/docs/classes/PathItem.html +1148 -298
  28. package/dist/docs/classes/PathText.html +720 -242
  29. package/dist/docs/classes/PatternDefinition.html +367 -0
  30. package/dist/docs/classes/Point.html +1 -1
  31. package/dist/docs/classes/PointText.html +720 -242
  32. package/dist/docs/classes/Project.html +177 -7
  33. package/dist/docs/classes/Raster.html +720 -242
  34. package/dist/docs/classes/Rectangle.html +1 -1
  35. package/dist/docs/classes/Segment.html +3 -3
  36. package/dist/docs/classes/Shape.html +720 -242
  37. package/dist/docs/classes/Size.html +1 -1
  38. package/dist/docs/classes/StrokeProfileStop.html +346 -0
  39. package/dist/docs/classes/Style.html +1 -1
  40. package/dist/docs/classes/SymbolDefinition.html +28 -2
  41. package/dist/docs/classes/SymbolItem.html +720 -242
  42. package/dist/docs/classes/TextItem.html +720 -242
  43. package/dist/docs/classes/TextRange.html +1 -1
  44. package/dist/docs/classes/TextStory.html +1 -1
  45. package/dist/docs/classes/Tool.html +2 -2
  46. package/dist/docs/classes/ToolEvent.html +1 -1
  47. package/dist/docs/classes/Tween.html +1 -1
  48. package/dist/docs/classes/View.html +2 -2
  49. package/dist/docs/classes/global.html +1 -1
  50. package/dist/docs/classes/index.html +2 -2
  51. package/dist/docs/index.html +1 -1
  52. package/dist/node/browser.js +15 -0
  53. package/dist/paper-core.js +4476 -674
  54. package/dist/paper-core.min.js +3 -3
  55. package/dist/paper-full.js +4565 -733
  56. package/dist/paper-full.min.js +3 -3
  57. package/dist/paper-hosted.js +5111 -823
  58. package/dist/paper.d.ts +898 -47
  59. package/examples/Paperjs.org/LiveEffects.html +366 -0
  60. package/examples/Paperjs.org/Offsetting.html +379 -0
  61. package/examples/Paperjs.org/StrokeProfiles.html +706 -0
  62. package/examples/Scripts/Patterns.html +57 -0
  63. package/package.json +5 -3
package/dist/docs/classes/Curve.html CHANGED
@@ -2317,7 +2317,7 @@
2317
2317
 
2318
2318
  <!-- =========================== copyright notice ========================== -->
2319
2319
  <p class="footer">
2320
- Paper.js v0.16.0<br>
2320
+ Paper.js v0.17.0<br>
2321
2321
  Copyright &#169; 2011—2026 <a href="http://www.lehni.org" target="_blank">J&uuml;rg Lehni</a> &amp; <a href="http://www.jonathanpuckey.com" target="_blank">Jonathan Puckey</a>. All Rights Reserved.</p>
2322
2322
  <div class="content-end"></div>
2323
2323
 
package/dist/docs/classes/CurveLocation.html CHANGED
@@ -664,7 +664,7 @@
664
664
 
665
665
  <!-- =========================== copyright notice ========================== -->
666
666
  <p class="footer">
667
- Paper.js v0.16.0<br>
667
+ Paper.js v0.17.0<br>
668
668
  Copyright &#169; 2011—2026 <a href="http://www.lehni.org" target="_blank">J&uuml;rg Lehni</a> &amp; <a href="http://www.jonathanpuckey.com" target="_blank">Jonathan Puckey</a>. All Rights Reserved.</p>
669
669
  <div class="content-end"></div>
670
670
 
package/dist/docs/classes/DrawEvent.html ADDED
@@ -0,0 +1,69 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <title>DrawEvent</title>
6
+ <base target="class-frame">
7
+ <link href="../assets/css/docs.css" rel="stylesheet" type="text/css">
8
+ <script src="../assets/js/paper.js"></script>
9
+ <script src="../assets/js/jquery.js"></script>
10
+ <script src="../assets/js/codemirror.js"></script>
11
+ <script src="../assets/js/docs.js"></script>
12
+ </head>
13
+ <body>
14
+ <article class="reference">
15
+ <div class="reference-class">
16
+ <h1>DrawEvent</h1>
17
+
18
+ <p>The DrawEvent object is received by the <a href="../classes/Item.html"><tt>Item</tt></a>&rsquo;s drawing handlers <a href="../classes/Item.html#ondraw"><tt>item.onDraw</tt></a> and <a href="../classes/Item.html#ondrawselection"><tt>item.onDrawSelection</tt></a>, which describe its fields.</p>
19
+
20
+
21
+ </div>
22
+
23
+
24
+
25
+
26
+
27
+
28
+
29
+
30
+
31
+ <!-- ============================== methods ================================ -->
32
+ <div class="reference-members">
33
+ <h2>Methods</h2>
34
+
35
+
36
+ <div id="preventdefault" class="member">
37
+ <div class="member-link">
38
+ <a name="preventdefault" href="#preventdefault"><tt><b>preventDefault</b>()</tt></a>
39
+ </div>
40
+ <div class="member-description hidden">
41
+ <div class="member-text">
42
+ <p>Skips the item&rsquo;s default drawing, as returning <code>false</code> from the handler does.</p>
43
+
44
+
45
+
46
+
47
+
48
+
49
+
50
+ </div>
51
+ </div>
52
+ </div>
53
+
54
+
55
+
56
+ </div>
57
+
58
+
59
+
60
+
61
+ <!-- =========================== copyright notice ========================== -->
62
+ <p class="footer">
63
+ Paper.js v0.17.0<br>
64
+ Copyright &#169; 2011—2026 <a href="http://www.lehni.org" target="_blank">J&uuml;rg Lehni</a> &amp; <a href="http://www.jonathanpuckey.com" target="_blank">Jonathan Puckey</a>. All Rights Reserved.</p>
65
+ <div class="content-end"></div>
66
+
67
+
68
+ </article>
69
+ </body>
package/dist/docs/classes/Effect.html ADDED
@@ -0,0 +1,434 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <title>Effect</title>
6
+ <base target="class-frame">
7
+ <link href="../assets/css/docs.css" rel="stylesheet" type="text/css">
8
+ <script src="../assets/js/paper.js"></script>
9
+ <script src="../assets/js/jquery.js"></script>
10
+ <script src="../assets/js/codemirror.js"></script>
11
+ <script src="../assets/js/docs.js"></script>
12
+ </head>
13
+ <body>
14
+ <article class="reference">
15
+ <div class="reference-class">
16
+ <h1>Effect</h1>
17
+
18
+ <p>A live effect, which derives what is drawn from an item without changing the item itself, as the effects in Illustrator do. Creating one registers it under its type, replacing any effect registered there before, and items use it by that type, see <a href="../classes/Item.html#effects"><tt>item.effects</tt></a>, each through an <a href="../classes/EffectInstance.html"><tt>EffectInstance</tt></a> with its own parameters.</p>
19
+
20
+
21
+ </div>
22
+
23
+ <!-- =============================== constructors ========================== -->
24
+ <div class="reference-members">
25
+ <h2>Constructors</h2>
26
+
27
+
28
+ <div id="effect-props" class="member">
29
+ <div class="member-link">
30
+ <a name="effect-props" href="#effect-props"><tt><b>Effect</b>(props)</tt></a>
31
+ </div>
32
+ <div class="member-description hidden">
33
+ <div class="member-text">
34
+ <p>Creates an effect and registers it under its type.</p>
35
+
36
+
37
+ <ul class="member-list">
38
+ <h4>Parameters:</h4>
39
+
40
+ <li>
41
+ <tt>props:</tt>
42
+ <tt>Object</tt>
43
+ &mdash;&nbsp;the <a href="../classes/Effect.html#type"><tt>type</tt></a> of the effect, its <a href="../classes/Effect.html#label"><tt>label</tt></a> and <a href="../classes/Effect.html#parameters"><tt>parameters</tt></a>, and <a href="../classes/Effect.html#onapply"><tt>onApply</tt></a> and <a href="../classes/Effect.html#oneditparameters"><tt>onEditParameters</tt></a>
44
+
45
+ </li>
46
+
47
+ </ul>
48
+
49
+
50
+ <ul class="member-list">
51
+ <h4>Returns:</h4>
52
+
53
+ <li>
54
+ <tt><a href="../classes/Effect.html"><tt>Effect</tt></a></tt>
55
+ </li>
56
+
57
+
58
+ </ul>
59
+
60
+
61
+
62
+
63
+
64
+ </div>
65
+ </div>
66
+ </div>
67
+
68
+ </div>
69
+
70
+
71
+
72
+
73
+
74
+ <!-- ================================ properties =========================== -->
75
+ <div class="reference-members">
76
+ <h2>Properties</h2>
77
+
78
+
79
+ <div id="type" class="member">
80
+ <div class="member-link">
81
+ <a name="type" href="#type"><tt><b>type</b></tt></a>
82
+ </div>
83
+ <div class="member-description hidden">
84
+
85
+ <div class="member-text">
86
+ <p>The type that the effect is registered under, and that items use it by.</p>
87
+
88
+ <p>Read only.</p>
89
+
90
+
91
+
92
+ <ul class="member-list">
93
+ <h4>Type:</h4>
94
+ <li>
95
+ <tt>String</tt>
96
+ </li>
97
+ </ul>
98
+
99
+
100
+
101
+ </div>
102
+
103
+ </div>
104
+ </div>
105
+
106
+
107
+ <div id="label" class="member">
108
+ <div class="member-link">
109
+ <a name="label" href="#label"><tt><b>label</b></tt></a>
110
+ </div>
111
+ <div class="member-description hidden">
112
+
113
+ <div class="member-text">
114
+ <p>The label of the effect, for hosts to show to users.</p>
115
+
116
+ <p>Read only.</p>
117
+
118
+
119
+
120
+ <ul class="member-list">
121
+ <h4>Default:</h4>
122
+ <li><tt>the type</tt></li>
123
+ </ul>
124
+
125
+ <ul class="member-list">
126
+ <h4>Type:</h4>
127
+ <li>
128
+ <tt>String</tt>
129
+ </li>
130
+ </ul>
131
+
132
+
133
+
134
+ </div>
135
+
136
+ </div>
137
+ </div>
138
+
139
+
140
+ <div id="parameters" class="member">
141
+ <div class="member-link">
142
+ <a name="parameters" href="#parameters"><tt><b>parameters</b></tt></a>
143
+ </div>
144
+ <div class="member-description hidden">
145
+
146
+ <div class="member-text">
147
+ <p>The declared parameters of the effect by their names, as objects that describe them for hosts to build their settings from, with the default as their <code>value</code>, e.g. <code>{ label: &#39;Amount&#39;, type: &#39;number&#39;, range: [0, 100], value: 10 }</code>. The instances of the effect have them as properties.</p>
148
+
149
+ <p>Read only.</p>
150
+
151
+
152
+
153
+ <ul class="member-list">
154
+ <h4>Type:</h4>
155
+ <li>
156
+ <tt>Object</tt>
157
+ </li>
158
+ </ul>
159
+
160
+
161
+
162
+ </div>
163
+
164
+ </div>
165
+ </div>
166
+
167
+
168
+ <div id="onapply" class="member">
169
+ <div class="member-link">
170
+ <a name="onapply" href="#onapply"><tt><b>onApply</b></tt></a>
171
+ </div>
172
+ <div class="member-description hidden">
173
+
174
+ <div class="member-text">
175
+ <p>The function that applies the effect, called with the instance as <code>this</code>, and returning what the effect makes of the art that it gets, which it doesn&rsquo;t change.</p>
176
+
177
+
178
+
179
+ <ul class="member-list">
180
+ <h4>Type:</h4>
181
+ <li>
182
+ <tt>Function</tt>⟋<tt>null</tt>
183
+ </li>
184
+ </ul>
185
+ <ul class="member-list">
186
+ <h4>Options:</h4>
187
+ <li><tt>event.art: <a href="../classes/Item.html"><tt>Item</tt></a></tt> &mdash; the item to apply the effect to, or what the effect before it returned</li>
188
+ <li><tt>event.item: <a href="../classes/Item.html"><tt>Item</tt></a></tt> &mdash; the item that the instance is part of</li>
189
+ </ul>
190
+
191
+
192
+ </div>
193
+
194
+ </div>
195
+ </div>
196
+
197
+
198
+ <div id="oneditparameters" class="member">
199
+ <div class="member-link">
200
+ <a name="oneditparameters" href="#oneditparameters"><tt><b>onEditParameters</b></tt></a>
201
+ </div>
202
+ <div class="member-description hidden">
203
+
204
+ <div class="member-text">
205
+ <p>The function that hosts call when the user edits the parameters of an instance, with the instance as <code>this</code>, to set its properties. Paper.js itself doesn&rsquo;t call it.</p>
206
+
207
+
208
+
209
+ <ul class="member-list">
210
+ <h4>Type:</h4>
211
+ <li>
212
+ <tt>Function</tt>⟋<tt>null</tt>
213
+ </li>
214
+ </ul>
215
+
216
+
217
+
218
+ </div>
219
+
220
+ </div>
221
+ </div>
222
+
223
+ </div>
224
+
225
+
226
+
227
+
228
+
229
+ <!-- ============================== methods ================================ -->
230
+ <div class="reference-members">
231
+ <h2>Methods</h2>
232
+
233
+
234
+ <div id="remove" class="member">
235
+ <div class="member-link">
236
+ <a name="remove" href="#remove"><tt><b>remove</b>()</tt></a>
237
+ </div>
238
+ <div class="member-description hidden">
239
+ <div class="member-text">
240
+ <p>Removes the effect from the registered effects.</p>
241
+
242
+
243
+
244
+ <ul class="member-list">
245
+ <h4>Returns:</h4>
246
+
247
+ <li>
248
+ <tt><tt>Boolean</tt></tt>&nbsp;&mdash;&nbsp;<tt>true</tt> if the effect was registered, <tt>false</tt> otherwise
249
+ </li>
250
+
251
+
252
+ </ul>
253
+
254
+
255
+
256
+
257
+
258
+ </div>
259
+ </div>
260
+ </div>
261
+
262
+
263
+
264
+ </div>
265
+
266
+
267
+ <div class="reference-members">
268
+ <h2>Static Methods</h2>
269
+
270
+
271
+ <div id="add-effect" class="member">
272
+ <div class="member-link">
273
+ <a name="add-effect" href="#add-effect"><tt><b>Effect.add</b>(effect)</tt></a>
274
+ </div>
275
+ <div class="member-description hidden">
276
+ <div class="member-text">
277
+ <p>Registers the effect under its type, replacing any effect registered there before. Effects register themselves when they are created.</p>
278
+
279
+
280
+ <ul class="member-list">
281
+ <h4>Parameters:</h4>
282
+
283
+ <li>
284
+ <tt>effect:</tt>
285
+ <a href="../classes/Effect.html"><tt>Effect</tt></a>
286
+
287
+
288
+ </li>
289
+
290
+ </ul>
291
+
292
+
293
+ <ul class="member-list">
294
+ <h4>Returns:</h4>
295
+
296
+ <li>
297
+ <tt><a href="../classes/Effect.html"><tt>Effect</tt></a></tt>&nbsp;&mdash;&nbsp;the effect
298
+ </li>
299
+
300
+
301
+ </ul>
302
+
303
+
304
+
305
+
306
+
307
+ </div>
308
+ </div>
309
+ </div>
310
+
311
+
312
+ <div id="get-type" class="member">
313
+ <div class="member-link">
314
+ <a name="get-type" href="#get-type"><tt><b>Effect.get</b>(type)</tt></a>
315
+ </div>
316
+ <div class="member-description hidden">
317
+ <div class="member-text">
318
+ <p>Returns the effect registered under the type.</p>
319
+
320
+
321
+ <ul class="member-list">
322
+ <h4>Parameters:</h4>
323
+
324
+ <li>
325
+ <tt>type:</tt>
326
+ <tt>String</tt>
327
+
328
+
329
+ </li>
330
+
331
+ </ul>
332
+
333
+
334
+ <ul class="member-list">
335
+ <h4>Returns:</h4>
336
+
337
+ <li>
338
+ <tt><a href="../classes/Effect.html"><tt>Effect</tt></a>⟋<tt>null</tt></tt>&nbsp;&mdash;&nbsp;the effect, or <code>null</code>
339
+ </li>
340
+
341
+
342
+ </ul>
343
+
344
+
345
+
346
+
347
+
348
+ </div>
349
+ </div>
350
+ </div>
351
+
352
+
353
+ <div id="getall" class="member">
354
+ <div class="member-link">
355
+ <a name="getall" href="#getall"><tt><b>Effect.getAll</b>()</tt></a>
356
+ </div>
357
+ <div class="member-description hidden">
358
+ <div class="member-text">
359
+ <p>Returns all registered effects.</p>
360
+
361
+
362
+
363
+ <ul class="member-list">
364
+ <h4>Returns:</h4>
365
+
366
+ <li>
367
+ <tt>Array of <a href="../classes/Effect.html"><tt>Effect</tt></a> objects</tt>&nbsp;&mdash;&nbsp;the effects
368
+ </li>
369
+
370
+
371
+ </ul>
372
+
373
+
374
+
375
+
376
+
377
+ </div>
378
+ </div>
379
+ </div>
380
+
381
+
382
+ <div id="remove-effect" class="member">
383
+ <div class="member-link">
384
+ <a name="remove-effect" href="#remove-effect"><tt><b>Effect.remove</b>(effect)</tt></a>
385
+ </div>
386
+ <div class="member-description hidden">
387
+ <div class="member-text">
388
+ <p>Removes the effect from the registered effects.</p>
389
+
390
+
391
+ <ul class="member-list">
392
+ <h4>Parameters:</h4>
393
+
394
+ <li>
395
+ <tt>effect:</tt>
396
+ <a href="../classes/Effect.html"><tt>Effect</tt></a>
397
+
398
+
399
+ </li>
400
+
401
+ </ul>
402
+
403
+
404
+ <ul class="member-list">
405
+ <h4>Returns:</h4>
406
+
407
+ <li>
408
+ <tt><tt>Boolean</tt></tt>&nbsp;&mdash;&nbsp;<tt>true</tt> if the effect was registered, <tt>false</tt> otherwise
409
+ </li>
410
+
411
+
412
+ </ul>
413
+
414
+
415
+
416
+
417
+
418
+ </div>
419
+ </div>
420
+ </div>
421
+
422
+ </div>
423
+
424
+
425
+
426
+ <!-- =========================== copyright notice ========================== -->
427
+ <p class="footer">
428
+ Paper.js v0.17.0<br>
429
+ Copyright &#169; 2011—2026 <a href="http://www.lehni.org" target="_blank">J&uuml;rg Lehni</a> &amp; <a href="http://www.jonathanpuckey.com" target="_blank">Jonathan Puckey</a>. All Rights Reserved.</p>
430
+ <div class="content-end"></div>
431
+
432
+
433
+ </article>
434
+ </body>