From 45617e557ddcfeca93f9b5a368ec2d44233fb272 Mon Sep 17 00:00:00 2001 From: ousttrue Date: Fri, 15 Oct 2021 16:46:59 +0900 Subject: [PATCH] document --- docs/gltf/0_82_glb_import.md | 5 +-- docs/locale/en/LC_MESSAGES/build.po | 10 ++--- .../LC_MESSAGES/implementation/coordinate.po | 35 ++++++++--------- .../en/LC_MESSAGES/implementation/index.po | 3 +- docs/locale/en/LC_MESSAGES/index.po | 1 - docs/locale/en/LC_MESSAGES/release/index.po | 26 +------------ docs/locale/en/LC_MESSAGES/vrm0/index.po | 2 +- docs/release/055/index.md | 2 +- docs/release/056/index.md | 2 +- docs/release/068/index.md | 2 +- docs/release/079/index.md | 2 +- docs/release/index.md | 7 ---- docs/vrm0/0_68_runtime_import.md | 2 +- docs/vrm0/0_77_runtime_import.md | 2 +- docs/vrm0/0_79_runtime_import.md | 2 +- docs/vrm0/0_82_runtime_import.md | 5 +-- docs/vrm0/0_87_runtime_import.md | 39 +++++++++++++++++++ docs/vrm0/index.md | 12 ++++-- 18 files changed, 83 insertions(+), 76 deletions(-) create mode 100644 docs/vrm0/0_87_runtime_import.md diff --git a/docs/gltf/0_82_glb_import.md b/docs/gltf/0_82_glb_import.md index 2fcce636b..23c961b42 100644 --- a/docs/gltf/0_82_glb_import.md +++ b/docs/gltf/0_82_glb_import.md @@ -1,6 +1,5 @@ -# GlbImport(0.82) -`0.82.1` の API です。 -`0.82.0` の場合は更新をお願いします。 +# GlbImport(0.82) GltfData +from: `0.82.1` 以下のステップでロードします。 diff --git a/docs/locale/en/LC_MESSAGES/build.po b/docs/locale/en/LC_MESSAGES/build.po index 7fad76b9d..da74a5d42 100644 --- a/docs/locale/en/LC_MESSAGES/build.po +++ b/docs/locale/en/LC_MESSAGES/build.po @@ -20,17 +20,18 @@ msgstr "" #: ../../build.md:1 msgid "アプリケーションのビルド" -msgstr "" +msgstr "Build Application" #: ../../build.md:3 msgid "ビルドに含めるシェーダー" -msgstr "" +msgstr "Shaders to include in the build" #: ../../build.md:5 msgid "" "`Project Settings = Graphics - Always Included Shaders` " "などに設定して、ビルドに含まれるようにしてください。" -msgstr "" +msgstr "Set `Project Settings = Graphics - Always Included Shaders` " +"to included in the build" #: ../../build.md:7 msgid "Unlit" @@ -50,7 +51,7 @@ msgstr "" #: ../../build.md:15 msgid "ランタイム import/export 時のテクスチャー変換用のシェーダー" -msgstr "" +msgstr "Shaders for texture conversion during runtime import/export" #: ../../build.md:17 msgid "`Assets\\VRMShaders\\GLTF\\IO\\Resources\\UniGLTF\\NormalMapExporter.shader`" @@ -63,4 +64,3 @@ msgstr "" #: ../../build.md:19 msgid "`Assets\\VRMShaders\\GLTF\\IO\\Resources\\UniGLTF\\StandardMapImporter.shader`" msgstr "" - diff --git a/docs/locale/en/LC_MESSAGES/implementation/coordinate.po b/docs/locale/en/LC_MESSAGES/implementation/coordinate.po index 78795a8c7..ec05d408c 100644 --- a/docs/locale/en/LC_MESSAGES/implementation/coordinate.po +++ b/docs/locale/en/LC_MESSAGES/implementation/coordinate.po @@ -20,31 +20,31 @@ msgstr "" #: ../../implementation/coordinate.md:1 msgid "座標系の変換" -msgstr "" +msgstr "Coordinate conversion" #: ../../implementation/coordinate.md:3 msgid "UniVRMは、インポート・エクスポート時に座標変換を実行しています。" -msgstr "" +msgstr "UniVRM convert coordinate when import or export" #: ../../implementation/coordinate.md msgid "右" -msgstr "" +msgstr "right" #: ../../implementation/coordinate.md msgid "上" -msgstr "" +msgstr "up" #: ../../implementation/coordinate.md msgid "前" -msgstr "" +msgstr "forward" #: ../../implementation/coordinate.md msgid "掌性" -msgstr "" +msgstr "chirality" #: ../../implementation/coordinate.md msgid "UV原点" -msgstr "" +msgstr "Origin of Texture coordinates" #: ../../implementation/coordinate.md msgid "Unity" @@ -64,11 +64,11 @@ msgstr "" #: ../../implementation/coordinate.md msgid "左手" -msgstr "" +msgstr "Left handed" #: ../../implementation/coordinate.md msgid "左下" -msgstr "" +msgstr "left bottom" #: ../../implementation/coordinate.md msgid "VRM-0" @@ -80,11 +80,11 @@ msgstr "" #: ../../implementation/coordinate.md msgid "右手" -msgstr "" +msgstr "Right handed" #: ../../implementation/coordinate.md msgid "左上" -msgstr "" +msgstr "left top" #: ../../implementation/coordinate.md msgid "VRM-1" @@ -100,7 +100,7 @@ msgstr "" #: ../../implementation/coordinate.md msgid "デフォルトはVRM-0方式。オプションでVRM-1方式を選べます" -msgstr "" +msgstr "The default is the VRM-0 method. Vrm-1 method can be selected as an option" #: ../../implementation/coordinate.md:12 msgid "UV" @@ -108,7 +108,7 @@ msgstr "" #: ../../implementation/coordinate.md:14 msgid "以下のように変換します。" -msgstr "" +msgstr "The following conversions" #: ../../implementation/coordinate.md:16 msgid "V^{\\prime} = 1 - V" @@ -120,11 +120,11 @@ msgstr "" #: ../../implementation/coordinate.md:22 msgid "Z軸を反転します。" -msgstr "" +msgstr "Invert Z-axis" #: ../../implementation/coordinate.md:24 msgid "Vector3: Position, Normalなど" -msgstr "" +msgstr "Vector3: Position, Normal, etc." #: ../../implementation/coordinate.md:33 msgid "Quaternion: Rotation" @@ -136,7 +136,7 @@ msgstr "" #: ../../implementation/coordinate.md:47 msgid "スケール値が入っているとうまくいきません" -msgstr "" +msgstr "If the scale value is in it, it does not work." #: ../../implementation/coordinate.md:61 msgid "Unity <-> VRM1" @@ -144,5 +144,4 @@ msgstr "" #: ../../implementation/coordinate.md:63 msgid "X軸を反転します。" -msgstr "" - +msgstr "Invert X-axis" diff --git a/docs/locale/en/LC_MESSAGES/implementation/index.po b/docs/locale/en/LC_MESSAGES/implementation/index.po index 54a409541..f3fa258cb 100644 --- a/docs/locale/en/LC_MESSAGES/implementation/index.po +++ b/docs/locale/en/LC_MESSAGES/implementation/index.po @@ -20,5 +20,4 @@ msgstr "" #: ../../implementation/index.md:1 msgid "実装メモ" -msgstr "" - +msgstr "Implementation note" diff --git a/docs/locale/en/LC_MESSAGES/index.po b/docs/locale/en/LC_MESSAGES/index.po index 8311de585..6e78302fa 100644 --- a/docs/locale/en/LC_MESSAGES/index.po +++ b/docs/locale/en/LC_MESSAGES/index.po @@ -23,7 +23,6 @@ msgid "UniVRM Programming Document" msgstr "" #: ../../index.md:3 -#, fuzzy msgid "" "これは、[UniVRM](https://github.com/vrm-c/UniVRM) の開発ドキュメントです。 " "UnityでVRMをエクスポートする方法などについては [manual](https://vrm.dev/docs/univrm/) " diff --git a/docs/locale/en/LC_MESSAGES/release/index.po b/docs/locale/en/LC_MESSAGES/release/index.po index a58ff8a0f..7871a2711 100644 --- a/docs/locale/en/LC_MESSAGES/release/index.po +++ b/docs/locale/en/LC_MESSAGES/release/index.po @@ -47,7 +47,6 @@ msgid "Unity-2019.4" msgstr "" #: ../../release/index.md -#, fuzzy msgid "特に問題が無ければこれ。" msgstr "Default" @@ -60,9 +59,8 @@ msgid "Unity-2018.4" msgstr "" #: ../../release/index.md -#, fuzzy msgid "開発版。最新版を使ってください。" -msgstr "Development version. Please use v0.81 ~" +msgstr "Development version. Please use latest" #: ../../release/index.md msgid "{doc}`v0.56～v0.67 <056/index>`" @@ -83,25 +81,3 @@ msgstr "" #: ../../release/index.md msgid "Unity-5.6(.NET3.5)" msgstr "" - -#~ msgid "v0.79～" -#~ msgstr "" - -#~ msgid "v0.68～v0.78" -#~ msgstr "" - -#~ msgid "v0.56～v0.67" -#~ msgstr "" - -#~ msgid "～v0.55" -#~ msgstr "" - -#~ msgid "`from 0.80`: `Unity-2019.4`" -#~ msgstr "" - -#~ msgid "`from 0.81`: `UniGLTF_VRMShaders` and `UniVRM` ２パッケージ構成" -#~ msgstr "`from 0.81`: `UniGLTF_VRMShaders` and `UniVRM` 2 package configuration" - -#~ msgid "Older versions" -#~ msgstr "" - diff --git a/docs/locale/en/LC_MESSAGES/vrm0/index.po b/docs/locale/en/LC_MESSAGES/vrm0/index.po index 3910199c3..97d1c66b0 100644 --- a/docs/locale/en/LC_MESSAGES/vrm0/index.po +++ b/docs/locale/en/LC_MESSAGES/vrm0/index.po @@ -32,7 +32,7 @@ msgstr "" #: ../../vrm0/index.md msgid "BlendShapeKey の仕様変更" -msgstr "" +msgstr "BlendShapeKey API update" #: ../../vrm0/index.md:19 msgid "Samples" diff --git a/docs/release/055/index.md b/docs/release/055/index.md index 9bf7aeaa3..12b5658cc 100644 --- a/docs/release/055/index.md +++ b/docs/release/055/index.md @@ -1,4 +1,4 @@ -# ～v0.55: Unity-5.6(.NET-3.5) +# ～v0.55 (Unity-5.6 .NET-3.5) 推奨バージョンv0.55 ## UnityPackage diff --git a/docs/release/056/index.md b/docs/release/056/index.md index 662d35704..ce8ad0ce8 100644 --- a/docs/release/056/index.md +++ b/docs/release/056/index.md @@ -1,4 +1,4 @@ -# v0.56～v0.67: Unity-2018.4 +# v0.56～v0.67 (Unity-2018.4) 推奨バージョンv0.66 ## ReleaseNote diff --git a/docs/release/068/index.md b/docs/release/068/index.md index 2a96a1923..3510ce9a0 100644 --- a/docs/release/068/index.md +++ b/docs/release/068/index.md @@ -1,4 +1,4 @@ -# v0.68～v0.78: Unity-2018.4 (pre release) +# v0.68～v0.78 (Unity-2018.4) 開発版 * VRM-1.0 作業中 * `.Net-3.5` が無くなって `coRoutine` を `Task` に置き換え diff --git a/docs/release/079/index.md b/docs/release/079/index.md index 624ea1b1c..b766b7fd2 100644 --- a/docs/release/079/index.md +++ b/docs/release/079/index.md @@ -1,4 +1,4 @@ -# v0.79～: Unity-2019.4 +# v0.79～ (Unity-2019.4) 最新版をご利用ください ## ReleaseNote diff --git a/docs/release/index.md b/docs/release/index.md index 3d75a5dfc..ddfca2bef 100644 --- a/docs/release/index.md +++ b/docs/release/index.md @@ -1,12 +1,5 @@ # Release -| バージョン | お勧め | Unity | | -|---------------------------------|--------|--------------------|----------------------------------| -| {doc}`v0.79～ <079/index>` | 最新版 | Unity-2019.4 | 特に問題が無ければこれ。 | -| {doc}`v0.68～v0.78 <068/index>` | | Unity-2018.4 | 開発版。最新版を使ってください。 | -| {doc}`v0.56～v0.67 <056/index>` | v0.66 | Unity-2018.4 | | -| {doc}`～v0.55 <055/index>` | v0.55 | Unity-5.6(.NET3.5) | | - ```{toctree} :maxdepth: 1 diff --git a/docs/vrm0/0_68_runtime_import.md b/docs/vrm0/0_68_runtime_import.md index 55b9cdc74..44a2689ba 100644 --- a/docs/vrm0/0_68_runtime_import.md +++ b/docs/vrm0/0_68_runtime_import.md @@ -1,4 +1,4 @@ -# RuntimeImport(0.68) +# RuntimeImport(0.68) DisposeOnGameObjectDestroyed(obsolete) ## 過去バージョンからの仕様変更 diff --git a/docs/vrm0/0_77_runtime_import.md b/docs/vrm0/0_77_runtime_import.md index 973c902d9..7b567b24a 100644 --- a/docs/vrm0/0_77_runtime_import.md +++ b/docs/vrm0/0_77_runtime_import.md @@ -1,4 +1,4 @@ -# RuntimeImport(0.77) +# RuntimeImport(0.77) RuntimeGltfInstance [DisposeOnGameObjectDestroyed](https://github.com/vrm-c/UniVRM/issues/1018) diff --git a/docs/vrm0/0_79_runtime_import.md b/docs/vrm0/0_79_runtime_import.md index 656b6801f..49fbc89bd 100644 --- a/docs/vrm0/0_79_runtime_import.md +++ b/docs/vrm0/0_79_runtime_import.md @@ -1,4 +1,4 @@ -# RuntimeImport(0.79) +# RuntimeImport(0.79) GltfData `GltfParser` と `GltfData` の分割 diff --git a/docs/vrm0/0_82_runtime_import.md b/docs/vrm0/0_82_runtime_import.md index c23583d92..2f33a28fb 100644 --- a/docs/vrm0/0_82_runtime_import.md +++ b/docs/vrm0/0_82_runtime_import.md @@ -1,7 +1,6 @@ -# RuntimeImport(0.82) +# RuntimeImport(0.82) VRMData -* `Version 0.82.0` は `0.82.1` 以降を使ってください。 -* `Version 0.82.1~` +from `0.82.1` 以下の手順で import します。 diff --git a/docs/vrm0/0_87_runtime_import.md b/docs/vrm0/0_87_runtime_import.md new file mode 100644 index 000000000..196a9ded4 --- /dev/null +++ b/docs/vrm0/0_87_runtime_import.md @@ -0,0 +1,39 @@ +# RuntimeImport(0.87) 非同期ロード + +## awaitCaller 引き数 + +```cs +public virtual async Task LoadAsync(IAwaitCaller awaitCaller = null, ...) +``` + +awaitCaller によりロード時の挙動をカスタマイズできます。 + +```{literalinclude} ../../Assets/VRMShaders/GLTF/IO/Runtime/AwaitCaller/IAwaitCaller.cs + :language: csharp + :linenos: +``` + +* NextFrame: 処理を中断して次のフレームで再開します。ロード処理が長い場合に長時間アプリケーションが固まることを防ぎます +* Run: UnityEngine.Object にアクセスしない処理を別スレッドで実行します。タスクが終了したら await で Unity Script スレッドで続きを実行します。 + +## ImmediateCaller + +デフォルトでは、`ImmediateCaller` が使われます。 +`ImmediateCaller` タスクを即時に実行するので、同期実行となります。 + +* Play(Editor Play, build), Editor(not play), UnitTest でデッドロックしないための実装です。 + +```{literalinclude} ../../Assets/VRMShaders/GLTF/IO/Runtime/AwaitCaller/ImmediateCaller.cs + :language: csharp + :linenos: +``` + +## RuntimeOnlyAwaitCaller + +* Play(Editor Play, build) 時に非同期実行する実装です +* `VRM10_Samples/VRM10Viewer` に使用例があります。 + +```{literalinclude} ../../Assets/VRMShaders/GLTF/IO/Runtime/AwaitCaller/RuntimeOnlyAwaitCaller.cs + :language: csharp + :linenos: +``` diff --git a/docs/vrm0/index.md b/docs/vrm0/index.md index e31f771f2..81e682e18 100644 --- a/docs/vrm0/index.md +++ b/docs/vrm0/index.md @@ -1,12 +1,9 @@ # VRM -| version | | -|---------|-------------------------------------------------| -| v0.56 | BlendShapeKey の仕様変更 | - ```{toctree} :maxdepth: 1 +0_87_runtime_import 0_82_runtime_import 0_79_runtime_import 0_77_runtime_import @@ -16,6 +13,13 @@ firstperson ``` +* {doc}`FastSpringBone(0.85) ` + +### TODO: + +* 🚧 materialGenerator +* 🚧 firstPerson + ## Samples - SimpleViewer