vim-webgl-viewer
Advanced tools
A high-performance 3D viewer and VIM file loader built on top of Three.JS.
The VIM Three.JS 3D Viewer is an open-source and easy to configure and use 3D model viewer built as a thin wrapper on top of the popular Three.JS WebGL framework. It is enhanced with a loader for the VIM format which is specialized in the transfer of large AEC data.
The VIM Three.JS 3D viewer combines the Three.JS library with several common loaders and utilities, to reduce boilerplate code. It can be simply included via script tags or consumed using esm imports.
Checkout repo
Run npm install to install all dependencies
Run npm run dev to launch a dev-server and watching for changes
Run npm run build to compile and bundle everything for publishing. Resulting files end up in ./dist
Navigate to http://localhost:3000 in your browser
Virtually the simplest usage of the VIM viewer is the following example:
<html>
<head>
<title>VIM Viewer</title>
</head>
<body>
<script src="https://unpkg.com/three@0.133.1/build/three.min.js"></script>
<script src="./vim-webgl-viewer.iife.js"></script>
<script>
var viewer = new vim.Viewer();
viewer.view({
url: 'https://vim.azureedge.net/samples/residence.vim',
object: {
rotation: { x: 270 },
},
plane: {
show: false
},
showStats: true
});
</script>
</body>
</html>
If you want to use esm imports, you do it as follows:
// This will work if you use a bundler and installed the viewer via npm
import { Viewer } from 'vim-webgl-viewer'
// That will work if you use the bundled file directly
// However, you still need to have threejs installed via npm and use a bundler
import { Viewer } from './dist/vim-webgl-viewer.es.js'
const viewer = new Viewer();
viewer.view({
url: './residence.vim',
object: {
scale: 0.1,
rotation: { x: 270 },
position: { y: 0 }
},
plane: {
show: false
},
showStats: true
});
TBD
The distributable file vim-webgl-viewer.iife.js does not contain the underlying source for Three.JS to avoid duplication. Please include Three.JS on your own. However, it comes bundled with:
vim-webgl-viewer.js source file which encapsulates common Three JS boiler plateThe viewer is broadly divided into three layer.
Meshes: The scene is rendered using a collection of InstancedMesh, specific object are refered by a (Mesh, instanceIndex) pair.
Nodes: The vim scene is a collection of nodes with a transform and a geometry, each node will result in zero or one object added to Three to be rendered. Nodes are refered by Index.
Elements: objects from the original the bim software containing rich data. Each element can have from 0 to N nodes associated with it. Elements are refered to by Id or Index.
Exemple:
A table from Revit has elementId 12321
it gets exported into 5 nodes, 4 legs and a table top.
the 5 nodes are rendered using 2 meshes, one for the table top, one for all 4 legs.
FAQs
A high-performance 3D viewer and VIM file loader built on top of Three.JS.
The npm package vim-webgl-viewer receives a total of 126 weekly downloads. As such, vim-webgl-viewer popularity was classified as not popular.
We found that vim-webgl-viewer demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.