OBJLoaderPlugin

Viewer plugin that loads models from OBJ files.

• Creates an Entity representing each model it loads, which will have Entity#isModel set true and will be registered by Entity#id in Scene#models.
• Creates an Entity for each object within the model, which will have Entity#isObject set true and will be registered by Entity#id in Scene#objects.
• When loading, can set the World-space position, scale and rotation of each model within World space, along with initial properties for all the model's Entitys.

Metadata

OBJLoaderPlugin can also load an accompanying JSON metadata file with each model, which creates a MetaModel corresponding to the model Entity and a MetaObject corresponding to each object Entity.

Each MetaObject has a MetaObject#type, which indicates the classification of its corresponding Entity. When loading metadata, we can also provide GLTFModelLoaderPlugin with a custom lookup table of initial values to set on the properties of each type of Entity. By default, OBJLoaderPlugin uses its own map of standard default colors, visibilities and opacities for IFC element types.

Usage

[Run this example]

import {Viewer, OBJLoaderPlugin} from "xeokit-sdk.es.js";

// Create a xeokit Viewer and arrange the camera
const viewer = new Viewer({
     canvasId: "myCanvas",
     transparent: true
});

viewer.camera.orbitPitch(20);

// Add an OBJLoaderPlugin to the Viewer
const objLoader = new OBJLoaderPlugin(viewer);

// Load an OBJ model
var model = objLoader.load({ // Model is an Entity
     id: "myModel",
     src: "./models/obj/sportsCar/sportsCar.obj",
     edges: true
});

// When the model has loaded, fit it to view
model.on("loaded", () => {
     viewer.cameraFlight.flyTo(model);
})

// Find the model Entity by ID
model = viewer.scene.models["myModel"];

// Update properties of the model Entity
model.highlight = [1,0,0];

// Destroy the model
model.destroy();