diff --git a/README.md b/README.md index 1e8af72..b1898de 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ # BlenderProc Publication Visualization Publication-ready visualization of 3D objects and point clouds in seconds. -_Head over to the repository's [**GitHub** pages site](https://hummat.com/bproc-pubvis) for a prettier and more +| Mesh | Point Cloud | Mesh + Depth | +|---------------------------------|-------------------------------|----------------------------------------| +| ![mesh](examples/mesh_0000.png) | ![pcd](examples/pcd_0000.png) | ![mesh_depth](examples/mesh_depth.png) | + +_Head over to the repository's [**GitHub** Pages site](https://hummat.com/bproc-pubvis) for a prettier and more interactive version of this README!_ ## Installation @@ -14,3 +18,27 @@ blenderproc pip install fire loguru ```bash blenderproc run main.py --obj_path /path/to/3d.obj --save /path/to/output.png ``` + +## Examples + +To render a mesh, simply run: +```bash +blenderproc run main.py --obj_path path/to/mesh.obj +``` +The following options can be added to: +* **save** the rendered image: `--save path/to/output.png` +* **export** the object: `--export path/to/output.obj` (use `.glb` to get web-friendly format) +* Render the mesh as **point cloud**: `--pcd` +* Render the mesh as **depth** image: `--depth` +* Render the mesh as **point cloud** from projected **depth** image: `--pcd --depth` + +| Mesh | Point cloud | Mesh + Depth | +|---------------------------------|-----------------------------------------------------|-------------------------------------------------------| +| mesh | pcd | mesh | +| `--obj_path suzanne` | `--mesh_as_pcd` | `--depth` | + +## Credits + +| [**BlenderProc 2**](https://github.com/DLR-RM/BlenderProc) | [**Blender**](https://www.blender.org) | +|------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| +| blenderproc | blender | | \ No newline at end of file diff --git a/examples/mesh.png b/examples/mesh.png new file mode 100644 index 0000000..c7c39ce Binary files /dev/null and b/examples/mesh.png differ diff --git a/examples/pcd.png b/examples/pcd.png new file mode 100644 index 0000000..6bfa811 Binary files /dev/null and b/examples/pcd.png differ