opt-rapid3d-loader
v1.0.2
Published
High-performance BIM & CAD model loader — load 10GB+ models in seconds.
Maintainers
Readme
Welcome to Rapid3D Loader for Three.js
High-performance BIM & CAD model loader — load 10GB+ models in seconds.
I. Components of the Rapid3D Product Pipeline
The Rapid3D product line consists of two parts — the Converter "produces" web-optimized models, and the Loader "consumes" them:
Rapid3D Converter
A local 3D/BIM model conversion and lightweighting product. All processing runs on your own machines — your data never leaves your network.
Two deployment options:
- Desktop App (Free) — A Windows desktop application for drag-and-drop conversion.
- Supports all formats, with a single limitation: input model size ≤ 100 MB can be exported in lightweighting file(.opt).
- Permanent and free — no time limit, no conversion count limit, no registration required.
- Ideal for evaluation, learning, and small projects.
- Standalone Conversion Service (Licensed) — A self-hosted conversion service with built-in license management and a web-based admin console, exposing a RESTful API for integration into your own applications and pipelines.
Pricing (Standalone Conversion Service):
- Machine-based license (per workstation / per server deployment), unlimited conversions — no metering, no phone-home, fully offline license validation.
- Annual subscription, tiered by format coverage:
- AEC Standard ($2,800/year) — Revit (.rvt/.rfa), Sketchup(.skp)+ all open formats (IFC, FBX,STEP/STP,IGES,DAE,STL,3DXML,DXF)
- AEC Complete ($4,500/year) — Everything in AEC Standard + Bentley (.dgn), Tekla, Navisworks (.nwd/.nwc, including SP3D and PDMS model opening and data extraction)
- Universal ($5,500/year) — Everything in AEC Complete + SolidWorks and Inventor, for manufacturing and cross-discipline engineering
- Volume discounts available for multi-machine deployments. 30-day money-back guarantee.
Rapid3D Loader for Three.js (npm package)
- Responsible for "consuming" the converted
.optgeometry files — achieving high-performance 3D/BIM model loading and rendering on the web under the Three.js framework. - Free to download, use, and distribute — for learning, evaluation, and commercial projects.
The "reader" is free; only the "writer" (Converter service) is licensed.
II. Advantages of Rapid3D Loader for Three.js
Compared to native Three.js, Rapid3D Loader offers the following advantages:
1. Multiple 3D/BIM Model Formats via 6 Dedicated Export Plugins — No Geometry or Data Loss
To completely solve the industry problem of "3D model components or attribute loss" caused by other ODA-based solutions, we developed dedicated export plugins that extract data via each CAD vendor's official API: Revit, Bentley, Tekla, Navisworks, SolidWorks, and Inventor. The Navisworks plugin also opens SP3D and PDMS models and extracts their data.
- No Data Loss: Not only geometry, but also materials, textures, hierarchical structures, and key 3D/BIM structural attribute data are extracted without loss.
- Broad Open-Format Support: Direct support for mainstream open formats including SKP, IFC, FBX, STEP/STP, IGES, DAE, STL, 3DXML, DXF and RVM.
- Industry Coverage: From architectural design and construction to infrastructure, EPC, plant and petrochemical engineering — a complete "key" for every BIM workflow.
2. Ultra-Optimized 3D/BIM Model Lightweighting Technology
To achieve high-performance web rendering, the conversion stage comprehensively applies multiple technical solutions:
- High-performance floating-point compression.
- Scene component instantiation / parameterization compression.
- Automatic face reduction and redundant data removal while maintaining geometric precision.
- Model material merging and texture compression.
- LOD multi-level data construction with automatic coarse/fine model generation.
- High-performance Draco compression.
3. Over 3x Faster 3D/BIM Model Loading Than Native
Rapid3D Loader is optimized at the underlying graphics level — a complete reconstruction of the rendering pipeline, not just code-level streamlining:
- Multi-Worker Download Queue: Parallel downloading and decoding across workers, significantly reducing the time for 3D models to travel from server to local web browser.
- Chunk Rendering: Breaking vast scene graphs down into manageable rendering units, greatly reducing Draw Call overhead.
- Instanced Rendering: Pushing the rendering efficiency of repeated components (doors, windows, bolts, panels) to the limit.
- Frustum Culling + Dynamic Culling: The browser no longer wastes even a single pixel rendering objects outside the field of view — hidden and occluded objects are dynamically skipped.
- On-Demand Rendering & Draw Caching: When the scene is static, rendering work nearly stops; cached draw results are reused instead of recomputed — squeezing every drop of performance out of the GPU.
- Distance-Based LOD Strategy: For ultra-large models at the 10 GB level, hierarchical loading is combined with coarse/fine model replacement. The system intelligently judges camera distance, dynamically scheduling loading and precision swapping — campus-scale roaming and screw-level inspection both stay silky smooth.
4. One-to-One Correspondence Between Geometry and Attribute Data
During lightweighting conversion, all professional structures and attribute data (component IDs, hierarchical relationships, professional attributes) are extracted intact and stored in a .db model data file on the user's device.
- The complete table structure and field descriptions of the DB file are fully disclosed — no data lock-in.
- Developers obtain component IDs through Rapid3D Loader's basic interfaces, then retrieve the corresponding structural attribute data from the DB file by component ID.
5. Freely Expandable Development with Seamless Three.js Integration
Rapid3D Loader provides a deliberately minimal set of 7 simple APIs — component picking, coloring, transparency control, show/hide, displacement, rotation, outline highlighting — all commonly used interactive functions, encapsulated for developers to call directly. A small API surface means half a day to productivity, and every API boundary is clearly documented.
Installation
Install using npm:
npm install opt-rapid3d-loaderQuick Start
import { Scene, WebGLRenderer, PerspectiveCamera, AmbientLight, DirectionalLight, Color, Vector2, Vector3 } from 'three';
import OptRapid3dLoader from 'opt-rapid3d-loader';
const scene = new Scene();
scene.background = new Color(0x87CEFA);
const renderer = new WebGLRenderer({ antialias: true, logarithmicDepthBuffer: true });
renderer.setSize(window.innerWidth, window.innerHeight);
document.getElementById("container").appendChild(renderer.domElement);
const camera = new PerspectiveCamera(60, window.innerWidth / window.innerHeight, 0.1, 1000);
camera.position.set(0, 100, 150);
camera.lookAt(0, 0, 0);
const ambientLight = new AmbientLight(0xffffff, 2.0);
scene.add(ambientLight);
const mainLight = new DirectionalLight(0xffffff, 1.0);
mainLight.position.set(5, 10, 7);
scene.add(mainLight);
const loader = new OptRapid3dLoader({
renderer: renderer,
camera: camera,
parent: scene,
libs: './libs', // Directory path corresponding to your three version's libs directory, plugin depends on draco and basis parsers in libs directory
url: "http://192.168.1.200/bim/house_opt/root.opt",
callback: () => {
console.log("Loading completed!");
}
});
function animate() {
requestAnimationFrame(animate);
loader.interface.update(); // Update function needs to be triggered for each loader instance here
renderer.render(scene, camera);
}
animate();API Documentation
Constructor new OptRapid3dLoader(options)
Creates an OptRapid3dLoader instance.
| Parameter | Type | Description |
| :--- | :--- | :--- |
| renderer | WebGLRenderer | Three.js renderer instance |
| camera | Camera | Three.js camera |
| parent | Scene/Group | Three.js container |
| libs | String | Decoder file directory path. If not provided, will default to public CDN: https://unpkg.com/[email protected]/examples/jsm/libs |
| url | String | Path to opt data format exported using dedicated export plugin |
| callback | Function | Model loading completion callback function |
Interaction Interface
OptRapid3dLoader provides a powerful interface object for interacting with and controlling specific components in the model. All operations are asynchronous, please use with await.
Component Picking
Pick component information in the scene through screen coordinates.
const json = await loader.interface.pick({ position: new Vector2(x, y) });- position (
Vector2): Screen pixel coordinates, typically corresponding to mouse click event'sclientXandclientY. - Return:
Promise<Object | null>, containing component ID and other information.
Set Color
Modify the color of specified components.
await loader.interface.setColor({ featureIds: json.id, type: 0, color: "rgb(255, 255, 0)" });- featureIds (
String): Target component ID, supports batch operations (e.g.,1111#2222). - type (
Number): Coloring type,0is mixing,1is replacement. - color (
String): CSS format color value.
Set Visibility
Control component display or hide state.
await loader.interface.setVisible({ featureIds: json.id, visible: false });- visible (
Boolean):truefor show,falsefor hide.
Set Alpha
Adjust component transparency and color.
await loader.interface.setAlpha({ featureIds: json.id, color: "rgb(255, 0, 0)", alpha: 0.3 });- alpha (
Number): Transparency value, range 0.0 to 1.0.
Component Offset
Translate component position.
await loader.interface.offset({ featureIds: json.id, x: 10, y: 10, z: 0 });Clear Offset
Reset component position offset, restore original position.
await loader.interface.clearOffset({ featureIds: json.id });Component Rotation
Apply rotation transformation to component.
await loader.interface.rotate({ featureIds: json.id, angle: 30 });- angle (
Number): Rotation angle.
Clear Rotation
Reset component rotation state, restore original angle.
await loader.interface.clearRotate({ featureIds: json.id });Component Zoom To
Automatically adjust camera view to focus on specified component.
await loader.interface.zoomTo({ featureIds: json.id });Other Methods
loader.interface.update();// Loader updateloader.interface.dispose();// Loader disposal
Border Effect
Set the border effect of the model.
await loader.interface.setEdge({ edgeColor: 0x333030, edgeUseFatLines: true });- isShow (
Boolean):truefor show,falsefor hide. - edgeColor (
String): Set the color of the border line. - edgeUseFatLines (
Boolean):trueTo use the three Line2 object, the current three version must support the Line2 object,falseDo not use the Line2 object. - edgeLineWidth (
Number): Border line width. Note: It will only take effect when "edgeUseFatLines" is set to true.
Try Now
Please visit: https://www.opt3ds.com/
Download: Rapid3D Converter — Desktop App (Windows 64-bit) — free, all formats supported, input models up to 100 MB.
Rapid3D Loader for Three.js End User License Agreement (EULA)
This End User License Agreement ("Agreement") is a legal agreement between you (either an individual or a single entity) and 3DExpert Co.,Ltd. ("3DExpert", "we", "us", or "our") regarding your use of the Rapid3D Loader for Three.js software, including the JavaScript library ("Loader JS Package"), the Rapid3D Converter Desktop App, and the Rapid3D Converter Standalone Conversion Service (collectively, the "Software"), and any associated documentation, updates, or services. By installing, copying, accessing, or otherwise using the Software, you agree to be bound by the terms of this Agreement. If you do not agree to the terms of this Agreement, do not install or use the Software.
Grant of License
Subject to your compliance with this Agreement and, where applicable, payment of the applicable license fees, we grant you a non-exclusive, worldwide license to:
Use the Rapid3D Converter Desktop App free of charge for the purpose of processing and lightweighting 3D/BIM models on your local device. The Desktop App is provided free of charge on a permanent basis, with a single limitation: each input model may not exceed 100 MB in size. There is no time limit and no conversion count limit.
Use the Rapid3D Converter Standalone Conversion Service (including its RESTful API and web-based admin console) solely for the purpose of processing and lightweighting 3D/BIM models on machines covered by a valid license. The Standalone Conversion Service is licensed per machine (workstation or server) deployment, on an annual subscription basis, in accordance with our pricing policy at the time of purchase. A valid license entitles you to unlimited conversions — no usage metering is performed, no usage data is transmitted to us, and license validation operates fully offline. Format coverage (open formats, Revit, Bentley, Tekla, Navisworks, SolidWorks, Inventor) depends on the license tier purchased.
Use the Loader JS Package free of charge to render the lightweighted 3D/BIM models processed by the Rapid3D Converter Desktop App or Standalone Conversion Service within web applications built on the Three.js framework (.opt files), for learning, evaluation, and commercial purposes.
Distribute the Loader JS Package freely as part of your own web applications or products, including for commercial use, provided that you may, at your option, retain or exclude all copyright notices.
Ownership and Intellectual Property
The Software, including its code, structure, organization, and documentation, is the proprietary property of 3DExpert and is protected by copyright laws and international treaty provisions. All rights not expressly granted herein are reserved by 3DExpert. The Three.js framework is a third-party open-source library; your use of Three.js is governed by its own license terms, which are independent of this Agreement.
Data and Privacy
Rapid3D Loader for Three.js is designed to operate in a client-side, fully local environment. The Software does not collect, transmit, or store any user data, model files, usage statistics, or personally identifiable information on our servers. All model processing and rendering occur locally on the user's device or the user's own server infrastructure. License validation for the Standalone Conversion Service is performed offline and does not require or initiate any network connection to 3DExpert. By using the Software, you acknowledge that you are solely responsible for the data processed through the Software and for complying with applicable data protection laws (including but not limited to GDPR, CCPA, and other regional regulations) in your jurisdiction.
Limitation of Liability
TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, 3DEXPERT PROVIDES THE SOFTWARE "AS IS" AND "AS AVAILABLE" WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. 3DEXPERT DOES NOT WARRANT THAT THE SOFTWARE WILL BE UNINTERRUPTED, ERROR-FREE, OR SECURE, OR THAT DEFECTS WILL BE CORRECTED. YOU ASSUME ALL RISKS ASSOCIATED WITH THE USE OF THE SOFTWARE. IN NO EVENT SHALL 3DEXPERT BE LIABLE FOR ANY INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL, OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO LOSS OF PROFITS, DATA, OR BUSINESS INTERRUPTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THE SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. OUR TOTAL LIABILITY TO YOU FOR ALL CLAIMS ARISING UNDER THIS AGREEMENT SHALL NOT EXCEED THE TOTAL LICENSE FEES ACTUALLY PAID BY YOU FOR THE RAPID3D CONVERTER STANDALONE CONVERSION SERVICE IN THE TWELVE (12) MONTHS PRECEDING THE CLAIM. WHERE NO SUCH FEES HAVE BEEN PAID, OUR TOTAL LIABILITY SHALL NOT EXCEED FIFTY U.S. DOLLARS (USD $50).
Termination
This Agreement is effective until terminated. Your rights under this Agreement will terminate automatically without notice from us if you fail to comply with any term of this Agreement. Upon termination, you must cease all use of the Software and destroy all copies, full or partial, of the Software in your possession or control.
Governing Law and Jurisdiction
This Agreement shall be governed by and construed in accordance with the laws of Japan, without regard to its conflict of laws principles. Any legal action or proceeding arising under this Agreement will be brought exclusively in the courts located in Osaka, Japan, and the parties hereby consent to personal jurisdiction and venue therein.
Export Control
You acknowledge that the Software may be subject to export control laws and regulations of Japan and other jurisdictions. You agree to comply with all applicable export and re-export restrictions, including but not limited to those administered by the Japanese Ministry of Economy, Trade and Industry (METI).
Miscellaneous
This Agreement constitutes the entire agreement between you and 3DExpert regarding the subject matter hereof and supersedes all prior or contemporaneous agreements, representations, warranties, and understandings, whether written or oral. If any provision of this Agreement is held to be invalid or unenforceable, the remaining provisions shall remain in full force and effect. We may update this Agreement from time to time; your continued use of the Software after such updates constitutes acceptance of the revised terms. By using the Software, you represent and warrant that you have the authority to enter into this Agreement and that you are at least 18 years of age.
