| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>MDDLoader - Three.js Docs</title>
- <meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
- <script src="../scripts/highlight.min.js"></script>
- <link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
- <link type="text/css" rel="stylesheet" href="../styles/page.css">
- </head>
- <body>
- <p class="inheritance" translate="no"><a href="Loader.html">Loader</a> → </p>
- <h1 translate="no">MDDLoader</h1>
- <section>
- <header>
- <div class="class-description"><p>A loader for the MDD format.</p>
- <p>MDD stores a position for every vertex in a model for every frame in an animation.
- Similar to BVH, it can be used to transfer animation data between different 3D applications or engines.</p>
- <p>MDD stores its data in binary format (big endian) in the following way:</p>
- <ul>
- <li>number of frames (a single uint32)</li>
- <li>number of vertices (a single uint32)</li>
- <li>time values for each frame (sequence of float32)</li>
- <li>vertex data for each frame (sequence of float32)</li>
- </ul></div>
- <h2>Code Example</h2>
- <div translate="no"><pre><code class="language-js">const loader = new MDDLoader();
- const result = await loader.loadAsync( 'models/mdd/cube.mdd' );
- const morphTargets = result.morphTargets;
- const clip = result.clip;
- // clip.optimize(); // optional
- const geometry = new THREE.BoxGeometry();
- geometry.morphAttributes.position = morphTargets; // apply morph targets (vertex data must match)
- const material = new THREE.MeshBasicMaterial();
- const mesh = new THREE.Mesh( geometry, material );
- scene.add( mesh );
- const mixer = new THREE.AnimationMixer( mesh );
- mixer.clipAction( clip ).play();
- </code></pre></div>
- </header>
- <article>
- <h2 class="subsection-title">Import</h2>
- <p><span translate="no">MDDLoader</span> is an addon, and must be imported explicitly, see <a href="https://threejs.org/manual/#en/installation" target="_blank">Installation#Addons</a>.</p>
- <pre><code class="language-js">import { MDDLoader } from 'three/addons/loaders/MDDLoader.js';</code></pre>
- <div class="container-overview">
- <h2>Constructor</h2>
- <h3 class="name name-method" id="MDDLoader" translate="no">new <a href="#MDDLoader">MDDLoader</a><span class="signature">( manager : <span class="param-type">LoadingManager</span> )</span> </h3>
- <div class="method">
- <div class="description">
- <p>Constructs a new MDD loader.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>manager</code></td>
- <td class="description last"><p>The loading manager.</p></td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <h2 class="subsection-title">Methods</h2>
- <h3 class="name name-method" id="load" translate="no">.<a href="#load">load</a><span class="signature">( url : <span class="param-type">string</span>, onLoad : <span class="param-type">function</span>, onProgress : <span class="param-type">onProgressCallback</span>, onError : <span class="param-type">onErrorCallback</span> )</span> </h3>
- <div class="method">
- <div class="description">
- <p>Starts loading from the given URL and passes the loaded MDD asset
- to the <code>onLoad()</code> callback.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>url</code></td>
- <td class="description last"><p>The path/URL of the file to be loaded. This can also be a data URI.</p></td>
- </tr>
- <tr>
- <td class="name"><code>onLoad</code></td>
- <td class="description last"><p>Executed when the loading process has been finished.</p></td>
- </tr>
- <tr>
- <td class="name"><code>onProgress</code></td>
- <td class="description last"><p>Executed while the loading is in progress.</p></td>
- </tr>
- <tr>
- <td class="name"><code>onError</code></td>
- <td class="description last"><p>Executed when errors occur.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#load">Loader#load</a></dt>
- </dl>
- </div>
- <h3 class="name name-method" id="parse" translate="no">.<a href="#parse">parse</a><span class="signature">( data : <span class="param-type">ArrayBuffer</span> )</span><span class="type-signature"> : Object</span> </h3>
- <div class="method">
- <div class="description">
- <p>Parses the given MDD data and returns an object holding the animation clip and the respective
- morph targets.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>data</code></td>
- <td class="description last"><p>The raw XYZ data as an array buffer.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-overrides"><strong>Overrides:</strong> <a href="Loader.html#parse">Loader#parse</a></dt>
- </dl>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The result object.</dt>
- </dl>
- </div>
- <h2 class="subsection-title">Source</h2>
- <p>
- <a href="https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/MDDLoader.js" target="_blank" rel="noopener" translate="no">examples/jsm/loaders/MDDLoader.js</a>
- </p>
- </article>
- </section>
- <script src="../scripts/linenumber.js"></script>
- <script src="../scripts/page.js"></script>
- </body>
- </html>
|