@lightningjs/renderer 0.7.5 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (252) hide show
  1. package/LICENSE +202 -202
  2. package/NOTICE +3 -3
  3. package/README.md +233 -221
  4. package/dist/src/common/CommonTypes.d.ts +12 -0
  5. package/dist/src/core/CoreNode.d.ts +83 -9
  6. package/dist/src/core/CoreNode.js +232 -44
  7. package/dist/src/core/CoreNode.js.map +1 -1
  8. package/dist/src/core/CoreTextNode.d.ts +6 -1
  9. package/dist/src/core/CoreTextNode.js +33 -20
  10. package/dist/src/core/CoreTextNode.js.map +1 -1
  11. package/dist/src/core/CoreTextureManager.d.ts +3 -1
  12. package/dist/src/core/CoreTextureManager.js +11 -2
  13. package/dist/src/core/CoreTextureManager.js.map +1 -1
  14. package/dist/src/core/Stage.d.ts +6 -0
  15. package/dist/src/core/Stage.js +16 -1
  16. package/dist/src/core/Stage.js.map +1 -1
  17. package/dist/src/core/TextureMemoryManager.d.ts +12 -0
  18. package/dist/src/core/TextureMemoryManager.js +42 -0
  19. package/dist/src/core/TextureMemoryManager.js.map +1 -0
  20. package/dist/src/core/lib/ImageWorker.d.ts +0 -1
  21. package/dist/src/core/lib/ImageWorker.js +55 -40
  22. package/dist/src/core/lib/ImageWorker.js.map +1 -1
  23. package/dist/src/core/lib/RenderCoords.d.ts +13 -0
  24. package/dist/src/core/lib/RenderCoords.js +63 -0
  25. package/dist/src/core/lib/RenderCoords.js.map +1 -0
  26. package/dist/src/core/lib/WebGlContext.d.ts +414 -0
  27. package/dist/src/core/lib/WebGlContext.js +640 -0
  28. package/dist/src/core/lib/WebGlContext.js.map +1 -0
  29. package/dist/src/core/lib/utils.d.ts +1 -0
  30. package/dist/src/core/lib/utils.js +6 -0
  31. package/dist/src/core/lib/utils.js.map +1 -1
  32. package/dist/src/core/platform.js +8 -0
  33. package/dist/src/core/platform.js.map +1 -1
  34. package/dist/src/core/renderers/CoreContextTexture.d.ts +5 -1
  35. package/dist/src/core/renderers/CoreContextTexture.js +3 -1
  36. package/dist/src/core/renderers/CoreContextTexture.js.map +1 -1
  37. package/dist/src/core/renderers/webgl/WebGlCoreCtxSubTexture.d.ts +2 -1
  38. package/dist/src/core/renderers/webgl/WebGlCoreCtxSubTexture.js +2 -2
  39. package/dist/src/core/renderers/webgl/WebGlCoreCtxSubTexture.js.map +1 -1
  40. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.d.ts +3 -1
  41. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.js +26 -6
  42. package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.js.map +1 -1
  43. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.d.ts +3 -0
  44. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.js +4 -2
  45. package/dist/src/core/renderers/webgl/WebGlCoreRenderer.js.map +1 -1
  46. package/dist/src/core/renderers/webgl/internal/RendererUtils.d.ts +9 -0
  47. package/dist/src/core/renderers/webgl/internal/RendererUtils.js +14 -0
  48. package/dist/src/core/renderers/webgl/internal/RendererUtils.js.map +1 -1
  49. package/dist/src/core/renderers/webgl/shaders/DefaultShader.js +47 -47
  50. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +61 -61
  51. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +93 -93
  52. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +63 -63
  53. package/dist/src/core/renderers/webgl/shaders/SdfShader.js +49 -49
  54. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js +15 -15
  55. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js +5 -5
  56. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js +15 -15
  57. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js +15 -15
  58. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js +15 -15
  59. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js +42 -42
  60. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js +44 -44
  61. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.js +3 -3
  62. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js +44 -57
  63. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js.map +1 -1
  64. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.d.ts +1 -0
  65. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js +33 -39
  66. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js.map +1 -1
  67. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js +37 -37
  68. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js +19 -19
  69. package/dist/src/core/scene/Scene.d.ts +59 -0
  70. package/dist/src/core/scene/Scene.js +106 -0
  71. package/dist/src/core/scene/Scene.js.map +1 -0
  72. package/dist/src/core/text-rendering/TrFontManager.js +30 -25
  73. package/dist/src/core/text-rendering/TrFontManager.js.map +1 -1
  74. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.d.ts +2 -0
  75. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js +26 -2
  76. package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js.map +1 -1
  77. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.d.ts +8 -0
  78. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js +34 -6
  79. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js.map +1 -1
  80. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/findNearestMultiple.d.ts +8 -0
  81. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/findNearestMultiple.js +29 -0
  82. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/findNearestMultiple.js.map +1 -0
  83. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.js +1 -3
  84. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.js.map +1 -1
  85. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/SdfBufferHelper.d.ts +19 -0
  86. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/SdfBufferHelper.js +84 -0
  87. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/SdfBufferHelper.js.map +1 -0
  88. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutLine.d.ts +8 -0
  89. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutLine.js +40 -0
  90. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutLine.js.map +1 -0
  91. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutText2.d.ts +2 -0
  92. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutText2.js +41 -0
  93. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/layoutText2.js.map +1 -0
  94. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/utils.d.ts +1 -0
  95. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/utils.js +4 -0
  96. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2/utils.js.map +1 -0
  97. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2.d.ts +1 -0
  98. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2.js +2 -0
  99. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText2.js.map +1 -0
  100. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.d.ts +20 -0
  101. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.js +55 -0
  102. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.js.map +1 -0
  103. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/roundUpToMultiple.d.ts +9 -0
  104. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/roundUpToMultiple.js +32 -0
  105. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/roundUpToMultiple.js.map +1 -0
  106. package/dist/src/core/text-rendering/renderers/TextRenderer.d.ts +31 -0
  107. package/dist/src/core/text-rendering/renderers/TextRenderer.js +26 -0
  108. package/dist/src/core/text-rendering/renderers/TextRenderer.js.map +1 -1
  109. package/dist/src/core/textures/ImageTexture.js +16 -2
  110. package/dist/src/core/textures/ImageTexture.js.map +1 -1
  111. package/dist/src/core/textures/Texture.d.ts +27 -2
  112. package/dist/src/core/textures/Texture.js +30 -1
  113. package/dist/src/core/textures/Texture.js.map +1 -1
  114. package/dist/src/core/utils.d.ts +1 -1
  115. package/dist/src/main-api/ICoreDriver.d.ts +1 -0
  116. package/dist/src/main-api/Inspector.js +2 -1
  117. package/dist/src/main-api/Inspector.js.map +1 -1
  118. package/dist/src/main-api/RendererMain.d.ts +15 -0
  119. package/dist/src/main-api/RendererMain.js +7 -1
  120. package/dist/src/main-api/RendererMain.js.map +1 -1
  121. package/dist/src/render-drivers/main/MainCoreDriver.d.ts +1 -0
  122. package/dist/src/render-drivers/main/MainCoreDriver.js +8 -0
  123. package/dist/src/render-drivers/main/MainCoreDriver.js.map +1 -1
  124. package/dist/src/render-drivers/main/MainOnlyNode.d.ts +5 -0
  125. package/dist/src/render-drivers/main/MainOnlyNode.js +26 -0
  126. package/dist/src/render-drivers/main/MainOnlyNode.js.map +1 -1
  127. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js +2 -0
  128. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js.map +1 -1
  129. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.d.ts +2 -0
  130. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js.map +1 -1
  131. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js +3 -0
  132. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js.map +1 -1
  133. package/dist/src/render-drivers/threadx/worker/renderer.js +2 -0
  134. package/dist/src/render-drivers/threadx/worker/renderer.js.map +1 -1
  135. package/dist/src/utils.d.ts +6 -0
  136. package/dist/src/utils.js +9 -1
  137. package/dist/src/utils.js.map +1 -1
  138. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  139. package/exports/core-api.ts +102 -102
  140. package/exports/main-api.ts +60 -60
  141. package/exports/utils.ts +41 -41
  142. package/package.json +1 -1
  143. package/scripts/please-use-pnpm.js +13 -13
  144. package/src/common/CommonTypes.ts +132 -113
  145. package/src/common/EventEmitter.ts +77 -77
  146. package/src/common/IAnimationController.ts +29 -29
  147. package/src/core/CoreExtension.ts +32 -32
  148. package/src/core/CoreNode.ts +1199 -955
  149. package/src/core/CoreShaderManager.ts +243 -243
  150. package/src/core/CoreTextNode.ts +400 -391
  151. package/src/core/CoreTextureManager.ts +339 -326
  152. package/src/core/Stage.ts +375 -354
  153. package/src/core/TextureMemoryManager.ts +66 -0
  154. package/src/core/animations/AnimationManager.ts +38 -38
  155. package/src/core/animations/CoreAnimation.ts +181 -181
  156. package/src/core/animations/CoreAnimationController.ts +148 -148
  157. package/src/core/lib/ContextSpy.ts +41 -41
  158. package/src/core/lib/ImageWorker.ts +149 -135
  159. package/src/core/lib/Matrix3d.ts +290 -290
  160. package/src/core/lib/RenderCoords.ts +86 -0
  161. package/src/core/lib/WebGlContextWrapper.ts +992 -992
  162. package/src/core/lib/textureCompression.ts +152 -152
  163. package/src/core/lib/utils.ts +250 -241
  164. package/src/core/platform.ts +54 -46
  165. package/src/core/renderers/CoreContextTexture.ts +35 -30
  166. package/src/core/renderers/CoreRenderOp.ts +22 -22
  167. package/src/core/renderers/CoreRenderer.ts +63 -63
  168. package/src/core/renderers/CoreShader.ts +41 -41
  169. package/src/core/renderers/webgl/WebGlCoreCtxSubTexture.ts +42 -37
  170. package/src/core/renderers/webgl/WebGlCoreCtxTexture.ts +261 -230
  171. package/src/core/renderers/webgl/WebGlCoreRenderOp.ts +107 -107
  172. package/src/core/renderers/webgl/WebGlCoreRenderer.ts +528 -520
  173. package/src/core/renderers/webgl/WebGlCoreShader.ts +337 -337
  174. package/src/core/renderers/webgl/internal/BufferCollection.ts +54 -54
  175. package/src/core/renderers/webgl/internal/RendererUtils.ts +148 -131
  176. package/src/core/renderers/webgl/internal/ShaderUtils.ts +136 -136
  177. package/src/core/renderers/webgl/internal/WebGlUtils.ts +35 -35
  178. package/src/core/renderers/webgl/shaders/DefaultShader.ts +95 -95
  179. package/src/core/renderers/webgl/shaders/DefaultShaderBatched.ts +132 -132
  180. package/src/core/renderers/webgl/shaders/DynamicShader.ts +474 -474
  181. package/src/core/renderers/webgl/shaders/RoundedRectangle.ts +161 -161
  182. package/src/core/renderers/webgl/shaders/SdfShader.ts +174 -174
  183. package/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.ts +101 -101
  184. package/src/core/renderers/webgl/shaders/effects/BorderEffect.ts +86 -86
  185. package/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.ts +101 -101
  186. package/src/core/renderers/webgl/shaders/effects/BorderRightEffect.ts +101 -101
  187. package/src/core/renderers/webgl/shaders/effects/BorderTopEffect.ts +101 -101
  188. package/src/core/renderers/webgl/shaders/effects/EffectUtils.ts +33 -33
  189. package/src/core/renderers/webgl/shaders/effects/FadeOutEffect.ts +135 -135
  190. package/src/core/renderers/webgl/shaders/effects/GlitchEffect.ts +145 -145
  191. package/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.ts +67 -67
  192. package/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.ts +160 -176
  193. package/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.ts +153 -159
  194. package/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.ts +186 -186
  195. package/src/core/renderers/webgl/shaders/effects/RadiusEffect.ts +121 -121
  196. package/src/core/renderers/webgl/shaders/effects/ShaderEffect.ts +114 -114
  197. package/src/core/text-rendering/TextTextureRendererUtils.ts +189 -189
  198. package/src/core/text-rendering/TrFontManager.ts +170 -166
  199. package/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts +141 -141
  200. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/FontShaper.ts +139 -139
  201. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.test.ts +173 -173
  202. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.ts +169 -169
  203. package/src/core/text-rendering/font-face-types/TrFontFace.ts +105 -105
  204. package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +77 -77
  205. package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +780 -751
  206. package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts +741 -741
  207. package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +812 -778
  208. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.test.ts +48 -48
  209. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.ts +66 -66
  210. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/SpecialCodepoints.ts +52 -52
  211. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/constants.ts +32 -32
  212. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getStartConditions.ts +84 -84
  213. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.test.ts +133 -133
  214. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.ts +38 -38
  215. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.ts +391 -393
  216. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.test.ts +49 -49
  217. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.ts +51 -51
  218. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.test.ts +205 -205
  219. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.ts +93 -93
  220. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/util.ts +40 -40
  221. package/src/core/text-rendering/renderers/TextRenderer.ts +548 -504
  222. package/src/core/textures/ColorTexture.ts +86 -86
  223. package/src/core/textures/ImageTexture.ts +154 -140
  224. package/src/core/textures/NoiseTexture.ts +96 -96
  225. package/src/core/textures/SubTexture.ts +143 -143
  226. package/src/core/textures/Texture.ts +261 -218
  227. package/src/core/utils.ts +224 -224
  228. package/src/env.d.ts +7 -7
  229. package/src/main-api/ICoreDriver.ts +68 -66
  230. package/src/main-api/INode.ts +499 -499
  231. package/src/main-api/Inspector.ts +440 -439
  232. package/src/main-api/RendererMain.ts +676 -652
  233. package/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.ts +45 -45
  234. package/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.ts +154 -154
  235. package/src/main-api/texture-usage-trackers/TextureUsageTracker.ts +54 -54
  236. package/src/render-drivers/main/MainCoreDriver.ts +158 -148
  237. package/src/render-drivers/main/MainOnlyNode.ts +500 -466
  238. package/src/render-drivers/main/MainOnlyTextNode.ts +261 -261
  239. package/src/render-drivers/threadx/NodeStruct.ts +300 -300
  240. package/src/render-drivers/threadx/SharedNode.ts +97 -97
  241. package/src/render-drivers/threadx/TextNodeStruct.ts +211 -211
  242. package/src/render-drivers/threadx/ThreadXCoreDriver.ts +287 -285
  243. package/src/render-drivers/threadx/ThreadXMainAnimationController.ts +99 -99
  244. package/src/render-drivers/threadx/ThreadXMainNode.ts +192 -192
  245. package/src/render-drivers/threadx/ThreadXMainTextNode.ts +85 -85
  246. package/src/render-drivers/threadx/ThreadXRendererMessage.ts +112 -110
  247. package/src/render-drivers/threadx/worker/ThreadXRendererNode.ts +245 -238
  248. package/src/render-drivers/threadx/worker/ThreadXRendererTextNode.ts +149 -149
  249. package/src/render-drivers/threadx/worker/renderer.ts +153 -151
  250. package/src/render-drivers/utils.ts +97 -97
  251. package/src/utils.ts +216 -207
  252. package/COPYING +0 -1
@@ -1,955 +1,1199 @@
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 { assertTruthy, mergeColorAlphaPremultiplied } from '../utils.js';
21
- import type { ShaderMap } from './CoreShaderManager.js';
22
- import type {
23
- ExtractProps,
24
- TextureMap,
25
- TextureOptions,
26
- } from './CoreTextureManager.js';
27
- import type { CoreRenderer } from './renderers/CoreRenderer.js';
28
- import type { CoreShader } from './renderers/CoreShader.js';
29
- import type { Stage } from './Stage.js';
30
- import type {
31
- Texture,
32
- TextureFailedEventHandler,
33
- TextureLoadedEventHandler,
34
- } from './textures/Texture.js';
35
- import type {
36
- NodeTextureFailedPayload,
37
- NodeTextureLoadedPayload,
38
- } from '../common/CommonTypes.js';
39
- import { EventEmitter } from '../common/EventEmitter.js';
40
- import { copyRect, intersectRect, type RectWithValid } from './lib/utils.js';
41
- import { Matrix3d } from './lib/Matrix3d.js';
42
-
43
- export interface CoreNodeProps {
44
- id: number;
45
- // External facing properties whose defaults are determined by
46
- // RendererMain's resolveNodeDefaults() method
47
- x: number;
48
- y: number;
49
- width: number;
50
- height: number;
51
- alpha: number;
52
- clipping: boolean;
53
- color: number;
54
- colorTop: number;
55
- colorBottom: number;
56
- colorLeft: number;
57
- colorRight: number;
58
- colorTl: number;
59
- colorTr: number;
60
- colorBl: number;
61
- colorBr: number;
62
- parent: CoreNode | null;
63
- zIndex: number;
64
- texture: Texture | null;
65
- textureOptions: TextureOptions | null;
66
- shader: CoreShader | null;
67
- shaderProps: Record<string, unknown> | null;
68
- zIndexLocked: number;
69
- scaleX: number;
70
- scaleY: number;
71
- mount: number;
72
- mountX: number;
73
- mountY: number;
74
- pivot: number;
75
- pivotX: number;
76
- pivotY: number;
77
- rotation: number;
78
- }
79
-
80
- type ICoreNode = Omit<
81
- CoreNodeProps,
82
- 'texture' | 'textureOptions' | 'shader' | 'shaderProps'
83
- >;
84
-
85
- enum UpdateType {
86
- /**
87
- * Child updates
88
- */
89
- Children = 1,
90
-
91
- /**
92
- * Scale/Rotate transform update
93
- */
94
- ScaleRotate = 2,
95
-
96
- /**
97
- * Translate transform update (x/y/width/height/pivot/mount)
98
- */
99
- Local = 4,
100
-
101
- /**
102
- * Global transform update
103
- */
104
- Global = 8,
105
-
106
- /**
107
- * Clipping rect update
108
- */
109
- Clipping = 16,
110
-
111
- /**
112
- * Calculated ZIndex update
113
- */
114
- CalculatedZIndex = 32,
115
-
116
- /**
117
- * Z-Index Sorted Children update
118
- */
119
- ZIndexSortedChildren = 64,
120
-
121
- /**
122
- * Premultiplied Colors
123
- */
124
- PremultipliedColors = 128,
125
-
126
- /**
127
- * World Alpha
128
- *
129
- * @remarks
130
- * World Alpha = Parent World Alpha * Alpha
131
- */
132
- WorldAlpha = 256,
133
-
134
- /**
135
- * None
136
- */
137
- None = 0,
138
-
139
- /**
140
- * All
141
- */
142
- All = 511,
143
- }
144
-
145
- export class CoreNode extends EventEmitter implements ICoreNode {
146
- readonly children: CoreNode[] = [];
147
- protected props: Required<CoreNodeProps>;
148
-
149
- public updateType = UpdateType.All;
150
- public globalTransform?: Matrix3d;
151
- public scaleRotateTransform?: Matrix3d;
152
- public localTransform?: Matrix3d;
153
- public clippingRect: RectWithValid = {
154
- x: 0,
155
- y: 0,
156
- width: 0,
157
- height: 0,
158
- valid: false,
159
- };
160
- public isRenderable = false;
161
- public worldAlpha = 1;
162
- public premultipliedColorTl = 0;
163
- public premultipliedColorTr = 0;
164
- public premultipliedColorBl = 0;
165
- public premultipliedColorBr = 0;
166
- public calcZIndex = 0;
167
-
168
- private isComplex = false;
169
-
170
- constructor(protected stage: Stage, props: CoreNodeProps) {
171
- super();
172
- this.props = {
173
- ...props,
174
- parent: null,
175
- };
176
- // Allow for parent to be processed appropriately
177
- this.parent = props.parent;
178
- this.updateScaleRotateTransform();
179
- }
180
-
181
- //#region Textures
182
- loadTexture<Type extends keyof TextureMap>(
183
- textureType: Type,
184
- props: ExtractProps<TextureMap[Type]>,
185
- options: TextureOptions | null = null,
186
- ): void {
187
- // First unload any existing texture
188
- if (this.props.texture) {
189
- this.unloadTexture();
190
- }
191
- const { txManager } = this.stage;
192
- const texture = txManager.loadTexture(textureType, props, options);
193
-
194
- this.props.texture = texture;
195
- this.props.textureOptions = options;
196
- this.checkIsRenderable();
197
-
198
- // If texture is already loaded / failed, trigger loaded event manually
199
- // so that users get a consistent event experience.
200
- // We do this in a microtask to allow listeners to be attached in the same
201
- // synchronous task after calling loadTexture()
202
- queueMicrotask(() => {
203
- if (texture.state === 'loaded') {
204
- this.onTextureLoaded(texture, texture.dimensions!);
205
- } else if (texture.state === 'failed') {
206
- this.onTextureFailed(texture, texture.error!);
207
- }
208
- texture.on('loaded', this.onTextureLoaded);
209
- texture.on('failed', this.onTextureFailed);
210
- });
211
- }
212
-
213
- unloadTexture(): void {
214
- if (this.props.texture) {
215
- this.props.texture.off('loaded', this.onTextureLoaded);
216
- this.props.texture.off('failed', this.onTextureFailed);
217
- }
218
- this.props.texture = null;
219
- this.props.textureOptions = null;
220
- this.checkIsRenderable();
221
- }
222
-
223
- private onTextureLoaded: TextureLoadedEventHandler = (target, dimensions) => {
224
- // Texture was loaded. In case the RAF loop has already stopped, we request
225
- // a render to ensure the texture is rendered.
226
- this.stage.requestRender();
227
- this.emit('loaded', {
228
- type: 'texture',
229
- dimensions,
230
- } satisfies NodeTextureLoadedPayload);
231
- };
232
-
233
- private onTextureFailed: TextureFailedEventHandler = (target, error) => {
234
- this.emit('failed', {
235
- type: 'texture',
236
- error,
237
- } satisfies NodeTextureFailedPayload);
238
- };
239
- //#endregion Textures
240
-
241
- loadShader<Type extends keyof ShaderMap>(
242
- shaderType: Type,
243
- props: ExtractProps<ShaderMap[Type]>,
244
- ): void {
245
- const shManager = this.stage.renderer.getShaderManager();
246
- assertTruthy(shManager);
247
- const { shader, props: p } = shManager.loadShader(shaderType, props);
248
- this.props.shader = shader;
249
- this.props.shaderProps = p;
250
- this.checkIsRenderable();
251
- }
252
-
253
- /**
254
- * Change types types is used to determine the scope of the changes being applied
255
- *
256
- * @remarks
257
- * See {@link UpdateType} for more information on each type
258
- *
259
- * @param type
260
- */
261
- setUpdateType(type: UpdateType): void {
262
- this.updateType |= type;
263
-
264
- // If we're updating this node at all, we need to inform the parent
265
- // (and all ancestors) that their children need updating as well
266
- const parent = this.props.parent;
267
- if (parent && !(parent.updateType & UpdateType.Children)) {
268
- parent.setUpdateType(UpdateType.Children);
269
- }
270
- }
271
-
272
- sortChildren() {
273
- this.children.sort((a, b) => a.calcZIndex - b.calcZIndex);
274
- }
275
-
276
- updateScaleRotateTransform() {
277
- this.scaleRotateTransform = Matrix3d.rotate(
278
- this.props.rotation,
279
- this.scaleRotateTransform,
280
- ).scale(this.props.scaleX, this.props.scaleY);
281
- }
282
-
283
- updateLocalTransform() {
284
- assertTruthy(this.scaleRotateTransform);
285
- const pivotTranslateX = this.props.pivotX * this.props.width;
286
- const pivotTranslateY = this.props.pivotY * this.props.height;
287
- const mountTranslateX = this.props.mountX * this.props.width;
288
- const mountTranslateY = this.props.mountY * this.props.height;
289
-
290
- this.localTransform = Matrix3d.translate(
291
- pivotTranslateX - mountTranslateX + this.props.x,
292
- pivotTranslateY - mountTranslateY + this.props.y,
293
- this.localTransform,
294
- )
295
- .multiply(this.scaleRotateTransform)
296
- .translate(-pivotTranslateX, -pivotTranslateY);
297
- this.setUpdateType(UpdateType.Global);
298
- }
299
-
300
- /**
301
- * @todo: test for correct calculation flag
302
- * @param delta
303
- */
304
- update(delta: number, parentClippingRect: RectWithValid): void {
305
- if (this.updateType & UpdateType.ScaleRotate) {
306
- this.updateScaleRotateTransform();
307
- this.setUpdateType(UpdateType.Local);
308
- }
309
-
310
- if (this.updateType & UpdateType.Local) {
311
- this.updateLocalTransform();
312
- this.setUpdateType(UpdateType.Global);
313
- }
314
-
315
- const parent = this.props.parent;
316
- let childUpdateType = UpdateType.None;
317
- if (this.updateType & UpdateType.Global) {
318
- assertTruthy(this.localTransform);
319
- this.globalTransform = Matrix3d.copy(
320
- parent?.globalTransform || this.localTransform,
321
- this.globalTransform,
322
- );
323
-
324
- if (parent) {
325
- this.globalTransform.multiply(this.localTransform);
326
- }
327
-
328
- this.setUpdateType(UpdateType.Clipping | UpdateType.Children);
329
- childUpdateType |= UpdateType.Global;
330
- }
331
-
332
- if (this.updateType & UpdateType.Clipping) {
333
- this.calculateClippingRect(parentClippingRect);
334
- this.checkIsRenderable();
335
- this.setUpdateType(UpdateType.Children);
336
- childUpdateType |= UpdateType.Clipping;
337
- }
338
-
339
- if (this.updateType & UpdateType.WorldAlpha) {
340
- if (parent) {
341
- this.worldAlpha = parent.worldAlpha * this.props.alpha;
342
- } else {
343
- this.worldAlpha = this.props.alpha;
344
- }
345
- this.setUpdateType(UpdateType.Children | UpdateType.PremultipliedColors);
346
- childUpdateType |= UpdateType.WorldAlpha;
347
- }
348
-
349
- if (this.updateType & UpdateType.PremultipliedColors) {
350
- this.premultipliedColorTl = mergeColorAlphaPremultiplied(
351
- this.props.colorTl,
352
- this.worldAlpha,
353
- true,
354
- );
355
-
356
- // If all the colors are the same just sent them all to the same value
357
- if (
358
- this.props.colorTl === this.props.colorTr &&
359
- this.props.colorBl === this.props.colorBr &&
360
- this.props.colorTl === this.props.colorBl
361
- ) {
362
- this.premultipliedColorTr =
363
- this.premultipliedColorBl =
364
- this.premultipliedColorBr =
365
- this.premultipliedColorTl;
366
- } else {
367
- this.premultipliedColorTr = mergeColorAlphaPremultiplied(
368
- this.props.colorTr,
369
- this.worldAlpha,
370
- true,
371
- );
372
- this.premultipliedColorBl = mergeColorAlphaPremultiplied(
373
- this.props.colorBl,
374
- this.worldAlpha,
375
- true,
376
- );
377
- this.premultipliedColorBr = mergeColorAlphaPremultiplied(
378
- this.props.colorBr,
379
- this.worldAlpha,
380
- true,
381
- );
382
- }
383
- this.checkIsRenderable();
384
- this.setUpdateType(UpdateType.Children);
385
- childUpdateType |= UpdateType.PremultipliedColors;
386
- }
387
-
388
- // No need to update zIndex if there is no parent
389
- if (parent && this.updateType & UpdateType.CalculatedZIndex) {
390
- this.calculateZIndex();
391
- // Tell parent to re-sort children
392
- parent.setUpdateType(UpdateType.ZIndexSortedChildren);
393
- }
394
-
395
- if (this.updateType & UpdateType.Children && this.children.length) {
396
- this.children.forEach((child) => {
397
- // Trigger the depenedent update types on the child
398
- child.setUpdateType(childUpdateType);
399
- // If child has no updates, skip
400
- if (child.updateType === 0) {
401
- return;
402
- }
403
- child.update(delta, this.clippingRect);
404
- });
405
- }
406
-
407
- // Sorting children MUST happen after children have been updated so
408
- // that they have the oppotunity to update their calculated zIndex.
409
- if (this.updateType & UpdateType.ZIndexSortedChildren) {
410
- // reorder z-index
411
- this.sortChildren();
412
- }
413
-
414
- // reset update type
415
- this.updateType = 0;
416
- }
417
-
418
- // This function checks if the current node is renderable based on certain properties.
419
- // It returns true if any of the specified properties are truthy or if any color property is not 0, otherwise it returns false.
420
- checkIsRenderable(): boolean {
421
- if (this.props.texture) {
422
- return (this.isRenderable = true);
423
- }
424
-
425
- if (!this.props.width || !this.props.height) {
426
- return (this.isRenderable = false);
427
- }
428
-
429
- if (this.props.shader) {
430
- return (this.isRenderable = true);
431
- }
432
-
433
- if (this.props.clipping) {
434
- return (this.isRenderable = true);
435
- }
436
-
437
- if (this.props.color !== 0) {
438
- return (this.isRenderable = true);
439
- }
440
-
441
- // Consider removing these checks and just using the color property check above.
442
- // Maybe add a forceRender prop for nodes that should always render.
443
- if (this.props.colorTop !== 0) {
444
- return (this.isRenderable = true);
445
- }
446
-
447
- if (this.props.colorBottom !== 0) {
448
- return (this.isRenderable = true);
449
- }
450
-
451
- if (this.props.colorLeft !== 0) {
452
- return (this.isRenderable = true);
453
- }
454
-
455
- if (this.props.colorRight !== 0) {
456
- return (this.isRenderable = true);
457
- }
458
-
459
- if (this.props.colorTl !== 0) {
460
- return (this.isRenderable = true);
461
- }
462
-
463
- if (this.props.colorTr !== 0) {
464
- return (this.isRenderable = true);
465
- }
466
-
467
- if (this.props.colorBl !== 0) {
468
- return (this.isRenderable = true);
469
- }
470
-
471
- if (this.props.colorBr !== 0) {
472
- return (this.isRenderable = true);
473
- }
474
-
475
- return (this.isRenderable = false);
476
- }
477
-
478
- /**
479
- * This function calculates the clipping rectangle for a node.
480
- *
481
- * The function then checks if the node is rotated. If the node requires clipping and is not rotated, a new clipping rectangle is created based on the node's global transform and dimensions.
482
- * If a parent clipping rectangle exists, it is intersected with the node's clipping rectangle (if it exists), or replaces the node's clipping rectangle.
483
- *
484
- * Finally, the node's parentClippingRect and clippingRect properties are updated.
485
- */
486
- calculateClippingRect(parentClippingRect: RectWithValid) {
487
- assertTruthy(this.globalTransform);
488
- const { clippingRect, props, globalTransform: gt } = this;
489
- const { clipping } = props;
490
-
491
- const isRotated = gt.tb !== 0 || gt.tc !== 0;
492
-
493
- if (clipping && !isRotated) {
494
- clippingRect.x = gt.tx;
495
- clippingRect.y = gt.ty;
496
- clippingRect.width = this.width * gt.ta;
497
- clippingRect.height = this.height * gt.td;
498
- clippingRect.valid = true;
499
- } else {
500
- clippingRect.valid = false;
501
- }
502
-
503
- if (parentClippingRect.valid && clippingRect.valid) {
504
- // Intersect parent clipping rect with node clipping rect
505
- intersectRect(parentClippingRect, clippingRect, clippingRect);
506
- } else if (parentClippingRect.valid) {
507
- // Copy parent clipping rect
508
- copyRect(parentClippingRect, clippingRect);
509
- clippingRect.valid = true;
510
- }
511
- }
512
-
513
- calculateZIndex(): void {
514
- const props = this.props;
515
- const z = props.zIndex || 0;
516
- const p = props.parent?.zIndex || 0;
517
-
518
- let zIndex = z;
519
- if (props.parent?.zIndexLocked) {
520
- zIndex = z < p ? z : p;
521
- }
522
- this.calcZIndex = zIndex;
523
- }
524
-
525
- /**
526
- * Destroy the node and cleanup all resources
527
- */
528
- destroy(): void {
529
- // destroy children
530
- for (let i = 0; i < this.children.length; i++) {
531
- this.children[i]?.destroy();
532
- }
533
-
534
- this.children.length = 0;
535
- this.unloadTexture();
536
-
537
- this.isRenderable = false;
538
- this.clippingRect.valid = false;
539
-
540
- delete this.globalTransform;
541
- delete this.scaleRotateTransform;
542
- delete this.localTransform;
543
-
544
- this.props.texture = null;
545
- this.props.shader = null;
546
-
547
- if (this.parent && !(this.parent.updateType & UpdateType.Children)) {
548
- this.parent.setUpdateType(UpdateType.Children);
549
- }
550
-
551
- this.parent = null;
552
- }
553
-
554
- renderQuads(renderer: CoreRenderer): void {
555
- const { width, height, texture, textureOptions, shader, shaderProps } =
556
- this.props;
557
- const {
558
- premultipliedColorTl,
559
- premultipliedColorTr,
560
- premultipliedColorBl,
561
- premultipliedColorBr,
562
- } = this;
563
-
564
- const { zIndex, worldAlpha, globalTransform: gt, clippingRect } = this;
565
-
566
- assertTruthy(gt);
567
-
568
- // add to list of renderables to be sorted before rendering
569
- renderer.addQuad({
570
- width,
571
- height,
572
- colorTl: premultipliedColorTl,
573
- colorTr: premultipliedColorTr,
574
- colorBl: premultipliedColorBl,
575
- colorBr: premultipliedColorBr,
576
- texture,
577
- textureOptions,
578
- zIndex,
579
- shader,
580
- shaderProps,
581
- alpha: worldAlpha,
582
- clippingRect,
583
- tx: gt.tx,
584
- ty: gt.ty,
585
- ta: gt.ta,
586
- tb: gt.tb,
587
- tc: gt.tc,
588
- td: gt.td,
589
- });
590
-
591
- // Calculate absolute X and Y based on all ancestors
592
- // renderer.addQuad(absX, absY, w, h, color, texture, textureOptions, zIndex);
593
- }
594
-
595
- //#region Properties
596
- get id(): number {
597
- return this.props.id;
598
- }
599
-
600
- get x(): number {
601
- return this.props.x;
602
- }
603
-
604
- set x(value: number) {
605
- if (this.props.x !== value) {
606
- this.props.x = value;
607
- this.setUpdateType(UpdateType.Local);
608
- }
609
- }
610
-
611
- get absX(): number {
612
- return (
613
- this.props.x +
614
- (this.props.parent?.absX || this.props.parent?.globalTransform?.tx || 0)
615
- );
616
- }
617
-
618
- get absY(): number {
619
- return this.props.y + (this.props.parent?.absY ?? 0);
620
- }
621
-
622
- get y(): number {
623
- return this.props.y;
624
- }
625
-
626
- set y(value: number) {
627
- if (this.props.y !== value) {
628
- this.props.y = value;
629
- this.setUpdateType(UpdateType.Local);
630
- }
631
- }
632
-
633
- get width(): number {
634
- return this.props.width;
635
- }
636
-
637
- set width(value: number) {
638
- if (this.props.width !== value) {
639
- this.props.width = value;
640
- this.setUpdateType(UpdateType.Local);
641
- }
642
- }
643
-
644
- get height(): number {
645
- return this.props.height;
646
- }
647
-
648
- set height(value: number) {
649
- if (this.props.height !== value) {
650
- this.props.height = value;
651
- this.setUpdateType(UpdateType.Local);
652
- }
653
- }
654
-
655
- get scale(): number {
656
- // The CoreNode `scale` property is only used by Animations.
657
- // Unlike INode, `null` should never be possibility for Animations.
658
- return this.scaleX;
659
- }
660
-
661
- set scale(value: number) {
662
- // The CoreNode `scale` property is only used by Animations.
663
- // Unlike INode, `null` should never be possibility for Animations.
664
- this.scaleX = value;
665
- this.scaleY = value;
666
- }
667
-
668
- get scaleX(): number {
669
- return this.props.scaleX;
670
- }
671
-
672
- set scaleX(value: number) {
673
- if (this.props.scaleX !== value) {
674
- this.props.scaleX = value;
675
- this.setUpdateType(UpdateType.ScaleRotate);
676
- }
677
- }
678
-
679
- get scaleY(): number {
680
- return this.props.scaleY;
681
- }
682
-
683
- set scaleY(value: number) {
684
- if (this.props.scaleY !== value) {
685
- this.props.scaleY = value;
686
- this.setUpdateType(UpdateType.ScaleRotate);
687
- }
688
- }
689
-
690
- get mount(): number {
691
- return this.props.mount;
692
- }
693
-
694
- set mount(value: number) {
695
- if (this.props.mountX !== value || this.props.mountY !== value) {
696
- this.props.mountX = value;
697
- this.props.mountY = value;
698
- this.props.mount = value;
699
- this.setUpdateType(UpdateType.Local);
700
- }
701
- }
702
-
703
- get mountX(): number {
704
- return this.props.mountX;
705
- }
706
-
707
- set mountX(value: number) {
708
- if (this.props.mountX !== value) {
709
- this.props.mountX = value;
710
- this.setUpdateType(UpdateType.Local);
711
- }
712
- }
713
-
714
- get mountY(): number {
715
- return this.props.mountY;
716
- }
717
-
718
- set mountY(value: number) {
719
- if (this.props.mountY !== value) {
720
- this.props.mountY = value;
721
- this.setUpdateType(UpdateType.Local);
722
- }
723
- }
724
-
725
- get pivot(): number {
726
- return this.props.pivot;
727
- }
728
-
729
- set pivot(value: number) {
730
- if (this.props.pivotX !== value || this.props.pivotY !== value) {
731
- this.props.pivotX = value;
732
- this.props.pivotY = value;
733
- this.props.pivot = value;
734
- this.setUpdateType(UpdateType.Local);
735
- }
736
- }
737
-
738
- get pivotX(): number {
739
- return this.props.pivotX;
740
- }
741
-
742
- set pivotX(value: number) {
743
- if (this.props.pivotX !== value) {
744
- this.props.pivotX = value;
745
- this.setUpdateType(UpdateType.Local);
746
- }
747
- }
748
-
749
- get pivotY(): number {
750
- return this.props.pivotY;
751
- }
752
-
753
- set pivotY(value: number) {
754
- if (this.props.pivotY !== value) {
755
- this.props.pivotY = value;
756
- this.setUpdateType(UpdateType.Local);
757
- }
758
- }
759
-
760
- get rotation(): number {
761
- return this.props.rotation;
762
- }
763
-
764
- set rotation(value: number) {
765
- if (this.props.rotation !== value) {
766
- this.props.rotation = value;
767
- this.setUpdateType(UpdateType.ScaleRotate);
768
- }
769
- }
770
-
771
- get alpha(): number {
772
- return this.props.alpha;
773
- }
774
-
775
- set alpha(value: number) {
776
- this.props.alpha = value;
777
- this.setUpdateType(UpdateType.PremultipliedColors | UpdateType.WorldAlpha);
778
- }
779
-
780
- get clipping(): boolean {
781
- return this.props.clipping;
782
- }
783
-
784
- set clipping(value: boolean) {
785
- this.props.clipping = value;
786
- this.setUpdateType(UpdateType.Clipping);
787
- }
788
-
789
- get color(): number {
790
- return this.props.color;
791
- }
792
-
793
- set color(value: number) {
794
- if (
795
- this.props.colorTl !== value ||
796
- this.props.colorTr !== value ||
797
- this.props.colorBl !== value ||
798
- this.props.colorBr !== value
799
- ) {
800
- this.colorTl = value;
801
- this.colorTr = value;
802
- this.colorBl = value;
803
- this.colorBr = value;
804
- }
805
- this.props.color = value;
806
-
807
- this.setUpdateType(UpdateType.PremultipliedColors);
808
- }
809
-
810
- get colorTop(): number {
811
- return this.props.colorTop;
812
- }
813
-
814
- set colorTop(value: number) {
815
- if (this.props.colorTl !== value || this.props.colorTr !== value) {
816
- this.colorTl = value;
817
- this.colorTr = value;
818
- }
819
- this.props.colorTop = value;
820
- this.setUpdateType(UpdateType.PremultipliedColors);
821
- }
822
-
823
- get colorBottom(): number {
824
- return this.props.colorBottom;
825
- }
826
-
827
- set colorBottom(value: number) {
828
- if (this.props.colorBl !== value || this.props.colorBr !== value) {
829
- this.colorBl = value;
830
- this.colorBr = value;
831
- }
832
- this.props.colorBottom = value;
833
- this.setUpdateType(UpdateType.PremultipliedColors);
834
- }
835
-
836
- get colorLeft(): number {
837
- return this.props.colorLeft;
838
- }
839
-
840
- set colorLeft(value: number) {
841
- if (this.props.colorTl !== value || this.props.colorBl !== value) {
842
- this.colorTl = value;
843
- this.colorBl = value;
844
- }
845
- this.props.colorLeft = value;
846
- this.setUpdateType(UpdateType.PremultipliedColors);
847
- }
848
-
849
- get colorRight(): number {
850
- return this.props.colorRight;
851
- }
852
-
853
- set colorRight(value: number) {
854
- if (this.props.colorTr !== value || this.props.colorBr !== value) {
855
- this.colorTr = value;
856
- this.colorBr = value;
857
- }
858
- this.props.colorRight = value;
859
- this.setUpdateType(UpdateType.PremultipliedColors);
860
- }
861
-
862
- get colorTl(): number {
863
- return this.props.colorTl;
864
- }
865
-
866
- set colorTl(value: number) {
867
- this.props.colorTl = value;
868
- this.setUpdateType(UpdateType.PremultipliedColors);
869
- }
870
-
871
- get colorTr(): number {
872
- return this.props.colorTr;
873
- }
874
-
875
- set colorTr(value: number) {
876
- this.props.colorTr = value;
877
- this.setUpdateType(UpdateType.PremultipliedColors);
878
- }
879
-
880
- get colorBl(): number {
881
- return this.props.colorBl;
882
- }
883
-
884
- set colorBl(value: number) {
885
- this.props.colorBl = value;
886
- this.setUpdateType(UpdateType.PremultipliedColors);
887
- }
888
-
889
- get colorBr(): number {
890
- return this.props.colorBr;
891
- }
892
-
893
- set colorBr(value: number) {
894
- this.props.colorBr = value;
895
- this.setUpdateType(UpdateType.PremultipliedColors);
896
- }
897
-
898
- // we're only interested in parent zIndex to test
899
- // if we should use node zIndex is higher then parent zIndex
900
- get zIndexLocked(): number {
901
- return this.props.zIndexLocked || 0;
902
- }
903
-
904
- set zIndexLocked(value: number) {
905
- this.props.zIndexLocked = value;
906
- this.setUpdateType(UpdateType.CalculatedZIndex | UpdateType.Children);
907
- this.children.forEach((child) => {
908
- child.setUpdateType(UpdateType.CalculatedZIndex);
909
- });
910
- }
911
-
912
- get zIndex(): number {
913
- return this.props.zIndex;
914
- }
915
-
916
- set zIndex(value: number) {
917
- this.props.zIndex = value;
918
- this.setUpdateType(UpdateType.CalculatedZIndex | UpdateType.Children);
919
- this.children.forEach((child) => {
920
- child.setUpdateType(UpdateType.CalculatedZIndex);
921
- });
922
- }
923
-
924
- get parent(): CoreNode | null {
925
- return this.props.parent;
926
- }
927
-
928
- set parent(newParent: CoreNode | null) {
929
- const oldParent = this.props.parent;
930
- if (oldParent === newParent) {
931
- return;
932
- }
933
- this.props.parent = newParent;
934
- if (oldParent) {
935
- const index = oldParent.children.indexOf(this);
936
- assertTruthy(
937
- index !== -1,
938
- "CoreNode.parent: Node not found in old parent's children!",
939
- );
940
- oldParent.children.splice(index, 1);
941
- }
942
- if (newParent) {
943
- newParent.children.push(this);
944
- // Since this node has a new parent, to be safe, have it do a full update.
945
- this.setUpdateType(UpdateType.All);
946
- // Tell parent that it's children need to be updated and sorted.
947
- newParent.setUpdateType(
948
- UpdateType.Children | UpdateType.ZIndexSortedChildren,
949
- );
950
- }
951
-
952
- this.updateScaleRotateTransform();
953
- }
954
- //#endregion Properties
955
- }
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 { assertTruthy, mergeColorAlphaPremultiplied } from '../utils.js';
21
+ import type { ShaderMap } from './CoreShaderManager.js';
22
+ import type {
23
+ ExtractProps,
24
+ TextureMap,
25
+ TextureOptions,
26
+ } from './CoreTextureManager.js';
27
+ import type { CoreRenderer } from './renderers/CoreRenderer.js';
28
+ import type { CoreShader } from './renderers/CoreShader.js';
29
+ import type { Stage } from './Stage.js';
30
+ import type {
31
+ Texture,
32
+ TextureFailedEventHandler,
33
+ TextureFreedEventHandler,
34
+ TextureLoadedEventHandler,
35
+ } from './textures/Texture.js';
36
+ import type {
37
+ NodeTextureFailedPayload,
38
+ NodeTextureFreedPayload,
39
+ NodeTextureLoadedPayload,
40
+ } from '../common/CommonTypes.js';
41
+ import { EventEmitter } from '../common/EventEmitter.js';
42
+ import {
43
+ copyRect,
44
+ intersectRect,
45
+ type Bound,
46
+ type RectWithValid,
47
+ createBound,
48
+ boundInsideBound,
49
+ } from './lib/utils.js';
50
+ import { Matrix3d } from './lib/Matrix3d.js';
51
+ import { RenderCoords } from './lib/RenderCoords.js';
52
+
53
+ export enum CoreNodeRenderState {
54
+ Init = 0,
55
+ OutOfBounds = 2,
56
+ InBounds = 4,
57
+ InViewport = 8,
58
+ }
59
+
60
+ const CoreNodeRenderStateMap: Map<CoreNodeRenderState, string> = new Map();
61
+ CoreNodeRenderStateMap.set(CoreNodeRenderState.Init, 'init');
62
+ CoreNodeRenderStateMap.set(CoreNodeRenderState.OutOfBounds, 'outOfBounds');
63
+ CoreNodeRenderStateMap.set(CoreNodeRenderState.InBounds, 'inBounds');
64
+ CoreNodeRenderStateMap.set(CoreNodeRenderState.InViewport, 'inViewport');
65
+
66
+ export interface CoreNodeProps {
67
+ id: number;
68
+ // External facing properties whose defaults are determined by
69
+ // RendererMain's resolveNodeDefaults() method
70
+ x: number;
71
+ y: number;
72
+ width: number;
73
+ height: number;
74
+ alpha: number;
75
+ clipping: boolean;
76
+ color: number;
77
+ colorTop: number;
78
+ colorBottom: number;
79
+ colorLeft: number;
80
+ colorRight: number;
81
+ colorTl: number;
82
+ colorTr: number;
83
+ colorBl: number;
84
+ colorBr: number;
85
+ parent: CoreNode | null;
86
+ zIndex: number;
87
+ texture: Texture | null;
88
+ textureOptions: TextureOptions | null;
89
+ shader: CoreShader | null;
90
+ shaderProps: Record<string, unknown> | null;
91
+ zIndexLocked: number;
92
+ scaleX: number;
93
+ scaleY: number;
94
+ mount: number;
95
+ mountX: number;
96
+ mountY: number;
97
+ pivot: number;
98
+ pivotX: number;
99
+ pivotY: number;
100
+ rotation: number;
101
+ }
102
+
103
+ type ICoreNode = Omit<
104
+ CoreNodeProps,
105
+ 'texture' | 'textureOptions' | 'shader' | 'shaderProps'
106
+ >;
107
+
108
+ export enum UpdateType {
109
+ /**
110
+ * Child updates
111
+ */
112
+ Children = 1,
113
+
114
+ /**
115
+ * Scale/Rotate transform update
116
+ *
117
+ * @remarks
118
+ * CoreNode Properties Updated:
119
+ * - `scaleRotateTransform`
120
+ */
121
+ ScaleRotate = 2,
122
+
123
+ /**
124
+ * Translate transform update (x/y/width/height/pivot/mount)
125
+ *
126
+ * @remarks
127
+ * CoreNode Properties Updated:
128
+ * - `localTransform`
129
+ */
130
+ Local = 4,
131
+
132
+ /**
133
+ * Global Transform update
134
+ *
135
+ * @remarks
136
+ * CoreNode Properties Updated:
137
+ * - `globalTransform`
138
+ * - `renderCoords`
139
+ * - `renderBound`
140
+ */
141
+ Global = 8,
142
+
143
+ /**
144
+ * Clipping rect update
145
+ *
146
+ * @remarks
147
+ * CoreNode Properties Updated:
148
+ * - `clippingRect`
149
+ */
150
+ Clipping = 16,
151
+
152
+ /**
153
+ * Calculated ZIndex update
154
+ *
155
+ * @remarks
156
+ * CoreNode Properties Updated:
157
+ * - `calcZIndex`
158
+ */
159
+ CalculatedZIndex = 32,
160
+
161
+ /**
162
+ * Z-Index Sorted Children update
163
+ *
164
+ * @remarks
165
+ * CoreNode Properties Updated:
166
+ * - `children` (sorts children by their `calcZIndex`)
167
+ */
168
+ ZIndexSortedChildren = 64,
169
+
170
+ /**
171
+ * Premultiplied Colors update
172
+ *
173
+ * @remarks
174
+ * CoreNode Properties Updated:
175
+ * - `premultipliedColorTl`
176
+ * - `premultipliedColorTr`
177
+ * - `premultipliedColorBl`
178
+ * - `premultipliedColorBr`
179
+ */
180
+ PremultipliedColors = 128,
181
+
182
+ /**
183
+ * World Alpha update
184
+ *
185
+ * @remarks
186
+ * CoreNode Properties Updated:
187
+ * - `worldAlpha` = `parent.worldAlpha` * `alpha`
188
+ */
189
+ WorldAlpha = 256,
190
+
191
+ /**
192
+ * Render State update
193
+ *
194
+ * @remarks
195
+ * CoreNode Properties Updated:
196
+ * - `renderState`
197
+ */
198
+ RenderState = 512,
199
+
200
+ /**
201
+ * Is Renderable update
202
+ *
203
+ * @remarks
204
+ * CoreNode Properties Updated:
205
+ * - `isRenderable`
206
+ */
207
+ IsRenderable = 1024,
208
+
209
+ /**
210
+ * None
211
+ */
212
+ None = 0,
213
+
214
+ /**
215
+ * All
216
+ */
217
+ All = 2047,
218
+ }
219
+
220
+ export class CoreNode extends EventEmitter implements ICoreNode {
221
+ readonly children: CoreNode[] = [];
222
+ protected props: Required<CoreNodeProps>;
223
+
224
+ public updateType = UpdateType.All;
225
+
226
+ public globalTransform?: Matrix3d;
227
+ public scaleRotateTransform?: Matrix3d;
228
+ public localTransform?: Matrix3d;
229
+ public renderCoords?: RenderCoords;
230
+ public renderBound?: Bound;
231
+ public strictBound?: Bound;
232
+ public preloadBound?: Bound;
233
+ public clippingRect: RectWithValid = {
234
+ x: 0,
235
+ y: 0,
236
+ width: 0,
237
+ height: 0,
238
+ valid: false,
239
+ };
240
+ public isRenderable = false;
241
+ public renderState: CoreNodeRenderState = CoreNodeRenderState.Init;
242
+
243
+ public worldAlpha = 1;
244
+ public premultipliedColorTl = 0;
245
+ public premultipliedColorTr = 0;
246
+ public premultipliedColorBl = 0;
247
+ public premultipliedColorBr = 0;
248
+ public calcZIndex = 0;
249
+
250
+ constructor(protected stage: Stage, props: CoreNodeProps) {
251
+ super();
252
+ this.props = {
253
+ ...props,
254
+ parent: null,
255
+ };
256
+ // Allow for parent to be processed appropriately
257
+ this.parent = props.parent;
258
+ this.updateScaleRotateTransform();
259
+ }
260
+
261
+ //#region Textures
262
+ loadTexture<Type extends keyof TextureMap>(
263
+ textureType: Type,
264
+ props: ExtractProps<TextureMap[Type]>,
265
+ options: TextureOptions | null = null,
266
+ ): void {
267
+ // First unload any existing texture
268
+ if (this.props.texture) {
269
+ this.unloadTexture();
270
+ }
271
+ const { txManager } = this.stage;
272
+ const texture = txManager.loadTexture(textureType, props, options);
273
+
274
+ this.props.texture = texture;
275
+ this.props.textureOptions = options;
276
+ this.setUpdateType(UpdateType.IsRenderable);
277
+
278
+ // If texture is already loaded / failed, trigger loaded event manually
279
+ // so that users get a consistent event experience.
280
+ // We do this in a microtask to allow listeners to be attached in the same
281
+ // synchronous task after calling loadTexture()
282
+ queueMicrotask(() => {
283
+ if (texture.state === 'loaded') {
284
+ this.onTextureLoaded(texture, texture.dimensions!);
285
+ } else if (texture.state === 'failed') {
286
+ this.onTextureFailed(texture, texture.error!);
287
+ } else if (texture.state === 'freed') {
288
+ this.onTextureFreed(texture);
289
+ }
290
+ texture.on('loaded', this.onTextureLoaded);
291
+ texture.on('failed', this.onTextureFailed);
292
+ texture.on('freed', this.onTextureFreed);
293
+ });
294
+ }
295
+
296
+ unloadTexture(): void {
297
+ if (this.props.texture) {
298
+ const { texture } = this.props;
299
+ texture.off('loaded', this.onTextureLoaded);
300
+ texture.off('failed', this.onTextureFailed);
301
+ texture.off('freed', this.onTextureFreed);
302
+ texture.setRenderableOwner(this, false);
303
+ }
304
+ this.props.texture = null;
305
+ this.props.textureOptions = null;
306
+ this.setUpdateType(UpdateType.IsRenderable);
307
+ }
308
+
309
+ private onTextureLoaded: TextureLoadedEventHandler = (target, dimensions) => {
310
+ // Texture was loaded. In case the RAF loop has already stopped, we request
311
+ // a render to ensure the texture is rendered.
312
+ this.stage.requestRender();
313
+ this.emit('loaded', {
314
+ type: 'texture',
315
+ dimensions,
316
+ } satisfies NodeTextureLoadedPayload);
317
+ };
318
+
319
+ private onTextureFailed: TextureFailedEventHandler = (target, error) => {
320
+ this.emit('failed', {
321
+ type: 'texture',
322
+ error,
323
+ } satisfies NodeTextureFailedPayload);
324
+ };
325
+
326
+ private onTextureFreed: TextureFreedEventHandler = (target: Texture) => {
327
+ this.emit('freed', {
328
+ type: 'texture',
329
+ } satisfies NodeTextureFreedPayload);
330
+ };
331
+ //#endregion Textures
332
+
333
+ loadShader<Type extends keyof ShaderMap>(
334
+ shaderType: Type,
335
+ props: ExtractProps<ShaderMap[Type]>,
336
+ ): void {
337
+ const shManager = this.stage.renderer.getShaderManager();
338
+ assertTruthy(shManager);
339
+ const { shader, props: p } = shManager.loadShader(shaderType, props);
340
+ this.props.shader = shader;
341
+ this.props.shaderProps = p;
342
+ this.setUpdateType(UpdateType.IsRenderable);
343
+ }
344
+
345
+ /**
346
+ * Change types types is used to determine the scope of the changes being applied
347
+ *
348
+ * @remarks
349
+ * See {@link UpdateType} for more information on each type
350
+ *
351
+ * @param type
352
+ */
353
+ setUpdateType(type: UpdateType): void {
354
+ this.updateType |= type;
355
+
356
+ // If we're updating this node at all, we need to inform the parent
357
+ // (and all ancestors) that their children need updating as well
358
+ const parent = this.props.parent;
359
+ if (parent && !(parent.updateType & UpdateType.Children)) {
360
+ parent.setUpdateType(UpdateType.Children);
361
+ }
362
+ }
363
+
364
+ sortChildren() {
365
+ this.children.sort((a, b) => a.calcZIndex - b.calcZIndex);
366
+ }
367
+
368
+ updateScaleRotateTransform() {
369
+ this.scaleRotateTransform = Matrix3d.rotate(
370
+ this.props.rotation,
371
+ this.scaleRotateTransform,
372
+ ).scale(this.props.scaleX, this.props.scaleY);
373
+ }
374
+
375
+ updateLocalTransform() {
376
+ assertTruthy(this.scaleRotateTransform);
377
+ const pivotTranslateX = this.props.pivotX * this.props.width;
378
+ const pivotTranslateY = this.props.pivotY * this.props.height;
379
+ const mountTranslateX = this.props.mountX * this.props.width;
380
+ const mountTranslateY = this.props.mountY * this.props.height;
381
+
382
+ this.localTransform = Matrix3d.translate(
383
+ pivotTranslateX - mountTranslateX + this.props.x,
384
+ pivotTranslateY - mountTranslateY + this.props.y,
385
+ this.localTransform,
386
+ )
387
+ .multiply(this.scaleRotateTransform)
388
+ .translate(-pivotTranslateX, -pivotTranslateY);
389
+
390
+ this.setUpdateType(UpdateType.Global);
391
+ }
392
+
393
+ /**
394
+ * @todo: test for correct calculation flag
395
+ * @param delta
396
+ */
397
+ update(delta: number, parentClippingRect: RectWithValid): void {
398
+ if (this.updateType & UpdateType.ScaleRotate) {
399
+ this.updateScaleRotateTransform();
400
+ this.setUpdateType(UpdateType.Local);
401
+ }
402
+
403
+ if (this.updateType & UpdateType.Local) {
404
+ this.updateLocalTransform();
405
+ this.setUpdateType(UpdateType.Global);
406
+ }
407
+
408
+ const parent = this.props.parent;
409
+ let childUpdateType = UpdateType.None;
410
+ if (this.updateType & UpdateType.Global) {
411
+ assertTruthy(this.localTransform);
412
+ this.globalTransform = Matrix3d.copy(
413
+ parent?.globalTransform || this.localTransform,
414
+ this.globalTransform,
415
+ );
416
+
417
+ if (parent) {
418
+ this.globalTransform.multiply(this.localTransform);
419
+ }
420
+ this.calculateRenderCoords();
421
+ this.updateBoundingRect();
422
+ this.setUpdateType(
423
+ UpdateType.Clipping | UpdateType.RenderState | UpdateType.Children,
424
+ );
425
+ childUpdateType |= UpdateType.Global;
426
+ }
427
+
428
+ if (this.updateType & UpdateType.Clipping) {
429
+ this.calculateClippingRect(parentClippingRect);
430
+ this.setUpdateType(UpdateType.Children);
431
+ childUpdateType |= UpdateType.Clipping;
432
+ }
433
+
434
+ if (this.updateType & UpdateType.WorldAlpha) {
435
+ if (parent) {
436
+ this.worldAlpha = parent.worldAlpha * this.props.alpha;
437
+ } else {
438
+ this.worldAlpha = this.props.alpha;
439
+ }
440
+ this.setUpdateType(UpdateType.Children | UpdateType.PremultipliedColors);
441
+ childUpdateType |= UpdateType.WorldAlpha;
442
+ }
443
+
444
+ if (this.updateType & UpdateType.PremultipliedColors) {
445
+ this.premultipliedColorTl = mergeColorAlphaPremultiplied(
446
+ this.props.colorTl,
447
+ this.worldAlpha,
448
+ true,
449
+ );
450
+
451
+ // If all the colors are the same just sent them all to the same value
452
+ if (
453
+ this.props.colorTl === this.props.colorTr &&
454
+ this.props.colorBl === this.props.colorBr &&
455
+ this.props.colorTl === this.props.colorBl
456
+ ) {
457
+ this.premultipliedColorTr =
458
+ this.premultipliedColorBl =
459
+ this.premultipliedColorBr =
460
+ this.premultipliedColorTl;
461
+ } else {
462
+ this.premultipliedColorTr = mergeColorAlphaPremultiplied(
463
+ this.props.colorTr,
464
+ this.worldAlpha,
465
+ true,
466
+ );
467
+ this.premultipliedColorBl = mergeColorAlphaPremultiplied(
468
+ this.props.colorBl,
469
+ this.worldAlpha,
470
+ true,
471
+ );
472
+ this.premultipliedColorBr = mergeColorAlphaPremultiplied(
473
+ this.props.colorBr,
474
+ this.worldAlpha,
475
+ true,
476
+ );
477
+ }
478
+ }
479
+
480
+ if (this.updateType & UpdateType.RenderState) {
481
+ this.updateRenderState();
482
+ this.setUpdateType(UpdateType.IsRenderable);
483
+ }
484
+
485
+ if (this.updateType & UpdateType.IsRenderable) {
486
+ this.updateIsRenderable();
487
+ }
488
+
489
+ // No need to update zIndex if there is no parent
490
+ if (parent && this.updateType & UpdateType.CalculatedZIndex) {
491
+ this.calculateZIndex();
492
+ // Tell parent to re-sort children
493
+ parent.setUpdateType(UpdateType.ZIndexSortedChildren);
494
+ }
495
+
496
+ if (this.updateType & UpdateType.Children && this.children.length) {
497
+ this.children.forEach((child) => {
498
+ // Trigger the depenedent update types on the child
499
+ child.setUpdateType(childUpdateType);
500
+ // If child has no updates, skip
501
+ if (child.updateType === 0) {
502
+ return;
503
+ }
504
+ child.update(delta, this.clippingRect);
505
+ });
506
+ }
507
+
508
+ // Sorting children MUST happen after children have been updated so
509
+ // that they have the oppotunity to update their calculated zIndex.
510
+ if (this.updateType & UpdateType.ZIndexSortedChildren) {
511
+ // reorder z-index
512
+ this.sortChildren();
513
+ }
514
+
515
+ // reset update type
516
+ this.updateType = 0;
517
+ }
518
+
519
+ //check if CoreNode is renderable based on props
520
+ checkRenderProps(): boolean {
521
+ if (this.props.texture) {
522
+ return true;
523
+ }
524
+
525
+ if (!this.props.width || !this.props.height) {
526
+ return false;
527
+ }
528
+
529
+ if (this.props.shader) {
530
+ return true;
531
+ }
532
+
533
+ if (this.props.clipping) {
534
+ return true;
535
+ }
536
+
537
+ if (this.props.color !== 0) {
538
+ return true;
539
+ }
540
+
541
+ // Consider removing these checks and just using the color property check above.
542
+ // Maybe add a forceRender prop for nodes that should always render.
543
+ if (this.props.colorTop !== 0) {
544
+ return true;
545
+ }
546
+
547
+ if (this.props.colorBottom !== 0) {
548
+ return true;
549
+ }
550
+
551
+ if (this.props.colorLeft !== 0) {
552
+ return true;
553
+ }
554
+
555
+ if (this.props.colorRight !== 0) {
556
+ return true;
557
+ }
558
+
559
+ if (this.props.colorTl !== 0) {
560
+ return true;
561
+ }
562
+
563
+ if (this.props.colorTr !== 0) {
564
+ return true;
565
+ }
566
+
567
+ if (this.props.colorBl !== 0) {
568
+ return true;
569
+ }
570
+
571
+ if (this.props.colorBr !== 0) {
572
+ return true;
573
+ }
574
+ return false;
575
+ }
576
+
577
+ checkRenderBounds(): CoreNodeRenderState {
578
+ assertTruthy(this.clippingRect);
579
+ assertTruthy(this.renderBound);
580
+ const rectW = this.clippingRect.width || this.stage.root.width;
581
+ const rectH = this.clippingRect.height || this.stage.root.height;
582
+ this.strictBound = createBound(
583
+ this.clippingRect.x,
584
+ this.clippingRect.y,
585
+ rectW,
586
+ rectH,
587
+ this.strictBound,
588
+ );
589
+
590
+ const renderM = this.stage.boundsMargin;
591
+ this.preloadBound = createBound(
592
+ this.clippingRect.x - renderM[3],
593
+ this.clippingRect.y - renderM[0],
594
+ this.clippingRect.x + rectW + renderM[1],
595
+ this.clippingRect.y + rectH + renderM[2],
596
+ this.preloadBound,
597
+ );
598
+
599
+ if (boundInsideBound(this.renderBound, this.strictBound)) {
600
+ return CoreNodeRenderState.InViewport;
601
+ }
602
+
603
+ if (boundInsideBound(this.renderBound, this.preloadBound)) {
604
+ return CoreNodeRenderState.InBounds;
605
+ }
606
+ return CoreNodeRenderState.OutOfBounds;
607
+ }
608
+
609
+ updateRenderState() {
610
+ const renderState = this.checkRenderBounds();
611
+ if (renderState !== this.renderState) {
612
+ const previous = this.renderState;
613
+ this.renderState = renderState;
614
+ if (previous === CoreNodeRenderState.InViewport) {
615
+ this.emit('outOfViewport', {
616
+ previous,
617
+ current: renderState,
618
+ });
619
+ }
620
+ const event = CoreNodeRenderStateMap.get(renderState);
621
+ assertTruthy(event);
622
+ this.emit(event, {
623
+ previous,
624
+ current: renderState,
625
+ });
626
+ }
627
+ }
628
+
629
+ setRenderState(state: CoreNodeRenderState) {
630
+ if (state !== this.renderState) {
631
+ this.renderState = state;
632
+ this.emit(CoreNodeRenderState[state]);
633
+ }
634
+ }
635
+
636
+ /**
637
+ * This function updates the `isRenderable` property based on certain conditions.
638
+ *
639
+ * @returns
640
+ */
641
+ updateIsRenderable() {
642
+ let newIsRenderable;
643
+ if (!this.checkRenderProps()) {
644
+ newIsRenderable = false;
645
+ } else {
646
+ newIsRenderable = this.renderState > CoreNodeRenderState.OutOfBounds;
647
+ }
648
+ if (this.isRenderable !== newIsRenderable) {
649
+ this.isRenderable = newIsRenderable;
650
+ this.onChangeIsRenderable(newIsRenderable);
651
+ }
652
+ }
653
+
654
+ onChangeIsRenderable(isRenderable: boolean) {
655
+ this.props.texture?.setRenderableOwner(this, isRenderable);
656
+ }
657
+
658
+ calculateRenderCoords() {
659
+ const { width, height, globalTransform: transform } = this;
660
+ assertTruthy(transform);
661
+ const { tx, ty, ta, tb, tc, td } = transform;
662
+ if (tb === 0 && tc === 0) {
663
+ const minX = tx;
664
+ const maxX = tx + width * ta;
665
+
666
+ const minY = ty;
667
+ const maxY = ty + height * td;
668
+ this.renderCoords = RenderCoords.translate(
669
+ //top-left
670
+ minX,
671
+ minY,
672
+ //top-right
673
+ maxX,
674
+ minY,
675
+ //bottom-right
676
+ maxX,
677
+ maxY,
678
+ //bottom-left
679
+ minX,
680
+ maxY,
681
+ this.renderCoords,
682
+ );
683
+ } else {
684
+ this.renderCoords = RenderCoords.translate(
685
+ //top-left
686
+ tx,
687
+ ty,
688
+ //top-right
689
+ tx + width * ta,
690
+ ty + width * tc,
691
+ //bottom-right
692
+ tx + width * ta + height * tb,
693
+ ty + width * tc + height * td,
694
+ //bottom-left
695
+ tx + height * tb,
696
+ ty + height * td,
697
+ this.renderCoords,
698
+ );
699
+ }
700
+ }
701
+
702
+ updateBoundingRect() {
703
+ const { renderCoords, globalTransform: transform } = this;
704
+ assertTruthy(transform);
705
+ assertTruthy(renderCoords);
706
+
707
+ const { tb, tc } = transform;
708
+ const { x1, y1, x3, y3 } = renderCoords;
709
+ if (tb === 0 || tc === 0) {
710
+ this.renderBound = createBound(x1, y1, x3, y3, this.renderBound);
711
+ } else {
712
+ const { x2, x4, y2, y4 } = renderCoords;
713
+ this.renderBound = createBound(
714
+ Math.min(x1, x2, x3, x4),
715
+ Math.min(y1, y2, y3, y4),
716
+ Math.max(x1, x2, x3, x4),
717
+ Math.max(y1, y2, y3, y4),
718
+ this.renderBound,
719
+ );
720
+ }
721
+ }
722
+
723
+ /**
724
+ * This function calculates the clipping rectangle for a node.
725
+ *
726
+ * The function then checks if the node is rotated. If the node requires clipping and is not rotated, a new clipping rectangle is created based on the node's global transform and dimensions.
727
+ * If a parent clipping rectangle exists, it is intersected with the node's clipping rectangle (if it exists), or replaces the node's clipping rectangle.
728
+ *
729
+ * Finally, the node's parentClippingRect and clippingRect properties are updated.
730
+ */
731
+ calculateClippingRect(parentClippingRect: RectWithValid) {
732
+ assertTruthy(this.globalTransform);
733
+ const { clippingRect, props, globalTransform: gt } = this;
734
+ const { clipping } = props;
735
+
736
+ const isRotated = gt.tb !== 0 || gt.tc !== 0;
737
+
738
+ if (clipping && !isRotated) {
739
+ clippingRect.x = gt.tx;
740
+ clippingRect.y = gt.ty;
741
+ clippingRect.width = this.width * gt.ta;
742
+ clippingRect.height = this.height * gt.td;
743
+ clippingRect.valid = true;
744
+ } else {
745
+ clippingRect.valid = false;
746
+ }
747
+
748
+ if (parentClippingRect.valid && clippingRect.valid) {
749
+ // Intersect parent clipping rect with node clipping rect
750
+ intersectRect(parentClippingRect, clippingRect, clippingRect);
751
+ } else if (parentClippingRect.valid) {
752
+ // Copy parent clipping rect
753
+ copyRect(parentClippingRect, clippingRect);
754
+ clippingRect.valid = true;
755
+ }
756
+ }
757
+
758
+ calculateZIndex(): void {
759
+ const props = this.props;
760
+ const z = props.zIndex || 0;
761
+ const p = props.parent?.zIndex || 0;
762
+
763
+ let zIndex = z;
764
+ if (props.parent?.zIndexLocked) {
765
+ zIndex = z < p ? z : p;
766
+ }
767
+ this.calcZIndex = zIndex;
768
+ }
769
+
770
+ /**
771
+ * Destroy the node and cleanup all resources
772
+ */
773
+ destroy(): void {
774
+ this.unloadTexture();
775
+
776
+ this.clippingRect.valid = false;
777
+
778
+ this.isRenderable = false;
779
+
780
+ delete this.renderCoords;
781
+ delete this.renderBound;
782
+ delete this.strictBound;
783
+ delete this.preloadBound;
784
+ delete this.globalTransform;
785
+ delete this.scaleRotateTransform;
786
+ delete this.localTransform;
787
+
788
+ this.props.texture = null;
789
+ this.props.shader = null;
790
+
791
+ this.removeAllListeners();
792
+ this.parent = null;
793
+ }
794
+
795
+ renderQuads(renderer: CoreRenderer): void {
796
+ const { width, height, texture, textureOptions, shader, shaderProps } =
797
+ this.props;
798
+ const {
799
+ premultipliedColorTl,
800
+ premultipliedColorTr,
801
+ premultipliedColorBl,
802
+ premultipliedColorBr,
803
+ } = this;
804
+
805
+ const { zIndex, worldAlpha, globalTransform: gt, clippingRect } = this;
806
+
807
+ assertTruthy(gt);
808
+
809
+ // add to list of renderables to be sorted before rendering
810
+ renderer.addQuad({
811
+ width,
812
+ height,
813
+ colorTl: premultipliedColorTl,
814
+ colorTr: premultipliedColorTr,
815
+ colorBl: premultipliedColorBl,
816
+ colorBr: premultipliedColorBr,
817
+ texture,
818
+ textureOptions,
819
+ zIndex,
820
+ shader,
821
+ shaderProps,
822
+ alpha: worldAlpha,
823
+ clippingRect,
824
+ tx: gt.tx,
825
+ ty: gt.ty,
826
+ ta: gt.ta,
827
+ tb: gt.tb,
828
+ tc: gt.tc,
829
+ td: gt.td,
830
+ });
831
+
832
+ // Calculate absolute X and Y based on all ancestors
833
+ // renderer.addQuad(absX, absY, w, h, color, texture, textureOptions, zIndex);
834
+ }
835
+
836
+ //#region Properties
837
+ get id(): number {
838
+ return this.props.id;
839
+ }
840
+
841
+ get x(): number {
842
+ return this.props.x;
843
+ }
844
+
845
+ set x(value: number) {
846
+ if (this.props.x !== value) {
847
+ this.props.x = value;
848
+ this.setUpdateType(UpdateType.Local);
849
+ }
850
+ }
851
+
852
+ get absX(): number {
853
+ return (
854
+ this.props.x +
855
+ (this.props.parent?.absX || this.props.parent?.globalTransform?.tx || 0)
856
+ );
857
+ }
858
+
859
+ get absY(): number {
860
+ return this.props.y + (this.props.parent?.absY ?? 0);
861
+ }
862
+
863
+ get y(): number {
864
+ return this.props.y;
865
+ }
866
+
867
+ set y(value: number) {
868
+ if (this.props.y !== value) {
869
+ this.props.y = value;
870
+ this.setUpdateType(UpdateType.Local);
871
+ }
872
+ }
873
+
874
+ get width(): number {
875
+ return this.props.width;
876
+ }
877
+
878
+ set width(value: number) {
879
+ if (this.props.width !== value) {
880
+ this.props.width = value;
881
+ this.setUpdateType(UpdateType.Local);
882
+ }
883
+ }
884
+
885
+ get height(): number {
886
+ return this.props.height;
887
+ }
888
+
889
+ set height(value: number) {
890
+ if (this.props.height !== value) {
891
+ this.props.height = value;
892
+ this.setUpdateType(UpdateType.Local);
893
+ }
894
+ }
895
+
896
+ get scale(): number {
897
+ // The CoreNode `scale` property is only used by Animations.
898
+ // Unlike INode, `null` should never be possibility for Animations.
899
+ return this.scaleX;
900
+ }
901
+
902
+ set scale(value: number) {
903
+ // The CoreNode `scale` property is only used by Animations.
904
+ // Unlike INode, `null` should never be possibility for Animations.
905
+ this.scaleX = value;
906
+ this.scaleY = value;
907
+ }
908
+
909
+ get scaleX(): number {
910
+ return this.props.scaleX;
911
+ }
912
+
913
+ set scaleX(value: number) {
914
+ if (this.props.scaleX !== value) {
915
+ this.props.scaleX = value;
916
+ this.setUpdateType(UpdateType.ScaleRotate);
917
+ }
918
+ }
919
+
920
+ get scaleY(): number {
921
+ return this.props.scaleY;
922
+ }
923
+
924
+ set scaleY(value: number) {
925
+ if (this.props.scaleY !== value) {
926
+ this.props.scaleY = value;
927
+ this.setUpdateType(UpdateType.ScaleRotate);
928
+ }
929
+ }
930
+
931
+ get mount(): number {
932
+ return this.props.mount;
933
+ }
934
+
935
+ set mount(value: number) {
936
+ if (this.props.mountX !== value || this.props.mountY !== value) {
937
+ this.props.mountX = value;
938
+ this.props.mountY = value;
939
+ this.props.mount = value;
940
+ this.setUpdateType(UpdateType.Local);
941
+ }
942
+ }
943
+
944
+ get mountX(): number {
945
+ return this.props.mountX;
946
+ }
947
+
948
+ set mountX(value: number) {
949
+ if (this.props.mountX !== value) {
950
+ this.props.mountX = value;
951
+ this.setUpdateType(UpdateType.Local);
952
+ }
953
+ }
954
+
955
+ get mountY(): number {
956
+ return this.props.mountY;
957
+ }
958
+
959
+ set mountY(value: number) {
960
+ if (this.props.mountY !== value) {
961
+ this.props.mountY = value;
962
+ this.setUpdateType(UpdateType.Local);
963
+ }
964
+ }
965
+
966
+ get pivot(): number {
967
+ return this.props.pivot;
968
+ }
969
+
970
+ set pivot(value: number) {
971
+ if (this.props.pivotX !== value || this.props.pivotY !== value) {
972
+ this.props.pivotX = value;
973
+ this.props.pivotY = value;
974
+ this.props.pivot = value;
975
+ this.setUpdateType(UpdateType.Local);
976
+ }
977
+ }
978
+
979
+ get pivotX(): number {
980
+ return this.props.pivotX;
981
+ }
982
+
983
+ set pivotX(value: number) {
984
+ if (this.props.pivotX !== value) {
985
+ this.props.pivotX = value;
986
+ this.setUpdateType(UpdateType.Local);
987
+ }
988
+ }
989
+
990
+ get pivotY(): number {
991
+ return this.props.pivotY;
992
+ }
993
+
994
+ set pivotY(value: number) {
995
+ if (this.props.pivotY !== value) {
996
+ this.props.pivotY = value;
997
+ this.setUpdateType(UpdateType.Local);
998
+ }
999
+ }
1000
+
1001
+ get rotation(): number {
1002
+ return this.props.rotation;
1003
+ }
1004
+
1005
+ set rotation(value: number) {
1006
+ if (this.props.rotation !== value) {
1007
+ this.props.rotation = value;
1008
+ this.setUpdateType(UpdateType.ScaleRotate);
1009
+ }
1010
+ }
1011
+
1012
+ get alpha(): number {
1013
+ return this.props.alpha;
1014
+ }
1015
+
1016
+ set alpha(value: number) {
1017
+ this.props.alpha = value;
1018
+ this.setUpdateType(UpdateType.PremultipliedColors | UpdateType.WorldAlpha);
1019
+ }
1020
+
1021
+ get clipping(): boolean {
1022
+ return this.props.clipping;
1023
+ }
1024
+
1025
+ set clipping(value: boolean) {
1026
+ this.props.clipping = value;
1027
+ this.setUpdateType(UpdateType.Clipping);
1028
+ }
1029
+
1030
+ get color(): number {
1031
+ return this.props.color;
1032
+ }
1033
+
1034
+ set color(value: number) {
1035
+ if (
1036
+ this.props.colorTl !== value ||
1037
+ this.props.colorTr !== value ||
1038
+ this.props.colorBl !== value ||
1039
+ this.props.colorBr !== value
1040
+ ) {
1041
+ this.colorTl = value;
1042
+ this.colorTr = value;
1043
+ this.colorBl = value;
1044
+ this.colorBr = value;
1045
+ }
1046
+ this.props.color = value;
1047
+
1048
+ this.setUpdateType(UpdateType.PremultipliedColors);
1049
+ }
1050
+
1051
+ get colorTop(): number {
1052
+ return this.props.colorTop;
1053
+ }
1054
+
1055
+ set colorTop(value: number) {
1056
+ if (this.props.colorTl !== value || this.props.colorTr !== value) {
1057
+ this.colorTl = value;
1058
+ this.colorTr = value;
1059
+ }
1060
+ this.props.colorTop = value;
1061
+ this.setUpdateType(UpdateType.PremultipliedColors);
1062
+ }
1063
+
1064
+ get colorBottom(): number {
1065
+ return this.props.colorBottom;
1066
+ }
1067
+
1068
+ set colorBottom(value: number) {
1069
+ if (this.props.colorBl !== value || this.props.colorBr !== value) {
1070
+ this.colorBl = value;
1071
+ this.colorBr = value;
1072
+ }
1073
+ this.props.colorBottom = value;
1074
+ this.setUpdateType(UpdateType.PremultipliedColors);
1075
+ }
1076
+
1077
+ get colorLeft(): number {
1078
+ return this.props.colorLeft;
1079
+ }
1080
+
1081
+ set colorLeft(value: number) {
1082
+ if (this.props.colorTl !== value || this.props.colorBl !== value) {
1083
+ this.colorTl = value;
1084
+ this.colorBl = value;
1085
+ }
1086
+ this.props.colorLeft = value;
1087
+ this.setUpdateType(UpdateType.PremultipliedColors);
1088
+ }
1089
+
1090
+ get colorRight(): number {
1091
+ return this.props.colorRight;
1092
+ }
1093
+
1094
+ set colorRight(value: number) {
1095
+ if (this.props.colorTr !== value || this.props.colorBr !== value) {
1096
+ this.colorTr = value;
1097
+ this.colorBr = value;
1098
+ }
1099
+ this.props.colorRight = value;
1100
+ this.setUpdateType(UpdateType.PremultipliedColors);
1101
+ }
1102
+
1103
+ get colorTl(): number {
1104
+ return this.props.colorTl;
1105
+ }
1106
+
1107
+ set colorTl(value: number) {
1108
+ this.props.colorTl = value;
1109
+ this.setUpdateType(UpdateType.PremultipliedColors);
1110
+ }
1111
+
1112
+ get colorTr(): number {
1113
+ return this.props.colorTr;
1114
+ }
1115
+
1116
+ set colorTr(value: number) {
1117
+ this.props.colorTr = value;
1118
+ this.setUpdateType(UpdateType.PremultipliedColors);
1119
+ }
1120
+
1121
+ get colorBl(): number {
1122
+ return this.props.colorBl;
1123
+ }
1124
+
1125
+ set colorBl(value: number) {
1126
+ this.props.colorBl = value;
1127
+ this.setUpdateType(UpdateType.PremultipliedColors);
1128
+ }
1129
+
1130
+ get colorBr(): number {
1131
+ return this.props.colorBr;
1132
+ }
1133
+
1134
+ set colorBr(value: number) {
1135
+ this.props.colorBr = value;
1136
+ this.setUpdateType(UpdateType.PremultipliedColors);
1137
+ }
1138
+
1139
+ // we're only interested in parent zIndex to test
1140
+ // if we should use node zIndex is higher then parent zIndex
1141
+ get zIndexLocked(): number {
1142
+ return this.props.zIndexLocked || 0;
1143
+ }
1144
+
1145
+ set zIndexLocked(value: number) {
1146
+ this.props.zIndexLocked = value;
1147
+ this.setUpdateType(UpdateType.CalculatedZIndex | UpdateType.Children);
1148
+ this.children.forEach((child) => {
1149
+ child.setUpdateType(UpdateType.CalculatedZIndex);
1150
+ });
1151
+ }
1152
+
1153
+ get zIndex(): number {
1154
+ return this.props.zIndex;
1155
+ }
1156
+
1157
+ set zIndex(value: number) {
1158
+ this.props.zIndex = value;
1159
+ this.setUpdateType(UpdateType.CalculatedZIndex | UpdateType.Children);
1160
+ this.children.forEach((child) => {
1161
+ child.setUpdateType(UpdateType.CalculatedZIndex);
1162
+ });
1163
+ }
1164
+
1165
+ get parent(): CoreNode | null {
1166
+ return this.props.parent;
1167
+ }
1168
+
1169
+ set parent(newParent: CoreNode | null) {
1170
+ const oldParent = this.props.parent;
1171
+ if (oldParent === newParent) {
1172
+ return;
1173
+ }
1174
+ this.props.parent = newParent;
1175
+ if (oldParent) {
1176
+ const index = oldParent.children.indexOf(this);
1177
+ assertTruthy(
1178
+ index !== -1,
1179
+ "CoreNode.parent: Node not found in old parent's children!",
1180
+ );
1181
+ oldParent.children.splice(index, 1);
1182
+ oldParent.setUpdateType(
1183
+ UpdateType.Children | UpdateType.ZIndexSortedChildren,
1184
+ );
1185
+ }
1186
+ if (newParent) {
1187
+ newParent.children.push(this);
1188
+ // Since this node has a new parent, to be safe, have it do a full update.
1189
+ this.setUpdateType(UpdateType.All);
1190
+ // Tell parent that it's children need to be updated and sorted.
1191
+ newParent.setUpdateType(
1192
+ UpdateType.Children | UpdateType.ZIndexSortedChildren,
1193
+ );
1194
+ }
1195
+
1196
+ this.updateScaleRotateTransform();
1197
+ }
1198
+ //#endregion Properties
1199
+ }