Skip to main content

Working With Labels

To add a label to your scene, you first create the label, then add it to a billboard item, which is then rendered in the billboard pass. All of the billboard items you create, must be a part of the scene tree or hierarchy to be rendererd. You can add your billboard items to an empty tree item so that it can rendered.

  1. Adding Labels to Your Scene
  2. Working With Multilingual Labels

Below is an example of what you can do with labels

Adding Labels to Your Scene#

Add labels to your scene using the billboard renderer.

Add this code to your project. Use the Basic Setup Template to get started quickly.

// Zea Engine dependencies stored in new const variables. View the API to see what you can include and use.const { Scene, GLRenderer, Vec3, Color, Xfo, Label, BillboardItem, TreeItem } = window.zeaEngine
function createLabel(color, labelText) {  const label = new Label(labelText)  label.getParameter('FontSize').setValue(48)  label.getParameter('FontColor').setValue(color)  label.getParameter('BackgroundColor').setValue(new Color(0.3, 0.3, 0.3)  return label}
function createBillboard(label, pos) {  const billboard = new BillboardItem('billboard', label)  const xfo = new Xfo(pos)  billboard.getParameter('LocalXfo').setValue(xfo)  billboard.getParameter('PixelsPerMeter').setValue(300)  billboard.getParameter('AlignedToCamera').setValue(true)  billboard.getParameter('Alpha').setValue(1)  return billboard}
export function main() {  const renderer = new GLRenderer(document.getElementById('canvas'))  const camera = renderer.getViewport().getCamera()  camera.setPositionAndTarget(new Vec3(5, 6, 3), new Vec3(0, 0, 0))
  const scene = new Scene()  scene.setupGrid(20, 10)  renderer.setScene(scene)
  // create an empty TreeItem can be added to the scene tree to then add billboards to.  const asset = new TreeItem('labels')  scene.getRoot().addChild(asset)
  const label0 = createLabel(new Color(0, 1, 0), 'Hello')  const billboard0 = createBillboard(label0, new Vec3(1, 1, 1))  asset.addChild(billboard0)
  const label1 = createLabel(new Color(1, 1, 0), 'Long')  const billboard1 = createBillboard(label1, new Vec3(-1, -1, 1))  asset.addChild(billboard1)
  const label2 = createLabel(new Color(1, 1, 0), 'MyCustomLabel')  const billboard2 = createBillboard(label2, new Vec3(0, 0.05, 0.08))  asset.addChild(billboard2)

Working With Multilingual Labels#

Loading a label pack.#

See the live example

fetch('')  .then(response => response.json())  .then(data => {    labelManager.loadLibrary('LabelPack', data)    addLabel(new Vec3(0, 0, 0), new Vec3(0, 0.05, 0.08), new Color(1, 1, 0), 'MyCustomLabel')  })