@twick/2d 0.14.0 → 1.14.3

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 (186) hide show
  1. package/LICENSE +21 -21
  2. package/editor/editor/tsconfig.build.tsbuildinfo +1 -1
  3. package/lib/components/Audio.d.ts.map +1 -1
  4. package/lib/components/Audio.js +33 -3
  5. package/lib/components/CodeBlock.d.ts +1 -1
  6. package/lib/components/Img.js +23 -23
  7. package/lib/components/Line.js +31 -31
  8. package/lib/components/Media.d.ts +6 -0
  9. package/lib/components/Media.d.ts.map +1 -1
  10. package/lib/components/Media.js +277 -61
  11. package/lib/components/Node.d.ts +1 -1
  12. package/lib/components/Path.d.ts +1 -1
  13. package/lib/components/SVG.d.ts +1 -1
  14. package/lib/components/Shape.d.ts +1 -1
  15. package/lib/components/Spline.js +25 -25
  16. package/lib/components/Video.d.ts +0 -1
  17. package/lib/components/Video.d.ts.map +1 -1
  18. package/lib/components/Video.js +70 -65
  19. package/lib/tsconfig.build.tsbuildinfo +1 -1
  20. package/package.json +4 -5
  21. package/src/editor/NodeInspectorConfig.tsx +76 -76
  22. package/src/editor/PreviewOverlayConfig.tsx +67 -67
  23. package/src/editor/Provider.tsx +93 -93
  24. package/src/editor/SceneGraphTabConfig.tsx +81 -81
  25. package/src/editor/icons/CircleIcon.tsx +7 -7
  26. package/src/editor/icons/CodeBlockIcon.tsx +8 -8
  27. package/src/editor/icons/CurveIcon.tsx +7 -7
  28. package/src/editor/icons/GridIcon.tsx +7 -7
  29. package/src/editor/icons/IconMap.ts +35 -35
  30. package/src/editor/icons/ImgIcon.tsx +8 -8
  31. package/src/editor/icons/LayoutIcon.tsx +9 -9
  32. package/src/editor/icons/LineIcon.tsx +7 -7
  33. package/src/editor/icons/NodeIcon.tsx +7 -7
  34. package/src/editor/icons/RayIcon.tsx +7 -7
  35. package/src/editor/icons/RectIcon.tsx +7 -7
  36. package/src/editor/icons/ShapeIcon.tsx +7 -7
  37. package/src/editor/icons/TxtIcon.tsx +8 -8
  38. package/src/editor/icons/VideoIcon.tsx +7 -7
  39. package/src/editor/icons/View2DIcon.tsx +10 -10
  40. package/src/editor/index.ts +17 -17
  41. package/src/editor/tree/DetachedRoot.tsx +23 -23
  42. package/src/editor/tree/NodeElement.tsx +74 -74
  43. package/src/editor/tree/TreeElement.tsx +72 -72
  44. package/src/editor/tree/TreeRoot.tsx +10 -10
  45. package/src/editor/tree/ViewRoot.tsx +20 -20
  46. package/src/editor/tree/index.module.scss +38 -38
  47. package/src/editor/tree/index.ts +3 -3
  48. package/src/editor/tsconfig.build.json +5 -5
  49. package/src/editor/tsconfig.json +12 -12
  50. package/src/editor/tsdoc.json +4 -4
  51. package/src/editor/vite-env.d.ts +1 -1
  52. package/src/lib/code/CodeCursor.ts +445 -445
  53. package/src/lib/code/CodeDiffer.ts +78 -78
  54. package/src/lib/code/CodeFragment.ts +97 -97
  55. package/src/lib/code/CodeHighlighter.ts +75 -75
  56. package/src/lib/code/CodeMetrics.ts +47 -47
  57. package/src/lib/code/CodeRange.test.ts +74 -74
  58. package/src/lib/code/CodeRange.ts +216 -216
  59. package/src/lib/code/CodeScope.ts +101 -101
  60. package/src/lib/code/CodeSelection.ts +24 -24
  61. package/src/lib/code/CodeSignal.ts +327 -327
  62. package/src/lib/code/CodeTokenizer.ts +54 -54
  63. package/src/lib/code/DefaultHighlightStyle.ts +98 -98
  64. package/src/lib/code/LezerHighlighter.ts +113 -113
  65. package/src/lib/code/diff.test.ts +311 -311
  66. package/src/lib/code/diff.ts +319 -319
  67. package/src/lib/code/extractRange.ts +126 -126
  68. package/src/lib/code/index.ts +13 -13
  69. package/src/lib/components/Audio.ts +168 -131
  70. package/src/lib/components/Bezier.ts +105 -105
  71. package/src/lib/components/Circle.ts +266 -266
  72. package/src/lib/components/Code.ts +526 -526
  73. package/src/lib/components/CodeBlock.ts +576 -576
  74. package/src/lib/components/CubicBezier.ts +112 -112
  75. package/src/lib/components/Curve.ts +455 -455
  76. package/src/lib/components/Grid.ts +135 -135
  77. package/src/lib/components/Icon.ts +96 -96
  78. package/src/lib/components/Img.ts +319 -319
  79. package/src/lib/components/Knot.ts +157 -157
  80. package/src/lib/components/Latex.ts +122 -122
  81. package/src/lib/components/Layout.ts +1092 -1092
  82. package/src/lib/components/Line.ts +429 -429
  83. package/src/lib/components/Media.ts +576 -346
  84. package/src/lib/components/Node.ts +1940 -1940
  85. package/src/lib/components/Path.ts +137 -137
  86. package/src/lib/components/Polygon.ts +171 -171
  87. package/src/lib/components/QuadBezier.ts +100 -100
  88. package/src/lib/components/Ray.ts +125 -125
  89. package/src/lib/components/Rect.ts +187 -187
  90. package/src/lib/components/Rive.ts +156 -156
  91. package/src/lib/components/SVG.ts +797 -797
  92. package/src/lib/components/Shape.ts +143 -143
  93. package/src/lib/components/Spline.ts +344 -344
  94. package/src/lib/components/Txt.test.tsx +81 -81
  95. package/src/lib/components/Txt.ts +203 -203
  96. package/src/lib/components/TxtLeaf.ts +205 -205
  97. package/src/lib/components/Video.ts +461 -462
  98. package/src/lib/components/View2D.ts +98 -98
  99. package/src/lib/components/__tests__/children.test.tsx +142 -142
  100. package/src/lib/components/__tests__/clone.test.tsx +126 -126
  101. package/src/lib/components/__tests__/generatorTest.ts +28 -28
  102. package/src/lib/components/__tests__/mockScene2D.ts +45 -45
  103. package/src/lib/components/__tests__/query.test.tsx +122 -122
  104. package/src/lib/components/__tests__/state.test.tsx +60 -60
  105. package/src/lib/components/index.ts +28 -28
  106. package/src/lib/components/types.ts +35 -35
  107. package/src/lib/curves/ArcSegment.ts +159 -159
  108. package/src/lib/curves/CircleSegment.ts +77 -77
  109. package/src/lib/curves/CubicBezierSegment.ts +78 -78
  110. package/src/lib/curves/CurveDrawingInfo.ts +11 -11
  111. package/src/lib/curves/CurvePoint.ts +15 -15
  112. package/src/lib/curves/CurveProfile.ts +7 -7
  113. package/src/lib/curves/KnotInfo.ts +10 -10
  114. package/src/lib/curves/LineSegment.ts +62 -62
  115. package/src/lib/curves/Polynomial.ts +355 -355
  116. package/src/lib/curves/Polynomial2D.ts +62 -62
  117. package/src/lib/curves/PolynomialSegment.ts +124 -124
  118. package/src/lib/curves/QuadBezierSegment.ts +64 -64
  119. package/src/lib/curves/Segment.ts +17 -17
  120. package/src/lib/curves/UniformPolynomialCurveSampler.ts +94 -94
  121. package/src/lib/curves/createCurveProfileLerp.ts +471 -471
  122. package/src/lib/curves/getBezierSplineProfile.ts +223 -223
  123. package/src/lib/curves/getCircleProfile.ts +86 -86
  124. package/src/lib/curves/getPathProfile.ts +178 -178
  125. package/src/lib/curves/getPointAtDistance.ts +21 -21
  126. package/src/lib/curves/getPolylineProfile.test.ts +21 -21
  127. package/src/lib/curves/getPolylineProfile.ts +89 -89
  128. package/src/lib/curves/getRectProfile.ts +139 -139
  129. package/src/lib/curves/index.ts +16 -16
  130. package/src/lib/decorators/canvasStyleSignal.ts +16 -16
  131. package/src/lib/decorators/colorSignal.ts +9 -9
  132. package/src/lib/decorators/compound.ts +72 -72
  133. package/src/lib/decorators/computed.ts +18 -18
  134. package/src/lib/decorators/defaultStyle.ts +18 -18
  135. package/src/lib/decorators/filtersSignal.ts +136 -136
  136. package/src/lib/decorators/index.ts +10 -10
  137. package/src/lib/decorators/initializers.ts +32 -32
  138. package/src/lib/decorators/nodeName.ts +13 -13
  139. package/src/lib/decorators/signal.test.ts +90 -90
  140. package/src/lib/decorators/signal.ts +345 -345
  141. package/src/lib/decorators/spacingSignal.ts +15 -15
  142. package/src/lib/decorators/vector2Signal.ts +30 -30
  143. package/src/lib/globals.d.ts +2 -2
  144. package/src/lib/index.ts +8 -8
  145. package/src/lib/jsx-dev-runtime.ts +2 -2
  146. package/src/lib/jsx-runtime.ts +46 -46
  147. package/src/lib/parse-svg-path.d.ts +14 -14
  148. package/src/lib/partials/Filter.ts +180 -180
  149. package/src/lib/partials/Gradient.ts +102 -102
  150. package/src/lib/partials/Pattern.ts +34 -34
  151. package/src/lib/partials/ShaderConfig.ts +117 -117
  152. package/src/lib/partials/index.ts +4 -4
  153. package/src/lib/partials/types.ts +58 -58
  154. package/src/lib/scenes/Scene2D.ts +242 -242
  155. package/src/lib/scenes/index.ts +3 -3
  156. package/src/lib/scenes/makeScene2D.ts +16 -16
  157. package/src/lib/scenes/useScene2D.ts +6 -6
  158. package/src/lib/tsconfig.build.json +5 -5
  159. package/src/lib/tsconfig.json +10 -10
  160. package/src/lib/tsdoc.json +4 -4
  161. package/src/lib/utils/CanvasUtils.ts +306 -306
  162. package/src/lib/utils/diff.test.ts +453 -453
  163. package/src/lib/utils/diff.ts +148 -148
  164. package/src/lib/utils/index.ts +2 -2
  165. package/src/lib/utils/is.ts +11 -11
  166. package/src/lib/utils/makeSignalExtensions.ts +30 -30
  167. package/src/lib/utils/video/declarations.d.ts +1 -1
  168. package/src/lib/utils/video/ffmpeg-client.ts +50 -50
  169. package/src/lib/utils/video/mp4-parser-manager.ts +72 -72
  170. package/src/lib/utils/video/parser/index.ts +1 -1
  171. package/src/lib/utils/video/parser/parser.ts +257 -257
  172. package/src/lib/utils/video/parser/sampler.ts +72 -72
  173. package/src/lib/utils/video/parser/segment.ts +302 -302
  174. package/src/lib/utils/video/parser/sink.ts +29 -29
  175. package/src/lib/utils/video/parser/utils.ts +31 -31
  176. package/src/tsconfig.base.json +19 -19
  177. package/src/tsconfig.build.json +8 -8
  178. package/src/tsconfig.json +5 -5
  179. package/tsconfig.project.json +7 -7
  180. package/lib/components/utils/waitUntil.d.ts +0 -7
  181. package/lib/components/utils/waitUntil.d.ts.map +0 -1
  182. package/lib/components/utils/waitUntil.js +0 -15
  183. package/lib/utils/waitUntil.d.ts +0 -7
  184. package/lib/utils/waitUntil.d.ts.map +0 -1
  185. package/lib/utils/waitUntil.js +0 -15
  186. package/src/lib/utils/waitUntil.ts +0 -18
@@ -1,797 +1,797 @@
1
- import type {
2
- PossibleSpacing,
3
- SerializedVector2,
4
- SignalValue,
5
- SimpleSignal,
6
- ThreadGenerator,
7
- TimingFunction,
8
- } from '@twick/core';
9
- import {
10
- BBox,
11
- Matrix2D,
12
- Vector2,
13
- all,
14
- clampRemap,
15
- delay,
16
- easeInOutSine,
17
- isReactive,
18
- lazy,
19
- threadable,
20
- tween,
21
- useLogger,
22
- } from '@twick/core';
23
- import {computed, signal} from '../decorators';
24
- import type {DesiredLength, PossibleCanvasStyle} from '../partials';
25
- import {applyTransformDiff, getTransformDiff} from '../utils/diff';
26
- import type {CircleProps} from './Circle';
27
- import {Circle} from './Circle';
28
- import type {ImgProps} from './Img';
29
- import {Img} from './Img';
30
- import {Layout} from './Layout';
31
- import type {LineProps} from './Line';
32
- import {Line} from './Line';
33
- import type {NodeProps} from './Node';
34
- import {Node} from './Node';
35
- import type {PathProps} from './Path';
36
- import {Path} from './Path';
37
- import type {RectProps} from './Rect';
38
- import {Rect} from './Rect';
39
- import type {ShapeProps} from './Shape';
40
- import {Shape} from './Shape';
41
- import {View2D} from './View2D';
42
-
43
- /**
44
- * Represent SVG shape.
45
- * This only used single time because `node` may have reference to parent SVG renderer.
46
- */
47
- export interface SVGShape {
48
- id: string;
49
- shape: Node;
50
- }
51
-
52
- /**
53
- * Data of SVGShape.
54
- * This can used many times because it do not reference parent SVG.
55
- * This must build into SVGShape
56
- */
57
- export interface SVGShapeData {
58
- id: string;
59
- type: new (props: NodeProps) => Node;
60
- props: ShapeProps;
61
- children?: SVGShapeData[];
62
- }
63
-
64
- /**
65
- * Represent SVG document that contains SVG shapes.
66
- * This only used single time because `nodes` have reference to parent SVG renderer.
67
- */
68
- export interface SVGDocument {
69
- size: Vector2;
70
- nodes: SVGShape[];
71
- }
72
-
73
- /**
74
- * Data of SVGDocument.
75
- * This can used many times because it do not reference parent SVG.
76
- * This must build into SVGDocument
77
- */
78
- export interface SVGDocumentData {
79
- size: Vector2;
80
- nodes: SVGShapeData[];
81
- }
82
-
83
- export interface SVGProps extends ShapeProps {
84
- svg: SignalValue<string>;
85
- }
86
-
87
- /**
88
- A Node for drawing and animating SVG images.
89
-
90
- @remarks
91
- If you're not interested in animating SVG, you can use {@link Img} instead.
92
- */
93
- export class SVG extends Shape {
94
- @lazy(() => {
95
- const element = document.createElement('div');
96
- View2D.shadowRoot.appendChild(element);
97
- return element;
98
- })
99
- protected static containerElement: HTMLDivElement;
100
- private static svgNodesPool: Record<string, SVGDocumentData> = {};
101
-
102
- /**
103
- * SVG string to be rendered
104
- */
105
- @signal()
106
- public declare readonly svg: SimpleSignal<string, this>;
107
-
108
- /**
109
- * Child to wrap all SVG node
110
- */
111
- public wrapper: Node;
112
-
113
- private lastTweenTargetSrc: string | null = null;
114
- private lastTweenTargetDocument: SVGDocument | null = null;
115
-
116
- public constructor(props: SVGProps) {
117
- super(props);
118
- this.wrapper = new Node({});
119
- this.wrapper.children(this.documentNodes);
120
- this.wrapper.scale(this.wrapperScale);
121
- this.add(this.wrapper);
122
- }
123
-
124
- /**
125
- * Get all SVG nodes with the given id.
126
- * @param id - An id to query.
127
- */
128
- public getChildrenById(id: string) {
129
- return this.document()
130
- .nodes.filter(node => node.id === id)
131
- .map(({shape}) => shape);
132
- }
133
-
134
- protected override desiredSize(): SerializedVector2<DesiredLength> {
135
- const docSize = this.document().size;
136
- const scale = this.calculateWrapperScale(
137
- docSize,
138
- super.desiredSize() as SerializedVector2<number | null>,
139
- );
140
- return docSize.mul(scale);
141
- }
142
-
143
- protected getCurrentSize() {
144
- return {
145
- x: this.width.isInitial() ? null : this.width(),
146
- y: this.height.isInitial() ? null : this.height(),
147
- };
148
- }
149
-
150
- protected calculateWrapperScale(
151
- documentSize: Vector2,
152
- parentSize: SerializedVector2<number | null>,
153
- ) {
154
- const result = new Vector2(1, 1);
155
- if (parentSize.x && parentSize.y) {
156
- result.x = parentSize.x / documentSize.width;
157
- result.y = parentSize.y / documentSize.height;
158
- } else if (parentSize.x && !parentSize.y) {
159
- result.x = parentSize.x / documentSize.width;
160
- result.y = result.x;
161
- } else if (!parentSize.x && parentSize.y) {
162
- result.y = parentSize.y / documentSize.height;
163
- result.x = result.y;
164
- }
165
- return result;
166
- }
167
-
168
- /**
169
- * Convert `SVGDocumentData` to `SVGDocument`.
170
- * @param data - `SVGDocumentData` to convert.
171
- */
172
- protected buildDocument(data: SVGDocumentData): SVGDocument {
173
- return {
174
- size: data.size,
175
- nodes: data.nodes.map(ch => this.buildShape(ch)),
176
- };
177
- }
178
-
179
- /**
180
- * Convert `SVGShapeData` to `SVGShape`.
181
- * @param data - `SVGShapeData` to convert.
182
- */
183
- protected buildShape({id, type, props, children}: SVGShapeData): SVGShape {
184
- return {
185
- id,
186
- shape: new type({
187
- children: children?.map(ch => this.buildShape(ch).shape),
188
- ...this.processElementStyle(props),
189
- }),
190
- };
191
- }
192
-
193
- /**
194
- * Convert an SVG string to `SVGDocument`.
195
- * @param svg - An SVG string to be parsed.
196
- */
197
- protected parseSVG(svg: string): SVGDocument {
198
- return this.buildDocument(SVG.parseSVGData(svg));
199
- }
200
-
201
- /**
202
- * Create a tweening list to tween between two SVG nodes.
203
- * @param from - The initial node,
204
- * @param to - The final node.
205
- * @param duration - The duration of the tween.
206
- * @param timing - The timing function.
207
- */
208
- protected *generateTransformer(
209
- from: Node,
210
- to: Node,
211
- duration: number,
212
- timing: TimingFunction,
213
- ): Generator<ThreadGenerator> {
214
- yield from.position(to.position(), duration, timing);
215
- yield from.scale(to.scale(), duration, timing);
216
- yield from.rotation(to.rotation(), duration, timing);
217
- if (
218
- from instanceof Path &&
219
- to instanceof Path &&
220
- from.data() !== to.data()
221
- ) {
222
- yield from.data(to.data(), duration, timing);
223
- }
224
- if (from instanceof Layout && to instanceof Layout) {
225
- yield from.size(to.size(), duration, timing);
226
- }
227
- if (from instanceof Shape && to instanceof Shape) {
228
- yield from.fill(to.fill(), duration, timing);
229
- yield from.stroke(to.stroke(), duration, timing);
230
- yield from.lineWidth(to.lineWidth(), duration, timing);
231
- }
232
-
233
- const fromChildren = from.children();
234
- const toChildren = to.children();
235
- for (let i = 0; i < fromChildren.length; i++) {
236
- yield* this.generateTransformer(
237
- fromChildren[i],
238
- toChildren[i],
239
- duration,
240
- timing,
241
- );
242
- }
243
- }
244
-
245
- @threadable()
246
- protected *tweenSvg(
247
- value: SignalValue<string>,
248
- time: number,
249
- timingFunction: TimingFunction,
250
- ) {
251
- const newValue = isReactive(value) ? value() : value;
252
- const newSVG = this.parseSVG(newValue);
253
- const currentSVG = this.document();
254
- const diff = getTransformDiff(currentSVG.nodes, newSVG.nodes);
255
-
256
- this.lastTweenTargetSrc = newValue;
257
- this.lastTweenTargetDocument = newSVG;
258
-
259
- applyTransformDiff(currentSVG.nodes, diff, ({shape, ...rest}) => ({
260
- ...rest,
261
- shape: shape.clone(),
262
- }));
263
- this.wrapper.children(currentSVG.nodes.map(shape => shape.shape));
264
- for (const item of currentSVG.nodes) {
265
- item.shape.parent(this.wrapper);
266
- }
267
-
268
- const beginning = 0.2;
269
- const ending = 0.8;
270
- const overlap = 0.15;
271
-
272
- const transformator: ThreadGenerator[] = [];
273
- const transformatorTime = (ending - beginning) * time;
274
- const transformatorDelay = beginning * time;
275
-
276
- for (const item of diff.transformed) {
277
- transformator.push(
278
- ...this.generateTransformer(
279
- item.from.current.shape,
280
- item.to.current.shape,
281
- transformatorTime,
282
- timingFunction,
283
- ),
284
- );
285
- }
286
-
287
- const autoWidth = this.width.isInitial();
288
- const autoHeight = this.height.isInitial();
289
- this.wrapper.scale(
290
- this.calculateWrapperScale(currentSVG.size, this.getCurrentSize()),
291
- );
292
-
293
- const baseTween = tween(
294
- time,
295
- value => {
296
- const progress = timingFunction(value);
297
- const remapped = clampRemap(beginning, ending, 0, 1, progress);
298
-
299
- const scale = this.wrapper.scale();
300
- if (autoWidth) {
301
- this.width(
302
- easeInOutSine(remapped, currentSVG.size.x, newSVG.size.x) * scale.x,
303
- );
304
- }
305
-
306
- if (autoHeight) {
307
- this.height(
308
- easeInOutSine(remapped, currentSVG.size.y, newSVG.size.y) * scale.y,
309
- );
310
- }
311
-
312
- const deletedOpacity = clampRemap(
313
- 0,
314
- beginning + overlap,
315
- 1,
316
- 0,
317
- progress,
318
- );
319
- for (const {current} of diff.deleted) {
320
- current.shape.opacity(deletedOpacity);
321
- }
322
-
323
- const insertedOpacity = clampRemap(ending - overlap, 1, 0, 1, progress);
324
- for (const {current} of diff.inserted) {
325
- current.shape.opacity(insertedOpacity);
326
- }
327
- },
328
- () => {
329
- this.wrapper.children(this.documentNodes);
330
- if (autoWidth) this.width.reset();
331
- if (autoHeight) this.height.reset();
332
-
333
- for (const {current} of diff.deleted) current.shape.dispose();
334
- for (const {from} of diff.transformed) {
335
- from.current.shape.dispose();
336
- }
337
- this.wrapper.scale(this.wrapperScale);
338
- },
339
- );
340
- yield* all(
341
- this.wrapper.scale(
342
- this.calculateWrapperScale(newSVG.size, this.getCurrentSize()),
343
- time,
344
- timingFunction,
345
- ),
346
- baseTween,
347
- delay(transformatorDelay, all(...transformator)),
348
- );
349
- }
350
-
351
- @computed()
352
- private wrapperScale(): Vector2 {
353
- return this.calculateWrapperScale(
354
- this.document().size,
355
- this.getCurrentSize(),
356
- );
357
- }
358
-
359
- /**
360
- * Get the current `SVGDocument`.
361
- */
362
- @computed()
363
- private document(): SVGDocument {
364
- try {
365
- const src = this.svg();
366
- if (this.lastTweenTargetDocument && src === this.lastTweenTargetSrc) {
367
- return this.lastTweenTargetDocument;
368
- }
369
- return this.parseSVG(src);
370
- } finally {
371
- this.lastTweenTargetSrc = null;
372
- this.lastTweenTargetDocument = null;
373
- }
374
- }
375
-
376
- /**
377
- * Get current document nodes.
378
- */
379
- @computed()
380
- private documentNodes() {
381
- return this.document().nodes.map(node => node.shape);
382
- }
383
-
384
- /**
385
- * Convert SVG colors in Shape properties to Motion Canvas colors.
386
- * @param param - Shape properties.
387
- * @returns Converted Shape properties.
388
- */
389
- private processElementStyle({fill, stroke, ...rest}: ShapeProps): ShapeProps {
390
- return {
391
- fill: fill === 'currentColor' ? this.fill : SVG.processSVGColor(fill),
392
- stroke:
393
- stroke === 'currentColor' ? this.stroke : SVG.processSVGColor(stroke),
394
- ...rest,
395
- };
396
- }
397
-
398
- /**
399
- * Parse an SVG string as `SVGDocumentData`.
400
- * @param svg - And SVG string to be parsed.
401
- * @returns `SVGDocumentData` that can be used to build SVGDocument.
402
- */
403
- protected static parseSVGData(svg: string) {
404
- const cached = SVG.svgNodesPool[svg];
405
- if (cached && (cached.size.x > 0 || cached.size.y > 0)) return cached;
406
-
407
- SVG.containerElement.innerHTML = svg;
408
-
409
- const svgRoot = SVG.containerElement.querySelector('svg');
410
-
411
- if (!svgRoot) {
412
- useLogger().error({
413
- message: 'Invalid SVG',
414
- object: svg,
415
- });
416
- return {
417
- size: new Vector2(0, 0),
418
- nodes: [],
419
- } as SVGDocumentData;
420
- }
421
-
422
- let viewBox = new BBox();
423
- let size = new Vector2();
424
-
425
- const hasViewBox = svgRoot.hasAttribute('viewBox');
426
- const hasSize =
427
- svgRoot.hasAttribute('width') || svgRoot.hasAttribute('height');
428
-
429
- if (hasViewBox) {
430
- const {x, y, width, height} = svgRoot.viewBox.baseVal;
431
- viewBox = new BBox(x, y, width, height);
432
-
433
- if (!hasSize) size = viewBox.size;
434
- }
435
-
436
- if (hasSize) {
437
- size = new Vector2(
438
- svgRoot.width.baseVal.value,
439
- svgRoot.height.baseVal.value,
440
- );
441
-
442
- if (!hasViewBox) viewBox = new BBox(0, 0, size.width, size.height);
443
- }
444
-
445
- if (!hasViewBox && !hasSize) {
446
- viewBox = new BBox(svgRoot.getBBox());
447
- size = viewBox.size;
448
- }
449
-
450
- const scale = size.div(viewBox.size);
451
- const center = viewBox.center;
452
-
453
- const rootTransform = new DOMMatrix()
454
- .scaleSelf(scale.x, scale.y)
455
- .translateSelf(-center.x, -center.y);
456
-
457
- const nodes = Array.from(
458
- SVG.extractGroupNodes(svgRoot, svgRoot, rootTransform, {}),
459
- );
460
- const builder: SVGDocumentData = {
461
- size,
462
- nodes,
463
- };
464
- SVG.svgNodesPool[svg] = builder;
465
- return builder;
466
- }
467
-
468
- /**
469
- * Get position, rotation and scale from Matrix transformation as Shape properties
470
- * @param transform - Matrix transformation
471
- * @returns MotionCanvas Shape properties
472
- */
473
- protected static getMatrixTransformation(transform: DOMMatrix): ShapeProps {
474
- const matrix2 = new Matrix2D(transform);
475
-
476
- const position = matrix2.translation;
477
- const rotation = matrix2.rotation;
478
- // matrix.scaling can give incorrect result when matrix contain skew operation
479
- const scale = {
480
- x: matrix2.x.magnitude,
481
- y: matrix2.y.magnitude,
482
- };
483
- if (matrix2.determinant < 0) {
484
- if (matrix2.values[0] < matrix2.values[3]) scale.x = -scale.x;
485
- else scale.y = -scale.y;
486
- }
487
- return {
488
- position,
489
- rotation,
490
- scale,
491
- };
492
- }
493
-
494
- /**
495
- * Convert an SVG color into a Motion Canvas color.
496
- * @param color - SVG color.
497
- * @returns Motion Canvas color.
498
- */
499
- private static processSVGColor(
500
- color: SignalValue<PossibleCanvasStyle> | undefined,
501
- ): SignalValue<PossibleCanvasStyle> | undefined {
502
- if (color === 'transparent' || color === 'none') {
503
- return null;
504
- }
505
-
506
- return color;
507
- }
508
-
509
- /**
510
- * Get the final transformation matrix for the given SVG element.
511
- * @param element - SVG element.
512
- * @param parentTransform - The transformation matrix of the parent.
513
- */
514
- private static getElementTransformation(
515
- element: SVGGraphicsElement,
516
- parentTransform: DOMMatrix,
517
- ) {
518
- const transform = element.transform.baseVal.consolidate();
519
- const transformMatrix = (
520
- transform ? parentTransform.multiply(transform.matrix) : parentTransform
521
- ).translate(
522
- SVG.parseNumberAttribute(element, 'x'),
523
- SVG.parseNumberAttribute(element, 'y'),
524
- );
525
- return transformMatrix;
526
- }
527
-
528
- private static parseLineCap(name: string | null): CanvasLineCap | null {
529
- if (!name) return null;
530
- if (name === 'butt' || name === 'round' || name === 'square') return name;
531
-
532
- useLogger().warn(`SVG: invalid line cap "${name}"`);
533
- return null;
534
- }
535
-
536
- private static parseLineJoin(name: string | null): CanvasLineJoin | null {
537
- if (!name) return null;
538
- if (name === 'bevel' || name === 'miter' || name === 'round') return name;
539
-
540
- if (name === 'arcs' || name === 'miter-clip') {
541
- useLogger().warn(`SVG: line join is not supported "${name}"`);
542
- } else {
543
- useLogger().warn(`SVG: invalid line join "${name}"`);
544
- }
545
- return null;
546
- }
547
-
548
- private static parseLineDash(value: string | null): number[] | null {
549
- if (!value) return null;
550
-
551
- const list = value.split(/,|\s+/);
552
- if (list.findIndex(str => str.endsWith('%')) > 0) {
553
- useLogger().warn(`SVG: percentage line dash are ignored`);
554
- return null;
555
- }
556
- return list.map(str => parseFloat(str));
557
- }
558
-
559
- private static parseDashOffset(value: string | null): number | null {
560
- if (!value) return null;
561
- const trimmed = value.trim();
562
- if (trimmed.endsWith('%')) {
563
- useLogger().warn(`SVG: percentage line dash offset are ignored`);
564
- }
565
- return parseFloat(trimmed);
566
- }
567
-
568
- private static parseOpacity(value: string | null): number | null {
569
- if (!value) return null;
570
- if (value.endsWith('%')) return parseFloat(value) / 100;
571
- return parseFloat(value);
572
- }
573
-
574
- /**
575
- * Convert the SVG element's style to a Motion Canvas Shape properties.
576
- * @param element - An SVG element whose style should be converted.
577
- * @param inheritedStyle - The parent style that should be inherited.
578
- */
579
- private static getElementStyle(
580
- element: SVGGraphicsElement,
581
- inheritedStyle: ShapeProps,
582
- ): ShapeProps {
583
- return {
584
- fill: element.getAttribute('fill') ?? inheritedStyle.fill,
585
- stroke: element.getAttribute('stroke') ?? inheritedStyle.stroke,
586
- lineWidth: element.hasAttribute('stroke-width')
587
- ? parseFloat(element.getAttribute('stroke-width')!)
588
- : inheritedStyle.lineWidth,
589
- lineCap:
590
- this.parseLineCap(element.getAttribute('stroke-linecap')) ??
591
- inheritedStyle.lineCap,
592
- lineJoin:
593
- this.parseLineJoin(element.getAttribute('stroke-linejoin')) ??
594
- inheritedStyle.lineJoin,
595
- lineDash:
596
- this.parseLineDash(element.getAttribute('stroke-dasharray')) ??
597
- inheritedStyle.lineDash,
598
- lineDashOffset:
599
- this.parseDashOffset(element.getAttribute('stroke-dashoffset')) ??
600
- inheritedStyle.lineDashOffset,
601
- opacity:
602
- this.parseOpacity(element.getAttribute('opacity')) ??
603
- inheritedStyle.opacity,
604
- layout: false,
605
- };
606
- }
607
-
608
- /**
609
- * Extract `SVGShapeData` list from the SVG element's children.
610
- * This will not extract the current element's shape.
611
- * @param element - An element whose children will be extracted.
612
- * @param svgRoot - The SVG root ("svg" tag) of the element.
613
- * @param parentTransform - The transformation matrix applied to the parent.
614
- * @param inheritedStyle - The style of the current SVG `element` that the children should inherit.
615
- */
616
- private static *extractGroupNodes(
617
- element: SVGElement,
618
- svgRoot: Element,
619
- parentTransform: DOMMatrix,
620
- inheritedStyle: ShapeProps,
621
- ): Generator<SVGShapeData> {
622
- for (const child of element.children) {
623
- if (!(child instanceof SVGGraphicsElement)) continue;
624
-
625
- yield* this.extractElementNodes(
626
- child,
627
- svgRoot,
628
- parentTransform,
629
- inheritedStyle,
630
- );
631
- }
632
- }
633
-
634
- /**
635
- * Parse a number from an SVG element attribute.
636
- * @param element - SVG element whose attribute will be parsed.
637
- * @param name - The name of the attribute to parse.
638
- * @returns a parsed number or `0` if the attribute is not defined.
639
- */
640
- private static parseNumberAttribute(
641
- element: SVGElement,
642
- name: string,
643
- ): number {
644
- return parseFloat(element.getAttribute(name) ?? '0');
645
- }
646
-
647
- /**
648
- * Extract `SVGShapeData` list from the SVG element.
649
- * This will also recursively extract shapes from its children.
650
- * @param child - An SVG element to extract.
651
- * @param svgRoot - The SVG root ("svg" tag) of the element.
652
- * @param parentTransform - The transformation matrix applied to the parent.
653
- * @param inheritedStyle - The style of the parent SVG element that the element should inherit.
654
- */
655
- private static *extractElementNodes(
656
- child: SVGGraphicsElement,
657
- svgRoot: Element,
658
- parentTransform: DOMMatrix,
659
- inheritedStyle: ShapeProps,
660
- ): Generator<SVGShapeData> {
661
- const transformMatrix = SVG.getElementTransformation(
662
- child,
663
- parentTransform,
664
- );
665
- const style = SVG.getElementStyle(child, inheritedStyle);
666
- const id = child.id ?? '';
667
- if (child.tagName === 'g') {
668
- yield* SVG.extractGroupNodes(child, svgRoot, transformMatrix, style);
669
- } else if (child.tagName === 'use') {
670
- const hrefElement = svgRoot.querySelector(
671
- (child as SVGUseElement).href.baseVal,
672
- );
673
- if (!(hrefElement instanceof SVGGraphicsElement)) {
674
- useLogger().warn(`invalid SVG use tag. element "${child.outerHTML}"`);
675
- return;
676
- }
677
-
678
- yield* SVG.extractElementNodes(
679
- hrefElement,
680
- svgRoot,
681
- transformMatrix,
682
- inheritedStyle,
683
- );
684
- } else if (child.tagName === 'path') {
685
- const data = child.getAttribute('d');
686
- if (!data) {
687
- useLogger().warn('blank path data at ' + child.id);
688
- return;
689
- }
690
- const transformation = transformMatrix;
691
- yield {
692
- id: id || 'path',
693
- type: Path as unknown as new (props: NodeProps) => Node,
694
- props: {
695
- data,
696
- tweenAlignPath: true,
697
- ...SVG.getMatrixTransformation(transformation),
698
- ...style,
699
- } as PathProps,
700
- };
701
- } else if (child.tagName === 'rect') {
702
- const width = SVG.parseNumberAttribute(child, 'width');
703
- const height = SVG.parseNumberAttribute(child, 'height');
704
- const rx = SVG.parseNumberAttribute(child, 'rx');
705
- const ry = SVG.parseNumberAttribute(child, 'ry');
706
-
707
- const bbox = new BBox(0, 0, width, height);
708
- const center = bbox.center;
709
- const transformation = transformMatrix.translate(center.x, center.y);
710
-
711
- yield {
712
- id: id || 'rect',
713
- type: Rect,
714
- props: {
715
- width,
716
- height,
717
- radius: [rx, ry],
718
- ...SVG.getMatrixTransformation(transformation),
719
- ...style,
720
- } as RectProps,
721
- };
722
- } else if (['circle', 'ellipse'].includes(child.tagName)) {
723
- const cx = SVG.parseNumberAttribute(child, 'cx');
724
- const cy = SVG.parseNumberAttribute(child, 'cy');
725
- const size: PossibleSpacing =
726
- child.tagName === 'circle'
727
- ? SVG.parseNumberAttribute(child, 'r') * 2
728
- : [
729
- SVG.parseNumberAttribute(child, 'rx') * 2,
730
- SVG.parseNumberAttribute(child, 'ry') * 2,
731
- ];
732
-
733
- const transformation = transformMatrix.translate(cx, cy);
734
-
735
- yield {
736
- id: id || child.tagName,
737
- type: Circle,
738
- props: {
739
- size,
740
- ...style,
741
- ...SVG.getMatrixTransformation(transformation),
742
- } as CircleProps,
743
- };
744
- } else if (['line', 'polyline', 'polygon'].includes(child.tagName)) {
745
- const numbers =
746
- child.tagName === 'line'
747
- ? ['x1', 'y1', 'x2', 'y2'].map(attr =>
748
- SVG.parseNumberAttribute(child, attr),
749
- )
750
- : child
751
- .getAttribute('points')!
752
- .match(/-?[\d.e+-]+/g)!
753
- .map(value => parseFloat(value));
754
- const points = numbers.reduce<number[][]>((accum, current) => {
755
- let last = accum.at(-1);
756
- if (!last || last.length === 2) {
757
- last = [];
758
- accum.push(last);
759
- }
760
- last.push(current);
761
- return accum;
762
- }, []);
763
-
764
- if (child.tagName === 'polygon') points.push(points[0]);
765
-
766
- yield {
767
- id: id || child.tagName,
768
- type: Line as unknown as new (props: NodeProps) => Node,
769
- props: {
770
- points,
771
- ...style,
772
- ...SVG.getMatrixTransformation(transformMatrix),
773
- } as LineProps,
774
- };
775
- } else if (child.tagName === 'image') {
776
- const x = SVG.parseNumberAttribute(child, 'x');
777
- const y = SVG.parseNumberAttribute(child, 'y');
778
- const width = SVG.parseNumberAttribute(child, 'width');
779
- const height = SVG.parseNumberAttribute(child, 'height');
780
- const href = child.getAttribute('href') ?? '';
781
-
782
- const bbox = new BBox(x, y, width, height);
783
- const center = bbox.center;
784
- const transformation = transformMatrix.translate(center.x, center.y);
785
-
786
- yield {
787
- id: id || child.tagName,
788
- type: Img,
789
- props: {
790
- src: href,
791
- ...style,
792
- ...SVG.getMatrixTransformation(transformation),
793
- } as ImgProps,
794
- };
795
- }
796
- }
797
- }
1
+ import type {
2
+ PossibleSpacing,
3
+ SerializedVector2,
4
+ SignalValue,
5
+ SimpleSignal,
6
+ ThreadGenerator,
7
+ TimingFunction,
8
+ } from '@twick/core';
9
+ import {
10
+ BBox,
11
+ Matrix2D,
12
+ Vector2,
13
+ all,
14
+ clampRemap,
15
+ delay,
16
+ easeInOutSine,
17
+ isReactive,
18
+ lazy,
19
+ threadable,
20
+ tween,
21
+ useLogger,
22
+ } from '@twick/core';
23
+ import {computed, signal} from '../decorators';
24
+ import type {DesiredLength, PossibleCanvasStyle} from '../partials';
25
+ import {applyTransformDiff, getTransformDiff} from '../utils/diff';
26
+ import type {CircleProps} from './Circle';
27
+ import {Circle} from './Circle';
28
+ import type {ImgProps} from './Img';
29
+ import {Img} from './Img';
30
+ import {Layout} from './Layout';
31
+ import type {LineProps} from './Line';
32
+ import {Line} from './Line';
33
+ import type {NodeProps} from './Node';
34
+ import {Node} from './Node';
35
+ import type {PathProps} from './Path';
36
+ import {Path} from './Path';
37
+ import type {RectProps} from './Rect';
38
+ import {Rect} from './Rect';
39
+ import type {ShapeProps} from './Shape';
40
+ import {Shape} from './Shape';
41
+ import {View2D} from './View2D';
42
+
43
+ /**
44
+ * Represent SVG shape.
45
+ * This only used single time because `node` may have reference to parent SVG renderer.
46
+ */
47
+ export interface SVGShape {
48
+ id: string;
49
+ shape: Node;
50
+ }
51
+
52
+ /**
53
+ * Data of SVGShape.
54
+ * This can used many times because it do not reference parent SVG.
55
+ * This must build into SVGShape
56
+ */
57
+ export interface SVGShapeData {
58
+ id: string;
59
+ type: new (props: NodeProps) => Node;
60
+ props: ShapeProps;
61
+ children?: SVGShapeData[];
62
+ }
63
+
64
+ /**
65
+ * Represent SVG document that contains SVG shapes.
66
+ * This only used single time because `nodes` have reference to parent SVG renderer.
67
+ */
68
+ export interface SVGDocument {
69
+ size: Vector2;
70
+ nodes: SVGShape[];
71
+ }
72
+
73
+ /**
74
+ * Data of SVGDocument.
75
+ * This can used many times because it do not reference parent SVG.
76
+ * This must build into SVGDocument
77
+ */
78
+ export interface SVGDocumentData {
79
+ size: Vector2;
80
+ nodes: SVGShapeData[];
81
+ }
82
+
83
+ export interface SVGProps extends ShapeProps {
84
+ svg: SignalValue<string>;
85
+ }
86
+
87
+ /**
88
+ A Node for drawing and animating SVG images.
89
+
90
+ @remarks
91
+ If you're not interested in animating SVG, you can use {@link Img} instead.
92
+ */
93
+ export class SVG extends Shape {
94
+ @lazy(() => {
95
+ const element = document.createElement('div');
96
+ View2D.shadowRoot.appendChild(element);
97
+ return element;
98
+ })
99
+ protected static containerElement: HTMLDivElement;
100
+ private static svgNodesPool: Record<string, SVGDocumentData> = {};
101
+
102
+ /**
103
+ * SVG string to be rendered
104
+ */
105
+ @signal()
106
+ public declare readonly svg: SimpleSignal<string, this>;
107
+
108
+ /**
109
+ * Child to wrap all SVG node
110
+ */
111
+ public wrapper: Node;
112
+
113
+ private lastTweenTargetSrc: string | null = null;
114
+ private lastTweenTargetDocument: SVGDocument | null = null;
115
+
116
+ public constructor(props: SVGProps) {
117
+ super(props);
118
+ this.wrapper = new Node({});
119
+ this.wrapper.children(this.documentNodes);
120
+ this.wrapper.scale(this.wrapperScale);
121
+ this.add(this.wrapper);
122
+ }
123
+
124
+ /**
125
+ * Get all SVG nodes with the given id.
126
+ * @param id - An id to query.
127
+ */
128
+ public getChildrenById(id: string) {
129
+ return this.document()
130
+ .nodes.filter(node => node.id === id)
131
+ .map(({shape}) => shape);
132
+ }
133
+
134
+ protected override desiredSize(): SerializedVector2<DesiredLength> {
135
+ const docSize = this.document().size;
136
+ const scale = this.calculateWrapperScale(
137
+ docSize,
138
+ super.desiredSize() as SerializedVector2<number | null>,
139
+ );
140
+ return docSize.mul(scale);
141
+ }
142
+
143
+ protected getCurrentSize() {
144
+ return {
145
+ x: this.width.isInitial() ? null : this.width(),
146
+ y: this.height.isInitial() ? null : this.height(),
147
+ };
148
+ }
149
+
150
+ protected calculateWrapperScale(
151
+ documentSize: Vector2,
152
+ parentSize: SerializedVector2<number | null>,
153
+ ) {
154
+ const result = new Vector2(1, 1);
155
+ if (parentSize.x && parentSize.y) {
156
+ result.x = parentSize.x / documentSize.width;
157
+ result.y = parentSize.y / documentSize.height;
158
+ } else if (parentSize.x && !parentSize.y) {
159
+ result.x = parentSize.x / documentSize.width;
160
+ result.y = result.x;
161
+ } else if (!parentSize.x && parentSize.y) {
162
+ result.y = parentSize.y / documentSize.height;
163
+ result.x = result.y;
164
+ }
165
+ return result;
166
+ }
167
+
168
+ /**
169
+ * Convert `SVGDocumentData` to `SVGDocument`.
170
+ * @param data - `SVGDocumentData` to convert.
171
+ */
172
+ protected buildDocument(data: SVGDocumentData): SVGDocument {
173
+ return {
174
+ size: data.size,
175
+ nodes: data.nodes.map(ch => this.buildShape(ch)),
176
+ };
177
+ }
178
+
179
+ /**
180
+ * Convert `SVGShapeData` to `SVGShape`.
181
+ * @param data - `SVGShapeData` to convert.
182
+ */
183
+ protected buildShape({id, type, props, children}: SVGShapeData): SVGShape {
184
+ return {
185
+ id,
186
+ shape: new type({
187
+ children: children?.map(ch => this.buildShape(ch).shape),
188
+ ...this.processElementStyle(props),
189
+ }),
190
+ };
191
+ }
192
+
193
+ /**
194
+ * Convert an SVG string to `SVGDocument`.
195
+ * @param svg - An SVG string to be parsed.
196
+ */
197
+ protected parseSVG(svg: string): SVGDocument {
198
+ return this.buildDocument(SVG.parseSVGData(svg));
199
+ }
200
+
201
+ /**
202
+ * Create a tweening list to tween between two SVG nodes.
203
+ * @param from - The initial node,
204
+ * @param to - The final node.
205
+ * @param duration - The duration of the tween.
206
+ * @param timing - The timing function.
207
+ */
208
+ protected *generateTransformer(
209
+ from: Node,
210
+ to: Node,
211
+ duration: number,
212
+ timing: TimingFunction,
213
+ ): Generator<ThreadGenerator> {
214
+ yield from.position(to.position(), duration, timing);
215
+ yield from.scale(to.scale(), duration, timing);
216
+ yield from.rotation(to.rotation(), duration, timing);
217
+ if (
218
+ from instanceof Path &&
219
+ to instanceof Path &&
220
+ from.data() !== to.data()
221
+ ) {
222
+ yield from.data(to.data(), duration, timing);
223
+ }
224
+ if (from instanceof Layout && to instanceof Layout) {
225
+ yield from.size(to.size(), duration, timing);
226
+ }
227
+ if (from instanceof Shape && to instanceof Shape) {
228
+ yield from.fill(to.fill(), duration, timing);
229
+ yield from.stroke(to.stroke(), duration, timing);
230
+ yield from.lineWidth(to.lineWidth(), duration, timing);
231
+ }
232
+
233
+ const fromChildren = from.children();
234
+ const toChildren = to.children();
235
+ for (let i = 0; i < fromChildren.length; i++) {
236
+ yield* this.generateTransformer(
237
+ fromChildren[i],
238
+ toChildren[i],
239
+ duration,
240
+ timing,
241
+ );
242
+ }
243
+ }
244
+
245
+ @threadable()
246
+ protected *tweenSvg(
247
+ value: SignalValue<string>,
248
+ time: number,
249
+ timingFunction: TimingFunction,
250
+ ) {
251
+ const newValue = isReactive(value) ? value() : value;
252
+ const newSVG = this.parseSVG(newValue);
253
+ const currentSVG = this.document();
254
+ const diff = getTransformDiff(currentSVG.nodes, newSVG.nodes);
255
+
256
+ this.lastTweenTargetSrc = newValue;
257
+ this.lastTweenTargetDocument = newSVG;
258
+
259
+ applyTransformDiff(currentSVG.nodes, diff, ({shape, ...rest}) => ({
260
+ ...rest,
261
+ shape: shape.clone(),
262
+ }));
263
+ this.wrapper.children(currentSVG.nodes.map(shape => shape.shape));
264
+ for (const item of currentSVG.nodes) {
265
+ item.shape.parent(this.wrapper);
266
+ }
267
+
268
+ const beginning = 0.2;
269
+ const ending = 0.8;
270
+ const overlap = 0.15;
271
+
272
+ const transformator: ThreadGenerator[] = [];
273
+ const transformatorTime = (ending - beginning) * time;
274
+ const transformatorDelay = beginning * time;
275
+
276
+ for (const item of diff.transformed) {
277
+ transformator.push(
278
+ ...this.generateTransformer(
279
+ item.from.current.shape,
280
+ item.to.current.shape,
281
+ transformatorTime,
282
+ timingFunction,
283
+ ),
284
+ );
285
+ }
286
+
287
+ const autoWidth = this.width.isInitial();
288
+ const autoHeight = this.height.isInitial();
289
+ this.wrapper.scale(
290
+ this.calculateWrapperScale(currentSVG.size, this.getCurrentSize()),
291
+ );
292
+
293
+ const baseTween = tween(
294
+ time,
295
+ value => {
296
+ const progress = timingFunction(value);
297
+ const remapped = clampRemap(beginning, ending, 0, 1, progress);
298
+
299
+ const scale = this.wrapper.scale();
300
+ if (autoWidth) {
301
+ this.width(
302
+ easeInOutSine(remapped, currentSVG.size.x, newSVG.size.x) * scale.x,
303
+ );
304
+ }
305
+
306
+ if (autoHeight) {
307
+ this.height(
308
+ easeInOutSine(remapped, currentSVG.size.y, newSVG.size.y) * scale.y,
309
+ );
310
+ }
311
+
312
+ const deletedOpacity = clampRemap(
313
+ 0,
314
+ beginning + overlap,
315
+ 1,
316
+ 0,
317
+ progress,
318
+ );
319
+ for (const {current} of diff.deleted) {
320
+ current.shape.opacity(deletedOpacity);
321
+ }
322
+
323
+ const insertedOpacity = clampRemap(ending - overlap, 1, 0, 1, progress);
324
+ for (const {current} of diff.inserted) {
325
+ current.shape.opacity(insertedOpacity);
326
+ }
327
+ },
328
+ () => {
329
+ this.wrapper.children(this.documentNodes);
330
+ if (autoWidth) this.width.reset();
331
+ if (autoHeight) this.height.reset();
332
+
333
+ for (const {current} of diff.deleted) current.shape.dispose();
334
+ for (const {from} of diff.transformed) {
335
+ from.current.shape.dispose();
336
+ }
337
+ this.wrapper.scale(this.wrapperScale);
338
+ },
339
+ );
340
+ yield* all(
341
+ this.wrapper.scale(
342
+ this.calculateWrapperScale(newSVG.size, this.getCurrentSize()),
343
+ time,
344
+ timingFunction,
345
+ ),
346
+ baseTween,
347
+ delay(transformatorDelay, all(...transformator)),
348
+ );
349
+ }
350
+
351
+ @computed()
352
+ private wrapperScale(): Vector2 {
353
+ return this.calculateWrapperScale(
354
+ this.document().size,
355
+ this.getCurrentSize(),
356
+ );
357
+ }
358
+
359
+ /**
360
+ * Get the current `SVGDocument`.
361
+ */
362
+ @computed()
363
+ private document(): SVGDocument {
364
+ try {
365
+ const src = this.svg();
366
+ if (this.lastTweenTargetDocument && src === this.lastTweenTargetSrc) {
367
+ return this.lastTweenTargetDocument;
368
+ }
369
+ return this.parseSVG(src);
370
+ } finally {
371
+ this.lastTweenTargetSrc = null;
372
+ this.lastTweenTargetDocument = null;
373
+ }
374
+ }
375
+
376
+ /**
377
+ * Get current document nodes.
378
+ */
379
+ @computed()
380
+ private documentNodes() {
381
+ return this.document().nodes.map(node => node.shape);
382
+ }
383
+
384
+ /**
385
+ * Convert SVG colors in Shape properties to Motion Canvas colors.
386
+ * @param param - Shape properties.
387
+ * @returns Converted Shape properties.
388
+ */
389
+ private processElementStyle({fill, stroke, ...rest}: ShapeProps): ShapeProps {
390
+ return {
391
+ fill: fill === 'currentColor' ? this.fill : SVG.processSVGColor(fill),
392
+ stroke:
393
+ stroke === 'currentColor' ? this.stroke : SVG.processSVGColor(stroke),
394
+ ...rest,
395
+ };
396
+ }
397
+
398
+ /**
399
+ * Parse an SVG string as `SVGDocumentData`.
400
+ * @param svg - And SVG string to be parsed.
401
+ * @returns `SVGDocumentData` that can be used to build SVGDocument.
402
+ */
403
+ protected static parseSVGData(svg: string) {
404
+ const cached = SVG.svgNodesPool[svg];
405
+ if (cached && (cached.size.x > 0 || cached.size.y > 0)) return cached;
406
+
407
+ SVG.containerElement.innerHTML = svg;
408
+
409
+ const svgRoot = SVG.containerElement.querySelector('svg');
410
+
411
+ if (!svgRoot) {
412
+ useLogger().error({
413
+ message: 'Invalid SVG',
414
+ object: svg,
415
+ });
416
+ return {
417
+ size: new Vector2(0, 0),
418
+ nodes: [],
419
+ } as SVGDocumentData;
420
+ }
421
+
422
+ let viewBox = new BBox();
423
+ let size = new Vector2();
424
+
425
+ const hasViewBox = svgRoot.hasAttribute('viewBox');
426
+ const hasSize =
427
+ svgRoot.hasAttribute('width') || svgRoot.hasAttribute('height');
428
+
429
+ if (hasViewBox) {
430
+ const {x, y, width, height} = svgRoot.viewBox.baseVal;
431
+ viewBox = new BBox(x, y, width, height);
432
+
433
+ if (!hasSize) size = viewBox.size;
434
+ }
435
+
436
+ if (hasSize) {
437
+ size = new Vector2(
438
+ svgRoot.width.baseVal.value,
439
+ svgRoot.height.baseVal.value,
440
+ );
441
+
442
+ if (!hasViewBox) viewBox = new BBox(0, 0, size.width, size.height);
443
+ }
444
+
445
+ if (!hasViewBox && !hasSize) {
446
+ viewBox = new BBox(svgRoot.getBBox());
447
+ size = viewBox.size;
448
+ }
449
+
450
+ const scale = size.div(viewBox.size);
451
+ const center = viewBox.center;
452
+
453
+ const rootTransform = new DOMMatrix()
454
+ .scaleSelf(scale.x, scale.y)
455
+ .translateSelf(-center.x, -center.y);
456
+
457
+ const nodes = Array.from(
458
+ SVG.extractGroupNodes(svgRoot, svgRoot, rootTransform, {}),
459
+ );
460
+ const builder: SVGDocumentData = {
461
+ size,
462
+ nodes,
463
+ };
464
+ SVG.svgNodesPool[svg] = builder;
465
+ return builder;
466
+ }
467
+
468
+ /**
469
+ * Get position, rotation and scale from Matrix transformation as Shape properties
470
+ * @param transform - Matrix transformation
471
+ * @returns MotionCanvas Shape properties
472
+ */
473
+ protected static getMatrixTransformation(transform: DOMMatrix): ShapeProps {
474
+ const matrix2 = new Matrix2D(transform);
475
+
476
+ const position = matrix2.translation;
477
+ const rotation = matrix2.rotation;
478
+ // matrix.scaling can give incorrect result when matrix contain skew operation
479
+ const scale = {
480
+ x: matrix2.x.magnitude,
481
+ y: matrix2.y.magnitude,
482
+ };
483
+ if (matrix2.determinant < 0) {
484
+ if (matrix2.values[0] < matrix2.values[3]) scale.x = -scale.x;
485
+ else scale.y = -scale.y;
486
+ }
487
+ return {
488
+ position,
489
+ rotation,
490
+ scale,
491
+ };
492
+ }
493
+
494
+ /**
495
+ * Convert an SVG color into a Motion Canvas color.
496
+ * @param color - SVG color.
497
+ * @returns Motion Canvas color.
498
+ */
499
+ private static processSVGColor(
500
+ color: SignalValue<PossibleCanvasStyle> | undefined,
501
+ ): SignalValue<PossibleCanvasStyle> | undefined {
502
+ if (color === 'transparent' || color === 'none') {
503
+ return null;
504
+ }
505
+
506
+ return color;
507
+ }
508
+
509
+ /**
510
+ * Get the final transformation matrix for the given SVG element.
511
+ * @param element - SVG element.
512
+ * @param parentTransform - The transformation matrix of the parent.
513
+ */
514
+ private static getElementTransformation(
515
+ element: SVGGraphicsElement,
516
+ parentTransform: DOMMatrix,
517
+ ) {
518
+ const transform = element.transform.baseVal.consolidate();
519
+ const transformMatrix = (
520
+ transform ? parentTransform.multiply(transform.matrix) : parentTransform
521
+ ).translate(
522
+ SVG.parseNumberAttribute(element, 'x'),
523
+ SVG.parseNumberAttribute(element, 'y'),
524
+ );
525
+ return transformMatrix;
526
+ }
527
+
528
+ private static parseLineCap(name: string | null): CanvasLineCap | null {
529
+ if (!name) return null;
530
+ if (name === 'butt' || name === 'round' || name === 'square') return name;
531
+
532
+ useLogger().warn(`SVG: invalid line cap "${name}"`);
533
+ return null;
534
+ }
535
+
536
+ private static parseLineJoin(name: string | null): CanvasLineJoin | null {
537
+ if (!name) return null;
538
+ if (name === 'bevel' || name === 'miter' || name === 'round') return name;
539
+
540
+ if (name === 'arcs' || name === 'miter-clip') {
541
+ useLogger().warn(`SVG: line join is not supported "${name}"`);
542
+ } else {
543
+ useLogger().warn(`SVG: invalid line join "${name}"`);
544
+ }
545
+ return null;
546
+ }
547
+
548
+ private static parseLineDash(value: string | null): number[] | null {
549
+ if (!value) return null;
550
+
551
+ const list = value.split(/,|\s+/);
552
+ if (list.findIndex(str => str.endsWith('%')) > 0) {
553
+ useLogger().warn(`SVG: percentage line dash are ignored`);
554
+ return null;
555
+ }
556
+ return list.map(str => parseFloat(str));
557
+ }
558
+
559
+ private static parseDashOffset(value: string | null): number | null {
560
+ if (!value) return null;
561
+ const trimmed = value.trim();
562
+ if (trimmed.endsWith('%')) {
563
+ useLogger().warn(`SVG: percentage line dash offset are ignored`);
564
+ }
565
+ return parseFloat(trimmed);
566
+ }
567
+
568
+ private static parseOpacity(value: string | null): number | null {
569
+ if (!value) return null;
570
+ if (value.endsWith('%')) return parseFloat(value) / 100;
571
+ return parseFloat(value);
572
+ }
573
+
574
+ /**
575
+ * Convert the SVG element's style to a Motion Canvas Shape properties.
576
+ * @param element - An SVG element whose style should be converted.
577
+ * @param inheritedStyle - The parent style that should be inherited.
578
+ */
579
+ private static getElementStyle(
580
+ element: SVGGraphicsElement,
581
+ inheritedStyle: ShapeProps,
582
+ ): ShapeProps {
583
+ return {
584
+ fill: element.getAttribute('fill') ?? inheritedStyle.fill,
585
+ stroke: element.getAttribute('stroke') ?? inheritedStyle.stroke,
586
+ lineWidth: element.hasAttribute('stroke-width')
587
+ ? parseFloat(element.getAttribute('stroke-width')!)
588
+ : inheritedStyle.lineWidth,
589
+ lineCap:
590
+ this.parseLineCap(element.getAttribute('stroke-linecap')) ??
591
+ inheritedStyle.lineCap,
592
+ lineJoin:
593
+ this.parseLineJoin(element.getAttribute('stroke-linejoin')) ??
594
+ inheritedStyle.lineJoin,
595
+ lineDash:
596
+ this.parseLineDash(element.getAttribute('stroke-dasharray')) ??
597
+ inheritedStyle.lineDash,
598
+ lineDashOffset:
599
+ this.parseDashOffset(element.getAttribute('stroke-dashoffset')) ??
600
+ inheritedStyle.lineDashOffset,
601
+ opacity:
602
+ this.parseOpacity(element.getAttribute('opacity')) ??
603
+ inheritedStyle.opacity,
604
+ layout: false,
605
+ };
606
+ }
607
+
608
+ /**
609
+ * Extract `SVGShapeData` list from the SVG element's children.
610
+ * This will not extract the current element's shape.
611
+ * @param element - An element whose children will be extracted.
612
+ * @param svgRoot - The SVG root ("svg" tag) of the element.
613
+ * @param parentTransform - The transformation matrix applied to the parent.
614
+ * @param inheritedStyle - The style of the current SVG `element` that the children should inherit.
615
+ */
616
+ private static *extractGroupNodes(
617
+ element: SVGElement,
618
+ svgRoot: Element,
619
+ parentTransform: DOMMatrix,
620
+ inheritedStyle: ShapeProps,
621
+ ): Generator<SVGShapeData> {
622
+ for (const child of element.children) {
623
+ if (!(child instanceof SVGGraphicsElement)) continue;
624
+
625
+ yield* this.extractElementNodes(
626
+ child,
627
+ svgRoot,
628
+ parentTransform,
629
+ inheritedStyle,
630
+ );
631
+ }
632
+ }
633
+
634
+ /**
635
+ * Parse a number from an SVG element attribute.
636
+ * @param element - SVG element whose attribute will be parsed.
637
+ * @param name - The name of the attribute to parse.
638
+ * @returns a parsed number or `0` if the attribute is not defined.
639
+ */
640
+ private static parseNumberAttribute(
641
+ element: SVGElement,
642
+ name: string,
643
+ ): number {
644
+ return parseFloat(element.getAttribute(name) ?? '0');
645
+ }
646
+
647
+ /**
648
+ * Extract `SVGShapeData` list from the SVG element.
649
+ * This will also recursively extract shapes from its children.
650
+ * @param child - An SVG element to extract.
651
+ * @param svgRoot - The SVG root ("svg" tag) of the element.
652
+ * @param parentTransform - The transformation matrix applied to the parent.
653
+ * @param inheritedStyle - The style of the parent SVG element that the element should inherit.
654
+ */
655
+ private static *extractElementNodes(
656
+ child: SVGGraphicsElement,
657
+ svgRoot: Element,
658
+ parentTransform: DOMMatrix,
659
+ inheritedStyle: ShapeProps,
660
+ ): Generator<SVGShapeData> {
661
+ const transformMatrix = SVG.getElementTransformation(
662
+ child,
663
+ parentTransform,
664
+ );
665
+ const style = SVG.getElementStyle(child, inheritedStyle);
666
+ const id = child.id ?? '';
667
+ if (child.tagName === 'g') {
668
+ yield* SVG.extractGroupNodes(child, svgRoot, transformMatrix, style);
669
+ } else if (child.tagName === 'use') {
670
+ const hrefElement = svgRoot.querySelector(
671
+ (child as SVGUseElement).href.baseVal,
672
+ );
673
+ if (!(hrefElement instanceof SVGGraphicsElement)) {
674
+ useLogger().warn(`invalid SVG use tag. element "${child.outerHTML}"`);
675
+ return;
676
+ }
677
+
678
+ yield* SVG.extractElementNodes(
679
+ hrefElement,
680
+ svgRoot,
681
+ transformMatrix,
682
+ inheritedStyle,
683
+ );
684
+ } else if (child.tagName === 'path') {
685
+ const data = child.getAttribute('d');
686
+ if (!data) {
687
+ useLogger().warn('blank path data at ' + child.id);
688
+ return;
689
+ }
690
+ const transformation = transformMatrix;
691
+ yield {
692
+ id: id || 'path',
693
+ type: Path as unknown as new (props: NodeProps) => Node,
694
+ props: {
695
+ data,
696
+ tweenAlignPath: true,
697
+ ...SVG.getMatrixTransformation(transformation),
698
+ ...style,
699
+ } as PathProps,
700
+ };
701
+ } else if (child.tagName === 'rect') {
702
+ const width = SVG.parseNumberAttribute(child, 'width');
703
+ const height = SVG.parseNumberAttribute(child, 'height');
704
+ const rx = SVG.parseNumberAttribute(child, 'rx');
705
+ const ry = SVG.parseNumberAttribute(child, 'ry');
706
+
707
+ const bbox = new BBox(0, 0, width, height);
708
+ const center = bbox.center;
709
+ const transformation = transformMatrix.translate(center.x, center.y);
710
+
711
+ yield {
712
+ id: id || 'rect',
713
+ type: Rect,
714
+ props: {
715
+ width,
716
+ height,
717
+ radius: [rx, ry],
718
+ ...SVG.getMatrixTransformation(transformation),
719
+ ...style,
720
+ } as RectProps,
721
+ };
722
+ } else if (['circle', 'ellipse'].includes(child.tagName)) {
723
+ const cx = SVG.parseNumberAttribute(child, 'cx');
724
+ const cy = SVG.parseNumberAttribute(child, 'cy');
725
+ const size: PossibleSpacing =
726
+ child.tagName === 'circle'
727
+ ? SVG.parseNumberAttribute(child, 'r') * 2
728
+ : [
729
+ SVG.parseNumberAttribute(child, 'rx') * 2,
730
+ SVG.parseNumberAttribute(child, 'ry') * 2,
731
+ ];
732
+
733
+ const transformation = transformMatrix.translate(cx, cy);
734
+
735
+ yield {
736
+ id: id || child.tagName,
737
+ type: Circle,
738
+ props: {
739
+ size,
740
+ ...style,
741
+ ...SVG.getMatrixTransformation(transformation),
742
+ } as CircleProps,
743
+ };
744
+ } else if (['line', 'polyline', 'polygon'].includes(child.tagName)) {
745
+ const numbers =
746
+ child.tagName === 'line'
747
+ ? ['x1', 'y1', 'x2', 'y2'].map(attr =>
748
+ SVG.parseNumberAttribute(child, attr),
749
+ )
750
+ : child
751
+ .getAttribute('points')!
752
+ .match(/-?[\d.e+-]+/g)!
753
+ .map(value => parseFloat(value));
754
+ const points = numbers.reduce<number[][]>((accum, current) => {
755
+ let last = accum.at(-1);
756
+ if (!last || last.length === 2) {
757
+ last = [];
758
+ accum.push(last);
759
+ }
760
+ last.push(current);
761
+ return accum;
762
+ }, []);
763
+
764
+ if (child.tagName === 'polygon') points.push(points[0]);
765
+
766
+ yield {
767
+ id: id || child.tagName,
768
+ type: Line as unknown as new (props: NodeProps) => Node,
769
+ props: {
770
+ points,
771
+ ...style,
772
+ ...SVG.getMatrixTransformation(transformMatrix),
773
+ } as LineProps,
774
+ };
775
+ } else if (child.tagName === 'image') {
776
+ const x = SVG.parseNumberAttribute(child, 'x');
777
+ const y = SVG.parseNumberAttribute(child, 'y');
778
+ const width = SVG.parseNumberAttribute(child, 'width');
779
+ const height = SVG.parseNumberAttribute(child, 'height');
780
+ const href = child.getAttribute('href') ?? '';
781
+
782
+ const bbox = new BBox(x, y, width, height);
783
+ const center = bbox.center;
784
+ const transformation = transformMatrix.translate(center.x, center.y);
785
+
786
+ yield {
787
+ id: id || child.tagName,
788
+ type: Img,
789
+ props: {
790
+ src: href,
791
+ ...style,
792
+ ...SVG.getMatrixTransformation(transformation),
793
+ } as ImgProps,
794
+ };
795
+ }
796
+ }
797
+ }