Skip to content

Commit a10e95e

Browse files
RamType0RamType0
committed
Update docs(ja)
1 parent bb99c50 commit a10e95e

14 files changed

+99
-37
lines changed

‎.docfx/docs/ja/csharp-api/getting-started.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# C#から呼び出す
2+
3+
Meshiaの中核的なAPIは全て[`MeshSimplifier`](~/api/Meshia.MeshSimplification.MeshSimplifier.html)を通じて提供されます。
4+
5+
`MeshSimplifier`には`static`メソッドで提供されるステートレスAPIと、より高度なシナリオ向けのステートフルAPIがあります。
6+
7+
## ステートレスAPI
8+
9+
```csharp
10+
11+
using Meshia.MeshSimplification;
12+
13+
Mesh simplifiedMesh = new();
14+
15+
// 非同期API
16+
17+
await MeshSimplifier.SimplifyAsync(originalMesh, target, options, simplifiedMesh);
18+
19+
// 同期API
20+
21+
MeshSimplifier.Simplify(originalMesh, target, options, simplifiedMesh);
22+
23+
```
24+
25+
## ステートフルAPI
26+
27+
複数フレームをまたいで非同期で処理を行う場合、`Allocator.Persistent`を使用してください。
28+
1フレーム以内に処理が終わる場合でも、`Allocator.TempJob`を用いる必要があります。(`Allocator.Temp`は使えません)
29+
30+
1. `MeshSimplifier`のインスタンスを作る
31+
32+
2. [`MeshSimplifier.ScheduleLoadMeshData`](~/api/Meshia.MeshSimplification.MeshSimplifier.html#Meshia_MeshSimplification_MeshSimplifier_ScheduleLoadMeshData_Mesh_MeshData_Meshia_MeshSimplification_MeshSimplifierOptions_JobHandle_)でメッシュの読み込みをスケジュールする
33+
34+
3. [`BlendShapeData.GetMeshBlendShapes`](~/api/Meshia.MeshSimplification.BlendShapeData.html#Meshia_MeshSimplification_BlendShapeData_GetMeshBlendShapes_Mesh_AllocatorManager_AllocatorHandle_)でメッシュのブレンドシェイプを読み込む
35+
36+
4. [`MeshSimplifier.ScheduleSimplify`](~/api/Meshia.MeshSimplification.MeshSimplifier.html#Meshia_MeshSimplification_MeshSimplifier_ScheduleSimplify_Mesh_MeshData_NativeList_Meshia_MeshSimplification_BlendShapeData__Meshia_MeshSimplification_MeshSimplificationTarget_JobHandle_)
37+
でメッシュの軽量化をスケジュールする
38+
39+
5. [`MeshSimplifier.ScheduleWriteMeshData`](~/api/Meshia.MeshSimplification.MeshSimplifier.html#Meshia_MeshSimplification_MeshSimplifier_ScheduleWriteMeshData_Mesh_MeshData_NativeList_Meshia_MeshSimplification_BlendShapeData__Mesh_MeshData_NativeList_Meshia_MeshSimplification_BlendShapeData__JobHandle_)でメッシュの情報を書き出す
40+
41+
4~5を繰り返すことで一つのメッシュの複数のLODを生成することができます。
42+
43+
44+
[`MeshSimplifier.SimplifyAsync`](~/api/Meshia.MeshSimplification.MeshSimplifier.html#Meshia_MeshSimplification_MeshSimplifier_SimplifyAsync_Mesh_Meshia_MeshSimplification_MeshSimplificationTarget_Meshia_MeshSimplification_MeshSimplifierOptions_Mesh_System_Threading_CancellationToken_)の実装や、[テストコード](https://github.com/RamType0/Meshia.MeshSimplification/blob/d2ab9e170db6f7c6bbf693dd205415178a06c857/Runtime/Tests/MeshSimplifierTests.cs#L42)も参考になるでしょう。

‎.docfx/docs/ja/csharp-api/toc.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
- name: C#から呼び出す
2+
href: getting-started.md
3+

‎.docfx/docs/ja/getting-started.md‎

Lines changed: 0 additions & 34 deletions
This file was deleted.

‎.docfx/docs/ja/installation.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# インストール
2+
3+
[VPM repository](https://ramtype0.github.io/VpmRepository/)をVCCに追加してから、Manage Project > Manage PackagesからMeshia Mesh Simplificationをプロジェクトに追加してください。

‎.docfx/docs/ja/introduction.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Meshia Mesh Simplificationとは？
22

3-
Meshia Mesh SimplificationはUnity Job System上で動作する、非同期、高速なメッシュ軽量化ツールです。
3+
Meshia Mesh SimplificationはUnity Job System上で動作する、非同期、高速なメッシュ軽量化ツールです。

‎.docfx/docs/ja/toc.yml‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
- name: Meshia Mesh Simplificationとは？
22
href: introduction.md
3-
- name: チュートリアル
4-
href: getting-started.md
3+
- name: インストール
4+
href: installation.md
5+
- name: VRChat
6+
href: vrchat/toc.yml
7+
- name: C# API
8+
href: csharp-api/toc.yml

‎.docfx/docs/ja/vrchat/installation.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# インストール
2+
3+
VRChat向けの機能として、Meshia Mesh Simplifierと Meshia Cascading Avatar Mesh Simplifierがあります。これらの機能を使うには、追加のセットアップが必要になります。
4+
5+
# アバター改変向けに両方使いたい
6+
7+
[ModularAvatar](https://modular-avatar.nadena.dev/ja)をインストールしてください。
8+
9+
# ワールド改変向けに`MeshiaMeshSimplifier`を使いたい
10+
11+
NDMFをインストールする必要があります。ALCOMやVCCなどから最新のNDMFをインストールしてください。

‎.docfx/docs/ja/vrchat/meshia-cascading-avatar-mesh-simplifier.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Meshia Cascading Avatar Mesh Simplifierの使い方
2+
3+
1. 対象のアバター直下にMeshia Cascading Avatar Mesh SimplifierのGameObjectを作成してください。
4+
5+
![ヒエラルキーから追加](~/images/add-meshia-cascading-avatar-mesh-simplifier-object.png)
6+
7+
2. 目標とするパフォーマンスランクを選択します。
8+
9+
![パフォーマンスランクを選択](~/images/select-performance-rank.png)
10+
11+
3. 見た目を確認しながらポリゴン数の配分、オプションなどを調整してください。
12+
13+
![オプション](~/images/simplifier-options.png)
14+
15+
> [!TIP]
16+
> 特に重要なオプションがあります。
17+
>
18+
> ### メッシュの端の辺を保持
19+
>
20+
> 指先に穴が空いたりする場合、有効化してみてください。
21+
> - 無効
22+
>
23+
> ![無効](~/images/preserve-border-edges-disabled.png)
24+
> - 有効
25+
>
26+
> ![有効](~/images/preserve-border-edges-enabled.png)

‎.docfx/docs/ja/vrchat/toc.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
- name: インストール
2+
href: installation.md
3+
- name: Meshia Cascading Avatar Mesh Simplifier
4+
href: meshia-cascading-avatar-mesh-simplifier.md
5+

‎.docfx/images/add-meshia-cascading-avatar-mesh-simplifier-object.png‎

116 KB
Loading

0 commit comments

Comments
 (0)