# でアニメーションする多くのオブジェクトを最適化

この記事は多くのオブジェクトを最適化の続きです。まだ読んでいない場合は先に読んでみて下さい。

前回の記事では約19000個のキューブを単体のジオメトリにマージしました。 19000個のキューブの描画を最適化する利点がありましたが、個々のキューブを動かすのが難しくなる欠点がありました。

何を達成するかによって様々な解決策があります。 今回は複数のデータセットをグラフ化し、そのデータセットでクロスフェードアニメーションさせてみましょう。

まず、複数のデータセットを取得する必要があります。 オフラインでデータの前処理をするのが理想的ですが、今回は2つのデータセットをロードしてさらに2つのデータを生成してみましょう。

以下は古いデータロードのコードです。

    loadFile('resources/data/gpw/gpw_v4_basic_demographic_characteristics_rev10_a000_014mt_2010_cntm_1_deg.asc')
      .then(parseData)
      .then(addBoxes)
      .then(render);

このような感じに変更してみましょう。

    async function loadData(info) {
      const text = await loadFile(info.url);
      info.file = parseData(text);
    }

    async function loadAll() {
      const fileInfos = [
        {name: 'men',   hueRange: [0.7, 0.3], url: 'resources/data/gpw/gpw_v4_basic_demographic_characteristics_rev10_a000_014mt_2010_cntm_1_deg.asc' },
        {name: 'women', hueRange: [0.9, 1.1], url: 'resources/data/gpw/gpw_v4_basic_demographic_characteristics_rev10_a000_014ft_2010_cntm_1_deg.asc' },
      ];

      await Promise.all(fileInfos.map(loadData));

      ...
    }
    loadAll();

上記のコードでは `fileInfos` 内の各オブジェクトがローティングされたファイルを `file` プロパティに持ち、Promise.allで全てのファイルをロードします。 `name` と `hueRange` プロパティはあとで使います。`name` はUIフィールドです。`hueRange` は色相の範囲をマップし選択するために使います。

上記2ファイルは2010年時点でのエリア別の男性数と女性数を示しています。

注：このデータが正しいかわかりませんが、それは重要ではありません。 重要なのは異なるデータセットを示す事です。

さらに2つのデータセットを生成してみましょう。 1つは女性数よりも男性数が多い場所、逆にもう1つは男性数より女性数が多い場所です。

まず先ほどのデータで新しい2次元配列をマップする前に、2次元配列を生成する関数を書いてみましょう。

    function mapValues(data, fn) {
      return data.map((row, rowNdx) => {
        return row.map((value, colNdx) => {
          return fn(value, rowNdx, colNdx);
        });
      });
    }

通常の `Array.map` 関数と同様に `mapValues` 関数は配列の各値に対して関数 `fn` を呼び出します。 fnには値と行と列のインデックスを渡します。

2つのファイルを比較した新しいファイルを生成するコードを作成します。

    function makeDiffFile(baseFile, otherFile, compareFn) {
      let min;
      let max;
      const baseData = baseFile.data;
      const otherData = otherFile.data;
      const data = mapValues(baseData, (base, rowNdx, colNdx) => {
        const other = otherData[rowNdx][colNdx];
          if (base === undefined || other === undefined) {
            return undefined;
          }
          const value = compareFn(base, other);
          min = Math.min(min === undefined ? value : min, value);
          max = Math.max(max === undefined ? value : max, value);
          return value;
      });
      // make a copy of baseFile and replace min, max, and data
      // with the new data
      return {...baseFile, min, max, data};
    }

上記のコードは `compareFn` 関数で比較された値を元に `mapValues` 関数で新しいデータセットを生成しています。また `min` と `max` の比較結果も持っています。 最後のreturnで新しく `min`、`max`、`data` を追加した以外は `baseFile` と同じプロパティを持つ新しいファイルを作成します。

それを使って2つの新しいデータセットを作りましょう。

    {
      const menInfo = fileInfos[0];
      const womenInfo = fileInfos[1];
      const menFile = menInfo.file;
      const womenFile = womenInfo.file;

      function amountGreaterThan(a, b) {
        return Math.max(a - b, 0);
      }
      fileInfos.push({
        name: '>50%men',
        hueRange: [0.6, 1.1],
        file: makeDiffFile(menFile, womenFile, (men, women) => {
          return amountGreaterThan(men, women);
        }),
      });
      fileInfos.push({
        name: '>50% women',
        hueRange: [0.0, 0.4],
        file: makeDiffFile(womenFile, menFile, (women, men) => {
          return amountGreaterThan(women, men);
        }),
      });
    }

これらのデータセットを選択するUIを生成しましょう。まず、いくつかのhtmlのUIが必要です。

    <body>
      <canvas id="c"></canvas>
    +  <div id="ui"></div>
    </body>

次に左上のエリアに表示するためにCSSを追加しました。

    #ui {
      position: absolute;
      left: 1em;
      top: 1em;
    }
    #ui>div {
      font-size: 20pt;
      padding: 1em;
      display: inline-block;
    }
    #ui>div.selected {
      color: red;
    }

各ファイルを調べてデータセットごとにマージされたボックスのセットを生成します。 これでラベル上にマウスカーソルを置くとそのデータセットを表示し、他の全てのデータセットを非表示にするラベルUIを生成できます。

    // show the selected data, hide the rest
    function showFileInfo(fileInfos, fileInfo) {
      fileInfos.forEach((info) => {
        const visible = fileInfo === info;
        info.root.visible = visible;
        info.elem.className = visible ? 'selected' : '';
      });
      requestRenderIfNotRequested();
    }

    const uiElem = document.querySelector('#ui');
    fileInfos.forEach((info) => {
      const boxes = addBoxes(info.file, info.hueRange);
      info.root = boxes;
      const div = document.createElement('div');
      info.elem = div;
      div.textContent = info.name;
      uiElem.appendChild(div);
      div.addEventListener('mouseover', () => {
        showFileInfo(fileInfos, info);
      });
    });
    // show the first set of data
    showFileInfo(fileInfos, fileInfos[0]);

もう1つ変更が必要で `addBoxes` の引数に `hueRange` があります。

    -function addBoxes(file) {
    +function addBoxes(file, hueRange) {

      ...

        // compute a color
    -    const hue = THREE.MathUtils.lerp(0.7, 0.3, amount);
    +    const hue = THREE.MathUtils.lerp(...hueRange, amount);

      ...

これで4つのデータセットを表示できるようになるはずです。ラベルの上にマウスを置いたり、タッチしてデータセットを切り替える事ができます。

ここをクリックして別のウィンドウで開きます

注意してほしいのは突出したいくつかの奇妙なデータポイントがあります。

これは何が起きてるのでしょう！？

いずれにしてもこの4つのデータセットをラベルから切り替えた際にクロスフェードアニメーションさせるにはどうすればいいのでしょうか。

たくさんのアイデアがあります。

- `Material.opacity` でクロスフェードアニメーションする

  この解決策の問題点はキューブが完全に重なっているため、Z軸の戦いの問題を意味します。 depth関数とブレンディングを使い修正できる可能性があります。調べてみた方が良さそうですね。

- 見たいデータセットをスケールアップして他のデータセットをスケールダウンする

  全てのボックスは惑星の中心に位置しているので、1.0以下に縮小すると惑星の中に沈んでしまいます。 最初は良いアイデアのように聞こえますが、高さの低いボックスはほとんどすぐに消えてしまい、新しいデータセットが1.0までスケールアップするまで置き換えできません。 このため、アニメーション遷移があまり気持ち良くありません。派手なカスタムシェーダーで修正できるかもしれません。

- モーフターゲットを使用する

  モーフターゲットはジオメトリ内の各頂点に複数の値を与え、それらの中間を モーフ または lerp (線形補間) する方法です。 モーフターゲットは3Dキャラクターの表情アニメーションに最も一般的に使用されていますがそれだけではありません。

モーフターゲットを使ってみましょう。

これまで通りにデータセットごとにジオメトリを作成しますが、それぞれのデータから `position` を抜き出してモーフターゲットとして使用します。

まず `addBoxes` を変更してマージされたジオメトリを返すだけに変更してみましょう。

    -function addBoxes(file, hueRange) {
    +function makeBoxes(file, hueRange) {
      const {min, max, data} = file;
      const range = max - min;

      ...

    -  const mergedGeometry = BufferGeometryUtils.mergeGeometries(
    -      geometries, false);
    -  const material = new THREE.MeshBasicMaterial({
    -    vertexColors: true,
    -  });
    -  const mesh = new THREE.Mesh(mergedGeometry, material);
    -  scene.add(mesh);
    -  return mesh;
    +  return BufferGeometryUtils.mergeGeometries(
    +     geometries, false);
    }

ここでもう1つやるべき事があります。モーフターゲットは全ての頂点数が全く同じである必要があります。 あるターゲットの頂点#123は、他の全てのターゲットに対応する頂点#123を持つ必要があります。 しかし、異なるデータセットにはデータのないデータポイントがあるかもしれないので、 そのポイントに対してはボックスが生成されず、別のデータセットに対応する頂点も生成されません。

そこで全てのデータセットをチェックし、どのセットにもデータがある場合は常に何かを生成するか、 またはどのセットにもデータがない場合は何も生成しないかのどちらかを選択する必要があります。後者をやってみましょう。

    +function dataMissingInAnySet(fileInfos, latNdx, lonNdx) {
    +  for (const fileInfo of fileInfos) {
    +    if (fileInfo.file.data[latNdx][lonNdx] === undefined) {
    +      return true;
    +    }
    +  }
    +  return false;
    +}

    -function makeBoxes(file, hueRange) {
    +function makeBoxes(file, hueRange, fileInfos) {
      const {min, max, data} = file;
      const range = max - min;

      ...

      const geometries = [];
      data.forEach((row, latNdx) => {
        row.forEach((value, lonNdx) => {
    +      if (dataMissingInAnySet(fileInfos, latNdx, lonNdx)) {
    +        return;
    +      }
          const amount = (value - min) / range;

      ...

`addBoxes` を呼び出していたコードを `makeBoxes` に変更し、モーフターゲットを設定します。

    +// make geometry for each data set
    +const geometries = fileInfos.map((info) => {
    +  return makeBoxes(info.file, info.hueRange, fileInfos);
    +});
    +
    +// use the first geometry as the base
    +// and add all the geometries as morphtargets
    +const baseGeometry = geometries[0];
    +baseGeometry.morphAttributes.position = geometries.map((geometry, ndx) => {
    +  const attribute = geometry.getAttribute('position');
    +  const name = `target${ndx}`;
    +  attribute.name = name;
    +  return attribute;
    +});
    +baseGeometry.morphAttributes.color = geometries.map((geometry, ndx) => {
    +  const attribute = geometry.getAttribute('color');
    +  const name = `target${ndx}`;
    +  attribute.name = name;
    +  return attribute;
    +});
    +const material = new THREE.MeshBasicMaterial({
    +  vertexColors: true,
    +});
    +const mesh = new THREE.Mesh(baseGeometry, material);
    +scene.add(mesh);

    const uiElem = document.querySelector('#ui');
    fileInfos.forEach((info) => {
    -  const boxes = addBoxes(info.file, info.hueRange);
    -  info.root = boxes;
      const div = document.createElement('div');
      info.elem = div;
      div.textContent = info.name;
      uiElem.appendChild(div);
      function show() {
        showFileInfo(fileInfos, info);
      }
      div.addEventListener('mouseover', show);
      div.addEventListener('touchstart', show);
    });
    // show the first set of data
    showFileInfo(fileInfos, fileInfos[0]);

上記では最初のデータセットをベースとしたジオメトリを作成し、各ジオメトリから `position` を取得し、 それを `position` のベースジオメトリにモーフターゲットとして追加します。 あとはデータセットの表示・非表示の仕方を変える必要があります。 メッシュを表示・非表示するのではなく、モーフターゲットの影響を変える必要があります。 見たいデータセットは1の影響を持つ必要があり、見たくないデータセットは0の影響を持つ必要があります。

直接0か1にすれば良いのですがそうするとクロスフェードアニメーションが見られなくなり、すでに持っている値に変更がなくスナップします。 または簡単にカスタムアニメーションのコードを書く事ができますが、 オリジナルのwebgl globeではアニメーションライブラリを使っているので合わせましょう。

アニメーションライブラリをimportする必要があります。

    import * as THREE from 'three';
    import * as BufferGeometryUtils from 'three/addons/utils/BufferGeometryUtils.js';
    import {OrbitControls} from 'three/addons/controls/OrbitControls.js';
    +import TWEEN from 'three/addons/libs/tween.module.js';

そして、影響を与えるアニメーションの `Tween` を作成します。

    // show the selected data, hide the rest
    function showFileInfo(fileInfos, fileInfo) {
      fileInfos.forEach((info) => {
        const visible = fileInfo === info;
    -    info.root.visible = visible;
        info.elem.className = visible ? 'selected' : '';
    +    const targets = {};
    +    fileInfos.forEach((info, i) => {
    +      targets[i] = info === fileInfo ? 1 : 0;
    +    });
    +    const durationInMs = 1000;
    +    new TWEEN.Tween(mesh.morphTargetInfluences)
    +      .to(targets, durationInMs)
    +      .start();
      });
      requestRenderIfNotRequested();
    }

レンダリングループ内でフレームごとに `TWEEN.update` を呼び出しますが問題があります。 "tween.js"は連続的なレンダリング用に設計されていますが、ここでは要求されたレンダリングをしています。 連続的なレンダリングに切り替えれますが、何も起きていない時にはレンダリングコストを下げた方が良いため、要求されたレンダリングだけにするのもいいかもしれません。 これを助けるために `TweenManager` を作ります。 TweenManagerは `update` メソッドを持ち、再度呼び出す必要がある場合は `true` を返し、全てのアニメーションが終了した場合は `false` を返します。

    class TweenManger {
      constructor() {
        this.numTweensRunning = 0;
      }
      _handleComplete() {
        --this.numTweensRunning;
        console.assert(this.numTweensRunning >= 0);
      }
      createTween(targetObject) {
        const self = this;
        ++this.numTweensRunning;
        let userCompleteFn = () => {};
        // create a new tween and install our own onComplete callback
        const tween = new TWEEN.Tween(targetObject).onComplete(function(...args) {
          self._handleComplete();
          userCompleteFn.call(this, ...args);
        });
        // replace the tween's onComplete function with our own
        // so we can call the user's callback if they supply one.
        tween.onComplete = (fn) => {
          userCompleteFn = fn;
          return tween;
        };
        return tween;
      }
      update() {
        TWEEN.update();
        return this.numTweensRunning > 0;
      }
    }

TweenMangerを使用するために次のようなコードにします。

    function main() {
      const canvas = document.querySelector('#c');
      const renderer = new THREE.WebGLRenderer({antialias: true, canvas});
    +  const tweenManager = new TweenManger();

      ...

TweenMangerを使って `Tween` を作成します。

    // show the selected data, hide the rest
    function showFileInfo(fileInfos, fileInfo) {
      fileInfos.forEach((info) => {
        const visible = fileInfo === info;
        info.elem.className = visible ? 'selected' : '';
        const targets = {};
        fileInfos.forEach((info, i) => {
          targets[i] = info === fileInfo ? 1 : 0;
        });
        const durationInMs = 1000;
    -    new TWEEN.Tween(mesh.morphTargetInfluences)
    +    tweenManager.createTween(mesh.morphTargetInfluences)
          .to(targets, durationInMs)
          .start();
      });
      requestRenderIfNotRequested();
    }

次にtweenManagerを更新するためにレンダーループを修正し、アニメーションが実行されている場合はレンダリングを継続します。

    function render() {
      renderRequested = false;

      if (resizeRendererToDisplaySize(renderer)) {
        const canvas = renderer.domElement;
        camera.aspect = canvas.clientWidth / canvas.clientHeight;
        camera.updateProjectionMatrix();
      }

    +  if (tweenManager.update()) {
    +    requestRenderIfNotRequested();
    +  }

      controls.update();
      renderer.render(scene, camera);
    }
    render();

そして、データセットでクロスフェードアニメーションを行う必要があります。

ここをクリックして別のウィンドウで開きます

これがお役に立てれば幸いです。 three.jsが提供するサービスを利用するか、カスタムシェーダーを使ってモーフターゲットを使うのは多くのオブジェクトを移動させるための一般的なテクニックです。 例として全てのキューブに別の目標を設定し、そこから地球上での最初の位置へと変化します。 地球儀を紹介するにはかっこいいかもしれません。

次はHTML要素を3Dに整列させるで説明している地球儀にラベルを追加します。

注: 男性や女性の割合、または正の差をグラフ化する事もできますが、情報を表示する方法に基づいて地表から成長するキューブはほとんどのキューブが低い方が良いでしょう。 これらの他の比較を使用した場合、ほとんどのキューブは最大高さの約1/2の大きさになり可視化として良くありません。 `amountGreaterThan` を変えたように感じますが、このような場合は `Math.max(a - b, 0)` を `(a - b)` "正の差" や `a / (a +b)` "パーセント" のようなものに変えると何を言っているのかわかるでしょう。