A Node is a basic building block of the Renderer scene graph. It can be a
container for other Nodes, or it can be a leaf Node that renders a solid
color, gradient, image, or specific texture, using a specific shader.
CoreNode is the name of the class for a Renderer Node and is only directly
used internally by the Renderer. INode describes the public API of a
Renderer Node including the ability to be tied to a specific Shader.
Users of the Renderer API, should generally interact with INode objects
instead of CoreNode objects.
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
calculateRenderCoords(): void
Returns void
calculateZIndex
calculateZIndex(): void
Returns void
checkRenderBounds
checkRenderBounds(): CoreNodeRenderState
Returns CoreNodeRenderState
checkRenderProps
checkRenderProps(): boolean
Returns boolean
createPreloadBounds
createPreloadBounds(strictBound): Bound
Parameters
strictBound: Bound
Returns Bound
createRenderBounds
createRenderBounds(): void
Returns void
destroy
destroy(): void
Destroy the node and cleanup all resources
Returns void
emit
emit(event, data?): void
Parameters
event: string
Optionaldata: any
Returns void
flush
flush(): void
Returns void
loadTexture
loadTexture(): void
Returns void
off
off(event, listener?): void
Parameters
event: string
Optionallistener: ((target, data) => void)
(target, data): void
Parameters
target: any
data: any
Returns void
Returns void
on
on(event, listener): void
Parameters
event: string
listener: ((target, data) => void)
(target, data): void
Parameters
target: any
data: any
Returns void
Returns void
onChangeIsRenderable
onChangeIsRenderable(isRenderable): void
Parameters
isRenderable: boolean
Returns void
once
once(event, listener): void
Parameters
event: string
listener: ((target, data) => void)
(target, data): void
Parameters
target: any
data: any
Returns void
Returns void
removeAllListeners
removeAllListeners(): void
Returns void
renderQuads
renderQuads(renderer): void
Parameters
renderer: CoreRenderer
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
sortChildren(): void
Returns void
unloadTexture
unloadTexture(): void
Returns void
update
update(delta, parentClippingRect): void
@todo: test for correct calculation flag
Parameters
delta: number
parentClippingRect: RectWithValid
Returns void
updateBoundingRect
updateBoundingRect(): void
Returns void
updateIsRenderable
updateIsRenderable(): void
This function updates the isRenderable property based on certain conditions.
A visual Node in the Renderer scene graph.
Remarks
A Node is a basic building block of the Renderer scene graph. It can be a container for other Nodes, or it can be a leaf Node that renders a solid color, gradient, image, or specific texture, using a specific shader.
For text rendering Nodes, see ITextNode.
INode vs CoreNode
CoreNode is the name of the class for a Renderer Node and is only directly used internally by the Renderer. INode describes the public API of a Renderer Node including the ability to be tied to a specific Shader.
Users of the Renderer API, should generally interact with INode objects instead of CoreNode objects.