@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,137 +1,137 @@
1
- import type {
2
- SignalValue,
3
- SimpleSignal,
4
- TimingFunction,
5
- Vector2,
6
- } from '@twick/core';
7
- import {
8
- BBox,
9
- createSignal,
10
- isReactive,
11
- threadable,
12
- transformVectorAsPoint,
13
- tween,
14
- } from '@twick/core';
15
- import type {CurveProfile} from '../curves';
16
- import {createCurveProfileLerp} from '../curves/createCurveProfileLerp';
17
- import {getPathProfile} from '../curves/getPathProfile';
18
- import {computed, signal} from '../decorators';
19
- import {drawLine, drawPivot} from '../utils';
20
- import type {CurveProps} from './Curve';
21
- import {Curve} from './Curve';
22
-
23
- export interface PathProps extends CurveProps {
24
- data: SignalValue<string>;
25
- }
26
-
27
- export class Path extends Curve {
28
- private currentProfile = createSignal<CurveProfile | null>(null);
29
- @signal()
30
- public declare readonly data: SimpleSignal<string, this>;
31
-
32
- public constructor(props: PathProps) {
33
- super(props);
34
- this.canHaveSubpath = true;
35
- }
36
-
37
- @computed()
38
- public override profile(): CurveProfile {
39
- return this.currentProfile() ?? getPathProfile(this.data());
40
- }
41
-
42
- protected override childrenBBox() {
43
- const points = this.profile().segments.flatMap(segment => segment.points);
44
- return BBox.fromPoints(...points);
45
- }
46
-
47
- protected override lineWidthCoefficient(): number {
48
- const join = this.lineJoin();
49
-
50
- let coefficient = super.lineWidthCoefficient();
51
-
52
- if (join === 'miter') {
53
- const {minSin} = this.profile();
54
- if (minSin > 0) {
55
- coefficient = Math.max(coefficient, 0.5 / minSin);
56
- }
57
- }
58
-
59
- return coefficient;
60
- }
61
-
62
- protected override processSubpath(
63
- path: Path2D,
64
- startPoint: Vector2 | null,
65
- endPoint: Vector2 | null,
66
- ): void {
67
- if (startPoint && endPoint && startPoint.equals(endPoint)) {
68
- path.closePath();
69
- }
70
- }
71
-
72
- @threadable()
73
- protected *tweenData(
74
- newPath: SignalValue<string>,
75
- time: number,
76
- timingFunction: TimingFunction,
77
- ) {
78
- const fromProfile = this.profile();
79
- const toProfile = getPathProfile(isReactive(newPath) ? newPath() : newPath);
80
-
81
- const interpolator = createCurveProfileLerp(fromProfile, toProfile);
82
-
83
- this.currentProfile(fromProfile);
84
- yield* tween(
85
- time,
86
- value => {
87
- const progress = timingFunction(value);
88
- this.currentProfile(interpolator(progress));
89
- },
90
- () => {
91
- this.currentProfile(null);
92
- this.data(newPath);
93
- },
94
- );
95
- }
96
-
97
- public override drawOverlay(
98
- context: CanvasRenderingContext2D,
99
- matrix: DOMMatrix,
100
- ): void {
101
- const box = this.childrenBBox().transformCorners(matrix);
102
- const size = this.computedSize();
103
- const offsetVector = size.mul(this.offset()).scale(0.5);
104
- const offset = transformVectorAsPoint(offsetVector, matrix);
105
- const segments = this.profile().segments;
106
-
107
- context.lineWidth = 1;
108
- context.strokeStyle = 'white';
109
- context.fillStyle = 'white';
110
-
111
- context.save();
112
- context.setTransform(matrix);
113
- let endPoint: Vector2 | null = null;
114
- let path = new Path2D();
115
-
116
- for (const segment of segments) {
117
- if (endPoint && !segment.getPoint(0).position.equals(endPoint)) {
118
- context.stroke(path);
119
- path = new Path2D();
120
- endPoint = null;
121
- }
122
- const [, end] = segment.draw(path, 0, 1, endPoint == null);
123
- endPoint = end.position;
124
- }
125
- context.stroke(path);
126
- context.restore();
127
-
128
- context.beginPath();
129
- drawPivot(context, offset);
130
- context.stroke();
131
-
132
- context.beginPath();
133
- drawLine(context, box);
134
- context.closePath();
135
- context.stroke();
136
- }
137
- }
1
+ import type {
2
+ SignalValue,
3
+ SimpleSignal,
4
+ TimingFunction,
5
+ Vector2,
6
+ } from '@twick/core';
7
+ import {
8
+ BBox,
9
+ createSignal,
10
+ isReactive,
11
+ threadable,
12
+ transformVectorAsPoint,
13
+ tween,
14
+ } from '@twick/core';
15
+ import type {CurveProfile} from '../curves';
16
+ import {createCurveProfileLerp} from '../curves/createCurveProfileLerp';
17
+ import {getPathProfile} from '../curves/getPathProfile';
18
+ import {computed, signal} from '../decorators';
19
+ import {drawLine, drawPivot} from '../utils';
20
+ import type {CurveProps} from './Curve';
21
+ import {Curve} from './Curve';
22
+
23
+ export interface PathProps extends CurveProps {
24
+ data: SignalValue<string>;
25
+ }
26
+
27
+ export class Path extends Curve {
28
+ private currentProfile = createSignal<CurveProfile | null>(null);
29
+ @signal()
30
+ public declare readonly data: SimpleSignal<string, this>;
31
+
32
+ public constructor(props: PathProps) {
33
+ super(props);
34
+ this.canHaveSubpath = true;
35
+ }
36
+
37
+ @computed()
38
+ public override profile(): CurveProfile {
39
+ return this.currentProfile() ?? getPathProfile(this.data());
40
+ }
41
+
42
+ protected override childrenBBox() {
43
+ const points = this.profile().segments.flatMap(segment => segment.points);
44
+ return BBox.fromPoints(...points);
45
+ }
46
+
47
+ protected override lineWidthCoefficient(): number {
48
+ const join = this.lineJoin();
49
+
50
+ let coefficient = super.lineWidthCoefficient();
51
+
52
+ if (join === 'miter') {
53
+ const {minSin} = this.profile();
54
+ if (minSin > 0) {
55
+ coefficient = Math.max(coefficient, 0.5 / minSin);
56
+ }
57
+ }
58
+
59
+ return coefficient;
60
+ }
61
+
62
+ protected override processSubpath(
63
+ path: Path2D,
64
+ startPoint: Vector2 | null,
65
+ endPoint: Vector2 | null,
66
+ ): void {
67
+ if (startPoint && endPoint && startPoint.equals(endPoint)) {
68
+ path.closePath();
69
+ }
70
+ }
71
+
72
+ @threadable()
73
+ protected *tweenData(
74
+ newPath: SignalValue<string>,
75
+ time: number,
76
+ timingFunction: TimingFunction,
77
+ ) {
78
+ const fromProfile = this.profile();
79
+ const toProfile = getPathProfile(isReactive(newPath) ? newPath() : newPath);
80
+
81
+ const interpolator = createCurveProfileLerp(fromProfile, toProfile);
82
+
83
+ this.currentProfile(fromProfile);
84
+ yield* tween(
85
+ time,
86
+ value => {
87
+ const progress = timingFunction(value);
88
+ this.currentProfile(interpolator(progress));
89
+ },
90
+ () => {
91
+ this.currentProfile(null);
92
+ this.data(newPath);
93
+ },
94
+ );
95
+ }
96
+
97
+ public override drawOverlay(
98
+ context: CanvasRenderingContext2D,
99
+ matrix: DOMMatrix,
100
+ ): void {
101
+ const box = this.childrenBBox().transformCorners(matrix);
102
+ const size = this.computedSize();
103
+ const offsetVector = size.mul(this.offset()).scale(0.5);
104
+ const offset = transformVectorAsPoint(offsetVector, matrix);
105
+ const segments = this.profile().segments;
106
+
107
+ context.lineWidth = 1;
108
+ context.strokeStyle = 'white';
109
+ context.fillStyle = 'white';
110
+
111
+ context.save();
112
+ context.setTransform(matrix);
113
+ let endPoint: Vector2 | null = null;
114
+ let path = new Path2D();
115
+
116
+ for (const segment of segments) {
117
+ if (endPoint && !segment.getPoint(0).position.equals(endPoint)) {
118
+ context.stroke(path);
119
+ path = new Path2D();
120
+ endPoint = null;
121
+ }
122
+ const [, end] = segment.draw(path, 0, 1, endPoint == null);
123
+ endPoint = end.position;
124
+ }
125
+ context.stroke(path);
126
+ context.restore();
127
+
128
+ context.beginPath();
129
+ drawPivot(context, offset);
130
+ context.stroke();
131
+
132
+ context.beginPath();
133
+ drawLine(context, box);
134
+ context.closePath();
135
+ context.stroke();
136
+ }
137
+ }
@@ -1,171 +1,171 @@
1
- import type {SerializedVector2, SignalValue, SimpleSignal} from '@twick/core';
2
- import {BBox, Vector2} from '@twick/core';
3
- import type {CurveProfile} from '../curves';
4
- import {getPolylineProfile} from '../curves';
5
- import {computed, initial, signal} from '../decorators';
6
- import type {DesiredLength} from '../partials';
7
- import {drawPolygon} from '../utils';
8
- import type {CurveProps} from './Curve';
9
- import {Curve} from './Curve';
10
-
11
- export interface PolygonProps extends CurveProps {
12
- /**
13
- * {@inheritDoc Polygon.sides}
14
- */
15
- sides?: SignalValue<number>;
16
- /**
17
- * {@inheritDoc Polygon.radius}
18
- */
19
- radius?: SignalValue<number>;
20
- }
21
-
22
- /**
23
- * A node for drawing regular polygons.
24
- *
25
- * @remarks
26
- * This node can be used to render shapes such as: triangle, pentagon,
27
- * hexagon and more.
28
- *
29
- * Note that the polygon is inscribed in a circle defined by the height
30
- * and width. If height and width are unequal, the polygon is inscribed
31
- * in the resulting ellipse.
32
- *
33
- * Since the polygon is inscribed in the circle, the actual displayed
34
- * height and width may differ somewhat from the bounding rectangle. This
35
- * will be particularly noticeable if the number of sides is low, e.g. for a
36
- * triangle.
37
- *
38
- * @preview
39
- * ```tsx editor
40
- * // snippet Polygon
41
- * import {makeScene2D, Polygon} from '@twick/2d';
42
- * import {createRef} from '@twick/core';
43
- *
44
- * export default makeScene2D(function* (view) {
45
- * const ref = createRef<Polygon>();
46
- * view.add(
47
- * <Polygon
48
- * ref={ref}
49
- * sides={6}
50
- * size={160}
51
- * fill={'lightseagreen'}
52
- * />
53
- * );
54
- *
55
- * yield* ref().sides(3, 2).to(6, 2);
56
- * });
57
- *
58
- * // snippet Pentagon outline
59
- * import {makeScene2D, Polygon} from '@twick/2d';
60
- *
61
- * export default makeScene2D(function* (view) {
62
- * view.add(
63
- * <Polygon
64
- * sides={5}
65
- * size={160}
66
- * radius={30}
67
- * stroke={'lightblue'}
68
- * lineWidth={8}
69
- * />
70
- * );
71
- * });
72
- * ```
73
- */
74
- export class Polygon extends Curve {
75
- /**
76
- * The number of sides of the polygon.
77
- *
78
- * @remarks
79
- * For example, a value of 6 creates a hexagon.
80
- *
81
- * @example
82
- * ```tsx
83
- * <Polygon
84
- * size={320}
85
- * sides={7}
86
- * stroke={'#fff'}
87
- * lineWidth={8}
88
- * fill={'lightseagreen'}
89
- * />
90
- * ```
91
- */
92
- @initial(6)
93
- @signal()
94
- public declare readonly sides: SimpleSignal<number, this>;
95
-
96
- /**
97
- * The radius of the polygon's corners.
98
- *
99
- * @example
100
- * ```tsx
101
- * <Polygon
102
- * radius={30}
103
- * size={320}
104
- * sides={3}
105
- * stroke={'#fff'}
106
- * lineWidth={8}
107
- * />
108
- * ```
109
- */
110
- @initial(0)
111
- @signal()
112
- public declare readonly radius: SimpleSignal<number, this>;
113
-
114
- public constructor(props: PolygonProps) {
115
- super(props);
116
- }
117
-
118
- @computed()
119
- public override profile(): CurveProfile {
120
- const sides = this.sides();
121
- const radius = this.radius();
122
-
123
- const points = [];
124
- const size = this.computedSize().scale(0.5);
125
- for (let i = 0; i < sides; i++) {
126
- const theta = (i * 2 * Math.PI) / sides;
127
- const direction = Vector2.fromRadians(theta).perpendicular;
128
- points.push(direction.mul(size));
129
- }
130
-
131
- return getPolylineProfile(points, radius, true);
132
- }
133
-
134
- protected override desiredSize(): SerializedVector2<DesiredLength> {
135
- return {
136
- x: this.width.context.getter(),
137
- y: this.height.context.getter(),
138
- };
139
- }
140
-
141
- protected override offsetComputedLayout(box: BBox): BBox {
142
- return box;
143
- }
144
-
145
- protected override childrenBBox(): BBox {
146
- return BBox.fromSizeCentered(this.computedSize());
147
- }
148
-
149
- protected override requiresProfile(): boolean {
150
- return super.requiresProfile() || this.radius() > 0;
151
- }
152
-
153
- protected override getPath(): Path2D {
154
- if (this.requiresProfile()) {
155
- return this.curveDrawingInfo().path;
156
- }
157
-
158
- return this.createPath();
159
- }
160
- protected override getRipplePath(): Path2D {
161
- return this.createPath(this.rippleSize());
162
- }
163
-
164
- protected createPath(expand = 0) {
165
- const path = new Path2D();
166
- const sides = this.sides();
167
- const box = BBox.fromSizeCentered(this.size()).expand(expand);
168
- drawPolygon(path, box, sides);
169
- return path;
170
- }
171
- }
1
+ import type {SerializedVector2, SignalValue, SimpleSignal} from '@twick/core';
2
+ import {BBox, Vector2} from '@twick/core';
3
+ import type {CurveProfile} from '../curves';
4
+ import {getPolylineProfile} from '../curves';
5
+ import {computed, initial, signal} from '../decorators';
6
+ import type {DesiredLength} from '../partials';
7
+ import {drawPolygon} from '../utils';
8
+ import type {CurveProps} from './Curve';
9
+ import {Curve} from './Curve';
10
+
11
+ export interface PolygonProps extends CurveProps {
12
+ /**
13
+ * {@inheritDoc Polygon.sides}
14
+ */
15
+ sides?: SignalValue<number>;
16
+ /**
17
+ * {@inheritDoc Polygon.radius}
18
+ */
19
+ radius?: SignalValue<number>;
20
+ }
21
+
22
+ /**
23
+ * A node for drawing regular polygons.
24
+ *
25
+ * @remarks
26
+ * This node can be used to render shapes such as: triangle, pentagon,
27
+ * hexagon and more.
28
+ *
29
+ * Note that the polygon is inscribed in a circle defined by the height
30
+ * and width. If height and width are unequal, the polygon is inscribed
31
+ * in the resulting ellipse.
32
+ *
33
+ * Since the polygon is inscribed in the circle, the actual displayed
34
+ * height and width may differ somewhat from the bounding rectangle. This
35
+ * will be particularly noticeable if the number of sides is low, e.g. for a
36
+ * triangle.
37
+ *
38
+ * @preview
39
+ * ```tsx editor
40
+ * // snippet Polygon
41
+ * import {makeScene2D, Polygon} from '@twick/2d';
42
+ * import {createRef} from '@twick/core';
43
+ *
44
+ * export default makeScene2D(function* (view) {
45
+ * const ref = createRef<Polygon>();
46
+ * view.add(
47
+ * <Polygon
48
+ * ref={ref}
49
+ * sides={6}
50
+ * size={160}
51
+ * fill={'lightseagreen'}
52
+ * />
53
+ * );
54
+ *
55
+ * yield* ref().sides(3, 2).to(6, 2);
56
+ * });
57
+ *
58
+ * // snippet Pentagon outline
59
+ * import {makeScene2D, Polygon} from '@twick/2d';
60
+ *
61
+ * export default makeScene2D(function* (view) {
62
+ * view.add(
63
+ * <Polygon
64
+ * sides={5}
65
+ * size={160}
66
+ * radius={30}
67
+ * stroke={'lightblue'}
68
+ * lineWidth={8}
69
+ * />
70
+ * );
71
+ * });
72
+ * ```
73
+ */
74
+ export class Polygon extends Curve {
75
+ /**
76
+ * The number of sides of the polygon.
77
+ *
78
+ * @remarks
79
+ * For example, a value of 6 creates a hexagon.
80
+ *
81
+ * @example
82
+ * ```tsx
83
+ * <Polygon
84
+ * size={320}
85
+ * sides={7}
86
+ * stroke={'#fff'}
87
+ * lineWidth={8}
88
+ * fill={'lightseagreen'}
89
+ * />
90
+ * ```
91
+ */
92
+ @initial(6)
93
+ @signal()
94
+ public declare readonly sides: SimpleSignal<number, this>;
95
+
96
+ /**
97
+ * The radius of the polygon's corners.
98
+ *
99
+ * @example
100
+ * ```tsx
101
+ * <Polygon
102
+ * radius={30}
103
+ * size={320}
104
+ * sides={3}
105
+ * stroke={'#fff'}
106
+ * lineWidth={8}
107
+ * />
108
+ * ```
109
+ */
110
+ @initial(0)
111
+ @signal()
112
+ public declare readonly radius: SimpleSignal<number, this>;
113
+
114
+ public constructor(props: PolygonProps) {
115
+ super(props);
116
+ }
117
+
118
+ @computed()
119
+ public override profile(): CurveProfile {
120
+ const sides = this.sides();
121
+ const radius = this.radius();
122
+
123
+ const points = [];
124
+ const size = this.computedSize().scale(0.5);
125
+ for (let i = 0; i < sides; i++) {
126
+ const theta = (i * 2 * Math.PI) / sides;
127
+ const direction = Vector2.fromRadians(theta).perpendicular;
128
+ points.push(direction.mul(size));
129
+ }
130
+
131
+ return getPolylineProfile(points, radius, true);
132
+ }
133
+
134
+ protected override desiredSize(): SerializedVector2<DesiredLength> {
135
+ return {
136
+ x: this.width.context.getter(),
137
+ y: this.height.context.getter(),
138
+ };
139
+ }
140
+
141
+ protected override offsetComputedLayout(box: BBox): BBox {
142
+ return box;
143
+ }
144
+
145
+ protected override childrenBBox(): BBox {
146
+ return BBox.fromSizeCentered(this.computedSize());
147
+ }
148
+
149
+ protected override requiresProfile(): boolean {
150
+ return super.requiresProfile() || this.radius() > 0;
151
+ }
152
+
153
+ protected override getPath(): Path2D {
154
+ if (this.requiresProfile()) {
155
+ return this.curveDrawingInfo().path;
156
+ }
157
+
158
+ return this.createPath();
159
+ }
160
+ protected override getRipplePath(): Path2D {
161
+ return this.createPath(this.rippleSize());
162
+ }
163
+
164
+ protected createPath(expand = 0) {
165
+ const path = new Path2D();
166
+ const sides = this.sides();
167
+ const box = BBox.fromSizeCentered(this.size()).expand(expand);
168
+ drawPolygon(path, box, sides);
169
+ return path;
170
+ }
171
+ }