Documentation Overview

The behave3d library is written in Javascript (ECMA 5) and uses CSS3 3D transforms. Check the Browser Requirements page for a list of used JS and CSS features and browsers supporting them. The lib can either linked via tags, or loaded as an ES6/CommonJS module.

For an overview of how the library is used, take a look at the Workflow Documentation page.

The engine attaches 'controllers' to HTML elements on the page and updates these controllers on each drawing frame of the browser. The engine also synchronizes the scene's perspective-origin CSS property with the browser's viewport position. Check the Engine Documentation page to learn more about how the engine works.

Every HTML element with attached controllers has an added DOM property behave3d, which contains an object of class Behave3d.Element that manages the element's controllers and the transforms they apply. Check the Behave3d.Element Documentation page to learn more about how the element is managed.

Every controller has parameters, receives messages and fires events. Check the Behave3d.Controller Documentation page to learn more about how to set parameters, send messages and add event listeners and triggers to a controller. Check the Documentation > Controller Reference menu above for documentation on each controller.

You can easily create new controllers starting from the Controller Template or from a copy of the file of an existing controller with similar functionality. Check the Adding a New Controller page for details.