Skip to content

Commit

Permalink
Add examples and enhance README for BlenderProc visualization
Browse files Browse the repository at this point in the history
- Added example images for mesh, point cloud, and depth rendering.
- Updated README with installation instructions and usage examples.
- Improved formatting with tables for better clarity.
  • Loading branch information
Matthias Humt committed Dec 6, 2024
1 parent f7afbcf commit 06200d3
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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 |
|---------------------------------|-----------------------------------------------------|-------------------------------------------------------|
| <img src="examples/mesh.png" alt="mesh" width="200"/> | <img src="examples/pcd.png" alt="pcd" width="200"/> | <img src="examples/mesh.png" alt="mesh" width="200"/> |
| `--obj_path suzanne` | `--mesh_as_pcd` | `--depth` |

## Credits

| [**BlenderProc 2**](https://github.com/DLR-RM/BlenderProc) | [**Blender**](https://www.blender.org) |
|------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------|
| <img src="https://user-images.githubusercontent.com/6104887/137109535-275a2aa3-f5fd-4173-9d16-a9a9b86f66e7.gif" alt="blenderproc" width="512"> | <img src="https://download.blender.org/branding/blender_logo_socket.png" alt="blender" width="512"> | |
Binary file added examples/mesh.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added examples/pcd.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 06200d3

Please sign in to comment.