@kitware/vtk.js 33.0.0-beta.2 → 33.0.0-beta.3

package/IO/Geometry/GLTFImporter.d.ts

@@ -0,0 +1,266 @@
+import { vtkAlgorithm, vtkObject } from './../../interfaces';
+import HtmlDataAccessHelper from './../Core/DataAccessHelper/HtmlDataAccessHelper';
+import HttpDataAccessHelper from './../Core/DataAccessHelper/HttpDataAccessHelper';
+import JSZipDataAccessHelper from './../Core/DataAccessHelper/JSZipDataAccessHelper';
+import LiteHttpDataAccessHelper from './../Core/DataAccessHelper/LiteHttpDataAccessHelper';
+
+import vtkActor from './../../Rendering/Core/Actor';
+import vtkRenderer from './../../Rendering/Core/Renderer';
+import vtkCamera from './../../Rendering/Core/Camera';
+
+interface IGLTFImporterOptions {
+  binary?: boolean;
+  compression?: string;
+  progressCallback?: any;
+}
+
+export interface IGLTFAnimation {
+  id: string;
+  name: string;
+  channels: any[];
+  samplers: any[];
+}
+
+export interface IGLTFAnimationMixer {
+  addAnimation: (glTFAnimation: object) => void;
+  play: (name: string, weight?: number) => void;
+  stop: (name: string) => void;
+  stopAll: () => void;
+  update: (deltaTime: number) => void;
+}
+
+export interface IGLTFMaterialVariant {
+  material: number;
+  variants: number[];
+}
+
+/**
+ *
+ */
+export interface IGLTFImporterInitialValues {}
+
+type vtkGLTFImporterBase = vtkObject &
+  Omit<
+    vtkAlgorithm,
+    | 'getInputData'
+    | 'setInputData'
+    | 'setInputConnection'
+    | 'getInputConnection'
+    | 'addInputConnection'
+    | 'addInputData'
+  >;
+
+export interface vtkGLTFImporter extends vtkGLTFImporterBase {
+  /**
+   * Get the actors.
+   */
+  getActors(): Map<string, vtkActor>;
+
+  /**
+   * Get the animation mixer.
+   */
+  getAnimationMixer(): IGLTFAnimationMixer;
+
+  /**
+   * Get the animations.
+   */
+  getAnimations(): IGLTFAnimation[];
+
+  /**
+   * Get the base url.
+   */
+  getBaseURL(): string;
+
+  /**
+   * Get the cameras.
+   */
+  getCameras(): Map<string, vtkCamera>;
+
+  /**
+   *
+   */
+  getDataAccessHelper():
+    | HtmlDataAccessHelper
+    | HttpDataAccessHelper
+    | JSZipDataAccessHelper
+    | LiteHttpDataAccessHelper;
+
+  /**
+   * Get the url of the object to load.
+   */
+  getUrl(): string;
+
+  /**
+   * Get the variant array.
+   */
+  getVariants(): string[];
+
+  /**
+   * Get the variant mappings.
+   */
+  getVariantMappings(): Map<string, IGLTFMaterialVariant[]>;
+
+  /**
+   * Import the actors.
+   */
+  importActors(): void;
+
+  /**
+   * Import the animations.
+   */
+  importAnimations(): void;
+
+  /**
+   * Import the cameras.
+   */
+  importCameras(): void;
+
+  /**
+   * Import the lights.
+   */
+  importLights(): void;
+
+  /**
+   * Invoke the ready event.
+   */
+  invokeReady(): void;
+
+  /**
+   * Load the object data.
+   * @param {IGLTFImporterOptions} [options]
+   */
+  loadData(options?: IGLTFImporterOptions): Promise<any>;
+
+  /**
+   *
+   * @param callback
+   */
+  onReady(callback: () => void): void;
+
+  /**
+   * Parse data.
+   * @param {String | ArrayBuffer} content The content to parse.
+   */
+  parse(content: string | ArrayBuffer): void;
+
+  /**
+   * Parse data as ArrayBuffer.
+   * @param {ArrayBuffer} content The content to parse.
+   */
+  parseAsArrayBuffer(content: ArrayBuffer): void;
+
+  /**
+   * Parse data as text.
+   * @param {String} content The content to parse.
+   */
+  parseAsText(content: string): void;
+
+  /**
+   *
+   * @param inData
+   * @param outData
+   */
+  requestData(inData: any, outData: any): void;
+
+  /**
+   *
+   * @param dataAccessHelper
+   */
+  setDataAccessHelper(
+    dataAccessHelper:
+      | HtmlDataAccessHelper
+      | HttpDataAccessHelper
+      | JSZipDataAccessHelper
+      | LiteHttpDataAccessHelper
+  ): boolean;
+
+  /**
+   * Set the url of the object to load.
+   * @param {String} url the url of the object to load.
+   * @param {IGLTFImporterOptions} [option] The Draco reader options.
+   */
+  setUrl(url: string, option?: IGLTFImporterOptions): Promise<string | any>;
+
+  /**
+   * Set the camera id.
+   * @param cameraId The camera id.
+   */
+  setCamera(cameraId: string): void;
+
+  /**
+   * Set the Draco decoder.
+   * @param dracoDecoder
+   */
+  setDracoDecoder(dracoDecoder: any): void;
+
+  /**
+   * Set the vtk Renderer.
+   * @param renderer The vtk Renderer.
+   */
+  setRenderer(renderer: vtkRenderer): void;
+
+  /**
+   * Switch to a variant.
+   * @param variantIndex The index of the variant to switch to.
+   */
+  switchToVariant(variantIndex: number): void;
+}
+
+/**
+ * Method used to decorate a given object (publicAPI+model) with vtkGLTFImporter characteristics.
+ *
+ * @param publicAPI object on which methods will be bounds (public)
+ * @param model object on which data structure will be bounds (protected)
+ * @param {IGLTFImporterInitialValues} [initialValues] (default: {})
+ */
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IGLTFImporterInitialValues
+): void;
+
+/**
+ * Method used to create a new instance of vtkGLTFImporter
+ * @param {IGLTFImporterInitialValues} [initialValues] for pre-setting some of its content
+ */
+export function newInstance(
+  initialValues?: IGLTFImporterInitialValues
+): vtkGLTFImporter;
+
+/**
+ * Load the WASM decoder from url and set the decoderModule
+ * @param url
+ * @param binaryName
+ */
+export function setWasmBinary(
+  url: string,
+  binaryName: string
+): Promise<boolean>;
+
+/**
+ * vtkGLTFImporter can import glTF 2.0 files.
+ *
+ * The GL Transmission Format (glTF) is an API-neutral runtime asset delivery
+ * format. A glTF asset is represented by:
+ * * A JSON-formatted file (.gltf) containing a full scene description: node
+ *   hierarchy, materials, cameras, as well as descriptor information for
+ *   meshes, animations, and other constructs
+ * * Binary files (.bin) containing geometry and animation data, and other
+ *   buffer-based data
+ * * Image files (.jpg, .png) for textures
+ *
+ * Supported extensions:
+ * * KHR_draco_mesh_compression
+ * * KHR_lights_punctual
+ * * KHR_materials_unlit
+ * * KHR_materials_ior
+ * * KHR_materials_specular
+ * * KHR_materials_variants
+ * * EXT_texture_webp
+ * * EXT_texture_avif
+ */
+export declare const vtkGLTFImporter: {
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+};
+export default vtkGLTFImporter;

package/IO/Geometry/GLTFImporter.js

@@ -0,0 +1,245 @@
+import { m as macro } from '../../macros2.js';
+import BinaryHelper from '../Core/BinaryHelper.js';
+import DataAccessHelper from '../Core/DataAccessHelper.js';
+import vtkDracoReader from './DracoReader.js';
+import { parseGLTF, createVTKObjects, GLTFCameraToVTKCamera, applyTransformToCamera, createPropertyFromGLTFMaterial } from './GLTFImporter/Reader.js';
+import parseGLB from './GLTFImporter/Decoder.js';
+import { createAnimationMixer } from './GLTFImporter/Animations.js';
+import { BINARY_HEADER_MAGIC } from './GLTFImporter/Constants.js';
+
+const {
+  vtkDebugMacro,
+  vtkErrorMacro
+} = macro;
+
+// ----------------------------------------------------------------------------
+// vtkGLTFImporter methods
+// ----------------------------------------------------------------------------
+
+function vtkGLTFImporter(publicAPI, model) {
+  // Set our className
+  model.classHierarchy.push('vtkGLTFImporter');
+
+  // Create default dataAccessHelper if not available
+  if (!model.dataAccessHelper) {
+    model.dataAccessHelper = DataAccessHelper.get('http');
+  }
+
+  // Internal method to fetch Array
+  function fetchData(url) {
+    let option = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    const {
+      compression,
+      progressCallback
+    } = model;
+    if (option.binary) {
+      return model.dataAccessHelper.fetchBinary(url, {
+        compression,
+        progressCallback
+      });
+    }
+    return model.dataAccessHelper.fetchText(publicAPI, url, {
+      compression,
+      progressCallback
+    });
+  }
+
+  // Set DataSet url
+  publicAPI.setUrl = function (url) {
+    let option = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {
+      binary: true
+    };
+    model.url = url;
+
+    // Remove the file in the URL
+    const path = url.split('/');
+    path.pop();
+    model.baseURL = path.join('/');
+    model.compression = option.compression;
+    model.sceneId = option.sceneId ? option.sceneId : 0;
+
+    // Fetch metadata
+    return publicAPI.loadData({
+      progressCallback: option.progressCallback,
+      binary: !!option.binary
+    });
+  };
+
+  // Fetch the actual data arrays
+  publicAPI.loadData = function () {
+    let option = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    const promise = fetchData(model.url, option);
+    promise.then(publicAPI.parse);
+    return promise;
+  };
+  publicAPI.parse = content => {
+    if (typeof content === 'string') {
+      publicAPI.parseAsText(content);
+    } else {
+      publicAPI.parseAsBinary(content);
+    }
+  };
+  publicAPI.parseAsBinary = async content => {
+    if (!content) {
+      return;
+    }
+    if (content !== model.parseData) {
+      publicAPI.modified();
+    } else {
+      return;
+    }
+    const glTF = {};
+    const options = {
+      baseUri: model.baseURL
+    };
+    const magic = BinaryHelper.arrayBufferToString(new Uint8Array(content, 0, 4));
+    if (magic === BINARY_HEADER_MAGIC) {
+      const {
+        json,
+        buffers
+      } = parseGLB(content);
+      vtkDebugMacro('Loaded GLB', json, buffers);
+      glTF.glbBuffers = buffers;
+      glTF.json = json;
+    } else {
+      glTF.json = JSON.parse(BinaryHelper.arrayBufferToString(content));
+    }
+    if (glTF.json.asset === undefined || glTF.json.asset.version[0] < 2) {
+      vtkErrorMacro('Unsupported asset. glTF versions >=2.0 are supported.');
+      return;
+    }
+    model.glTFTree = await parseGLTF(glTF, options);
+    model.actors = new Map();
+    model.cameras = new Map();
+    model.lights = new Map();
+    model.animations = [];
+    model.variants = [];
+    model.variantMappings = new Map();
+    await createVTKObjects(model);
+    model.scenes = model.glTFTree.scenes;
+    publicAPI.invokeReady();
+  };
+  publicAPI.parseAsText = content => {
+    if (!content) {
+      return;
+    }
+    if (content !== model.parseData) {
+      publicAPI.modified();
+    } else {
+      return;
+    }
+    model.parseData = content;
+  };
+  publicAPI.requestData = (inData, outData) => {
+    publicAPI.parse(model.parseData);
+  };
+  publicAPI.setDracoDecoder = async dracoDecoder => {
+    await vtkDracoReader.setDracoDecoder(dracoDecoder);
+  };
+  publicAPI.importActors = () => {
+    // Add actors to renderer
+    model.actors.forEach(actor => model.renderer.addActor(actor));
+  };
+  publicAPI.importCameras = () => {
+    // Set up camera
+    model.glTFTree.cameras?.forEach(glTFcamera => {
+      const camera = GLTFCameraToVTKCamera(glTFcamera);
+      model.cameras.set(glTFcamera.id, camera);
+    });
+    model.scenes.forEach(scene => {
+      scene.nodes.forEach(node => {
+        const camera = model.cameras.get(node.camera?.id);
+        if (camera) {
+          applyTransformToCamera(camera, node.transform);
+        }
+      });
+    });
+  };
+  publicAPI.importAnimations = () => {
+    // Set up animations
+    if (model.glTFTree.animations?.length > 0) {
+      model.animationMixer = createAnimationMixer(model.actors, model.glTFTree.accessors);
+      model.glTFTree.animations.forEach(animation => {
+        model.animationMixer.addAnimation(animation);
+      });
+    }
+    model.animations = model.glTFTree.animations || [];
+  };
+  publicAPI.importLights = () => {
+    // Set up lights
+    model.lights?.forEach(light => {
+      vtkDebugMacro('Adding light', light);
+      model.renderer.addLight(light);
+    });
+  };
+  publicAPI.setCamera = cameraId => {
+    const camera = model.cameras.get(cameraId);
+    if (!camera) {
+      vtkErrorMacro(`Camera ${cameraId} not found`);
+      return;
+    }
+    vtkDebugMacro('Setting camera', camera);
+    model.renderer.setActiveCamera(camera);
+  };
+  publicAPI.switchToVariant = async variantIndex => {
+    const promises = Array.from(model.actors).map(async _ref => {
+      let [nodeId, actor] = _ref;
+      vtkDebugMacro('Switching to variant', variantIndex, 'for node', nodeId);
+      const variantMappings = model.variantMappings.get(nodeId);
+      if (variantMappings) {
+        const mapping = variantMappings.find(m => m.variants.includes(variantIndex));
+        if (mapping) {
+          const variantMaterial = model.glTFTree.materials[mapping.material];
+          await createPropertyFromGLTFMaterial(model, variantMaterial, actor);
+        }
+      }
+    });
+    await Promise.all(promises);
+  };
+}
+
+// ----------------------------------------------------------------------------
+// Object factory
+// ----------------------------------------------------------------------------
+
+const DEFAULT_VALUES = {
+  // baseURL: null,
+  // dataAccessHelper: null,
+  // url: null,
+};
+
+// ----------------------------------------------------------------------------
+
+function extend(publicAPI, model) {
+  let initialValues = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+  Object.assign(model, DEFAULT_VALUES, initialValues);
+
+  // Build VTK API
+  macro.obj(publicAPI, model);
+  macro.get(publicAPI, model, ['url', 'baseURL', 'actors', 'scenes', 'cameras', 'animations', 'animationMixer', 'variants', 'variantMappings']);
+  macro.set(publicAPI, model, ['renderer', 'dracoDecoder']);
+  macro.event(publicAPI, model, 'ready');
+
+  // vtkGLTFImporter methods
+  vtkGLTFImporter(publicAPI, model);
+
+  // To support destructuring
+  if (!model.compression) {
+    model.compression = null;
+  }
+  if (!model.progressCallback) {
+    model.progressCallback = null;
+  }
+}
+// ----------------------------------------------------------------------------
+
+const newInstance = macro.newInstance(extend, 'vtkGLTFImporter');
+
+// ----------------------------------------------------------------------------
+
+var vtkGLTFImporter$1 = {
+  extend,
+  newInstance
+};
+
+export { vtkGLTFImporter$1 as default, extend, newInstance };

package/IO/Geometry/IFCImporter.d.ts

@@ -0,0 +1,163 @@
+import { vtkAlgorithm, vtkObject } from './../../interfaces';
+import vtkRenderer from './../../Rendering/Core/Renderer';
+import HtmlDataAccessHelper from './../Core/DataAccessHelper/HtmlDataAccessHelper';
+import HttpDataAccessHelper from './../Core/DataAccessHelper/HttpDataAccessHelper';
+import JSZipDataAccessHelper from './../Core/DataAccessHelper/JSZipDataAccessHelper';
+import LiteHttpDataAccessHelper from './../Core/DataAccessHelper/LiteHttpDataAccessHelper';
+
+interface IIFCImporterOptions {
+  compression?: string;
+  progressCallback?: any;
+}
+
+/**
+ *
+ */
+export interface IIFCImporterInitialValues {
+  mergeGeometries?: boolean;
+}
+
+type vtkIFCImporterBase = vtkObject &
+  Omit<
+    vtkAlgorithm,
+    | 'getInputData'
+    | 'setInputData'
+    | 'setInputConnection'
+    | 'getInputConnection'
+    | 'addInputConnection'
+    | 'addInputData'
+  >;
+
+export interface vtkIFCImporter extends vtkIFCImporterBase {
+  /**
+   *
+   */
+  getBaseURL(): string;
+
+  /**
+   *
+   */
+  getDataAccessHelper():
+    | HtmlDataAccessHelper
+    | HttpDataAccessHelper
+    | JSZipDataAccessHelper
+    | LiteHttpDataAccessHelper;
+
+  /**
+   * Get the url of the object to load.
+   */
+  getUrl(): string;
+
+  /**
+   * Import actors into the renderer.
+   * @param {vtkRenderer} renderer The vtkRenderer to import the actors into.
+   */
+  importActors(renderer: vtkRenderer): void;
+
+  /**
+   * Load the object data.
+   * @param {IIFCImporterOptions} [options]
+   */
+  loadData(options?: IIFCImporterOptions): Promise<any>;
+
+  /**
+   * Parse data.
+   * @param {String | ArrayBuffer} content The content to parse.
+   */
+  parse(content: string | ArrayBuffer): void;
+
+  /**
+   * Parse data as ArrayBuffer.
+   * @param {ArrayBuffer} content The content to parse.
+   */
+  parseAsArrayBuffer(content: ArrayBuffer): void;
+
+  /**
+   *
+   * @param inData
+   * @param outData
+   */
+  requestData(inData: any, outData: any): void;
+
+  /**
+   *
+   * @param dataAccessHelper
+   */
+  setDataAccessHelper(
+    dataAccessHelper:
+      | HtmlDataAccessHelper
+      | HttpDataAccessHelper
+      | JSZipDataAccessHelper
+      | LiteHttpDataAccessHelper
+  ): boolean;
+
+  /**
+   * Set the url of the object to load.
+   * @param {String} url the url of the object to load.
+   * @param {IIFCImporterOptions} [option] The PLY reader options.
+   */
+  setUrl(url: string, option?: IIFCImporterOptions): Promise<string | any>;
+}
+
+/**
+ * Set WebIFC api to be used by vtkIFCImporter
+ * @param {object} ifcApi
+ */
+export function setIFCAPI(ifcApi: any): void;
+
+/**
+ * Method used to decorate a given object (publicAPI+model) with vtkIFCImporter characteristics.
+ *
+ * @param publicAPI object on which methods will be bounds (public)
+ * @param model object on which data structure will be bounds (protected)
+ * @param {IIFCImporterInitialValues} [initialValues] (default: {})
+ */
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IIFCImporterInitialValues
+): void;
+
+/**
+ * Method used to create a new instance of vtkIFCImporter
+ * @param {IIFCImporterInitialValues} [initialValues] for pre-setting some of its content
+ */
+export function newInstance(
+  initialValues?: IIFCImporterInitialValues
+): vtkIFCImporter;
+
+/**
+ * vtkIFCImporter is a source object that reads Industry Foundation Class(IFC) files.
+ *
+ * The vtkIFCImporter is using web-ifc library to parse the IFC file.
+ *
+ * @example
+ * ```js
+ * import vtkResourceLoader from '@kitware/vtk.js/IO/Core/ResourceLoader';
+ * import vtkIFCImporter from '@kitware/vtk.js/IO/Geometry/IFCImporter';
+ *
+ * function update() {
+ *   importer.onReady(() => {
+ *     importer.importActors(renderer);
+ *     renderer.resetCamera();
+ *     renderWindow.render();
+ *   });
+ * }
+ *
+ * vtkResourceLoader
+ * .loadScript('https://cdn.jsdelivr.net/npm/web-ifc@0.0.55/web-ifc-api-iife.js')
+ * .then(() => {
+ *   // Pass WebIFC api to vtkIFCImporter
+ *   vtkIFCImporter.setIFCAPI(window.WebIFC);
+ *
+ *   // Trigger data download
+ *   importer.setUrl(`${__BASE_PATH__}/data/ifc/house.ifc`).then(update);
+ * });
+ * ```
+ */
+export declare const vtkIFCImporter: {
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+  setIFCAPI: typeof setIFCAPI;
+};
+export default vtkIFCImporter;