Merge pull request #54 from vrm-c/update/20241223

Update/20241223
vrm-c · Dec 24, 2024 · a7528e5 · a7528e5
2 parents a2b82da + 9897a25
commit a7528e5
Show file tree

Hide file tree

Showing 70 changed files with 514 additions and 443 deletions.
diff --git a/docs/api/api_update.md b/docs/api/api_update.md
@@ -1,43 +1,40 @@
 # 0.x to 1.0
 
-`VRM-0.x` の個別のコンポーネントに機能を分散する設計を変更して
-`Vrm10Instance` にすべてを集約する方式になりました。
+The design of distributing functions to individual components of `VRM-0.x` has been changed to consolidating everything into `Vrm10Instance`.
 
 | 0.x                           | 1.0                            |
 | ----------------------------- | ------------------------------ |
 | VRMBlendShapeProxy            | VRMInstance.Runtime.Expression |
 | VRMLookAt                     | VRMInstance.Runtime.LookAt     |
 | VRMSpringBone(各SpringのRoot) | VRMInstance.Runtime.SpringBone |
 
-:::info 毎フレーム決まった順番で更新します。
+:::info It updates every frame in a fixed order.
 
 1. Control Rig
 2. Constraints
 3. Gaze control
 4. Expression
 
-ポーズ付け、ポーズの加工を考慮すると
+Considering posing and pose processing
 
-- [-2] ControlRig にポーズを付ける(Animator もしくは独自処理)
-- [-1] ControlRig の修正。IK など
-- [1] ControlRig 適用 から本体へのモーション転送
-- [2] Constraints 解決
-- [3] Gaze control 解決
-- [4] Expression 適用
-- [5] SpringBone 更新
+- [-2] Pose the ControlRig (using Animator or your own process)
+- [-1] ControlRig fixes. IK etc.
+- [1] Applying ControlRig to transfer motion to the body
+- [2] Constraints Solution
+- [3] Gaze control solution
+- [4] Expression apply
+- [5] SpringBone Update
 
-となりそうです。
-順番の制御が必要な場合は、VRMInstance の更新を手動に切り替えて手動で更新してください。
+If you need control over the order, you can update the VRMInstance manually by switching it to update manually.
 :::
 
 ## Expression
 
-```{admonition} VRMBlendShapeProxy は Vrm10Instance.Runtime.Expression になりました。
-:class: info
+:::info VRMBlendShapeProxy is now Vrm10Instance.Runtime.Expression.
 
-ImmediatelySetValue と AccumulateValue は、SetWeight に一本化されました。
-ImmediatelySetValue は無くなりました。
-```
+ImmediatelySetValue and AccumulateValue have been merged into SetWeight.
+ImmediatelySetValue is gone.
+:::
 
 ```csharp
 var proxy = root.GetComponent<VRMBlendShapeProxy>();
@@ -53,12 +50,10 @@ vrm10.Runtime.Expression.SetWeight(ExpressionKey.CreateFromPreset(ExpressionPres
 
 ## LookAt
 
-```{admonition} VRMLookAt は Vrm10Instance.Runtime.LookAt になりました。
-:class: info
+:::info VRMLookAt is now Vrm10Instance.Runtime.LookAt.
 
-vrm10.Gaze.position か vrm10.Runtime.LookAt.SetLookAtYawPitch で予め更新しておいた値が、
-後で vrm10.Runtime により適用されます。
-```
+The values previously updated by vrm10.Gaze.position or vrm10.Runtime.LookAt.SetLookAtYawPitch will be applied later by vrm10.Runtime.
+:::
 
 ### Gaze
 

diff --git a/docs/api/scripted_importer.md → docs/api/editor-import/scripted_importer.md b/docs/api/scripted_importer.md → docs/api/editor-import/scripted_importer.md
diff --git a/docs/api/editor-import/vrm10.md b/docs/api/editor-import/vrm10.md
diff --git a/docs/api/first_person.mdx b/docs/api/first_person.mdx
diff --git a/docs/api/check_firstperson.jpg → docs/api/firstperson/check_firstperson.jpg b/docs/api/check_firstperson.jpg → docs/api/firstperson/check_firstperson.jpg
diff --git a/docs/api/check_thirdperson.jpg → docs/api/firstperson/check_thirdperson.jpg b/docs/api/check_thirdperson.jpg → docs/api/firstperson/check_thirdperson.jpg
diff --git a/docs/api/firstperson/first_person.md b/docs/api/firstperson/first_person.md
@@ -0,0 +1,17 @@
+# VRアプリケーションの FirstPerson 設定による Renderer の可視制御
+
+- `isSelf==true` 自分のアバター
+- `isSelf==false` 自分以外のアバター
+- FP Camera: HMDと連動するカメラ
+- TP Camera: それ以外のすべてのカメラ
+
+| isSelf | FirstPerson設定 | FP Camera | TP Camera | レイヤーによる可視制御例                   |
+| ------ | --------------- | --------- | --------- | ------------------------------------------ |
+| true   | FirstPersonOnly | ✅        | ❌        | FIRSTPERSON                                |
+| true   | ThirdPersonOnly | ❌        | ✅        | THIRDPERSON                                |
+| true   | Both            | ✅        | ✅        | default                                    |
+| true   | Auto            | -         | -         | Both と ThirdPersonOnly に分割する         |
+| false  | FirstPersonOnly | ❌        | ❌        | 完全に描画されない。Rendererの描画を止める |
+| false  | ThirdPersonOnly | ✅        | ✅        | default                                    |
+| false  | Both            | ✅        | ✅        | default                                    |
+| false  | Auto            | ✅        | ✅        | default。メッシュ分割など特別な処理は不要  |
diff --git a/docs/api/firstperson.md → docs/api/firstperson/firstperson.md b/docs/api/firstperson.md → docs/api/firstperson/firstperson.md
@@ -1,6 +1,6 @@
 # `vrm-0.x` VRMFirstPersonの使い方
 
-[FirstPerson と Renderer の可視制御 ](/api/first_person)
+[FirstPerson と Renderer の可視制御 ](/api/firstperson/first_person)
 
 実行時に**VRMFirstPerson.Setup**を呼び出すことで、FirstPerson設定に応じた Renderer の可視制御を行うことができます。
 明示的に外部から呼び出してください。

diff --git a/docs/api/tags_layers.jpg → docs/api/firstperson/tags_layers.jpg b/docs/api/tags_layers.jpg → docs/api/firstperson/tags_layers.jpg
diff --git a/docs/api/vrm1_firstperson.md → docs/api/firstperson/vrm1_firstperson.md b/docs/api/vrm1_firstperson.md → docs/api/firstperson/vrm1_firstperson.md
@@ -1,6 +1,6 @@
 # `vrm-1.0` FirstPerson
 
-[FirstPerson と Renderer の可視制御 ](/api/first_person)
+[FirstPerson と Renderer の可視制御 ](/api/firstperson/first_person)
 
 :::warning VR 用の機能です
 

diff --git a/docs/api/0_36_update.md → docs/api/gltf/0_36_update.md b/docs/api/0_36_update.md → docs/api/gltf/0_36_update.md
diff --git a/docs/api/format.md → docs/api/gltf/format.md b/docs/api/format.md → docs/api/gltf/format.md
diff --git a/docs/api/how_to_impl_extension.md → docs/api/gltf/how_to_impl_extension.md b/docs/api/how_to_impl_extension.md → docs/api/gltf/how_to_impl_extension.md
diff --git a/docs/api/ControlRig.png → docs/api/humanoid/ControlRig.png b/docs/api/ControlRig.png → docs/api/humanoid/ControlRig.png
diff --git a/docs/api/humanoid/humanoid_animation.md b/docs/api/humanoid/humanoid_animation.md
@@ -46,9 +46,9 @@ BVH の初期姿勢は特に決まっていません。
 
 ### vrm-1.0 ControlRig で変換コピーする
 
-![img](../ControlRig.png)
+![img](./ControlRig.png)
 
-[ControlRig](/api/vrm1_controlrig)
+[ControlRig](/api/humanoid/vrm1_controlrig)
 
 :::tip 正規化さていないスケルトン/モーションを変換できます。
 

diff --git a/docs/api/vrm1_controlrig.md → docs/api/humanoid/vrm1_controlrig.md b/docs/api/vrm1_controlrig.md → docs/api/humanoid/vrm1_controlrig.md
diff --git a/docs/api/runtime_resource_management.md → docs/api/index.md b/docs/api/runtime_resource_management.md → docs/api/index.md
diff --git a/docs/api/index.mdx b/docs/api/index.mdx
diff --git a/docs/api/0_76_texture_deserializer.md → ...api/material/0_76_texture_deserializer.md b/docs/api/0_76_texture_deserializer.md → ...api/material/0_76_texture_deserializer.md
diff --git a/docs/api/0_96_1_use_gamma_colorspace.md → ...i/material/0_96_1_use_gamma_colorspace.md b/docs/api/0_96_1_use_gamma_colorspace.md → ...i/material/0_96_1_use_gamma_colorspace.md
diff --git a/docs/api/texture_manipulation.md → docs/api/material/texture_manipulation.md b/docs/api/texture_manipulation.md → docs/api/material/texture_manipulation.md
diff --git a/docs/api/transparent_zwrite.md → docs/api/material/transparent_zwrite.md b/docs/api/transparent_zwrite.md → docs/api/material/transparent_zwrite.md
diff --git a/docs/api/runtime-import/UniVRM10_Vrm10.md b/docs/api/runtime-import/UniVRM10_Vrm10.md
@@ -49,7 +49,7 @@ vrm-0.x とアタッチされるコンポーネントが異なります。
 
 unity の humanoid を経由せずに直接操作する場合のユーティリティーです。
 
-[正規化されていないモデルを操作する](/api/vrm1_controlrig)
+[正規化されていないモデルを操作する](/api/humanoid/vrm1_controlrig)
 
 ### showMeshes: Load完了時に表示させるか
 
@@ -108,7 +108,7 @@ public class ImporterContextSettings
 
 ### springboneRuntime: SpringBone の Runtime 選択
 
-[SpringBone Runtime](/api/springbone/vrm1/runtime)
+[SpringBone Runtime](/api/springbone/vrm1/IVrm10SpringBoneRuntime)
 
 ## LoadBytesAsync
 

diff --git a/docs/api/sample/AnimationBridgeSample.md b/docs/api/sample/AnimationBridgeSample.md
diff --git a/docs/api/sample/RuntimeExporterSample.md b/docs/api/sample/RuntimeExporterSample.md
diff --git a/docs/api/sample/Vrm10FirstPersonSample.md b/docs/api/sample/Vrm10FirstPersonSample.md
diff --git a/docs/api/springbone/center.md → docs/api/sample/index.md b/docs/api/springbone/center.md → docs/api/sample/index.md
diff --git a/docs/api/sample/index.mdx b/docs/api/sample/index.mdx
diff --git a/docs/api/sample/sample_from_upm.jpg b/docs/api/sample/sample_from_upm.jpg
diff --git a/docs/api/sample/sample_install.md b/docs/api/sample/sample_install.md
@@ -1,13 +1,19 @@
-# UniVRM サンプルをインストールする
+# Install UniVRM Sample
 
-このセクションでは、[UniVRM パッケージをインストール](/univrm/install/univrm_install)したことを想定しています。
+## UPM
 
-## UniVRM サンプルのパッケージ
+![PackageManager](./sample_from_upm.jpg)
+
+## Unity Package
+
+[UniVRM パッケージをインストール](/univrm/install/univrm_install) の場合
+
+### UniVRM サンプルのパッケージ
 
 `v0.81.0` から UniVRM サンプルは UniVRM パッケージに含まれています。  
 最新の UniVRM バージョンがインストールされている場合は、**UniVRM サンプルのシーンを実行する**セクションをご覧ください。
 
-### ~ v0.80.0
+#### ~ v0.80.0
 
 https://github.com/vrm-c/UniVRM/releases
 
@@ -22,4 +28,3 @@ https://github.com/vrm-c/UniVRM/releases
 以下の画像ようにインポートウィンドウを見たら、`Import`ボタンをクリックしてください：
 
 ![sample_package_import](/images/vrm/sample_package_import.jpg)
-
diff --git a/docs/api/sample/vrm0x/AnimationBridgeSample.md b/docs/api/sample/vrm0x/AnimationBridgeSample.md
@@ -0,0 +1,5 @@
+# AnimationBridgeSample
+
+[Assets/VRM_Samples/AnimationBridgeSample](https://github.com/vrm-c/UniVRM/tree/master/Assets/VRM_Samples/AnimationBridgeSample)
+
+AnimationClip に BlendShape の変換を記録して反映するサンプルです。
diff --git a/docs/api/sample/vrm0x/FirstPersonSample.md b/docs/api/sample/vrm0x/FirstPersonSample.md
@@ -0,0 +1,14 @@
+# FirstPersonSample
+
+[Assets/VRM_Samples/FirstPersonSample](https://github.com/vrm-c/UniVRM/tree/master/Assets/VRM_Samples/FirstPersonSample)
+
+![FirstPersonSample](./vrm0_firstperson_sample.jpg)
+
+VR アプリで FistPerson の設定に合わせて、可視設定を反映するサンプルです。
+
+画面が４分割されて、
+
+- HMDカメラ
+- その他のカメラ
+
+の描画を例示します。
diff --git a/docs/api/sample/vrm0x/RuntimeExporterSample.md b/docs/api/sample/vrm0x/RuntimeExporterSample.md
@@ -0,0 +1,7 @@
+# RuntimeExporterSample
+
+[Assets/VRM_Samples/RuntimeExporterSample](https://github.com/vrm-c/UniVRM/tree/master/Assets/VRM_Samples/RuntimeExporterSample)
+
+VRM を Runtime Export するサンプルです。
+
+`Assets/VRM_Samples/RuntimeExporterSample/VRMRuntimeExporter.cs`
diff --git a/docs/api/sample/SimpleViewer.md → docs/api/sample/vrm0x/SimpleViewer.md b/docs/api/sample/SimpleViewer.md → docs/api/sample/vrm0x/SimpleViewer.md
@@ -1,5 +1,7 @@
 # SimpleViewer
 
+[Assets/VRM_Samples/SimpleViewer](https://github.com/vrm-c/UniVRM/tree/master/Assets/VRM_Samples/SimpleViewer)
+
 Runtime ローダーのサンプルです。
 
 `Assets/VRM_Samples/SimpleViewer/ViewerUI.cs`
@@ -16,7 +18,4 @@ Runtime ローダーのサンプルです。
 
 ![sample_viewer_activate](/images/vrm/sample_viewer_activate.jpg)
 
-`VRM.Samples`に[ランタイム VRM エクスポート](https://github.com/vrm-c/UniVRM/tree/master/Assets/VRM/Samples/RuntimeExporterSample)と[一人称レンダリング](https://github.com/vrm-c/UniVRM/tree/master/Assets/VRM/Samples/FirstPersonSample)のサンプルがあります。
-
 Alicia モデルは[こちら](https://github.com/vrm-c/UniVRM/blob/master/Tests/Models/Alicia_vrm-0.51/AliciaSolid_vrm-0.51.vrm)。
-
diff --git a/docs/api/sample/vrm0_firstperson_sample.jpg → .../sample/vrm0x/vrm0_firstperson_sample.jpg b/docs/api/sample/vrm0_firstperson_sample.jpg → .../sample/vrm0x/vrm0_firstperson_sample.jpg
diff --git a/docs/api/sample/vrm10/ClothSample.md b/docs/api/sample/vrm10/ClothSample.md
@@ -0,0 +1,7 @@
+# ClothSample
+
+`v0.128.1`
+
+🚧 🚧 🚧
+
+[Assets/VRM10_Samples/ClothSample](https://github.com/vrm-c/UniVRM/tree/master/Assets/VRM10_Samples/ClothSample)
diff --git a/docs/api/sample/vrm10/SimpleVrma.md b/docs/api/sample/vrm10/SimpleVrma.md
@@ -0,0 +1,3 @@
+# SimpleVrma
+
+[Assets/VRM10_Samples/SimpleVrma](https://github.com/vrm-c/UniVRM/tree/master/Assets/VRM10_Samples/SimpleVrma)
diff --git a/docs/api/sample/FirstPersonSample.md → ...pi/sample/vrm10/VRM10FirstPersonSample.md b/docs/api/sample/FirstPersonSample.md → ...pi/sample/vrm10/VRM10FirstPersonSample.md
@@ -1,4 +1,6 @@
-# vmr-1.0 FirstPersonSample
+# VRM10FirstPersonSample
+
+[Assets/VRM10_Samples/VRM10FirstPersonSample](https://github.com/vrm-c/UniVRM/tree/master/Assets/VRM10_Samples/VRM10FirstPersonSample)
 
 ![image](./vrm1_firstperson_sample.jpg)
 
@@ -8,8 +10,7 @@ VR アプリで FistPerson の設定に合わせて、可視設定を反映す
 
 画面が４分割されて、
 
-* HMDカメラ
-* その他のカメラ
+- HMDカメラ
+- その他のカメラ
 
 の描画を例示します。
-
diff --git a/docs/api/sample/vrm10/VRM10RuntimeExporterSample.md b/docs/api/sample/vrm10/VRM10RuntimeExporterSample.md
@@ -0,0 +1,3 @@
+# VRM10RuntimeExporterSample
+
+[Assets/VRM10_Samples/VRM10RuntimeExporterSample](https://github.com/vrm-c/UniVRM/tree/master/Assets/VRM10_Samples/VRM10RuntimeExporterSample)
diff --git a/docs/api/sample/VRM10Viewer/index.md → docs/api/sample/vrm10/VRM10Viewer.md b/docs/api/sample/VRM10Viewer/index.md → docs/api/sample/vrm10/VRM10Viewer.md
@@ -1,6 +1,8 @@
 # VRM10Viewer
 
-![image](./vrm10viewer.jpg)
+[Assets/VRM10_Samples/VRM10Viewer](https://github.com/vrm-c/UniVRM/tree/master/Assets/VRM10_Samples/VRM10Viewer)
+
+![vrm10viewer](./vrm10viewer.jpg)
 
 vrm-1.0 の Runtime ローダーのサンプルです。
 
@@ -10,4 +12,3 @@ vrm-1.0 の Runtime ローダーのサンプルです。
 - (model) vrm-0.x(vrm-1.0 に動的に変換する)
 - (motion) bvh
 - (motion) vrm-animation
-
diff --git a/docs/api/sample/VRM10Viewer/vrm10viewer.jpg → docs/api/sample/vrm10/vrm10viewer.jpg b/docs/api/sample/VRM10Viewer/vrm10viewer.jpg → docs/api/sample/vrm10/vrm10viewer.jpg
diff --git a/docs/api/sample/vrm1_firstperson_sample.jpg → .../sample/vrm10/vrm1_firstperson_sample.jpg b/docs/api/sample/vrm1_firstperson_sample.jpg → .../sample/vrm10/vrm1_firstperson_sample.jpg
diff --git a/docs/api/springbone/index.md b/docs/api/springbone/index.md
diff --git a/docs/api/springbone/note.md b/docs/api/springbone/note.md
diff --git a/docs/api/springbone/scaling.md b/docs/api/springbone/scaling.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# SimpleVrma

		[Assets/VRM10_Samples/SimpleVrma](https://github.com/vrm-c/UniVRM/tree/master/Assets/VRM10_Samples/SimpleVrma)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# VRM10RuntimeExporterSample

		[Assets/VRM10_Samples/VRM10RuntimeExporterSample](https://github.com/vrm-c/UniVRM/tree/master/Assets/VRM10_Samples/VRM10RuntimeExporterSample)