deploy: 9c216579d2

2026-09-12 13:59:21 -05:00 · 2021-09-07 14:16:07 +00:00
parent c5cee3d5dd
commit 01c9848017
5 changed files with 288 additions and 59 deletions
--- a/articles/en/gltf/0_82_glb_import.html
+++ b/articles/en/gltf/0_82_glb_import.html
@@ -5,9 +5,9 @@
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
-    <title>GLB </title>
+    <title>1. Parse </title>
    <meta name="viewport" content="width=device-width">
-    <meta name="title" content="GLB ">
+    <meta name="title" content="1. Parse ">
    <meta name="generator" content="docfx 2.58.2.0">
    
    <link rel="shortcut icon" href="../../../favicon.ico">
@@ -67,11 +67,106 @@
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="">
-<h2 id="glb">GLB</h2>

-<p>Set <code>materialGenerator</code> argument, Material is replaced by URP version.</p>
-<pre><code class="lang-cs">var data = new GlbFileParser(path).Parse();
-var loader = new UniGLTF.ImporterContext(data, materialGenerator: new GltfUrpMaterialDescriptorGenerator());
+<p>This is <code>0.82.1</code> API.
+If use <code>0.82.0</code>, please upgrade.</p>
+<p>GLB load is below steps.</p>
+<ol>
+<li>Parse <code>GLB</code> / <code>GLTF</code>, get a <code>GltfData</code></li>
+<li>Load <code>Unity Hierarchy</code> from the <code>GltfData</code>, get a <code>RuntimeGltfInstance</code>, dispose loader.</li>
+<li>Use the <code>RuntimeGltfInstance</code>, destroy the <code>RuntimeGltfInstance</code>.</li>
+</ol>
+<h1 id="1-parse">1. Parse</h1>
+<h2 id="parse-glb-from-file-path">Parse glb from file path</h2>
+<ul>
+<li>same as <code>vrm</code></li>
+</ul>
+<pre><code class="lang-cs">GltfData Load(string path)
+{
+    return new GlbFileParser(path).Parse();
+}
+</code></pre>
+<h2 id="parse-glb-byte-array">Parse glb byte array</h2>
+<ul>
+<li>same as <code>vrm</code></li>
+</ul>
+<pre><code class="lang-cs">GltfData Load(byte[] bytes)
+{
+    return new GlbBinaryParser(bytes, &quot;LOAD_NAME&quot;).parse();
+}
+</code></pre>
+<h2 id="parse-gltf-from-file-path">Parse gltf from file path</h2>
+<pre><code class="lang-cs">GltfData Load(string path)
+{
+    return new GltfFileWithResourceFilesParser(path).Parse();
+}
+</code></pre>
+<h2 id="parse-gltf-in-zip-archive-from-file-path">Parse gltf in zip archive from file path</h2>
+<p>Zip archive that contain gltf and related files can parsed (experimental).</p>
+<pre><code class="lang-cs">GltfData Load(string path)
+{
+    return new ZipArchivedGltfFileParser(path).Parse();
+}
+</code></pre>
+<h2 id="parse-by-file-extension">Parse by file extension</h2>
+<p>See <code>SimpleViewer</code> sample.</p>
+<pre><code class="lang-cs">GltfData Load(string path)
+{
+    var ext = Path.GetExtension(path).ToLower();
+    switch(ext)
+    {
+        case &quot;.glb&quot;: return new GlbFileParser(path).Parse();
+        case &quot;.gltf&quot;: return new GltfFileWithResourceFilesParser(path).Parse();
+        case &quot;.zip&quot;: return new ZipArchivedGltfFileParser(path).Parse();
+        default: throw new Exception($&quot;unknown: {ext}&quot;);
+    }
+}
+</code></pre>
+<h1 id="2-load">2. Load</h1>
+<h2 id="sync">sync</h2>
+<pre><code class="lang-cs">RuntimeGltfInstance Load(GltfData data)
+{
+    // Call ImporterContext.Dispose after load.
+    // Automatically load dispose by using.
+    using(var loader = new UniGLTF.ImporterContext(data)
+    {
+        var instance = loader.Load();
+        return instance;
+    }
+}
+</code></pre>
+<h2 id="async">async</h2>
+<pre><code class="lang-cs">async RuntimeGltfInstance Load(GltfData data)
+{
+    // Call ImporterContext.Dispose after load.
+    // Automatically load dispose by using.
+    using(var loader = new UniGLTF.ImporterContext(data)
+    {
+        var instance = await loader.LoadAsync();
+        return instance;
+    }
+}
+</code></pre>
+<h2 id="load-urp-material-by-materialgenerator-argument">Load URP material by materialGenerator argument</h2>
+<p>You can load URP materials by setting the <code>materialGenerator</code> Argument (optional).</p>
+<pre><code class="lang-cs">async RuntimeGltfInstance Load(GltfData data)
+{
+    var materialGenerator = new GltfUrpMaterialDescriptorGenerator();
+    using(var loader = new UniGLTF.ImporterContext(data, materialGenerator: materialGenerator)
+    {
+        var instance = await loader.LoadAsync();
+        return instance;
+    }
+}
+</code></pre>
+<h1 id="3-use-instance">3. Use instance</h1>
+<pre><code class="lang-cs">// Setup for SkinnedMeshRenderer
+instance.EnableUpdateWhenOffscreen();
+// Show meshes when ready(invisible by default)
+instance.ShowMeshes();
+</code></pre>
+<p>Destroy after use and discard related assets (textures, materials, meshes, etc.)</p>
+<pre><code class="lang-cs">GameObject.Destroy(instance);
 </code></pre>
 </article>
          </div>
--- a/articles/en/vrm0/0_82_runtime_import.html
+++ b/articles/en/vrm0/0_82_runtime_import.html
@@ -5,9 +5,9 @@
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
-    <title>1. Parse </title>
+    <title>1. Get GltfData </title>
    <meta name="viewport" content="width=device-width">
-    <meta name="title" content="1. Parse ">
+    <meta name="title" content="1. Get GltfData ">
    <meta name="generator" content="docfx 2.58.2.0">
    
    <link rel="shortcut icon" href="../../../favicon.ico">
@@ -75,35 +75,55 @@
 <p>Material replacement for URP when Import is implemented .</p>
 <p>Below step is needed.</p>
 <ol>
-<li>Parse VRM, and Get VrmData.</li>
-<li>Create VrmImporter, and load Unity hierarchy.</li>
-<li>Use loaded instance(ShowMeshes)</li>
+<li>Parse VRM, and Get <code>GltfData</code>.</li>
+<li>Get <code>VRMData</code> from <code>GltfData</code>.</li>
+<li>Load a <code>RuntimeGltfInstance</code> from <code>VRMData</code>.</li>
+<li>Use the <code>RuntimeGltfInstance</code></li>
 </ol>
-<h1 id="1-parse">1. Parse</h1>
-<p><code>v0.82.1</code> VrmData is introduced.</p>
-<pre><code class="lang-cs">var data = new UniGLTF.GlbFileParser(path).Parse();
-VrmData vrm = new VRM.VRMData(data);
+<h1 id="1-get-gltfdata">1. Get <code>GltfData</code></h1>
+<pre><code class="lang-cs">GltfData Load(string path)
+{
+    return new GlbFileParser(path).Parse();
+}
 </code></pre>
-<h1 id="2-load">2. Load</h1>
-<p><code>v0.82.1</code> VrmData is introduced.</p>
-<pre><code class="lang-cs">var loader = new VRM.VRMImporterContext(vrm);
-RuntimeGltfInstance instance = context.Load();
+<p>See <a href="../gltf/0_82_glb_import.html">GLB import</a>.</p>
+<h1 id="2-get-vrmdata">2. Get <code>VRMData</code></h1>
+<pre><code class="lang-cs">VRMData vrm = new VRMData(data);
 </code></pre>
-<h2 id="set-materialgenerator-argument-for-urp">Set <code>materialGenerator</code> argument for URP</h2>
+<h1 id="3-load">3. Load</h1>
+<pre><code class="lang-cs">async RuntimeGltfInstance Load(VRMData vrm)
+{
+    // Dispose VRMImporterContext, after load
+    using(var loader = new VRMImporterContext(vrm))
+    {
+        var instance = await loader.LoadAsync();
+        return instance;
+    }
+}
+</code></pre>
+<h2 id="set-materialgenerator-argument-for-urpexperimental">Set <code>materialGenerator</code> argument for URP(Experimental)</h2>
 <p>Set <code>materialGenerator</code> Argument, material generation is could customized.
 If omitted, default <code>materialGenerator</code> for <code>built-in</code> pipeline is used.</p>
-<pre><code class="lang-cs">var loader = new VRM.VRMImporterContext(vrm, materialGenerator: new VRMUrpMaterialDescriptorGenerator(vrm.VrmExtension));
+<pre><code class="lang-cs">async RuntimeGltfInstance Load(VRMData vrm)
+{
+    var materialGenerator = new VRMUrpMaterialDescriptorGenerator(vrm.VrmExtension);
+    using(var loader = new VRM.VRMImporterContext(vrm, materialGenerator: materialGenerator))
+    {
+        var instance = await loader.LoadAsync();
+        return instance;
+    }
+}
 </code></pre>
 <ul>
 <li><code>MToonShader for URP</code> has not been implemented yet, fallback to <code>UniUnlit</code>.</li>
 </ul>
-<h1 id="3-instance">3. Instance</h1>
-<h2 id="showmeshes">ShowMeshes</h2>
-<p><code>v0.77</code> ShowMeshes method is move to RuntimeGltfInstance from Importer.</p>
-<pre><code class="lang-cs">instance.ShowMeshes();
+<h1 id="4-instance">4. Instance</h1>
+<pre><code class="lang-cs">// Setup for SkinnedMeshRenderer
+instance.EnableUpdateWhenOffscreen();
+// Show meshes when ready(invisible by default)
+instance.ShowMeshes();
 </code></pre>
-<h2 id="destroy">Destroy</h2>
-<p><code>v0.77</code> When destroy, related assets(meshes, materials and textures etc...) is destroyed.</p>
+<p>When destroy, related assets(meshes, materials and textures etc...) is destroyed.</p>
 <pre><code class="lang-cs">GameObject.Destroy(instance);
 </code></pre>
 </article>
--- a/articles/ja/gltf/0_82_glb_import.html
+++ b/articles/ja/gltf/0_82_glb_import.html
@@ -5,9 +5,9 @@
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
-    <title>GLB </title>
+    <title>1. &#12497;&#12540;&#12473;&#12377;&#12427; </title>
    <meta name="viewport" content="width=device-width">
-    <meta name="title" content="GLB ">
+    <meta name="title" content="1. &#12497;&#12540;&#12473;&#12377;&#12427; ">
    <meta name="generator" content="docfx 2.58.2.0">
    
    <link rel="shortcut icon" href="../../../favicon.ico">
@@ -67,11 +67,106 @@
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="">
-<h2 id="glb">GLB</h2>

+<p><code>0.82.1</code> の API です。
+<code>0.82.0</code> の場合は更新をお願いします。</p>
+<p>以下のステップでロードします。</p>
+<ol>
+<li><code>GLB</code> / <code>GLTF</code> をパースして <code>GltfData</code> を得る。</li>
+<li><code>GltfData</code> から <code>Unity Hierarchy</code> を ロード する。<code>RuntimeGltfInstance</code> を得る。 ローダーを破棄する。</li>
+<li>ロードした <code>RuntimeGltfInstance</code> 使う。<code>RuntimeGltfInstance</code> を破棄する。</li>
+</ol>
+<h1 id="1-パースする">1. パースする</h1>
+<h2 id="glb-ファイルパスからパースする">glb ファイルパスからパースする</h2>
+<ul>
+<li><code>vrm</code> もこの関数を使います。</li>
+</ul>
+<pre><code class="lang-cs">GltfData Load(string path)
+{
+    return new GlbFileParser(path).Parse();
+}
+</code></pre>
+<h2 id="glb-バイト列をパースする">glb バイト列をパースする</h2>
+<ul>
+<li><code>vrm</code> もこの関数を使います。</li>
+</ul>
+<pre><code class="lang-cs">GltfData Load(byte[] bytes)
+{
+    return new GlbBinaryParser(bytes, &quot;LOAD_NAME&quot;).parse();
+}
+</code></pre>
+<h2 id="gltf-ファイルパスからパースする">gltf ファイルパスからパースする</h2>
+<pre><code class="lang-cs">GltfData Load(string path)
+{
+    return new GltfFileWithResourceFilesParser(path).Parse();
+}
+</code></pre>
+<h2 id="zip-アーカイブからパースする">zip アーカイブからパースする</h2>
+<p>gltf と関連するファイルを zip アーカイブしたファイルをパースできます(実験)。</p>
+<pre><code class="lang-cs">GltfData Load(string path)
+{
+    return new ZipArchivedGltfFileParser(path).Parse();
+}
+</code></pre>
+<h2 id="ファイルパスの拡張子でパースする">ファイルパスの拡張子でパースする</h2>
+<p>サンプルの <code>SimpleViewer</code> を参考にしてください。</p>
+<pre><code class="lang-cs">GltfData Load(string path)
+{
+    var ext = Path.GetExtension(path).ToLower();
+    switch(ext)
+    {
+        case &quot;.glb&quot;: return new GlbFileParser(path).Parse();
+        case &quot;.gltf&quot;: return new GltfFileWithResourceFilesParser(path).Parse();
+        case &quot;.zip&quot;: return new ZipArchivedGltfFileParser(path).Parse();
+        default: throw new Exception($&quot;unknown: {ext}&quot;);
+    }
+}
+</code></pre>
+<h1 id="2-ロードする">2. ロードする</h1>
+<h2 id="sync">sync</h2>
+<pre><code class="lang-cs">RuntimeGltfInstance Load(GltfData data)
+{
+    // ImporterContext は使用後に Dispose を呼び出してください。
+    // using で自動的に呼び出すことができます。
+    using(var loader = new UniGLTF.ImporterContext(data)
+    {
+        var instance = loader.Load();
+        return instance;
+    }
+}
+</code></pre>
+<h2 id="async">async</h2>
+<pre><code class="lang-cs">async RuntimeGltfInstance Load(GltfData data)
+{
+    // ImporterContext は使用後に Dispose を呼び出してください。
+    // using で自動的に呼び出すことができます。
+    using(var loader = new UniGLTF.ImporterContext(data)
+    {
+        var instance = await loader.LoadAsync();
+        return instance;
+    }
+}
+</code></pre>
+<h2 id="materialgenerator-で-urp-用のマテリアルをロードする">materialGenerator で URP 用のマテリアルをロードする</h2>
 <p><code>materialGenerator</code> 引き数(省略可能)を指定することで URP マテリアルを生成するようにカスタムできます。</p>
-<pre><code class="lang-cs">var data = new GlbFileParser(path).Parse();
-var loader = new UniGLTF.ImporterContext(data, materialGenerator: new GltfUrpMaterialDescriptorGenerator());
+<pre><code class="lang-cs">async RuntimeGltfInstance Load(GltfData data)
+{
+    var materialGenerator = new GltfUrpMaterialDescriptorGenerator();
+    using(var loader = new UniGLTF.ImporterContext(data, materialGenerator: materialGenerator)
+    {
+        var instance = await loader.LoadAsync();
+        return instance;
+    }
+}
+</code></pre>
+<h1 id="3-インスタンスを使用する">3. インスタンスを使用する</h1>
+<pre><code class="lang-cs">// SkinnedMeshRenderer に対する指示
+instance.EnableUpdateWhenOffscreen();
+// 準備ができたら表示する(デフォルトでは非表示)
+instance.ShowMeshes();
+</code></pre>
+<p>使用後に以下のように破棄してください。関連する Asset(Texture, Material, Meshなど)も破棄されます。</p>
+<pre><code class="lang-cs">GameObject.Destroy(instance);
 </code></pre>
 </article>
          </div>
--- a/articles/ja/vrm0/0_82_runtime_import.html
+++ b/articles/ja/vrm0/0_82_runtime_import.html
@@ -5,9 +5,9 @@
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
-    <title>1. Parse </title>
+    <title>1. GltfData &#12434;&#24471;&#12427; </title>
    <meta name="viewport" content="width=device-width">
-    <meta name="title" content="1. Parse ">
+    <meta name="title" content="1. GltfData &#12434;&#24471;&#12427; ">
    <meta name="generator" content="docfx 2.58.2.0">
    
    <link rel="shortcut icon" href="../../../favicon.ico">
@@ -72,38 +72,57 @@
 <li><code>Version 0.82.0</code> <code>0.82.1</code> 以降を使ってください。</li>
 <li><code>Version 0.82.1~</code></li>
 </ul>
-<p>Import時の Material 差し替え機能(URP対応)が実装されました。</p>
 <p>以下の手順で import します。</p>
 <ol>
-<li>VRMをパースして、VrmDataを得る</li>
-<li>VrmImporter 作成して、 Unity のヒエラルキーをロードする</li>
-<li>ロードされたインスタンスを使う(ShowMeshes)</li>
+<li>VRMをパースして、<code>GltfData</code> を得る。</li>
+<li><code>GltfData</code> から <code>VRMData</code> を得る。</li>
+<li><code>VrmData</code> から <code>RuntimeGltfInstance</code> をロードする。</li>
+<li><code>RuntimeGltfInstance</code> を使う。</li>
 </ol>
-<h1 id="1-parse">1. Parse</h1>
-<p><code>v0.82.1</code> VrmData が導入されます。</p>
-<pre><code class="lang-cs">var data = new UniGLTF.GlbFileParser(path).Parse();
-VrmData vrm = new VRM.VRMData(data);
+<h1 id="1-gltfdata-を得る">1. <code>GltfData</code> を得る</h1>
+<pre><code class="lang-cs">GltfData Load(string path)
+{
+    return new GlbFileParser(path).Parse();
+}
 </code></pre>
-<h1 id="2-load">2. Load</h1>
-<p><code>v0.82.1</code> VrmData が導入されます。</p>
-<pre><code class="lang-cs">var loader = new VRM.VRMImporterContext(vrm);
-RuntimeGltfInstance instance = context.Load();
+<p><a href="../gltf/0_82_glb_import.html">GLB import</a> も参照してください。</p>
+<h1 id="2-vrmdata-を得る">2. <code>VRMData</code> を得る</h1>
+<pre><code class="lang-cs">VRMData vrm = new VRMData(data);
 </code></pre>
-<h2 id="urp-向けに-materialgenerator-を指定する">URP 向けに <code>materialGenerator</code> を指定する</h2>
+<h1 id="3-load-する">3. Load する</h1>
+<pre><code class="lang-cs">async RuntimeGltfInstance Load(VRMData vrm)
+{
+    // 使用後に Dispose で VRMImporterContext を破棄してください。
+    using(var loader = new VRMImporterContext(vrm))
+    {
+        var instance = await loader.LoadAsync();
+        return instance;
+    }
+}
+</code></pre>
+<h2 id="urp-向けに-materialgenerator-を指定する実験">URP 向けに <code>materialGenerator</code> を指定する(実験)</h2>
 <p><code>materialGenerator</code> 引き数(省略可能)を指定することで URP マテリアルを生成するようにカスタムできます。
 指定しない場合は <code>built-in</code> 向けのデフォルトが使用されます。</p>
-<pre><code class="lang-cs">var loader = new VRM.VRMImporterContext(vrm, materialGenerator: new VRMUrpMaterialDescriptorGenerator(vrm.VrmExtension));
+<pre><code class="lang-cs">async RuntimeGltfInstance Load(VRMData vrm)
+{
+    var materialGenerator = new VRMUrpMaterialDescriptorGenerator(vrm.VrmExtension);
+    using(var loader = new VRM.VRMImporterContext(vrm, materialGenerator: materialGenerator))
+    {
+        var instance = await loader.LoadAsync();
+        return instance;
+    }
+}
 </code></pre>
 <ul>
-<li>まだ URP 向け MToonShader が作成されていないので、URP 向け <code>UniUnlit</code> にフォールバックします。</li>
+<li>まだ URP 向け MToonShader が作成されていないので、<code>UniUnlit</code> にフォールバックします。</li>
 </ul>
-<h1 id="3-instance">3. Instance</h1>
-<h2 id="showmeshes">ShowMeshes</h2>
-<p><code>v0.77</code> ShowMeshes が loader から instance に移動しました。</p>
-<pre><code class="lang-cs">instance.ShowMeshes();
+<h1 id="4-instance">4. Instance</h1>
+<pre><code class="lang-cs">// SkinnedMeshRenderer に対する指示
+instance.EnableUpdateWhenOffscreen();
+// 準備ができたら表示する(デフォルトでは非表示)
+instance.ShowMeshes();
 </code></pre>
-<h2 id="destroy">Destroy</h2>
-<p><code>v0.77</code> 破棄時に関連する Asset を破棄するようになりました。</p>
+<p>使用後に以下のように破棄してください。関連する Asset(Texture, Material, Meshなど)も破棄されます。</p>
 <pre><code class="lang-cs">GameObject.Destroy(instance);
 </code></pre>
 </article>
--- a/manifest.json
+++ b/manifest.json
@@ -4476,7 +4476,7 @@
      "output": {
        ".html": {
          "relative_path": "articles/en/gltf/0_82_glb_import.html",
-          "hash": "t7KcKRj3qkID55thLner/pluAryGDmvLyh5zErETWKU="
+          "hash": "sePaFU7bPMVRBXhGAxP6mRHoHA2pAlahd/YdY2RnFgM="
        }
      },
      "is_incremental": false,
@@ -4608,7 +4608,7 @@
      "output": {
        ".html": {
          "relative_path": "articles/en/vrm0/0_82_runtime_import.html",
-          "hash": "CfgSrAd7WZzf2BKNTfghrbwCD/m5IE4c8e8vxQosxiM="
+          "hash": "ee7MtwC62KPXwOTOnI9Su04fMxwiqZzCflTrcCZpBuM="
        }
      },
      "is_incremental": false,
@@ -4707,7 +4707,7 @@
      "output": {
        ".html": {
          "relative_path": "articles/ja/gltf/0_82_glb_import.html",
-          "hash": "goUF+LCJ1Y13+RWUJBOlz0iKYzkKL5PSbYFFQabyf5E="
+          "hash": "n5U2x3FheIJItVm+4eMQVnPsT8KzVhFeT/fJkmmjYps="
        }
      },
      "is_incremental": false,
@@ -4839,7 +4839,7 @@
      "output": {
        ".html": {
          "relative_path": "articles/ja/vrm0/0_82_runtime_import.html",
-          "hash": "pHthsSeq2n0sV6kDGpKLcnoj5eNElulJV0xsaf0CIKU="
+          "hash": "mkQnVZnFrSBTi1dCMHAOfKtVXIm7EBvkXaGtjvr8TtM="
        }
      },
      "is_incremental": false,