@lightningjs/renderer 2.9.0-beta2 → 2.9.0-beta3

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 (189) hide show
  1. package/COPYING +1 -0
  2. package/LICENSE +202 -202
  3. package/NOTICE +3 -3
  4. package/README.md +147 -147
  5. package/dist/src/core/CoreNode.d.ts +2 -1
  6. package/dist/src/core/CoreNode.js +54 -43
  7. package/dist/src/core/CoreNode.js.map +1 -1
  8. package/dist/src/core/CoreTextureManager.d.ts +61 -15
  9. package/dist/src/core/CoreTextureManager.js +179 -104
  10. package/dist/src/core/CoreTextureManager.js.map +1 -1
  11. package/dist/src/core/Stage.d.ts +7 -0
  12. package/dist/src/core/Stage.js +33 -1
  13. package/dist/src/core/Stage.js.map +1 -1
  14. package/dist/src/core/TextureMemoryManager.js +2 -5
  15. package/dist/src/core/TextureMemoryManager.js.map +1 -1
  16. package/dist/src/core/lib/ImageWorker.js +31 -28
  17. package/dist/src/core/lib/ImageWorker.js.map +1 -1
  18. package/dist/src/core/lib/WebGlContextWrapper.d.ts +1 -0
  19. package/dist/src/core/lib/WebGlContextWrapper.js +2 -0
  20. package/dist/src/core/lib/WebGlContextWrapper.js.map +1 -1
  21. package/dist/src/core/renderers/CoreContextTexture.d.ts +1 -0
  22. package/dist/src/core/renderers/CoreContextTexture.js +1 -0
  23. package/dist/src/core/renderers/CoreContextTexture.js.map +1 -1
  24. package/dist/src/core/renderers/canvas/CanvasCoreRenderer.d.ts +1 -1
  25. package/dist/src/core/renderers/canvas/CanvasCoreRenderer.js +13 -5
  26. package/dist/src/core/renderers/canvas/CanvasCoreRenderer.js.map +1 -1
  27. package/dist/src/core/renderers/canvas/CanvasCoreTexture.js +6 -8
  28. package/dist/src/core/renderers/canvas/CanvasCoreTexture.js.map +1 -1
  29. package/dist/src/core/renderers/webgl/WebGlCoreCtxSubTexture.js +3 -1
  30. package/dist/src/core/renderers/webgl/WebGlCoreCtxSubTexture.js.map +1 -1
  31. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.d.ts +1 -2
  32. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.js +26 -24
  33. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.js.map +1 -1
  34. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.d.ts +0 -1
  35. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.js +7 -17
  36. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.js.map +1 -1
  37. package/dist/src/core/renderers/webgl/shaders/DefaultShader.js +45 -45
  38. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +61 -61
  39. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +93 -93
  40. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +63 -63
  41. package/dist/src/core/renderers/webgl/shaders/SdfShader.js +62 -62
  42. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js +15 -15
  43. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js +6 -6
  44. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js +15 -15
  45. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js +15 -15
  46. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js +15 -15
  47. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js +42 -42
  48. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js +44 -44
  49. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.js +3 -3
  50. package/dist/src/core/renderers/webgl/shaders/effects/HolePunchEffect.js +22 -22
  51. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js +28 -28
  52. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js +10 -10
  53. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js +37 -37
  54. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js +19 -19
  55. package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js +3 -5
  56. package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js.map +1 -1
  57. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js +2 -1
  58. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js.map +1 -1
  59. package/dist/src/core/textures/ColorTexture.d.ts +1 -1
  60. package/dist/src/core/textures/ColorTexture.js +2 -1
  61. package/dist/src/core/textures/ColorTexture.js.map +1 -1
  62. package/dist/src/core/textures/ImageTexture.d.ts +8 -1
  63. package/dist/src/core/textures/ImageTexture.js +39 -1
  64. package/dist/src/core/textures/ImageTexture.js.map +1 -1
  65. package/dist/src/core/textures/NoiseTexture.d.ts +1 -1
  66. package/dist/src/core/textures/NoiseTexture.js +2 -1
  67. package/dist/src/core/textures/NoiseTexture.js.map +1 -1
  68. package/dist/src/core/textures/RenderTexture.d.ts +1 -1
  69. package/dist/src/core/textures/RenderTexture.js +2 -1
  70. package/dist/src/core/textures/RenderTexture.js.map +1 -1
  71. package/dist/src/core/textures/SubTexture.d.ts +1 -1
  72. package/dist/src/core/textures/SubTexture.js +21 -4
  73. package/dist/src/core/textures/SubTexture.js.map +1 -1
  74. package/dist/src/core/textures/Texture.d.ts +43 -21
  75. package/dist/src/core/textures/Texture.js +105 -33
  76. package/dist/src/core/textures/Texture.js.map +1 -1
  77. package/dist/src/main-api/Renderer.d.ts +18 -0
  78. package/dist/src/main-api/Renderer.js +6 -4
  79. package/dist/src/main-api/Renderer.js.map +1 -1
  80. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  81. package/exports/canvas.ts +39 -39
  82. package/exports/index.ts +89 -89
  83. package/exports/inspector.ts +24 -24
  84. package/exports/utils.ts +44 -44
  85. package/exports/webgl.ts +38 -38
  86. package/package.json +1 -1
  87. package/scripts/please-use-pnpm.js +13 -13
  88. package/src/common/CommonTypes.ts +139 -139
  89. package/src/common/EventEmitter.ts +77 -77
  90. package/src/common/IAnimationController.ts +92 -92
  91. package/src/common/IEventEmitter.ts +28 -28
  92. package/src/core/CoreNode.test.ts +95 -95
  93. package/src/core/CoreNode.ts +2282 -2258
  94. package/src/core/CoreShaderManager.ts +292 -292
  95. package/src/core/CoreTextNode.ts +450 -450
  96. package/src/core/CoreTextureManager.ts +522 -432
  97. package/src/core/Stage.ts +699 -652
  98. package/src/core/TextureMemoryManager.ts +277 -279
  99. package/src/core/animations/AnimationManager.ts +38 -38
  100. package/src/core/animations/CoreAnimation.ts +340 -340
  101. package/src/core/animations/CoreAnimationController.ts +157 -157
  102. package/src/core/lib/ContextSpy.ts +41 -41
  103. package/src/core/lib/ImageWorker.ts +270 -267
  104. package/src/core/lib/Matrix3d.ts +244 -244
  105. package/src/core/lib/RenderCoords.ts +86 -86
  106. package/src/core/lib/WebGlContextWrapper.ts +1322 -1320
  107. package/src/core/lib/textureCompression.ts +152 -152
  108. package/src/core/lib/textureSvg.ts +78 -78
  109. package/src/core/lib/utils.ts +306 -306
  110. package/src/core/platform.ts +61 -61
  111. package/src/core/renderers/CoreContextTexture.ts +43 -42
  112. package/src/core/renderers/CoreRenderOp.ts +22 -22
  113. package/src/core/renderers/CoreRenderer.ts +114 -114
  114. package/src/core/renderers/CoreShader.ts +41 -41
  115. package/src/core/renderers/canvas/CanvasCoreRenderer.ts +364 -353
  116. package/src/core/renderers/canvas/CanvasCoreTexture.ts +150 -149
  117. package/src/core/renderers/canvas/internal/C2DShaderUtils.ts +231 -231
  118. package/src/core/renderers/canvas/internal/ColorUtils.ts +69 -69
  119. package/src/core/renderers/canvas/shaders/UnsupportedShader.ts +48 -48
  120. package/src/core/renderers/webgl/WebGlCoreCtxRenderTexture.ts +79 -79
  121. package/src/core/renderers/webgl/WebGlCoreCtxSubTexture.ts +50 -48
  122. package/src/core/renderers/webgl/WebGlCoreCtxTexture.ts +298 -290
  123. package/src/core/renderers/webgl/WebGlCoreRenderOp.ts +125 -125
  124. package/src/core/renderers/webgl/WebGlCoreRenderer.ts +805 -817
  125. package/src/core/renderers/webgl/WebGlCoreShader.ts +362 -362
  126. package/src/core/renderers/webgl/internal/BufferCollection.ts +54 -54
  127. package/src/core/renderers/webgl/internal/ShaderUtils.ts +143 -143
  128. package/src/core/renderers/webgl/internal/WebGlUtils.ts +35 -35
  129. package/src/core/renderers/webgl/shaders/DefaultShader.ts +93 -93
  130. package/src/core/renderers/webgl/shaders/DefaultShaderBatched.ts +132 -132
  131. package/src/core/renderers/webgl/shaders/DynamicShader.ts +580 -580
  132. package/src/core/renderers/webgl/shaders/RoundedRectangle.ts +167 -167
  133. package/src/core/renderers/webgl/shaders/SdfShader.ts +204 -204
  134. package/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.ts +101 -101
  135. package/src/core/renderers/webgl/shaders/effects/BorderEffect.ts +87 -87
  136. package/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.ts +101 -101
  137. package/src/core/renderers/webgl/shaders/effects/BorderRightEffect.ts +101 -101
  138. package/src/core/renderers/webgl/shaders/effects/BorderTopEffect.ts +101 -101
  139. package/src/core/renderers/webgl/shaders/effects/EffectUtils.ts +159 -159
  140. package/src/core/renderers/webgl/shaders/effects/FadeOutEffect.ts +127 -127
  141. package/src/core/renderers/webgl/shaders/effects/GlitchEffect.ts +148 -148
  142. package/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.ts +67 -67
  143. package/src/core/renderers/webgl/shaders/effects/HolePunchEffect.ts +157 -157
  144. package/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.ts +171 -171
  145. package/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.ts +168 -168
  146. package/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.ts +187 -187
  147. package/src/core/renderers/webgl/shaders/effects/RadiusEffect.ts +110 -110
  148. package/src/core/renderers/webgl/shaders/effects/ShaderEffect.ts +196 -196
  149. package/src/core/text-rendering/TextRenderingUtils.ts +36 -36
  150. package/src/core/text-rendering/TextTextureRendererUtils.ts +263 -263
  151. package/src/core/text-rendering/TrFontManager.ts +183 -183
  152. package/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts +169 -171
  153. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/FontShaper.ts +139 -139
  154. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.test.ts +173 -173
  155. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.ts +171 -171
  156. package/src/core/text-rendering/font-face-types/TrFontFace.ts +187 -187
  157. package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +89 -89
  158. package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +509 -507
  159. package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts +798 -798
  160. package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +853 -853
  161. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.test.ts +48 -48
  162. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.ts +66 -66
  163. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/SpecialCodepoints.ts +52 -52
  164. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/constants.ts +32 -32
  165. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getStartConditions.ts +117 -117
  166. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.test.ts +133 -133
  167. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.ts +38 -38
  168. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.ts +403 -403
  169. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.test.ts +49 -49
  170. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.ts +52 -52
  171. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.test.ts +205 -205
  172. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.ts +93 -93
  173. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/util.ts +40 -40
  174. package/src/core/text-rendering/renderers/TextRenderer.ts +557 -557
  175. package/src/core/textures/ColorTexture.ts +102 -100
  176. package/src/core/textures/ImageTexture.ts +378 -337
  177. package/src/core/textures/NoiseTexture.ts +104 -101
  178. package/src/core/textures/RenderTexture.ts +85 -83
  179. package/src/core/textures/SubTexture.ts +171 -146
  180. package/src/core/textures/Texture.ts +407 -318
  181. package/src/core/utils.ts +227 -227
  182. package/src/env.d.ts +7 -7
  183. package/src/main-api/DynamicShaderController.ts +104 -104
  184. package/src/main-api/INode.ts +101 -101
  185. package/src/main-api/Inspector.ts +505 -505
  186. package/src/main-api/Renderer.ts +693 -670
  187. package/src/main-api/ShaderController.ts +80 -80
  188. package/src/main-api/utils.ts +45 -45
  189. package/src/utils.ts +248 -248
@@ -1,450 +1,450 @@
1
- /*
2
- * If not stated otherwise in this file or this component's LICENSE file the
3
- * following copyright and licenses apply:
4
- *
5
- * Copyright 2023 Comcast Cable Communications Management, LLC.
6
- *
7
- * Licensed under the Apache License, Version 2.0 (the License);
8
- * you may not use this file except in compliance with the License.
9
- * You may obtain a copy of the License at
10
- *
11
- * http://www.apache.org/licenses/LICENSE-2.0
12
- *
13
- * Unless required by applicable law or agreed to in writing, software
14
- * distributed under the License is distributed on an "AS IS" BASIS,
15
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
- * See the License for the specific language governing permissions and
17
- * limitations under the License.
18
- */
19
-
20
- import type {
21
- TextRenderer,
22
- TextRendererMap,
23
- TrProps,
24
- TextRendererState,
25
- TrFailedEventHandler,
26
- TrLoadedEventHandler,
27
- } from './text-rendering/renderers/TextRenderer.js';
28
- import { CoreNode, UpdateType, type CoreNodeProps } from './CoreNode.js';
29
- import type { Stage } from './Stage.js';
30
- import type { CoreRenderer } from './renderers/CoreRenderer.js';
31
- import type {
32
- NodeTextFailedPayload,
33
- NodeTextLoadedPayload,
34
- } from '../common/CommonTypes.js';
35
- import type { RectWithValid } from './lib/utils.js';
36
- import { assertTruthy } from '../utils.js';
37
- import { Matrix3d } from './lib/Matrix3d.js';
38
-
39
- export interface CoreTextNodeProps extends CoreNodeProps, TrProps {
40
- /**
41
- * Force Text Node to use a specific Text Renderer
42
- *
43
- * @remarks
44
- * By default, Text Nodes resolve the Text Renderer to use based on the font
45
- * that is matched using the font family and other font selection properties.
46
- *
47
- * If two fonts supported by two separate Text Renderers are matched setting
48
- * this override forces the Text Node to resolve to the Text Renderer defined
49
- * here.
50
- *
51
- * @default null
52
- */
53
- textRendererOverride: keyof TextRendererMap | null;
54
- }
55
-
56
- /**
57
- * An CoreNode in the Renderer scene graph that renders text.
58
- *
59
- * @remarks
60
- * A Text Node is the second graphical building block of the Renderer scene
61
- * graph. It renders text using a specific text renderer that is automatically
62
- * chosen based on the font requested and what type of fonts are installed
63
- * into an app.
64
- *
65
- * The text renderer can be overridden by setting the `textRendererOverride`
66
- *
67
- * The `texture` and `shader` properties are managed by loaded text renderer and
68
- * should not be set directly.
69
- *
70
- * For non-text rendering, see {@link CoreNode}.
71
- */
72
- export class CoreTextNode extends CoreNode implements CoreTextNodeProps {
73
- textRenderer: TextRenderer;
74
- trState: TextRendererState;
75
- private _textRendererOverride: CoreTextNodeProps['textRendererOverride'] =
76
- null;
77
-
78
- constructor(
79
- stage: Stage,
80
- props: CoreTextNodeProps,
81
- textRenderer: TextRenderer,
82
- ) {
83
- super(stage, props);
84
- this._textRendererOverride = props.textRendererOverride;
85
- this.textRenderer = textRenderer;
86
- const textRendererState = this.createState({
87
- x: this.absX,
88
- y: this.absY,
89
- width: props.width,
90
- height: props.height,
91
- textAlign: props.textAlign,
92
- color: props.color,
93
- zIndex: props.zIndex,
94
- contain: props.contain,
95
- scrollable: props.scrollable,
96
- scrollY: props.scrollY,
97
- offsetY: props.offsetY,
98
- letterSpacing: props.letterSpacing,
99
- debug: props.debug,
100
- fontFamily: props.fontFamily,
101
- fontSize: props.fontSize,
102
- fontStretch: props.fontStretch,
103
- fontStyle: props.fontStyle,
104
- fontWeight: props.fontWeight,
105
- text: props.text,
106
- lineHeight: props.lineHeight,
107
- maxLines: props.maxLines,
108
- textBaseline: props.textBaseline,
109
- verticalAlign: props.verticalAlign,
110
- overflowSuffix: props.overflowSuffix,
111
- });
112
-
113
- this.trState = textRendererState;
114
- }
115
-
116
- private onTextLoaded: TrLoadedEventHandler = () => {
117
- const { contain } = this;
118
- const setWidth = this.trState.props.width;
119
- const setHeight = this.trState.props.height;
120
- const calcWidth = this.trState.textW || 0;
121
- const calcHeight = this.trState.textH || 0;
122
-
123
- if (contain === 'both') {
124
- this.props.width = setWidth;
125
- this.props.height = setHeight;
126
- } else if (contain === 'width') {
127
- this.props.width = setWidth;
128
- this.props.height = calcHeight;
129
- } else if (contain === 'none') {
130
- this.props.width = calcWidth;
131
- this.props.height = calcHeight;
132
- }
133
- this.updateLocalTransform();
134
-
135
- // Incase the RAF loop has been stopped already before text was loaded,
136
- // we request a render so it can be drawn.
137
- this.stage.requestRender();
138
- this.emit('loaded', {
139
- type: 'text',
140
- dimensions: {
141
- width: this.trState.textW || 0,
142
- height: this.trState.textH || 0,
143
- },
144
- } satisfies NodeTextLoadedPayload);
145
- };
146
-
147
- private onTextFailed: TrFailedEventHandler = (target, error) => {
148
- this.emit('failed', {
149
- type: 'text',
150
- error,
151
- } satisfies NodeTextFailedPayload);
152
- };
153
-
154
- override get width(): number {
155
- return this.props.width;
156
- }
157
-
158
- override set width(value: number) {
159
- this.props.width = value;
160
- this.textRenderer.set.width(this.trState, value);
161
-
162
- // If not containing, we must update the local transform to account for the
163
- // new width
164
- if (this.contain === 'none') {
165
- this.setUpdateType(UpdateType.Local);
166
- }
167
- }
168
-
169
- override get height(): number {
170
- return this.props.height;
171
- }
172
-
173
- override set height(value: number) {
174
- this.props.height = value;
175
- this.textRenderer.set.height(this.trState, value);
176
-
177
- // If not containing in the horizontal direction, we must update the local
178
- // transform to account for the new height
179
- if (this.contain !== 'both') {
180
- this.setUpdateType(UpdateType.Local);
181
- }
182
- }
183
-
184
- override get color(): number {
185
- return this.trState.props.color;
186
- }
187
-
188
- override set color(value: number) {
189
- this.textRenderer.set.color(this.trState, value);
190
- }
191
-
192
- get text(): string {
193
- return this.trState.props.text;
194
- }
195
-
196
- set text(value: string) {
197
- this.textRenderer.set.text(this.trState, value);
198
- }
199
-
200
- get textRendererOverride(): CoreTextNodeProps['textRendererOverride'] {
201
- return this._textRendererOverride;
202
- }
203
-
204
- set textRendererOverride(value: CoreTextNodeProps['textRendererOverride']) {
205
- this._textRendererOverride = value;
206
- this.textRenderer.destroyState(this.trState);
207
-
208
- const textRenderer = this.stage.resolveTextRenderer(
209
- this.trState.props,
210
- this._textRendererOverride,
211
- );
212
-
213
- if (!textRenderer) {
214
- console.warn(
215
- 'Text Renderer not found for font',
216
- this.trState.props.fontFamily,
217
- );
218
- return;
219
- }
220
-
221
- this.textRenderer = textRenderer;
222
- this.trState = this.createState(this.trState.props);
223
- }
224
-
225
- get fontSize(): CoreTextNodeProps['fontSize'] {
226
- return this.trState.props.fontSize;
227
- }
228
-
229
- set fontSize(value: CoreTextNodeProps['fontSize']) {
230
- this.textRenderer.set.fontSize(this.trState, value);
231
- }
232
-
233
- get fontFamily(): CoreTextNodeProps['fontFamily'] {
234
- return this.trState.props.fontFamily;
235
- }
236
-
237
- set fontFamily(value: CoreTextNodeProps['fontFamily']) {
238
- this.textRenderer.set.fontFamily(this.trState, value);
239
- }
240
-
241
- get fontStretch(): CoreTextNodeProps['fontStretch'] {
242
- return this.trState.props.fontStretch;
243
- }
244
-
245
- set fontStretch(value: CoreTextNodeProps['fontStretch']) {
246
- this.textRenderer.set.fontStretch(this.trState, value);
247
- }
248
-
249
- get fontStyle(): CoreTextNodeProps['fontStyle'] {
250
- return this.trState.props.fontStyle;
251
- }
252
-
253
- set fontStyle(value: CoreTextNodeProps['fontStyle']) {
254
- this.textRenderer.set.fontStyle(this.trState, value);
255
- }
256
-
257
- get fontWeight(): CoreTextNodeProps['fontWeight'] {
258
- return this.trState.props.fontWeight;
259
- }
260
-
261
- set fontWeight(value: CoreTextNodeProps['fontWeight']) {
262
- this.textRenderer.set.fontWeight(this.trState, value);
263
- }
264
-
265
- get textAlign(): CoreTextNodeProps['textAlign'] {
266
- return this.trState.props.textAlign;
267
- }
268
-
269
- set textAlign(value: CoreTextNodeProps['textAlign']) {
270
- this.textRenderer.set.textAlign(this.trState, value);
271
- }
272
-
273
- get contain(): CoreTextNodeProps['contain'] {
274
- return this.trState.props.contain;
275
- }
276
-
277
- set contain(value: CoreTextNodeProps['contain']) {
278
- this.textRenderer.set.contain(this.trState, value);
279
- }
280
-
281
- get scrollable(): CoreTextNodeProps['scrollable'] {
282
- return this.trState.props.scrollable;
283
- }
284
-
285
- set scrollable(value: CoreTextNodeProps['scrollable']) {
286
- this.textRenderer.set.scrollable(this.trState, value);
287
- }
288
-
289
- get scrollY(): CoreTextNodeProps['scrollY'] {
290
- return this.trState.props.scrollY;
291
- }
292
-
293
- set scrollY(value: CoreTextNodeProps['scrollY']) {
294
- this.textRenderer.set.scrollY(this.trState, value);
295
- }
296
-
297
- get offsetY(): CoreTextNodeProps['offsetY'] {
298
- return this.trState.props.offsetY;
299
- }
300
-
301
- set offsetY(value: CoreTextNodeProps['offsetY']) {
302
- this.textRenderer.set.offsetY(this.trState, value);
303
- }
304
-
305
- get letterSpacing(): CoreTextNodeProps['letterSpacing'] {
306
- return this.trState.props.letterSpacing;
307
- }
308
-
309
- set letterSpacing(value: CoreTextNodeProps['letterSpacing']) {
310
- this.textRenderer.set.letterSpacing(this.trState, value);
311
- }
312
-
313
- get lineHeight(): CoreTextNodeProps['lineHeight'] {
314
- return this.trState.props.lineHeight;
315
- }
316
-
317
- set lineHeight(value: CoreTextNodeProps['lineHeight']) {
318
- this.textRenderer.set.lineHeight(this.trState, value);
319
- }
320
-
321
- get maxLines(): CoreTextNodeProps['maxLines'] {
322
- return this.trState.props.maxLines;
323
- }
324
-
325
- set maxLines(value: CoreTextNodeProps['maxLines']) {
326
- this.textRenderer.set.maxLines(this.trState, value);
327
- }
328
-
329
- get textBaseline(): CoreTextNodeProps['textBaseline'] {
330
- return this.trState.props.textBaseline;
331
- }
332
-
333
- set textBaseline(value: CoreTextNodeProps['textBaseline']) {
334
- this.textRenderer.set.textBaseline(this.trState, value);
335
- }
336
-
337
- get verticalAlign(): CoreTextNodeProps['verticalAlign'] {
338
- return this.trState.props.verticalAlign;
339
- }
340
-
341
- set verticalAlign(value: CoreTextNodeProps['verticalAlign']) {
342
- this.textRenderer.set.verticalAlign(this.trState, value);
343
- }
344
-
345
- get overflowSuffix(): CoreTextNodeProps['overflowSuffix'] {
346
- return this.trState.props.overflowSuffix;
347
- }
348
-
349
- set overflowSuffix(value: CoreTextNodeProps['overflowSuffix']) {
350
- this.textRenderer.set.overflowSuffix(this.trState, value);
351
- }
352
-
353
- get debug(): CoreTextNodeProps['debug'] {
354
- return this.trState.props.debug;
355
- }
356
-
357
- set debug(value: CoreTextNodeProps['debug']) {
358
- this.textRenderer.set.debug(this.trState, value);
359
- }
360
-
361
- override update(delta: number, parentClippingRect: RectWithValid) {
362
- super.update(delta, parentClippingRect);
363
-
364
- assertTruthy(this.globalTransform);
365
-
366
- // globalTransform is updated in super.update(delta)
367
- this.textRenderer.set.x(this.trState, this.globalTransform.tx);
368
- this.textRenderer.set.y(this.trState, this.globalTransform.ty);
369
- }
370
-
371
- override hasRenderableProperties(): boolean {
372
- if (this.trState && this.trState.props.text !== '') {
373
- return true;
374
- }
375
- return super.hasRenderableProperties();
376
- }
377
-
378
- override onChangeIsRenderable(isRenderable: boolean) {
379
- super.onChangeIsRenderable(isRenderable);
380
- this.textRenderer.setIsRenderable(this.trState, isRenderable);
381
- }
382
-
383
- override renderQuads(renderer: CoreRenderer) {
384
- assertTruthy(this.globalTransform);
385
-
386
- // If the text renderer does not support rendering quads, fallback to the
387
- // default renderQuads method
388
- if (!this.textRenderer.renderQuads) {
389
- super.renderQuads(renderer);
390
- return;
391
- }
392
-
393
- // If the text renderer does support rendering quads, use it...
394
-
395
- // Prevent quad rendering if parent has a render texture
396
- // and this node is not the render texture
397
- if (this.parentHasRenderTexture) {
398
- if (!renderer.renderToTextureActive) {
399
- return;
400
- }
401
- // Prevent quad rendering if parent render texture is not the active render texture
402
- if (this.parentRenderTexture !== renderer.activeRttNode) {
403
- return;
404
- }
405
- }
406
-
407
- if (this.parentHasRenderTexture && this.props.parent?.rtt) {
408
- this.globalTransform = Matrix3d.identity();
409
- if (this.localTransform) {
410
- this.globalTransform.multiply(this.localTransform);
411
- }
412
- }
413
-
414
- assertTruthy(this.globalTransform);
415
-
416
- this.textRenderer.renderQuads(
417
- this.trState,
418
- this.globalTransform,
419
- this.clippingRect,
420
- this.worldAlpha,
421
- this.parentHasRenderTexture,
422
- this.framebufferDimensions,
423
- );
424
- }
425
-
426
- /**
427
- * Destroy the node and cleanup all resources
428
- */
429
- override destroy(): void {
430
- super.destroy();
431
-
432
- this.textRenderer.destroyState(this.trState);
433
- }
434
-
435
- /**
436
- * Resolve a text renderer and a new state based on the current text renderer props provided
437
- * @param props
438
- * @returns
439
- */
440
- private createState(props: TrProps) {
441
- const textRendererState = this.textRenderer.createState(props, this);
442
-
443
- textRendererState.emitter.on('loaded', this.onTextLoaded);
444
- textRendererState.emitter.on('failed', this.onTextFailed);
445
-
446
- this.textRenderer.scheduleUpdateState(textRendererState);
447
-
448
- return textRendererState;
449
- }
450
- }
1
+ /*
2
+ * If not stated otherwise in this file or this component's LICENSE file the
3
+ * following copyright and licenses apply:
4
+ *
5
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
6
+ *
7
+ * Licensed under the Apache License, Version 2.0 (the License);
8
+ * you may not use this file except in compliance with the License.
9
+ * You may obtain a copy of the License at
10
+ *
11
+ * http://www.apache.org/licenses/LICENSE-2.0
12
+ *
13
+ * Unless required by applicable law or agreed to in writing, software
14
+ * distributed under the License is distributed on an "AS IS" BASIS,
15
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ * See the License for the specific language governing permissions and
17
+ * limitations under the License.
18
+ */
19
+
20
+ import type {
21
+ TextRenderer,
22
+ TextRendererMap,
23
+ TrProps,
24
+ TextRendererState,
25
+ TrFailedEventHandler,
26
+ TrLoadedEventHandler,
27
+ } from './text-rendering/renderers/TextRenderer.js';
28
+ import { CoreNode, UpdateType, type CoreNodeProps } from './CoreNode.js';
29
+ import type { Stage } from './Stage.js';
30
+ import type { CoreRenderer } from './renderers/CoreRenderer.js';
31
+ import type {
32
+ NodeTextFailedPayload,
33
+ NodeTextLoadedPayload,
34
+ } from '../common/CommonTypes.js';
35
+ import type { RectWithValid } from './lib/utils.js';
36
+ import { assertTruthy } from '../utils.js';
37
+ import { Matrix3d } from './lib/Matrix3d.js';
38
+
39
+ export interface CoreTextNodeProps extends CoreNodeProps, TrProps {
40
+ /**
41
+ * Force Text Node to use a specific Text Renderer
42
+ *
43
+ * @remarks
44
+ * By default, Text Nodes resolve the Text Renderer to use based on the font
45
+ * that is matched using the font family and other font selection properties.
46
+ *
47
+ * If two fonts supported by two separate Text Renderers are matched setting
48
+ * this override forces the Text Node to resolve to the Text Renderer defined
49
+ * here.
50
+ *
51
+ * @default null
52
+ */
53
+ textRendererOverride: keyof TextRendererMap | null;
54
+ }
55
+
56
+ /**
57
+ * An CoreNode in the Renderer scene graph that renders text.
58
+ *
59
+ * @remarks
60
+ * A Text Node is the second graphical building block of the Renderer scene
61
+ * graph. It renders text using a specific text renderer that is automatically
62
+ * chosen based on the font requested and what type of fonts are installed
63
+ * into an app.
64
+ *
65
+ * The text renderer can be overridden by setting the `textRendererOverride`
66
+ *
67
+ * The `texture` and `shader` properties are managed by loaded text renderer and
68
+ * should not be set directly.
69
+ *
70
+ * For non-text rendering, see {@link CoreNode}.
71
+ */
72
+ export class CoreTextNode extends CoreNode implements CoreTextNodeProps {
73
+ textRenderer: TextRenderer;
74
+ trState: TextRendererState;
75
+ private _textRendererOverride: CoreTextNodeProps['textRendererOverride'] =
76
+ null;
77
+
78
+ constructor(
79
+ stage: Stage,
80
+ props: CoreTextNodeProps,
81
+ textRenderer: TextRenderer,
82
+ ) {
83
+ super(stage, props);
84
+ this._textRendererOverride = props.textRendererOverride;
85
+ this.textRenderer = textRenderer;
86
+ const textRendererState = this.createState({
87
+ x: this.absX,
88
+ y: this.absY,
89
+ width: props.width,
90
+ height: props.height,
91
+ textAlign: props.textAlign,
92
+ color: props.color,
93
+ zIndex: props.zIndex,
94
+ contain: props.contain,
95
+ scrollable: props.scrollable,
96
+ scrollY: props.scrollY,
97
+ offsetY: props.offsetY,
98
+ letterSpacing: props.letterSpacing,
99
+ debug: props.debug,
100
+ fontFamily: props.fontFamily,
101
+ fontSize: props.fontSize,
102
+ fontStretch: props.fontStretch,
103
+ fontStyle: props.fontStyle,
104
+ fontWeight: props.fontWeight,
105
+ text: props.text,
106
+ lineHeight: props.lineHeight,
107
+ maxLines: props.maxLines,
108
+ textBaseline: props.textBaseline,
109
+ verticalAlign: props.verticalAlign,
110
+ overflowSuffix: props.overflowSuffix,
111
+ });
112
+
113
+ this.trState = textRendererState;
114
+ }
115
+
116
+ private onTextLoaded: TrLoadedEventHandler = () => {
117
+ const { contain } = this;
118
+ const setWidth = this.trState.props.width;
119
+ const setHeight = this.trState.props.height;
120
+ const calcWidth = this.trState.textW || 0;
121
+ const calcHeight = this.trState.textH || 0;
122
+
123
+ if (contain === 'both') {
124
+ this.props.width = setWidth;
125
+ this.props.height = setHeight;
126
+ } else if (contain === 'width') {
127
+ this.props.width = setWidth;
128
+ this.props.height = calcHeight;
129
+ } else if (contain === 'none') {
130
+ this.props.width = calcWidth;
131
+ this.props.height = calcHeight;
132
+ }
133
+ this.updateLocalTransform();
134
+
135
+ // Incase the RAF loop has been stopped already before text was loaded,
136
+ // we request a render so it can be drawn.
137
+ this.stage.requestRender();
138
+ this.emit('loaded', {
139
+ type: 'text',
140
+ dimensions: {
141
+ width: this.trState.textW || 0,
142
+ height: this.trState.textH || 0,
143
+ },
144
+ } satisfies NodeTextLoadedPayload);
145
+ };
146
+
147
+ private onTextFailed: TrFailedEventHandler = (target, error) => {
148
+ this.emit('failed', {
149
+ type: 'text',
150
+ error,
151
+ } satisfies NodeTextFailedPayload);
152
+ };
153
+
154
+ override get width(): number {
155
+ return this.props.width;
156
+ }
157
+
158
+ override set width(value: number) {
159
+ this.props.width = value;
160
+ this.textRenderer.set.width(this.trState, value);
161
+
162
+ // If not containing, we must update the local transform to account for the
163
+ // new width
164
+ if (this.contain === 'none') {
165
+ this.setUpdateType(UpdateType.Local);
166
+ }
167
+ }
168
+
169
+ override get height(): number {
170
+ return this.props.height;
171
+ }
172
+
173
+ override set height(value: number) {
174
+ this.props.height = value;
175
+ this.textRenderer.set.height(this.trState, value);
176
+
177
+ // If not containing in the horizontal direction, we must update the local
178
+ // transform to account for the new height
179
+ if (this.contain !== 'both') {
180
+ this.setUpdateType(UpdateType.Local);
181
+ }
182
+ }
183
+
184
+ override get color(): number {
185
+ return this.trState.props.color;
186
+ }
187
+
188
+ override set color(value: number) {
189
+ this.textRenderer.set.color(this.trState, value);
190
+ }
191
+
192
+ get text(): string {
193
+ return this.trState.props.text;
194
+ }
195
+
196
+ set text(value: string) {
197
+ this.textRenderer.set.text(this.trState, value);
198
+ }
199
+
200
+ get textRendererOverride(): CoreTextNodeProps['textRendererOverride'] {
201
+ return this._textRendererOverride;
202
+ }
203
+
204
+ set textRendererOverride(value: CoreTextNodeProps['textRendererOverride']) {
205
+ this._textRendererOverride = value;
206
+ this.textRenderer.destroyState(this.trState);
207
+
208
+ const textRenderer = this.stage.resolveTextRenderer(
209
+ this.trState.props,
210
+ this._textRendererOverride,
211
+ );
212
+
213
+ if (!textRenderer) {
214
+ console.warn(
215
+ 'Text Renderer not found for font',
216
+ this.trState.props.fontFamily,
217
+ );
218
+ return;
219
+ }
220
+
221
+ this.textRenderer = textRenderer;
222
+ this.trState = this.createState(this.trState.props);
223
+ }
224
+
225
+ get fontSize(): CoreTextNodeProps['fontSize'] {
226
+ return this.trState.props.fontSize;
227
+ }
228
+
229
+ set fontSize(value: CoreTextNodeProps['fontSize']) {
230
+ this.textRenderer.set.fontSize(this.trState, value);
231
+ }
232
+
233
+ get fontFamily(): CoreTextNodeProps['fontFamily'] {
234
+ return this.trState.props.fontFamily;
235
+ }
236
+
237
+ set fontFamily(value: CoreTextNodeProps['fontFamily']) {
238
+ this.textRenderer.set.fontFamily(this.trState, value);
239
+ }
240
+
241
+ get fontStretch(): CoreTextNodeProps['fontStretch'] {
242
+ return this.trState.props.fontStretch;
243
+ }
244
+
245
+ set fontStretch(value: CoreTextNodeProps['fontStretch']) {
246
+ this.textRenderer.set.fontStretch(this.trState, value);
247
+ }
248
+
249
+ get fontStyle(): CoreTextNodeProps['fontStyle'] {
250
+ return this.trState.props.fontStyle;
251
+ }
252
+
253
+ set fontStyle(value: CoreTextNodeProps['fontStyle']) {
254
+ this.textRenderer.set.fontStyle(this.trState, value);
255
+ }
256
+
257
+ get fontWeight(): CoreTextNodeProps['fontWeight'] {
258
+ return this.trState.props.fontWeight;
259
+ }
260
+
261
+ set fontWeight(value: CoreTextNodeProps['fontWeight']) {
262
+ this.textRenderer.set.fontWeight(this.trState, value);
263
+ }
264
+
265
+ get textAlign(): CoreTextNodeProps['textAlign'] {
266
+ return this.trState.props.textAlign;
267
+ }
268
+
269
+ set textAlign(value: CoreTextNodeProps['textAlign']) {
270
+ this.textRenderer.set.textAlign(this.trState, value);
271
+ }
272
+
273
+ get contain(): CoreTextNodeProps['contain'] {
274
+ return this.trState.props.contain;
275
+ }
276
+
277
+ set contain(value: CoreTextNodeProps['contain']) {
278
+ this.textRenderer.set.contain(this.trState, value);
279
+ }
280
+
281
+ get scrollable(): CoreTextNodeProps['scrollable'] {
282
+ return this.trState.props.scrollable;
283
+ }
284
+
285
+ set scrollable(value: CoreTextNodeProps['scrollable']) {
286
+ this.textRenderer.set.scrollable(this.trState, value);
287
+ }
288
+
289
+ get scrollY(): CoreTextNodeProps['scrollY'] {
290
+ return this.trState.props.scrollY;
291
+ }
292
+
293
+ set scrollY(value: CoreTextNodeProps['scrollY']) {
294
+ this.textRenderer.set.scrollY(this.trState, value);
295
+ }
296
+
297
+ get offsetY(): CoreTextNodeProps['offsetY'] {
298
+ return this.trState.props.offsetY;
299
+ }
300
+
301
+ set offsetY(value: CoreTextNodeProps['offsetY']) {
302
+ this.textRenderer.set.offsetY(this.trState, value);
303
+ }
304
+
305
+ get letterSpacing(): CoreTextNodeProps['letterSpacing'] {
306
+ return this.trState.props.letterSpacing;
307
+ }
308
+
309
+ set letterSpacing(value: CoreTextNodeProps['letterSpacing']) {
310
+ this.textRenderer.set.letterSpacing(this.trState, value);
311
+ }
312
+
313
+ get lineHeight(): CoreTextNodeProps['lineHeight'] {
314
+ return this.trState.props.lineHeight;
315
+ }
316
+
317
+ set lineHeight(value: CoreTextNodeProps['lineHeight']) {
318
+ this.textRenderer.set.lineHeight(this.trState, value);
319
+ }
320
+
321
+ get maxLines(): CoreTextNodeProps['maxLines'] {
322
+ return this.trState.props.maxLines;
323
+ }
324
+
325
+ set maxLines(value: CoreTextNodeProps['maxLines']) {
326
+ this.textRenderer.set.maxLines(this.trState, value);
327
+ }
328
+
329
+ get textBaseline(): CoreTextNodeProps['textBaseline'] {
330
+ return this.trState.props.textBaseline;
331
+ }
332
+
333
+ set textBaseline(value: CoreTextNodeProps['textBaseline']) {
334
+ this.textRenderer.set.textBaseline(this.trState, value);
335
+ }
336
+
337
+ get verticalAlign(): CoreTextNodeProps['verticalAlign'] {
338
+ return this.trState.props.verticalAlign;
339
+ }
340
+
341
+ set verticalAlign(value: CoreTextNodeProps['verticalAlign']) {
342
+ this.textRenderer.set.verticalAlign(this.trState, value);
343
+ }
344
+
345
+ get overflowSuffix(): CoreTextNodeProps['overflowSuffix'] {
346
+ return this.trState.props.overflowSuffix;
347
+ }
348
+
349
+ set overflowSuffix(value: CoreTextNodeProps['overflowSuffix']) {
350
+ this.textRenderer.set.overflowSuffix(this.trState, value);
351
+ }
352
+
353
+ get debug(): CoreTextNodeProps['debug'] {
354
+ return this.trState.props.debug;
355
+ }
356
+
357
+ set debug(value: CoreTextNodeProps['debug']) {
358
+ this.textRenderer.set.debug(this.trState, value);
359
+ }
360
+
361
+ override update(delta: number, parentClippingRect: RectWithValid) {
362
+ super.update(delta, parentClippingRect);
363
+
364
+ assertTruthy(this.globalTransform);
365
+
366
+ // globalTransform is updated in super.update(delta)
367
+ this.textRenderer.set.x(this.trState, this.globalTransform.tx);
368
+ this.textRenderer.set.y(this.trState, this.globalTransform.ty);
369
+ }
370
+
371
+ override hasRenderableProperties(): boolean {
372
+ if (this.trState && this.trState.props.text !== '') {
373
+ return true;
374
+ }
375
+ return super.hasRenderableProperties();
376
+ }
377
+
378
+ override onChangeIsRenderable(isRenderable: boolean) {
379
+ super.onChangeIsRenderable(isRenderable);
380
+ this.textRenderer.setIsRenderable(this.trState, isRenderable);
381
+ }
382
+
383
+ override renderQuads(renderer: CoreRenderer) {
384
+ assertTruthy(this.globalTransform);
385
+
386
+ // If the text renderer does not support rendering quads, fallback to the
387
+ // default renderQuads method
388
+ if (!this.textRenderer.renderQuads) {
389
+ super.renderQuads(renderer);
390
+ return;
391
+ }
392
+
393
+ // If the text renderer does support rendering quads, use it...
394
+
395
+ // Prevent quad rendering if parent has a render texture
396
+ // and this node is not the render texture
397
+ if (this.parentHasRenderTexture) {
398
+ if (!renderer.renderToTextureActive) {
399
+ return;
400
+ }
401
+ // Prevent quad rendering if parent render texture is not the active render texture
402
+ if (this.parentRenderTexture !== renderer.activeRttNode) {
403
+ return;
404
+ }
405
+ }
406
+
407
+ if (this.parentHasRenderTexture && this.props.parent?.rtt) {
408
+ this.globalTransform = Matrix3d.identity();
409
+ if (this.localTransform) {
410
+ this.globalTransform.multiply(this.localTransform);
411
+ }
412
+ }
413
+
414
+ assertTruthy(this.globalTransform);
415
+
416
+ this.textRenderer.renderQuads(
417
+ this.trState,
418
+ this.globalTransform,
419
+ this.clippingRect,
420
+ this.worldAlpha,
421
+ this.parentHasRenderTexture,
422
+ this.framebufferDimensions,
423
+ );
424
+ }
425
+
426
+ /**
427
+ * Destroy the node and cleanup all resources
428
+ */
429
+ override destroy(): void {
430
+ super.destroy();
431
+
432
+ this.textRenderer.destroyState(this.trState);
433
+ }
434
+
435
+ /**
436
+ * Resolve a text renderer and a new state based on the current text renderer props provided
437
+ * @param props
438
+ * @returns
439
+ */
440
+ private createState(props: TrProps) {
441
+ const textRendererState = this.textRenderer.createState(props, this);
442
+
443
+ textRendererState.emitter.on('loaded', this.onTextLoaded);
444
+ textRendererState.emitter.on('failed', this.onTextFailed);
445
+
446
+ this.textRenderer.scheduleUpdateState(textRendererState);
447
+
448
+ return textRendererState;
449
+ }
450
+ }