CopperLicht API Documentation
Class CL3D.Overlay2DSceneNode
Scene Node which draws a 2d overlay with color, image and/or text
Extends
CL3D.SceneNode.
Class Overview
CL3D.Overlay2DSceneNode(engine)
A simple 2d overlay scene node which draws a 2d area over the 3d scene. Useful for displaying text, images and similar.
// how to add a 2D overlay with text
var overlay = new CL3D.Overlay2DSceneNode();
scene.getRootSceneNode().addChild(overlay);
overlay.set2DPosition(10,10,200,70);
overlay.setText('Hello World!');
overlay.FontName = "12;default;arial;normal;bold;true";
overlay.TextColor = CL3D.createColor(255, 150, 232, 249);
- Parameters:
- engine
| Field Attributes | Field Name and Description |
|---|---|
|
Font string to be used when drawing text.
|
|
|
Text alignment to be used.
|
|
|
Text color to be used.
|
| Method Attributes | Method Name and Description |
|---|---|
|
Get the axis aligned, not transformed bounding box of this node.
|
|
|
getType()
Returns the type string of the scene node.
|
|
|
set2DPosition(x, y, width, height)
Sets the position of the overlay in pixels
|
|
|
setShowBackgroundColor(showBackground, color)
Sets if the overlay scene node should show a colored background
|
|
|
setShowImage(tex)
Sets if the overlay scene node should show a image
|
|
|
setText(text)
Sets the text which should be shown on the overlay 2D node.
|
- Methods borrowed from class CL3D.SceneNode:
- addAnimator, addChild, createClone, getAbsolutePosition, getAbsoluteTransformation, getAnimatorOfType, getAnimators, getChildren, getMaterial, getMaterialCount, getParent, getRelativeTransformation, getTransformedBoundingBox, init, isActuallyVisible, OnAnimate, OnRegisterSceneNode, removeAnimator, removeChild, render, updateAbsolutePosition
Field Detail
{String.}
FontName
Font string to be used when drawing text. It uses the following format:
PointSize;Family(Default|Decorative|Roman|Script|Swiss|Modern);FaceName(Arial etc);Style(Normal|Slant|Italic);Weight(Normal|Light|Bold);Underlined(True|false)
Example: "12;default;arial;normal;bold;true"
- Default Value:
- ""
{Number}
TextAlignment
Text alignment to be used. Use 0 for left align, 1 for center and 2 for multiline with word wrap.
- Default Value:
- 0
{Number}
TextColor
Text color to be used. Use for example CL3D.createColor(255, 150, 232, 249); to create a nice color.
- Default Value:
- 0
Method Detail
{CL3D.Box3d}
getBoundingBox()
Get the axis aligned, not transformed bounding box of this node.
This means that if this node is an animated 3d character, moving in a room, the bounding box will
always be around the origin. To get the box in real world coordinates, just transform it with the matrix
you receive with getAbsoluteTransformation() or simply use getTransformedBoundingBox(), which does the same.
- Returns:
- {CL3D.Box3d} Bounding box of this scene node.
{String}
getType()
Returns the type string of the scene node.
Returns '2doverlay' for the scene node.
- Returns:
- {String} type name of the scene node.
set2DPosition(x, y, width, height)
Sets the position of the overlay in pixels
- Parameters:
- x
- {Number} x position of the overlay in pixels
- y
- {Number} y position of the overlay in pixels
- width
- {Number} width of the overlay in pixels
- height
- {Number} height of the overlay in pixels
setShowBackgroundColor(showBackground, color)
Sets if the overlay scene node should show a colored background
- Parameters:
- showBackground
- {Boolean} true to show the backgroundcolor, false if not
- color
- {Number} a color created with CL3D.createColor defining the color to show
setShowImage(tex)
Sets if the overlay scene node should show a image
- Parameters:
- {CL3D.Texture} tex
- a CL3D.Texture to show as image on the 2d overlay
setText(text)
Sets the text which should be shown on the overlay 2D node.
Note that you can also set a text color using the .TextColor property and a
font using the FontName property.
- Parameters:
- text
- {String}