7/13夜時点

nishlumi · Jul 13, 2022 · 0a409f7 · 0a409f7
1 parent 74a0b01
commit 0a409f7
Show file tree

Hide file tree

Showing 33 changed files with 186 additions and 40 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -22,7 +22,7 @@
 author = 'ISHII Eiju'
 
 # The full version, including alpha/beta/rc tags
-release = '1.0.0b'
+release = '1.0.0'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/source/img/operation_initial_5.png b/docs/source/img/operation_initial_5.png
diff --git a/docs/source/img/screen_project1.png b/docs/source/img/screen_project1.png
diff --git a/docs/source/img/screen_ribbon_animation.png b/docs/source/img/screen_ribbon_animation.png
diff --git a/docs/source/img/screen_ribbon_home_clearcache.png b/docs/source/img/screen_ribbon_home_clearcache.png
diff --git a/docs/source/man1/menu_animation.rst b/docs/source/man1/menu_animation.rst
@@ -37,8 +37,9 @@
     アニメーションを完全に停止します。
 :ループ:
     ループ再生をオン・オフ切り替えます。
-:FPS:
-    アニメーションのFPSを設定します。
+:デフォルトの間隔:
+    現在のアニメーションプロジェクトにおいて、1フレーム間の秒数を指定します。デフォルトでは ``FPS / 6000.0`` の計算結果がセットされます。
+
 
 
 **Frame operation 内**

diff --git a/docs/source/man1/menu_home.rst b/docs/source/man1/menu_home.rst
@@ -4,6 +4,8 @@
 ホームタブ
 ####################################
 
+
+
 .. image:: ../img/screen_ribbon_home.png
     :align: center
 
@@ -16,6 +18,16 @@
     本アプリのロゴを表示します。
 :キャッシュクリア:
     ファイルの開いた履歴や一時ファイルを一括で削除します。
+
+    .. image:: ../img/screen_ribbon_home_clearcache.png
+
+    | 
+    ================================= ==================
+    WebGLの動作を整理する             HTMLのUIを操作したときにWebGL内が動かなくなったときに動作をチェックして不要なキャッシュをクリアします。
+    アプリのキャッシュをクリアする     アプリ内で一時的に保持するだけのデータをまとめて削除します。
+    アプリの設定を削除する            アプリの設定で示される設定内容をすべて削除してデフォルトの状態に戻します。
+    ================================= ==================
+
 :言語選択:
     本アプリのUI言語を切り替えます。一部UIは次回起動後に反映されます。
 

diff --git a/docs/source/man1/screen_project.rst b/docs/source/man1/screen_project.rst
@@ -25,6 +25,8 @@
     明記したいURL
 :ライセンス:
     アニメーションプロジェクトのライセンス条項（必要であれば）
+:FPS:
+    アニメーションのFPSを設定します。 
 
 
 役割の管理

diff --git a/docs/source/man2/operation_camera.rst b/docs/source/man2/operation_camera.rst
@@ -8,7 +8,7 @@ Camera
 　カメラオブジェクトはシステム上最初から見えている映像であるメインカメラとは別に、サブカメラとして追加できます。
 IKマーカーは他と判別しやすくするために実際のカメラ風です。
 
-
+.. contents::
 
 .. image:: ../img/operation_camera_1.png
     :align: left

diff --git a/docs/source/man2/operation_effect.rst b/docs/source/man2/operation_effect.rst
@@ -7,6 +7,7 @@ Effect
 
 　Effectはアニメーションする画面効果をオブジェクトとして追加したり、他のオブジェクトに対して影響を与える効果を設定することができます。
 
+.. contents::
 
 .. index:: Effectのプレビュー
 

diff --git a/docs/source/man2/operation_initial.rst b/docs/source/man2/operation_initial.rst
@@ -2,6 +2,9 @@
 オブジェクト操作の基本
 ####################################
 
+.. contents::
+
+
 .. index:: オブジェクトを開く
 
 オブジェクトを開く
@@ -52,7 +55,7 @@ VRMの場合
 
 ::
 
-    球、カプセル、円柱、立方体、平面（3D）、四辺形（2D）
+    球、カプセル、円柱、立方体、平面（3D）、四辺形（2D）、水面
 
 
 

diff --git a/docs/source/man2/operation_obj.rst b/docs/source/man2/operation_obj.rst
@@ -8,6 +8,7 @@ OtherObject
 
 　OtherObjectは基本的にはVRoid/VRM以外の一般的な3Dモデルを扱います。OtherObjectを始め、VRoid/VRM以外はIKマーカーは1つのオブジェクトにつき1個のみです。
 
+.. contents::
 
 
 .. image:: ../img/operation_oobj_1.png
@@ -49,6 +50,19 @@ OtherObject
 .. note::
     ※キーフレームに3Dオブジェクトのアニメーションデータが展開・表示されるわけではなく、あくまで再生・一時停止・停止・シークという状態がキーフレームに登録されるのみです。
 
+.. hint::
+    再生や停止ではなく、再生位置変更でシーク位置を変えることだけをキーフレームに登録していっても、そのオブジェクトのアニメーション再生を自由に行なえます。
+
+    .. code::
+
+        例）あるアニメーションを持つFBXをOtherObjectにした
+
+        1フレーム目: アニメーションの状態（登録用） = 再生位置変更、シーク位置 = 0.855時点
+
+        2フレーム目: アニメーションの状態（登録用） = 再生位置変更、シーク位置 = 0.124時点、間隔(duration)は1秒。
+
+        → このFBXは逆再生のようにアニメーションする。
+
 |
 
 .. index:: テクスチャ（OtherObject）
@@ -70,7 +84,7 @@ OtherObject
 2. 各種設定を好みで変更します。
 
 :シェーダー:
-    ``Standard`` ,  ``VRM/MToon`` , ``Water`` のいずれかを選択します。
+    ``Standard`` ,  ``VRM/MToon`` , ``Water``, ``Water2`` のいずれかを選択します。
 :色:
     テクスチャのベースの色を変更します。
 :カリングモード:

diff --git a/docs/source/man2/operation_stage.rst b/docs/source/man2/operation_stage.rst
@@ -8,6 +8,7 @@ Stage
 　Stageは床や空、照明などの環境を扱います。
 
 
+.. contents::
 
 舞台
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -30,7 +31,18 @@ Stage
     ※建築物や木などはOtherObjectを使って表現してください。
 
 
-UserStageの場合
+水面の舞台
+----------------------
+
+　BasicSeaLevel、DaytimeWaterStage、NighttimeWaterStageの3種類は海面・水面となる舞台です。それぞれ演出効果が若干異なります。
+
+　DaytimeWaterStage、NighttimeWaterStageの2種類は角が丸い平面となっており、他の舞台より若干地平線（水平線）が低めとなっています。
+
+.. hint::
+    OtherObjectの基本の図形にある ``水面`` を使うと地面の舞台を使いながら、部分的に水面を演出することができます。
+
+
+UserStage
 ----------------------
 
 UserStageは自分で好きなテクスチャを貼り付けて表現できる舞台の種類です。

diff --git a/docs/source/man2/operation_vrm.rst b/docs/source/man2/operation_vrm.rst
@@ -6,6 +6,7 @@ VRoid/VRM
 　VRoid/VRMを読み込んでポーズを取らせたり後述のアニメーションを作成して楽しめるのが本アプリのメインの特徴です。VRMファイルの読み込みから実際の操作まで、一連の操作を説明していきます。
 
 
+.. contents::
 
 
 .. index:: VRMの利用条件を確認する
@@ -247,6 +248,10 @@ IKマーカーを別オブジェクトに切り替える
 .. caution::
     割り当てているオブジェクトを削除した場合、各VRMのIKは自動的にデフォルトに戻ります。
 
+| 
+
+**VRM AとVRM B、そしてエフェクトオブジェクトを使った場合**
+
 .. image:: ../img/operation_vrm_e.png
     :align: center
 
@@ -467,7 +472,7 @@ Ver 1.0.0 時点：
 2. 各種設定を好みで変更します。
 
 :シェーダー:
-    ``Standard`` ,  ``VRM/MToon`` , ``Water`` のいずれかを選択します。
+    ``Standard`` ,  ``VRM/MToon`` , ``Water``, ``Water2`` のいずれかを選択します。
 :色:
     テクスチャのベースの色を変更します。
 :カリングモード:

diff --git a/docs/source/man2/prop_effect.rst b/docs/source/man2/prop_effect.rst
@@ -4,6 +4,8 @@
 Effect
 ####################################
 
+.. contents::
+
 
 メインのプロパティ
 ---------------------

diff --git a/docs/source/man2/prop_obj.rst b/docs/source/man2/prop_obj.rst
@@ -4,6 +4,9 @@
 OtherObject
 ####################################
 
+.. contents::
+
+
 
 .. index:: テクスチャ（OtherObjectのプロパティ）
 

diff --git a/docs/source/man2/prop_stage.rst b/docs/source/man2/prop_stage.rst
@@ -4,6 +4,8 @@
 Stage
 ####################################
 
+.. contents::
+
 
 メインのプロパティ
 ------------------------
@@ -21,8 +23,9 @@ Stage
 .. csv-table::
 
     Default,    グリッドで表されるデフォルトの床です。
-    SeaDayTime, 水面です。日中の水面を表しており水面はアニメーションします。
-    SeaNight,   水面です。夜の水面を表しており水面はアニメーションします。
+    BasicSeaLevel, 細かく調整可能な汎用的な水面です。水面はアニメーションします。不透明度が反映されます。
+    DayTimeWaterStage, 水面です。日中の水面を表しており水面はアニメーションします。
+    NighttimeWaterStage,   水面です。夜の水面を表しており水面はアニメーションします。
     DryGround,  乾燥地帯のような地面です。
     Desert,     砂漠の砂地です。
     Field1～4,  その他一般的な地形のような地面です。
@@ -44,6 +47,10 @@ Stage
     :発光色:
         シェーダのEmission Color
 
+BasicSeaLevel、DayTimeWaterStage、NighttimeWaterStageについて
+    設定オプションが多岐にわたるものがあります。詳しくはUnityのドキュメントを御覧ください。
+
+    `<https://docs.unity3d.com/ja/2019.1/Manual/HOWTO-Water.html>`_
 
 |
 

diff --git a/docs/source/man2/prop_vrm.rst b/docs/source/man2/prop_vrm.rst
@@ -6,6 +6,8 @@ VRoid/VRM
 
 　VRoid/VRMで使用可能なプロパティです。
 
+.. contents::
+
 
 .. index:: IK（VRMのプロパティ)
 .. index:: 移動モード（VRMのプロパティ)

diff --git a/docs/source/man4/animation_loadsave.rst b/docs/source/man4/animation_loadsave.rst
@@ -4,6 +4,8 @@
 アニメーションの読み込みと保存
 #########################################
 
+.. contents::
+
 .. index:: モーションの保存（アニメーションプロジェクト）
 
 モーションファイルに保存する
@@ -29,8 +31,17 @@
 :保存形式:
     **.vvmmot**
 
-    ※独自の拡張子ですが実際はただのJSON形式のファイルです。.jsonに拡張子を変更しても読み込むことはできます。正しくないデータを読み込んだ場合の動作は保証致しません。
+    * 独自の拡張子ですが実際はただのJSON形式のファイルです。.jsonに拡張子を変更しても読み込むことはできます。正しくないデータを読み込んだ場合の動作は保証致しません。
+
+.. warning::
+    VRMでモーションデータを作る際、途中で身長や体格の異なるVRMに差し替えて作ると接地や各部位にズレが生じてしまいます。必ず同じVRMのままモーションの作成を完成させてください。
 
+    例：
+        1. 160cmのVRMでモーションを途中まで作り、一旦ファイルに保存する
+        2. 別の日に155cmのVRMにvvmmotファイルを読み込み、モーションの続きを作成する
+        3. また別の日に140cmのVRMにvvmmotファイルを読み込み、モーションを再生する
+
+        この場合、3の140cmのVRMはモーション中に全身が浮き沈みしたり予期せぬ動きを起こします。
 
 | 
 
@@ -245,3 +256,32 @@
 .. note::
     プロジェクトに紐づいた素材も全てアプリ内から削除されます。
 
+
+.. index:: プロジェクトファイルをバックアップする（アニメーションプロジェクト）
+    バックアップ
+    バックアップの復元
+
+プロジェクトファイルをバックアップする
+=========================================
+
+　現在開いているプロジェクトを、定期的にバックアップすることができます。
+
+1. アプリの設定を開きます。
+2. アプリケーションタブにある ``プロジェクトをバックアップする`` にチェックを入れます。
+3. バックアップの間隔に、どのくらいの頻度でバックアップを自動的にするか目的の分を指定します。
+
+.. image:: img/loadsave_b.png
+    :align: center
+
+4. 内部ストレージダイアログを開くと、 ``%BACKUP%`` の名称で保存されています。
+
+.. image:: img/loadsave_c.png
+    :align: center
+
+|
+
+　予期せぬ事態が起きてアプリが終了したり継続不可能になった場合、 ``%BACKUP%.vvmproj`` を開けば以前の状態からすぐ再開できるようになります。
+
+.. warning::
+    バックアップされたプロジェクトファイルを開いた後、改めて保存する際はファイル名を変更してください。 ``%BACKUP%`` が入ったファイル名では保存できません。
+
diff --git a/docs/source/man4/animation_proper.rst b/docs/source/man4/animation_proper.rst
@@ -2,24 +2,60 @@
 アニメーションの各種設定
 #########################################
 
+.. contents::
+
 
 .. index:: フレーム数とFPSを設定する（アニメーションプロジェクト）
 
 フレーム数とFPSを設定する
 -------------------------------
 
-
 　アニメーションの長さを最初に決めます。デフォルトでは60となっており、FPSも60になっています。リボンバーの ``アニメーション`` タブにある図の2箇所を好みで設定してください。
 
-.. image:: img/proper_1.png
+.. |prop_right| image:: img/proper_1right.png
+.. |prop_left| image:: img/proper_1left.png
+
+
+.. csv-table::
     :align: center
 
+    |prop_left| , |prop_right|
+    プロジェクトの設定画面, リボンバー
+    FPS（1秒間あたりのフレーム数）, 最大のフレーム数
+
 |
 
 ※FPSで示される ``フレーム`` と本アプリでの ``フレーム`` は同意味ではありません。本アプリでの ``フレーム`` はあくまでもデータの管理上の配列の意味にすぎません。
 
+.. warning::
+    FPSを変更すると、 ``FPS / 6000.0`` を再計算して自動的に全キーフレームのduration(間隔)を更新します。手動で設定した間隔も全て変更されるので、FPSの変更を本当にするべきなのか確認してください。
+
+|
+
+.. index:: デフォルトの間隔を設定する
+
+デフォルトの間隔を設定する
+---------------------------------
+
+　アニメーションプロジェクトでは、そのフレームの内容に到達する間隔が秒数で決まっています。デフォルトでは ``FPS / 6000.0`` の計算結果が設定されています。
+
+　これを任意の秒数に変更することができます。
+
+1. リボンバーの ``デフォルトの間隔`` を入力します。（0.0001～99.9999 秒）
+
+.. image:: img/proper_h.png
+    :align: center
+
 |
 
+　ここで指定することにより、これ以後のキーフレームの登録では変更後の秒数が基準となって登録されます。
+
+　フレームを1つ以上離して登録すると、そのフレームの間隔は ``デフォルトの間隔 * 離したフレーム数`` の計算結果をベースとして調整された秒数となります。
+
+.. hint::
+    キーフレーム個別で間隔を設定したい場合は後述の :doc:`animation_register` →「キーフレームの間隔を設定する」を参照してください。
+
+
 .. index:: 
     WebGL画面サイズを設定する（アニメーションプロジェクト）
     ウィンドウサイズ

diff --git a/docs/source/man4/animation_register.rst b/docs/source/man4/animation_register.rst
@@ -4,6 +4,8 @@
 キーフレームの登録と設定
 #########################################
 
+.. contents::
+
 .. index:: 
     フレームを選択する（アニメーションプロジェクト）
     キーフレームの復元

diff --git a/docs/source/man4/animation_tl.rst b/docs/source/man4/animation_tl.rst
@@ -71,6 +71,6 @@
 
 
 |tlvisi| **タイムラインのキャスト（オブジェクト）の表示・非表示を切り替える**
-    | 選択中のタイムラインのキャストを非表示にすることができます。非表示にしてもIKマーカーは引き続き表示されます。（別キャストを選択すればIKマーカーすら表示されません）
-    | 非表示にしたキャストはアニメーション再生の対象外、かつプレビュー再生時にもポーズが復元されません。
+    　選択中のタイムラインのキャストを非表示にすることができます。非表示にしてもIKマーカーは引き続き表示されます。（別キャストを選択すればIKマーカーすら表示されません）
+
 
diff --git a/docs/source/man4/img/loadsave_b.png b/docs/source/man4/img/loadsave_b.png
diff --git a/docs/source/man4/img/loadsave_c.png b/docs/source/man4/img/loadsave_c.png
diff --git a/docs/source/man4/img/play_1.png b/docs/source/man4/img/play_1.png
diff --git a/docs/source/man4/img/proper_1.png b/docs/source/man4/img/proper_1.png
diff --git a/docs/source/man4/img/proper_1left.png b/docs/source/man4/img/proper_1left.png
diff --git a/docs/source/man4/img/proper_1right.png b/docs/source/man4/img/proper_1right.png
diff --git a/docs/source/man4/img/proper_h.png b/docs/source/man4/img/proper_h.png