# scan-3d

**Repository Path**: jiawei651/scan-3d

## Basic Information

- **Project Name**: scan-3d
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-02-27
- **Last Updated**: 2022-02-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Scan 3D

## Setup

- Download and install [Node.js](https://nodejs.org/en/download/)
- Download and install [Git LFS](https://git-lfs.github.com/)

``` bash
# Fetch and update LFS files
git lfs fetch
git lfs update

# Install dependencies (only for first time)
npm i

# Serve at localhost:8080
npm run dev

# Build for production in the dist/ directory
npm run build
```

## Generate data

### Photos

- Take photos with great natural light
- Don't shake
- Lock focus and brightness to a setting without to much saturation
- If objects are far (few meters) walk 3 to 4 steps between photos
- If objects are close (less than 2 meters) walk a maximum of 2 steps between photos
- Keep the the angle slightly above the horizon
- Try not to have the sun in front of you

### 3DF Zephyr Aerials

#### Import and generate

- Open 3DF Zephyr Aerials
- Drag and drop the photo sequence
- Use those settings<br><img src="./resources/images/01-generate-01.png" width="400"><img src="./resources/images/01-generate-02.png" width="400"><img src="./resources/images/01-generate-03.png" width="400"><img src="./resources/images/01-generate-04.png" width="400"><img src="./resources/images/01-generate-05.png" width="400">
- Run and wait (it can take from few minutes to few hours depending on the quality and quantity of the photos)

#### Export

- Export as OBJ<br><img src="./resources/images/02-export-obj-01.png" width="320">
- Use those settings<br><img src="./resources/images/02-export-obj-02.png" width="320">

### Blender

#### Geometry

- Import the OBJ in Blender with default settings
- Merge vertices by distance
- Rotate the scene (Z positive = up, Y positive = forward)
- Fix incorrect areas (floor, ceiling, reflections)
- Create a man reference (can be a simple box 180cm high) and scale the model accordingly
- Run `/resources/blender/textureToVertexColor/textureToVertexColors.py` to convert texture to vertex color (you might need to change the image name in the last line of the script)
- Export as PLY
- Use those settings<br><img src="./resources/images/03-export-ply-01.png" width="200">
- Optimize the PLY using the python script `/resources/python/optimise.py`

```
# Default
python3 optimise.py --path ./example.ply

# Change float precision (default: 9)
python3 optimise.py --path ./example.ply --precision 5

# Remove some points (default: 1)
python3 optimise.py --path ./example.ply --reduce 0.5

# Add points limit usually for testing (default: 1000000000)
python3 optimise.py --path ./example.ply --limit 300
```

#### Collision primitive

- Create collision JSON using primitives (box, circle, sphere)
- Resize, move and rotate the primitives but do not change the vertices directly and do not apply transformations
- Export using the script `/resources/blender/primitiveJsonExporter/main.py`
- Use those settings<br><img src="./resources/images/04-export-collision-01.png" width="200">

#### Floor

- Create à geometry roughly following the floor
- Export as PLY
- Use those settings<br><img src="./resources/images/05-export-floor-01.png" width="200">