|
| 1 | +import { vtkAlgorithm, vtkObject } from '../../../interfaces'; |
| 2 | +import vtkRenderer from '../../../Rendering/Core/Renderer'; |
| 3 | +import HtmlDataAccessHelper from '../../Core/DataAccessHelper/HtmlDataAccessHelper'; |
| 4 | +import HttpDataAccessHelper from '../../Core/DataAccessHelper/HttpDataAccessHelper'; |
| 5 | +import JSZipDataAccessHelper from '../../Core/DataAccessHelper/JSZipDataAccessHelper'; |
| 6 | +import LiteHttpDataAccessHelper from '../../Core/DataAccessHelper/LiteHttpDataAccessHelper'; |
| 7 | + |
| 8 | +interface IIFCImporterOptions { |
| 9 | + compression?: string; |
| 10 | + progressCallback?: any; |
| 11 | +} |
| 12 | + |
| 13 | +/** |
| 14 | + * |
| 15 | + */ |
| 16 | +export interface IIFCImporterInitialValues { |
| 17 | + mergeGeometries?: boolean; |
| 18 | +} |
| 19 | + |
| 20 | +type vtkIFCImporterBase = vtkObject & |
| 21 | + Omit< |
| 22 | + vtkAlgorithm, |
| 23 | + | 'getInputData' |
| 24 | + | 'setInputData' |
| 25 | + | 'setInputConnection' |
| 26 | + | 'getInputConnection' |
| 27 | + | 'addInputConnection' |
| 28 | + | 'addInputData' |
| 29 | + >; |
| 30 | + |
| 31 | +export interface vtkIFCImporter extends vtkIFCImporterBase { |
| 32 | + /** |
| 33 | + * |
| 34 | + */ |
| 35 | + getBaseURL(): string; |
| 36 | + |
| 37 | + /** |
| 38 | + * |
| 39 | + */ |
| 40 | + getDataAccessHelper(): |
| 41 | + | HtmlDataAccessHelper |
| 42 | + | HttpDataAccessHelper |
| 43 | + | JSZipDataAccessHelper |
| 44 | + | LiteHttpDataAccessHelper; |
| 45 | + |
| 46 | + /** |
| 47 | + * Get the url of the object to load. |
| 48 | + */ |
| 49 | + getUrl(): string; |
| 50 | + |
| 51 | + /** |
| 52 | + * Import actors into the renderer. |
| 53 | + * @param {vtkRenderer} renderer The vtkRenderer to import the actors into. |
| 54 | + */ |
| 55 | + importActors(renderer: vtkRenderer): void; |
| 56 | + |
| 57 | + /** |
| 58 | + * Load the object data. |
| 59 | + * @param {IIFCImporterOptions} [options] |
| 60 | + */ |
| 61 | + loadData(options?: IIFCImporterOptions): Promise<any>; |
| 62 | + |
| 63 | + /** |
| 64 | + * Parse data. |
| 65 | + * @param {String | ArrayBuffer} content The content to parse. |
| 66 | + */ |
| 67 | + parse(content: string | ArrayBuffer): void; |
| 68 | + |
| 69 | + /** |
| 70 | + * Parse data as ArrayBuffer. |
| 71 | + * @param {ArrayBuffer} content The content to parse. |
| 72 | + */ |
| 73 | + parseAsArrayBuffer(content: ArrayBuffer): void; |
| 74 | + |
| 75 | + /** |
| 76 | + * |
| 77 | + * @param inData |
| 78 | + * @param outData |
| 79 | + */ |
| 80 | + requestData(inData: any, outData: any): void; |
| 81 | + |
| 82 | + /** |
| 83 | + * |
| 84 | + * @param dataAccessHelper |
| 85 | + */ |
| 86 | + setDataAccessHelper( |
| 87 | + dataAccessHelper: |
| 88 | + | HtmlDataAccessHelper |
| 89 | + | HttpDataAccessHelper |
| 90 | + | JSZipDataAccessHelper |
| 91 | + | LiteHttpDataAccessHelper |
| 92 | + ): boolean; |
| 93 | + |
| 94 | + /** |
| 95 | + * Set the url of the object to load. |
| 96 | + * @param {String} url the url of the object to load. |
| 97 | + * @param {IIFCImporterOptions} [option] The PLY reader options. |
| 98 | + */ |
| 99 | + setUrl(url: string, option?: IIFCImporterOptions): Promise<string | any>; |
| 100 | +} |
| 101 | + |
| 102 | +/** |
| 103 | + * Set WebIFC api to be used by vtkIFCImporter |
| 104 | + * @param {object} ifcApi |
| 105 | + */ |
| 106 | +export function setIFCAPI(ifcApi: any): void; |
| 107 | + |
| 108 | +/** |
| 109 | + * Method used to decorate a given object (publicAPI+model) with vtkIFCImporter characteristics. |
| 110 | + * |
| 111 | + * @param publicAPI object on which methods will be bounds (public) |
| 112 | + * @param model object on which data structure will be bounds (protected) |
| 113 | + * @param {IIFCImporterInitialValues} [initialValues] (default: {}) |
| 114 | + */ |
| 115 | +export function extend( |
| 116 | + publicAPI: object, |
| 117 | + model: object, |
| 118 | + initialValues?: IIFCImporterInitialValues |
| 119 | +): void; |
| 120 | + |
| 121 | +/** |
| 122 | + * Method used to create a new instance of vtkIFCImporter |
| 123 | + * @param {IIFCImporterInitialValues} [initialValues] for pre-setting some of its content |
| 124 | + */ |
| 125 | +export function newInstance( |
| 126 | + initialValues?: IIFCImporterInitialValues |
| 127 | +): vtkIFCImporter; |
| 128 | + |
| 129 | +/** |
| 130 | + * vtkIFCImporter is a source object that reads Industry Foundation Class(IFC) files. |
| 131 | + * |
| 132 | + * The vtkIFCImporter is using web-ifc library to parse the IFC file. |
| 133 | + * |
| 134 | + * @example |
| 135 | + * ```js |
| 136 | + * import vtkResourceLoader from '@kitware/vtk.js/IO/Core/ResourceLoader'; |
| 137 | + * import vtkIFCImporter from '@kitware/vtk.js/IO/Geometry/IFCImporter'; |
| 138 | + * |
| 139 | + * function update() { |
| 140 | + * importer.onReady(() => { |
| 141 | + * importer.importActors(renderer); |
| 142 | + * renderer.resetCamera(); |
| 143 | + * renderWindow.render(); |
| 144 | + * }); |
| 145 | + * } |
| 146 | + * |
| 147 | + * vtkResourceLoader |
| 148 | + * .loadScript('https://cdn.jsdelivr.net/npm/[email protected]/web-ifc-api-iife.js') |
| 149 | + * .then(() => { |
| 150 | + * // Pass WebIFC api to vtkIFCImporter |
| 151 | + * vtkIFCImporter.setIFCAPI(window.WebIFC); |
| 152 | + * |
| 153 | + * // Trigger data download |
| 154 | + * importer.setUrl(`${__BASE_PATH__}/data/ifc/house.ifc`).then(update); |
| 155 | + * }); |
| 156 | + * ``` |
| 157 | + */ |
| 158 | +export declare const vtkIFCImporter: { |
| 159 | + newInstance: typeof newInstance; |
| 160 | + extend: typeof extend; |
| 161 | + setIFCAPI: typeof setIFCAPI; |
| 162 | +}; |
| 163 | +export default vtkIFCImporter; |
0 commit comments