Home

Productbuilder Engine

The Productbuilder Engine is the main core for the Configurator. The main directory of the Engine is scr dir. Within this dir you will be able to find all source scripts for the Engine.

Directory structure

  • build
  • coverage
  • docs
  • node_modules
  • src
  • test
  • utils

Build

By running "yarn build" form the terminal a current version of the Engine willbe build.

Test

The test directory is used to test the entire Engine. Each script / features will have it's own test.

Source Sections (src)

  • actor
  • component
  • configurator
  • default_settings
  • export
  • package
  • reporter
  • scene
  • server
  • transform
  • utilities
  • view

view

Event Handlers

The engine makes primarily use of pointer events. Pointer can handle mouse, touch and stylus events.

While handling events it is important to take notice of the event cascade. (https://www.smashingmagazine.com/2015/03/better-browser-input-events/)

Utils (Viewers)

The Utils directory is used for Helper Apps that are built directly on top of the Engine. Currently these are mainly viewers to test the worings of the engine.

Standard Viewer

The Standard Viewer is built as an experiment to see if packages from different manufacturers can be combined in to one single interface. The Design/Architecture for the Satndard Viewer is inherited from the Threejs Editor.

In order to launch the Standard Viewer it expects the following directory structure:

  • Root
    • packages
    • engine

In order to start the standard viewer. Run the http-server from the Root directory and open your localhost:8080 in your browser. Then navigate to "/engine/utils/standard-viewer" to open de web app.

Safari

In order to test the Engine in safari this will need to be done through a build of the Engine. When running the engine with it's source script it will encoutner numerous error's. Besides running the Engine through the build it also needs to be run in https instead of http. To be able to run https you will need to have a key on your system.

Change log

Releases