Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RobotWebTools/ros3djs
3D Visualization Library for use with the ROS JavaScript Libraries
https://github.com/RobotWebTools/ros3djs
Last synced: about 1 month ago
JSON representation
3D Visualization Library for use with the ROS JavaScript Libraries
- Host: GitHub
- URL: https://github.com/RobotWebTools/ros3djs
- Owner: RobotWebTools
- License: other
- Created: 2013-03-15T00:52:55.000Z (almost 12 years ago)
- Default Branch: develop
- Last Pushed: 2024-11-05T10:26:01.000Z (about 2 months ago)
- Last Synced: 2024-11-10T08:04:47.198Z (about 1 month ago)
- Language: JavaScript
- Homepage: https://robotwebtools.github.io/ros3djs
- Size: 11.1 MB
- Stars: 368
- Watchers: 32
- Forks: 216
- Open Issues: 81
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Authors: AUTHORS.md
Awesome Lists containing this project
- awesome-robotic-tooling - ros3djs - 3D Visualization Library for use with the ROS JavaScript Libraries. (Data Visualization and Mission Control / Command Line Interface)
README
# ros3djs
[](https://github.com/RobotWebTools/ros3djs/actions/workflows/main.yml)
#### 3D Visualization Library for use with the ROS JavaScript Libraries
For full documentation, see [the ROS wiki](http://ros.org/wiki/ros3djs) or check out some [working demos](https://robotwebtools.github.io/demos.html).
[JSDoc](https://robotwebtools.github.io/ros3djs) can be found on the Robot Web Tools website.
This project is released as part of the [Robot Web Tools](https://robotwebtools.github.io/) effort.
### Usage
Pre-built files can be found in either [ros3d.js](build/ros3d.js) or [ros3d.min.js](build/ros3d.min.js).
Alternatively, you can use the current release via the [JsDelivr](https://www.jsdelivr.com/) CDN: ([full](https://cdn.jsdelivr.net/npm/ros3d@1/build/ros3d.js)) | ([min](https://cdn.jsdelivr.net/npm/ros3d@1/build/ros3d.min.js))
### Dependencies
ros3djs depends on:
[EventEmitter3](https://github.com/primus/eventemitter3). The current supported version is 5.0. The current supported version can be found on the JsDeliver CDN: ([full](https://cdn.jsdelivr.net/npm/[email protected]/dist/eventemitter3.umd.js)) | ([min](https://cdn.jsdelivr.net/npm/[email protected]/dist/eventemitter3.umd.js))
[three.js](https://github.com/mrdoob/three.js/). The current supported version is r89. The current supported version can be found on the Robot Web Tools CDN: ([full](https://cdn.jsdelivr.net/npm/[email protected]/build/three.js)) | ([min](https://cdn.jsdelivr.net/npm/[email protected]/build/three.min.js))
[THREE.ColladaLoader](https://github.com/mrdoob/three.js/blob/master/examples/js/loaders/ColladaLoader.js). The current supported version is r89. The current supported version can be found on the Robot Web Tools CDN: ~([full](https://static.robotwebtools.org/threejs/r89/ColladaLoader.js))~ This CDN is gone.
[THREE.STLLoader](https://github.com/mrdoob/three.js/blob/master/examples/js/loaders/STLLoader.js). The current supported version is r89. The current supported version can be found on the Robot Web Tools CDN: ~([full](https://static.robotwebtools.org/threejs/r89/STLLoader.js))~ This CDN is gone.
(ROS)ColladaLoader. We support patched version of ColladaLoader to workaround ros-visualization/rviz#1045. This version can be found on the Robot Web Tools CDN: ~([full](https://static.robotwebtools.org/ros3djs/0.18.0/ColladaLoader.js))~ This CDN is gone.
[roslibjs](https://github.com/RobotWebTools/roslibjs). The current supported version is 1.3.0. The current supported version can be found on the JsDeliver CDN: ([full](https://cdn.jsdelivr.net/npm/roslib@1/build/roslib.js)) | ([min](https://cdn.jsdelivr.net/npm/roslib@1/build/roslib.min.js))
### Build
[Grunt](http://gruntjs.com/) is used for building, including concatenating, minimizing, documenting, linting, and testing.
### Install Grunt and its Dependencies
#### Ubuntu 18.04/20.04
1. Install Node.js and its package manager, NPM
* `sudo apt-get install nodejs nodejs-legacy npm` or any other way you like
2. Install Grunt
* `sudo npm install -g grunt-cli`
* (optional) `sudo rm -rf ~/.npm ~/tmp`
3. Install the Grunt tasks specific to this project
* `cd /path/to/ros3djs/`
* `npm install .`
### Build with Grunt
Before proceeding, please confirm you have installed the dependencies above.
To run the build tasks:
1. `cd /path/to/ros3djs/`
2. `grunt build`
`grunt build` will concatenate and minimize the files under src and replace ros3d.js and ros3d.min.js in the build directory. It will also run the linter and test cases. This is what [GitHub Actions](https://github.com/RobotWebTools/ros3djs/actions/workflows/main.yml) runs when a Pull Request is submitted.
`grunt dev` will watch for any changes to any of the src/ files and automatically concatenate and minimize the files. This is ideal for those developing as you should only have to run `grunt dev` once.
`grunt doc` will rebuild all JSDoc for the project.
### Testing
Utilizes [mocha](https://mochajs.org/) and [chai](http://chaijs.com/) for in browser testing.
To run tests simply open `tests/index.html` in a web browser
### Examples
There are a variety of [examples](examples) of the different things that can be done with ros3djs.
There are also some examples of how ros3djs can be used in different environments:
- [Classic html script tag inclusion](examples)
- [Modular html script tag inclusion](examples/html-import)
### License
ros3djs is released with a BSD license. For full terms and conditions, see the [LICENSE](LICENSE) file.
### Authors
See the [AUTHORS.md](AUTHORS.md) file for a full list of contributors.