threejs-model-loader
Advanced tools
Changelog
[0.0.2] - 2018-06-22
redraw() function to the viewer elementauto-redraw attribute to the viewer elementReadme
THREE.js Model Loader for delegating to the appropriate geometry loader. Uses the file's extension to determine which THREE geometry loader to use.
var loader = new THREE.ModelLoader();
// overriding the getLoader function so loaders can be
// loaded as-needed
loader.getLoader = function( loaderName, manager, loadercb ) {
function createLoader() {
return new THREE[ loaderName ]( manager );
}
if ( THREE[ loaderName ] == null ) {
// fetch the loader script from the server and run it
// if it's not already on the page
fetch(`.../node_modules/three/examples/js/loaders/${ loaderName }.js`)
.then(res => res.text())
.then(tex => {
eval( text );
loadercb( createLoader() );
});
} else {
loadercb( createLoader() );
}
}
loader.load( '.../model.ply', res => {
// res.model
// res.originalResult
// res.extension
} );
A function signature that mirrors all the THREE.js geometry loaders. An appriopriate loader is selected based on the file name.
If extOverride is set, then that extension is used to select the loader.
onLoad is passed an object with values
{
model, // THREE.js Object3D, Group, or Mesh that was loaded
extension, // The extension of the model that was loaded
originalResult // The original result that the loader returned
}
Takes the data to parse into geometry and the associated file extension in ext.
The model is returned asynchronously in onLoad to support async fetching of the loaders.
See load for documentation on what the onLoad function is passed.
Function used to return an instance of a particular loader. Once the loader has been created, pass it into loadercb. See above code snippet for an example.
List of extension to loaderName, used to select the loader for each extension. The list can be modified by adding and removing keys from the list. Every loader is expected to be found on the THREE object.
loader.loadMap[ 'obj' ] = 'OBJLoader';
delete loader.loadMap[ 'stl' ];
<!-- Register the Element -->
<script href=".../model-viewer-element.js" />
<script>customElements.define('model-viewer', ModelViewer)</script>
<body>
<model-viewer src=".../path/to/model.ply" display-shadow ambient-color="red"></model-viewer>
</body>
The url of the model to display.
Whether or not the render the shadow under the robot.
The color of the ambient light specified with css colors.
Show a grid underneath the model.
Automatically redraw the model every frame instead of waiting to be dirtied.
Dirty the renderer so the element will redraw next frame.
Fires when a model is going to load.
Fires when all the geometry has been fully loaded.
Fires when there's a problem loading the model.
Install Node.js and NPM.
Run npm install.
Run npm run server.
Visit localhost:9080/example/ to view the page.
FAQs
THREE.js Model Loader that delegates to the appropriate geometry loader
The npm package threejs-model-loader receives a total of 15 weekly downloads. As such, threejs-model-loader popularity was classified as not popular.
We found that threejs-model-loader demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer 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.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).