@lightningjs/renderer
    Preparing search index...

    Class CoreNode

    A visual Node in the Renderer scene graph.

    CoreNode is an internally used class that represents a Renderer Node in the scene graph. See INode.ts for the public APIs exposed to Renderer users that include generic types for Shaders.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _id: number = ...
    autosizer: null | Autosizer = null

    Autosize properties

    calcZIndex: number = 0
    children: CoreNode[] = []
    childUpdateType: UpdateType = UpdateType.None
    clippingRect: RectWithValid = ...
    destroyed: boolean = false
    framebufferDimensions: null | Dimensions = null

    only used when rtt = true

    globalTransform?: Matrix3d
    hasRTTupdates: boolean = false
    hasShaderTimeFn: boolean = false
    isCoreNode: true = ...
    isRenderable: boolean = false
    localTransform?: Matrix3d
    numQuads: number = 0
    onTextureLoaded: TextureLoadedEventHandler = ...
    parentAutosizer: null | Autosizer = null
    parentHasRenderTexture: boolean = false
    preloadBound?: Bound
    premultipliedColorBl: number = 0
    premultipliedColorBr: number = 0
    premultipliedColorTl: number = 0
    premultipliedColorTr: number = 0
    previousZIndex: number = -1
    renderBound?: Bound
    renderCoords?: RenderCoords
    renderOpBufferIdx: number = 0
    renderOpTextures: WebGlCoreCtxTexture[] = []
    renderState: CoreNodeRenderState = CoreNodeRenderState.Init
    rttParent: null | CoreNode = null
    sceneGlobalTransform?: Matrix3d
    sceneRenderCoords?: RenderCoords
    stage: Stage
    strictBound?: Bound
    textureCoords?: Bound
    updateShaderUniforms: boolean = false
    updateType: UpdateType = UpdateType.All
    worldAlpha: number = 1

    Accessors

    • get boundsMargin(): null | number | [number, number, number, number]

      Returns null | number | [number, number, number, number]

    • set boundsMargin(value: null | number | [number, number, number, number]): void

      Parameters

      • value: null | number | [number, number, number, number]

      Returns void

    • get imageType(): null | "svg" | "regular" | "compressed"

      Returns null | "svg" | "regular" | "compressed"

    • set imageType(type: null | "svg" | "regular" | "compressed"): void

      Parameters

      • type: null | "svg" | "regular" | "compressed"

      Returns void

    Methods

    • 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

    • Checks if the node is renderable based on world alpha, dimensions and out of bounds status.

      Returns boolean

    • Checks if the node is out of the viewport bounds.

      Returns boolean

    • Parameters

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

      Returns void

    • Sets the renderable state and triggers changes if necessary.

      Parameters

      • isRenderable: boolean

        The new renderable state

      Returns void

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

      Parameters

      • type: UpdateType

      Returns void

      See UpdateType for more information on each type

    • @todo: test for correct calculation flag

      Parameters

      • delta: number
      • parentClippingRect: RectWithValid

      Returns void

    • Updates the isRenderable property based on various conditions.

      Returns void

    • Changes the renderable state of the node.

      Parameters

      • isRenderable: boolean

      Returns void