Skip to content

Commit

Permalink
fix see2et
Browse files Browse the repository at this point in the history
  • Loading branch information
@slotsu0809
slotsu0809 committed Aug 12, 2024
1 parent 1160680 commit 030c025
Showing 1 changed file with 22 additions and 23 deletions.
45 changes: 22 additions & 23 deletions package/About_model_of_sutera_package_using_yaml.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Suteraパッケージのモデルについて(yamlフォーマット)

# モデルのSuteraパッケージについて(yamlフォーマット)
## 概要
Suteraパッケージではワールド内に設置された3Dモデルの情報を本項目で説明してるyamal^[1]フォーマットを用いて管理しています。

Expand All @@ -8,25 +7,25 @@ Suteraパッケージにおいてワールド内で設置されたオブジェ

### metadata
ファイルの基本的な情報が記載される部分です。
- type オブジェクトの場合Sutera-objectと記載されます
- Sutera_version 使用されているSuteraのバージョンが記載されます
- name オブジェクトの名前が記載されます
- version オブジェクトのバージョンが記載されます
- id オブジェクトに割り振るidを記載します
- type: Suteraパッケージのタイプを示します。オブジェクトの場合Sutera-objectと記載されます

Check failure on line 10 in package/About_model_of_sutera_package_using_yaml.md

View workflow job for this annotation

GitHub Actions / textlint 

[textlint] reported by reviewdog 🐶
箇条書き: "である"調 と "ですます"調 が混在
=> "である"調 の文体に、次の "ですます"調 の箇所があります: "ます。"
Total:
である  : 0
ですます: 27
 (ja-technical-writing/no-mix-dearu-desumasu)

Raw Output:
/home/runner/work/Specifications/Specifications/package/About_model_of_sutera_package_using_yaml.md:10:27: error: 箇条書き: "である"調 と "ですます"調 が混在
=> "である"調 の文体に、次の "ですます"調 の箇所があります: "ます。"
Total:
である  : 0
ですます: 27
 (ja-technical-writing/no-mix-dearu-desumasu) (eslint.rules.ja-technical-writing/no-mix-dearu-desumasu)

Check failure on line 10 in package/About_model_of_sutera_package_using_yaml.md

View workflow job for this annotation

GitHub Actions / textlint 

[textlint] reported by reviewdog 🐶
箇条書き: "である"調 と "ですます"調 が混在
=> "である"調 の文体に、次の "ですます"調 の箇所があります: "ます"
Total:
である  : 0
ですます: 27
 (ja-technical-writing/no-mix-dearu-desumasu)

Raw Output:
/home/runner/work/Specifications/Specifications/package/About_model_of_sutera_package_using_yaml.md:10:57: error: 箇条書き: "である"調 と "ですます"調 が混在
=> "である"調 の文体に、次の "ですます"調 の箇所があります: "ます"
Total:
である  : 0
ですます: 27
 (ja-technical-writing/no-mix-dearu-desumasu) (eslint.rules.ja-technical-writing/no-mix-dearu-desumasu)
- Sutera_version: 使用されているSuteraのバージョンが記載されます

Check failure on line 11 in package/About_model_of_sutera_package_using_yaml.md

View workflow job for this annotation

GitHub Actions / textlint 

[textlint] reported by reviewdog 🐶
箇条書き: "である"調 と "ですます"調 が混在
=> "である"調 の文体に、次の "ですます"調 の箇所があります: "ます"
Total:
である  : 0
ですます: 27
 (ja-technical-writing/no-mix-dearu-desumasu)

Raw Output:
/home/runner/work/Specifications/Specifications/package/About_model_of_sutera_package_using_yaml.md:11:43: error: 箇条書き: "である"調 と "ですます"調 が混在
=> "である"調 の文体に、次の "ですます"調 の箇所があります: "ます"
Total:
である  : 0
ですます: 27
 (ja-technical-writing/no-mix-dearu-desumasu) (eslint.rules.ja-technical-writing/no-mix-dearu-desumasu)
- name: オブジェクトの名前が記載されます

Check failure on line 12 in package/About_model_of_sutera_package_using_yaml.md

View workflow job for this annotation

GitHub Actions / textlint 

[textlint] reported by reviewdog 🐶
箇条書き: "である"調 と "ですます"調 が混在
=> "である"調 の文体に、次の "ですます"調 の箇所があります: "ます"
Total:
である  : 0
ですます: 27
 (ja-technical-writing/no-mix-dearu-desumasu)

Raw Output:
/home/runner/work/Specifications/Specifications/package/About_model_of_sutera_package_using_yaml.md:12:23: error: 箇条書き: "である"調 と "ですます"調 が混在
=> "である"調 の文体に、次の "ですます"調 の箇所があります: "ます"
Total:
である  : 0
ですます: 27
 (ja-technical-writing/no-mix-dearu-desumasu) (eslint.rules.ja-technical-writing/no-mix-dearu-desumasu)
- version: オブジェクトのバージョンが記載されます

Check failure on line 13 in package/About_model_of_sutera_package_using_yaml.md

View workflow job for this annotation

GitHub Actions / textlint 

[textlint] reported by reviewdog 🐶
箇条書き: "である"調 と "ですます"調 が混在
=> "である"調 の文体に、次の "ですます"調 の箇所があります: "ます"
Total:
である  : 0
ですます: 27
 (ja-technical-writing/no-mix-dearu-desumasu)

Raw Output:
/home/runner/work/Specifications/Specifications/package/About_model_of_sutera_package_using_yaml.md:13:29: error: 箇条書き: "である"調 と "ですます"調 が混在
=> "である"調 の文体に、次の "ですます"調 の箇所があります: "ます"
Total:
である  : 0
ですます: 27
 (ja-technical-writing/no-mix-dearu-desumasu) (eslint.rules.ja-technical-writing/no-mix-dearu-desumasu)
- id: オブジェクトに割り振るidを記載します

Check failure on line 14 in package/About_model_of_sutera_package_using_yaml.md

View workflow job for this annotation

GitHub Actions / textlint 

[textlint] reported by reviewdog 🐶
箇条書き: "である"調 と "ですます"調 が混在
=> "である"調 の文体に、次の "ですます"調 の箇所があります: "ます"
Total:
である  : 0
ですます: 27
 (ja-technical-writing/no-mix-dearu-desumasu)

Raw Output:
/home/runner/work/Specifications/Specifications/package/About_model_of_sutera_package_using_yaml.md:14:24: error: 箇条書き: "である"調 と "ですます"調 が混在
=> "である"調 の文体に、次の "ですます"調 の箇所があります: "ます"
Total:
である  : 0
ですます: 27
 (ja-technical-writing/no-mix-dearu-desumasu) (eslint.rules.ja-technical-writing/no-mix-dearu-desumasu)

### model
使用する3Dモデルのモデルデータに関して記述される部分です。
- type 使用する3Dモデルのファイルタイプを記載してください
- path 使用する3Dモデルのファイルへの絶対パスを指定してください
- type: 使用する3Dモデルのファイルタイプを記載してください
- path: 使用する3Dモデルのファイルへの絶対パスを指定してください

### material
3Dモデルで使用するマテリアルに関して記述する部分です。
- type マテリアルに使用するファイルのタイプを記述してください
- path マテリアルに使用するファイルの絶対パスを記述してください
- type: マテリアルに使用するファイルのタイプを記述してください
- path: マテリアルに使用するファイルの絶対パスを記述してください

### physics
モデルの物理的挙動の設定に関して記述する部分です。
- coliders
- coliders:
コライダーに関して設定する部分です。配列であるため、設定しない場合は空配列[]を設定してください。コライダーを設定する際はコライダーのtypeと各タイプごとのパラメータを記述してください。以下にSuteraで使用できる主要なコライダーのタイプと設定項目の例を記載します。
#### box
箱型のコライダーです。x,y,z軸方向のboxの大きさを指定してください。
Expand All @@ -35,7 +34,7 @@ Suteraパッケージにおいてワールド内で設置されたオブジェ
x: 1
y: 1
z: 1
```
```
#### sphere
球形のコライダーです。球の半径rを指定してください

Check failure on line 39 in package/About_model_of_sutera_package_using_yaml.md

View workflow job for this annotation

GitHub Actions / textlint 

[textlint] reported by reviewdog 🐶
不自然なアルファベットがあります: r (ja-technical-writing/ja-unnatural-alphabet)

Raw Output:
/home/runner/work/Specifications/Specifications/package/About_model_of_sutera_package_using_yaml.md:39:18: error: 不自然なアルファベットがあります: r (ja-technical-writing/ja-unnatural-alphabet) (eslint.rules.ja-technical-writing/ja-unnatural-alphabet)

Check failure on line 39 in package/About_model_of_sutera_package_using_yaml.md

View workflow job for this annotation

GitHub Actions / textlint 

[textlint] reported by reviewdog 🐶
文末が"。"で終わっていません。 (ja-technical-writing/ja-no-mixed-period)

Raw Output:
/home/runner/work/Specifications/Specifications/package/About_model_of_sutera_package_using_yaml.md:39:27: error: 文末が"。"で終わっていません。 (ja-technical-writing/ja-no-mixed-period) (eslint.rules.ja-technical-writing/ja-no-mixed-period)
```
Expand All @@ -52,19 +51,19 @@ Suteraパッケージにおいてワールド内で設置されたオブジェ
```


- rigidbody 物理演算について記述する項目です
- gravity Trueに設定すると重力の影響を受けます
- mass 質量の設定で単位は[kg]です。明記しない場合は0となり重力がないという扱いになります
- Drag オブジェクトに影響する空気抵抗の大きさです。0の場合空気抵抗が0となります
- Angular_Drag トルクによって回転する際に、オブジェクトに影響する空気抵抗の大きさです。0の場合空気抵抗は0となります
- rigidbody: 物理演算について記述する項目です
- gravity: Trueに設定すると重力の影響を受けます
- mass: 質量の設定で単位は[kg]です。明記しない場合は0となり重力がないという扱いになります
- Drag: オブジェクトに影響する空気抵抗の大きさです。0の場合空気抵抗が0となります
- Angular_Drag: トルクによって回転する際に、オブジェクトに影響する空気抵抗の大きさです。0の場合空気抵抗は0となります

### specs
ocjectをワールドに設置した際の位置や回転などといった情報を記述する部分です。
- location ワールドにおけるオブジェクトのグローバル座標です。x,y,zの3次元直交座標系で記載します
- rotation オブジェクトの回転を表します。x,y,z,wのクォータニオンで記載します
- scale オブジェクトのスケールです。locationと同じくx,y,zの3次元直交座標系で記載します
- origin ワールドにおけるオブジェクトの原点です。グローバル座標で表され、オブジェクトをリスポーンした際にはこの位置にオブジェクトが移動します
- origin_rotation ワールドにオブジェクトがスポーンした際の角度を指定します。rotationと同様にx,y,z,wのクォータニオンで記載します
- location: ワールドにおけるオブジェクトのグローバル座標です。x,y,zの3次元直交座標系で記載します
- rotation: オブジェクトの回転を表します。x,y,z,wのクォータニオンで記載します
- scale: オブジェクトのスケールです。locationと同じくx,y,zの3次元直交座標系で記載します
- origin: ワールドにおけるオブジェクトの原点です。グローバル座標で表され、オブジェクトをリスポーンした際にはこの位置にオブジェクトが移動します
- origin_rotation: ワールドにオブジェクトがスポーンした際の角度を指定します。rotationと同様にx,y,z,wのクォータニオンで記載します
## yamlファイルの例
[model.yaml](./model.yaml)に本項目で説明したワールドに設置する3Dモデルに関するyamlファイルの例が記載されています。

Expand Down

0 comments on commit 030c025

Please sign in to comment.