semantic-scene 0.1.1

Rust parser for semantic scene descriptors, currently focused on Habitat-Sim Matterport3D .house files.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

# semantic-scene

[![GitHub License](https://img.shields.io/github/license/PRO-2684/semantic-scene?logo=opensourceinitiative)](https://github.com/PRO-2684/semantic-scene/blob/main/LICENSE)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/PRO-2684/semantic-scene/release.yml?logo=githubactions)](https://github.com/PRO-2684/semantic-scene/blob/main/.github/workflows/release.yml)
[![GitHub Release](https://img.shields.io/github/v/release/PRO-2684/semantic-scene?logo=githubactions)](https://github.com/PRO-2684/semantic-scene/releases)
[![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/PRO-2684/semantic-scene/total?logo=github)](https://github.com/PRO-2684/semantic-scene/releases)
[![Crates.io Version](https://img.shields.io/crates/v/semantic-scene?logo=rust)](https://crates.io/crates/semantic-scene)
[![Crates.io Total Downloads](https://img.shields.io/crates/d/semantic-scene?logo=rust)](https://crates.io/crates/semantic-scene)
[![docs.rs](https://img.shields.io/docsrs/semantic-scene?logo=rust)](https://docs.rs/semantic-scene)

Rust parser for semantic scene descriptors. Currently supports Habitat-Sim/Matterport3D `.house` files from the [MP3D dataset](https://niessner.github.io/Matterport/#download).

## 💡 Examples

The primary API is dataset-first and Rust-native.

For example, to load a `.house` file:

```rust
use semantic_scene::{Mp3d, Mp3dOptions, SemanticScene};

let scene =
    SemanticScene::load::<Mp3d>("data/17DRP5sb8fy.house", Mp3dOptions::default()).unwrap();
println!("{scene:#}");
```

## 📥 Installation

> The `semantic-scene` CLI tool takes a path to a `.house` file and displays a human-readable summary of the scene.

### Using [`binstall`](https://github.com/cargo-bins/cargo-binstall)

```shell
cargo binstall semantic-scene
```

### Downloading from Releases

Navigate to the [Releases page](https://github.com/PRO-2684/semantic-scene/releases) and download respective binary for your platform. Make sure to give it execute permissions.

### Compiling from Source

```shell
cargo install semantic-scene
```

## ✅ TODO

- [ ] Enum-based category (`Mp3dObjectCategory`, `Mp3dRegionCategory`)

## 🎉 Credits

TODO