Package structure

Open Cascade Web Viewer is distributed in form of an NPM package for straightforward usage from modern Web development frameworks. This proprietary package is expected to be privately hosted or used locally (e.g. it is NOT directly available from servers of NPM project).

The package consists of WebAssembly module(s), TypeScript API, resources (images, fonts, models) and samples.

TypeScript bindings to 3D Viewer expose web-friendly API. Long operations provide Promise-based API.

Two WebAssembly modules are provided - multi-threaded and single-threaded; the latter is a fallback implementation for compatibility with older browsers / limited environments.

The following samples in the package demonstrate basic Viewer integration into various frameworks:

• samples/html/html-simple
  Static HTML page (JavaScript API).
• samples/vue
  Vue.js project (TypeScript API).
• samples/angular-simple
  AngularJS project (TypeScript API).

Additional advanced samples demonstrate Viewer capabilities:

• samples/html/demo
  Advanced static HTML page (JavaScript API).
• samples/html/core
  Advanced features projects (JavaScript API).
• samples/html/html-multiview
  Multiview HTML sample (JavaScript API).
• samples/html/modules
  Modules projects (JavaScript API).

Package contains also external resources like images and font files. See license for more details.