The alpha opacity of the Node.
The alpha value is a number between 0 and 1, where 0 is fully transparent and 1 is fully opaque.
1
Readonly childrenClipping Mode
Enable Clipping Mode when you want to prevent the drawing of a Node and its descendants from overflowing outside of the Node's x/y/width/height bounds.
For WebGL, clipping is implemented using the high-performance WebGL operation scissor. As a consequence, clipping does not work for non-rectangular areas. So, if the element is rotated (by itself or by any of its ancestors), clipping will not work as intended.
TODO: Add support for non-rectangular clipping either automatically or via Render-To-Texture.
false
The color of the Node.
The color value is a number in the format 0xRRGGBBAA, where RR is the red component, GG is the green component, BB is the blue component, and AA is the alpha component.
Gradient colors may be set by setting the different color sub-properties: colorTop, colorBottom, colorLeft, colorRight, colorTl, colorTr, colorBr, colorBl accordingly.
0xffffffff (opaque white)
The color of the bottom-left corner of the Node for gradient rendering.
See color for more information about color values and gradient rendering.
The color of the bottom edge of the Node for gradient rendering.
See color for more information about color values and gradient rendering.
The color of the bottom-right corner of the Node for gradient rendering.
See color for more information about color values and gradient rendering.
The color of the left edge of the Node for gradient rendering.
See color for more information about color values and gradient rendering.
The color of the right edge of the Node for gradient rendering.
See color for more information about color values and gradient rendering.
The color of the top-left corner of the Node for gradient rendering.
See color for more information about color values and gradient rendering.
The color of the top edge of the Node for gradient rendering.
See color for more information about color values and gradient rendering.
The color of the top-right corner of the Node for gradient rendering.
See color for more information about color values and gradient rendering.
Destroys the node and all its children
Find a node by key
string key
ISceneNode or null
Gets the internal Lightning 3 node. Note: This should not be needed in most cases.
INode or null
The height of the Node.
0
Combined position of the Node's Mount Point
The value can be any number between 0.0 and 1.0:
0.0 defines the Mount Point at the top-left corner of the Node.0.5 defines it at the center of the Node.1.0 defines it at the bottom-right corner of the node.Use the mountX and mountY props seperately for more control of the Mount Point.
When assigned, the same value is also passed to both the mountX and mountY props.
0 (top-left)
X position of the Node's Mount Point
The value can be any number between 0.0 and 1.0:
0.0 defines the Mount Point's X position as the left-most edge of the
Node0.5 defines it as the horizontal center of the Node1.0 defines it as the right-most edge of the Node.The combination of mountX and mountY define the Mount Point
0 (left-most edge)
Y position of the Node's Mount Point
The value can be any number between 0.0 and 1.0:
0.0 defines the Mount Point's Y position as the top-most edge of the
Node0.5 defines it as the vertical center of the Node1.0 defines it as the bottom-most edge of the Node.The combination of mountX and mountY define the Mount Point
0 (top-most edge)
The Node's parent Node.
The value null indicates that the Node has no parent. This may either be
because the Node is the root Node of the scene graph, or because the Node
has been removed from the scene graph.
In order to make sure that a Node can be rendered on the screen, it must be added to the scene graph by setting it's parent property to a Node that is already in the scene graph such as the root Node.
null
Combined position of the Node's Pivot Point
The value can be any number between 0.0 and 1.0:
0.0 defines the Pivot Point at the top-left corner of the Node.0.5 defines it at the center of the Node.1.0 defines it at the bottom-right corner of the node.Use the pivotX and pivotY props seperately for more control of the Pivot Point.
When assigned, the same value is also passed to both the pivotX and pivotY props.
0.5 (center)
X position of the Node's Pivot Point
The value can be any number between 0.0 and 1.0:
0.0 defines the Pivot Point's X position as the left-most edge of the
Node0.5 defines it as the horizontal center of the Node1.0 defines it as the right-most edge of the Node.The combination of pivotX and pivotY define the Pivot Point
0.5 (centered on x-axis)
Y position of the Node's Pivot Point
The value can be any number between 0.0 and 1.0:
0.0 defines the Pivot Point's Y position as the top-most edge of the
Node0.5 defines it as the vertical center of the Node1.0 defines it as the bottom-most edge of the Node.The combination of pivotX and pivotY define the Pivot Point
0.5 (centered on y-axis)
Removes a child node from the tree, this will unmount the node and destroy it.
Rotation of the Node (in Radians)
Sets the amount to rotate the Node by around it's Pivot Point (defined by the pivot props). Positive values rotate the Node clockwise, while negative values rotate it counter-clockwise.
Example values:
-Math.PI / 2: 90 degree rotation counter-clockwise0: No rotationMath.PI / 2: 90 degree rotation clockwiseMath.PI: 180 degree rotation clockwise3 * Math.PI / 2: 270 degree rotation clockwise2 * Math.PI: 360 rotation clockwiseScale to render the Node at
The scale value multiplies the provided width and height of the Node around the Node's Pivot Point (defined by the pivot props).
Behind the scenes, setting this property sets both the scaleX and scaleY props to the same value.
NOTE: When the scaleX and scaleY props are explicitly set to different values,
this property returns null. Setting null on this property will have no
effect.
1.0
Scale to render the Node at (X-Axis)
Scale to render the Node at (Y-Axis)
The Node's shader
The shader defines a Shader used to draw the Node. By default,
the Default Shader is used which simply draws the defined texture
or color(s) within the Node without any special effects.
To create a Shader in order to set it on this property, call RendererMain.createShader.
Note: If this is a Text Node, the Shader will be managed by the Node's TextRenderer and should not be set explicitly.
Image URL
When set, the Node's texture is automatically set to an ImageTexture using the source image URL provided (with all other settings being defaults)
The Node's Texture.
The texture defines a rasterized image that is contained within the
width and height dimensions of the Node. If null, the
Node will use an opaque white ColorTexture when being drawn, which
essentially enables colors (including gradients) to be drawn.
If set, by default, the texture will be drawn, as is, stretched to the dimensions of the Node. This behavior can be modified by setting the TBD and TBD properties.
To create a Texture in order to set it on this property, call RendererMain.createTexture.
If the src is set on a Node, the Node will use the ImageTexture by default and the Node will simply load the image at the specified URL.
Note: If this is a Text Node, the Texture will be managed by the Node's TextRenderer and should not be set explicitly.
The width of the Node.
0
The x coordinate of the Node's Mount Point.
The y coordinate of the Node's Mount Point.
The Node's z-index.
TBD
Generated using TypeDoc
Adds a new child node to the scene