@optellix/xviewr-sdk
v2.0.1
Published
XViewr 3D Viewer SDK - Modular plugin-based 3D viewer
Maintainers
Readme
XViewr SDK
A powerful, modular 3D viewer SDK built on Three.js — by Optellix.
XViewr SDK is proprietary commercial software. All Rights Reserved. A valid Optellix license key is required to use this SDK. Contact: optellix.com | [email protected]
Getting Started
1. Obtain a License Key
Contact us at optellix.com or email [email protected] to obtain your commercial license key.
2. Install
npm install @optellix/xviewr-sdk three3. Initialise the Viewer
import { ViewerCore } from "@optellix/xviewr-sdk";
const viewer = new ViewerCore(container, {
license: "YOUR_OPTELLIX_LICENSE_KEY",
viewer: {
container: document.getElementById("viewer"),
camera: { type: "perspective" },
controls: { type: "orbit" },
environment: {},
licensing: { key: "YOUR_OPTELLIX_LICENSE_KEY" },
},
plugins: [],
features: {
enableCrossSection: false,
enableMeasurement: false,
enableSelection: true,
enableTransform: false,
enableLabels: false,
enableAnimation: false,
enableGrid: true,
enableShadows: false,
enableEnvironment: true,
},
rendering: { antialias: true },
});4. Load a Model
await viewer.loadModel("https://your-cdn.com/model.glb");Support
For documentation, support, and licensing:
- Website: optellix.com
- Support: [email protected]
- Licensing: [email protected]
License
Proprietary — All Rights Reserved. A valid Optellix commercial license key is required. See LICENSE.
