Merge pull request #470 from ousttrue/update/20241217

Update/20241217
vrm-c · Dec 17, 2024 · c55a166 · c55a166
2 parents 817fa04 + 20fac55
commit c55a166
Show file tree

Hide file tree

Showing 43 changed files with 382 additions and 348 deletions.
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/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/springbone/center.md b/docs/api/springbone/center.md
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
diff --git a/docs/api/springbone/startup.md b/docs/api/springbone/startup.md
diff --git a/docs/api/springbone/update.md b/docs/api/springbone/update.md
diff --git a/docs/api/springbone/vrm0/runtime.md → ...gbone/vrm0/VRM_IVrm0XSpringBoneRuntime.md b/docs/api/springbone/vrm0/runtime.md → ...gbone/vrm0/VRM_IVrm0XSpringBoneRuntime.md
@@ -1,4 +1,11 @@
-# SpringBone Runtime
+# VRM.IVrm0XSpringBoneRuntime
+
+実行システムを切り替えられるようになりました。
+
+- **Vrm0XSpringBoneDefaultRuntime(default)**: 通常の MonoBehaviour です。
+- `v0.85` **Vrm0XFastSpringboneRuntime**: Unity job system で実装されています。すべての vrm の spring bone まとめて処理するシングルトンです。
+
+これらの実装は importer の引数で切り替え可能です。`from v0.127.0`
 
 [SimpleViewer](https://github.com/vrm-c/UniVRM/blob/master/Assets/VRM_Samples/SimpleViewer/ViewerUI.cs)を参照してください。
 

diff --git a/docs/api/springbone/vrm0/VRM_VRMSpringBone.md b/docs/api/springbone/vrm0/VRM_VRMSpringBone.md
@@ -0,0 +1,105 @@
+# VRM.VRMSpringBone
+
+## インタフェース抜粋
+
+```cs
+public sealed class VRMSpringBone : MonoBehaviour
+{
+    [SerializeField] public string m_comment;
+    [SerializeField] private Color m_gizmoColor = Color.yellow;
+    [SerializeField] public float m_stiffnessForce = 1.0f;
+    [SerializeField] public float m_gravityPower;
+    [SerializeField] public Vector3 m_gravityDir = new Vector3(0, -1.0f, 0);
+    [SerializeField][Range(0, 1)] public float m_dragForce = 0.4f;
+    [SerializeField] public Transform m_center;
+    [SerializeField] public List<Transform> RootBones = new List<Transform>();
+    [SerializeField] public float m_hitRadius = 0.02f;
+    [SerializeField] public VRMSpringBoneColliderGroup[] ColliderGroups;
+
+    /// <summary>
+    /// - アプリケーション開発者用のパラメタである
+    /// - Runtime 制御用のパラメタである
+    /// - シリアライズ対象でない
+    /// - true にすることで、モデルをスケーリングしたときも SpringBone の見た目上の動き(角速度)がなるべく保たれるようになる
+    /// - Non-Uniform scaling 下における動作は保証しない        
+    /// </summary>
+    public bool UseRuntimeScalingSupport { get; set; }
+
+    /// <summary>
+    /// VRM-1.0 からのバックポート。
+    /// - Runtime 制御用のパラメタである
+    /// - シリアライズ対象でない
+    /// - World座標系
+    /// </summary>
+    public Vector3 ExternalForce { get; set; }
+
+    public enum SpringBoneUpdateType
+    {
+        LateUpdate,
+        FixedUpdate,
+        Manual,
+    }
+    [SerializeField] public SpringBoneUpdateType m_updateType = SpringBoneUpdateType.LateUpdate;
+
+    [ContextMenu("Reset bones")]
+    public void Setup(bool force = false)
+    {
+        if (RootBones != null)
+        {
+            m_system.Setup(Scene, force);
+        }
+    }
+
+    public void ReinitializeRotation()
+    {
+        m_system.ReinitializeRotation(Scene);
+    }
+
+    public void SetModelLevel(UniGLTF.SpringBoneJobs.Blittables.BlittableModelLevel modelSettings)
+    {
+        UseRuntimeScalingSupport = modelSettings.SupportsScalingAtRuntime;
+        ExternalForce = modelSettings.ExternalForce;
+    }
+
+    public void ManualUpdate(float deltaTime)
+    {
+        if (m_updateType != SpringBoneUpdateType.Manual)
+        {
+            throw new System.ArgumentException("require SpringBoneUpdateType.Manual");
+        }
+        m_system.UpdateProcess(deltaTime, Scene, Settings);
+    }
+}
+```
+
+## Update の手動呼び出し
+
+from [v0.106.0](/release/100/v0.106.0)
+
+[\#1866](https://github.com/vrm-c/UniVRM/pull/1886)
+
+- VRMSpringBone.SpringBoneUpdateType.Manual を追加
+- VRMSpringBone.ManualUpdate を追加
+
+- spring.ManualUpdate を使う前に spring.m_updateType を `Manual` に設定します。
+
+以下のように呼び出すことができます。
+
+```csharp
+VRMSpringBone spring;
+
+// setup
+spring.m_updateType = VRMSpringBone.SpringBoneUpdateType.Manual;
+
+// each frame
+spring.ManualUpdate(time.deltaTime);
+```
+
+## 拡大縮小の対応状況
+
+:::warning スケーリングは uniform(xyz が同じ) のみの対応です
+:::
+
+- `0.x` [SpringBone does not work correctly if you change the model size, for example scale (8,8,8). · Issue #2242 · vrm-c/UniVRM · GitHub](https://github.com/vrm-c/UniVRM/issues/2242)
+- `0.x` [Scale が VRM Spring Bone に正しく適用されません · Issue #922 · vrm-c/UniVRM · GitHub](https://github.com/vrm-c/UniVRM/issues/922)
+- [SpringBone does not work correctly if you change the model size, for example scale (8,8,8). · Issue #2242 · vrm-c/UniVRM · GitHub](https://github.com/vrm-c/UniVRM/issues/2242)
diff --git a/docs/api/springbone/vrm0/index.md b/docs/api/springbone/vrm0/index.md
@@ -3,4 +3,3 @@
 :::note オリジナル
 blog `Rocket Jump` の `Unityで揺れものを揺らす` という記事(2014年)に基いています。
 :::
-
diff --git a/docs/api/springbone/jobs.md → docs/api/springbone/vrm0/jobs.md b/docs/api/springbone/jobs.md → docs/api/springbone/vrm0/jobs.md
@@ -1,5 +1,24 @@
 # FastSpringBone(Unity job)について
 
+:::info job版のロジックは vrm-0.x と vrm-1.0 で共通化されました
+
+- https://github.com/vrm-c/UniVRM/issues/2422
+
+:::
+
+:::note job は房並列です
+
+joint 毎ではなく房(根元 から末端まで)単位の並列です。
+根元から順番に長さで拘束して位置を確定させる都合で親の位置・方向が先に決まる必要があるためです。
+
+- 伸縮せずに見た目がきれい
+- 並列化できない
+
+というトレードオフがあります。
+
+:::
+
+
 `from v0.85`
 
 ## 概要
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,4 +3,3 @@
		:::note オリジナル
		blog `Rocket Jump` の `Unityで揺れものを揺らす` という記事(2014年)に基いています。
		:::