@creenv/hud v0.0.1

Creenv HUD

The HUD object can be used to regroup different elements from the @creenv Creative Environment, such as . Any element added to the HUD must inherit the @creenv/hud-element HUDElement class.

Right now, @creenv supports officialy those elements:

• @creenv/gui GUI - a panel used to have a graphical control over parameters used within the algorithms
• @creenv/stats Stats - a wrapper of mrdoob stat.js, used to display statistics about the render

How to use

import HUD from "@creenv/hud";

// hud elements 
import Stats from "@creenv/stats";
import GUI from "@creenv/gui";


let hud = new HUD();

let stats = new Stats();
hud.add(stats);

let controls = /* bla bla, see @creenv/gui for more details */;
let gui = new GUI(controls);
hud.add(gui);

That is done, stats will be added to the page so will the controls.

Full doc

Following is a full list of @creenv/hud available methods.

constructor (visible: ?boolean, toggleKey: ?string, infoMessage: false|string)

.toggle (visible: ?boolean)

Can force the visibility of the HUD if visible is defined, otherwise toggles the HUD to its opposite state.

.add (element: HUDElement)

Adds an element to the HUD. The element must be intance or child of @creenv/hud-element HUDElement.