Skip to content

Commit

Permalink
ドキュメントの最新化 (#654)
Browse files Browse the repository at this point in the history
<!-- Close or Related Issues -->

### What I did(変更内容)
<!-- Please describe the motivation behind this PR and the changes it
introduces. -->
<!-- どのような変更をしますか? 目的は? -->

- マニュアルを改修

### Notes(連絡事項)
<!-- If manual testing is required, please describe the procedure. -->
<!-- 手動での動作確認が必要なら手順を簡単に伝えてください。そのほか連絡事項など。 -->

None / なし
  • Loading branch information
nokonoko1203 authored Sep 27, 2024
1 parent 52cd11c commit a3f0ca3
Show file tree
Hide file tree
Showing 12 changed files with 89 additions and 48 deletions.
8 changes: 4 additions & 4 deletions docs/manual/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
GitHubリポジトリの[リリースページ](https://github.com/MIERUNE/PLATEAU-GIS-Converter/releases)からダウンロードすることが可能です。

windowsを利用している方は、`PLATEAU.GIS.Converter_<最新バージョン>_x64-setup.exe`をダウンロードしてください。
MacOSを利用している方は`PLATEAU.GIS.Converter_<最新バージョン>_universal.dmg`をダウンロードしてください。
macOSを利用している方は`PLATEAU.GIS.Converter_<最新バージョン>_universal.dmg`をダウンロードしてください。

![alt text](../resources/install_image-11.png)

Expand All @@ -23,13 +23,13 @@ MacOSを利用している方は、`PLATEAU.GIS.Converter_<最新バージョン

![alt text](../resources/install_image-3.png)

## MacOSでのインストール
## macOSでのインストール

ダウンロードした`PLATEAU.GIS.Converter_<最新バージョン>_universal.dmg`を実行します。

![alt text](../resources/install_image-4.png)

アプリケーションをアプリケーションフォルダに移動します
アプリケーションをアプリケーションフォルダーに移動します

![alt text](../resources/install_image-5.png)

Expand All @@ -47,4 +47,4 @@ MacOSを利用している方は、`PLATEAU.GIS.Converter_<最新バージョン

![alt text](../resources/install_image-9.png)

![alt text](../resources/install_image-10.png)
![alt text](../resources/install_image.png)
36 changes: 32 additions & 4 deletions docs/manual/use_command_line.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Rustのインストール

[公式サイト](https://www.rust-lang.org/ja/tools/install)に従い、Rustをインストールしてください。MacOSかLinuxの場合は、以下のコマンドでインストールできます。
[公式サイト](https://www.rust-lang.org/ja/tools/install)に従い、Rustをインストールしてください。macOSかLinuxの場合は、以下のコマンドでインストールできます。

```sh
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
Expand All @@ -24,30 +24,33 @@ GitHubでの開発に慣れている方は、コマンドラインでcloneして
![alt text](../resources/useCommandLine_image-2.png)

ZIPファイルでダウンロードした方は、解凍した後に、コマンドラインで解凍したディレクトリに移動してください。
例えば`~/Downloads/PLATEAU-GIS-Converter-main`に解凍した場合は、以下のコマンドで移動できます。
たとえば`~/Downloads/PLATEAU-GIS-Converter-main`に解凍した場合は、以下のコマンドで移動できます。

```sh
cd ~/Downloads/PLATEAU-GIS-Converter-main
```

## データを変換する

以下のようにコマンドを実行することで、GeoPackageに変換することができます
以下のようにコマンドを実行することで、GeoPackageに変換できます
実行速度が高速になればなるほど、コンパイルに時間がかかります。

```bash
cd ./nusamai/

# Debug (非常に低速)
cargo run -- ~/path/to/PLATEAU/15100_niigata-shi_2022_citygml_1_op/udx/bldg/*.gml --sink geojson --output foobar.geojson

# Release (最適化コンパイル、実用速度)
cargo run --release -- ~/path/to/PLATEAU/15100_niigata-shi_2022_citygml_1_op/udx/bldg/*.gml --sink geojson --output foobar.geojson

# Release (LTO有効のプロダクションビルド、最高速)
cargo run --profile release-lto -- ~/path/to/PLATEAU/15100_niigata-shi_2022_citygml_1_op/udx/bldg/*.gml --sink geojson --output foobar.geojson
```

### 設定項目

- `--` : 以降の引数はファイル名として解釈されます。`*`を使って複数ファイルを指定することができます
- `--` : 以降の引数はファイル名として解釈されます。`*`を使って複数ファイルを指定できます
- `--sink` : 出力形式を指定します。以下のように指定することが可能です。
- `3dtiles` : 3D Tiles
- `gpkg` : GeoPackage
Expand All @@ -61,3 +64,28 @@ cargo run --profile release-lto -- ~/path/to/PLATEAU/15100_niigata-shi_2022_city
- `obj`: Wavefront OBJ
- `shapefile` : Shapefile
- `--output` : 出力先を指定します。拡張子なども指定してください。
- `-t`: 利用するLODを指定可能です。利用可能なオプションはGUIと同様です。
- `use_lod`
- `max_lod`: 最大LODを抽出する
- `min_lod`: 最小LODを抽出する
- `textured_max_lod`: テクスチャ付きの最大LODを抽出し、テクスチャがない場合は最大のLODを抽出する
- `-o`: 出力ファイル形式固有のオプションを設定します。
- `split`: OBJ形式専用です。オブジェクト分割についてbool値で設定します。
- `limit_texture_resolution`: 3D形式専用です。距離(メートル)あたりのテクスチャ解像度を制限します。
- 有効にすると、小さな地物の過剰に高解像度なテクスチャを適切に調整し、全体的なパフォーマンスを向上させます。

#### 設定例

- 中央区すべての建築物を、テクスチャ付きで3D Tilesに変換する

```bash
cargo run --release -- ~/13102_chuo-ku_city_2023_citygml_1_op/udx/bldg/*.gml \
--sink 3dtiles --output ~/data/output/3dtiles_textured -t use_lod=textured_max_lod
```

- テクスチャ付きかつ、テクスチャ解像度を制限してOBJ形式を出力する

```bash
% cargo run --release -- ~/13104_shinjuku-ku_city_2023_citygml_1_op/udx/bldg/53394525_bldg_6697_op.gml \
--sink obj --output ~/data/output/obj -t use_lod=textured_max_lod -o limit_texture_resolution=true -o split=true
```
Loading

0 comments on commit a3f0ca3

Please sign in to comment.