@lightningjs/renderer 0.7.4 → 0.7.6

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