Interface ITextNode

A visual Node in the Renderer scene graph that renders text.

Remarks

A Text Node is a special type of Node that renders text using a specific text renderer, such as Web/Canvas or Signed Distance Field (SDF) text.

For non-text rendering, see INode.

Users of the Renderer API, should generally interact with ITextNode objects instead of CoreTextNode objects.

interface ITextNode {
    absX: number;
    absY: number;
    alpha: number;
    autosize: boolean;
    boundsMargin: null | number | [number, number, number, number];
    calcZIndex: number;
    children: CoreNode[];
    childUpdateType: UpdateType;
    clipping: boolean;
    clippingRect: RectWithValid;
    color: number;
    colorBl: number;
    colorBottom: number;
    colorBr: number;
    colorLeft: number;
    colorRight: number;
    colorTl: number;
    colorTop: number;
    colorTr: number;
    data: undefined | CustomDataMap;
    destroyed: boolean;
    fontFamily: string;
    fontSize: number;
    fontStyle: "normal" | "italic" | "oblique";
    forceLoad: boolean;
    framebufferDimensions: null | Dimensions;
    globalTransform?: Matrix3d;
    h: number;
    hasRTTupdates: boolean;
    id: number;
    imageType:
        | null
        | "svg"
        | "regular"
        | "compressed";
    interactive: undefined | boolean;
    isRenderable: boolean;
    letterSpacing: number;
    lineHeight: number;
    localTransform?: Matrix3d;
    maxHeight: number;
    maxLines: number;
    maxWidth: number;
    mount: number;
    mountX: number;
    mountY: number;
    offsetY: number;
    overflowSuffix: string;
    parent: null | INode<CoreShaderNode<Record<string, unknown>>>;
    parentFramebufferDimensions: Dimensions;
    parentHasRenderTexture: boolean;
    parentRenderTexture: null | CoreNode;
    pivot: number;
    pivotX: number;
    pivotY: number;
    preloadBound?: Bound;
    premultipliedColorBl: number;
    premultipliedColorBr: number;
    premultipliedColorTl: number;
    premultipliedColorTr: number;
    props: CoreNodeProps;
    renderBound?: Bound;
    renderCoords?: RenderCoords;
    renderInfo: TextRenderInfo;
    renderState: CoreNodeRenderState;
    rotation: number;
    rtt: boolean;
    rttParent: null | CoreNode;
    scale: number;
    scaleX: number;
    scaleY: number;
    sceneGlobalTransform?: Matrix3d;
    sceneRenderCoords?: RenderCoords;
    shader: null | CoreShaderNode<any>;
    src: null | string;
    srcHeight: undefined | number;
    srcWidth: undefined | number;
    srcX: undefined | number;
    srcY: undefined | number;
    stage: Stage;
    strictBound?: Bound;
    text: string;
    textAlign: "center" | "left" | "right";
    textBaseline: TextBaseline;
    texture: null | Texture;
    textureCoords?: Bound;
    textureOptions: TextureOptions;
    updateShaderUniforms: boolean;
    updateTextureCoords: boolean;
    updateType: UpdateType;
    verticalAlign: TextVerticalAlign;
    w: number;
    wordBreak: "normal" | "break-all" | "break-word";
    worldAlpha: number;
    x: number;
    y: number;
    zIndex: number;
    zIndexLocked: number;
    allowTextGeneration(): boolean;
    animate(props: Partial<INodeAnimateProps<CoreShaderNode<Record<string, unknown>>>>, settings: Partial<AnimationSettings>): IAnimationController;
    calculateClippingRect(parentClippingRect: RectWithValid): void;
    calculateRenderCoords(): void;
    calculateZIndex(): void;
    checkRenderBounds(): CoreNodeRenderState;
    createRenderBounds(): void;
    destroy(): void;
    emit(event: string, data?: any): void;
    flush(): void;
    loadTexture(): void;
    off(event: string, listener?: ((target: any, data: any) => void)): void;
    on(event: string, listener: ((target: any, data: any) => void)): void;
    once(event: string, listener: ((target: any, data: any) => void)): void;
    removeAllListeners(): void;
    renderQuads(renderer: CoreRenderer): void;
    setRenderable(isRenderable: boolean): void;
    setRTTUpdates(type: number): void;
    setUpdateType(type: UpdateType): void;
    sortChildren(): void;
    unloadTexture(): void;
    update(delta: number, parentClippingRect: RectWithValid): void;
    updateBoundingRect(): void;
    updateIsRenderable(): void;
    updateLocalTransform(): void;
    updateRenderState(renderState: CoreNodeRenderState): void;
    updateTextureOwnership(isRenderable: boolean): void;
}

Hierarchy

  • Omit<CoreTextNode, "animate" | "parent">
    • ITextNode

Properties

absX absY alpha autosize boundsMargin calcZIndex children childUpdateType clipping clippingRect color colorBl colorBottom colorBr colorLeft colorRight colorTl colorTop colorTr data destroyed fontFamily fontSize fontStyle forceLoad framebufferDimensions globalTransform? h hasRTTupdates id imageType interactive isRenderable letterSpacing lineHeight localTransform? maxHeight maxLines maxWidth mount mountX mountY offsetY overflowSuffix parent parentFramebufferDimensions parentHasRenderTexture parentRenderTexture pivot pivotX pivotY preloadBound? premultipliedColorBl premultipliedColorBr premultipliedColorTl premultipliedColorTr props renderBound? renderCoords? renderInfo renderState rotation rtt rttParent scale scaleX scaleY sceneGlobalTransform? sceneRenderCoords? shader src srcHeight srcWidth srcX srcY stage strictBound? text textAlign textBaseline texture textureCoords? textureOptions updateShaderUniforms updateTextureCoords updateType verticalAlign w wordBreak worldAlpha x y zIndex zIndexLocked

Methods

allowTextGeneration animate calculateClippingRect calculateRenderCoords calculateZIndex checkRenderBounds createRenderBounds destroy emit flush loadTexture off on once removeAllListeners renderQuads setRenderable setRTTUpdates setUpdateType sortChildren unloadTexture update updateBoundingRect updateIsRenderable updateLocalTransform updateRenderState updateTextureOwnership

Properties

absX

absX: number

absY

absY: number

alpha

alpha: number

autosize

autosize: boolean

boundsMargin

boundsMargin: null | number | [number, number, number, number]

calcZIndex

calcZIndex: number = 0

Readonlychildren

children: CoreNode[] = []

childUpdateType

childUpdateType: UpdateType = UpdateType.None

clipping

clipping: boolean

clippingRect

clippingRect: RectWithValid = ...

color

color: number

colorBl

colorBl: number

colorBottom

colorBottom: number

colorBr

colorBr: number

colorLeft

colorLeft: number

colorRight

colorRight: number

colorTl

colorTl: number

colorTop

colorTop: number

colorTr

colorTr: number

data

data: undefined | CustomDataMap

destroyed

destroyed: boolean = false

fontFamily

fontFamily: string

fontSize

fontSize: number

fontStyle

fontStyle: "normal" | "italic" | "oblique"

forceLoad

forceLoad: boolean

framebufferDimensions

framebufferDimensions: null | Dimensions = null

only used when rtt = true

OptionalglobalTransform

globalTransform?: Matrix3d

h

h: number

hasRTTupdates

hasRTTupdates: boolean = false

id

id: number

imageType

imageType:
    | null
    | "svg"
    | "regular"
    | "compressed"

interactive

interactive: undefined | boolean

isRenderable

isRenderable: boolean = false

letterSpacing

letterSpacing: number

lineHeight

lineHeight: number

OptionallocalTransform

localTransform?: Matrix3d

maxHeight

maxHeight: number

maxLines

maxLines: number

maxWidth

maxWidth: number

mount

mount: number

mountX

mountX: number

mountY

mountY: number

offsetY

offsetY: number

overflowSuffix

overflowSuffix: string

parent

parent: null | INode<CoreShaderNode<Record<string, unknown>>>

parentFramebufferDimensions

parentFramebufferDimensions: Dimensions

parentHasRenderTexture

parentHasRenderTexture: boolean = false

parentRenderTexture

parentRenderTexture: null | CoreNode

pivot

pivot: number

pivotX

pivotX: number

pivotY

pivotY: number

OptionalpreloadBound

preloadBound?: Bound

premultipliedColorBl

premultipliedColorBl: number = 0

premultipliedColorBr

premultipliedColorBr: number = 0

premultipliedColorTl

premultipliedColorTl: number = 0

premultipliedColorTr

premultipliedColorTr: number = 0

Readonlyprops

props: CoreNodeProps

OptionalrenderBound

renderBound?: Bound

OptionalrenderCoords

renderCoords?: RenderCoords

renderInfo

renderInfo: TextRenderInfo

renderState

renderState: CoreNodeRenderState = CoreNodeRenderState.Init

rotation

rotation: number

rtt

rtt: boolean

rttParent

rttParent: null | CoreNode = null

scale

scale: number

scaleX

scaleX: number

scaleY

scaleY: number

OptionalsceneGlobalTransform

sceneGlobalTransform?: Matrix3d

OptionalsceneRenderCoords

sceneRenderCoords?: RenderCoords

shader

shader: null | CoreShaderNode<any>

src

src: null | string

srcHeight

srcHeight: undefined | number

srcWidth

srcWidth: undefined | number

srcX

srcX: undefined | number

srcY

srcY: undefined | number

Readonlystage

stage: Stage

OptionalstrictBound

strictBound?: Bound

text

text: string

textAlign

textAlign: "center" | "left" | "right"

textBaseline

textBaseline: TextBaseline

texture

texture: null | Texture

OptionaltextureCoords

textureCoords?: Bound

textureOptions

textureOptions: TextureOptions

updateShaderUniforms

updateShaderUniforms: boolean = false

updateTextureCoords

updateTextureCoords: boolean = false

updateType

updateType: UpdateType = UpdateType.All

verticalAlign

verticalAlign: TextVerticalAlign

w

w: number

wordBreak

wordBreak: "normal" | "break-all" | "break-word"

worldAlpha

worldAlpha: number = 1

x

x: number

y

y: number

zIndex

zIndex: number

zIndexLocked

zIndexLocked: number

Methods

allowTextGeneration

animate

calculateClippingRect

  • calculateClippingRect(parentClippingRect): void

  • This function calculates the clipping rectangle for a node.

    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. 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.

    Finally, the node's parentClippingRect and clippingRect properties are updated.

    Parameters

    • parentClippingRect: RectWithValid

    Returns void

calculateRenderCoords

calculateZIndex

checkRenderBounds

createRenderBounds

destroy

emit

flush

loadTexture

off

  • off(event, listener?): void

  • Parameters

    • event: string
    • Optionallistener: ((target: any, data: any) => void)
        • (target, data): void

        • Parameters

          • target: any
          • data: any

          Returns void

    Returns void

on

  • on(event, listener): void

  • Parameters

    • event: string
    • listener: ((target: any, data: any) => void)
        • (target, data): void

        • Parameters

          • target: any
          • data: any

          Returns void

    Returns void

once

  • once(event, listener): void

  • Parameters

    • event: string
    • listener: ((target: any, data: any) => void)
        • (target, data): void

        • Parameters

          • target: any
          • data: any

          Returns void

    Returns void

removeAllListeners

renderQuads

  • renderQuads(renderer): void

  • Override renderQuads to handle SDF vs Canvas rendering

    Parameters

    • renderer: CoreRenderer

    Returns void

setRenderable

  • setRenderable(isRenderable): void

  • Sets the renderable state and triggers changes if necessary.

    Parameters

    • isRenderable: boolean

      The new renderable state

    Returns void

setRTTUpdates

  • setRTTUpdates(type): void

  • Parameters

    • type: number

    Returns void

setUpdateType

  • setUpdateType(type): void

  • Change types types is used to determine the scope of the changes being applied

    Parameters

    • type: UpdateType

    Returns void

    Remarks

    See UpdateType for more information on each type

sortChildren

unloadTexture

update

  • update(delta, parentClippingRect): void

  • Override CoreNode's update method to handle text-specific updates

    Parameters

    • delta: number
    • parentClippingRect: RectWithValid

    Returns void

updateBoundingRect

updateIsRenderable

  • updateIsRenderable(): void

  • Override is renderable check for SDF text nodes

    Returns void

updateLocalTransform

updateRenderState

updateTextureOwnership

  • updateTextureOwnership(isRenderable): void

  • Changes the renderable state of the node.

    Parameters

    • isRenderable: boolean

    Returns void

Settings

Member Visibility

On This Page

Properties
absXabsYalphaautosizeboundsMargincalcZIndexchildrenchildUpdateTypeclippingclippingRectcolorcolorBlcolorBottomcolorBrcolorLeftcolorRightcolorTlcolorTopcolorTrdatadestroyedfontFamilyfontSizefontStyleforceLoadframebufferDimensionsglobalTransformhhasRTTupdatesidimageTypeinteractiveisRenderableletterSpacinglineHeightlocalTransformmaxHeightmaxLinesmaxWidthmountmountXmountYoffsetYoverflowSuffixparentparentFramebufferDimensionsparentHasRenderTextureparentRenderTexturepivotpivotXpivotYpreloadBoundpremultipliedColorBlpremultipliedColorBrpremultipliedColorTlpremultipliedColorTrpropsrenderBoundrenderCoordsrenderInforenderStaterotationrttrttParentscalescaleXscaleYsceneGlobalTransformsceneRenderCoordsshadersrcsrcHeightsrcWidthsrcXsrcYstagestrictBoundtexttextAligntextBaselinetexturetextureCoordstextureOptionsupdateShaderUniformsupdateTextureCoordsupdateTypeverticalAlignwwordBreakworldAlphaxyzIndexzIndexLocked
Methods