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.

Hierarchy

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

Index

Properties

absX absY alpha autosize calcZIndex childUpdateType children clipping clippingRect color colorBl colorBottom colorBr colorLeft colorRight colorTl colorTop colorTr contain data debug fontFamily fontSize fontStretch fontStyle fontWeight framebufferDimensions globalTransform? hasRTTupdates height id imageType isRenderable letterSpacing lineHeight localTransform? maxLines mount mountX mountY offsetY overflowSuffix parent parentHasRenderTexture parentRenderTexture pivot pivotX pivotY preloadBound? premultipliedColorBl premultipliedColorBr premultipliedColorTl premultipliedColorTr preventCleanup props renderBound? renderCoords? renderState rotation rtt scale scaleRotateTransform? scaleX scaleY scrollY scrollable shader src srcHeight srcWidth srcX srcY stage strictBound? strictBounds text textAlign textBaseline textRenderer textRendererOverride texture textureOptions trState updateType verticalAlign width worldAlpha x y zIndex zIndexLocked

Properties

absX

absX: number

absY

absY: number

alpha

alpha: number

autosize

autosize: boolean

calcZIndex

calcZIndex: number = 0

childUpdateType

childUpdateType: UpdateType = UpdateType.None

`Readonly` children

children: CoreNode[] = []

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

contain

contain: "both" | "none" | "width"

data

data: undefined | CustomDataMap

debug

debug: Partial<TextRendererDebugProps>

fontFamily

fontFamily: string

fontStretch

fontStyle

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

fontWeight

fontWeight: number | "bold" | "normal" | "lighter" | "bolder"

framebufferDimensions

framebufferDimensions: Dimensions

`Optional` globalTransform

globalTransform?: Matrix3d

hasRTTupdates

hasRTTupdates: boolean = false

height

height: number

id

id: number

imageType

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

isRenderable

isRenderable: boolean = false

letterSpacing

letterSpacing: number

lineHeight

lineHeight: undefined | number

`Optional` localTransform

localTransform?: Matrix3d

maxLines

maxLines: number

mount

mount: number

mountX

mountX: number

mountY

mountY: number

offsetY

offsetY: number

overflowSuffix

overflowSuffix: string

parent

parent: null | INode<BaseShaderController>

parentHasRenderTexture

parentHasRenderTexture: boolean = false

parentRenderTexture

parentRenderTexture: null | CoreNode

pivot

pivot: number

pivotX

pivotX: number

pivotY

pivotY: number

`Optional` preloadBound

preloadBound?: Bound

premultipliedColorBl

premultipliedColorBl: number = 0

premultipliedColorBr

premultipliedColorBr: number = 0

premultipliedColorTl

premultipliedColorTl: number = 0

premultipliedColorTr

premultipliedColorTr: number = 0

preventCleanup

preventCleanup: boolean

`Readonly` props

props: CoreNodeProps

`Optional` renderBound

renderBound?: Bound

`Optional` renderCoords

renderCoords?: RenderCoords

renderState

renderState: CoreNodeRenderState = CoreNodeRenderState.Init

rotation

rotation: number

rtt

rtt: boolean

scale

scale: number

`Optional` scaleRotateTransform

scaleRotateTransform?: Matrix3d

scaleX

scaleX: number

scaleY

scaleY: number

scrollY

scrollY: number

scrollable

scrollable: boolean

shader

shader: BaseShaderController

src

src: null | string

srcHeight

srcHeight: undefined | number

srcWidth

srcWidth: undefined | number

srcX

srcX: undefined | number

srcY

srcY: undefined | number

`Readonly` stage

stage: Stage

`Optional` strictBound

strictBound?: Bound

strictBounds

strictBounds: boolean

text

text: string

textAlign

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

textBaseline

textBaseline: TextBaseline

textRenderer

textRenderer: TextRenderer<TextRendererState>

textRendererOverride

textRendererOverride: null | keyof TextRendererMap

texture

texture: null | Texture

textureOptions

textureOptions: TextureOptions

trState

trState: TextRendererState

updateType

updateType: UpdateType = UpdateType.All

verticalAlign

verticalAlign: TextVerticalAlign

width

width: number

worldAlpha

worldAlpha: number = 1

x

x: number

y

y: number

zIndex

zIndex: number

zIndexLocked

zIndexLocked: number

Methods

animate

animate(props, settings): IAnimationController
Parameters
- props: Partial<INodeAnimateProps<BaseShaderController>>
- settings: Partial<AnimationSettings>
Returns IAnimationController
- Defined in src/main-api/INode.ts:89

autosizeNode

autosizeNode(dimensions): void
Parameters
- dimensions: Dimensions
Returns void
Inherited from Omit.autosizeNode
- Defined in src/core/CoreNode.ts:809

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
Inherited from Omit.calculateClippingRect
- Defined in src/core/CoreNode.ts:1417

calculateRenderCoords

calculateRenderCoords(): void
Returns void
Inherited from Omit.calculateRenderCoords
- Defined in src/core/CoreNode.ts:1365

calculateZIndex

calculateZIndex(): void
Returns void
Inherited from Omit.calculateZIndex
- Defined in src/core/CoreNode.ts:1444

checkRenderBounds

checkRenderBounds(): CoreNodeRenderState
Returns CoreNodeRenderState
Inherited from Omit.checkRenderBounds
- Defined in src/core/CoreNode.ts:1222

checkRenderProps

checkRenderProps(): boolean
Returns boolean
Inherited from Omit.checkRenderProps
- Defined in src/core/CoreTextNode.ts:371

createPreloadBounds

createPreloadBounds(strictBound): Bound
Parameters
- strictBound: Bound
Returns Bound
Inherited from Omit.createPreloadBounds
- Defined in src/core/CoreNode.ts:1251

createRenderBounds

createRenderBounds(): void
Returns void
Inherited from Omit.createRenderBounds
- Defined in src/core/CoreNode.ts:1282

destroy

destroy(): void
Destroy the node and cleanup all resources

Returns void
Inherited from Omit.destroy
- Defined in src/core/CoreTextNode.ts:429

emit

emit(event, data?): void
Parameters
- event: string
- Optional data: any
Returns void
Inherited from Omit.emit
- Defined in src/common/EventEmitter.ts:64

flush

flush(): void
Returns void
Inherited from Omit.flush
- Defined in src/core/CoreNode.ts:2171

loadTexture

loadTexture(): void
Returns void
Inherited from Omit.loadTexture
- Defined in src/core/CoreNode.ts:771

off

off(event, listener?): void
Parameters
- event: string
- Optional listener: ((target, data) => void)
  - - (target, data): void
    - Parameters
      
      target: any
      
      data: any
      
      Returns void
Returns void
Inherited from Omit.off
- Defined in src/common/EventEmitter.ts:41

on

on(event, listener): void
Parameters
- event: string
- listener: ((target, data) => void)
  - - (target, data): void
    - Parameters
      
      target: any
      
      data: any
      
      Returns void
Returns void
Inherited from Omit.on
- Defined in src/common/EventEmitter.ts:32

onChangeIsRenderable

onChangeIsRenderable(isRenderable): void
Parameters
- isRenderable: boolean
Returns void
Inherited from Omit.onChangeIsRenderable
- Defined in src/core/CoreTextNode.ts:378

once

once(event, listener): void
Parameters
- event: string
- listener: ((target, data) => void)
  - - (target, data): void
    - Parameters
      
      target: any
      
      data: any
      
      Returns void
Returns void
Inherited from Omit.once
- Defined in src/common/EventEmitter.ts:56

removeAllListeners

removeAllListeners(): void
Returns void
Inherited from Omit.removeAllListeners
- Defined in src/common/EventEmitter.ts:74

renderQuads

renderQuads(renderer): void
Parameters
- renderer: CoreRenderer
Returns void
Inherited from Omit.renderQuads
- Defined in src/core/CoreTextNode.ts:383

setRTTUpdates

setRTTUpdates(type): void
Parameters
- type: number
Returns void
Inherited from Omit.setRTTUpdates
- Defined in src/core/CoreNode.ts:2152

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
Inherited from Omit.setUpdateType
- Defined in src/core/CoreNode.ts:862

sortChildren

sortChildren(): void
Returns void
Inherited from Omit.sortChildren
- Defined in src/core/CoreNode.ts:883

unloadTexture

unloadTexture(): void
Returns void
Inherited from Omit.unloadTexture
- Defined in src/core/CoreNode.ts:800

update

update(delta, parentClippingRect): void
Parameters
- delta: number
- parentClippingRect: RectWithValid
Returns void
Inherited from Omit.update
- Defined in src/core/CoreTextNode.ts:361

updateBoundingRect

updateBoundingRect(): void
Returns void
Inherited from Omit.updateBoundingRect
- Defined in src/core/CoreNode.ts:1261

updateIsRenderable

updateIsRenderable(): void
This function updates the isRenderable property based on certain conditions.

Returns void
Inherited from Omit.updateIsRenderable
- Defined in src/core/CoreNode.ts:1348

updateLocalTransform

updateLocalTransform(): void
Returns void
Inherited from Omit.updateLocalTransform
- Defined in src/core/CoreNode.ts:902

updateRenderState

updateRenderState(renderState): void
Parameters
- renderState: CoreNodeRenderState
Returns void
Inherited from Omit.updateRenderState
- Defined in src/core/CoreNode.ts:1328

updateScaleRotateTransform

updateScaleRotateTransform(): void
Returns void
Inherited from Omit.updateScaleRotateTransform
- Defined in src/core/CoreNode.ts:887

Interface ITextNode

Remarks

Hierarchy

Index

Properties

Methods

Properties

absX

absY

alpha

autosize

calcZIndex

childUpdateType

Readonly children

clipping

clippingRect

color

colorBl

colorBottom

colorBr

colorLeft

colorRight

colorTl

colorTop

colorTr

contain

data

debug

fontFamily

fontSize

fontStretch

fontStyle

fontWeight

framebufferDimensions

Optional globalTransform

hasRTTupdates

height

id

imageType

isRenderable

letterSpacing

lineHeight

Optional localTransform

maxLines

mount

mountX

mountY

offsetY

overflowSuffix

parent

parentHasRenderTexture

parentRenderTexture

pivot

pivotX

pivotY

Optional preloadBound

premultipliedColorBl

premultipliedColorBr

premultipliedColorTl

premultipliedColorTr

preventCleanup

Readonly props

Optional renderBound

Optional renderCoords

renderState

rotation

rtt

scale

Optional scaleRotateTransform

scaleX

scaleY

scrollY

scrollable

shader

src

srcHeight

srcWidth

srcX

srcY

Readonly stage

`Readonly` children

`Optional` globalTransform

`Optional` localTransform

`Optional` preloadBound

`Readonly` props

`Optional` renderBound

`Optional` renderCoords

`Optional` scaleRotateTransform

`Readonly` stage

`Optional` strictBound

`Optional` data: any

`Optional` listener: ((target, data) => void)