@lightningjs/renderer 3.0.0-beta4 → 3.0.0-beta5

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 (335) hide show
  1. package/LICENSE +202 -202
  2. package/NOTICE +3 -3
  3. package/README.md +147 -147
  4. package/dist/exports/core-api.d.ts +74 -0
  5. package/dist/exports/core-api.js +96 -0
  6. package/dist/exports/core-api.js.map +1 -0
  7. package/dist/exports/main-api.d.ts +30 -0
  8. package/dist/exports/main-api.js +45 -0
  9. package/dist/exports/main-api.js.map +1 -0
  10. package/dist/src/core/CoreExtension.d.ts +12 -0
  11. package/dist/src/core/CoreExtension.js +29 -0
  12. package/dist/src/core/CoreExtension.js.map +1 -0
  13. package/dist/src/core/CoreNode.js +1 -1
  14. package/dist/src/core/CoreNode.js.map +1 -1
  15. package/dist/src/core/CoreStuff.js +138 -0
  16. package/dist/src/core/CoreStuff.js.map +1 -0
  17. package/dist/src/core/CoreTextNode.js +1 -0
  18. package/dist/src/core/CoreTextNode.js.map +1 -1
  19. package/dist/src/core/CoreTexturizer.d.ts +14 -0
  20. package/dist/src/core/CoreTexturizer.js +47 -0
  21. package/dist/src/core/CoreTexturizer.js.map +1 -0
  22. package/dist/src/core/LngNode.d.ts +736 -0
  23. package/dist/src/core/LngNode.js +1174 -0
  24. package/dist/src/core/LngNode.js.map +1 -0
  25. package/dist/src/core/Matrix2DContext.d.ts +15 -0
  26. package/dist/src/core/Matrix2DContext.js +45 -0
  27. package/dist/src/core/Matrix2DContext.js.map +1 -0
  28. package/dist/src/core/ShaderNode.d.ts +10 -0
  29. package/dist/src/core/ShaderNode.js +30 -0
  30. package/dist/src/core/ShaderNode.js.map +1 -0
  31. package/dist/src/core/TextNode.d.ts +103 -0
  32. package/dist/src/core/TextNode.js +331 -0
  33. package/dist/src/core/TextNode.js.map +1 -0
  34. package/dist/src/core/lib/Coords.d.ts +14 -0
  35. package/dist/src/core/lib/Coords.js +55 -0
  36. package/dist/src/core/lib/Coords.js.map +1 -0
  37. package/dist/src/core/lib/glm/common.d.ts +162 -0
  38. package/dist/src/core/lib/glm/common.js +81 -0
  39. package/dist/src/core/lib/glm/common.js.map +1 -0
  40. package/dist/src/core/lib/glm/index.d.ts +11 -0
  41. package/dist/src/core/lib/glm/index.js +30 -0
  42. package/dist/src/core/lib/glm/index.js.map +1 -0
  43. package/dist/src/core/lib/glm/mat2.d.ts +219 -0
  44. package/dist/src/core/lib/glm/mat2.js +396 -0
  45. package/dist/src/core/lib/glm/mat2.js.map +1 -0
  46. package/dist/src/core/lib/glm/mat2d.d.ts +237 -0
  47. package/dist/src/core/lib/glm/mat2d.js +442 -0
  48. package/dist/src/core/lib/glm/mat2d.js.map +1 -0
  49. package/dist/src/core/lib/glm/mat3.d.ts +283 -0
  50. package/dist/src/core/lib/glm/mat3.js +680 -0
  51. package/dist/src/core/lib/glm/mat3.js.map +1 -0
  52. package/dist/src/core/lib/glm/mat4.d.ts +550 -0
  53. package/dist/src/core/lib/glm/mat4.js +1802 -0
  54. package/dist/src/core/lib/glm/mat4.js.map +1 -0
  55. package/dist/src/core/lib/glm/quat.d.ts +363 -0
  56. package/dist/src/core/lib/glm/quat.js +693 -0
  57. package/dist/src/core/lib/glm/quat.js.map +1 -0
  58. package/dist/src/core/lib/glm/quat2.d.ts +356 -0
  59. package/dist/src/core/lib/glm/quat2.js +754 -0
  60. package/dist/src/core/lib/glm/quat2.js.map +1 -0
  61. package/dist/src/core/lib/glm/vec2.d.ts +365 -0
  62. package/dist/src/core/lib/glm/vec2.js +569 -0
  63. package/dist/src/core/lib/glm/vec2.js.map +1 -0
  64. package/dist/src/core/lib/glm/vec3.d.ts +406 -0
  65. package/dist/src/core/lib/glm/vec3.js +720 -0
  66. package/dist/src/core/lib/glm/vec3.js.map +1 -0
  67. package/dist/src/core/lib/glm/vec4.d.ts +330 -0
  68. package/dist/src/core/lib/glm/vec4.js +608 -0
  69. package/dist/src/core/lib/glm/vec4.js.map +1 -0
  70. package/dist/src/core/renderers/CoreShaderManager.d.ts +19 -0
  71. package/dist/src/core/renderers/CoreShaderManager.js +33 -0
  72. package/dist/src/core/renderers/CoreShaderManager.js.map +1 -0
  73. package/dist/src/core/renderers/webgl/WebGlCoreShaderManager.d.ts +27 -0
  74. package/dist/src/core/renderers/webgl/WebGlCoreShaderManager.js +82 -0
  75. package/dist/src/core/renderers/webgl/WebGlCoreShaderManager.js.map +1 -0
  76. package/dist/src/core/renderers/webgl/WebGlCoreShaderProgram.d.ts +11 -0
  77. package/dist/src/core/renderers/webgl/WebGlCoreShaderProgram.js +34 -0
  78. package/dist/src/core/renderers/webgl/WebGlCoreShaderProgram.js.map +1 -0
  79. package/dist/src/core/renderers/webgl/internal/ShaderUtils.js +35 -35
  80. package/dist/src/core/renderers/webgl/shaders/DefaultShader.js +45 -45
  81. package/dist/src/core/renderers/webgl/shaders/DefaultShaderBatched.js +61 -61
  82. package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +93 -93
  83. package/dist/src/core/renderers/webgl/shaders/RoundedRectangle.js +63 -63
  84. package/dist/src/core/renderers/webgl/shaders/SdfShader.js +62 -62
  85. package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js +15 -15
  86. package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js +6 -6
  87. package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js +15 -15
  88. package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js +15 -15
  89. package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js +15 -15
  90. package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js +42 -42
  91. package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js +44 -44
  92. package/dist/src/core/renderers/webgl/shaders/effects/GrayscaleEffect.js +3 -3
  93. package/dist/src/core/renderers/webgl/shaders/effects/HolePunchEffect.js +22 -22
  94. package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js +28 -28
  95. package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js +10 -10
  96. package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js +37 -37
  97. package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js +19 -19
  98. package/dist/src/core/scene/Scene.d.ts +59 -0
  99. package/dist/src/core/scene/Scene.js +106 -0
  100. package/dist/src/core/scene/Scene.js.map +1 -0
  101. package/dist/src/core/shaders/webgl/Border.js +59 -59
  102. package/dist/src/core/shaders/webgl/Default.js +47 -47
  103. package/dist/src/core/shaders/webgl/DefaultBatched.js +61 -61
  104. package/dist/src/core/shaders/webgl/HolePunch.js +32 -32
  105. package/dist/src/core/shaders/webgl/LinearGradient.js +36 -36
  106. package/dist/src/core/shaders/webgl/RadialGradient.js +33 -33
  107. package/dist/src/core/shaders/webgl/Rounded.js +71 -71
  108. package/dist/src/core/shaders/webgl/RoundedWithBorder.js +66 -66
  109. package/dist/src/core/shaders/webgl/RoundedWithBorderAndShadow.js +79 -79
  110. package/dist/src/core/shaders/webgl/RoundedWithShadow.js +54 -54
  111. package/dist/src/core/shaders/webgl/SdfShader.js +62 -62
  112. package/dist/src/core/shaders/webgl/Shadow.js +83 -83
  113. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.d.ts +20 -0
  114. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.js +55 -0
  115. package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/makeRenderWindow.js.map +1 -0
  116. package/dist/src/main-api/ICoreDriver.d.ts +27 -0
  117. package/dist/src/main-api/ICoreDriver.js +20 -0
  118. package/dist/src/main-api/ICoreDriver.js.map +1 -0
  119. package/dist/src/main-api/IRenderDriver.d.ts +20 -0
  120. package/dist/src/main-api/IRenderDriver.js +20 -0
  121. package/dist/src/main-api/IRenderDriver.js.map +1 -0
  122. package/dist/src/main-api/IShaderController.d.ts +14 -0
  123. package/dist/src/main-api/IShaderController.js +30 -0
  124. package/dist/src/main-api/IShaderController.js.map +1 -0
  125. package/dist/src/main-api/IShaderNode.d.ts +17 -0
  126. package/dist/src/main-api/IShaderNode.js +19 -0
  127. package/dist/src/main-api/IShaderNode.js.map +1 -0
  128. package/dist/src/main-api/RendererMain.d.ts +375 -0
  129. package/dist/src/main-api/RendererMain.js +365 -0
  130. package/dist/src/main-api/RendererMain.js.map +1 -0
  131. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.d.ts +9 -0
  132. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js +38 -0
  133. package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js.map +1 -0
  134. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.d.ts +56 -0
  135. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js +101 -0
  136. package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js.map +1 -0
  137. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.d.ts +32 -0
  138. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js +28 -0
  139. package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js.map +1 -0
  140. package/dist/src/render-drivers/main/MainCoreDriver.d.ts +24 -0
  141. package/dist/src/render-drivers/main/MainCoreDriver.js +118 -0
  142. package/dist/src/render-drivers/main/MainCoreDriver.js.map +1 -0
  143. package/dist/src/render-drivers/main/MainOnlyNode.d.ts +99 -0
  144. package/dist/src/render-drivers/main/MainOnlyNode.js +396 -0
  145. package/dist/src/render-drivers/main/MainOnlyNode.js.map +1 -0
  146. package/dist/src/render-drivers/main/MainOnlyShaderController.d.ts +6 -0
  147. package/dist/src/render-drivers/main/MainOnlyShaderController.js +15 -0
  148. package/dist/src/render-drivers/main/MainOnlyShaderController.js.map +1 -0
  149. package/dist/src/render-drivers/main/MainOnlyShaderNode.d.ts +7 -0
  150. package/dist/src/render-drivers/main/MainOnlyShaderNode.js +34 -0
  151. package/dist/src/render-drivers/main/MainOnlyShaderNode.js.map +1 -0
  152. package/dist/src/render-drivers/main/MainOnlyTextNode.d.ts +47 -0
  153. package/dist/src/render-drivers/main/MainOnlyTextNode.js +205 -0
  154. package/dist/src/render-drivers/main/MainOnlyTextNode.js.map +1 -0
  155. package/dist/src/render-drivers/main/MainRenderDriver.d.ts +17 -0
  156. package/dist/src/render-drivers/main/MainRenderDriver.js +88 -0
  157. package/dist/src/render-drivers/main/MainRenderDriver.js.map +1 -0
  158. package/dist/src/render-drivers/threadx/NodeStruct.d.ts +90 -0
  159. package/dist/src/render-drivers/threadx/NodeStruct.js +281 -0
  160. package/dist/src/render-drivers/threadx/NodeStruct.js.map +1 -0
  161. package/dist/src/render-drivers/threadx/SharedNode.d.ts +39 -0
  162. package/dist/src/render-drivers/threadx/SharedNode.js +60 -0
  163. package/dist/src/render-drivers/threadx/SharedNode.js.map +1 -0
  164. package/dist/src/render-drivers/threadx/TextNodeStruct.d.ts +44 -0
  165. package/dist/src/render-drivers/threadx/TextNodeStruct.js +201 -0
  166. package/dist/src/render-drivers/threadx/TextNodeStruct.js.map +1 -0
  167. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.d.ts +28 -0
  168. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js +234 -0
  169. package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js.map +1 -0
  170. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.d.ts +20 -0
  171. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js +84 -0
  172. package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js.map +1 -0
  173. package/dist/src/render-drivers/threadx/ThreadXMainNode.d.ts +44 -0
  174. package/dist/src/render-drivers/threadx/ThreadXMainNode.js +154 -0
  175. package/dist/src/render-drivers/threadx/ThreadXMainNode.js.map +1 -0
  176. package/dist/src/render-drivers/threadx/ThreadXMainShaderController.d.ts +6 -0
  177. package/dist/src/render-drivers/threadx/ThreadXMainShaderController.js +16 -0
  178. package/dist/src/render-drivers/threadx/ThreadXMainShaderController.js.map +1 -0
  179. package/dist/src/render-drivers/threadx/ThreadXMainShaderNode.d.ts +7 -0
  180. package/dist/src/render-drivers/threadx/ThreadXMainShaderNode.js +15 -0
  181. package/dist/src/render-drivers/threadx/ThreadXMainShaderNode.js.map +1 -0
  182. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.d.ts +28 -0
  183. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js +55 -0
  184. package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js.map +1 -0
  185. package/dist/src/render-drivers/threadx/ThreadXRenderDriver.d.ts +21 -0
  186. package/dist/src/render-drivers/threadx/ThreadXRenderDriver.js +198 -0
  187. package/dist/src/render-drivers/threadx/ThreadXRenderDriver.js.map +1 -0
  188. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.d.ts +70 -0
  189. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js +32 -0
  190. package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js.map +1 -0
  191. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.d.ts +19 -0
  192. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js +177 -0
  193. package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js.map +1 -0
  194. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.d.ts +27 -0
  195. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js +108 -0
  196. package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js.map +1 -0
  197. package/dist/src/render-drivers/threadx/worker/renderer.d.ts +1 -0
  198. package/dist/src/render-drivers/threadx/worker/renderer.js +145 -0
  199. package/dist/src/render-drivers/threadx/worker/renderer.js.map +1 -0
  200. package/dist/src/render-drivers/utils.d.ts +12 -0
  201. package/dist/src/render-drivers/utils.js +69 -0
  202. package/dist/src/render-drivers/utils.js.map +1 -0
  203. package/dist/tsconfig.dist.tsbuildinfo +1 -1
  204. package/exports/canvas-shaders.ts +28 -28
  205. package/exports/canvas.ts +45 -45
  206. package/exports/index.ts +90 -90
  207. package/exports/inspector.ts +24 -24
  208. package/exports/utils.ts +44 -44
  209. package/exports/webgl-shaders.ts +28 -28
  210. package/exports/webgl.ts +50 -50
  211. package/package.json +2 -1
  212. package/scripts/please-use-pnpm.js +13 -13
  213. package/src/common/CommonTypes.ts +146 -146
  214. package/src/common/EventEmitter.ts +77 -77
  215. package/src/common/IAnimationController.ts +92 -92
  216. package/src/common/IEventEmitter.ts +28 -28
  217. package/src/core/CoreNode.test.ts +203 -203
  218. package/src/core/CoreNode.ts +2494 -2494
  219. package/src/core/CoreShaderManager.ts +188 -188
  220. package/src/core/CoreTextNode.ts +449 -448
  221. package/src/core/CoreTextureManager.ts +601 -601
  222. package/src/core/Stage.ts +754 -754
  223. package/src/core/TextureMemoryManager.ts +395 -395
  224. package/src/core/animations/AnimationManager.ts +38 -38
  225. package/src/core/animations/CoreAnimation.ts +284 -284
  226. package/src/core/animations/CoreAnimationController.ts +157 -157
  227. package/src/core/lib/ContextSpy.ts +41 -41
  228. package/src/core/lib/ImageWorker.ts +280 -280
  229. package/src/core/lib/Matrix3d.ts +244 -244
  230. package/src/core/lib/RenderCoords.ts +71 -71
  231. package/src/core/lib/WebGlContextWrapper.ts +1374 -1374
  232. package/src/core/lib/textureCompression.ts +152 -152
  233. package/src/core/lib/textureSvg.ts +78 -78
  234. package/src/core/lib/utils.ts +386 -386
  235. package/src/core/lib/validateImageBitmap.ts +87 -87
  236. package/src/core/platform.ts +64 -64
  237. package/src/core/platforms/Platform.ts +77 -77
  238. package/src/core/platforms/web/WebPlatform.ts +84 -84
  239. package/src/core/renderers/CoreContextTexture.ts +43 -43
  240. package/src/core/renderers/CoreRenderOp.ts +22 -22
  241. package/src/core/renderers/CoreRenderer.ts +109 -109
  242. package/src/core/renderers/CoreShaderNode.ts +165 -165
  243. package/src/core/renderers/CoreShaderProgram.ts +23 -23
  244. package/src/core/renderers/canvas/CanvasRenderer.ts +298 -298
  245. package/src/core/renderers/canvas/CanvasShaderNode.ts +99 -99
  246. package/src/core/renderers/canvas/CanvasTexture.ts +156 -156
  247. package/src/core/renderers/canvas/internal/C2DShaderUtils.ts +220 -220
  248. package/src/core/renderers/canvas/internal/ColorUtils.ts +85 -85
  249. package/src/core/renderers/webgl/WebGlCtxRenderTexture.ts +86 -86
  250. package/src/core/renderers/webgl/WebGlCtxSubTexture.ts +50 -50
  251. package/src/core/renderers/webgl/WebGlCtxTexture.ts +301 -301
  252. package/src/core/renderers/webgl/WebGlRenderOp.ts +161 -161
  253. package/src/core/renderers/webgl/WebGlRenderer.ts +750 -750
  254. package/src/core/renderers/webgl/WebGlShaderNode.ts +437 -437
  255. package/src/core/renderers/webgl/WebGlShaderProgram.ts +318 -318
  256. package/src/core/renderers/webgl/internal/BufferCollection.ts +54 -54
  257. package/src/core/renderers/webgl/internal/RendererUtils.ts +155 -155
  258. package/src/core/renderers/webgl/internal/ShaderUtils.ts +281 -281
  259. package/src/core/renderers/webgl/internal/WebGlUtils.ts +35 -35
  260. package/src/core/shaders/canvas/Border.ts +78 -78
  261. package/src/core/shaders/canvas/HolePunch.ts +62 -62
  262. package/src/core/shaders/canvas/LinearGradient.ts +69 -69
  263. package/src/core/shaders/canvas/RadialGradient.ts +113 -113
  264. package/src/core/shaders/canvas/Rounded.ts +55 -55
  265. package/src/core/shaders/canvas/RoundedWithBorder.ts +68 -68
  266. package/src/core/shaders/canvas/RoundedWithBorderAndShadow.ts +88 -88
  267. package/src/core/shaders/canvas/RoundedWithShadow.ts +69 -69
  268. package/src/core/shaders/canvas/Shadow.ts +52 -52
  269. package/src/core/shaders/canvas/utils/render.ts +151 -151
  270. package/src/core/shaders/templates/BorderTemplate.ts +115 -115
  271. package/src/core/shaders/templates/HolePunchTemplate.ts +82 -82
  272. package/src/core/shaders/templates/LinearGradientTemplate.ts +71 -71
  273. package/src/core/shaders/templates/RadialGradientTemplate.ts +81 -81
  274. package/src/core/shaders/templates/RoundedTemplate.ts +98 -98
  275. package/src/core/shaders/templates/RoundedWithBorderAndShadowTemplate.ts +38 -38
  276. package/src/core/shaders/templates/RoundedWithBorderTemplate.ts +35 -35
  277. package/src/core/shaders/templates/RoundedWithShadowTemplate.ts +35 -35
  278. package/src/core/shaders/templates/ShadowTemplate.ts +106 -106
  279. package/src/core/shaders/templates/shaderUtils.ts +47 -47
  280. package/src/core/shaders/webgl/Border.ts +96 -96
  281. package/src/core/shaders/webgl/Default.ts +89 -89
  282. package/src/core/shaders/webgl/DefaultBatched.ts +129 -129
  283. package/src/core/shaders/webgl/HolePunch.ts +78 -78
  284. package/src/core/shaders/webgl/LinearGradient.ts +81 -81
  285. package/src/core/shaders/webgl/RadialGradient.ts +84 -84
  286. package/src/core/shaders/webgl/Rounded.ts +117 -117
  287. package/src/core/shaders/webgl/RoundedWithBorder.ts +114 -114
  288. package/src/core/shaders/webgl/RoundedWithBorderAndShadow.ts +133 -133
  289. package/src/core/shaders/webgl/RoundedWithShadow.ts +98 -98
  290. package/src/core/shaders/webgl/SdfShader.ts +134 -134
  291. package/src/core/shaders/webgl/Shadow.ts +115 -115
  292. package/src/core/text-rendering/TextRenderingUtils.ts +36 -36
  293. package/src/core/text-rendering/TextTextureRendererUtils.ts +263 -263
  294. package/src/core/text-rendering/TrFontManager.ts +183 -183
  295. package/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts +176 -176
  296. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/FontShaper.ts +139 -139
  297. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.test.ts +173 -173
  298. package/src/core/text-rendering/font-face-types/SdfTrFontFace/internal/SdfFontShaper.ts +171 -171
  299. package/src/core/text-rendering/font-face-types/TrFontFace.ts +187 -187
  300. package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +94 -94
  301. package/src/core/text-rendering/font-face-types/utils.ts +39 -39
  302. package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +514 -514
  303. package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts +863 -863
  304. package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +846 -846
  305. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.test.ts +48 -48
  306. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/PeekableGenerator.ts +66 -66
  307. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/SpecialCodepoints.ts +52 -52
  308. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/constants.ts +32 -32
  309. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getStartConditions.ts +117 -117
  310. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.test.ts +133 -133
  311. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/getUnicodeCodepoints.ts +38 -38
  312. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.ts +497 -497
  313. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.test.ts +49 -49
  314. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/measureText.ts +52 -52
  315. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.test.ts +205 -205
  316. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/setRenderWindow.ts +93 -93
  317. package/src/core/text-rendering/renderers/SdfTextRenderer/internal/util.ts +40 -40
  318. package/src/core/text-rendering/renderers/TextRenderer.ts +567 -567
  319. package/src/core/textures/ColorTexture.ts +102 -102
  320. package/src/core/textures/ImageTexture.ts +410 -410
  321. package/src/core/textures/NoiseTexture.ts +104 -104
  322. package/src/core/textures/RenderTexture.ts +85 -85
  323. package/src/core/textures/SubTexture.ts +205 -205
  324. package/src/core/textures/Texture.ts +358 -358
  325. package/src/core/utils.ts +227 -227
  326. package/src/env.d.ts +7 -7
  327. package/src/main-api/INode.ts +100 -100
  328. package/src/main-api/Inspector.ts +522 -522
  329. package/src/main-api/Renderer.ts +675 -675
  330. package/src/main-api/utils.ts +45 -45
  331. package/src/utils.ts +267 -267
  332. package/COPYING +0 -1
  333. package/dist/src/core/temp.js +0 -77
  334. package/dist/src/core/temp.js.map +0 -1
  335. /package/dist/src/core/{temp.d.ts → CoreStuff.d.ts} +0 -0
@@ -1,2494 +1,2494 @@
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 {
21
- assertTruthy,
22
- getNewId,
23
- isProductionEnvironment,
24
- mergeColorAlphaPremultiplied,
25
- } from '../utils.js';
26
- import type { TextureOptions } from './CoreTextureManager.js';
27
- import type { CoreRenderer } from './renderers/CoreRenderer.js';
28
- import type { Stage } from './Stage.js';
29
- import {
30
- type Texture,
31
- type TextureCoords,
32
- type TextureFailedEventHandler,
33
- type TextureFreedEventHandler,
34
- type TextureLoadedEventHandler,
35
- } from './textures/Texture.js';
36
- import type {
37
- Dimensions,
38
- NodeTextureFailedPayload,
39
- NodeTextureFreedPayload,
40
- NodeTextureLoadedPayload,
41
- } from '../common/CommonTypes.js';
42
- import { EventEmitter } from '../common/EventEmitter.js';
43
- import {
44
- copyRect,
45
- intersectRect,
46
- type Bound,
47
- type RectWithValid,
48
- createBound,
49
- boundInsideBound,
50
- boundLargeThanBound,
51
- createPreloadBounds,
52
- } from './lib/utils.js';
53
- import { Matrix3d } from './lib/Matrix3d.js';
54
- import { RenderCoords } from './lib/RenderCoords.js';
55
- import type { AnimationSettings } from './animations/CoreAnimation.js';
56
- import type { IAnimationController } from '../common/IAnimationController.js';
57
- import { CoreAnimation } from './animations/CoreAnimation.js';
58
- import { CoreAnimationController } from './animations/CoreAnimationController.js';
59
- import type { CoreShaderNode } from './renderers/CoreShaderNode.js';
60
-
61
- export enum CoreNodeRenderState {
62
- Init = 0,
63
- OutOfBounds = 2,
64
- InBounds = 4,
65
- InViewport = 8,
66
- }
67
-
68
- const CoreNodeRenderStateMap: Map<CoreNodeRenderState, string> = new Map();
69
- CoreNodeRenderStateMap.set(CoreNodeRenderState.Init, 'init');
70
- CoreNodeRenderStateMap.set(CoreNodeRenderState.OutOfBounds, 'outOfBounds');
71
- CoreNodeRenderStateMap.set(CoreNodeRenderState.InBounds, 'inBounds');
72
- CoreNodeRenderStateMap.set(CoreNodeRenderState.InViewport, 'inViewport');
73
-
74
- export enum UpdateType {
75
- /**
76
- * Child updates
77
- */
78
- Children = 1,
79
-
80
- /**
81
- * Scale/Rotate transform update
82
- *
83
- * @remarks
84
- * CoreNode Properties Updated:
85
- * - `scaleRotateTransform`
86
- */
87
- ScaleRotate = 2,
88
-
89
- /**
90
- * Translate transform update (x/y/width/height/pivot/mount)
91
- *
92
- * @remarks
93
- * CoreNode Properties Updated:
94
- * - `localTransform`
95
- */
96
- Local = 4,
97
-
98
- /**
99
- * Global Transform update
100
- *
101
- * @remarks
102
- * CoreNode Properties Updated:
103
- * - `globalTransform`
104
- * - `renderCoords`
105
- * - `renderBound`
106
- */
107
- Global = 8,
108
-
109
- /**
110
- * Clipping rect update
111
- *
112
- * @remarks
113
- * CoreNode Properties Updated:
114
- * - `clippingRect`
115
- */
116
- Clipping = 16,
117
-
118
- /**
119
- * Calculated ZIndex update
120
- *
121
- * @remarks
122
- * CoreNode Properties Updated:
123
- * - `calcZIndex`
124
- */
125
- CalculatedZIndex = 32,
126
-
127
- /**
128
- * Z-Index Sorted Children update
129
- *
130
- * @remarks
131
- * CoreNode Properties Updated:
132
- * - `children` (sorts children by their `calcZIndex`)
133
- */
134
- ZIndexSortedChildren = 64,
135
-
136
- /**
137
- * Premultiplied Colors update
138
- *
139
- * @remarks
140
- * CoreNode Properties Updated:
141
- * - `premultipliedColorTl`
142
- * - `premultipliedColorTr`
143
- * - `premultipliedColorBl`
144
- * - `premultipliedColorBr`
145
- */
146
- PremultipliedColors = 128,
147
-
148
- /**
149
- * World Alpha update
150
- *
151
- * @remarks
152
- * CoreNode Properties Updated:
153
- * - `worldAlpha` = `parent.worldAlpha` * `alpha`
154
- */
155
- WorldAlpha = 256,
156
-
157
- /**
158
- * Render State update
159
- *
160
- * @remarks
161
- * CoreNode Properties Updated:
162
- * - `renderState`
163
- */
164
- RenderState = 512,
165
-
166
- /**
167
- * Is Renderable update
168
- *
169
- * @remarks
170
- * CoreNode Properties Updated:
171
- * - `isRenderable`
172
- */
173
- IsRenderable = 1024,
174
-
175
- /**
176
- * Render Texture update
177
- */
178
- RenderTexture = 2048,
179
-
180
- /**
181
- * Track if parent has render texture
182
- */
183
- ParentRenderTexture = 4096,
184
-
185
- /**
186
- * Render Bounds update
187
- */
188
- RenderBounds = 8192,
189
-
190
- /**
191
- * None
192
- */
193
- None = 0,
194
-
195
- /**
196
- * All
197
- */
198
- All = 14335,
199
-
200
- /**
201
- * RecalcUniforms
202
- */
203
- RecalcUniforms = 16384,
204
- }
205
-
206
- /**
207
- * A custom data map which can be stored on an CoreNode
208
- *
209
- * @remarks
210
- * This is a map of key-value pairs that can be stored on an INode. It is used
211
- * to store custom data that can be used by the application.
212
- * The data stored can only be of type string, number or boolean.
213
- */
214
- export type CustomDataMap = {
215
- [key: string]: string | number | boolean | undefined;
216
- };
217
-
218
- /**
219
- * Writable properties of a Node.
220
- */
221
- export interface CoreNodeProps {
222
- /**
223
- * The x coordinate of the Node's Mount Point.
224
- *
225
- * @remarks
226
- * See {@link mountX} and {@link mountY} for more information about setting
227
- * the Mount Point.
228
- *
229
- * @default `0`
230
- */
231
- x: number;
232
- /**
233
- * The y coordinate of the Node's Mount Point.
234
- *
235
- * @remarks
236
- * See {@link mountX} and {@link mountY} for more information about setting
237
- * the Mount Point.
238
- *
239
- * @default `0`
240
- */
241
- y: number;
242
- /**
243
- * The width of the Node.
244
- *
245
- * @default `0`
246
- */
247
- width: number;
248
- /**
249
- * The height of the Node.
250
- *
251
- * @default `0`
252
- */
253
- height: number;
254
- /**
255
- * The alpha opacity of the Node.
256
- *
257
- * @remarks
258
- * The alpha value is a number between 0 and 1, where 0 is fully transparent
259
- * and 1 is fully opaque.
260
- *
261
- * @default `1`
262
- */
263
- alpha: number;
264
- /**
265
- * Autosize mode
266
- *
267
- * @remarks
268
- * When enabled, when a texture is loaded into the Node, the Node will
269
- * automatically resize to the dimensions of the texture.
270
- *
271
- * Text Nodes are always autosized based on their text content regardless
272
- * of this mode setting.
273
- *
274
- * @default `false`
275
- */
276
- autosize: boolean;
277
- /**
278
- * Margin around the Node's bounds for preloading
279
- *
280
- * @default `null`
281
- */
282
- boundsMargin: number | [number, number, number, number] | null;
283
- /**
284
- * Clipping Mode
285
- *
286
- * @remarks
287
- * Enable Clipping Mode when you want to prevent the drawing of a Node and
288
- * its descendants from overflowing outside of the Node's x/y/width/height
289
- * bounds.
290
- *
291
- * For WebGL, clipping is implemented using the high-performance WebGL
292
- * operation scissor. As a consequence, clipping does not work for
293
- * non-rectangular areas. So, if the element is rotated
294
- * (by itself or by any of its ancestors), clipping will not work as intended.
295
- *
296
- * TODO: Add support for non-rectangular clipping either automatically or
297
- * via Render-To-Texture.
298
- *
299
- * @default `false`
300
- */
301
- clipping: boolean;
302
- /**
303
- * The color of the Node.
304
- *
305
- * @remarks
306
- * The color value is a number in the format 0xRRGGBBAA, where RR is the red
307
- * component, GG is the green component, BB is the blue component, and AA is
308
- * the alpha component.
309
- *
310
- * Gradient colors may be set by setting the different color sub-properties:
311
- * {@link colorTop}, {@link colorBottom}, {@link colorLeft}, {@link colorRight},
312
- * {@link colorTl}, {@link colorTr}, {@link colorBr}, {@link colorBl} accordingly.
313
- *
314
- * @default `0xffffffff` (opaque white)
315
- */
316
- color: number;
317
- /**
318
- * The color of the top edge of the Node for gradient rendering.
319
- *
320
- * @remarks
321
- * See {@link color} for more information about color values and gradient
322
- * rendering.
323
- */
324
- colorTop: number;
325
- /**
326
- * The color of the bottom edge of the Node for gradient rendering.
327
- *
328
- * @remarks
329
- * See {@link color} for more information about color values and gradient
330
- * rendering.
331
- */
332
- colorBottom: number;
333
- /**
334
- * The color of the left edge of the Node for gradient rendering.
335
- *
336
- * @remarks
337
- * See {@link color} for more information about color values and gradient
338
- * rendering.
339
- */
340
- colorLeft: number;
341
- /**
342
- * The color of the right edge of the Node for gradient rendering.
343
- *
344
- * @remarks
345
- * See {@link color} for more information about color values and gradient
346
- * rendering.
347
- */
348
- colorRight: number;
349
- /**
350
- * The color of the top-left corner of the Node for gradient rendering.
351
- *
352
- * @remarks
353
- * See {@link color} for more information about color values and gradient
354
- * rendering.
355
- */
356
- colorTl: number;
357
- /**
358
- * The color of the top-right corner of the Node for gradient rendering.
359
- *
360
- * @remarks
361
- * See {@link color} for more information about color values and gradient
362
- * rendering.
363
- */
364
- colorTr: number;
365
- /**
366
- * The color of the bottom-right corner of the Node for gradient rendering.
367
- *
368
- * @remarks
369
- * See {@link color} for more information about color values and gradient
370
- * rendering.
371
- */
372
- colorBr: number;
373
- /**
374
- * The color of the bottom-left corner of the Node for gradient rendering.
375
- *
376
- * @remarks
377
- * See {@link color} for more information about color values and gradient
378
- * rendering.
379
- */
380
- colorBl: number;
381
- /**
382
- * The Node's parent Node.
383
- *
384
- * @remarks
385
- * The value `null` indicates that the Node has no parent. This may either be
386
- * because the Node is the root Node of the scene graph, or because the Node
387
- * has been removed from the scene graph.
388
- *
389
- * In order to make sure that a Node can be rendered on the screen, it must
390
- * be added to the scene graph by setting it's parent property to a Node that
391
- * is already in the scene graph such as the root Node.
392
- *
393
- * @default `null`
394
- */
395
- parent: CoreNode | null;
396
- /**
397
- * The Node's z-index.
398
- *
399
- * @remarks
400
- * TBD
401
- */
402
- zIndex: number;
403
- /**
404
- * The Node's Texture.
405
- *
406
- * @remarks
407
- * The `texture` defines a rasterized image that is contained within the
408
- * {@link width} and {@link height} dimensions of the Node. If null, the
409
- * Node will use an opaque white {@link ColorTexture} when being drawn, which
410
- * essentially enables colors (including gradients) to be drawn.
411
- *
412
- * If set, by default, the texture will be drawn, as is, stretched to the
413
- * dimensions of the Node. This behavior can be modified by setting the TBD
414
- * and TBD properties.
415
- *
416
- * To create a Texture in order to set it on this property, call
417
- * {@link RendererMain.createTexture}.
418
- *
419
- * If the {@link src} is set on a Node, the Node will use the
420
- * {@link ImageTexture} by default and the Node will simply load the image at
421
- * the specified URL.
422
- *
423
- * Note: If this is a Text Node, the Texture will be managed by the Node's
424
- * {@link TextRenderer} and should not be set explicitly.
425
- */
426
- texture: Texture | null;
427
-
428
- /**
429
- * [Deprecated]: Prevents the texture from being cleaned up when the Node is removed
430
- *
431
- * @remarks
432
- * Please use the `preventCleanup` property on {@link TextureOptions} instead.
433
- *
434
- * @default false
435
- */
436
- preventCleanup: boolean;
437
- /**
438
- * Options to associate with the Node's Texture
439
- */
440
- textureOptions: TextureOptions;
441
-
442
- /**
443
- * The Node's shader
444
- *
445
- * @remarks
446
- * The `shader` defines a {@link Shader} used to draw the Node. By default,
447
- * the Default Shader is used which simply draws the defined {@link texture}
448
- * or {@link color}(s) within the Node without any special effects.
449
- *
450
- * To create a Shader in order to set it on this property, call
451
- * {@link RendererMain.createShader}.
452
- *
453
- * Note: If this is a Text Node, the Shader will be managed by the Node's
454
- * {@link TextRenderer} and should not be set explicitly.
455
- */
456
- shader: CoreShaderNode<any> | null;
457
- /**
458
- * Image URL
459
- *
460
- * @remarks
461
- * When set, the Node's {@link texture} is automatically set to an
462
- * {@link ImageTexture} using the source image URL provided (with all other
463
- * settings being defaults)
464
- */
465
- src: string | null;
466
- zIndexLocked: number;
467
- /**
468
- * Scale to render the Node at
469
- *
470
- * @remarks
471
- * The scale value multiplies the provided {@link width} and {@link height}
472
- * of the Node around the Node's Pivot Point (defined by the {@link pivot}
473
- * props).
474
- *
475
- * Behind the scenes, setting this property sets both the {@link scaleX} and
476
- * {@link scaleY} props to the same value.
477
- *
478
- * NOTE: When the scaleX and scaleY props are explicitly set to different values,
479
- * this property returns `null`. Setting `null` on this property will have no
480
- * effect.
481
- *
482
- * @default 1.0
483
- */
484
- scale: number | null;
485
- /**
486
- * Scale to render the Node at (X-Axis)
487
- *
488
- * @remarks
489
- * The scaleX value multiplies the provided {@link width} of the Node around
490
- * the Node's Pivot Point (defined by the {@link pivot} props).
491
- *
492
- * @default 1.0
493
- */
494
- scaleX: number;
495
- /**
496
- * Scale to render the Node at (Y-Axis)
497
- *
498
- * @remarks
499
- * The scaleY value multiplies the provided {@link height} of the Node around
500
- * the Node's Pivot Point (defined by the {@link pivot} props).
501
- *
502
- * @default 1.0
503
- */
504
- scaleY: number;
505
- /**
506
- * Combined position of the Node's Mount Point
507
- *
508
- * @remarks
509
- * The value can be any number between `0.0` and `1.0`:
510
- * - `0.0` defines the Mount Point at the top-left corner of the Node.
511
- * - `0.5` defines it at the center of the Node.
512
- * - `1.0` defines it at the bottom-right corner of the node.
513
- *
514
- * Use the {@link mountX} and {@link mountY} props seperately for more control
515
- * of the Mount Point.
516
- *
517
- * When assigned, the same value is also passed to both the {@link mountX} and
518
- * {@link mountY} props.
519
- *
520
- * @default 0 (top-left)
521
- */
522
- mount: number;
523
- /**
524
- * X position of the Node's Mount Point
525
- *
526
- * @remarks
527
- * The value can be any number between `0.0` and `1.0`:
528
- * - `0.0` defines the Mount Point's X position as the left-most edge of the
529
- * Node
530
- * - `0.5` defines it as the horizontal center of the Node
531
- * - `1.0` defines it as the right-most edge of the Node.
532
- *
533
- * The combination of {@link mountX} and {@link mountY} define the Mount Point
534
- *
535
- * @default 0 (left-most edge)
536
- */
537
- mountX: number;
538
- /**
539
- * Y position of the Node's Mount Point
540
- *
541
- * @remarks
542
- * The value can be any number between `0.0` and `1.0`:
543
- * - `0.0` defines the Mount Point's Y position as the top-most edge of the
544
- * Node
545
- * - `0.5` defines it as the vertical center of the Node
546
- * - `1.0` defines it as the bottom-most edge of the Node.
547
- *
548
- * The combination of {@link mountX} and {@link mountY} define the Mount Point
549
- *
550
- * @default 0 (top-most edge)
551
- */
552
- mountY: number;
553
- /**
554
- * Combined position of the Node's Pivot Point
555
- *
556
- * @remarks
557
- * The value can be any number between `0.0` and `1.0`:
558
- * - `0.0` defines the Pivot Point at the top-left corner of the Node.
559
- * - `0.5` defines it at the center of the Node.
560
- * - `1.0` defines it at the bottom-right corner of the node.
561
- *
562
- * Use the {@link pivotX} and {@link pivotY} props seperately for more control
563
- * of the Pivot Point.
564
- *
565
- * When assigned, the same value is also passed to both the {@link pivotX} and
566
- * {@link pivotY} props.
567
- *
568
- * @default 0.5 (center)
569
- */
570
- pivot: number;
571
- /**
572
- * X position of the Node's Pivot Point
573
- *
574
- * @remarks
575
- * The value can be any number between `0.0` and `1.0`:
576
- * - `0.0` defines the Pivot Point's X position as the left-most edge of the
577
- * Node
578
- * - `0.5` defines it as the horizontal center of the Node
579
- * - `1.0` defines it as the right-most edge of the Node.
580
- *
581
- * The combination of {@link pivotX} and {@link pivotY} define the Pivot Point
582
- *
583
- * @default 0.5 (centered on x-axis)
584
- */
585
- pivotX: number;
586
- /**
587
- * Y position of the Node's Pivot Point
588
- *
589
- * @remarks
590
- * The value can be any number between `0.0` and `1.0`:
591
- * - `0.0` defines the Pivot Point's Y position as the top-most edge of the
592
- * Node
593
- * - `0.5` defines it as the vertical center of the Node
594
- * - `1.0` defines it as the bottom-most edge of the Node.
595
- *
596
- * The combination of {@link pivotX} and {@link pivotY} define the Pivot Point
597
- *
598
- * @default 0.5 (centered on y-axis)
599
- */
600
- pivotY: number;
601
- /**
602
- * Rotation of the Node (in Radians)
603
- *
604
- * @remarks
605
- * Sets the amount to rotate the Node by around it's Pivot Point (defined by
606
- * the {@link pivot} props). Positive values rotate the Node clockwise, while
607
- * negative values rotate it counter-clockwise.
608
- *
609
- * Example values:
610
- * - `-Math.PI / 2`: 90 degree rotation counter-clockwise
611
- * - `0`: No rotation
612
- * - `Math.PI / 2`: 90 degree rotation clockwise
613
- * - `Math.PI`: 180 degree rotation clockwise
614
- * - `3 * Math.PI / 2`: 270 degree rotation clockwise
615
- * - `2 * Math.PI`: 360 rotation clockwise
616
- */
617
- rotation: number;
618
-
619
- /**
620
- * Whether the Node is rendered to a texture
621
- *
622
- * @remarks
623
- * TBD
624
- *
625
- * @default false
626
- */
627
- rtt: boolean;
628
-
629
- /**
630
- * Node data element for custom data storage (optional)
631
- *
632
- * @remarks
633
- * This property is used to store custom data on the Node as a key/value data store.
634
- * Data values are limited to string, numbers, booleans. Strings will be truncated
635
- * to a 2048 character limit for performance reasons.
636
- *
637
- * This is not a data storage mechanism for large amounts of data please use a
638
- * dedicated data storage mechanism for that.
639
- *
640
- * The custom data will be reflected in the inspector as part of `data-*` attributes
641
- *
642
- * @default `undefined`
643
- */
644
- data?: CustomDataMap;
645
-
646
- /**
647
- * Image Type to explicitly set the image type that is being loaded
648
- *
649
- * @remarks
650
- * This property must be used with a `src` that points at an image. In some cases
651
- * the extension doesn't provide a reliable representation of the image type. In such
652
- * cases set the ImageType explicitly.
653
- *
654
- * `regular` is used for normal images such as png, jpg, etc
655
- * `compressed` is used for ETC1/ETC2 compressed images with a PVR or KTX container
656
- * `svg` is used for scalable vector graphics
657
- *
658
- * @default `undefined`
659
- */
660
- imageType?: 'regular' | 'compressed' | 'svg' | null;
661
-
662
- /**
663
- * She width of the rectangle from which the Image Texture will be extracted.
664
- * This value can be negative. If not provided, the image's source natural
665
- * width will be used.
666
- */
667
- srcWidth?: number;
668
- /**
669
- * The height of the rectangle from which the Image Texture will be extracted.
670
- * This value can be negative. If not provided, the image's source natural
671
- * height will be used.
672
- */
673
- srcHeight?: number;
674
- /**
675
- * The x coordinate of the reference point of the rectangle from which the Texture
676
- * will be extracted. `width` and `height` are provided. And only works when
677
- * createImageBitmap is available. Only works when createImageBitmap is supported on the browser.
678
- */
679
- srcX?: number;
680
- /**
681
- * The y coordinate of the reference point of the rectangle from which the Texture
682
- * will be extracted. Only used when source `srcWidth` width and `srcHeight` height
683
- * are provided. Only works when createImageBitmap is supported on the browser.
684
- */
685
- srcY?: number;
686
- /**
687
- * By enabling Strict bounds the renderer will not process & render child nodes of a node that is out of the visible area
688
- *
689
- * @remarks
690
- * When enabled out of bound nodes, i.e. nodes that are out of the visible area, will
691
- * **NOT** have their children processed and renderer anymore. This means the children of a out of bound
692
- * node will not receive update processing such as positioning updates and will not be drawn on screen.
693
- * As such the rest of the branch of the update tree that sits below this node will not be processed anymore
694
- *
695
- * This is a big performance gain but may be disabled in cases where the width of the parent node is
696
- * unknown and the render must process the child nodes regardless of the viewport status of the parent node
697
- *
698
- * @default false
699
- */
700
- strictBounds: boolean;
701
- }
702
-
703
- /**
704
- * Grab all the number properties of type T
705
- */
706
- type NumberProps<T> = {
707
- [Key in keyof T as NonNullable<T[Key]> extends number ? Key : never]: number;
708
- };
709
-
710
- /**
711
- * Properties of a Node used by the animate() function
712
- */
713
- export interface CoreNodeAnimateProps extends NumberProps<CoreNodeProps> {
714
- /**
715
- * Shader properties to animate
716
- */
717
- shaderProps: Record<string, number>;
718
- // TODO: textureProps: Record<string, number>;
719
- }
720
-
721
- /**
722
- * A visual Node in the Renderer scene graph.
723
- *
724
- * @remarks
725
- * CoreNode is an internally used class that represents a Renderer Node in the
726
- * scene graph. See INode.ts for the public APIs exposed to Renderer users
727
- * that include generic types for Shaders.
728
- */
729
- export class CoreNode extends EventEmitter {
730
- readonly children: CoreNode[] = [];
731
- protected _id: number = getNewId();
732
- readonly props: CoreNodeProps;
733
-
734
- private hasShaderUpdater = false;
735
- public updateType = UpdateType.All;
736
- public childUpdateType = UpdateType.None;
737
-
738
- public globalTransform?: Matrix3d;
739
- public scaleRotateTransform?: Matrix3d;
740
- public localTransform?: Matrix3d;
741
- public sceneGlobalTransform?: Matrix3d;
742
- public renderCoords?: RenderCoords;
743
- public sceneRenderCoords?: RenderCoords;
744
- public renderBound?: Bound;
745
- public strictBound?: Bound;
746
- public preloadBound?: Bound;
747
- public clippingRect: RectWithValid = {
748
- x: 0,
749
- y: 0,
750
- width: 0,
751
- height: 0,
752
- valid: false,
753
- };
754
- public textureCoords?: TextureCoords;
755
- public updateTextureCoords?: boolean = false;
756
- public isRenderable = false;
757
- public renderState: CoreNodeRenderState = CoreNodeRenderState.Init;
758
-
759
- public worldAlpha = 1;
760
- public premultipliedColorTl = 0;
761
- public premultipliedColorTr = 0;
762
- public premultipliedColorBl = 0;
763
- public premultipliedColorBr = 0;
764
- public calcZIndex = 0;
765
- public hasRTTupdates = false;
766
- public parentHasRenderTexture = false;
767
- public rttParent: CoreNode | null = null;
768
-
769
- constructor(readonly stage: Stage, props: CoreNodeProps) {
770
- super();
771
-
772
- this.props = {
773
- ...props,
774
- parent: null,
775
- texture: null,
776
- shader: null,
777
- src: null,
778
- rtt: false,
779
- };
780
-
781
- // Assign props to instances
782
- this.parent = props.parent;
783
- this.texture = props.texture;
784
- this.shader = props.shader;
785
- this.src = props.src;
786
- this.rtt = props.rtt;
787
-
788
- if (props.boundsMargin) {
789
- this.boundsMargin = Array.isArray(props.boundsMargin)
790
- ? props.boundsMargin
791
- : [
792
- props.boundsMargin,
793
- props.boundsMargin,
794
- props.boundsMargin,
795
- props.boundsMargin,
796
- ];
797
- }
798
-
799
- this.setUpdateType(
800
- UpdateType.ScaleRotate |
801
- UpdateType.Local |
802
- UpdateType.RenderBounds |
803
- UpdateType.RenderState,
804
- );
805
-
806
- if (isProductionEnvironment() === false && props.preventCleanup === true) {
807
- console.warn(
808
- 'CoreNode.preventCleanup: Is deprecated and will be removed in upcoming release, please use textureOptions.preventCleanup instead',
809
- );
810
- }
811
-
812
- // if the default texture isn't loaded yet, wait for it to load
813
- // this only happens when the node is created before the stage is ready
814
- if (
815
- this.stage.defaultTexture &&
816
- this.stage.defaultTexture.state !== 'loaded'
817
- ) {
818
- this.stage.defaultTexture.once('loaded', () => {
819
- this.setUpdateType(UpdateType.IsRenderable);
820
- });
821
- }
822
- }
823
-
824
- //#region Textures
825
- loadTexture(): void {
826
- const { texture } = this.props;
827
- assertTruthy(texture);
828
-
829
- // If texture is already loaded / failed, trigger loaded event manually
830
- // so that users get a consistent event experience.
831
- // We do this in a microtask to allow listeners to be attached in the same
832
- // synchronous task after calling loadTexture()
833
- queueMicrotask(() => {
834
- if (this.textureOptions.preload === true) {
835
- this.stage.txManager.loadTexture(texture);
836
- }
837
-
838
- texture.preventCleanup =
839
- this.props.textureOptions?.preventCleanup ?? false;
840
- texture.on('loaded', this.onTextureLoaded);
841
- texture.on('failed', this.onTextureFailed);
842
- texture.on('freed', this.onTextureFreed);
843
-
844
- // If the parent is a render texture, the initial texture status
845
- // will be set to freed until the texture is processed by the
846
- // Render RTT nodes. So we only need to listen fo changes and
847
- // no need to check the texture.state until we restructure how
848
- // textures are being processed.
849
- if (this.parentHasRenderTexture) {
850
- this.notifyParentRTTOfUpdate();
851
- return;
852
- }
853
-
854
- if (texture.state === 'loaded') {
855
- assertTruthy(texture.dimensions);
856
- this.onTextureLoaded(texture, texture.dimensions);
857
- } else if (texture.state === 'failed') {
858
- assertTruthy(texture.error);
859
- this.onTextureFailed(texture, texture.error);
860
- } else if (texture.state === 'freed') {
861
- this.onTextureFreed(texture);
862
- }
863
- });
864
- }
865
-
866
- unloadTexture(): void {
867
- if (this.texture !== null) {
868
- this.texture.off('loaded', this.onTextureLoaded);
869
- this.texture.off('failed', this.onTextureFailed);
870
- this.texture.off('freed', this.onTextureFreed);
871
- this.texture.setRenderableOwner(this, false);
872
- }
873
- }
874
-
875
- autosizeNode(dimensions: Dimensions) {
876
- if (this.autosize) {
877
- this.width = dimensions.width;
878
- this.height = dimensions.height;
879
- }
880
- }
881
-
882
- private onTextureLoaded: TextureLoadedEventHandler = (_, dimensions) => {
883
- this.autosizeNode(dimensions);
884
- this.setUpdateType(UpdateType.IsRenderable);
885
-
886
- // Texture was loaded. In case the RAF loop has already stopped, we request
887
- // a render to ensure the texture is rendered.
888
- this.stage.requestRender();
889
-
890
- // If parent has a render texture, flag that we need to update
891
- if (this.parentHasRenderTexture) {
892
- this.notifyParentRTTOfUpdate();
893
- }
894
-
895
- // ignore 1x1 pixel textures
896
- if (dimensions.width > 1 && dimensions.height > 1) {
897
- this.emit('loaded', {
898
- type: 'texture',
899
- dimensions,
900
- } satisfies NodeTextureLoadedPayload);
901
- }
902
-
903
- // Trigger a local update if the texture is loaded and the resizeMode is 'contain'
904
- if (this.props.textureOptions?.resizeMode?.type === 'contain') {
905
- this.setUpdateType(UpdateType.Local);
906
- }
907
- };
908
-
909
- private onTextureFailed: TextureFailedEventHandler = (_, error) => {
910
- this.setUpdateType(UpdateType.IsRenderable);
911
-
912
- // If parent has a render texture, flag that we need to update
913
- if (this.parentHasRenderTexture) {
914
- this.notifyParentRTTOfUpdate();
915
- }
916
-
917
- this.emit('failed', {
918
- type: 'texture',
919
- error,
920
- } satisfies NodeTextureFailedPayload);
921
- };
922
-
923
- private onTextureFreed: TextureFreedEventHandler = () => {
924
- this.setUpdateType(UpdateType.IsRenderable);
925
-
926
- // If parent has a render texture, flag that we need to update
927
- if (this.parentHasRenderTexture) {
928
- this.notifyParentRTTOfUpdate();
929
- }
930
-
931
- this.emit('freed', {
932
- type: 'texture',
933
- } satisfies NodeTextureFreedPayload);
934
- };
935
- //#endregion Textures
936
-
937
- /**
938
- * Change types types is used to determine the scope of the changes being applied
939
- *
940
- * @remarks
941
- * See {@link UpdateType} for more information on each type
942
- *
943
- * @param type
944
- */
945
- setUpdateType(type: UpdateType): void {
946
- this.updateType |= type;
947
-
948
- const parent = this.props.parent;
949
- if (!parent) return;
950
-
951
- if ((parent.updateType & UpdateType.Children) === 0) {
952
- // Inform the parent if it doesn’t already have a child update
953
- parent.setUpdateType(UpdateType.Children);
954
- }
955
- }
956
-
957
- sortChildren() {
958
- this.children.sort((a, b) => a.calcZIndex - b.calcZIndex);
959
- }
960
-
961
- updateScaleRotateTransform() {
962
- const { rotation, scaleX, scaleY } = this.props;
963
-
964
- // optimize simple translation cases
965
- if (rotation === 0 && scaleX === 1 && scaleY === 1) {
966
- this.scaleRotateTransform = undefined;
967
- return;
968
- }
969
-
970
- this.scaleRotateTransform = Matrix3d.rotate(
971
- rotation,
972
- this.scaleRotateTransform,
973
- ).scale(scaleX, scaleY);
974
- }
975
-
976
- updateLocalTransform() {
977
- const { x, y, width, height } = this.props;
978
- const mountTranslateX = this.props.mountX * width;
979
- const mountTranslateY = this.props.mountY * height;
980
-
981
- if (this.scaleRotateTransform) {
982
- const pivotTranslateX = this.props.pivotX * width;
983
- const pivotTranslateY = this.props.pivotY * height;
984
-
985
- this.localTransform = Matrix3d.translate(
986
- x - mountTranslateX + pivotTranslateX,
987
- y - mountTranslateY + pivotTranslateY,
988
- this.localTransform,
989
- )
990
- .multiply(this.scaleRotateTransform)
991
- .translate(-pivotTranslateX, -pivotTranslateY);
992
- } else {
993
- this.localTransform = Matrix3d.translate(
994
- x - mountTranslateX,
995
- y - mountTranslateY,
996
- this.localTransform,
997
- );
998
- }
999
-
1000
- // Handle 'contain' resize mode
1001
- const texture = this.props.texture;
1002
- if (
1003
- texture &&
1004
- texture.dimensions &&
1005
- this.props.textureOptions?.resizeMode?.type === 'contain'
1006
- ) {
1007
- let resizeModeScaleX = 1;
1008
- let resizeModeScaleY = 1;
1009
- let extraX = 0;
1010
- let extraY = 0;
1011
- const { width: tw, height: th } = texture.dimensions;
1012
- const txAspectRatio = tw / th;
1013
- const nodeAspectRatio = width / height;
1014
- if (txAspectRatio > nodeAspectRatio) {
1015
- // Texture is wider than node
1016
- // Center the node vertically (shift down by extraY)
1017
- // Scale the node vertically to maintain original aspect ratio
1018
- const scaleX = width / tw;
1019
- const scaledTxHeight = th * scaleX;
1020
- extraY = (height - scaledTxHeight) / 2;
1021
- resizeModeScaleY = scaledTxHeight / height;
1022
- } else {
1023
- // Texture is taller than node (or equal)
1024
- // Center the node horizontally (shift right by extraX)
1025
- // Scale the node horizontally to maintain original aspect ratio
1026
- const scaleY = height / th;
1027
- const scaledTxWidth = tw * scaleY;
1028
- extraX = (width - scaledTxWidth) / 2;
1029
- resizeModeScaleX = scaledTxWidth / width;
1030
- }
1031
-
1032
- // Apply the extra translation and scale to the local transform
1033
- this.localTransform
1034
- .translate(extraX, extraY)
1035
- .scale(resizeModeScaleX, resizeModeScaleY);
1036
- }
1037
-
1038
- this.setUpdateType(UpdateType.Global);
1039
- }
1040
-
1041
- /**
1042
- * @todo: test for correct calculation flag
1043
- * @param delta
1044
- */
1045
- update(delta: number, parentClippingRect: RectWithValid): void {
1046
- if (this.updateType & UpdateType.ScaleRotate) {
1047
- this.updateScaleRotateTransform();
1048
- this.setUpdateType(UpdateType.Local);
1049
- }
1050
-
1051
- if (this.updateType & UpdateType.Local) {
1052
- this.updateLocalTransform();
1053
- this.setUpdateType(UpdateType.Global);
1054
- }
1055
-
1056
- const parent = this.props.parent;
1057
- let renderState: CoreNodeRenderState | null = null;
1058
-
1059
- // Handle specific RTT updates at this node level
1060
- if (this.updateType & UpdateType.RenderTexture && this.rtt) {
1061
- this.hasRTTupdates = true;
1062
- }
1063
-
1064
- if (this.updateType & UpdateType.Global) {
1065
- assertTruthy(this.localTransform);
1066
-
1067
- if (this.parentHasRenderTexture === true && parent?.rtt === true) {
1068
- // we are at the start of the RTT chain, so we need to reset the globalTransform
1069
- // for correct RTT rendering
1070
- this.globalTransform = Matrix3d.identity();
1071
-
1072
- // Maintain a full scene global transform for bounds detection
1073
- this.sceneGlobalTransform = Matrix3d.copy(
1074
- parent?.globalTransform || Matrix3d.identity(),
1075
- ).multiply(this.localTransform);
1076
- } else if (
1077
- this.parentHasRenderTexture === true &&
1078
- parent?.rtt === false
1079
- ) {
1080
- // we're part of an RTT chain but our parent is not the main RTT node
1081
- // so we need to propogate the sceneGlobalTransform of the parent
1082
- // to maintain a full scene global transform for bounds detection
1083
- this.sceneGlobalTransform = Matrix3d.copy(
1084
- parent?.sceneGlobalTransform || this.localTransform,
1085
- ).multiply(this.localTransform);
1086
-
1087
- this.globalTransform = Matrix3d.copy(
1088
- parent?.globalTransform || this.localTransform,
1089
- this.globalTransform,
1090
- );
1091
- } else {
1092
- this.globalTransform = Matrix3d.copy(
1093
- parent?.globalTransform || this.localTransform,
1094
- this.globalTransform,
1095
- );
1096
- }
1097
-
1098
- if (parent !== null) {
1099
- this.globalTransform.multiply(this.localTransform);
1100
- }
1101
- this.calculateRenderCoords();
1102
- this.updateBoundingRect();
1103
-
1104
- this.setUpdateType(
1105
- UpdateType.RenderState |
1106
- UpdateType.Children |
1107
- UpdateType.RecalcUniforms,
1108
- );
1109
- this.childUpdateType |= UpdateType.Global;
1110
-
1111
- if (this.clipping === true) {
1112
- this.setUpdateType(UpdateType.Clipping | UpdateType.RenderBounds);
1113
- this.childUpdateType |= UpdateType.RenderBounds;
1114
- }
1115
- }
1116
-
1117
- if (this.updateType & UpdateType.RenderBounds) {
1118
- this.createRenderBounds();
1119
- this.setUpdateType(UpdateType.RenderState);
1120
- this.setUpdateType(UpdateType.Children);
1121
-
1122
- this.childUpdateType |= UpdateType.RenderBounds;
1123
- }
1124
-
1125
- if (this.updateType & UpdateType.RenderState) {
1126
- renderState = this.checkRenderBounds();
1127
- this.setUpdateType(UpdateType.IsRenderable);
1128
-
1129
- // if we're not going out of bounds, update the render state
1130
- // this is done so the update loop can finish before we mark a node
1131
- // as out of bounds
1132
- if (renderState !== CoreNodeRenderState.OutOfBounds) {
1133
- this.updateRenderState(renderState);
1134
- }
1135
- }
1136
-
1137
- if (this.updateType & UpdateType.WorldAlpha) {
1138
- if (parent) {
1139
- this.worldAlpha = parent.worldAlpha * this.props.alpha;
1140
- } else {
1141
- this.worldAlpha = this.props.alpha;
1142
- }
1143
- this.setUpdateType(
1144
- UpdateType.Children |
1145
- UpdateType.PremultipliedColors |
1146
- UpdateType.IsRenderable,
1147
- );
1148
- this.childUpdateType |= UpdateType.WorldAlpha;
1149
- }
1150
-
1151
- if (this.updateType & UpdateType.IsRenderable) {
1152
- this.updateIsRenderable();
1153
- }
1154
-
1155
- if (this.updateType & UpdateType.Clipping) {
1156
- this.calculateClippingRect(parentClippingRect);
1157
- this.setUpdateType(UpdateType.Children);
1158
-
1159
- this.childUpdateType |= UpdateType.Clipping;
1160
- this.childUpdateType |= UpdateType.RenderBounds;
1161
- }
1162
-
1163
- if (this.updateType & UpdateType.PremultipliedColors) {
1164
- this.premultipliedColorTl = mergeColorAlphaPremultiplied(
1165
- this.props.colorTl,
1166
- this.worldAlpha,
1167
- true,
1168
- );
1169
-
1170
- // If all the colors are the same just sent them all to the same value
1171
- if (
1172
- this.props.colorTl === this.props.colorTr &&
1173
- this.props.colorBl === this.props.colorBr &&
1174
- this.props.colorTl === this.props.colorBl
1175
- ) {
1176
- this.premultipliedColorTr =
1177
- this.premultipliedColorBl =
1178
- this.premultipliedColorBr =
1179
- this.premultipliedColorTl;
1180
- } else {
1181
- this.premultipliedColorTr = mergeColorAlphaPremultiplied(
1182
- this.props.colorTr,
1183
- this.worldAlpha,
1184
- true,
1185
- );
1186
- this.premultipliedColorBl = mergeColorAlphaPremultiplied(
1187
- this.props.colorBl,
1188
- this.worldAlpha,
1189
- true,
1190
- );
1191
- this.premultipliedColorBr = mergeColorAlphaPremultiplied(
1192
- this.props.colorBr,
1193
- this.worldAlpha,
1194
- true,
1195
- );
1196
- }
1197
- }
1198
-
1199
- // No need to update zIndex if there is no parent
1200
- if (parent !== null && this.updateType & UpdateType.CalculatedZIndex) {
1201
- this.calculateZIndex();
1202
- // Tell parent to re-sort children
1203
- parent.setUpdateType(UpdateType.ZIndexSortedChildren);
1204
- }
1205
-
1206
- if (
1207
- this.props.strictBounds === true &&
1208
- this.renderState === CoreNodeRenderState.OutOfBounds
1209
- ) {
1210
- this.updateType &= ~UpdateType.RenderBounds; // remove render bounds update
1211
- return;
1212
- }
1213
-
1214
- if (
1215
- this.updateType & UpdateType.RecalcUniforms &&
1216
- this.hasShaderUpdater === true
1217
- ) {
1218
- //this exists because the boolean hasShaderUpdater === true
1219
- this.shader!.update!();
1220
- }
1221
-
1222
- if (this.updateType & UpdateType.Children && this.children.length > 0) {
1223
- for (let i = 0, length = this.children.length; i < length; i++) {
1224
- const child = this.children[i] as CoreNode;
1225
-
1226
- child.setUpdateType(this.childUpdateType);
1227
-
1228
- if (child.updateType === 0) {
1229
- continue;
1230
- }
1231
-
1232
- let childClippingRect = this.clippingRect;
1233
- if (this.rtt === true) {
1234
- childClippingRect = {
1235
- x: 0,
1236
- y: 0,
1237
- width: 0,
1238
- height: 0,
1239
- valid: false,
1240
- };
1241
- }
1242
-
1243
- child.update(delta, childClippingRect);
1244
- }
1245
- }
1246
-
1247
- // If the node has an RTT parent and requires a texture re-render, inform the RTT parent
1248
- // if (this.parentHasRenderTexture && this.updateType & UpdateType.RenderTexture) {
1249
- // @TODO have a more scoped down updateType for RTT updates
1250
- if (this.parentHasRenderTexture && this.updateType > 0) {
1251
- this.notifyParentRTTOfUpdate();
1252
- }
1253
-
1254
- // Sorting children MUST happen after children have been updated so
1255
- // that they have the oppotunity to update their calculated zIndex.
1256
- if (this.updateType & UpdateType.ZIndexSortedChildren) {
1257
- // reorder z-index
1258
- this.sortChildren();
1259
- }
1260
-
1261
- if (this.updateTextureCoords === true) {
1262
- this.updateTextureCoords = false;
1263
- this.textureCoords = this.stage.renderer.getTextureCoords!(this);
1264
- }
1265
-
1266
- // If we're out of bounds, apply the render state now
1267
- // this is done so nodes can finish their entire update loop before
1268
- // being marked as out of bounds
1269
- if (renderState === CoreNodeRenderState.OutOfBounds) {
1270
- this.updateRenderState(renderState);
1271
- this.updateIsRenderable();
1272
-
1273
- if (
1274
- this.rtt === true &&
1275
- renderState === CoreNodeRenderState.OutOfBounds
1276
- ) {
1277
- // notify children that we are going out of bounds
1278
- // we have to do this now before we stop processing the render tree
1279
- this.notifyChildrenRTTOfUpdate(renderState);
1280
- // this.childUpdateType |= UpdateType.RenderState;
1281
- }
1282
- }
1283
-
1284
- // reset update type
1285
- this.updateType = 0;
1286
- this.childUpdateType = 0;
1287
- }
1288
-
1289
- private findParentRTTNode(): CoreNode | null {
1290
- let rttNode: CoreNode | null = this.parent;
1291
- while (rttNode && !rttNode.rtt) {
1292
- rttNode = rttNode.parent;
1293
- }
1294
- return rttNode;
1295
- }
1296
-
1297
- private notifyChildrenRTTOfUpdate(renderState: CoreNodeRenderState) {
1298
- for (const child of this.children) {
1299
- // force child to update render state
1300
- child.updateRenderState(renderState);
1301
- child.updateIsRenderable();
1302
- child.notifyChildrenRTTOfUpdate(renderState);
1303
- }
1304
- }
1305
-
1306
- private notifyParentRTTOfUpdate() {
1307
- if (this.parent === null) {
1308
- return;
1309
- }
1310
-
1311
- const rttNode = this.rttParent || this.findParentRTTNode();
1312
- if (!rttNode) {
1313
- return;
1314
- }
1315
-
1316
- // If an RTT node is found, mark it for re-rendering
1317
- rttNode.hasRTTupdates = true;
1318
- rttNode.setUpdateType(UpdateType.RenderTexture);
1319
-
1320
- // if rttNode is nested, also make it update its RTT parent
1321
- if (rttNode.parentHasRenderTexture === true) {
1322
- rttNode.notifyParentRTTOfUpdate();
1323
- }
1324
- }
1325
-
1326
- checkRenderBounds(): CoreNodeRenderState {
1327
- assertTruthy(this.renderBound);
1328
- assertTruthy(this.strictBound);
1329
- assertTruthy(this.preloadBound);
1330
-
1331
- if (boundInsideBound(this.renderBound, this.strictBound)) {
1332
- return CoreNodeRenderState.InViewport;
1333
- }
1334
-
1335
- if (boundInsideBound(this.renderBound, this.preloadBound)) {
1336
- return CoreNodeRenderState.InBounds;
1337
- }
1338
-
1339
- // check if we're larger then our parent, we're definitely in the viewport
1340
- if (boundLargeThanBound(this.renderBound, this.strictBound)) {
1341
- return CoreNodeRenderState.InViewport;
1342
- }
1343
-
1344
- // check if we dont have dimensions, take our parent's render state
1345
- if (
1346
- this.parent !== null &&
1347
- (this.props.width === 0 || this.props.height === 0)
1348
- ) {
1349
- return this.parent.renderState;
1350
- }
1351
-
1352
- return CoreNodeRenderState.OutOfBounds;
1353
- }
1354
-
1355
- updateBoundingRect() {
1356
- const transform = this.sceneGlobalTransform || this.globalTransform;
1357
- const renderCoords = this.sceneRenderCoords || this.renderCoords;
1358
-
1359
- assertTruthy(transform);
1360
- assertTruthy(renderCoords);
1361
-
1362
- if (transform.tb === 0 || transform.tc === 0) {
1363
- this.renderBound = createBound(
1364
- renderCoords.x1,
1365
- renderCoords.y1,
1366
- renderCoords.x3,
1367
- renderCoords.y3,
1368
- this.renderBound,
1369
- );
1370
- } else {
1371
- const { x1, y1, x2, y2, x3, y3, x4, y4 } = renderCoords;
1372
- this.renderBound = createBound(
1373
- Math.min(x1, x2, x3, x4),
1374
- Math.min(y1, y2, y3, y4),
1375
- Math.max(x1, x2, x3, x4),
1376
- Math.max(y1, y2, y3, y4),
1377
- this.renderBound,
1378
- );
1379
- }
1380
- }
1381
-
1382
- createRenderBounds(): void {
1383
- assertTruthy(this.stage);
1384
-
1385
- if (this.parent !== null && this.parent.strictBound !== undefined) {
1386
- // we have a parent with a valid bound, copy it
1387
- const parentBound = this.parent.strictBound;
1388
- this.strictBound = createBound(
1389
- parentBound.x1,
1390
- parentBound.y1,
1391
- parentBound.x2,
1392
- parentBound.y2,
1393
- );
1394
-
1395
- this.preloadBound = createPreloadBounds(
1396
- this.strictBound,
1397
- this.boundsMargin as [number, number, number, number],
1398
- );
1399
- } else {
1400
- // no parent or parent does not have a bound, take the stage boundaries
1401
- this.strictBound = this.stage.strictBound;
1402
- this.preloadBound = this.stage.preloadBound;
1403
- }
1404
-
1405
- // if clipping is disabled, we're done
1406
- if (this.props.clipping === false) {
1407
- return;
1408
- }
1409
-
1410
- // only create local clipping bounds if node itself is in bounds
1411
- // this can only be done if we have a render bound already
1412
- if (this.renderBound === undefined) {
1413
- return;
1414
- }
1415
-
1416
- // if we're out of bounds, we're done
1417
- if (boundInsideBound(this.renderBound, this.strictBound) === false) {
1418
- return;
1419
- }
1420
-
1421
- // clipping is enabled and we are in bounds create our own bounds
1422
- const { x, y, width, height } = this.props;
1423
-
1424
- // Pick the global transform if available, otherwise use the local transform
1425
- // global transform is only available if the node in an RTT chain
1426
- const { tx, ty } = this.sceneGlobalTransform || this.globalTransform || {};
1427
- const _x = tx ?? x;
1428
- const _y = ty ?? y;
1429
- this.strictBound = createBound(
1430
- _x,
1431
- _y,
1432
- _x + width,
1433
- _y + height,
1434
- this.strictBound,
1435
- );
1436
-
1437
- this.preloadBound = createPreloadBounds(
1438
- this.strictBound,
1439
- this.boundsMargin as [number, number, number, number],
1440
- );
1441
- }
1442
-
1443
- updateRenderState(renderState: CoreNodeRenderState) {
1444
- if (renderState === this.renderState) {
1445
- return;
1446
- }
1447
-
1448
- const previous = this.renderState;
1449
- this.renderState = renderState;
1450
- const event = CoreNodeRenderStateMap.get(renderState);
1451
- assertTruthy(event);
1452
- this.emit(event, {
1453
- previous,
1454
- current: renderState,
1455
- });
1456
- }
1457
-
1458
- /**
1459
- * Updates the `isRenderable` property based on various conditions.
1460
- */
1461
- updateIsRenderable() {
1462
- let newIsRenderable = false;
1463
- let needsTextureOwnership = false;
1464
-
1465
- // If the node is out of bounds or has an alpha of 0, it is not renderable
1466
- if (this.checkBasicRenderability() === false) {
1467
- this.updateTextureOwnership(false);
1468
- this.setRenderable(false);
1469
- return;
1470
- }
1471
-
1472
- if (this.texture !== null) {
1473
- needsTextureOwnership = true;
1474
-
1475
- // we're only renderable if the texture state is loaded
1476
- newIsRenderable = this.texture.state === 'loaded';
1477
- } else if (
1478
- (this.hasShader() || this.hasColorProperties() === true) &&
1479
- this.hasDimensions() === true
1480
- ) {
1481
- // This mean we have dimensions and a color set, so we can render a ColorTexture
1482
- if (
1483
- this.stage.defaultTexture &&
1484
- this.stage.defaultTexture.state === 'loaded'
1485
- ) {
1486
- newIsRenderable = true;
1487
- }
1488
- }
1489
-
1490
- this.updateTextureOwnership(needsTextureOwnership);
1491
- this.setRenderable(newIsRenderable);
1492
- }
1493
-
1494
- /**
1495
- * Checks if the node is renderable based on world alpha, dimensions and out of bounds status.
1496
- */
1497
- checkBasicRenderability(): boolean {
1498
- if (this.worldAlpha === 0 || this.isOutOfBounds() === true) {
1499
- return false;
1500
- } else {
1501
- return true;
1502
- }
1503
- }
1504
-
1505
- /**
1506
- * Sets the renderable state and triggers changes if necessary.
1507
- * @param isRenderable - The new renderable state
1508
- */
1509
- setRenderable(isRenderable: boolean) {
1510
- this.isRenderable = isRenderable;
1511
- if (
1512
- isRenderable === true &&
1513
- this.stage.calculateTextureCoord === true &&
1514
- this.textureCoords === undefined
1515
- ) {
1516
- this.updateTextureCoords = true;
1517
- }
1518
- }
1519
-
1520
- /**
1521
- * Changes the renderable state of the node.
1522
- */
1523
- updateTextureOwnership(isRenderable: boolean) {
1524
- this.texture?.setRenderableOwner(this, isRenderable);
1525
- }
1526
-
1527
- /**
1528
- * Checks if the node is out of the viewport bounds.
1529
- */
1530
- isOutOfBounds(): boolean {
1531
- return this.renderState <= CoreNodeRenderState.OutOfBounds;
1532
- }
1533
-
1534
- /**
1535
- * Checks if the node has dimensions (width/height)
1536
- */
1537
- hasDimensions(): boolean {
1538
- return this.props.width !== 0 && this.props.height !== 0;
1539
- }
1540
-
1541
- /**
1542
- * Checks if the node has any color properties set.
1543
- */
1544
- hasColorProperties(): boolean {
1545
- return (
1546
- this.props.color !== 0 ||
1547
- this.props.colorTop !== 0 ||
1548
- this.props.colorBottom !== 0 ||
1549
- this.props.colorLeft !== 0 ||
1550
- this.props.colorRight !== 0 ||
1551
- this.props.colorTl !== 0 ||
1552
- this.props.colorTr !== 0 ||
1553
- this.props.colorBl !== 0 ||
1554
- this.props.colorBr !== 0
1555
- );
1556
- }
1557
-
1558
- hasShader(): boolean {
1559
- return this.props.shader !== null;
1560
- }
1561
-
1562
- calculateRenderCoords() {
1563
- const { width, height } = this;
1564
- const { tx, ty, ta, tb, tc, td } = this.globalTransform!;
1565
- if (tb === 0 && tc === 0) {
1566
- const minX = tx;
1567
- const maxX = tx + width * ta;
1568
- const minY = ty;
1569
- const maxY = ty + height * td;
1570
- this.renderCoords = RenderCoords.translate(
1571
- //top-left
1572
- minX,
1573
- minY,
1574
- //top-right
1575
- maxX,
1576
- minY,
1577
- //bottom-right
1578
- maxX,
1579
- maxY,
1580
- //bottom-left
1581
- minX,
1582
- maxY,
1583
- this.renderCoords,
1584
- );
1585
- } else {
1586
- this.renderCoords = RenderCoords.translate(
1587
- //top-left
1588
- tx,
1589
- ty,
1590
- //top-right
1591
- tx + width * ta,
1592
- ty + width * tc,
1593
- //bottom-right
1594
- tx + width * ta + height * tb,
1595
- ty + width * tc + height * td,
1596
- //bottom-left
1597
- tx + height * tb,
1598
- ty + height * td,
1599
- this.renderCoords,
1600
- );
1601
- }
1602
- if (this.sceneGlobalTransform === undefined) {
1603
- return;
1604
- }
1605
-
1606
- const {
1607
- tx: stx,
1608
- ty: sty,
1609
- ta: sta,
1610
- tb: stb,
1611
- tc: stc,
1612
- td: std,
1613
- } = this.sceneGlobalTransform;
1614
- if (stb === 0 && stc === 0) {
1615
- const minX = stx;
1616
- const maxX = stx + width * sta;
1617
- const minY = sty;
1618
- const maxY = sty + height * std;
1619
- this.sceneRenderCoords = RenderCoords.translate(
1620
- //top-left
1621
- minX,
1622
- minY,
1623
- //top-right
1624
- maxX,
1625
- minY,
1626
- //bottom-right
1627
- maxX,
1628
- maxY,
1629
- //bottom-left
1630
- minX,
1631
- maxY,
1632
- this.sceneRenderCoords,
1633
- );
1634
- } else {
1635
- this.sceneRenderCoords = RenderCoords.translate(
1636
- //top-left
1637
- stx,
1638
- sty,
1639
- //top-right
1640
- stx + width * sta,
1641
- sty + width * stc,
1642
- //bottom-right
1643
- stx + width * sta + height * stb,
1644
- sty + width * stc + height * std,
1645
- //bottom-left
1646
- stx + height * stb,
1647
- sty + height * std,
1648
- this.sceneRenderCoords,
1649
- );
1650
- }
1651
- }
1652
-
1653
- /**
1654
- * This function calculates the clipping rectangle for a node.
1655
- *
1656
- * 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.
1657
- * 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.
1658
- *
1659
- * Finally, the node's parentClippingRect and clippingRect properties are updated.
1660
- */
1661
- calculateClippingRect(parentClippingRect: RectWithValid) {
1662
- assertTruthy(this.globalTransform);
1663
- const { clippingRect, props, globalTransform: gt } = this;
1664
- const { clipping } = props;
1665
- const isRotated = gt.tb !== 0 || gt.tc !== 0;
1666
-
1667
- if (clipping === true && isRotated === false) {
1668
- clippingRect.x = gt.tx;
1669
- clippingRect.y = gt.ty;
1670
- clippingRect.width = this.width * gt.ta;
1671
- clippingRect.height = this.height * gt.td;
1672
- clippingRect.valid = true;
1673
- } else {
1674
- clippingRect.valid = false;
1675
- }
1676
-
1677
- if (parentClippingRect.valid === true && clippingRect.valid === true) {
1678
- // Intersect parent clipping rect with node clipping rect
1679
- intersectRect(parentClippingRect, clippingRect, clippingRect);
1680
- } else if (parentClippingRect.valid === true) {
1681
- // Copy parent clipping rect
1682
- copyRect(parentClippingRect, clippingRect);
1683
- clippingRect.valid = true;
1684
- }
1685
- }
1686
-
1687
- calculateZIndex(): void {
1688
- const props = this.props;
1689
- const z = props.zIndex || 0;
1690
- const p = props.parent?.zIndex || 0;
1691
-
1692
- let zIndex = z;
1693
- if (props.parent?.zIndexLocked) {
1694
- zIndex = z < p ? z : p;
1695
- }
1696
- this.calcZIndex = zIndex;
1697
- }
1698
-
1699
- /**
1700
- * Destroy the node and cleanup all resources
1701
- */
1702
- destroy(): void {
1703
- this.unloadTexture();
1704
-
1705
- this.clippingRect.valid = false;
1706
- this.isRenderable = false;
1707
-
1708
- this.renderCoords = undefined;
1709
- this.renderBound = undefined;
1710
- this.strictBound = undefined;
1711
- this.preloadBound = undefined;
1712
- this.globalTransform = undefined;
1713
- this.scaleRotateTransform = undefined;
1714
- this.localTransform = undefined;
1715
-
1716
- this.props.texture = null;
1717
- this.props.shader = null;
1718
-
1719
- while (this.children.length > 0) {
1720
- this.children[0]?.destroy();
1721
- }
1722
-
1723
- // This very action will also remove the node from the parent's children array
1724
- this.parent = null;
1725
-
1726
- if (this.rtt) {
1727
- this.stage.renderer.removeRTTNode(this);
1728
- }
1729
-
1730
- this.removeAllListeners();
1731
- }
1732
-
1733
- renderQuads(renderer: CoreRenderer): void {
1734
- // Prevent quad rendering if parent has a render texture
1735
- // and renderer is not currently rendering to a texture
1736
- if (this.parentHasRenderTexture) {
1737
- if (!renderer.renderToTextureActive) {
1738
- return;
1739
- }
1740
- // Prevent quad rendering if parent render texture is not the active render texture
1741
- if (this.parentRenderTexture !== renderer.activeRttNode) {
1742
- return;
1743
- }
1744
- }
1745
-
1746
- assertTruthy(this.globalTransform);
1747
- assertTruthy(this.renderCoords);
1748
-
1749
- // add to list of renderables to be sorted before rendering
1750
- renderer.addQuad({
1751
- width: this.props.width,
1752
- height: this.props.height,
1753
- colorTl: this.premultipliedColorTl,
1754
- colorTr: this.premultipliedColorTr,
1755
- colorBl: this.premultipliedColorBl,
1756
- colorBr: this.premultipliedColorBr,
1757
- // if we do not have a texture, use the default texture
1758
- // this assumes any renderable node is either a distinct texture or a ColorTexture
1759
- texture: this.texture || this.stage.defaultTexture,
1760
- textureOptions: this.textureOptions,
1761
- textureCoords: this.textureCoords,
1762
- zIndex: this.zIndex,
1763
- shader: this.props.shader as CoreShaderNode<any>,
1764
- alpha: this.worldAlpha,
1765
- clippingRect: this.clippingRect,
1766
- tx: this.globalTransform.tx,
1767
- ty: this.globalTransform.ty,
1768
- ta: this.globalTransform.ta,
1769
- tb: this.globalTransform.tb,
1770
- tc: this.globalTransform.tc,
1771
- td: this.globalTransform.td,
1772
- renderCoords: this.renderCoords,
1773
- rtt: this.rtt,
1774
- parentHasRenderTexture: this.parentHasRenderTexture,
1775
- framebufferDimensions: this.framebufferDimensions,
1776
- });
1777
- }
1778
-
1779
- //#region Properties
1780
- get id(): number {
1781
- return this._id;
1782
- }
1783
-
1784
- get data(): CustomDataMap | undefined {
1785
- return this.props.data;
1786
- }
1787
-
1788
- set data(d: CustomDataMap | undefined) {
1789
- this.props.data = d;
1790
- }
1791
-
1792
- get x(): number {
1793
- return this.props.x;
1794
- }
1795
-
1796
- set x(value: number) {
1797
- if (this.props.x !== value) {
1798
- this.props.x = value;
1799
- this.setUpdateType(UpdateType.Local);
1800
- }
1801
- }
1802
-
1803
- get absX(): number {
1804
- return (
1805
- this.props.x +
1806
- -this.props.width * this.props.mountX +
1807
- (this.props.parent?.absX || this.props.parent?.globalTransform?.tx || 0)
1808
- );
1809
- }
1810
-
1811
- get absY(): number {
1812
- return (
1813
- this.props.y +
1814
- -this.props.height * this.props.mountY +
1815
- (this.props.parent?.absY ?? 0)
1816
- );
1817
- }
1818
-
1819
- get y(): number {
1820
- return this.props.y;
1821
- }
1822
-
1823
- set y(value: number) {
1824
- if (this.props.y !== value) {
1825
- this.props.y = value;
1826
- this.setUpdateType(UpdateType.Local);
1827
- }
1828
- }
1829
-
1830
- get width(): number {
1831
- return this.props.width;
1832
- }
1833
-
1834
- set width(value: number) {
1835
- if (this.props.width !== value) {
1836
- this.props.width = value;
1837
- this.setUpdateType(UpdateType.Local);
1838
-
1839
- if (this.props.rtt) {
1840
- this.texture = this.stage.txManager.createTexture('RenderTexture', {
1841
- width: this.width,
1842
- height: this.height,
1843
- });
1844
-
1845
- this.setUpdateType(UpdateType.RenderTexture);
1846
- }
1847
- }
1848
- }
1849
-
1850
- get height(): number {
1851
- return this.props.height;
1852
- }
1853
-
1854
- set height(value: number) {
1855
- if (this.props.height !== value) {
1856
- this.props.height = value;
1857
- this.setUpdateType(UpdateType.Local);
1858
-
1859
- if (this.props.rtt) {
1860
- this.texture = this.stage.txManager.createTexture('RenderTexture', {
1861
- width: this.width,
1862
- height: this.height,
1863
- });
1864
-
1865
- this.setUpdateType(UpdateType.RenderTexture);
1866
- }
1867
- }
1868
- }
1869
-
1870
- get scale(): number {
1871
- // The CoreNode `scale` property is only used by Animations.
1872
- // Unlike INode, `null` should never be possibility for Animations.
1873
- return this.scaleX;
1874
- }
1875
-
1876
- set scale(value: number) {
1877
- // The CoreNode `scale` property is only used by Animations.
1878
- // Unlike INode, `null` should never be possibility for Animations.
1879
- this.scaleX = value;
1880
- this.scaleY = value;
1881
- }
1882
-
1883
- get scaleX(): number {
1884
- return this.props.scaleX;
1885
- }
1886
-
1887
- set scaleX(value: number) {
1888
- if (this.props.scaleX !== value) {
1889
- this.props.scaleX = value;
1890
- this.setUpdateType(UpdateType.ScaleRotate);
1891
- }
1892
- }
1893
-
1894
- get scaleY(): number {
1895
- return this.props.scaleY;
1896
- }
1897
-
1898
- set scaleY(value: number) {
1899
- if (this.props.scaleY !== value) {
1900
- this.props.scaleY = value;
1901
- this.setUpdateType(UpdateType.ScaleRotate);
1902
- }
1903
- }
1904
-
1905
- get mount(): number {
1906
- return this.props.mount;
1907
- }
1908
-
1909
- set mount(value: number) {
1910
- if (this.props.mountX !== value || this.props.mountY !== value) {
1911
- this.props.mountX = value;
1912
- this.props.mountY = value;
1913
- this.props.mount = value;
1914
- this.setUpdateType(UpdateType.Local);
1915
- }
1916
- }
1917
-
1918
- get mountX(): number {
1919
- return this.props.mountX;
1920
- }
1921
-
1922
- set mountX(value: number) {
1923
- if (this.props.mountX !== value) {
1924
- this.props.mountX = value;
1925
- this.setUpdateType(UpdateType.Local);
1926
- }
1927
- }
1928
-
1929
- get mountY(): number {
1930
- return this.props.mountY;
1931
- }
1932
-
1933
- set mountY(value: number) {
1934
- if (this.props.mountY !== value) {
1935
- this.props.mountY = value;
1936
- this.setUpdateType(UpdateType.Local);
1937
- }
1938
- }
1939
-
1940
- get pivot(): number {
1941
- return this.props.pivot;
1942
- }
1943
-
1944
- set pivot(value: number) {
1945
- if (this.props.pivotX !== value || this.props.pivotY !== value) {
1946
- this.props.pivotX = value;
1947
- this.props.pivotY = value;
1948
- this.props.pivot = value;
1949
- this.setUpdateType(UpdateType.Local);
1950
- }
1951
- }
1952
-
1953
- get pivotX(): number {
1954
- return this.props.pivotX;
1955
- }
1956
-
1957
- set pivotX(value: number) {
1958
- if (this.props.pivotX !== value) {
1959
- this.props.pivotX = value;
1960
- this.setUpdateType(UpdateType.Local);
1961
- }
1962
- }
1963
-
1964
- get pivotY(): number {
1965
- return this.props.pivotY;
1966
- }
1967
-
1968
- set pivotY(value: number) {
1969
- if (this.props.pivotY !== value) {
1970
- this.props.pivotY = value;
1971
- this.setUpdateType(UpdateType.Local);
1972
- }
1973
- }
1974
-
1975
- get rotation(): number {
1976
- return this.props.rotation;
1977
- }
1978
-
1979
- set rotation(value: number) {
1980
- if (this.props.rotation !== value) {
1981
- this.props.rotation = value;
1982
- this.setUpdateType(UpdateType.ScaleRotate);
1983
- }
1984
- }
1985
-
1986
- get alpha(): number {
1987
- return this.props.alpha;
1988
- }
1989
-
1990
- set alpha(value: number) {
1991
- this.props.alpha = value;
1992
- this.setUpdateType(
1993
- UpdateType.PremultipliedColors |
1994
- UpdateType.WorldAlpha |
1995
- UpdateType.Children |
1996
- UpdateType.IsRenderable,
1997
- );
1998
- this.childUpdateType |= UpdateType.WorldAlpha;
1999
- }
2000
-
2001
- get autosize(): boolean {
2002
- return this.props.autosize;
2003
- }
2004
-
2005
- set autosize(value: boolean) {
2006
- this.props.autosize = value;
2007
- }
2008
-
2009
- get boundsMargin(): number | [number, number, number, number] | null {
2010
- return (
2011
- this.props.boundsMargin ??
2012
- this.parent?.boundsMargin ??
2013
- this.stage.boundsMargin
2014
- );
2015
- }
2016
-
2017
- set boundsMargin(value: number | [number, number, number, number] | null) {
2018
- if (value === this.props.boundsMargin) {
2019
- return;
2020
- }
2021
-
2022
- if (value === null) {
2023
- this.props.boundsMargin = value;
2024
- } else {
2025
- const bm: [number, number, number, number] = Array.isArray(value)
2026
- ? value
2027
- : [value, value, value, value];
2028
-
2029
- this.props.boundsMargin = bm;
2030
- }
2031
- this.setUpdateType(UpdateType.RenderBounds);
2032
- }
2033
-
2034
- get clipping(): boolean {
2035
- return this.props.clipping;
2036
- }
2037
-
2038
- set clipping(value: boolean) {
2039
- this.props.clipping = value;
2040
- this.setUpdateType(
2041
- UpdateType.Clipping | UpdateType.RenderBounds | UpdateType.Children,
2042
- );
2043
- this.childUpdateType |= UpdateType.Global | UpdateType.Clipping;
2044
- }
2045
-
2046
- get color(): number {
2047
- return this.props.color;
2048
- }
2049
-
2050
- set color(value: number) {
2051
- this.colorTop = value;
2052
- this.colorBottom = value;
2053
- this.colorLeft = value;
2054
- this.colorRight = value;
2055
- this.props.color = value;
2056
-
2057
- this.setUpdateType(UpdateType.PremultipliedColors);
2058
- }
2059
-
2060
- get colorTop(): number {
2061
- return this.props.colorTop;
2062
- }
2063
-
2064
- set colorTop(value: number) {
2065
- if (this.props.colorTl !== value || this.props.colorTr !== value) {
2066
- this.colorTl = value;
2067
- this.colorTr = value;
2068
- }
2069
- this.props.colorTop = value;
2070
- this.setUpdateType(UpdateType.PremultipliedColors);
2071
- }
2072
-
2073
- get colorBottom(): number {
2074
- return this.props.colorBottom;
2075
- }
2076
-
2077
- set colorBottom(value: number) {
2078
- if (this.props.colorBl !== value || this.props.colorBr !== value) {
2079
- this.colorBl = value;
2080
- this.colorBr = value;
2081
- }
2082
- this.props.colorBottom = value;
2083
- this.setUpdateType(UpdateType.PremultipliedColors);
2084
- }
2085
-
2086
- get colorLeft(): number {
2087
- return this.props.colorLeft;
2088
- }
2089
-
2090
- set colorLeft(value: number) {
2091
- if (this.props.colorTl !== value || this.props.colorBl !== value) {
2092
- this.colorTl = value;
2093
- this.colorBl = value;
2094
- }
2095
- this.props.colorLeft = value;
2096
- this.setUpdateType(UpdateType.PremultipliedColors);
2097
- }
2098
-
2099
- get colorRight(): number {
2100
- return this.props.colorRight;
2101
- }
2102
-
2103
- set colorRight(value: number) {
2104
- if (this.props.colorTr !== value || this.props.colorBr !== value) {
2105
- this.colorTr = value;
2106
- this.colorBr = value;
2107
- }
2108
- this.props.colorRight = value;
2109
- this.setUpdateType(UpdateType.PremultipliedColors);
2110
- }
2111
-
2112
- get colorTl(): number {
2113
- return this.props.colorTl;
2114
- }
2115
-
2116
- set colorTl(value: number) {
2117
- this.props.colorTl = value;
2118
- this.setUpdateType(UpdateType.PremultipliedColors);
2119
- }
2120
-
2121
- get colorTr(): number {
2122
- return this.props.colorTr;
2123
- }
2124
-
2125
- set colorTr(value: number) {
2126
- this.props.colorTr = value;
2127
- this.setUpdateType(UpdateType.PremultipliedColors);
2128
- }
2129
-
2130
- get colorBl(): number {
2131
- return this.props.colorBl;
2132
- }
2133
-
2134
- set colorBl(value: number) {
2135
- this.props.colorBl = value;
2136
- this.setUpdateType(UpdateType.PremultipliedColors);
2137
- }
2138
-
2139
- get colorBr(): number {
2140
- return this.props.colorBr;
2141
- }
2142
-
2143
- set colorBr(value: number) {
2144
- this.props.colorBr = value;
2145
- this.setUpdateType(UpdateType.PremultipliedColors);
2146
- }
2147
-
2148
- // we're only interested in parent zIndex to test
2149
- // if we should use node zIndex is higher then parent zIndex
2150
- get zIndexLocked(): number {
2151
- return this.props.zIndexLocked || 0;
2152
- }
2153
-
2154
- set zIndexLocked(value: number) {
2155
- this.props.zIndexLocked = value;
2156
- this.setUpdateType(UpdateType.CalculatedZIndex | UpdateType.Children);
2157
- for (let i = 0, length = this.children.length; i < length; i++) {
2158
- this.children[i]!.setUpdateType(UpdateType.CalculatedZIndex);
2159
- }
2160
- }
2161
-
2162
- get zIndex(): number {
2163
- return this.props.zIndex;
2164
- }
2165
-
2166
- set zIndex(value: number) {
2167
- this.props.zIndex = value;
2168
- this.setUpdateType(UpdateType.CalculatedZIndex | UpdateType.Children);
2169
- for (let i = 0, length = this.children.length; i < length; i++) {
2170
- this.children[i]!.setUpdateType(UpdateType.CalculatedZIndex);
2171
- }
2172
- }
2173
-
2174
- get parent(): CoreNode | null {
2175
- return this.props.parent;
2176
- }
2177
-
2178
- set parent(newParent: CoreNode | null) {
2179
- const oldParent = this.props.parent;
2180
- if (oldParent === newParent) {
2181
- return;
2182
- }
2183
- this.props.parent = newParent;
2184
- if (oldParent) {
2185
- const index = oldParent.children.indexOf(this);
2186
- assertTruthy(
2187
- index !== -1,
2188
- "CoreNode.parent: Node not found in old parent's children!",
2189
- );
2190
- oldParent.children.splice(index, 1);
2191
- oldParent.setUpdateType(
2192
- UpdateType.Children | UpdateType.ZIndexSortedChildren,
2193
- );
2194
- }
2195
- if (newParent) {
2196
- newParent.children.push(this);
2197
- // Since this node has a new parent, to be safe, have it do a full update.
2198
- this.setUpdateType(UpdateType.All);
2199
- // Tell parent that it's children need to be updated and sorted.
2200
- newParent.setUpdateType(
2201
- UpdateType.Children | UpdateType.ZIndexSortedChildren,
2202
- );
2203
-
2204
- // If the new parent has an RTT enabled, apply RTT inheritance
2205
- if (newParent.rtt || newParent.parentHasRenderTexture) {
2206
- this.applyRTTInheritance(newParent);
2207
- }
2208
- }
2209
- this.updateScaleRotateTransform();
2210
-
2211
- // fetch render bounds from parent
2212
- this.setUpdateType(UpdateType.RenderBounds | UpdateType.Children);
2213
- }
2214
-
2215
- get preventCleanup(): boolean {
2216
- return this.props.textureOptions.preventCleanup || false;
2217
- }
2218
-
2219
- set preventCleanup(value: boolean) {
2220
- if (isProductionEnvironment() === false) {
2221
- console.warn(
2222
- 'CoreNode.preventCleanup: Is deprecated and will be removed in upcoming release, please use textureOptions.preventCleanup instead',
2223
- );
2224
- }
2225
-
2226
- this.props.textureOptions.preventCleanup = value;
2227
- }
2228
-
2229
- get rtt(): boolean {
2230
- return this.props.rtt;
2231
- }
2232
-
2233
- set rtt(value: boolean) {
2234
- if (this.props.rtt === value) {
2235
- return;
2236
- }
2237
- this.props.rtt = value;
2238
-
2239
- if (value === true) {
2240
- this.initRenderTexture();
2241
- this.markChildrenWithRTT();
2242
- } else {
2243
- this.cleanupRenderTexture();
2244
- }
2245
-
2246
- this.setUpdateType(UpdateType.RenderTexture);
2247
-
2248
- if (this.parentHasRenderTexture === true) {
2249
- this.notifyParentRTTOfUpdate();
2250
- }
2251
- }
2252
- private initRenderTexture() {
2253
- this.texture = this.stage.txManager.createTexture('RenderTexture', {
2254
- width: this.width,
2255
- height: this.height,
2256
- });
2257
-
2258
- this.stage.renderer.renderToTexture(this);
2259
- }
2260
-
2261
- private cleanupRenderTexture() {
2262
- this.unloadTexture();
2263
- this.clearRTTInheritance();
2264
-
2265
- this.hasRTTupdates = false;
2266
- this.texture = null;
2267
- }
2268
-
2269
- private markChildrenWithRTT(node: CoreNode | null = null) {
2270
- const parent = node || this;
2271
-
2272
- for (const child of parent.children) {
2273
- child.setUpdateType(UpdateType.All);
2274
- child.parentHasRenderTexture = true;
2275
- child.markChildrenWithRTT();
2276
- }
2277
- }
2278
-
2279
- // Apply RTT inheritance when a node has an RTT-enabled parent
2280
- private applyRTTInheritance(parent: CoreNode) {
2281
- if (parent.rtt) {
2282
- // Only the RTT node should be added to `renderToTexture`
2283
- parent.setUpdateType(UpdateType.RenderTexture);
2284
- }
2285
-
2286
- // Propagate `parentHasRenderTexture` downwards
2287
- this.markChildrenWithRTT(parent);
2288
- }
2289
-
2290
- // Clear RTT inheritance when detaching from an RTT chain
2291
- private clearRTTInheritance() {
2292
- // if this node is RTT itself stop the propagation important for nested RTT nodes
2293
- // for the initial RTT node this is already handled in `set rtt`
2294
- if (this.rtt) {
2295
- return;
2296
- }
2297
-
2298
- for (const child of this.children) {
2299
- // force child to update everything as the RTT inheritance has changed
2300
- child.parentHasRenderTexture = false;
2301
- child.rttParent = null;
2302
- child.setUpdateType(UpdateType.All);
2303
- child.clearRTTInheritance();
2304
- }
2305
- }
2306
-
2307
- get shader(): CoreShaderNode<any> | null {
2308
- return this.props.shader;
2309
- }
2310
-
2311
- set shader(shader: CoreShaderNode<any> | null) {
2312
- if (this.props.shader === shader) {
2313
- return;
2314
- }
2315
- if (shader === null) {
2316
- this.hasShaderUpdater = false;
2317
- this.props.shader = this.stage.defShaderNode;
2318
- this.setUpdateType(UpdateType.IsRenderable);
2319
- return;
2320
- }
2321
- if (shader.shaderKey !== 'default') {
2322
- this.hasShaderUpdater = shader.update !== undefined;
2323
- shader.attachNode(this);
2324
- }
2325
- this.props.shader = shader;
2326
- this.setUpdateType(UpdateType.IsRenderable);
2327
- }
2328
-
2329
- get src(): string | null {
2330
- return this.props.src;
2331
- }
2332
-
2333
- set src(imageUrl: string | null) {
2334
- if (this.props.src === imageUrl) {
2335
- return;
2336
- }
2337
-
2338
- this.props.src = imageUrl;
2339
-
2340
- if (!imageUrl) {
2341
- this.texture = null;
2342
- return;
2343
- }
2344
-
2345
- this.texture = this.stage.txManager.createTexture('ImageTexture', {
2346
- src: imageUrl,
2347
- width: this.props.width,
2348
- height: this.props.height,
2349
- type: this.props.imageType,
2350
- sx: this.props.srcX,
2351
- sy: this.props.srcY,
2352
- sw: this.props.srcWidth,
2353
- sh: this.props.srcHeight,
2354
- });
2355
- }
2356
-
2357
- set imageType(type: 'regular' | 'compressed' | 'svg' | null) {
2358
- if (this.props.imageType === type) {
2359
- return;
2360
- }
2361
-
2362
- this.props.imageType = type;
2363
- }
2364
-
2365
- get imageType() {
2366
- return this.props.imageType || null;
2367
- }
2368
-
2369
- get srcHeight(): number | undefined {
2370
- return this.props.srcHeight;
2371
- }
2372
-
2373
- set srcHeight(value: number) {
2374
- this.props.srcHeight = value;
2375
- }
2376
-
2377
- get srcWidth(): number | undefined {
2378
- return this.props.srcWidth;
2379
- }
2380
-
2381
- set srcWidth(value: number) {
2382
- this.props.srcWidth = value;
2383
- }
2384
-
2385
- get srcX(): number | undefined {
2386
- return this.props.srcX;
2387
- }
2388
-
2389
- set srcX(value: number) {
2390
- this.props.srcX = value;
2391
- }
2392
-
2393
- get srcY(): number | undefined {
2394
- return this.props.srcY;
2395
- }
2396
-
2397
- set srcY(value: number) {
2398
- this.props.srcY = value;
2399
- }
2400
-
2401
- /**
2402
- * Returns the framebuffer dimensions of the node.
2403
- * If the node has a render texture, the dimensions are the same as the node's dimensions.
2404
- * If the node does not have a render texture, the dimensions are inherited from the parent.
2405
- * If the node parent has a render texture and the node is a render texture, the nodes dimensions are used.
2406
- */
2407
- get framebufferDimensions(): Dimensions {
2408
- if (this.parentHasRenderTexture && !this.rtt && this.parent) {
2409
- return this.parent.framebufferDimensions;
2410
- }
2411
- return { width: this.width, height: this.height };
2412
- }
2413
-
2414
- /**
2415
- * Returns the parent render texture node if it exists.
2416
- */
2417
- get parentRenderTexture(): CoreNode | null {
2418
- let parent = this.parent;
2419
- while (parent) {
2420
- if (parent.rtt) {
2421
- return parent;
2422
- }
2423
- parent = parent.parent;
2424
- }
2425
- return null;
2426
- }
2427
-
2428
- get texture(): Texture | null {
2429
- return this.props.texture;
2430
- }
2431
-
2432
- set texture(value: Texture | null) {
2433
- if (this.props.texture === value) {
2434
- return;
2435
- }
2436
-
2437
- const oldTexture = this.props.texture;
2438
- if (oldTexture) {
2439
- oldTexture.setRenderableOwner(this, false);
2440
- this.unloadTexture();
2441
- }
2442
-
2443
- this.textureCoords = undefined;
2444
- this.props.texture = value;
2445
- if (value !== null) {
2446
- value.setRenderableOwner(this, this.isRenderable);
2447
- this.loadTexture();
2448
- }
2449
-
2450
- this.setUpdateType(UpdateType.IsRenderable);
2451
- }
2452
-
2453
- set textureOptions(value: TextureOptions) {
2454
- this.props.textureOptions = value;
2455
- }
2456
-
2457
- get textureOptions(): TextureOptions {
2458
- return this.props.textureOptions;
2459
- }
2460
-
2461
- get strictBounds(): boolean {
2462
- return this.props.strictBounds;
2463
- }
2464
-
2465
- set strictBounds(v) {
2466
- if (v === this.props.strictBounds) {
2467
- return;
2468
- }
2469
-
2470
- this.props.strictBounds = v;
2471
- this.setUpdateType(UpdateType.RenderBounds | UpdateType.Children);
2472
- this.childUpdateType |= UpdateType.RenderBounds | UpdateType.Children;
2473
- }
2474
-
2475
- animate(
2476
- props: Partial<CoreNodeAnimateProps>,
2477
- settings: Partial<AnimationSettings>,
2478
- ): IAnimationController {
2479
- const animation = new CoreAnimation(this, props, settings);
2480
-
2481
- const controller = new CoreAnimationController(
2482
- this.stage.animationManager,
2483
- animation,
2484
- );
2485
-
2486
- return controller;
2487
- }
2488
-
2489
- flush() {
2490
- // no-op
2491
- }
2492
-
2493
- //#endregion Properties
2494
- }
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 {
21
+ assertTruthy,
22
+ getNewId,
23
+ isProductionEnvironment,
24
+ mergeColorAlphaPremultiplied,
25
+ } from '../utils.js';
26
+ import type { TextureOptions } from './CoreTextureManager.js';
27
+ import type { CoreRenderer } from './renderers/CoreRenderer.js';
28
+ import type { Stage } from './Stage.js';
29
+ import {
30
+ type Texture,
31
+ type TextureCoords,
32
+ type TextureFailedEventHandler,
33
+ type TextureFreedEventHandler,
34
+ type TextureLoadedEventHandler,
35
+ } from './textures/Texture.js';
36
+ import type {
37
+ Dimensions,
38
+ NodeTextureFailedPayload,
39
+ NodeTextureFreedPayload,
40
+ NodeTextureLoadedPayload,
41
+ } from '../common/CommonTypes.js';
42
+ import { EventEmitter } from '../common/EventEmitter.js';
43
+ import {
44
+ copyRect,
45
+ intersectRect,
46
+ type Bound,
47
+ type RectWithValid,
48
+ createBound,
49
+ boundInsideBound,
50
+ boundLargeThanBound,
51
+ createPreloadBounds,
52
+ } from './lib/utils.js';
53
+ import { Matrix3d } from './lib/Matrix3d.js';
54
+ import { RenderCoords } from './lib/RenderCoords.js';
55
+ import type { AnimationSettings } from './animations/CoreAnimation.js';
56
+ import type { IAnimationController } from '../common/IAnimationController.js';
57
+ import { CoreAnimation } from './animations/CoreAnimation.js';
58
+ import { CoreAnimationController } from './animations/CoreAnimationController.js';
59
+ import type { CoreShaderNode } from './renderers/CoreShaderNode.js';
60
+
61
+ export enum CoreNodeRenderState {
62
+ Init = 0,
63
+ OutOfBounds = 2,
64
+ InBounds = 4,
65
+ InViewport = 8,
66
+ }
67
+
68
+ const CoreNodeRenderStateMap: Map<CoreNodeRenderState, string> = new Map();
69
+ CoreNodeRenderStateMap.set(CoreNodeRenderState.Init, 'init');
70
+ CoreNodeRenderStateMap.set(CoreNodeRenderState.OutOfBounds, 'outOfBounds');
71
+ CoreNodeRenderStateMap.set(CoreNodeRenderState.InBounds, 'inBounds');
72
+ CoreNodeRenderStateMap.set(CoreNodeRenderState.InViewport, 'inViewport');
73
+
74
+ export enum UpdateType {
75
+ /**
76
+ * Child updates
77
+ */
78
+ Children = 1,
79
+
80
+ /**
81
+ * Scale/Rotate transform update
82
+ *
83
+ * @remarks
84
+ * CoreNode Properties Updated:
85
+ * - `scaleRotateTransform`
86
+ */
87
+ ScaleRotate = 2,
88
+
89
+ /**
90
+ * Translate transform update (x/y/width/height/pivot/mount)
91
+ *
92
+ * @remarks
93
+ * CoreNode Properties Updated:
94
+ * - `localTransform`
95
+ */
96
+ Local = 4,
97
+
98
+ /**
99
+ * Global Transform update
100
+ *
101
+ * @remarks
102
+ * CoreNode Properties Updated:
103
+ * - `globalTransform`
104
+ * - `renderCoords`
105
+ * - `renderBound`
106
+ */
107
+ Global = 8,
108
+
109
+ /**
110
+ * Clipping rect update
111
+ *
112
+ * @remarks
113
+ * CoreNode Properties Updated:
114
+ * - `clippingRect`
115
+ */
116
+ Clipping = 16,
117
+
118
+ /**
119
+ * Calculated ZIndex update
120
+ *
121
+ * @remarks
122
+ * CoreNode Properties Updated:
123
+ * - `calcZIndex`
124
+ */
125
+ CalculatedZIndex = 32,
126
+
127
+ /**
128
+ * Z-Index Sorted Children update
129
+ *
130
+ * @remarks
131
+ * CoreNode Properties Updated:
132
+ * - `children` (sorts children by their `calcZIndex`)
133
+ */
134
+ ZIndexSortedChildren = 64,
135
+
136
+ /**
137
+ * Premultiplied Colors update
138
+ *
139
+ * @remarks
140
+ * CoreNode Properties Updated:
141
+ * - `premultipliedColorTl`
142
+ * - `premultipliedColorTr`
143
+ * - `premultipliedColorBl`
144
+ * - `premultipliedColorBr`
145
+ */
146
+ PremultipliedColors = 128,
147
+
148
+ /**
149
+ * World Alpha update
150
+ *
151
+ * @remarks
152
+ * CoreNode Properties Updated:
153
+ * - `worldAlpha` = `parent.worldAlpha` * `alpha`
154
+ */
155
+ WorldAlpha = 256,
156
+
157
+ /**
158
+ * Render State update
159
+ *
160
+ * @remarks
161
+ * CoreNode Properties Updated:
162
+ * - `renderState`
163
+ */
164
+ RenderState = 512,
165
+
166
+ /**
167
+ * Is Renderable update
168
+ *
169
+ * @remarks
170
+ * CoreNode Properties Updated:
171
+ * - `isRenderable`
172
+ */
173
+ IsRenderable = 1024,
174
+
175
+ /**
176
+ * Render Texture update
177
+ */
178
+ RenderTexture = 2048,
179
+
180
+ /**
181
+ * Track if parent has render texture
182
+ */
183
+ ParentRenderTexture = 4096,
184
+
185
+ /**
186
+ * Render Bounds update
187
+ */
188
+ RenderBounds = 8192,
189
+
190
+ /**
191
+ * None
192
+ */
193
+ None = 0,
194
+
195
+ /**
196
+ * All
197
+ */
198
+ All = 14335,
199
+
200
+ /**
201
+ * RecalcUniforms
202
+ */
203
+ RecalcUniforms = 16384,
204
+ }
205
+
206
+ /**
207
+ * A custom data map which can be stored on an CoreNode
208
+ *
209
+ * @remarks
210
+ * This is a map of key-value pairs that can be stored on an INode. It is used
211
+ * to store custom data that can be used by the application.
212
+ * The data stored can only be of type string, number or boolean.
213
+ */
214
+ export type CustomDataMap = {
215
+ [key: string]: string | number | boolean | undefined;
216
+ };
217
+
218
+ /**
219
+ * Writable properties of a Node.
220
+ */
221
+ export interface CoreNodeProps {
222
+ /**
223
+ * The x coordinate of the Node's Mount Point.
224
+ *
225
+ * @remarks
226
+ * See {@link mountX} and {@link mountY} for more information about setting
227
+ * the Mount Point.
228
+ *
229
+ * @default `0`
230
+ */
231
+ x: number;
232
+ /**
233
+ * The y coordinate of the Node's Mount Point.
234
+ *
235
+ * @remarks
236
+ * See {@link mountX} and {@link mountY} for more information about setting
237
+ * the Mount Point.
238
+ *
239
+ * @default `0`
240
+ */
241
+ y: number;
242
+ /**
243
+ * The width of the Node.
244
+ *
245
+ * @default `0`
246
+ */
247
+ width: number;
248
+ /**
249
+ * The height of the Node.
250
+ *
251
+ * @default `0`
252
+ */
253
+ height: number;
254
+ /**
255
+ * The alpha opacity of the Node.
256
+ *
257
+ * @remarks
258
+ * The alpha value is a number between 0 and 1, where 0 is fully transparent
259
+ * and 1 is fully opaque.
260
+ *
261
+ * @default `1`
262
+ */
263
+ alpha: number;
264
+ /**
265
+ * Autosize mode
266
+ *
267
+ * @remarks
268
+ * When enabled, when a texture is loaded into the Node, the Node will
269
+ * automatically resize to the dimensions of the texture.
270
+ *
271
+ * Text Nodes are always autosized based on their text content regardless
272
+ * of this mode setting.
273
+ *
274
+ * @default `false`
275
+ */
276
+ autosize: boolean;
277
+ /**
278
+ * Margin around the Node's bounds for preloading
279
+ *
280
+ * @default `null`
281
+ */
282
+ boundsMargin: number | [number, number, number, number] | null;
283
+ /**
284
+ * Clipping Mode
285
+ *
286
+ * @remarks
287
+ * Enable Clipping Mode when you want to prevent the drawing of a Node and
288
+ * its descendants from overflowing outside of the Node's x/y/width/height
289
+ * bounds.
290
+ *
291
+ * For WebGL, clipping is implemented using the high-performance WebGL
292
+ * operation scissor. As a consequence, clipping does not work for
293
+ * non-rectangular areas. So, if the element is rotated
294
+ * (by itself or by any of its ancestors), clipping will not work as intended.
295
+ *
296
+ * TODO: Add support for non-rectangular clipping either automatically or
297
+ * via Render-To-Texture.
298
+ *
299
+ * @default `false`
300
+ */
301
+ clipping: boolean;
302
+ /**
303
+ * The color of the Node.
304
+ *
305
+ * @remarks
306
+ * The color value is a number in the format 0xRRGGBBAA, where RR is the red
307
+ * component, GG is the green component, BB is the blue component, and AA is
308
+ * the alpha component.
309
+ *
310
+ * Gradient colors may be set by setting the different color sub-properties:
311
+ * {@link colorTop}, {@link colorBottom}, {@link colorLeft}, {@link colorRight},
312
+ * {@link colorTl}, {@link colorTr}, {@link colorBr}, {@link colorBl} accordingly.
313
+ *
314
+ * @default `0xffffffff` (opaque white)
315
+ */
316
+ color: number;
317
+ /**
318
+ * The color of the top edge of the Node for gradient rendering.
319
+ *
320
+ * @remarks
321
+ * See {@link color} for more information about color values and gradient
322
+ * rendering.
323
+ */
324
+ colorTop: number;
325
+ /**
326
+ * The color of the bottom edge of the Node for gradient rendering.
327
+ *
328
+ * @remarks
329
+ * See {@link color} for more information about color values and gradient
330
+ * rendering.
331
+ */
332
+ colorBottom: number;
333
+ /**
334
+ * The color of the left edge of the Node for gradient rendering.
335
+ *
336
+ * @remarks
337
+ * See {@link color} for more information about color values and gradient
338
+ * rendering.
339
+ */
340
+ colorLeft: number;
341
+ /**
342
+ * The color of the right edge of the Node for gradient rendering.
343
+ *
344
+ * @remarks
345
+ * See {@link color} for more information about color values and gradient
346
+ * rendering.
347
+ */
348
+ colorRight: number;
349
+ /**
350
+ * The color of the top-left corner of the Node for gradient rendering.
351
+ *
352
+ * @remarks
353
+ * See {@link color} for more information about color values and gradient
354
+ * rendering.
355
+ */
356
+ colorTl: number;
357
+ /**
358
+ * The color of the top-right corner of the Node for gradient rendering.
359
+ *
360
+ * @remarks
361
+ * See {@link color} for more information about color values and gradient
362
+ * rendering.
363
+ */
364
+ colorTr: number;
365
+ /**
366
+ * The color of the bottom-right corner of the Node for gradient rendering.
367
+ *
368
+ * @remarks
369
+ * See {@link color} for more information about color values and gradient
370
+ * rendering.
371
+ */
372
+ colorBr: number;
373
+ /**
374
+ * The color of the bottom-left corner of the Node for gradient rendering.
375
+ *
376
+ * @remarks
377
+ * See {@link color} for more information about color values and gradient
378
+ * rendering.
379
+ */
380
+ colorBl: number;
381
+ /**
382
+ * The Node's parent Node.
383
+ *
384
+ * @remarks
385
+ * The value `null` indicates that the Node has no parent. This may either be
386
+ * because the Node is the root Node of the scene graph, or because the Node
387
+ * has been removed from the scene graph.
388
+ *
389
+ * In order to make sure that a Node can be rendered on the screen, it must
390
+ * be added to the scene graph by setting it's parent property to a Node that
391
+ * is already in the scene graph such as the root Node.
392
+ *
393
+ * @default `null`
394
+ */
395
+ parent: CoreNode | null;
396
+ /**
397
+ * The Node's z-index.
398
+ *
399
+ * @remarks
400
+ * TBD
401
+ */
402
+ zIndex: number;
403
+ /**
404
+ * The Node's Texture.
405
+ *
406
+ * @remarks
407
+ * The `texture` defines a rasterized image that is contained within the
408
+ * {@link width} and {@link height} dimensions of the Node. If null, the
409
+ * Node will use an opaque white {@link ColorTexture} when being drawn, which
410
+ * essentially enables colors (including gradients) to be drawn.
411
+ *
412
+ * If set, by default, the texture will be drawn, as is, stretched to the
413
+ * dimensions of the Node. This behavior can be modified by setting the TBD
414
+ * and TBD properties.
415
+ *
416
+ * To create a Texture in order to set it on this property, call
417
+ * {@link RendererMain.createTexture}.
418
+ *
419
+ * If the {@link src} is set on a Node, the Node will use the
420
+ * {@link ImageTexture} by default and the Node will simply load the image at
421
+ * the specified URL.
422
+ *
423
+ * Note: If this is a Text Node, the Texture will be managed by the Node's
424
+ * {@link TextRenderer} and should not be set explicitly.
425
+ */
426
+ texture: Texture | null;
427
+
428
+ /**
429
+ * [Deprecated]: Prevents the texture from being cleaned up when the Node is removed
430
+ *
431
+ * @remarks
432
+ * Please use the `preventCleanup` property on {@link TextureOptions} instead.
433
+ *
434
+ * @default false
435
+ */
436
+ preventCleanup: boolean;
437
+ /**
438
+ * Options to associate with the Node's Texture
439
+ */
440
+ textureOptions: TextureOptions;
441
+
442
+ /**
443
+ * The Node's shader
444
+ *
445
+ * @remarks
446
+ * The `shader` defines a {@link Shader} used to draw the Node. By default,
447
+ * the Default Shader is used which simply draws the defined {@link texture}
448
+ * or {@link color}(s) within the Node without any special effects.
449
+ *
450
+ * To create a Shader in order to set it on this property, call
451
+ * {@link RendererMain.createShader}.
452
+ *
453
+ * Note: If this is a Text Node, the Shader will be managed by the Node's
454
+ * {@link TextRenderer} and should not be set explicitly.
455
+ */
456
+ shader: CoreShaderNode<any> | null;
457
+ /**
458
+ * Image URL
459
+ *
460
+ * @remarks
461
+ * When set, the Node's {@link texture} is automatically set to an
462
+ * {@link ImageTexture} using the source image URL provided (with all other
463
+ * settings being defaults)
464
+ */
465
+ src: string | null;
466
+ zIndexLocked: number;
467
+ /**
468
+ * Scale to render the Node at
469
+ *
470
+ * @remarks
471
+ * The scale value multiplies the provided {@link width} and {@link height}
472
+ * of the Node around the Node's Pivot Point (defined by the {@link pivot}
473
+ * props).
474
+ *
475
+ * Behind the scenes, setting this property sets both the {@link scaleX} and
476
+ * {@link scaleY} props to the same value.
477
+ *
478
+ * NOTE: When the scaleX and scaleY props are explicitly set to different values,
479
+ * this property returns `null`. Setting `null` on this property will have no
480
+ * effect.
481
+ *
482
+ * @default 1.0
483
+ */
484
+ scale: number | null;
485
+ /**
486
+ * Scale to render the Node at (X-Axis)
487
+ *
488
+ * @remarks
489
+ * The scaleX value multiplies the provided {@link width} of the Node around
490
+ * the Node's Pivot Point (defined by the {@link pivot} props).
491
+ *
492
+ * @default 1.0
493
+ */
494
+ scaleX: number;
495
+ /**
496
+ * Scale to render the Node at (Y-Axis)
497
+ *
498
+ * @remarks
499
+ * The scaleY value multiplies the provided {@link height} of the Node around
500
+ * the Node's Pivot Point (defined by the {@link pivot} props).
501
+ *
502
+ * @default 1.0
503
+ */
504
+ scaleY: number;
505
+ /**
506
+ * Combined position of the Node's Mount Point
507
+ *
508
+ * @remarks
509
+ * The value can be any number between `0.0` and `1.0`:
510
+ * - `0.0` defines the Mount Point at the top-left corner of the Node.
511
+ * - `0.5` defines it at the center of the Node.
512
+ * - `1.0` defines it at the bottom-right corner of the node.
513
+ *
514
+ * Use the {@link mountX} and {@link mountY} props seperately for more control
515
+ * of the Mount Point.
516
+ *
517
+ * When assigned, the same value is also passed to both the {@link mountX} and
518
+ * {@link mountY} props.
519
+ *
520
+ * @default 0 (top-left)
521
+ */
522
+ mount: number;
523
+ /**
524
+ * X position of the Node's Mount Point
525
+ *
526
+ * @remarks
527
+ * The value can be any number between `0.0` and `1.0`:
528
+ * - `0.0` defines the Mount Point's X position as the left-most edge of the
529
+ * Node
530
+ * - `0.5` defines it as the horizontal center of the Node
531
+ * - `1.0` defines it as the right-most edge of the Node.
532
+ *
533
+ * The combination of {@link mountX} and {@link mountY} define the Mount Point
534
+ *
535
+ * @default 0 (left-most edge)
536
+ */
537
+ mountX: number;
538
+ /**
539
+ * Y position of the Node's Mount Point
540
+ *
541
+ * @remarks
542
+ * The value can be any number between `0.0` and `1.0`:
543
+ * - `0.0` defines the Mount Point's Y position as the top-most edge of the
544
+ * Node
545
+ * - `0.5` defines it as the vertical center of the Node
546
+ * - `1.0` defines it as the bottom-most edge of the Node.
547
+ *
548
+ * The combination of {@link mountX} and {@link mountY} define the Mount Point
549
+ *
550
+ * @default 0 (top-most edge)
551
+ */
552
+ mountY: number;
553
+ /**
554
+ * Combined position of the Node's Pivot Point
555
+ *
556
+ * @remarks
557
+ * The value can be any number between `0.0` and `1.0`:
558
+ * - `0.0` defines the Pivot Point at the top-left corner of the Node.
559
+ * - `0.5` defines it at the center of the Node.
560
+ * - `1.0` defines it at the bottom-right corner of the node.
561
+ *
562
+ * Use the {@link pivotX} and {@link pivotY} props seperately for more control
563
+ * of the Pivot Point.
564
+ *
565
+ * When assigned, the same value is also passed to both the {@link pivotX} and
566
+ * {@link pivotY} props.
567
+ *
568
+ * @default 0.5 (center)
569
+ */
570
+ pivot: number;
571
+ /**
572
+ * X position of the Node's Pivot Point
573
+ *
574
+ * @remarks
575
+ * The value can be any number between `0.0` and `1.0`:
576
+ * - `0.0` defines the Pivot Point's X position as the left-most edge of the
577
+ * Node
578
+ * - `0.5` defines it as the horizontal center of the Node
579
+ * - `1.0` defines it as the right-most edge of the Node.
580
+ *
581
+ * The combination of {@link pivotX} and {@link pivotY} define the Pivot Point
582
+ *
583
+ * @default 0.5 (centered on x-axis)
584
+ */
585
+ pivotX: number;
586
+ /**
587
+ * Y position of the Node's Pivot Point
588
+ *
589
+ * @remarks
590
+ * The value can be any number between `0.0` and `1.0`:
591
+ * - `0.0` defines the Pivot Point's Y position as the top-most edge of the
592
+ * Node
593
+ * - `0.5` defines it as the vertical center of the Node
594
+ * - `1.0` defines it as the bottom-most edge of the Node.
595
+ *
596
+ * The combination of {@link pivotX} and {@link pivotY} define the Pivot Point
597
+ *
598
+ * @default 0.5 (centered on y-axis)
599
+ */
600
+ pivotY: number;
601
+ /**
602
+ * Rotation of the Node (in Radians)
603
+ *
604
+ * @remarks
605
+ * Sets the amount to rotate the Node by around it's Pivot Point (defined by
606
+ * the {@link pivot} props). Positive values rotate the Node clockwise, while
607
+ * negative values rotate it counter-clockwise.
608
+ *
609
+ * Example values:
610
+ * - `-Math.PI / 2`: 90 degree rotation counter-clockwise
611
+ * - `0`: No rotation
612
+ * - `Math.PI / 2`: 90 degree rotation clockwise
613
+ * - `Math.PI`: 180 degree rotation clockwise
614
+ * - `3 * Math.PI / 2`: 270 degree rotation clockwise
615
+ * - `2 * Math.PI`: 360 rotation clockwise
616
+ */
617
+ rotation: number;
618
+
619
+ /**
620
+ * Whether the Node is rendered to a texture
621
+ *
622
+ * @remarks
623
+ * TBD
624
+ *
625
+ * @default false
626
+ */
627
+ rtt: boolean;
628
+
629
+ /**
630
+ * Node data element for custom data storage (optional)
631
+ *
632
+ * @remarks
633
+ * This property is used to store custom data on the Node as a key/value data store.
634
+ * Data values are limited to string, numbers, booleans. Strings will be truncated
635
+ * to a 2048 character limit for performance reasons.
636
+ *
637
+ * This is not a data storage mechanism for large amounts of data please use a
638
+ * dedicated data storage mechanism for that.
639
+ *
640
+ * The custom data will be reflected in the inspector as part of `data-*` attributes
641
+ *
642
+ * @default `undefined`
643
+ */
644
+ data?: CustomDataMap;
645
+
646
+ /**
647
+ * Image Type to explicitly set the image type that is being loaded
648
+ *
649
+ * @remarks
650
+ * This property must be used with a `src` that points at an image. In some cases
651
+ * the extension doesn't provide a reliable representation of the image type. In such
652
+ * cases set the ImageType explicitly.
653
+ *
654
+ * `regular` is used for normal images such as png, jpg, etc
655
+ * `compressed` is used for ETC1/ETC2 compressed images with a PVR or KTX container
656
+ * `svg` is used for scalable vector graphics
657
+ *
658
+ * @default `undefined`
659
+ */
660
+ imageType?: 'regular' | 'compressed' | 'svg' | null;
661
+
662
+ /**
663
+ * She width of the rectangle from which the Image Texture will be extracted.
664
+ * This value can be negative. If not provided, the image's source natural
665
+ * width will be used.
666
+ */
667
+ srcWidth?: number;
668
+ /**
669
+ * The height of the rectangle from which the Image Texture will be extracted.
670
+ * This value can be negative. If not provided, the image's source natural
671
+ * height will be used.
672
+ */
673
+ srcHeight?: number;
674
+ /**
675
+ * The x coordinate of the reference point of the rectangle from which the Texture
676
+ * will be extracted. `width` and `height` are provided. And only works when
677
+ * createImageBitmap is available. Only works when createImageBitmap is supported on the browser.
678
+ */
679
+ srcX?: number;
680
+ /**
681
+ * The y coordinate of the reference point of the rectangle from which the Texture
682
+ * will be extracted. Only used when source `srcWidth` width and `srcHeight` height
683
+ * are provided. Only works when createImageBitmap is supported on the browser.
684
+ */
685
+ srcY?: number;
686
+ /**
687
+ * By enabling Strict bounds the renderer will not process & render child nodes of a node that is out of the visible area
688
+ *
689
+ * @remarks
690
+ * When enabled out of bound nodes, i.e. nodes that are out of the visible area, will
691
+ * **NOT** have their children processed and renderer anymore. This means the children of a out of bound
692
+ * node will not receive update processing such as positioning updates and will not be drawn on screen.
693
+ * As such the rest of the branch of the update tree that sits below this node will not be processed anymore
694
+ *
695
+ * This is a big performance gain but may be disabled in cases where the width of the parent node is
696
+ * unknown and the render must process the child nodes regardless of the viewport status of the parent node
697
+ *
698
+ * @default false
699
+ */
700
+ strictBounds: boolean;
701
+ }
702
+
703
+ /**
704
+ * Grab all the number properties of type T
705
+ */
706
+ type NumberProps<T> = {
707
+ [Key in keyof T as NonNullable<T[Key]> extends number ? Key : never]: number;
708
+ };
709
+
710
+ /**
711
+ * Properties of a Node used by the animate() function
712
+ */
713
+ export interface CoreNodeAnimateProps extends NumberProps<CoreNodeProps> {
714
+ /**
715
+ * Shader properties to animate
716
+ */
717
+ shaderProps: Record<string, number>;
718
+ // TODO: textureProps: Record<string, number>;
719
+ }
720
+
721
+ /**
722
+ * A visual Node in the Renderer scene graph.
723
+ *
724
+ * @remarks
725
+ * CoreNode is an internally used class that represents a Renderer Node in the
726
+ * scene graph. See INode.ts for the public APIs exposed to Renderer users
727
+ * that include generic types for Shaders.
728
+ */
729
+ export class CoreNode extends EventEmitter {
730
+ readonly children: CoreNode[] = [];
731
+ protected _id: number = getNewId();
732
+ readonly props: CoreNodeProps;
733
+
734
+ private hasShaderUpdater = false;
735
+ public updateType = UpdateType.All;
736
+ public childUpdateType = UpdateType.None;
737
+
738
+ public globalTransform?: Matrix3d;
739
+ public scaleRotateTransform?: Matrix3d;
740
+ public localTransform?: Matrix3d;
741
+ public sceneGlobalTransform?: Matrix3d;
742
+ public renderCoords?: RenderCoords;
743
+ public sceneRenderCoords?: RenderCoords;
744
+ public renderBound?: Bound;
745
+ public strictBound?: Bound;
746
+ public preloadBound?: Bound;
747
+ public clippingRect: RectWithValid = {
748
+ x: 0,
749
+ y: 0,
750
+ width: 0,
751
+ height: 0,
752
+ valid: false,
753
+ };
754
+ public textureCoords?: TextureCoords;
755
+ public updateTextureCoords?: boolean = false;
756
+ public isRenderable = false;
757
+ public renderState: CoreNodeRenderState = CoreNodeRenderState.Init;
758
+
759
+ public worldAlpha = 1;
760
+ public premultipliedColorTl = 0;
761
+ public premultipliedColorTr = 0;
762
+ public premultipliedColorBl = 0;
763
+ public premultipliedColorBr = 0;
764
+ public calcZIndex = 0;
765
+ public hasRTTupdates = false;
766
+ public parentHasRenderTexture = false;
767
+ public rttParent: CoreNode | null = null;
768
+
769
+ constructor(readonly stage: Stage, props: CoreNodeProps) {
770
+ super();
771
+
772
+ this.props = {
773
+ ...props,
774
+ parent: null,
775
+ texture: null,
776
+ shader: null,
777
+ src: null,
778
+ rtt: false,
779
+ };
780
+
781
+ // Assign props to instances
782
+ this.parent = props.parent;
783
+ this.texture = props.texture;
784
+ this.shader = props.shader;
785
+ this.src = props.src;
786
+ this.rtt = props.rtt;
787
+
788
+ if (props.boundsMargin) {
789
+ this.boundsMargin = Array.isArray(props.boundsMargin)
790
+ ? props.boundsMargin
791
+ : [
792
+ props.boundsMargin,
793
+ props.boundsMargin,
794
+ props.boundsMargin,
795
+ props.boundsMargin,
796
+ ];
797
+ }
798
+
799
+ this.setUpdateType(
800
+ UpdateType.ScaleRotate |
801
+ UpdateType.Local |
802
+ UpdateType.RenderBounds |
803
+ UpdateType.RenderState,
804
+ );
805
+
806
+ if (isProductionEnvironment() === false && props.preventCleanup === true) {
807
+ console.warn(
808
+ 'CoreNode.preventCleanup: Is deprecated and will be removed in upcoming release, please use textureOptions.preventCleanup instead',
809
+ );
810
+ }
811
+
812
+ // if the default texture isn't loaded yet, wait for it to load
813
+ // this only happens when the node is created before the stage is ready
814
+ if (
815
+ this.stage.defaultTexture &&
816
+ this.stage.defaultTexture.state !== 'loaded'
817
+ ) {
818
+ this.stage.defaultTexture.once('loaded', () => {
819
+ this.setUpdateType(UpdateType.IsRenderable);
820
+ });
821
+ }
822
+ }
823
+
824
+ //#region Textures
825
+ loadTexture(): void {
826
+ const { texture } = this.props;
827
+ assertTruthy(texture);
828
+
829
+ // If texture is already loaded / failed, trigger loaded event manually
830
+ // so that users get a consistent event experience.
831
+ // We do this in a microtask to allow listeners to be attached in the same
832
+ // synchronous task after calling loadTexture()
833
+ queueMicrotask(() => {
834
+ if (this.textureOptions.preload === true) {
835
+ this.stage.txManager.loadTexture(texture);
836
+ }
837
+
838
+ texture.preventCleanup =
839
+ this.props.textureOptions?.preventCleanup ?? false;
840
+ texture.on('loaded', this.onTextureLoaded);
841
+ texture.on('failed', this.onTextureFailed);
842
+ texture.on('freed', this.onTextureFreed);
843
+
844
+ // If the parent is a render texture, the initial texture status
845
+ // will be set to freed until the texture is processed by the
846
+ // Render RTT nodes. So we only need to listen fo changes and
847
+ // no need to check the texture.state until we restructure how
848
+ // textures are being processed.
849
+ if (this.parentHasRenderTexture) {
850
+ this.notifyParentRTTOfUpdate();
851
+ return;
852
+ }
853
+
854
+ if (texture.state === 'loaded') {
855
+ assertTruthy(texture.dimensions);
856
+ this.onTextureLoaded(texture, texture.dimensions);
857
+ } else if (texture.state === 'failed') {
858
+ assertTruthy(texture.error);
859
+ this.onTextureFailed(texture, texture.error);
860
+ } else if (texture.state === 'freed') {
861
+ this.onTextureFreed(texture);
862
+ }
863
+ });
864
+ }
865
+
866
+ unloadTexture(): void {
867
+ if (this.texture !== null) {
868
+ this.texture.off('loaded', this.onTextureLoaded);
869
+ this.texture.off('failed', this.onTextureFailed);
870
+ this.texture.off('freed', this.onTextureFreed);
871
+ this.texture.setRenderableOwner(this, false);
872
+ }
873
+ }
874
+
875
+ autosizeNode(dimensions: Dimensions) {
876
+ if (this.autosize) {
877
+ this.width = dimensions.width;
878
+ this.height = dimensions.height;
879
+ }
880
+ }
881
+
882
+ private onTextureLoaded: TextureLoadedEventHandler = (_, dimensions) => {
883
+ this.autosizeNode(dimensions);
884
+ this.setUpdateType(UpdateType.IsRenderable);
885
+
886
+ // Texture was loaded. In case the RAF loop has already stopped, we request
887
+ // a render to ensure the texture is rendered.
888
+ this.stage.requestRender();
889
+
890
+ // If parent has a render texture, flag that we need to update
891
+ if (this.parentHasRenderTexture) {
892
+ this.notifyParentRTTOfUpdate();
893
+ }
894
+
895
+ // ignore 1x1 pixel textures
896
+ if (dimensions.width > 1 && dimensions.height > 1) {
897
+ this.emit('loaded', {
898
+ type: 'texture',
899
+ dimensions,
900
+ } satisfies NodeTextureLoadedPayload);
901
+ }
902
+
903
+ // Trigger a local update if the texture is loaded and the resizeMode is 'contain'
904
+ if (this.props.textureOptions?.resizeMode?.type === 'contain') {
905
+ this.setUpdateType(UpdateType.Local);
906
+ }
907
+ };
908
+
909
+ private onTextureFailed: TextureFailedEventHandler = (_, error) => {
910
+ this.setUpdateType(UpdateType.IsRenderable);
911
+
912
+ // If parent has a render texture, flag that we need to update
913
+ if (this.parentHasRenderTexture) {
914
+ this.notifyParentRTTOfUpdate();
915
+ }
916
+
917
+ this.emit('failed', {
918
+ type: 'texture',
919
+ error,
920
+ } satisfies NodeTextureFailedPayload);
921
+ };
922
+
923
+ private onTextureFreed: TextureFreedEventHandler = () => {
924
+ this.setUpdateType(UpdateType.IsRenderable);
925
+
926
+ // If parent has a render texture, flag that we need to update
927
+ if (this.parentHasRenderTexture) {
928
+ this.notifyParentRTTOfUpdate();
929
+ }
930
+
931
+ this.emit('freed', {
932
+ type: 'texture',
933
+ } satisfies NodeTextureFreedPayload);
934
+ };
935
+ //#endregion Textures
936
+
937
+ /**
938
+ * Change types types is used to determine the scope of the changes being applied
939
+ *
940
+ * @remarks
941
+ * See {@link UpdateType} for more information on each type
942
+ *
943
+ * @param type
944
+ */
945
+ setUpdateType(type: UpdateType): void {
946
+ this.updateType |= type;
947
+
948
+ const parent = this.props.parent;
949
+ if (!parent) return;
950
+
951
+ if ((parent.updateType & UpdateType.Children) === 0) {
952
+ // Inform the parent if it doesn’t already have a child update
953
+ parent.setUpdateType(UpdateType.Children);
954
+ }
955
+ }
956
+
957
+ sortChildren() {
958
+ this.children.sort((a, b) => a.calcZIndex - b.calcZIndex);
959
+ }
960
+
961
+ updateScaleRotateTransform() {
962
+ const { rotation, scaleX, scaleY } = this.props;
963
+
964
+ // optimize simple translation cases
965
+ if (rotation === 0 && scaleX === 1 && scaleY === 1) {
966
+ this.scaleRotateTransform = undefined;
967
+ return;
968
+ }
969
+
970
+ this.scaleRotateTransform = Matrix3d.rotate(
971
+ rotation,
972
+ this.scaleRotateTransform,
973
+ ).scale(scaleX, scaleY);
974
+ }
975
+
976
+ updateLocalTransform() {
977
+ const { x, y, width, height } = this.props;
978
+ const mountTranslateX = this.props.mountX * width;
979
+ const mountTranslateY = this.props.mountY * height;
980
+
981
+ if (this.scaleRotateTransform) {
982
+ const pivotTranslateX = this.props.pivotX * width;
983
+ const pivotTranslateY = this.props.pivotY * height;
984
+
985
+ this.localTransform = Matrix3d.translate(
986
+ x - mountTranslateX + pivotTranslateX,
987
+ y - mountTranslateY + pivotTranslateY,
988
+ this.localTransform,
989
+ )
990
+ .multiply(this.scaleRotateTransform)
991
+ .translate(-pivotTranslateX, -pivotTranslateY);
992
+ } else {
993
+ this.localTransform = Matrix3d.translate(
994
+ x - mountTranslateX,
995
+ y - mountTranslateY,
996
+ this.localTransform,
997
+ );
998
+ }
999
+
1000
+ // Handle 'contain' resize mode
1001
+ const texture = this.props.texture;
1002
+ if (
1003
+ texture &&
1004
+ texture.dimensions &&
1005
+ this.props.textureOptions?.resizeMode?.type === 'contain'
1006
+ ) {
1007
+ let resizeModeScaleX = 1;
1008
+ let resizeModeScaleY = 1;
1009
+ let extraX = 0;
1010
+ let extraY = 0;
1011
+ const { width: tw, height: th } = texture.dimensions;
1012
+ const txAspectRatio = tw / th;
1013
+ const nodeAspectRatio = width / height;
1014
+ if (txAspectRatio > nodeAspectRatio) {
1015
+ // Texture is wider than node
1016
+ // Center the node vertically (shift down by extraY)
1017
+ // Scale the node vertically to maintain original aspect ratio
1018
+ const scaleX = width / tw;
1019
+ const scaledTxHeight = th * scaleX;
1020
+ extraY = (height - scaledTxHeight) / 2;
1021
+ resizeModeScaleY = scaledTxHeight / height;
1022
+ } else {
1023
+ // Texture is taller than node (or equal)
1024
+ // Center the node horizontally (shift right by extraX)
1025
+ // Scale the node horizontally to maintain original aspect ratio
1026
+ const scaleY = height / th;
1027
+ const scaledTxWidth = tw * scaleY;
1028
+ extraX = (width - scaledTxWidth) / 2;
1029
+ resizeModeScaleX = scaledTxWidth / width;
1030
+ }
1031
+
1032
+ // Apply the extra translation and scale to the local transform
1033
+ this.localTransform
1034
+ .translate(extraX, extraY)
1035
+ .scale(resizeModeScaleX, resizeModeScaleY);
1036
+ }
1037
+
1038
+ this.setUpdateType(UpdateType.Global);
1039
+ }
1040
+
1041
+ /**
1042
+ * @todo: test for correct calculation flag
1043
+ * @param delta
1044
+ */
1045
+ update(delta: number, parentClippingRect: RectWithValid): void {
1046
+ if (this.updateType & UpdateType.ScaleRotate) {
1047
+ this.updateScaleRotateTransform();
1048
+ this.setUpdateType(UpdateType.Local);
1049
+ }
1050
+
1051
+ if (this.updateType & UpdateType.Local) {
1052
+ this.updateLocalTransform();
1053
+ this.setUpdateType(UpdateType.Global);
1054
+ }
1055
+
1056
+ const parent = this.props.parent;
1057
+ let renderState: CoreNodeRenderState | null = null;
1058
+
1059
+ // Handle specific RTT updates at this node level
1060
+ if (this.updateType & UpdateType.RenderTexture && this.rtt) {
1061
+ this.hasRTTupdates = true;
1062
+ }
1063
+
1064
+ if (this.updateType & UpdateType.Global) {
1065
+ assertTruthy(this.localTransform);
1066
+
1067
+ if (this.parentHasRenderTexture === true && parent?.rtt === true) {
1068
+ // we are at the start of the RTT chain, so we need to reset the globalTransform
1069
+ // for correct RTT rendering
1070
+ this.globalTransform = Matrix3d.identity();
1071
+
1072
+ // Maintain a full scene global transform for bounds detection
1073
+ this.sceneGlobalTransform = Matrix3d.copy(
1074
+ parent?.globalTransform || Matrix3d.identity(),
1075
+ ).multiply(this.localTransform);
1076
+ } else if (
1077
+ this.parentHasRenderTexture === true &&
1078
+ parent?.rtt === false
1079
+ ) {
1080
+ // we're part of an RTT chain but our parent is not the main RTT node
1081
+ // so we need to propogate the sceneGlobalTransform of the parent
1082
+ // to maintain a full scene global transform for bounds detection
1083
+ this.sceneGlobalTransform = Matrix3d.copy(
1084
+ parent?.sceneGlobalTransform || this.localTransform,
1085
+ ).multiply(this.localTransform);
1086
+
1087
+ this.globalTransform = Matrix3d.copy(
1088
+ parent?.globalTransform || this.localTransform,
1089
+ this.globalTransform,
1090
+ );
1091
+ } else {
1092
+ this.globalTransform = Matrix3d.copy(
1093
+ parent?.globalTransform || this.localTransform,
1094
+ this.globalTransform,
1095
+ );
1096
+ }
1097
+
1098
+ if (parent !== null) {
1099
+ this.globalTransform.multiply(this.localTransform);
1100
+ }
1101
+ this.calculateRenderCoords();
1102
+ this.updateBoundingRect();
1103
+
1104
+ this.setUpdateType(
1105
+ UpdateType.RenderState |
1106
+ UpdateType.Children |
1107
+ UpdateType.RecalcUniforms,
1108
+ );
1109
+ this.childUpdateType |= UpdateType.Global;
1110
+
1111
+ if (this.clipping === true) {
1112
+ this.setUpdateType(UpdateType.Clipping | UpdateType.RenderBounds);
1113
+ this.childUpdateType |= UpdateType.RenderBounds;
1114
+ }
1115
+ }
1116
+
1117
+ if (this.updateType & UpdateType.RenderBounds) {
1118
+ this.createRenderBounds();
1119
+ this.setUpdateType(UpdateType.RenderState);
1120
+ this.setUpdateType(UpdateType.Children);
1121
+
1122
+ this.childUpdateType |= UpdateType.RenderBounds;
1123
+ }
1124
+
1125
+ if (this.updateType & UpdateType.RenderState) {
1126
+ renderState = this.checkRenderBounds();
1127
+ this.setUpdateType(UpdateType.IsRenderable);
1128
+
1129
+ // if we're not going out of bounds, update the render state
1130
+ // this is done so the update loop can finish before we mark a node
1131
+ // as out of bounds
1132
+ if (renderState !== CoreNodeRenderState.OutOfBounds) {
1133
+ this.updateRenderState(renderState);
1134
+ }
1135
+ }
1136
+
1137
+ if (this.updateType & UpdateType.WorldAlpha) {
1138
+ if (parent) {
1139
+ this.worldAlpha = parent.worldAlpha * this.props.alpha;
1140
+ } else {
1141
+ this.worldAlpha = this.props.alpha;
1142
+ }
1143
+ this.setUpdateType(
1144
+ UpdateType.Children |
1145
+ UpdateType.PremultipliedColors |
1146
+ UpdateType.IsRenderable,
1147
+ );
1148
+ this.childUpdateType |= UpdateType.WorldAlpha;
1149
+ }
1150
+
1151
+ if (this.updateType & UpdateType.IsRenderable) {
1152
+ this.updateIsRenderable();
1153
+ }
1154
+
1155
+ if (this.updateType & UpdateType.Clipping) {
1156
+ this.calculateClippingRect(parentClippingRect);
1157
+ this.setUpdateType(UpdateType.Children);
1158
+
1159
+ this.childUpdateType |= UpdateType.Clipping;
1160
+ this.childUpdateType |= UpdateType.RenderBounds;
1161
+ }
1162
+
1163
+ if (this.updateType & UpdateType.PremultipliedColors) {
1164
+ this.premultipliedColorTl = mergeColorAlphaPremultiplied(
1165
+ this.props.colorTl,
1166
+ this.worldAlpha,
1167
+ true,
1168
+ );
1169
+
1170
+ // If all the colors are the same just sent them all to the same value
1171
+ if (
1172
+ this.props.colorTl === this.props.colorTr &&
1173
+ this.props.colorBl === this.props.colorBr &&
1174
+ this.props.colorTl === this.props.colorBl
1175
+ ) {
1176
+ this.premultipliedColorTr =
1177
+ this.premultipliedColorBl =
1178
+ this.premultipliedColorBr =
1179
+ this.premultipliedColorTl;
1180
+ } else {
1181
+ this.premultipliedColorTr = mergeColorAlphaPremultiplied(
1182
+ this.props.colorTr,
1183
+ this.worldAlpha,
1184
+ true,
1185
+ );
1186
+ this.premultipliedColorBl = mergeColorAlphaPremultiplied(
1187
+ this.props.colorBl,
1188
+ this.worldAlpha,
1189
+ true,
1190
+ );
1191
+ this.premultipliedColorBr = mergeColorAlphaPremultiplied(
1192
+ this.props.colorBr,
1193
+ this.worldAlpha,
1194
+ true,
1195
+ );
1196
+ }
1197
+ }
1198
+
1199
+ // No need to update zIndex if there is no parent
1200
+ if (parent !== null && this.updateType & UpdateType.CalculatedZIndex) {
1201
+ this.calculateZIndex();
1202
+ // Tell parent to re-sort children
1203
+ parent.setUpdateType(UpdateType.ZIndexSortedChildren);
1204
+ }
1205
+
1206
+ if (
1207
+ this.props.strictBounds === true &&
1208
+ this.renderState === CoreNodeRenderState.OutOfBounds
1209
+ ) {
1210
+ this.updateType &= ~UpdateType.RenderBounds; // remove render bounds update
1211
+ return;
1212
+ }
1213
+
1214
+ if (
1215
+ this.updateType & UpdateType.RecalcUniforms &&
1216
+ this.hasShaderUpdater === true
1217
+ ) {
1218
+ //this exists because the boolean hasShaderUpdater === true
1219
+ this.shader!.update!();
1220
+ }
1221
+
1222
+ if (this.updateType & UpdateType.Children && this.children.length > 0) {
1223
+ for (let i = 0, length = this.children.length; i < length; i++) {
1224
+ const child = this.children[i] as CoreNode;
1225
+
1226
+ child.setUpdateType(this.childUpdateType);
1227
+
1228
+ if (child.updateType === 0) {
1229
+ continue;
1230
+ }
1231
+
1232
+ let childClippingRect = this.clippingRect;
1233
+ if (this.rtt === true) {
1234
+ childClippingRect = {
1235
+ x: 0,
1236
+ y: 0,
1237
+ width: 0,
1238
+ height: 0,
1239
+ valid: false,
1240
+ };
1241
+ }
1242
+
1243
+ child.update(delta, childClippingRect);
1244
+ }
1245
+ }
1246
+
1247
+ // If the node has an RTT parent and requires a texture re-render, inform the RTT parent
1248
+ // if (this.parentHasRenderTexture && this.updateType & UpdateType.RenderTexture) {
1249
+ // @TODO have a more scoped down updateType for RTT updates
1250
+ if (this.parentHasRenderTexture && this.updateType > 0) {
1251
+ this.notifyParentRTTOfUpdate();
1252
+ }
1253
+
1254
+ // Sorting children MUST happen after children have been updated so
1255
+ // that they have the oppotunity to update their calculated zIndex.
1256
+ if (this.updateType & UpdateType.ZIndexSortedChildren) {
1257
+ // reorder z-index
1258
+ this.sortChildren();
1259
+ }
1260
+
1261
+ if (this.updateTextureCoords === true) {
1262
+ this.updateTextureCoords = false;
1263
+ this.textureCoords = this.stage.renderer.getTextureCoords!(this);
1264
+ }
1265
+
1266
+ // If we're out of bounds, apply the render state now
1267
+ // this is done so nodes can finish their entire update loop before
1268
+ // being marked as out of bounds
1269
+ if (renderState === CoreNodeRenderState.OutOfBounds) {
1270
+ this.updateRenderState(renderState);
1271
+ this.updateIsRenderable();
1272
+
1273
+ if (
1274
+ this.rtt === true &&
1275
+ renderState === CoreNodeRenderState.OutOfBounds
1276
+ ) {
1277
+ // notify children that we are going out of bounds
1278
+ // we have to do this now before we stop processing the render tree
1279
+ this.notifyChildrenRTTOfUpdate(renderState);
1280
+ // this.childUpdateType |= UpdateType.RenderState;
1281
+ }
1282
+ }
1283
+
1284
+ // reset update type
1285
+ this.updateType = 0;
1286
+ this.childUpdateType = 0;
1287
+ }
1288
+
1289
+ private findParentRTTNode(): CoreNode | null {
1290
+ let rttNode: CoreNode | null = this.parent;
1291
+ while (rttNode && !rttNode.rtt) {
1292
+ rttNode = rttNode.parent;
1293
+ }
1294
+ return rttNode;
1295
+ }
1296
+
1297
+ private notifyChildrenRTTOfUpdate(renderState: CoreNodeRenderState) {
1298
+ for (const child of this.children) {
1299
+ // force child to update render state
1300
+ child.updateRenderState(renderState);
1301
+ child.updateIsRenderable();
1302
+ child.notifyChildrenRTTOfUpdate(renderState);
1303
+ }
1304
+ }
1305
+
1306
+ private notifyParentRTTOfUpdate() {
1307
+ if (this.parent === null) {
1308
+ return;
1309
+ }
1310
+
1311
+ const rttNode = this.rttParent || this.findParentRTTNode();
1312
+ if (!rttNode) {
1313
+ return;
1314
+ }
1315
+
1316
+ // If an RTT node is found, mark it for re-rendering
1317
+ rttNode.hasRTTupdates = true;
1318
+ rttNode.setUpdateType(UpdateType.RenderTexture);
1319
+
1320
+ // if rttNode is nested, also make it update its RTT parent
1321
+ if (rttNode.parentHasRenderTexture === true) {
1322
+ rttNode.notifyParentRTTOfUpdate();
1323
+ }
1324
+ }
1325
+
1326
+ checkRenderBounds(): CoreNodeRenderState {
1327
+ assertTruthy(this.renderBound);
1328
+ assertTruthy(this.strictBound);
1329
+ assertTruthy(this.preloadBound);
1330
+
1331
+ if (boundInsideBound(this.renderBound, this.strictBound)) {
1332
+ return CoreNodeRenderState.InViewport;
1333
+ }
1334
+
1335
+ if (boundInsideBound(this.renderBound, this.preloadBound)) {
1336
+ return CoreNodeRenderState.InBounds;
1337
+ }
1338
+
1339
+ // check if we're larger then our parent, we're definitely in the viewport
1340
+ if (boundLargeThanBound(this.renderBound, this.strictBound)) {
1341
+ return CoreNodeRenderState.InViewport;
1342
+ }
1343
+
1344
+ // check if we dont have dimensions, take our parent's render state
1345
+ if (
1346
+ this.parent !== null &&
1347
+ (this.props.width === 0 || this.props.height === 0)
1348
+ ) {
1349
+ return this.parent.renderState;
1350
+ }
1351
+
1352
+ return CoreNodeRenderState.OutOfBounds;
1353
+ }
1354
+
1355
+ updateBoundingRect() {
1356
+ const transform = this.sceneGlobalTransform || this.globalTransform;
1357
+ const renderCoords = this.sceneRenderCoords || this.renderCoords;
1358
+
1359
+ assertTruthy(transform);
1360
+ assertTruthy(renderCoords);
1361
+
1362
+ if (transform.tb === 0 || transform.tc === 0) {
1363
+ this.renderBound = createBound(
1364
+ renderCoords.x1,
1365
+ renderCoords.y1,
1366
+ renderCoords.x3,
1367
+ renderCoords.y3,
1368
+ this.renderBound,
1369
+ );
1370
+ } else {
1371
+ const { x1, y1, x2, y2, x3, y3, x4, y4 } = renderCoords;
1372
+ this.renderBound = createBound(
1373
+ Math.min(x1, x2, x3, x4),
1374
+ Math.min(y1, y2, y3, y4),
1375
+ Math.max(x1, x2, x3, x4),
1376
+ Math.max(y1, y2, y3, y4),
1377
+ this.renderBound,
1378
+ );
1379
+ }
1380
+ }
1381
+
1382
+ createRenderBounds(): void {
1383
+ assertTruthy(this.stage);
1384
+
1385
+ if (this.parent !== null && this.parent.strictBound !== undefined) {
1386
+ // we have a parent with a valid bound, copy it
1387
+ const parentBound = this.parent.strictBound;
1388
+ this.strictBound = createBound(
1389
+ parentBound.x1,
1390
+ parentBound.y1,
1391
+ parentBound.x2,
1392
+ parentBound.y2,
1393
+ );
1394
+
1395
+ this.preloadBound = createPreloadBounds(
1396
+ this.strictBound,
1397
+ this.boundsMargin as [number, number, number, number],
1398
+ );
1399
+ } else {
1400
+ // no parent or parent does not have a bound, take the stage boundaries
1401
+ this.strictBound = this.stage.strictBound;
1402
+ this.preloadBound = this.stage.preloadBound;
1403
+ }
1404
+
1405
+ // if clipping is disabled, we're done
1406
+ if (this.props.clipping === false) {
1407
+ return;
1408
+ }
1409
+
1410
+ // only create local clipping bounds if node itself is in bounds
1411
+ // this can only be done if we have a render bound already
1412
+ if (this.renderBound === undefined) {
1413
+ return;
1414
+ }
1415
+
1416
+ // if we're out of bounds, we're done
1417
+ if (boundInsideBound(this.renderBound, this.strictBound) === false) {
1418
+ return;
1419
+ }
1420
+
1421
+ // clipping is enabled and we are in bounds create our own bounds
1422
+ const { x, y, width, height } = this.props;
1423
+
1424
+ // Pick the global transform if available, otherwise use the local transform
1425
+ // global transform is only available if the node in an RTT chain
1426
+ const { tx, ty } = this.sceneGlobalTransform || this.globalTransform || {};
1427
+ const _x = tx ?? x;
1428
+ const _y = ty ?? y;
1429
+ this.strictBound = createBound(
1430
+ _x,
1431
+ _y,
1432
+ _x + width,
1433
+ _y + height,
1434
+ this.strictBound,
1435
+ );
1436
+
1437
+ this.preloadBound = createPreloadBounds(
1438
+ this.strictBound,
1439
+ this.boundsMargin as [number, number, number, number],
1440
+ );
1441
+ }
1442
+
1443
+ updateRenderState(renderState: CoreNodeRenderState) {
1444
+ if (renderState === this.renderState) {
1445
+ return;
1446
+ }
1447
+
1448
+ const previous = this.renderState;
1449
+ this.renderState = renderState;
1450
+ const event = CoreNodeRenderStateMap.get(renderState);
1451
+ assertTruthy(event);
1452
+ this.emit(event, {
1453
+ previous,
1454
+ current: renderState,
1455
+ });
1456
+ }
1457
+
1458
+ /**
1459
+ * Updates the `isRenderable` property based on various conditions.
1460
+ */
1461
+ updateIsRenderable() {
1462
+ let newIsRenderable = false;
1463
+ let needsTextureOwnership = false;
1464
+
1465
+ // If the node is out of bounds or has an alpha of 0, it is not renderable
1466
+ if (this.checkBasicRenderability() === false) {
1467
+ this.updateTextureOwnership(false);
1468
+ this.setRenderable(false);
1469
+ return;
1470
+ }
1471
+
1472
+ if (this.texture !== null) {
1473
+ needsTextureOwnership = true;
1474
+
1475
+ // we're only renderable if the texture state is loaded
1476
+ newIsRenderable = this.texture.state === 'loaded';
1477
+ } else if (
1478
+ (this.hasShader() || this.hasColorProperties() === true) &&
1479
+ this.hasDimensions() === true
1480
+ ) {
1481
+ // This mean we have dimensions and a color set, so we can render a ColorTexture
1482
+ if (
1483
+ this.stage.defaultTexture &&
1484
+ this.stage.defaultTexture.state === 'loaded'
1485
+ ) {
1486
+ newIsRenderable = true;
1487
+ }
1488
+ }
1489
+
1490
+ this.updateTextureOwnership(needsTextureOwnership);
1491
+ this.setRenderable(newIsRenderable);
1492
+ }
1493
+
1494
+ /**
1495
+ * Checks if the node is renderable based on world alpha, dimensions and out of bounds status.
1496
+ */
1497
+ checkBasicRenderability(): boolean {
1498
+ if (this.worldAlpha === 0 || this.isOutOfBounds() === true) {
1499
+ return false;
1500
+ } else {
1501
+ return true;
1502
+ }
1503
+ }
1504
+
1505
+ /**
1506
+ * Sets the renderable state and triggers changes if necessary.
1507
+ * @param isRenderable - The new renderable state
1508
+ */
1509
+ setRenderable(isRenderable: boolean) {
1510
+ this.isRenderable = isRenderable;
1511
+ if (
1512
+ isRenderable === true &&
1513
+ this.stage.calculateTextureCoord === true &&
1514
+ this.textureCoords === undefined
1515
+ ) {
1516
+ this.updateTextureCoords = true;
1517
+ }
1518
+ }
1519
+
1520
+ /**
1521
+ * Changes the renderable state of the node.
1522
+ */
1523
+ updateTextureOwnership(isRenderable: boolean) {
1524
+ this.texture?.setRenderableOwner(this, isRenderable);
1525
+ }
1526
+
1527
+ /**
1528
+ * Checks if the node is out of the viewport bounds.
1529
+ */
1530
+ isOutOfBounds(): boolean {
1531
+ return this.renderState <= CoreNodeRenderState.OutOfBounds;
1532
+ }
1533
+
1534
+ /**
1535
+ * Checks if the node has dimensions (width/height)
1536
+ */
1537
+ hasDimensions(): boolean {
1538
+ return this.props.width !== 0 && this.props.height !== 0;
1539
+ }
1540
+
1541
+ /**
1542
+ * Checks if the node has any color properties set.
1543
+ */
1544
+ hasColorProperties(): boolean {
1545
+ return (
1546
+ this.props.color !== 0 ||
1547
+ this.props.colorTop !== 0 ||
1548
+ this.props.colorBottom !== 0 ||
1549
+ this.props.colorLeft !== 0 ||
1550
+ this.props.colorRight !== 0 ||
1551
+ this.props.colorTl !== 0 ||
1552
+ this.props.colorTr !== 0 ||
1553
+ this.props.colorBl !== 0 ||
1554
+ this.props.colorBr !== 0
1555
+ );
1556
+ }
1557
+
1558
+ hasShader(): boolean {
1559
+ return this.props.shader !== null;
1560
+ }
1561
+
1562
+ calculateRenderCoords() {
1563
+ const { width, height } = this;
1564
+ const { tx, ty, ta, tb, tc, td } = this.globalTransform!;
1565
+ if (tb === 0 && tc === 0) {
1566
+ const minX = tx;
1567
+ const maxX = tx + width * ta;
1568
+ const minY = ty;
1569
+ const maxY = ty + height * td;
1570
+ this.renderCoords = RenderCoords.translate(
1571
+ //top-left
1572
+ minX,
1573
+ minY,
1574
+ //top-right
1575
+ maxX,
1576
+ minY,
1577
+ //bottom-right
1578
+ maxX,
1579
+ maxY,
1580
+ //bottom-left
1581
+ minX,
1582
+ maxY,
1583
+ this.renderCoords,
1584
+ );
1585
+ } else {
1586
+ this.renderCoords = RenderCoords.translate(
1587
+ //top-left
1588
+ tx,
1589
+ ty,
1590
+ //top-right
1591
+ tx + width * ta,
1592
+ ty + width * tc,
1593
+ //bottom-right
1594
+ tx + width * ta + height * tb,
1595
+ ty + width * tc + height * td,
1596
+ //bottom-left
1597
+ tx + height * tb,
1598
+ ty + height * td,
1599
+ this.renderCoords,
1600
+ );
1601
+ }
1602
+ if (this.sceneGlobalTransform === undefined) {
1603
+ return;
1604
+ }
1605
+
1606
+ const {
1607
+ tx: stx,
1608
+ ty: sty,
1609
+ ta: sta,
1610
+ tb: stb,
1611
+ tc: stc,
1612
+ td: std,
1613
+ } = this.sceneGlobalTransform;
1614
+ if (stb === 0 && stc === 0) {
1615
+ const minX = stx;
1616
+ const maxX = stx + width * sta;
1617
+ const minY = sty;
1618
+ const maxY = sty + height * std;
1619
+ this.sceneRenderCoords = RenderCoords.translate(
1620
+ //top-left
1621
+ minX,
1622
+ minY,
1623
+ //top-right
1624
+ maxX,
1625
+ minY,
1626
+ //bottom-right
1627
+ maxX,
1628
+ maxY,
1629
+ //bottom-left
1630
+ minX,
1631
+ maxY,
1632
+ this.sceneRenderCoords,
1633
+ );
1634
+ } else {
1635
+ this.sceneRenderCoords = RenderCoords.translate(
1636
+ //top-left
1637
+ stx,
1638
+ sty,
1639
+ //top-right
1640
+ stx + width * sta,
1641
+ sty + width * stc,
1642
+ //bottom-right
1643
+ stx + width * sta + height * stb,
1644
+ sty + width * stc + height * std,
1645
+ //bottom-left
1646
+ stx + height * stb,
1647
+ sty + height * std,
1648
+ this.sceneRenderCoords,
1649
+ );
1650
+ }
1651
+ }
1652
+
1653
+ /**
1654
+ * This function calculates the clipping rectangle for a node.
1655
+ *
1656
+ * 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.
1657
+ * 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.
1658
+ *
1659
+ * Finally, the node's parentClippingRect and clippingRect properties are updated.
1660
+ */
1661
+ calculateClippingRect(parentClippingRect: RectWithValid) {
1662
+ assertTruthy(this.globalTransform);
1663
+ const { clippingRect, props, globalTransform: gt } = this;
1664
+ const { clipping } = props;
1665
+ const isRotated = gt.tb !== 0 || gt.tc !== 0;
1666
+
1667
+ if (clipping === true && isRotated === false) {
1668
+ clippingRect.x = gt.tx;
1669
+ clippingRect.y = gt.ty;
1670
+ clippingRect.width = this.width * gt.ta;
1671
+ clippingRect.height = this.height * gt.td;
1672
+ clippingRect.valid = true;
1673
+ } else {
1674
+ clippingRect.valid = false;
1675
+ }
1676
+
1677
+ if (parentClippingRect.valid === true && clippingRect.valid === true) {
1678
+ // Intersect parent clipping rect with node clipping rect
1679
+ intersectRect(parentClippingRect, clippingRect, clippingRect);
1680
+ } else if (parentClippingRect.valid === true) {
1681
+ // Copy parent clipping rect
1682
+ copyRect(parentClippingRect, clippingRect);
1683
+ clippingRect.valid = true;
1684
+ }
1685
+ }
1686
+
1687
+ calculateZIndex(): void {
1688
+ const props = this.props;
1689
+ const z = props.zIndex || 0;
1690
+ const p = props.parent?.zIndex || 0;
1691
+
1692
+ let zIndex = z;
1693
+ if (props.parent?.zIndexLocked) {
1694
+ zIndex = z < p ? z : p;
1695
+ }
1696
+ this.calcZIndex = zIndex;
1697
+ }
1698
+
1699
+ /**
1700
+ * Destroy the node and cleanup all resources
1701
+ */
1702
+ destroy(): void {
1703
+ this.unloadTexture();
1704
+
1705
+ this.clippingRect.valid = false;
1706
+ this.isRenderable = false;
1707
+
1708
+ this.renderCoords = undefined;
1709
+ this.renderBound = undefined;
1710
+ this.strictBound = undefined;
1711
+ this.preloadBound = undefined;
1712
+ this.globalTransform = undefined;
1713
+ this.scaleRotateTransform = undefined;
1714
+ this.localTransform = undefined;
1715
+
1716
+ this.props.texture = null;
1717
+ this.props.shader = null;
1718
+
1719
+ while (this.children.length > 0) {
1720
+ this.children[0]?.destroy();
1721
+ }
1722
+
1723
+ // This very action will also remove the node from the parent's children array
1724
+ this.parent = null;
1725
+
1726
+ if (this.rtt) {
1727
+ this.stage.renderer.removeRTTNode(this);
1728
+ }
1729
+
1730
+ this.removeAllListeners();
1731
+ }
1732
+
1733
+ renderQuads(renderer: CoreRenderer): void {
1734
+ // Prevent quad rendering if parent has a render texture
1735
+ // and renderer is not currently rendering to a texture
1736
+ if (this.parentHasRenderTexture) {
1737
+ if (!renderer.renderToTextureActive) {
1738
+ return;
1739
+ }
1740
+ // Prevent quad rendering if parent render texture is not the active render texture
1741
+ if (this.parentRenderTexture !== renderer.activeRttNode) {
1742
+ return;
1743
+ }
1744
+ }
1745
+
1746
+ assertTruthy(this.globalTransform);
1747
+ assertTruthy(this.renderCoords);
1748
+
1749
+ // add to list of renderables to be sorted before rendering
1750
+ renderer.addQuad({
1751
+ width: this.props.width,
1752
+ height: this.props.height,
1753
+ colorTl: this.premultipliedColorTl,
1754
+ colorTr: this.premultipliedColorTr,
1755
+ colorBl: this.premultipliedColorBl,
1756
+ colorBr: this.premultipliedColorBr,
1757
+ // if we do not have a texture, use the default texture
1758
+ // this assumes any renderable node is either a distinct texture or a ColorTexture
1759
+ texture: this.texture || this.stage.defaultTexture,
1760
+ textureOptions: this.textureOptions,
1761
+ textureCoords: this.textureCoords,
1762
+ zIndex: this.zIndex,
1763
+ shader: this.props.shader as CoreShaderNode<any>,
1764
+ alpha: this.worldAlpha,
1765
+ clippingRect: this.clippingRect,
1766
+ tx: this.globalTransform.tx,
1767
+ ty: this.globalTransform.ty,
1768
+ ta: this.globalTransform.ta,
1769
+ tb: this.globalTransform.tb,
1770
+ tc: this.globalTransform.tc,
1771
+ td: this.globalTransform.td,
1772
+ renderCoords: this.renderCoords,
1773
+ rtt: this.rtt,
1774
+ parentHasRenderTexture: this.parentHasRenderTexture,
1775
+ framebufferDimensions: this.framebufferDimensions,
1776
+ });
1777
+ }
1778
+
1779
+ //#region Properties
1780
+ get id(): number {
1781
+ return this._id;
1782
+ }
1783
+
1784
+ get data(): CustomDataMap | undefined {
1785
+ return this.props.data;
1786
+ }
1787
+
1788
+ set data(d: CustomDataMap | undefined) {
1789
+ this.props.data = d;
1790
+ }
1791
+
1792
+ get x(): number {
1793
+ return this.props.x;
1794
+ }
1795
+
1796
+ set x(value: number) {
1797
+ if (this.props.x !== value) {
1798
+ this.props.x = value;
1799
+ this.setUpdateType(UpdateType.Local);
1800
+ }
1801
+ }
1802
+
1803
+ get absX(): number {
1804
+ return (
1805
+ this.props.x +
1806
+ -this.props.width * this.props.mountX +
1807
+ (this.props.parent?.absX || this.props.parent?.globalTransform?.tx || 0)
1808
+ );
1809
+ }
1810
+
1811
+ get absY(): number {
1812
+ return (
1813
+ this.props.y +
1814
+ -this.props.height * this.props.mountY +
1815
+ (this.props.parent?.absY ?? 0)
1816
+ );
1817
+ }
1818
+
1819
+ get y(): number {
1820
+ return this.props.y;
1821
+ }
1822
+
1823
+ set y(value: number) {
1824
+ if (this.props.y !== value) {
1825
+ this.props.y = value;
1826
+ this.setUpdateType(UpdateType.Local);
1827
+ }
1828
+ }
1829
+
1830
+ get width(): number {
1831
+ return this.props.width;
1832
+ }
1833
+
1834
+ set width(value: number) {
1835
+ if (this.props.width !== value) {
1836
+ this.props.width = value;
1837
+ this.setUpdateType(UpdateType.Local);
1838
+
1839
+ if (this.props.rtt) {
1840
+ this.texture = this.stage.txManager.createTexture('RenderTexture', {
1841
+ width: this.width,
1842
+ height: this.height,
1843
+ });
1844
+
1845
+ this.setUpdateType(UpdateType.RenderTexture);
1846
+ }
1847
+ }
1848
+ }
1849
+
1850
+ get height(): number {
1851
+ return this.props.height;
1852
+ }
1853
+
1854
+ set height(value: number) {
1855
+ if (this.props.height !== value) {
1856
+ this.props.height = value;
1857
+ this.setUpdateType(UpdateType.Local);
1858
+
1859
+ if (this.props.rtt) {
1860
+ this.texture = this.stage.txManager.createTexture('RenderTexture', {
1861
+ width: this.width,
1862
+ height: this.height,
1863
+ });
1864
+
1865
+ this.setUpdateType(UpdateType.RenderTexture);
1866
+ }
1867
+ }
1868
+ }
1869
+
1870
+ get scale(): number {
1871
+ // The CoreNode `scale` property is only used by Animations.
1872
+ // Unlike INode, `null` should never be possibility for Animations.
1873
+ return this.scaleX;
1874
+ }
1875
+
1876
+ set scale(value: number) {
1877
+ // The CoreNode `scale` property is only used by Animations.
1878
+ // Unlike INode, `null` should never be possibility for Animations.
1879
+ this.scaleX = value;
1880
+ this.scaleY = value;
1881
+ }
1882
+
1883
+ get scaleX(): number {
1884
+ return this.props.scaleX;
1885
+ }
1886
+
1887
+ set scaleX(value: number) {
1888
+ if (this.props.scaleX !== value) {
1889
+ this.props.scaleX = value;
1890
+ this.setUpdateType(UpdateType.ScaleRotate);
1891
+ }
1892
+ }
1893
+
1894
+ get scaleY(): number {
1895
+ return this.props.scaleY;
1896
+ }
1897
+
1898
+ set scaleY(value: number) {
1899
+ if (this.props.scaleY !== value) {
1900
+ this.props.scaleY = value;
1901
+ this.setUpdateType(UpdateType.ScaleRotate);
1902
+ }
1903
+ }
1904
+
1905
+ get mount(): number {
1906
+ return this.props.mount;
1907
+ }
1908
+
1909
+ set mount(value: number) {
1910
+ if (this.props.mountX !== value || this.props.mountY !== value) {
1911
+ this.props.mountX = value;
1912
+ this.props.mountY = value;
1913
+ this.props.mount = value;
1914
+ this.setUpdateType(UpdateType.Local);
1915
+ }
1916
+ }
1917
+
1918
+ get mountX(): number {
1919
+ return this.props.mountX;
1920
+ }
1921
+
1922
+ set mountX(value: number) {
1923
+ if (this.props.mountX !== value) {
1924
+ this.props.mountX = value;
1925
+ this.setUpdateType(UpdateType.Local);
1926
+ }
1927
+ }
1928
+
1929
+ get mountY(): number {
1930
+ return this.props.mountY;
1931
+ }
1932
+
1933
+ set mountY(value: number) {
1934
+ if (this.props.mountY !== value) {
1935
+ this.props.mountY = value;
1936
+ this.setUpdateType(UpdateType.Local);
1937
+ }
1938
+ }
1939
+
1940
+ get pivot(): number {
1941
+ return this.props.pivot;
1942
+ }
1943
+
1944
+ set pivot(value: number) {
1945
+ if (this.props.pivotX !== value || this.props.pivotY !== value) {
1946
+ this.props.pivotX = value;
1947
+ this.props.pivotY = value;
1948
+ this.props.pivot = value;
1949
+ this.setUpdateType(UpdateType.Local);
1950
+ }
1951
+ }
1952
+
1953
+ get pivotX(): number {
1954
+ return this.props.pivotX;
1955
+ }
1956
+
1957
+ set pivotX(value: number) {
1958
+ if (this.props.pivotX !== value) {
1959
+ this.props.pivotX = value;
1960
+ this.setUpdateType(UpdateType.Local);
1961
+ }
1962
+ }
1963
+
1964
+ get pivotY(): number {
1965
+ return this.props.pivotY;
1966
+ }
1967
+
1968
+ set pivotY(value: number) {
1969
+ if (this.props.pivotY !== value) {
1970
+ this.props.pivotY = value;
1971
+ this.setUpdateType(UpdateType.Local);
1972
+ }
1973
+ }
1974
+
1975
+ get rotation(): number {
1976
+ return this.props.rotation;
1977
+ }
1978
+
1979
+ set rotation(value: number) {
1980
+ if (this.props.rotation !== value) {
1981
+ this.props.rotation = value;
1982
+ this.setUpdateType(UpdateType.ScaleRotate);
1983
+ }
1984
+ }
1985
+
1986
+ get alpha(): number {
1987
+ return this.props.alpha;
1988
+ }
1989
+
1990
+ set alpha(value: number) {
1991
+ this.props.alpha = value;
1992
+ this.setUpdateType(
1993
+ UpdateType.PremultipliedColors |
1994
+ UpdateType.WorldAlpha |
1995
+ UpdateType.Children |
1996
+ UpdateType.IsRenderable,
1997
+ );
1998
+ this.childUpdateType |= UpdateType.WorldAlpha;
1999
+ }
2000
+
2001
+ get autosize(): boolean {
2002
+ return this.props.autosize;
2003
+ }
2004
+
2005
+ set autosize(value: boolean) {
2006
+ this.props.autosize = value;
2007
+ }
2008
+
2009
+ get boundsMargin(): number | [number, number, number, number] | null {
2010
+ return (
2011
+ this.props.boundsMargin ??
2012
+ this.parent?.boundsMargin ??
2013
+ this.stage.boundsMargin
2014
+ );
2015
+ }
2016
+
2017
+ set boundsMargin(value: number | [number, number, number, number] | null) {
2018
+ if (value === this.props.boundsMargin) {
2019
+ return;
2020
+ }
2021
+
2022
+ if (value === null) {
2023
+ this.props.boundsMargin = value;
2024
+ } else {
2025
+ const bm: [number, number, number, number] = Array.isArray(value)
2026
+ ? value
2027
+ : [value, value, value, value];
2028
+
2029
+ this.props.boundsMargin = bm;
2030
+ }
2031
+ this.setUpdateType(UpdateType.RenderBounds);
2032
+ }
2033
+
2034
+ get clipping(): boolean {
2035
+ return this.props.clipping;
2036
+ }
2037
+
2038
+ set clipping(value: boolean) {
2039
+ this.props.clipping = value;
2040
+ this.setUpdateType(
2041
+ UpdateType.Clipping | UpdateType.RenderBounds | UpdateType.Children,
2042
+ );
2043
+ this.childUpdateType |= UpdateType.Global | UpdateType.Clipping;
2044
+ }
2045
+
2046
+ get color(): number {
2047
+ return this.props.color;
2048
+ }
2049
+
2050
+ set color(value: number) {
2051
+ this.colorTop = value;
2052
+ this.colorBottom = value;
2053
+ this.colorLeft = value;
2054
+ this.colorRight = value;
2055
+ this.props.color = value;
2056
+
2057
+ this.setUpdateType(UpdateType.PremultipliedColors);
2058
+ }
2059
+
2060
+ get colorTop(): number {
2061
+ return this.props.colorTop;
2062
+ }
2063
+
2064
+ set colorTop(value: number) {
2065
+ if (this.props.colorTl !== value || this.props.colorTr !== value) {
2066
+ this.colorTl = value;
2067
+ this.colorTr = value;
2068
+ }
2069
+ this.props.colorTop = value;
2070
+ this.setUpdateType(UpdateType.PremultipliedColors);
2071
+ }
2072
+
2073
+ get colorBottom(): number {
2074
+ return this.props.colorBottom;
2075
+ }
2076
+
2077
+ set colorBottom(value: number) {
2078
+ if (this.props.colorBl !== value || this.props.colorBr !== value) {
2079
+ this.colorBl = value;
2080
+ this.colorBr = value;
2081
+ }
2082
+ this.props.colorBottom = value;
2083
+ this.setUpdateType(UpdateType.PremultipliedColors);
2084
+ }
2085
+
2086
+ get colorLeft(): number {
2087
+ return this.props.colorLeft;
2088
+ }
2089
+
2090
+ set colorLeft(value: number) {
2091
+ if (this.props.colorTl !== value || this.props.colorBl !== value) {
2092
+ this.colorTl = value;
2093
+ this.colorBl = value;
2094
+ }
2095
+ this.props.colorLeft = value;
2096
+ this.setUpdateType(UpdateType.PremultipliedColors);
2097
+ }
2098
+
2099
+ get colorRight(): number {
2100
+ return this.props.colorRight;
2101
+ }
2102
+
2103
+ set colorRight(value: number) {
2104
+ if (this.props.colorTr !== value || this.props.colorBr !== value) {
2105
+ this.colorTr = value;
2106
+ this.colorBr = value;
2107
+ }
2108
+ this.props.colorRight = value;
2109
+ this.setUpdateType(UpdateType.PremultipliedColors);
2110
+ }
2111
+
2112
+ get colorTl(): number {
2113
+ return this.props.colorTl;
2114
+ }
2115
+
2116
+ set colorTl(value: number) {
2117
+ this.props.colorTl = value;
2118
+ this.setUpdateType(UpdateType.PremultipliedColors);
2119
+ }
2120
+
2121
+ get colorTr(): number {
2122
+ return this.props.colorTr;
2123
+ }
2124
+
2125
+ set colorTr(value: number) {
2126
+ this.props.colorTr = value;
2127
+ this.setUpdateType(UpdateType.PremultipliedColors);
2128
+ }
2129
+
2130
+ get colorBl(): number {
2131
+ return this.props.colorBl;
2132
+ }
2133
+
2134
+ set colorBl(value: number) {
2135
+ this.props.colorBl = value;
2136
+ this.setUpdateType(UpdateType.PremultipliedColors);
2137
+ }
2138
+
2139
+ get colorBr(): number {
2140
+ return this.props.colorBr;
2141
+ }
2142
+
2143
+ set colorBr(value: number) {
2144
+ this.props.colorBr = value;
2145
+ this.setUpdateType(UpdateType.PremultipliedColors);
2146
+ }
2147
+
2148
+ // we're only interested in parent zIndex to test
2149
+ // if we should use node zIndex is higher then parent zIndex
2150
+ get zIndexLocked(): number {
2151
+ return this.props.zIndexLocked || 0;
2152
+ }
2153
+
2154
+ set zIndexLocked(value: number) {
2155
+ this.props.zIndexLocked = value;
2156
+ this.setUpdateType(UpdateType.CalculatedZIndex | UpdateType.Children);
2157
+ for (let i = 0, length = this.children.length; i < length; i++) {
2158
+ this.children[i]!.setUpdateType(UpdateType.CalculatedZIndex);
2159
+ }
2160
+ }
2161
+
2162
+ get zIndex(): number {
2163
+ return this.props.zIndex;
2164
+ }
2165
+
2166
+ set zIndex(value: number) {
2167
+ this.props.zIndex = value;
2168
+ this.setUpdateType(UpdateType.CalculatedZIndex | UpdateType.Children);
2169
+ for (let i = 0, length = this.children.length; i < length; i++) {
2170
+ this.children[i]!.setUpdateType(UpdateType.CalculatedZIndex);
2171
+ }
2172
+ }
2173
+
2174
+ get parent(): CoreNode | null {
2175
+ return this.props.parent;
2176
+ }
2177
+
2178
+ set parent(newParent: CoreNode | null) {
2179
+ const oldParent = this.props.parent;
2180
+ if (oldParent === newParent) {
2181
+ return;
2182
+ }
2183
+ this.props.parent = newParent;
2184
+ if (oldParent) {
2185
+ const index = oldParent.children.indexOf(this);
2186
+ assertTruthy(
2187
+ index !== -1,
2188
+ "CoreNode.parent: Node not found in old parent's children!",
2189
+ );
2190
+ oldParent.children.splice(index, 1);
2191
+ oldParent.setUpdateType(
2192
+ UpdateType.Children | UpdateType.ZIndexSortedChildren,
2193
+ );
2194
+ }
2195
+ if (newParent) {
2196
+ newParent.children.push(this);
2197
+ // Since this node has a new parent, to be safe, have it do a full update.
2198
+ this.setUpdateType(UpdateType.All);
2199
+ // Tell parent that it's children need to be updated and sorted.
2200
+ newParent.setUpdateType(
2201
+ UpdateType.Children | UpdateType.ZIndexSortedChildren,
2202
+ );
2203
+
2204
+ // If the new parent has an RTT enabled, apply RTT inheritance
2205
+ if (newParent.rtt || newParent.parentHasRenderTexture) {
2206
+ this.applyRTTInheritance(newParent);
2207
+ }
2208
+ }
2209
+ this.updateScaleRotateTransform();
2210
+
2211
+ // fetch render bounds from parent
2212
+ this.setUpdateType(UpdateType.RenderBounds | UpdateType.Children);
2213
+ }
2214
+
2215
+ get preventCleanup(): boolean {
2216
+ return this.props.textureOptions.preventCleanup || false;
2217
+ }
2218
+
2219
+ set preventCleanup(value: boolean) {
2220
+ if (isProductionEnvironment() === false) {
2221
+ console.warn(
2222
+ 'CoreNode.preventCleanup: Is deprecated and will be removed in upcoming release, please use textureOptions.preventCleanup instead',
2223
+ );
2224
+ }
2225
+
2226
+ this.props.textureOptions.preventCleanup = value;
2227
+ }
2228
+
2229
+ get rtt(): boolean {
2230
+ return this.props.rtt;
2231
+ }
2232
+
2233
+ set rtt(value: boolean) {
2234
+ if (this.props.rtt === value) {
2235
+ return;
2236
+ }
2237
+ this.props.rtt = value;
2238
+
2239
+ if (value === true) {
2240
+ this.initRenderTexture();
2241
+ this.markChildrenWithRTT();
2242
+ } else {
2243
+ this.cleanupRenderTexture();
2244
+ }
2245
+
2246
+ this.setUpdateType(UpdateType.RenderTexture);
2247
+
2248
+ if (this.parentHasRenderTexture === true) {
2249
+ this.notifyParentRTTOfUpdate();
2250
+ }
2251
+ }
2252
+ private initRenderTexture() {
2253
+ this.texture = this.stage.txManager.createTexture('RenderTexture', {
2254
+ width: this.width,
2255
+ height: this.height,
2256
+ });
2257
+
2258
+ this.stage.renderer.renderToTexture(this);
2259
+ }
2260
+
2261
+ private cleanupRenderTexture() {
2262
+ this.unloadTexture();
2263
+ this.clearRTTInheritance();
2264
+
2265
+ this.hasRTTupdates = false;
2266
+ this.texture = null;
2267
+ }
2268
+
2269
+ private markChildrenWithRTT(node: CoreNode | null = null) {
2270
+ const parent = node || this;
2271
+
2272
+ for (const child of parent.children) {
2273
+ child.setUpdateType(UpdateType.All);
2274
+ child.parentHasRenderTexture = true;
2275
+ child.markChildrenWithRTT();
2276
+ }
2277
+ }
2278
+
2279
+ // Apply RTT inheritance when a node has an RTT-enabled parent
2280
+ private applyRTTInheritance(parent: CoreNode) {
2281
+ if (parent.rtt) {
2282
+ // Only the RTT node should be added to `renderToTexture`
2283
+ parent.setUpdateType(UpdateType.RenderTexture);
2284
+ }
2285
+
2286
+ // Propagate `parentHasRenderTexture` downwards
2287
+ this.markChildrenWithRTT(parent);
2288
+ }
2289
+
2290
+ // Clear RTT inheritance when detaching from an RTT chain
2291
+ private clearRTTInheritance() {
2292
+ // if this node is RTT itself stop the propagation important for nested RTT nodes
2293
+ // for the initial RTT node this is already handled in `set rtt`
2294
+ if (this.rtt) {
2295
+ return;
2296
+ }
2297
+
2298
+ for (const child of this.children) {
2299
+ // force child to update everything as the RTT inheritance has changed
2300
+ child.parentHasRenderTexture = false;
2301
+ child.rttParent = null;
2302
+ child.setUpdateType(UpdateType.All);
2303
+ child.clearRTTInheritance();
2304
+ }
2305
+ }
2306
+
2307
+ get shader(): CoreShaderNode<any> | null {
2308
+ return this.props.shader;
2309
+ }
2310
+
2311
+ set shader(shader: CoreShaderNode<any> | null) {
2312
+ if (this.props.shader === shader) {
2313
+ return;
2314
+ }
2315
+ if (shader === null) {
2316
+ this.hasShaderUpdater = false;
2317
+ this.props.shader = this.stage.defShaderNode;
2318
+ this.setUpdateType(UpdateType.IsRenderable);
2319
+ return;
2320
+ }
2321
+ if (shader.shaderKey !== 'default') {
2322
+ this.hasShaderUpdater = shader.update !== undefined;
2323
+ shader.attachNode(this);
2324
+ }
2325
+ this.props.shader = shader;
2326
+ this.setUpdateType(UpdateType.IsRenderable | UpdateType.RecalcUniforms);
2327
+ }
2328
+
2329
+ get src(): string | null {
2330
+ return this.props.src;
2331
+ }
2332
+
2333
+ set src(imageUrl: string | null) {
2334
+ if (this.props.src === imageUrl) {
2335
+ return;
2336
+ }
2337
+
2338
+ this.props.src = imageUrl;
2339
+
2340
+ if (!imageUrl) {
2341
+ this.texture = null;
2342
+ return;
2343
+ }
2344
+
2345
+ this.texture = this.stage.txManager.createTexture('ImageTexture', {
2346
+ src: imageUrl,
2347
+ width: this.props.width,
2348
+ height: this.props.height,
2349
+ type: this.props.imageType,
2350
+ sx: this.props.srcX,
2351
+ sy: this.props.srcY,
2352
+ sw: this.props.srcWidth,
2353
+ sh: this.props.srcHeight,
2354
+ });
2355
+ }
2356
+
2357
+ set imageType(type: 'regular' | 'compressed' | 'svg' | null) {
2358
+ if (this.props.imageType === type) {
2359
+ return;
2360
+ }
2361
+
2362
+ this.props.imageType = type;
2363
+ }
2364
+
2365
+ get imageType() {
2366
+ return this.props.imageType || null;
2367
+ }
2368
+
2369
+ get srcHeight(): number | undefined {
2370
+ return this.props.srcHeight;
2371
+ }
2372
+
2373
+ set srcHeight(value: number) {
2374
+ this.props.srcHeight = value;
2375
+ }
2376
+
2377
+ get srcWidth(): number | undefined {
2378
+ return this.props.srcWidth;
2379
+ }
2380
+
2381
+ set srcWidth(value: number) {
2382
+ this.props.srcWidth = value;
2383
+ }
2384
+
2385
+ get srcX(): number | undefined {
2386
+ return this.props.srcX;
2387
+ }
2388
+
2389
+ set srcX(value: number) {
2390
+ this.props.srcX = value;
2391
+ }
2392
+
2393
+ get srcY(): number | undefined {
2394
+ return this.props.srcY;
2395
+ }
2396
+
2397
+ set srcY(value: number) {
2398
+ this.props.srcY = value;
2399
+ }
2400
+
2401
+ /**
2402
+ * Returns the framebuffer dimensions of the node.
2403
+ * If the node has a render texture, the dimensions are the same as the node's dimensions.
2404
+ * If the node does not have a render texture, the dimensions are inherited from the parent.
2405
+ * If the node parent has a render texture and the node is a render texture, the nodes dimensions are used.
2406
+ */
2407
+ get framebufferDimensions(): Dimensions {
2408
+ if (this.parentHasRenderTexture && !this.rtt && this.parent) {
2409
+ return this.parent.framebufferDimensions;
2410
+ }
2411
+ return { width: this.width, height: this.height };
2412
+ }
2413
+
2414
+ /**
2415
+ * Returns the parent render texture node if it exists.
2416
+ */
2417
+ get parentRenderTexture(): CoreNode | null {
2418
+ let parent = this.parent;
2419
+ while (parent) {
2420
+ if (parent.rtt) {
2421
+ return parent;
2422
+ }
2423
+ parent = parent.parent;
2424
+ }
2425
+ return null;
2426
+ }
2427
+
2428
+ get texture(): Texture | null {
2429
+ return this.props.texture;
2430
+ }
2431
+
2432
+ set texture(value: Texture | null) {
2433
+ if (this.props.texture === value) {
2434
+ return;
2435
+ }
2436
+
2437
+ const oldTexture = this.props.texture;
2438
+ if (oldTexture) {
2439
+ oldTexture.setRenderableOwner(this, false);
2440
+ this.unloadTexture();
2441
+ }
2442
+
2443
+ this.textureCoords = undefined;
2444
+ this.props.texture = value;
2445
+ if (value !== null) {
2446
+ value.setRenderableOwner(this, this.isRenderable);
2447
+ this.loadTexture();
2448
+ }
2449
+
2450
+ this.setUpdateType(UpdateType.IsRenderable);
2451
+ }
2452
+
2453
+ set textureOptions(value: TextureOptions) {
2454
+ this.props.textureOptions = value;
2455
+ }
2456
+
2457
+ get textureOptions(): TextureOptions {
2458
+ return this.props.textureOptions;
2459
+ }
2460
+
2461
+ get strictBounds(): boolean {
2462
+ return this.props.strictBounds;
2463
+ }
2464
+
2465
+ set strictBounds(v) {
2466
+ if (v === this.props.strictBounds) {
2467
+ return;
2468
+ }
2469
+
2470
+ this.props.strictBounds = v;
2471
+ this.setUpdateType(UpdateType.RenderBounds | UpdateType.Children);
2472
+ this.childUpdateType |= UpdateType.RenderBounds | UpdateType.Children;
2473
+ }
2474
+
2475
+ animate(
2476
+ props: Partial<CoreNodeAnimateProps>,
2477
+ settings: Partial<AnimationSettings>,
2478
+ ): IAnimationController {
2479
+ const animation = new CoreAnimation(this, props, settings);
2480
+
2481
+ const controller = new CoreAnimationController(
2482
+ this.stage.animationManager,
2483
+ animation,
2484
+ );
2485
+
2486
+ return controller;
2487
+ }
2488
+
2489
+ flush() {
2490
+ // no-op
2491
+ }
2492
+
2493
+ //#endregion Properties
2494
+ }