@twick/2d 0.13.0 → 0.14.2

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 (171) hide show
  1. package/LICENSE +21 -0
  2. package/editor/editor/tsconfig.build.tsbuildinfo +1 -1
  3. package/lib/components/Audio.js +3 -3
  4. package/lib/components/Img.js +23 -23
  5. package/lib/components/Line.js +31 -31
  6. package/lib/components/Media.d.ts +1 -1
  7. package/lib/components/Media.d.ts.map +1 -1
  8. package/lib/components/Media.js +26 -26
  9. package/lib/components/Spline.js +25 -25
  10. package/lib/components/Video.js +3 -3
  11. package/lib/tsconfig.build.tsbuildinfo +1 -1
  12. package/package.json +5 -4
  13. package/src/editor/NodeInspectorConfig.tsx +76 -76
  14. package/src/editor/PreviewOverlayConfig.tsx +67 -67
  15. package/src/editor/Provider.tsx +93 -93
  16. package/src/editor/SceneGraphTabConfig.tsx +81 -81
  17. package/src/editor/icons/CircleIcon.tsx +7 -7
  18. package/src/editor/icons/CodeBlockIcon.tsx +8 -8
  19. package/src/editor/icons/CurveIcon.tsx +7 -7
  20. package/src/editor/icons/GridIcon.tsx +7 -7
  21. package/src/editor/icons/IconMap.ts +35 -35
  22. package/src/editor/icons/ImgIcon.tsx +8 -8
  23. package/src/editor/icons/LayoutIcon.tsx +9 -9
  24. package/src/editor/icons/LineIcon.tsx +7 -7
  25. package/src/editor/icons/NodeIcon.tsx +7 -7
  26. package/src/editor/icons/RayIcon.tsx +7 -7
  27. package/src/editor/icons/RectIcon.tsx +7 -7
  28. package/src/editor/icons/ShapeIcon.tsx +7 -7
  29. package/src/editor/icons/TxtIcon.tsx +8 -8
  30. package/src/editor/icons/VideoIcon.tsx +7 -7
  31. package/src/editor/icons/View2DIcon.tsx +10 -10
  32. package/src/editor/index.ts +17 -17
  33. package/src/editor/tree/DetachedRoot.tsx +23 -23
  34. package/src/editor/tree/NodeElement.tsx +74 -74
  35. package/src/editor/tree/TreeElement.tsx +72 -72
  36. package/src/editor/tree/TreeRoot.tsx +10 -10
  37. package/src/editor/tree/ViewRoot.tsx +20 -20
  38. package/src/editor/tree/index.module.scss +38 -38
  39. package/src/editor/tree/index.ts +3 -3
  40. package/src/editor/tsconfig.build.json +5 -5
  41. package/src/editor/tsconfig.json +12 -12
  42. package/src/editor/tsdoc.json +4 -4
  43. package/src/editor/vite-env.d.ts +1 -1
  44. package/src/lib/code/CodeCursor.ts +445 -445
  45. package/src/lib/code/CodeDiffer.ts +78 -78
  46. package/src/lib/code/CodeFragment.ts +97 -97
  47. package/src/lib/code/CodeHighlighter.ts +75 -75
  48. package/src/lib/code/CodeMetrics.ts +47 -47
  49. package/src/lib/code/CodeRange.test.ts +74 -74
  50. package/src/lib/code/CodeRange.ts +216 -216
  51. package/src/lib/code/CodeScope.ts +101 -101
  52. package/src/lib/code/CodeSelection.ts +24 -24
  53. package/src/lib/code/CodeSignal.ts +327 -327
  54. package/src/lib/code/CodeTokenizer.ts +54 -54
  55. package/src/lib/code/DefaultHighlightStyle.ts +98 -98
  56. package/src/lib/code/LezerHighlighter.ts +113 -113
  57. package/src/lib/code/diff.test.ts +311 -311
  58. package/src/lib/code/diff.ts +319 -319
  59. package/src/lib/code/extractRange.ts +126 -126
  60. package/src/lib/code/index.ts +13 -13
  61. package/src/lib/components/Audio.ts +168 -168
  62. package/src/lib/components/Bezier.ts +105 -105
  63. package/src/lib/components/Circle.ts +266 -266
  64. package/src/lib/components/Code.ts +526 -526
  65. package/src/lib/components/CodeBlock.ts +576 -576
  66. package/src/lib/components/CubicBezier.ts +112 -112
  67. package/src/lib/components/Curve.ts +455 -455
  68. package/src/lib/components/Grid.ts +135 -135
  69. package/src/lib/components/Icon.ts +96 -96
  70. package/src/lib/components/Img.ts +319 -319
  71. package/src/lib/components/Knot.ts +157 -157
  72. package/src/lib/components/Latex.ts +122 -122
  73. package/src/lib/components/Layout.ts +1092 -1092
  74. package/src/lib/components/Line.ts +429 -429
  75. package/src/lib/components/Media.ts +576 -576
  76. package/src/lib/components/Node.ts +1940 -1940
  77. package/src/lib/components/Path.ts +137 -137
  78. package/src/lib/components/Polygon.ts +171 -171
  79. package/src/lib/components/QuadBezier.ts +100 -100
  80. package/src/lib/components/Ray.ts +125 -125
  81. package/src/lib/components/Rect.ts +187 -187
  82. package/src/lib/components/Rive.ts +156 -156
  83. package/src/lib/components/SVG.ts +797 -797
  84. package/src/lib/components/Shape.ts +143 -143
  85. package/src/lib/components/Spline.ts +344 -344
  86. package/src/lib/components/Txt.test.tsx +81 -81
  87. package/src/lib/components/Txt.ts +203 -203
  88. package/src/lib/components/TxtLeaf.ts +205 -205
  89. package/src/lib/components/Video.ts +461 -461
  90. package/src/lib/components/View2D.ts +98 -98
  91. package/src/lib/components/__tests__/children.test.tsx +142 -142
  92. package/src/lib/components/__tests__/clone.test.tsx +126 -126
  93. package/src/lib/components/__tests__/generatorTest.ts +28 -28
  94. package/src/lib/components/__tests__/mockScene2D.ts +45 -45
  95. package/src/lib/components/__tests__/query.test.tsx +122 -122
  96. package/src/lib/components/__tests__/state.test.tsx +60 -60
  97. package/src/lib/components/index.ts +28 -28
  98. package/src/lib/components/types.ts +35 -35
  99. package/src/lib/curves/ArcSegment.ts +159 -159
  100. package/src/lib/curves/CircleSegment.ts +77 -77
  101. package/src/lib/curves/CubicBezierSegment.ts +78 -78
  102. package/src/lib/curves/CurveDrawingInfo.ts +11 -11
  103. package/src/lib/curves/CurvePoint.ts +15 -15
  104. package/src/lib/curves/CurveProfile.ts +7 -7
  105. package/src/lib/curves/KnotInfo.ts +10 -10
  106. package/src/lib/curves/LineSegment.ts +62 -62
  107. package/src/lib/curves/Polynomial.ts +355 -355
  108. package/src/lib/curves/Polynomial2D.ts +62 -62
  109. package/src/lib/curves/PolynomialSegment.ts +124 -124
  110. package/src/lib/curves/QuadBezierSegment.ts +64 -64
  111. package/src/lib/curves/Segment.ts +17 -17
  112. package/src/lib/curves/UniformPolynomialCurveSampler.ts +94 -94
  113. package/src/lib/curves/createCurveProfileLerp.ts +471 -471
  114. package/src/lib/curves/getBezierSplineProfile.ts +223 -223
  115. package/src/lib/curves/getCircleProfile.ts +86 -86
  116. package/src/lib/curves/getPathProfile.ts +178 -178
  117. package/src/lib/curves/getPointAtDistance.ts +21 -21
  118. package/src/lib/curves/getPolylineProfile.test.ts +21 -21
  119. package/src/lib/curves/getPolylineProfile.ts +89 -89
  120. package/src/lib/curves/getRectProfile.ts +139 -139
  121. package/src/lib/curves/index.ts +16 -16
  122. package/src/lib/decorators/canvasStyleSignal.ts +16 -16
  123. package/src/lib/decorators/colorSignal.ts +9 -9
  124. package/src/lib/decorators/compound.ts +72 -72
  125. package/src/lib/decorators/computed.ts +18 -18
  126. package/src/lib/decorators/defaultStyle.ts +18 -18
  127. package/src/lib/decorators/filtersSignal.ts +136 -136
  128. package/src/lib/decorators/index.ts +10 -10
  129. package/src/lib/decorators/initializers.ts +32 -32
  130. package/src/lib/decorators/nodeName.ts +13 -13
  131. package/src/lib/decorators/signal.test.ts +90 -90
  132. package/src/lib/decorators/signal.ts +345 -345
  133. package/src/lib/decorators/spacingSignal.ts +15 -15
  134. package/src/lib/decorators/vector2Signal.ts +30 -30
  135. package/src/lib/globals.d.ts +2 -2
  136. package/src/lib/index.ts +8 -8
  137. package/src/lib/jsx-dev-runtime.ts +2 -2
  138. package/src/lib/jsx-runtime.ts +46 -46
  139. package/src/lib/parse-svg-path.d.ts +14 -14
  140. package/src/lib/partials/Filter.ts +180 -180
  141. package/src/lib/partials/Gradient.ts +102 -102
  142. package/src/lib/partials/Pattern.ts +34 -34
  143. package/src/lib/partials/ShaderConfig.ts +117 -117
  144. package/src/lib/partials/index.ts +4 -4
  145. package/src/lib/partials/types.ts +58 -58
  146. package/src/lib/scenes/Scene2D.ts +242 -242
  147. package/src/lib/scenes/index.ts +3 -3
  148. package/src/lib/scenes/makeScene2D.ts +16 -16
  149. package/src/lib/scenes/useScene2D.ts +6 -6
  150. package/src/lib/tsconfig.build.json +5 -5
  151. package/src/lib/tsconfig.json +10 -10
  152. package/src/lib/tsdoc.json +4 -4
  153. package/src/lib/utils/CanvasUtils.ts +306 -306
  154. package/src/lib/utils/diff.test.ts +453 -453
  155. package/src/lib/utils/diff.ts +148 -148
  156. package/src/lib/utils/index.ts +2 -2
  157. package/src/lib/utils/is.ts +11 -11
  158. package/src/lib/utils/makeSignalExtensions.ts +30 -30
  159. package/src/lib/utils/video/declarations.d.ts +1 -1
  160. package/src/lib/utils/video/ffmpeg-client.ts +50 -50
  161. package/src/lib/utils/video/mp4-parser-manager.ts +72 -72
  162. package/src/lib/utils/video/parser/index.ts +1 -1
  163. package/src/lib/utils/video/parser/parser.ts +257 -257
  164. package/src/lib/utils/video/parser/sampler.ts +72 -72
  165. package/src/lib/utils/video/parser/segment.ts +302 -302
  166. package/src/lib/utils/video/parser/sink.ts +29 -29
  167. package/src/lib/utils/video/parser/utils.ts +31 -31
  168. package/src/tsconfig.base.json +19 -19
  169. package/src/tsconfig.build.json +8 -8
  170. package/src/tsconfig.json +5 -5
  171. package/tsconfig.project.json +7 -7
@@ -1,455 +1,455 @@
1
- import type {
2
- BBox,
3
- SerializedVector2,
4
- SignalValue,
5
- SimpleSignal,
6
- } from '@twick/core';
7
- import {Vector2, clamp} from '@twick/core';
8
- import type {CurveDrawingInfo} from '../curves/CurveDrawingInfo';
9
- import type {CurvePoint} from '../curves/CurvePoint';
10
- import type {CurveProfile} from '../curves/CurveProfile';
11
- import {getPointAtDistance} from '../curves/getPointAtDistance';
12
- import {computed, initial, nodeName, signal} from '../decorators';
13
- import type {DesiredLength} from '../partials';
14
- import {lineTo, moveTo, resolveCanvasStyle} from '../utils';
15
- import type {ShapeProps} from './Shape';
16
- import {Shape} from './Shape';
17
-
18
- export interface CurveProps extends ShapeProps {
19
- /**
20
- * {@inheritDoc Curve.closed}
21
- */
22
- closed?: SignalValue<boolean>;
23
- /**
24
- * {@inheritDoc Curve.start}
25
- */
26
- start?: SignalValue<number>;
27
- /**
28
- * {@inheritDoc Curve.startOffset}
29
- */
30
- startOffset?: SignalValue<number>;
31
- /**
32
- * {@inheritDoc Curve.startArrow}
33
- */
34
- startArrow?: SignalValue<boolean>;
35
- /**
36
- * {@inheritDoc Curve.end}
37
- */
38
- end?: SignalValue<number>;
39
- /**
40
- * {@inheritDoc Curve.endOffset}
41
- */
42
- endOffset?: SignalValue<number>;
43
- /**
44
- * {@inheritDoc Curve.endArrow}
45
- */
46
- endArrow?: SignalValue<boolean>;
47
- /**
48
- * {@inheritDoc Curve.arrowSize}
49
- */
50
- arrowSize?: SignalValue<number>;
51
- }
52
-
53
- @nodeName('Curve')
54
- export abstract class Curve extends Shape {
55
- /**
56
- * Whether the curve should be closed.
57
- *
58
- * @remarks
59
- * Closed curves have their start and end points connected.
60
- */
61
- @initial(false)
62
- @signal()
63
- public declare readonly closed: SimpleSignal<boolean, this>;
64
-
65
- /**
66
- * A percentage from the start before which the curve should be clipped.
67
- *
68
- * @remarks
69
- * The portion of the curve that comes before the given percentage will be
70
- * made invisible.
71
- *
72
- * This property is usefully for animating the curve appearing on the screen.
73
- * The value of `0` means the very start of the curve (accounting for the
74
- * {@link startOffset}) while `1` means the very end (accounting for the
75
- * {@link endOffset}).
76
- */
77
- @initial(0)
78
- @signal()
79
- public declare readonly start: SimpleSignal<number, this>;
80
-
81
- /**
82
- * The offset in pixels from the start of the curve.
83
- *
84
- * @remarks
85
- * This property lets you specify where along the defined curve the actual
86
- * visible portion starts. For example, setting it to `20` will make the first
87
- * 20 pixels of the curve invisible.
88
- *
89
- * This property is useful for trimming the curve using a fixed distance.
90
- * If you want to animate the curve appearing on the screen, use {@link start}
91
- * instead.
92
- */
93
- @initial(0)
94
- @signal()
95
- public declare readonly startOffset: SimpleSignal<number, this>;
96
-
97
- /**
98
- * Whether to display an arrow at the start of the visible curve.
99
- *
100
- * @remarks
101
- * Use {@link arrowSize} to control the size of the arrow.
102
- */
103
- @initial(false)
104
- @signal()
105
- public declare readonly startArrow: SimpleSignal<boolean, this>;
106
-
107
- /**
108
- * A percentage from the start after which the curve should be clipped.
109
- *
110
- * @remarks
111
- * The portion of the curve that comes after the given percentage will be
112
- * made invisible.
113
- *
114
- * This property is usefully for animating the curve appearing on the screen.
115
- * The value of `0` means the very start of the curve (accounting for the
116
- * {@link startOffset}) while `1` means the very end (accounting for the
117
- * {@link endOffset}).
118
- */
119
- @initial(1)
120
- @signal()
121
- public declare readonly end: SimpleSignal<number, this>;
122
-
123
- /**
124
- * The offset in pixels from the end of the curve.
125
- *
126
- * @remarks
127
- * This property lets you specify where along the defined curve the actual
128
- * visible portion ends. For example, setting it to `20` will make the last
129
- * 20 pixels of the curve invisible.
130
- *
131
- * This property is useful for trimming the curve using a fixed distance.
132
- * If you want to animate the curve appearing on the screen, use {@link end}
133
- * instead.
134
- */
135
- @initial(0)
136
- @signal()
137
- public declare readonly endOffset: SimpleSignal<number, this>;
138
-
139
- /**
140
- * Whether to display an arrow at the end of the visible curve.
141
- *
142
- * @remarks
143
- * Use {@link arrowSize} to control the size of the arrow.
144
- */
145
- @initial(false)
146
- @signal()
147
- public declare readonly endArrow: SimpleSignal<boolean, this>;
148
-
149
- /**
150
- * Controls the size of the end and start arrows.
151
- *
152
- * @remarks
153
- * To make the arrows visible make sure to enable {@link startArrow} and/or
154
- * {@link endArrow}.
155
- */
156
- @initial(24)
157
- @signal()
158
- public declare readonly arrowSize: SimpleSignal<number, this>;
159
-
160
- protected canHaveSubpath = false;
161
-
162
- protected override desiredSize(): SerializedVector2<DesiredLength> {
163
- return this.childrenBBox().size;
164
- }
165
-
166
- public constructor(props: CurveProps) {
167
- super(props);
168
- }
169
-
170
- protected abstract childrenBBox(): BBox;
171
-
172
- public abstract profile(): CurveProfile;
173
-
174
- /**
175
- * Convert a percentage along the curve to a distance.
176
- *
177
- * @remarks
178
- * The returned distance is given in relation to the full curve, not
179
- * accounting for {@link startOffset} and {@link endOffset}.
180
- *
181
- * @param value - The percentage along the curve.
182
- */
183
- public percentageToDistance(value: number): number {
184
- return clamp(
185
- 0,
186
- this.baseArcLength(),
187
- this.startOffset() + this.offsetArcLength() * value,
188
- );
189
- }
190
-
191
- /**
192
- * Convert a distance along the curve to a percentage.
193
- *
194
- * @remarks
195
- * The distance should be given in relation to the full curve, not
196
- * accounting for {@link startOffset} and {@link endOffset}.
197
- *
198
- * @param value - The distance along the curve.
199
- */
200
- public distanceToPercentage(value: number): number {
201
- return (value - this.startOffset()) / this.offsetArcLength();
202
- }
203
-
204
- /**
205
- * The base arc length of this curve.
206
- *
207
- * @remarks
208
- * This is the entire length of this curve, not accounting for
209
- * {@link startOffset | the offsets}.
210
- */
211
- public baseArcLength() {
212
- return this.profile().arcLength;
213
- }
214
-
215
- /**
216
- * The offset arc length of this curve.
217
- *
218
- * @remarks
219
- * This is the length of the curve that accounts for
220
- * {@link startOffset | the offsets}.
221
- */
222
- public offsetArcLength() {
223
- const startOffset = this.startOffset();
224
- const endOffset = this.endOffset();
225
- const baseLength = this.baseArcLength();
226
- return clamp(0, baseLength, baseLength - startOffset - endOffset);
227
- }
228
-
229
- /**
230
- * The visible arc length of this curve.
231
- *
232
- * @remarks
233
- * This arc length accounts for both the offset and the {@link start} and
234
- * {@link end} properties.
235
- */
236
- @computed()
237
- public arcLength() {
238
- return this.offsetArcLength() * Math.abs(this.start() - this.end());
239
- }
240
-
241
- /**
242
- * The percentage of the curve that's currently visible.
243
- *
244
- * @remarks
245
- * The returned value is the ratio between the visible length (as defined by
246
- * {@link start} and {@link end}) and the offset length of the curve.
247
- */
248
- public completion(): number {
249
- return Math.abs(this.start() - this.end());
250
- }
251
-
252
- protected processSubpath(
253
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
254
- _path: Path2D,
255
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
256
- _startPoint: Vector2 | null,
257
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
258
- _endPoint: Vector2 | null,
259
- ) {
260
- // do nothing
261
- }
262
-
263
- @computed()
264
- protected curveDrawingInfo(): CurveDrawingInfo {
265
- const path = new Path2D();
266
- let subpath = new Path2D();
267
- const profile = this.profile();
268
-
269
- let start = this.percentageToDistance(this.start());
270
- let end = this.percentageToDistance(this.end());
271
- if (start > end) {
272
- [start, end] = [end, start];
273
- }
274
-
275
- const distance = end - start;
276
- const arrowSize = Math.min(distance / 2, this.arrowSize());
277
-
278
- if (this.startArrow()) {
279
- start += arrowSize / 2;
280
- }
281
-
282
- if (this.endArrow()) {
283
- end -= arrowSize / 2;
284
- }
285
-
286
- let length = 0;
287
- let startPoint = null;
288
- let startTangent = null;
289
- let endPoint = null;
290
- let endTangent = null;
291
- for (const segment of profile.segments) {
292
- const previousLength = length;
293
- length += segment.arcLength;
294
- if (length < start) {
295
- continue;
296
- }
297
-
298
- const relativeStart = (start - previousLength) / segment.arcLength;
299
- const relativeEnd = (end - previousLength) / segment.arcLength;
300
-
301
- const clampedStart = clamp(0, 1, relativeStart);
302
- const clampedEnd = clamp(0, 1, relativeEnd);
303
-
304
- if (
305
- this.canHaveSubpath &&
306
- endPoint &&
307
- !segment.getPoint(0).position.equals(endPoint)
308
- ) {
309
- path.addPath(subpath);
310
- this.processSubpath(subpath, startPoint, endPoint);
311
- subpath = new Path2D();
312
- startPoint = null;
313
- }
314
-
315
- const [startCurvePoint, endCurvePoint] = segment.draw(
316
- subpath,
317
- clampedStart,
318
- clampedEnd,
319
- startPoint === null,
320
- );
321
-
322
- if (startPoint === null) {
323
- startPoint = startCurvePoint.position;
324
- startTangent = startCurvePoint.normal.flipped.perpendicular;
325
- }
326
-
327
- endPoint = endCurvePoint.position;
328
- endTangent = endCurvePoint.normal.flipped.perpendicular;
329
- if (length > end) {
330
- break;
331
- }
332
- }
333
-
334
- if (
335
- this.closed() &&
336
- this.start.isInitial() &&
337
- this.end.isInitial() &&
338
- this.startOffset.isInitial() &&
339
- this.endOffset.isInitial()
340
- ) {
341
- subpath.closePath();
342
- }
343
- this.processSubpath(subpath, startPoint, endPoint);
344
- path.addPath(subpath);
345
-
346
- return {
347
- startPoint: startPoint ?? Vector2.zero,
348
- startTangent: startTangent ?? Vector2.right,
349
- endPoint: endPoint ?? Vector2.zero,
350
- endTangent: endTangent ?? Vector2.right,
351
- arrowSize,
352
- path,
353
- startOffset: start,
354
- };
355
- }
356
-
357
- protected getPointAtDistance(value: number): CurvePoint {
358
- return getPointAtDistance(this.profile(), value + this.startOffset());
359
- }
360
-
361
- public getPointAtPercentage(value: number): CurvePoint {
362
- return getPointAtDistance(this.profile(), this.percentageToDistance(value));
363
- }
364
-
365
- protected override getComputedLayout(): BBox {
366
- return this.offsetComputedLayout(super.getComputedLayout());
367
- }
368
-
369
- protected offsetComputedLayout(box: BBox): BBox {
370
- box.position = box.position.sub(this.childrenBBox().center);
371
- return box;
372
- }
373
-
374
- protected override getPath(): Path2D {
375
- return this.curveDrawingInfo().path;
376
- }
377
-
378
- protected override getCacheBBox(): BBox {
379
- const box = this.childrenBBox();
380
- const arrowSize =
381
- this.startArrow() || this.endArrow() ? this.arrowSize() : 0;
382
- const lineWidth = this.lineWidth();
383
-
384
- const coefficient = this.lineWidthCoefficient();
385
-
386
- return box.expand(Math.max(0, arrowSize, lineWidth * coefficient));
387
- }
388
-
389
- protected lineWidthCoefficient(): number {
390
- return this.lineCap() === 'square' ? 0.5 * 1.4143 : 0.5;
391
- }
392
-
393
- /**
394
- * Check if the path requires a profile.
395
- *
396
- * @remarks
397
- * The profile is only required if certain features are used. Otherwise, the
398
- * profile generation can be skipped, and the curve can be drawn directly
399
- * using the 2D context.
400
- */
401
- protected requiresProfile(): boolean {
402
- return (
403
- !this.start.isInitial() ||
404
- !this.startOffset.isInitial() ||
405
- !this.startArrow.isInitial() ||
406
- !this.end.isInitial() ||
407
- !this.endOffset.isInitial() ||
408
- !this.endArrow.isInitial()
409
- );
410
- }
411
-
412
- protected override drawShape(context: CanvasRenderingContext2D) {
413
- super.drawShape(context);
414
- if (this.startArrow() || this.endArrow()) {
415
- this.drawArrows(context);
416
- }
417
- }
418
-
419
- private drawArrows(context: CanvasRenderingContext2D) {
420
- const {startPoint, startTangent, endPoint, endTangent, arrowSize} =
421
- this.curveDrawingInfo();
422
- if (arrowSize < 0.001) {
423
- return;
424
- }
425
-
426
- context.save();
427
- context.beginPath();
428
- if (this.endArrow()) {
429
- this.drawArrow(context, endPoint, endTangent.flipped, arrowSize);
430
- }
431
- if (this.startArrow()) {
432
- this.drawArrow(context, startPoint, startTangent, arrowSize);
433
- }
434
- context.fillStyle = resolveCanvasStyle(this.stroke(), context);
435
- context.closePath();
436
- context.fill();
437
- context.restore();
438
- }
439
-
440
- private drawArrow(
441
- context: CanvasRenderingContext2D | Path2D,
442
- center: Vector2,
443
- tangent: Vector2,
444
- arrowSize: number,
445
- ) {
446
- const normal = tangent.perpendicular;
447
- const origin = center.add(tangent.scale(-arrowSize / 2));
448
-
449
- moveTo(context, origin);
450
- lineTo(context, origin.add(tangent.add(normal).scale(arrowSize)));
451
- lineTo(context, origin.add(tangent.sub(normal).scale(arrowSize)));
452
- lineTo(context, origin);
453
- context.closePath();
454
- }
455
- }
1
+ import type {
2
+ BBox,
3
+ SerializedVector2,
4
+ SignalValue,
5
+ SimpleSignal,
6
+ } from '@twick/core';
7
+ import {Vector2, clamp} from '@twick/core';
8
+ import type {CurveDrawingInfo} from '../curves/CurveDrawingInfo';
9
+ import type {CurvePoint} from '../curves/CurvePoint';
10
+ import type {CurveProfile} from '../curves/CurveProfile';
11
+ import {getPointAtDistance} from '../curves/getPointAtDistance';
12
+ import {computed, initial, nodeName, signal} from '../decorators';
13
+ import type {DesiredLength} from '../partials';
14
+ import {lineTo, moveTo, resolveCanvasStyle} from '../utils';
15
+ import type {ShapeProps} from './Shape';
16
+ import {Shape} from './Shape';
17
+
18
+ export interface CurveProps extends ShapeProps {
19
+ /**
20
+ * {@inheritDoc Curve.closed}
21
+ */
22
+ closed?: SignalValue<boolean>;
23
+ /**
24
+ * {@inheritDoc Curve.start}
25
+ */
26
+ start?: SignalValue<number>;
27
+ /**
28
+ * {@inheritDoc Curve.startOffset}
29
+ */
30
+ startOffset?: SignalValue<number>;
31
+ /**
32
+ * {@inheritDoc Curve.startArrow}
33
+ */
34
+ startArrow?: SignalValue<boolean>;
35
+ /**
36
+ * {@inheritDoc Curve.end}
37
+ */
38
+ end?: SignalValue<number>;
39
+ /**
40
+ * {@inheritDoc Curve.endOffset}
41
+ */
42
+ endOffset?: SignalValue<number>;
43
+ /**
44
+ * {@inheritDoc Curve.endArrow}
45
+ */
46
+ endArrow?: SignalValue<boolean>;
47
+ /**
48
+ * {@inheritDoc Curve.arrowSize}
49
+ */
50
+ arrowSize?: SignalValue<number>;
51
+ }
52
+
53
+ @nodeName('Curve')
54
+ export abstract class Curve extends Shape {
55
+ /**
56
+ * Whether the curve should be closed.
57
+ *
58
+ * @remarks
59
+ * Closed curves have their start and end points connected.
60
+ */
61
+ @initial(false)
62
+ @signal()
63
+ public declare readonly closed: SimpleSignal<boolean, this>;
64
+
65
+ /**
66
+ * A percentage from the start before which the curve should be clipped.
67
+ *
68
+ * @remarks
69
+ * The portion of the curve that comes before the given percentage will be
70
+ * made invisible.
71
+ *
72
+ * This property is usefully for animating the curve appearing on the screen.
73
+ * The value of `0` means the very start of the curve (accounting for the
74
+ * {@link startOffset}) while `1` means the very end (accounting for the
75
+ * {@link endOffset}).
76
+ */
77
+ @initial(0)
78
+ @signal()
79
+ public declare readonly start: SimpleSignal<number, this>;
80
+
81
+ /**
82
+ * The offset in pixels from the start of the curve.
83
+ *
84
+ * @remarks
85
+ * This property lets you specify where along the defined curve the actual
86
+ * visible portion starts. For example, setting it to `20` will make the first
87
+ * 20 pixels of the curve invisible.
88
+ *
89
+ * This property is useful for trimming the curve using a fixed distance.
90
+ * If you want to animate the curve appearing on the screen, use {@link start}
91
+ * instead.
92
+ */
93
+ @initial(0)
94
+ @signal()
95
+ public declare readonly startOffset: SimpleSignal<number, this>;
96
+
97
+ /**
98
+ * Whether to display an arrow at the start of the visible curve.
99
+ *
100
+ * @remarks
101
+ * Use {@link arrowSize} to control the size of the arrow.
102
+ */
103
+ @initial(false)
104
+ @signal()
105
+ public declare readonly startArrow: SimpleSignal<boolean, this>;
106
+
107
+ /**
108
+ * A percentage from the start after which the curve should be clipped.
109
+ *
110
+ * @remarks
111
+ * The portion of the curve that comes after the given percentage will be
112
+ * made invisible.
113
+ *
114
+ * This property is usefully for animating the curve appearing on the screen.
115
+ * The value of `0` means the very start of the curve (accounting for the
116
+ * {@link startOffset}) while `1` means the very end (accounting for the
117
+ * {@link endOffset}).
118
+ */
119
+ @initial(1)
120
+ @signal()
121
+ public declare readonly end: SimpleSignal<number, this>;
122
+
123
+ /**
124
+ * The offset in pixels from the end of the curve.
125
+ *
126
+ * @remarks
127
+ * This property lets you specify where along the defined curve the actual
128
+ * visible portion ends. For example, setting it to `20` will make the last
129
+ * 20 pixels of the curve invisible.
130
+ *
131
+ * This property is useful for trimming the curve using a fixed distance.
132
+ * If you want to animate the curve appearing on the screen, use {@link end}
133
+ * instead.
134
+ */
135
+ @initial(0)
136
+ @signal()
137
+ public declare readonly endOffset: SimpleSignal<number, this>;
138
+
139
+ /**
140
+ * Whether to display an arrow at the end of the visible curve.
141
+ *
142
+ * @remarks
143
+ * Use {@link arrowSize} to control the size of the arrow.
144
+ */
145
+ @initial(false)
146
+ @signal()
147
+ public declare readonly endArrow: SimpleSignal<boolean, this>;
148
+
149
+ /**
150
+ * Controls the size of the end and start arrows.
151
+ *
152
+ * @remarks
153
+ * To make the arrows visible make sure to enable {@link startArrow} and/or
154
+ * {@link endArrow}.
155
+ */
156
+ @initial(24)
157
+ @signal()
158
+ public declare readonly arrowSize: SimpleSignal<number, this>;
159
+
160
+ protected canHaveSubpath = false;
161
+
162
+ protected override desiredSize(): SerializedVector2<DesiredLength> {
163
+ return this.childrenBBox().size;
164
+ }
165
+
166
+ public constructor(props: CurveProps) {
167
+ super(props);
168
+ }
169
+
170
+ protected abstract childrenBBox(): BBox;
171
+
172
+ public abstract profile(): CurveProfile;
173
+
174
+ /**
175
+ * Convert a percentage along the curve to a distance.
176
+ *
177
+ * @remarks
178
+ * The returned distance is given in relation to the full curve, not
179
+ * accounting for {@link startOffset} and {@link endOffset}.
180
+ *
181
+ * @param value - The percentage along the curve.
182
+ */
183
+ public percentageToDistance(value: number): number {
184
+ return clamp(
185
+ 0,
186
+ this.baseArcLength(),
187
+ this.startOffset() + this.offsetArcLength() * value,
188
+ );
189
+ }
190
+
191
+ /**
192
+ * Convert a distance along the curve to a percentage.
193
+ *
194
+ * @remarks
195
+ * The distance should be given in relation to the full curve, not
196
+ * accounting for {@link startOffset} and {@link endOffset}.
197
+ *
198
+ * @param value - The distance along the curve.
199
+ */
200
+ public distanceToPercentage(value: number): number {
201
+ return (value - this.startOffset()) / this.offsetArcLength();
202
+ }
203
+
204
+ /**
205
+ * The base arc length of this curve.
206
+ *
207
+ * @remarks
208
+ * This is the entire length of this curve, not accounting for
209
+ * {@link startOffset | the offsets}.
210
+ */
211
+ public baseArcLength() {
212
+ return this.profile().arcLength;
213
+ }
214
+
215
+ /**
216
+ * The offset arc length of this curve.
217
+ *
218
+ * @remarks
219
+ * This is the length of the curve that accounts for
220
+ * {@link startOffset | the offsets}.
221
+ */
222
+ public offsetArcLength() {
223
+ const startOffset = this.startOffset();
224
+ const endOffset = this.endOffset();
225
+ const baseLength = this.baseArcLength();
226
+ return clamp(0, baseLength, baseLength - startOffset - endOffset);
227
+ }
228
+
229
+ /**
230
+ * The visible arc length of this curve.
231
+ *
232
+ * @remarks
233
+ * This arc length accounts for both the offset and the {@link start} and
234
+ * {@link end} properties.
235
+ */
236
+ @computed()
237
+ public arcLength() {
238
+ return this.offsetArcLength() * Math.abs(this.start() - this.end());
239
+ }
240
+
241
+ /**
242
+ * The percentage of the curve that's currently visible.
243
+ *
244
+ * @remarks
245
+ * The returned value is the ratio between the visible length (as defined by
246
+ * {@link start} and {@link end}) and the offset length of the curve.
247
+ */
248
+ public completion(): number {
249
+ return Math.abs(this.start() - this.end());
250
+ }
251
+
252
+ protected processSubpath(
253
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
254
+ _path: Path2D,
255
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
256
+ _startPoint: Vector2 | null,
257
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
258
+ _endPoint: Vector2 | null,
259
+ ) {
260
+ // do nothing
261
+ }
262
+
263
+ @computed()
264
+ protected curveDrawingInfo(): CurveDrawingInfo {
265
+ const path = new Path2D();
266
+ let subpath = new Path2D();
267
+ const profile = this.profile();
268
+
269
+ let start = this.percentageToDistance(this.start());
270
+ let end = this.percentageToDistance(this.end());
271
+ if (start > end) {
272
+ [start, end] = [end, start];
273
+ }
274
+
275
+ const distance = end - start;
276
+ const arrowSize = Math.min(distance / 2, this.arrowSize());
277
+
278
+ if (this.startArrow()) {
279
+ start += arrowSize / 2;
280
+ }
281
+
282
+ if (this.endArrow()) {
283
+ end -= arrowSize / 2;
284
+ }
285
+
286
+ let length = 0;
287
+ let startPoint = null;
288
+ let startTangent = null;
289
+ let endPoint = null;
290
+ let endTangent = null;
291
+ for (const segment of profile.segments) {
292
+ const previousLength = length;
293
+ length += segment.arcLength;
294
+ if (length < start) {
295
+ continue;
296
+ }
297
+
298
+ const relativeStart = (start - previousLength) / segment.arcLength;
299
+ const relativeEnd = (end - previousLength) / segment.arcLength;
300
+
301
+ const clampedStart = clamp(0, 1, relativeStart);
302
+ const clampedEnd = clamp(0, 1, relativeEnd);
303
+
304
+ if (
305
+ this.canHaveSubpath &&
306
+ endPoint &&
307
+ !segment.getPoint(0).position.equals(endPoint)
308
+ ) {
309
+ path.addPath(subpath);
310
+ this.processSubpath(subpath, startPoint, endPoint);
311
+ subpath = new Path2D();
312
+ startPoint = null;
313
+ }
314
+
315
+ const [startCurvePoint, endCurvePoint] = segment.draw(
316
+ subpath,
317
+ clampedStart,
318
+ clampedEnd,
319
+ startPoint === null,
320
+ );
321
+
322
+ if (startPoint === null) {
323
+ startPoint = startCurvePoint.position;
324
+ startTangent = startCurvePoint.normal.flipped.perpendicular;
325
+ }
326
+
327
+ endPoint = endCurvePoint.position;
328
+ endTangent = endCurvePoint.normal.flipped.perpendicular;
329
+ if (length > end) {
330
+ break;
331
+ }
332
+ }
333
+
334
+ if (
335
+ this.closed() &&
336
+ this.start.isInitial() &&
337
+ this.end.isInitial() &&
338
+ this.startOffset.isInitial() &&
339
+ this.endOffset.isInitial()
340
+ ) {
341
+ subpath.closePath();
342
+ }
343
+ this.processSubpath(subpath, startPoint, endPoint);
344
+ path.addPath(subpath);
345
+
346
+ return {
347
+ startPoint: startPoint ?? Vector2.zero,
348
+ startTangent: startTangent ?? Vector2.right,
349
+ endPoint: endPoint ?? Vector2.zero,
350
+ endTangent: endTangent ?? Vector2.right,
351
+ arrowSize,
352
+ path,
353
+ startOffset: start,
354
+ };
355
+ }
356
+
357
+ protected getPointAtDistance(value: number): CurvePoint {
358
+ return getPointAtDistance(this.profile(), value + this.startOffset());
359
+ }
360
+
361
+ public getPointAtPercentage(value: number): CurvePoint {
362
+ return getPointAtDistance(this.profile(), this.percentageToDistance(value));
363
+ }
364
+
365
+ protected override getComputedLayout(): BBox {
366
+ return this.offsetComputedLayout(super.getComputedLayout());
367
+ }
368
+
369
+ protected offsetComputedLayout(box: BBox): BBox {
370
+ box.position = box.position.sub(this.childrenBBox().center);
371
+ return box;
372
+ }
373
+
374
+ protected override getPath(): Path2D {
375
+ return this.curveDrawingInfo().path;
376
+ }
377
+
378
+ protected override getCacheBBox(): BBox {
379
+ const box = this.childrenBBox();
380
+ const arrowSize =
381
+ this.startArrow() || this.endArrow() ? this.arrowSize() : 0;
382
+ const lineWidth = this.lineWidth();
383
+
384
+ const coefficient = this.lineWidthCoefficient();
385
+
386
+ return box.expand(Math.max(0, arrowSize, lineWidth * coefficient));
387
+ }
388
+
389
+ protected lineWidthCoefficient(): number {
390
+ return this.lineCap() === 'square' ? 0.5 * 1.4143 : 0.5;
391
+ }
392
+
393
+ /**
394
+ * Check if the path requires a profile.
395
+ *
396
+ * @remarks
397
+ * The profile is only required if certain features are used. Otherwise, the
398
+ * profile generation can be skipped, and the curve can be drawn directly
399
+ * using the 2D context.
400
+ */
401
+ protected requiresProfile(): boolean {
402
+ return (
403
+ !this.start.isInitial() ||
404
+ !this.startOffset.isInitial() ||
405
+ !this.startArrow.isInitial() ||
406
+ !this.end.isInitial() ||
407
+ !this.endOffset.isInitial() ||
408
+ !this.endArrow.isInitial()
409
+ );
410
+ }
411
+
412
+ protected override drawShape(context: CanvasRenderingContext2D) {
413
+ super.drawShape(context);
414
+ if (this.startArrow() || this.endArrow()) {
415
+ this.drawArrows(context);
416
+ }
417
+ }
418
+
419
+ private drawArrows(context: CanvasRenderingContext2D) {
420
+ const {startPoint, startTangent, endPoint, endTangent, arrowSize} =
421
+ this.curveDrawingInfo();
422
+ if (arrowSize < 0.001) {
423
+ return;
424
+ }
425
+
426
+ context.save();
427
+ context.beginPath();
428
+ if (this.endArrow()) {
429
+ this.drawArrow(context, endPoint, endTangent.flipped, arrowSize);
430
+ }
431
+ if (this.startArrow()) {
432
+ this.drawArrow(context, startPoint, startTangent, arrowSize);
433
+ }
434
+ context.fillStyle = resolveCanvasStyle(this.stroke(), context);
435
+ context.closePath();
436
+ context.fill();
437
+ context.restore();
438
+ }
439
+
440
+ private drawArrow(
441
+ context: CanvasRenderingContext2D | Path2D,
442
+ center: Vector2,
443
+ tangent: Vector2,
444
+ arrowSize: number,
445
+ ) {
446
+ const normal = tangent.perpendicular;
447
+ const origin = center.add(tangent.scale(-arrowSize / 2));
448
+
449
+ moveTo(context, origin);
450
+ lineTo(context, origin.add(tangent.add(normal).scale(arrowSize)));
451
+ lineTo(context, origin.add(tangent.sub(normal).scale(arrowSize)));
452
+ lineTo(context, origin);
453
+ context.closePath();
454
+ }
455
+ }