@lightningjs/renderer 0.9.3 → 1.0.0-rc.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -82
- package/dist/exports/index.d.ts +40 -3
- package/dist/exports/index.js +35 -3
- package/dist/exports/index.js.map +1 -1
- package/dist/src/core/CoreNode.d.ts +462 -46
- package/dist/src/core/CoreNode.js +171 -103
- package/dist/src/core/CoreNode.js.map +1 -1
- package/dist/src/core/CoreShaderManager.d.ts +19 -8
- package/dist/src/core/CoreShaderManager.js +21 -21
- package/dist/src/core/CoreShaderManager.js.map +1 -1
- package/dist/src/core/CoreTextNode.d.ts +30 -4
- package/dist/src/core/CoreTextNode.js +24 -1
- package/dist/src/core/CoreTextNode.js.map +1 -1
- package/dist/src/core/CoreTextureManager.d.ts +31 -82
- package/dist/src/core/CoreTextureManager.js +39 -126
- package/dist/src/core/CoreTextureManager.js.map +1 -1
- package/dist/src/core/Stage.d.ts +67 -9
- package/dist/src/core/Stage.js +174 -30
- package/dist/src/core/Stage.js.map +1 -1
- package/dist/src/core/TextureMemoryManager.d.ts +97 -8
- package/dist/src/core/TextureMemoryManager.js +142 -19
- package/dist/src/core/TextureMemoryManager.js.map +1 -1
- package/dist/src/core/animations/CoreAnimation.d.ts +14 -6
- package/dist/src/core/animations/CoreAnimation.js +136 -44
- package/dist/src/core/animations/CoreAnimation.js.map +1 -1
- package/dist/src/core/lib/ImageWorker.js +59 -52
- package/dist/src/core/lib/ImageWorker.js.map +1 -1
- package/dist/src/core/lib/utils.d.ts +1 -0
- package/dist/src/core/lib/utils.js +3 -2
- package/dist/src/core/lib/utils.js.map +1 -1
- package/dist/src/core/platform.js +7 -1
- package/dist/src/core/platform.js.map +1 -1
- package/dist/src/core/renderers/CoreContextTexture.d.ts +3 -2
- package/dist/src/core/renderers/CoreContextTexture.js +7 -1
- package/dist/src/core/renderers/CoreContextTexture.js.map +1 -1
- package/dist/src/core/renderers/CoreRenderer.d.ts +5 -1
- package/dist/src/core/renderers/CoreRenderer.js +0 -1
- package/dist/src/core/renderers/CoreRenderer.js.map +1 -1
- package/dist/src/core/renderers/canvas/CanvasCoreRenderer.d.ts +3 -0
- package/dist/src/core/renderers/canvas/CanvasCoreRenderer.js +16 -1
- package/dist/src/core/renderers/canvas/CanvasCoreRenderer.js.map +1 -1
- package/dist/src/core/renderers/canvas/CanvasCoreTexture.d.ts +0 -1
- package/dist/src/core/renderers/canvas/CanvasCoreTexture.js +2 -5
- package/dist/src/core/renderers/canvas/CanvasCoreTexture.js.map +1 -1
- package/dist/src/core/renderers/webgl/WebGlCoreCtxRenderTexture.js +2 -2
- package/dist/src/core/renderers/webgl/WebGlCoreCtxRenderTexture.js.map +1 -1
- package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.d.ts +0 -1
- package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.js +7 -10
- package/dist/src/core/renderers/webgl/WebGlCoreCtxTexture.js.map +1 -1
- package/dist/src/core/renderers/webgl/WebGlCoreRenderer.d.ts +3 -0
- package/dist/src/core/renderers/webgl/WebGlCoreRenderer.js +47 -9
- package/dist/src/core/renderers/webgl/WebGlCoreRenderer.js.map +1 -1
- package/dist/src/core/renderers/webgl/newShader/abcMock.js +2 -0
- package/dist/src/core/renderers/webgl/newShader/abcMock.js.map +1 -0
- package/dist/src/core/renderers/webgl/shaders/DynamicShader.d.ts +24 -8
- package/dist/src/core/renderers/webgl/shaders/DynamicShader.js +70 -37
- package/dist/src/core/renderers/webgl/shaders/DynamicShader.js.map +1 -1
- package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js +2 -2
- package/dist/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.js.map +1 -1
- package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js +2 -2
- package/dist/src/core/renderers/webgl/shaders/effects/BorderEffect.js.map +1 -1
- package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js +2 -2
- package/dist/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.js.map +1 -1
- package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js +2 -2
- package/dist/src/core/renderers/webgl/shaders/effects/BorderRightEffect.js.map +1 -1
- package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js +2 -2
- package/dist/src/core/renderers/webgl/shaders/effects/BorderTopEffect.js.map +1 -1
- package/dist/src/core/renderers/webgl/shaders/effects/EffectUtils.d.ts +8 -0
- package/dist/src/core/renderers/webgl/shaders/effects/EffectUtils.js +103 -0
- package/dist/src/core/renderers/webgl/shaders/effects/EffectUtils.js.map +1 -1
- package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js +3 -18
- package/dist/src/core/renderers/webgl/shaders/effects/FadeOutEffect.js.map +1 -1
- package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js +5 -2
- package/dist/src/core/renderers/webgl/shaders/effects/GlitchEffect.js.map +1 -1
- package/dist/src/core/renderers/webgl/shaders/effects/HolePunchEffect.js +4 -36
- package/dist/src/core/renderers/webgl/shaders/effects/HolePunchEffect.js.map +1 -1
- package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js +3 -2
- package/dist/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.js.map +1 -1
- package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js +4 -2
- package/dist/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.js.map +1 -1
- package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js +2 -1
- package/dist/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.js.map +1 -1
- package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js +4 -36
- package/dist/src/core/renderers/webgl/shaders/effects/RadiusEffect.js.map +1 -1
- package/dist/src/core/renderers/webgl/shaders/effects/ShaderEffect.d.ts +11 -0
- package/dist/src/core/renderers/webgl/shaders/effects/ShaderEffect.js.map +1 -1
- package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js +5 -2
- package/dist/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js.map +1 -1
- package/dist/src/core/text-rendering/font-face-types/TrFontFace.d.ts +0 -1
- package/dist/src/core/text-rendering/font-face-types/TrFontFace.js +0 -1
- package/dist/src/core/text-rendering/font-face-types/TrFontFace.js.map +1 -1
- package/dist/src/core/text-rendering/font-face-types/WebTrFontFace.js +0 -1
- package/dist/src/core/text-rendering/font-face-types/WebTrFontFace.js.map +1 -1
- package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.d.ts +10 -26
- package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js +116 -365
- package/dist/src/core/text-rendering/renderers/CanvasTextRenderer.js.map +1 -1
- package/dist/src/core/text-rendering/renderers/LightningTextTextureRenderer.d.ts +0 -1
- package/dist/src/core/text-rendering/renderers/LightningTextTextureRenderer.js +0 -2
- package/dist/src/core/text-rendering/renderers/LightningTextTextureRenderer.js.map +1 -1
- package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js +2 -2
- package/dist/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js.map +1 -1
- package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.js +2 -0
- package/dist/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.js.map +1 -1
- package/dist/src/core/text-rendering/renderers/TextRenderer.d.ts +3 -2
- package/dist/src/core/text-rendering/renderers/TextRenderer.js.map +1 -1
- package/dist/src/core/textures/ColorTexture.d.ts +1 -1
- package/dist/src/core/textures/ColorTexture.js +1 -1
- package/dist/src/core/textures/ImageTexture.d.ts +1 -1
- package/dist/src/core/textures/NoiseTexture.d.ts +1 -1
- package/dist/src/core/textures/NoiseTexture.js +3 -0
- package/dist/src/core/textures/NoiseTexture.js.map +1 -1
- package/dist/src/core/textures/SubTexture.d.ts +2 -2
- package/dist/src/core/textures/SubTexture.js +5 -1
- package/dist/src/core/textures/SubTexture.js.map +1 -1
- package/dist/src/core/textures/Texture.d.ts +23 -2
- package/dist/src/core/textures/Texture.js +32 -3
- package/dist/src/core/textures/Texture.js.map +1 -1
- package/dist/src/core/utils.d.ts +7 -0
- package/dist/src/core/utils.js +12 -10
- package/dist/src/core/utils.js.map +1 -1
- package/dist/src/effectsMock.d.ts +13 -0
- package/dist/src/effectsMock.js +62 -0
- package/dist/src/effectsMock.js.map +1 -0
- package/dist/src/main-api/DynamicShaderController.d.ts +28 -0
- package/dist/src/main-api/DynamicShaderController.js +55 -0
- package/dist/src/main-api/DynamicShaderController.js.map +1 -0
- package/dist/src/main-api/INode.d.ts +43 -463
- package/dist/src/main-api/INode.js +1 -19
- package/dist/src/main-api/INode.js.map +1 -1
- package/dist/src/main-api/Inspector.d.ts +10 -10
- package/dist/src/main-api/Inspector.js +18 -15
- package/dist/src/main-api/Inspector.js.map +1 -1
- package/dist/src/main-api/Renderer.d.ts +28 -24
- package/dist/src/main-api/Renderer.js +22 -103
- package/dist/src/main-api/Renderer.js.map +1 -1
- package/dist/src/main-api/ShaderController.d.ts +31 -0
- package/dist/src/main-api/ShaderController.js +37 -0
- package/dist/src/main-api/ShaderController.js.map +1 -0
- package/dist/src/test.js +4 -0
- package/dist/src/test.js.map +1 -0
- package/dist/src/utils.d.ts +1 -0
- package/dist/src/utils.js +7 -0
- package/dist/src/utils.js.map +1 -1
- package/dist/tsconfig.dist.tsbuildinfo +1 -1
- package/exports/index.ts +60 -3
- package/package.json +8 -7
- package/src/core/CoreNode.test.ts +93 -0
- package/src/core/CoreNode.ts +675 -187
- package/src/core/CoreShaderManager.ts +63 -31
- package/src/core/CoreTextNode.ts +41 -9
- package/src/core/CoreTextureManager.ts +55 -175
- package/src/core/Stage.ts +199 -43
- package/src/core/TextureMemoryManager.ts +231 -22
- package/src/core/animations/CoreAnimation.ts +193 -68
- package/src/core/lib/ImageWorker.ts +79 -52
- package/src/core/lib/utils.ts +5 -2
- package/src/core/platform.ts +8 -1
- package/src/core/renderers/CoreContextTexture.ts +9 -2
- package/src/core/renderers/CoreRenderer.ts +5 -2
- package/src/core/renderers/canvas/CanvasCoreRenderer.ts +20 -1
- package/src/core/renderers/canvas/CanvasCoreTexture.ts +2 -6
- package/src/core/renderers/webgl/WebGlCoreCtxRenderTexture.ts +2 -2
- package/src/core/renderers/webgl/WebGlCoreCtxTexture.ts +7 -11
- package/src/core/renderers/webgl/WebGlCoreRenderer.ts +51 -9
- package/src/core/renderers/webgl/shaders/DynamicShader.ts +114 -55
- package/src/core/renderers/webgl/shaders/effects/BorderBottomEffect.ts +2 -2
- package/src/core/renderers/webgl/shaders/effects/BorderEffect.ts +2 -2
- package/src/core/renderers/webgl/shaders/effects/BorderLeftEffect.ts +2 -2
- package/src/core/renderers/webgl/shaders/effects/BorderRightEffect.ts +2 -2
- package/src/core/renderers/webgl/shaders/effects/BorderTopEffect.ts +2 -2
- package/src/core/renderers/webgl/shaders/effects/EffectUtils.ts +129 -3
- package/src/core/renderers/webgl/shaders/effects/FadeOutEffect.ts +7 -15
- package/src/core/renderers/webgl/shaders/effects/GlitchEffect.ts +5 -2
- package/src/core/renderers/webgl/shaders/effects/HolePunchEffect.ts +6 -15
- package/src/core/renderers/webgl/shaders/effects/LinearGradientEffect.ts +6 -2
- package/src/core/renderers/webgl/shaders/effects/RadialGradientEffect.ts +10 -2
- package/src/core/renderers/webgl/shaders/effects/RadialProgressEffect.ts +2 -1
- package/src/core/renderers/webgl/shaders/effects/RadiusEffect.ts +6 -15
- package/src/core/renderers/webgl/shaders/effects/ShaderEffect.ts +20 -0
- package/src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.ts +14 -15
- package/src/core/text-rendering/font-face-types/TrFontFace.ts +0 -2
- package/src/core/text-rendering/font-face-types/WebTrFontFace.ts +0 -1
- package/src/core/text-rendering/renderers/CanvasTextRenderer.ts +139 -447
- package/src/core/text-rendering/renderers/LightningTextTextureRenderer.ts +0 -3
- package/src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.ts +2 -2
- package/src/core/text-rendering/renderers/SdfTextRenderer/internal/layoutText.ts +4 -2
- package/src/core/text-rendering/renderers/TextRenderer.ts +3 -2
- package/src/core/textures/ColorTexture.ts +1 -1
- package/src/core/textures/ImageTexture.ts +1 -1
- package/src/core/textures/NoiseTexture.ts +4 -1
- package/src/core/textures/SubTexture.ts +7 -7
- package/src/core/textures/Texture.ts +46 -3
- package/src/core/utils.ts +12 -11
- package/src/main-api/DynamicShaderController.ts +97 -0
- package/src/main-api/INode.ts +56 -479
- package/src/main-api/Inspector.ts +37 -39
- package/src/main-api/Renderer.ts +543 -0
- package/src/main-api/ShaderController.ts +81 -0
- package/src/main-api/utils.ts +45 -0
- package/src/utils.ts +8 -0
- package/dist/exports/core-api.d.ts +0 -74
- package/dist/exports/core-api.js +0 -96
- package/dist/exports/core-api.js.map +0 -1
- package/dist/exports/main-api.d.ts +0 -30
- package/dist/exports/main-api.js +0 -45
- package/dist/exports/main-api.js.map +0 -1
- package/dist/src/core/CoreExtension.d.ts +0 -12
- package/dist/src/core/CoreExtension.js +0 -29
- package/dist/src/core/CoreExtension.js.map +0 -1
- package/dist/src/core/renderers/webgl/newShader/effectsMock.js +0 -36
- package/dist/src/core/renderers/webgl/newShader/effectsMock.js.map +0 -1
- package/dist/src/main-api/ICoreDriver.d.ts +0 -24
- package/dist/src/main-api/ICoreDriver.js +0 -20
- package/dist/src/main-api/ICoreDriver.js.map +0 -1
- package/dist/src/main-api/RendererMain.d.ts +0 -378
- package/dist/src/main-api/RendererMain.js +0 -367
- package/dist/src/main-api/RendererMain.js.map +0 -1
- package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.d.ts +0 -9
- package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js +0 -38
- package/dist/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.js.map +0 -1
- package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.d.ts +0 -56
- package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js +0 -101
- package/dist/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.js.map +0 -1
- package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.d.ts +0 -32
- package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js +0 -28
- package/dist/src/main-api/texture-usage-trackers/TextureUsageTracker.js.map +0 -1
- package/dist/src/render-drivers/main/MainCoreDriver.d.ts +0 -21
- package/dist/src/render-drivers/main/MainCoreDriver.js +0 -115
- package/dist/src/render-drivers/main/MainCoreDriver.js.map +0 -1
- package/dist/src/render-drivers/main/MainOnlyNode.d.ts +0 -101
- package/dist/src/render-drivers/main/MainOnlyNode.js +0 -425
- package/dist/src/render-drivers/main/MainOnlyNode.js.map +0 -1
- package/dist/src/render-drivers/main/MainOnlyTextNode.d.ts +0 -47
- package/dist/src/render-drivers/main/MainOnlyTextNode.js +0 -204
- package/dist/src/render-drivers/main/MainOnlyTextNode.js.map +0 -1
- package/dist/src/render-drivers/threadx/NodeStruct.d.ts +0 -93
- package/dist/src/render-drivers/threadx/NodeStruct.js +0 -290
- package/dist/src/render-drivers/threadx/NodeStruct.js.map +0 -1
- package/dist/src/render-drivers/threadx/SharedNode.d.ts +0 -40
- package/dist/src/render-drivers/threadx/SharedNode.js +0 -61
- package/dist/src/render-drivers/threadx/SharedNode.js.map +0 -1
- package/dist/src/render-drivers/threadx/TextNodeStruct.d.ts +0 -44
- package/dist/src/render-drivers/threadx/TextNodeStruct.js +0 -203
- package/dist/src/render-drivers/threadx/TextNodeStruct.js.map +0 -1
- package/dist/src/render-drivers/threadx/ThreadXCoreDriver.d.ts +0 -25
- package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js +0 -232
- package/dist/src/render-drivers/threadx/ThreadXCoreDriver.js.map +0 -1
- package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.d.ts +0 -24
- package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js +0 -113
- package/dist/src/render-drivers/threadx/ThreadXMainAnimationController.js.map +0 -1
- package/dist/src/render-drivers/threadx/ThreadXMainNode.d.ts +0 -46
- package/dist/src/render-drivers/threadx/ThreadXMainNode.js +0 -160
- package/dist/src/render-drivers/threadx/ThreadXMainNode.js.map +0 -1
- package/dist/src/render-drivers/threadx/ThreadXMainTextNode.d.ts +0 -28
- package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js +0 -55
- package/dist/src/render-drivers/threadx/ThreadXMainTextNode.js.map +0 -1
- package/dist/src/render-drivers/threadx/ThreadXRendererMessage.d.ts +0 -70
- package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js +0 -32
- package/dist/src/render-drivers/threadx/ThreadXRendererMessage.js.map +0 -1
- package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.d.ts +0 -19
- package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js +0 -184
- package/dist/src/render-drivers/threadx/worker/ThreadXRendererNode.js.map +0 -1
- package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.d.ts +0 -27
- package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js +0 -109
- package/dist/src/render-drivers/threadx/worker/ThreadXRendererTextNode.js.map +0 -1
- package/dist/src/render-drivers/threadx/worker/renderer.js +0 -147
- package/dist/src/render-drivers/threadx/worker/renderer.js.map +0 -1
- package/dist/src/render-drivers/utils.d.ts +0 -12
- package/dist/src/render-drivers/utils.js +0 -74
- package/dist/src/render-drivers/utils.js.map +0 -1
- package/exports/core-api.ts +0 -102
- package/exports/main-api.ts +0 -60
- package/src/core/CoreExtension.ts +0 -32
- package/src/main-api/ICoreDriver.ts +0 -68
- package/src/main-api/RendererMain.ts +0 -685
- package/src/main-api/texture-usage-trackers/FinalizationRegistryTextureUsageTracker.ts +0 -45
- package/src/main-api/texture-usage-trackers/ManualCountTextureUsageTracker.ts +0 -154
- package/src/main-api/texture-usage-trackers/TextureUsageTracker.ts +0 -54
- package/src/render-drivers/main/MainCoreDriver.ts +0 -159
- package/src/render-drivers/main/MainOnlyNode.ts +0 -553
- package/src/render-drivers/main/MainOnlyTextNode.ts +0 -261
- package/src/render-drivers/threadx/NodeStruct.ts +0 -320
- package/src/render-drivers/threadx/SharedNode.ts +0 -101
- package/src/render-drivers/threadx/TextNodeStruct.ts +0 -213
- package/src/render-drivers/threadx/ThreadXCoreDriver.ts +0 -291
- package/src/render-drivers/threadx/ThreadXMainAnimationController.ts +0 -135
- package/src/render-drivers/threadx/ThreadXMainNode.ts +0 -201
- package/src/render-drivers/threadx/ThreadXMainTextNode.ts +0 -85
- package/src/render-drivers/threadx/ThreadXRendererMessage.ts +0 -112
- package/src/render-drivers/threadx/worker/ThreadXRendererNode.ts +0 -253
- package/src/render-drivers/threadx/worker/ThreadXRendererTextNode.ts +0 -151
- package/src/render-drivers/threadx/worker/renderer.ts +0 -156
- package/src/render-drivers/utils.ts +0 -102
- /package/dist/src/core/renderers/webgl/newShader/{effectsMock.d.ts → abcMock.d.ts} +0 -0
- /package/dist/src/{render-drivers/threadx/worker/renderer.d.ts → test.d.ts} +0 -0
|
@@ -1,483 +1,63 @@
|
|
|
1
|
-
import type { IEventEmitter } from '@lightningjs/threadx';
|
|
2
1
|
import type { IAnimationController } from '../common/IAnimationController.js';
|
|
3
|
-
import
|
|
4
|
-
import type {
|
|
2
|
+
import { CoreNode, type CoreNodeAnimateProps, type CoreNodeProps } from '../core/CoreNode.js';
|
|
3
|
+
import type { CoreTextNode, CoreTextNodeProps } from '../core/CoreTextNode.js';
|
|
5
4
|
import type { AnimationSettings } from '../core/animations/CoreAnimation.js';
|
|
5
|
+
import type { BaseShaderController } from './ShaderController.js';
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
8
|
-
*/
|
|
9
|
-
export interface INodeWritableProps {
|
|
10
|
-
/**
|
|
11
|
-
* The x coordinate of the Node's Mount Point.
|
|
12
|
-
*
|
|
13
|
-
* @remarks
|
|
14
|
-
* See {@link mountX} and {@link mountY} for more information about setting
|
|
15
|
-
* the Mount Point.
|
|
16
|
-
*
|
|
17
|
-
* @default `0`
|
|
18
|
-
*/
|
|
19
|
-
x: number;
|
|
20
|
-
/**
|
|
21
|
-
* The y coordinate of the Node's Mount Point.
|
|
22
|
-
*
|
|
23
|
-
* @remarks
|
|
24
|
-
* See {@link mountX} and {@link mountY} for more information about setting
|
|
25
|
-
* the Mount Point.
|
|
26
|
-
*
|
|
27
|
-
* @default `0`
|
|
28
|
-
*/
|
|
29
|
-
y: number;
|
|
30
|
-
/**
|
|
31
|
-
* The width of the Node.
|
|
32
|
-
*
|
|
33
|
-
* @default `0`
|
|
34
|
-
*/
|
|
35
|
-
width: number;
|
|
36
|
-
/**
|
|
37
|
-
* The height of the Node.
|
|
38
|
-
*
|
|
39
|
-
* @default `0`
|
|
40
|
-
*/
|
|
41
|
-
height: number;
|
|
42
|
-
/**
|
|
43
|
-
* The alpha opacity of the Node.
|
|
44
|
-
*
|
|
45
|
-
* @remarks
|
|
46
|
-
* The alpha value is a number between 0 and 1, where 0 is fully transparent
|
|
47
|
-
* and 1 is fully opaque.
|
|
48
|
-
*
|
|
49
|
-
* @default `1`
|
|
50
|
-
*/
|
|
51
|
-
alpha: number;
|
|
52
|
-
/**
|
|
53
|
-
* Autosize mode
|
|
54
|
-
*
|
|
55
|
-
* @remarks
|
|
56
|
-
* When enabled, when a texture is loaded into the Node, the Node will
|
|
57
|
-
* automatically resize to the dimensions of the texture.
|
|
58
|
-
*
|
|
59
|
-
* Text Nodes are always autosized based on their text content regardless
|
|
60
|
-
* of this mode setting.
|
|
61
|
-
*
|
|
62
|
-
* @default `false`
|
|
63
|
-
*/
|
|
64
|
-
autosize: boolean;
|
|
65
|
-
/**
|
|
66
|
-
* Clipping Mode
|
|
67
|
-
*
|
|
68
|
-
* @remarks
|
|
69
|
-
* Enable Clipping Mode when you want to prevent the drawing of a Node and
|
|
70
|
-
* its descendants from overflowing outside of the Node's x/y/width/height
|
|
71
|
-
* bounds.
|
|
72
|
-
*
|
|
73
|
-
* For WebGL, clipping is implemented using the high-performance WebGL
|
|
74
|
-
* operation scissor. As a consequence, clipping does not work for
|
|
75
|
-
* non-rectangular areas. So, if the element is rotated
|
|
76
|
-
* (by itself or by any of its ancestors), clipping will not work as intended.
|
|
77
|
-
*
|
|
78
|
-
* TODO: Add support for non-rectangular clipping either automatically or
|
|
79
|
-
* via Render-To-Texture.
|
|
80
|
-
*
|
|
81
|
-
* @default `false`
|
|
82
|
-
*/
|
|
83
|
-
clipping: boolean;
|
|
84
|
-
/**
|
|
85
|
-
* The color of the Node.
|
|
86
|
-
*
|
|
87
|
-
* @remarks
|
|
88
|
-
* The color value is a number in the format 0xRRGGBBAA, where RR is the red
|
|
89
|
-
* component, GG is the green component, BB is the blue component, and AA is
|
|
90
|
-
* the alpha component.
|
|
91
|
-
*
|
|
92
|
-
* Gradient colors may be set by setting the different color sub-properties:
|
|
93
|
-
* {@link colorTop}, {@link colorBottom}, {@link colorLeft}, {@link colorRight},
|
|
94
|
-
* {@link colorTl}, {@link colorTr}, {@link colorBr}, {@link colorBl} accordingly.
|
|
95
|
-
*
|
|
96
|
-
* @default `0xffffffff` (opaque white)
|
|
97
|
-
*/
|
|
98
|
-
color: number;
|
|
99
|
-
/**
|
|
100
|
-
* The color of the top edge of the Node for gradient rendering.
|
|
101
|
-
*
|
|
102
|
-
* @remarks
|
|
103
|
-
* See {@link color} for more information about color values and gradient
|
|
104
|
-
* rendering.
|
|
105
|
-
*/
|
|
106
|
-
colorTop: number;
|
|
107
|
-
/**
|
|
108
|
-
* The color of the bottom edge of the Node for gradient rendering.
|
|
109
|
-
*
|
|
110
|
-
* @remarks
|
|
111
|
-
* See {@link color} for more information about color values and gradient
|
|
112
|
-
* rendering.
|
|
113
|
-
*/
|
|
114
|
-
colorBottom: number;
|
|
115
|
-
/**
|
|
116
|
-
* The color of the left edge of the Node for gradient rendering.
|
|
117
|
-
*
|
|
118
|
-
* @remarks
|
|
119
|
-
* See {@link color} for more information about color values and gradient
|
|
120
|
-
* rendering.
|
|
121
|
-
*/
|
|
122
|
-
colorLeft: number;
|
|
123
|
-
/**
|
|
124
|
-
* The color of the right edge of the Node for gradient rendering.
|
|
125
|
-
*
|
|
126
|
-
* @remarks
|
|
127
|
-
* See {@link color} for more information about color values and gradient
|
|
128
|
-
* rendering.
|
|
129
|
-
*/
|
|
130
|
-
colorRight: number;
|
|
131
|
-
/**
|
|
132
|
-
* The color of the top-left corner of the Node for gradient rendering.
|
|
133
|
-
*
|
|
134
|
-
* @remarks
|
|
135
|
-
* See {@link color} for more information about color values and gradient
|
|
136
|
-
* rendering.
|
|
137
|
-
*/
|
|
138
|
-
colorTl: number;
|
|
139
|
-
/**
|
|
140
|
-
* The color of the top-right corner of the Node for gradient rendering.
|
|
141
|
-
*
|
|
142
|
-
* @remarks
|
|
143
|
-
* See {@link color} for more information about color values and gradient
|
|
144
|
-
* rendering.
|
|
145
|
-
*/
|
|
146
|
-
colorTr: number;
|
|
147
|
-
/**
|
|
148
|
-
* The color of the bottom-right corner of the Node for gradient rendering.
|
|
149
|
-
*
|
|
150
|
-
* @remarks
|
|
151
|
-
* See {@link color} for more information about color values and gradient
|
|
152
|
-
* rendering.
|
|
153
|
-
*/
|
|
154
|
-
colorBr: number;
|
|
155
|
-
/**
|
|
156
|
-
* The color of the bottom-left corner of the Node for gradient rendering.
|
|
157
|
-
*
|
|
158
|
-
* @remarks
|
|
159
|
-
* See {@link color} for more information about color values and gradient
|
|
160
|
-
* rendering.
|
|
161
|
-
*/
|
|
162
|
-
colorBl: number;
|
|
163
|
-
/**
|
|
164
|
-
* The Node's parent Node.
|
|
165
|
-
*
|
|
166
|
-
* @remarks
|
|
167
|
-
* The value `null` indicates that the Node has no parent. This may either be
|
|
168
|
-
* because the Node is the root Node of the scene graph, or because the Node
|
|
169
|
-
* has been removed from the scene graph.
|
|
170
|
-
*
|
|
171
|
-
* In order to make sure that a Node can be rendered on the screen, it must
|
|
172
|
-
* be added to the scene graph by setting it's parent property to a Node that
|
|
173
|
-
* is already in the scene graph such as the root Node.
|
|
174
|
-
*
|
|
175
|
-
* @default `null`
|
|
176
|
-
*/
|
|
177
|
-
parent: INode | null;
|
|
178
|
-
/**
|
|
179
|
-
* The Node's z-index.
|
|
180
|
-
*
|
|
181
|
-
* @remarks
|
|
182
|
-
* TBD
|
|
183
|
-
*/
|
|
184
|
-
zIndex: number;
|
|
185
|
-
/**
|
|
186
|
-
* The Node's Texture.
|
|
187
|
-
*
|
|
188
|
-
* @remarks
|
|
189
|
-
* The `texture` defines a rasterized image that is contained within the
|
|
190
|
-
* {@link width} and {@link height} dimensions of the Node. If null, the
|
|
191
|
-
* Node will use an opaque white {@link ColorTexture} when being drawn, which
|
|
192
|
-
* essentially enables colors (including gradients) to be drawn.
|
|
193
|
-
*
|
|
194
|
-
* If set, by default, the texture will be drawn, as is, stretched to the
|
|
195
|
-
* dimensions of the Node. This behavior can be modified by setting the TBD
|
|
196
|
-
* and TBD properties.
|
|
197
|
-
*
|
|
198
|
-
* To create a Texture in order to set it on this property, call
|
|
199
|
-
* {@link RendererMain.createTexture}.
|
|
200
|
-
*
|
|
201
|
-
* If the {@link src} is set on a Node, the Node will use the
|
|
202
|
-
* {@link ImageTexture} by default and the Node will simply load the image at
|
|
203
|
-
* the specified URL.
|
|
204
|
-
*
|
|
205
|
-
* Note: If this is a Text Node, the Texture will be managed by the Node's
|
|
206
|
-
* {@link TextRenderer} and should not be set explicitly.
|
|
207
|
-
*/
|
|
208
|
-
texture: TextureRef | null;
|
|
209
|
-
/**
|
|
210
|
-
* The Node's shader
|
|
211
|
-
*
|
|
212
|
-
* @remarks
|
|
213
|
-
* The `shader` defines a {@link Shader} used to draw the Node. By default,
|
|
214
|
-
* the Default Shader is used which simply draws the defined {@link texture}
|
|
215
|
-
* or {@link color}(s) within the Node without any special effects.
|
|
216
|
-
*
|
|
217
|
-
* To create a Shader in order to set it on this property, call
|
|
218
|
-
* {@link RendererMain.createShader}.
|
|
219
|
-
*
|
|
220
|
-
* Note: If this is a Text Node, the Shader will be managed by the Node's
|
|
221
|
-
* {@link TextRenderer} and should not be set explicitly.
|
|
222
|
-
*/
|
|
223
|
-
shader: ShaderRef | null;
|
|
224
|
-
/**
|
|
225
|
-
* Image URL
|
|
226
|
-
*
|
|
227
|
-
* @remarks
|
|
228
|
-
* When set, the Node's {@link texture} is automatically set to an
|
|
229
|
-
* {@link ImageTexture} using the source image URL provided (with all other
|
|
230
|
-
* settings being defaults)
|
|
231
|
-
*/
|
|
232
|
-
src: string;
|
|
233
|
-
zIndexLocked: number;
|
|
234
|
-
/**
|
|
235
|
-
* Scale to render the Node at
|
|
236
|
-
*
|
|
237
|
-
* @remarks
|
|
238
|
-
* The scale value multiplies the provided {@link width} and {@link height}
|
|
239
|
-
* of the Node around the Node's Pivot Point (defined by the {@link pivot}
|
|
240
|
-
* props).
|
|
241
|
-
*
|
|
242
|
-
* Behind the scenes, setting this property sets both the {@link scaleX} and
|
|
243
|
-
* {@link scaleY} props to the same value.
|
|
244
|
-
*
|
|
245
|
-
* NOTE: When the scaleX and scaleY props are explicitly set to different values,
|
|
246
|
-
* this property returns `null`. Setting `null` on this property will have no
|
|
247
|
-
* effect.
|
|
248
|
-
*
|
|
249
|
-
* @default 1.0
|
|
250
|
-
*/
|
|
251
|
-
scale: number | null;
|
|
252
|
-
/**
|
|
253
|
-
* Scale to render the Node at (X-Axis)
|
|
254
|
-
*
|
|
255
|
-
* @remarks
|
|
256
|
-
* The scaleX value multiplies the provided {@link width} of the Node around
|
|
257
|
-
* the Node's Pivot Point (defined by the {@link pivot} props).
|
|
258
|
-
*
|
|
259
|
-
* @default 1.0
|
|
260
|
-
*/
|
|
261
|
-
scaleX: number;
|
|
262
|
-
/**
|
|
263
|
-
* Scale to render the Node at (Y-Axis)
|
|
264
|
-
*
|
|
265
|
-
* @remarks
|
|
266
|
-
* The scaleY value multiplies the provided {@link height} of the Node around
|
|
267
|
-
* the Node's Pivot Point (defined by the {@link pivot} props).
|
|
268
|
-
*
|
|
269
|
-
* @default 1.0
|
|
270
|
-
*/
|
|
271
|
-
scaleY: number;
|
|
272
|
-
/**
|
|
273
|
-
* Combined position of the Node's Mount Point
|
|
274
|
-
*
|
|
275
|
-
* @remarks
|
|
276
|
-
* The value can be any number between `0.0` and `1.0`:
|
|
277
|
-
* - `0.0` defines the Mount Point at the top-left corner of the Node.
|
|
278
|
-
* - `0.5` defines it at the center of the Node.
|
|
279
|
-
* - `1.0` defines it at the bottom-right corner of the node.
|
|
280
|
-
*
|
|
281
|
-
* Use the {@link mountX} and {@link mountY} props seperately for more control
|
|
282
|
-
* of the Mount Point.
|
|
283
|
-
*
|
|
284
|
-
* When assigned, the same value is also passed to both the {@link mountX} and
|
|
285
|
-
* {@link mountY} props.
|
|
286
|
-
*
|
|
287
|
-
* @default 0 (top-left)
|
|
288
|
-
*/
|
|
289
|
-
mount: number;
|
|
290
|
-
/**
|
|
291
|
-
* X position of the Node's Mount Point
|
|
292
|
-
*
|
|
293
|
-
* @remarks
|
|
294
|
-
* The value can be any number between `0.0` and `1.0`:
|
|
295
|
-
* - `0.0` defines the Mount Point's X position as the left-most edge of the
|
|
296
|
-
* Node
|
|
297
|
-
* - `0.5` defines it as the horizontal center of the Node
|
|
298
|
-
* - `1.0` defines it as the right-most edge of the Node.
|
|
299
|
-
*
|
|
300
|
-
* The combination of {@link mountX} and {@link mountY} define the Mount Point
|
|
301
|
-
*
|
|
302
|
-
* @default 0 (left-most edge)
|
|
303
|
-
*/
|
|
304
|
-
mountX: number;
|
|
305
|
-
/**
|
|
306
|
-
* Y position of the Node's Mount Point
|
|
307
|
-
*
|
|
308
|
-
* @remarks
|
|
309
|
-
* The value can be any number between `0.0` and `1.0`:
|
|
310
|
-
* - `0.0` defines the Mount Point's Y position as the top-most edge of the
|
|
311
|
-
* Node
|
|
312
|
-
* - `0.5` defines it as the vertical center of the Node
|
|
313
|
-
* - `1.0` defines it as the bottom-most edge of the Node.
|
|
314
|
-
*
|
|
315
|
-
* The combination of {@link mountX} and {@link mountY} define the Mount Point
|
|
316
|
-
*
|
|
317
|
-
* @default 0 (top-most edge)
|
|
318
|
-
*/
|
|
319
|
-
mountY: number;
|
|
320
|
-
/**
|
|
321
|
-
* Combined position of the Node's Pivot Point
|
|
322
|
-
*
|
|
323
|
-
* @remarks
|
|
324
|
-
* The value can be any number between `0.0` and `1.0`:
|
|
325
|
-
* - `0.0` defines the Pivot Point at the top-left corner of the Node.
|
|
326
|
-
* - `0.5` defines it at the center of the Node.
|
|
327
|
-
* - `1.0` defines it at the bottom-right corner of the node.
|
|
328
|
-
*
|
|
329
|
-
* Use the {@link pivotX} and {@link pivotY} props seperately for more control
|
|
330
|
-
* of the Pivot Point.
|
|
331
|
-
*
|
|
332
|
-
* When assigned, the same value is also passed to both the {@link pivotX} and
|
|
333
|
-
* {@link pivotY} props.
|
|
334
|
-
*
|
|
335
|
-
* @default 0.5 (center)
|
|
336
|
-
*/
|
|
337
|
-
pivot: number;
|
|
338
|
-
/**
|
|
339
|
-
* X position of the Node's Pivot Point
|
|
340
|
-
*
|
|
341
|
-
* @remarks
|
|
342
|
-
* The value can be any number between `0.0` and `1.0`:
|
|
343
|
-
* - `0.0` defines the Pivot Point's X position as the left-most edge of the
|
|
344
|
-
* Node
|
|
345
|
-
* - `0.5` defines it as the horizontal center of the Node
|
|
346
|
-
* - `1.0` defines it as the right-most edge of the Node.
|
|
347
|
-
*
|
|
348
|
-
* The combination of {@link pivotX} and {@link pivotY} define the Pivot Point
|
|
349
|
-
*
|
|
350
|
-
* @default 0.5 (centered on x-axis)
|
|
351
|
-
*/
|
|
352
|
-
pivotX: number;
|
|
353
|
-
/**
|
|
354
|
-
* Y position of the Node's Pivot Point
|
|
355
|
-
*
|
|
356
|
-
* @remarks
|
|
357
|
-
* The value can be any number between `0.0` and `1.0`:
|
|
358
|
-
* - `0.0` defines the Pivot Point's Y position as the top-most edge of the
|
|
359
|
-
* Node
|
|
360
|
-
* - `0.5` defines it as the vertical center of the Node
|
|
361
|
-
* - `1.0` defines it as the bottom-most edge of the Node.
|
|
362
|
-
*
|
|
363
|
-
* The combination of {@link pivotX} and {@link pivotY} define the Pivot Point
|
|
364
|
-
*
|
|
365
|
-
* @default 0.5 (centered on y-axis)
|
|
366
|
-
*/
|
|
367
|
-
pivotY: number;
|
|
368
|
-
/**
|
|
369
|
-
* Rotation of the Node (in Radians)
|
|
370
|
-
*
|
|
371
|
-
* @remarks
|
|
372
|
-
* Sets the amount to rotate the Node by around it's Pivot Point (defined by
|
|
373
|
-
* the {@link pivot} props). Positive values rotate the Node clockwise, while
|
|
374
|
-
* negative values rotate it counter-clockwise.
|
|
375
|
-
*
|
|
376
|
-
* Example values:
|
|
377
|
-
* - `-Math.PI / 2`: 90 degree rotation counter-clockwise
|
|
378
|
-
* - `0`: No rotation
|
|
379
|
-
* - `Math.PI / 2`: 90 degree rotation clockwise
|
|
380
|
-
* - `Math.PI`: 180 degree rotation clockwise
|
|
381
|
-
* - `3 * Math.PI / 2`: 270 degree rotation clockwise
|
|
382
|
-
* - `2 * Math.PI`: 360 rotation clockwise
|
|
383
|
-
*/
|
|
384
|
-
rotation: number;
|
|
385
|
-
/**
|
|
386
|
-
* Whether the Node is rendered to a texture
|
|
387
|
-
*
|
|
388
|
-
* @remarks
|
|
389
|
-
* TBD
|
|
390
|
-
*
|
|
391
|
-
* @default false
|
|
392
|
-
*/
|
|
393
|
-
rtt: boolean;
|
|
394
|
-
/**
|
|
395
|
-
* Node data element for custom data storage (optional)
|
|
396
|
-
*
|
|
397
|
-
* @remarks
|
|
398
|
-
* This property is used to store custom data on the Node as a key/value data store.
|
|
399
|
-
* Data values are limited to string, numbers, booleans. Strings will be truncated
|
|
400
|
-
* to a 2048 character limit for performance reasons.
|
|
401
|
-
*
|
|
402
|
-
* This is not a data storage mechanism for large amounts of data please use a
|
|
403
|
-
* dedicated data storage mechanism for that.
|
|
404
|
-
*
|
|
405
|
-
* The custom data will be reflected in the inspector as part of `data-*` attributes
|
|
406
|
-
*
|
|
407
|
-
* @default `undefined`
|
|
408
|
-
*/
|
|
409
|
-
data?: CustomDataMap;
|
|
410
|
-
}
|
|
411
|
-
/**
|
|
412
|
-
* A custom data map which can be stored on the INode
|
|
413
|
-
*
|
|
414
|
-
* @remarks
|
|
415
|
-
* This is a map of key-value pairs that can be stored on an INode. It is used
|
|
416
|
-
* to store custom data that can be used by the application.
|
|
417
|
-
* The data stored can only be of type string, number or boolean.
|
|
418
|
-
*/
|
|
419
|
-
export type CustomDataMap = {
|
|
420
|
-
[key: string]: string | number | boolean | undefined;
|
|
421
|
-
};
|
|
422
|
-
export type INodeAnimatableProps = {
|
|
423
|
-
[Key in keyof INodeWritableProps as NonNullable<INodeWritableProps[Key]> extends number ? Key : never]: number;
|
|
424
|
-
};
|
|
425
|
-
export interface INodeEvents {
|
|
426
|
-
[s: string]: (target: INode, data: any) => void;
|
|
427
|
-
}
|
|
428
|
-
/**
|
|
429
|
-
* Main API interface representing a Node in the Renderer scene graph.
|
|
7
|
+
* A visual Node in the Renderer scene graph.
|
|
430
8
|
*
|
|
431
9
|
* @remarks
|
|
432
10
|
* A Node is a basic building block of the Renderer scene graph. It can be a
|
|
433
11
|
* container for other Nodes, or it can be a leaf Node that renders a solid
|
|
434
12
|
* color, gradient, image, or specific texture, using a specific shader.
|
|
435
13
|
*
|
|
436
|
-
* For text rendering, see {@link ITextNode}.
|
|
14
|
+
* For text rendering Nodes, see {@link ITextNode}.
|
|
15
|
+
*
|
|
16
|
+
* ## INode vs CoreNode
|
|
17
|
+
* CoreNode is the name of the class for a Renderer Node and is only directly
|
|
18
|
+
* used internally by the Renderer. INode describes the public API of a
|
|
19
|
+
* Renderer Node including the ability to be tied to a specific Shader.
|
|
437
20
|
*
|
|
438
|
-
*
|
|
439
|
-
*
|
|
440
|
-
* implements it with it's `MainOnlyNode` while the ThreadXCoreDriver implements
|
|
441
|
-
* it with it's `ThreadXMainNode`.
|
|
21
|
+
* Users of the Renderer API, should generally interact with INode objects
|
|
22
|
+
* instead of CoreNode objects.
|
|
442
23
|
*/
|
|
443
|
-
export interface INode extends
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
destroy(): void;
|
|
448
|
-
flush(): void;
|
|
24
|
+
export interface INode<SC extends BaseShaderController = BaseShaderController> extends Omit<CoreNode, 'shader' | 'animate' | 'parent'> {
|
|
25
|
+
shader: SC;
|
|
26
|
+
animate(props: Partial<INodeAnimateProps<SC>>, settings: Partial<AnimationSettings>): IAnimationController;
|
|
27
|
+
parent: INode | null;
|
|
449
28
|
}
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
* By default, Text Nodes resolve the Text Renderer to use based on the font
|
|
456
|
-
* that is matched using the font family and other font selection properties.
|
|
457
|
-
*
|
|
458
|
-
* If two fonts supported by two separate Text Renderers are matched setting
|
|
459
|
-
* this override forces the Text Node to resolve to the Text Renderer defined
|
|
460
|
-
* here.
|
|
461
|
-
*
|
|
462
|
-
* @default null
|
|
463
|
-
*/
|
|
464
|
-
textRendererOverride: keyof TextRendererMap | null;
|
|
29
|
+
/**
|
|
30
|
+
* Properties used to animate() a Node
|
|
31
|
+
*/
|
|
32
|
+
export interface INodeAnimateProps<SC extends BaseShaderController> extends Omit<CoreNodeAnimateProps, 'shaderProps'> {
|
|
33
|
+
shaderProps: Partial<SC['props']>;
|
|
465
34
|
}
|
|
466
35
|
/**
|
|
467
|
-
*
|
|
36
|
+
* Properties used to create a new Node
|
|
37
|
+
*/
|
|
38
|
+
export interface INodeProps<SC extends BaseShaderController = BaseShaderController> extends Omit<CoreNodeProps, 'shader' | 'parent'> {
|
|
39
|
+
shader: SC;
|
|
40
|
+
parent: INode | null;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* A visual Node in the Renderer scene graph that renders text.
|
|
468
44
|
*
|
|
469
45
|
* @remarks
|
|
470
|
-
* A Text Node is
|
|
471
|
-
*
|
|
472
|
-
* chosen based on the font requested and what type of fonts are installed
|
|
473
|
-
* into an app via a CoreExtension.
|
|
474
|
-
*
|
|
475
|
-
* The text renderer can be overridden by setting the `textRendererOverride`
|
|
476
|
-
*
|
|
477
|
-
* The `texture` and `shader` properties are managed by loaded text renderer and
|
|
478
|
-
* should not be set directly.
|
|
46
|
+
* A Text Node is a special type of Node that renders text using a specific
|
|
47
|
+
* text renderer, such as Web/Canvas or Signed Distance Field (SDF) text.
|
|
479
48
|
*
|
|
480
49
|
* For non-text rendering, see {@link INode}.
|
|
50
|
+
*
|
|
51
|
+
* Users of the Renderer API, should generally interact with ITextNode objects
|
|
52
|
+
* instead of CoreTextNode objects.
|
|
53
|
+
*/
|
|
54
|
+
export interface ITextNode extends Omit<CoreTextNode, 'animate' | 'parent'> {
|
|
55
|
+
animate(props: Partial<INodeAnimateProps<BaseShaderController>>, settings: Partial<AnimationSettings>): IAnimationController;
|
|
56
|
+
parent: INode | null;
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Properties used to create a new Text Node
|
|
481
60
|
*/
|
|
482
|
-
export interface
|
|
61
|
+
export interface ITextNodeProps extends Omit<CoreTextNodeProps, 'parent'> {
|
|
62
|
+
parent: INode | null;
|
|
483
63
|
}
|
|
@@ -1,20 +1,2 @@
|
|
|
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
|
-
export {};
|
|
1
|
+
import { CoreNode, } from '../core/CoreNode.js';
|
|
20
2
|
//# sourceMappingURL=INode.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"INode.js","sourceRoot":"","sources":["../../../src/main-api/INode.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"INode.js","sourceRoot":"","sources":["../../../src/main-api/INode.ts"],"names":[],"mappings":"AAmBA,OAAO,EACL,QAAQ,GAGT,MAAM,qBAAqB,CAAC"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import
|
|
2
|
-
import type
|
|
3
|
-
import { type RendererMainSettings } from './RendererMain.js';
|
|
1
|
+
import { CoreNode, type CoreNodeAnimateProps, type CoreNodeProps } from '../core/CoreNode.js';
|
|
2
|
+
import { type RendererMainSettings } from './Renderer.js';
|
|
4
3
|
import type { AnimationSettings } from '../core/animations/CoreAnimation.js';
|
|
4
|
+
import type { CoreTextNode, CoreTextNodeProps } from '../core/CoreTextNode.js';
|
|
5
5
|
export declare class Inspector {
|
|
6
6
|
private root;
|
|
7
7
|
private canvas;
|
|
@@ -11,11 +11,11 @@ export declare class Inspector {
|
|
|
11
11
|
private scaleY;
|
|
12
12
|
constructor(canvas: HTMLCanvasElement, settings: RendererMainSettings);
|
|
13
13
|
setRootPosition(): void;
|
|
14
|
-
createDiv(
|
|
15
|
-
createNode(
|
|
16
|
-
createTextNode(
|
|
17
|
-
createProxy(node:
|
|
18
|
-
destroyNode(
|
|
19
|
-
updateNodeProperty(div: HTMLElement, property: keyof
|
|
20
|
-
animateNode(div: HTMLElement,
|
|
14
|
+
createDiv(id: number, properties: CoreNodeProps | CoreTextNodeProps): HTMLElement;
|
|
15
|
+
createNode(node: CoreNode): CoreNode;
|
|
16
|
+
createTextNode(node: CoreNode): CoreTextNode;
|
|
17
|
+
createProxy(node: CoreNode | CoreTextNode, div: HTMLElement): CoreNode | CoreTextNode;
|
|
18
|
+
destroyNode(id: number): void;
|
|
19
|
+
updateNodeProperty(div: HTMLElement, property: keyof CoreNodeProps | keyof CoreTextNodeProps, value: any): void;
|
|
20
|
+
animateNode(div: HTMLElement, props: CoreNodeAnimateProps, settings: AnimationSettings): void;
|
|
21
21
|
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import {} from '
|
|
1
|
+
import { CoreNode, } from '../core/CoreNode.js';
|
|
2
|
+
import {} from './Renderer.js';
|
|
2
3
|
import { isProductionEnvironment } from '../utils.js';
|
|
3
4
|
const stylePropertyMap = {
|
|
4
5
|
alpha: (v) => {
|
|
@@ -150,10 +151,10 @@ export class Inspector {
|
|
|
150
151
|
this.root.style.overflow = 'hidden';
|
|
151
152
|
this.root.style.zIndex = '65534';
|
|
152
153
|
}
|
|
153
|
-
createDiv(
|
|
154
|
+
createDiv(id, properties) {
|
|
154
155
|
const div = document.createElement('div');
|
|
155
156
|
div.style.position = 'absolute';
|
|
156
|
-
div.id =
|
|
157
|
+
div.id = id.toString();
|
|
157
158
|
// set initial properties
|
|
158
159
|
for (const key in properties) {
|
|
159
160
|
this.updateNodeProperty(div,
|
|
@@ -162,18 +163,16 @@ export class Inspector {
|
|
|
162
163
|
}
|
|
163
164
|
return div;
|
|
164
165
|
}
|
|
165
|
-
createNode(
|
|
166
|
-
const
|
|
167
|
-
const div = this.createDiv(node, properties);
|
|
166
|
+
createNode(node) {
|
|
167
|
+
const div = this.createDiv(node.id, node.props);
|
|
168
168
|
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
|
|
169
169
|
div.node = node;
|
|
170
170
|
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
|
|
171
171
|
node.div = div;
|
|
172
172
|
return this.createProxy(node, div);
|
|
173
173
|
}
|
|
174
|
-
createTextNode(
|
|
175
|
-
const
|
|
176
|
-
const div = this.createDiv(node, properties);
|
|
174
|
+
createTextNode(node) {
|
|
175
|
+
const div = this.createDiv(node.id, node.props);
|
|
177
176
|
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
|
|
178
177
|
div.node = node;
|
|
179
178
|
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
|
|
@@ -188,7 +187,7 @@ export class Inspector {
|
|
|
188
187
|
},
|
|
189
188
|
get: (target, property, receiver) => {
|
|
190
189
|
if (property === 'destroy') {
|
|
191
|
-
this.destroyNode(target);
|
|
190
|
+
this.destroyNode(target.id);
|
|
192
191
|
}
|
|
193
192
|
if (property === 'animate') {
|
|
194
193
|
return (props, settings) => {
|
|
@@ -197,7 +196,7 @@ export class Inspector {
|
|
|
197
196
|
return new Proxy(anim, {
|
|
198
197
|
get: (target, property, receiver) => {
|
|
199
198
|
if (property === 'start') {
|
|
200
|
-
this.animateNode(div,
|
|
199
|
+
this.animateNode(div, props, settings);
|
|
201
200
|
}
|
|
202
201
|
return Reflect.get(target, property, receiver);
|
|
203
202
|
},
|
|
@@ -208,8 +207,8 @@ export class Inspector {
|
|
|
208
207
|
},
|
|
209
208
|
});
|
|
210
209
|
}
|
|
211
|
-
destroyNode(
|
|
212
|
-
const div = document.getElementById(
|
|
210
|
+
destroyNode(id) {
|
|
211
|
+
const div = document.getElementById(id.toString());
|
|
213
212
|
div?.remove();
|
|
214
213
|
}
|
|
215
214
|
updateNodeProperty(div, property,
|
|
@@ -272,7 +271,11 @@ export class Inspector {
|
|
|
272
271
|
}
|
|
273
272
|
// DOM properties
|
|
274
273
|
if (domPropertyMap[property]) {
|
|
275
|
-
|
|
274
|
+
const domProperty = domPropertyMap[property];
|
|
275
|
+
if (!domProperty) {
|
|
276
|
+
return;
|
|
277
|
+
}
|
|
278
|
+
div.setAttribute(String(domProperty), String(value));
|
|
276
279
|
return;
|
|
277
280
|
}
|
|
278
281
|
// custom data properties
|
|
@@ -291,7 +294,7 @@ export class Inspector {
|
|
|
291
294
|
}
|
|
292
295
|
}
|
|
293
296
|
// simple animation handler
|
|
294
|
-
animateNode(div,
|
|
297
|
+
animateNode(div, props, settings) {
|
|
295
298
|
const { duration = 1000, delay = 0,
|
|
296
299
|
// easing = 'linear',
|
|
297
300
|
// repeat = 0,
|