Skip to content

Building the STK

angelxuanchang edited this page Jan 13, 2018 · 1 revision

Building the STK

To build the STK,

./build.sh

After building, you can find the built UMD at: scene-toolkit\client\build\STK.bundle.js NOTE: This currently does include minor dependencies of many external libraries....

Using the STK

You can use the built bundle by using commonJS or AMD (see SceneViewer for how to use the SceneViewer):

commonJS:

var STK = require('STK.bundle');
var sceneViewer = new STK.SceneViewer(...);

AMD:

define(['STK.bundle'], function (STK) {
  var sceneViewer = new STK.SceneViewer(...);
  ... 
})

Required dependencies

For all html files, the following js need to be loaded before the bundle js is loaded:

  • jquery
  • jquery-ui
  • three.js (custom)

Also, some other js dependencies are needed for some of the html files:
bootstrap: index.html, part-annotator.jade, view-model.jade
jstree: index.html, scene-viewer.html, text2scene.html, model-viewer.jade, view-model.jade, part-annotator-intro.jade, part-annotator.jade, part-viewer.jade
d3: index.html, text2scene.html, scene-viewer.html, sim-viewer.html, dataVis.html, ranker.html

For the sceneViewerLib bundle, all the JS dependencies specified above (excluding bootstrap JS) need to be loaded beforehand

Clone this wiki locally