Three.jsのおかげでブラウザで手軽に3D表現を使えるようになりました。

仕組み的にはWebGLという仕組みを使っているのですが、 直接コードを書くにはWeb言語しか触ったことない人間には少々辛いのが現実です。

それを楽に書けるようにラッパーとして存在しているのがThree.jsですね。

がっつりと3Dゲームや映像を作ることもできますし、 オリジナルモデルとかも読み込んで描写することも可能です。

JavaScript(TypeScriptも可)で書けるのでWeb系の人であれば簡単に書けてしまいます。

ですがWebGLについての知識が乏しいと、いつものように書いていると重たくなってしまうのも現実です。

といってもWebデザインの一部に組み込むことであれば容易ですし、 無茶な表現でなければそこまで重たくなりません。

とりあえずはThree.jsに慣れるためにWebデザインの一部として3D表現をできるようにしてみましょう。

Reactを併用するreact-three-fiberというReactでThree.jsを使うためのラッパーライブラリがあるのですが、 今回はシンプルにThree.jsをTypeScriptで書くことを主体に進めていきます。

今回使用する環境は

以上です。

Webpackはブラウザで理解できるようにしてもらう為に使います。

three.jsとTypeScriptとWebpackを導入

まずは必要なものをインストールしましょう。

yarn add three
yarn add -D webpack webpack-cli webpack-dev-server typescript ts-loader @types/node @types/three

次にwebpack.config.jsをルートに手動で作成します。

windowsだとwebpack init がなぜか動かず何回やってもwebpack-cliをグローバルに入れろって言われ 入れても入れろと言われるので恐らく環境によっては出来ないかもしれません。

なのでいつも通り手動で作ります。

// pathモジュールの読み込み
const path = require("path");

module.exports = {
  // モードを開発モードにする
  mode: "development",
  // 入力ファイル設定
  entry: [path.resolve(__dirname, "./src/index.ts")],
  // 出力ファイル設定
  output: {
    // 出力されるファイル名
    filename: "bundle.js",
    // 出力先ディレクトリ
    path: path.resolve(__dirname, "dist")
  },

  // モジュール設定
  module: {
    rules: [
      {
        // ts-loaderの設定
        test: /\.(js|ts|tsx)?$/,
        use: "ts-loader",
        exclude: /node_modules/
      },
    ]
  },
  // モジュール解決
  resolve: {
    extensions: [".ts", ".js", ".json"]
  },

  // 開発モード設定
  devtool: "source-map",
  devServer: {
    contentBase: "./dist"
  }
};

create-react-appを使わない時に作ったやつからtsxをtsにしただけです。

webpackに関してはこれでOKですね。

次にTypeScriptのtsconfig.jsonを設定します。

.\node_modules\.bin\tsc --init

これでtsconfig.jsonが自動生成されます。

もちろん手動で作っても大丈夫です。

生成されたら以下なファイルが出来上がっています。

{
  "compilerOptions": {
    /* Basic Options */
    // "incremental": true,                   /* Enable incremental compilation */
    "target": "es5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
    // "lib": [],                             /* Specify library files to be included in the compilation. */
    // "allowJs": true,                       /* Allow javascript files to be compiled. */
    // "checkJs": true,                       /* Report errors in .js files. */
    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
    // "outFile": "./",                       /* Concatenate and emit output to single file. */
    // "outDir": "./",                        /* Redirect output structure to the directory. */
    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
    // "composite": true,                     /* Enable project compilation */
    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
    // "removeComments": true,                /* Do not emit comments to output. */
    // "noEmit": true,                        /* Do not emit outputs. */
    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */

    /* Strict Type-Checking Options */
    "strict": true,                           /* Enable all strict type-checking options. */
    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
    // "strictNullChecks": true,              /* Enable strict null checks. */
    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */

    /* Additional Checks */
    // "noUnusedLocals": true,                /* Report errors on unused locals. */
    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */

    /* Module Resolution Options */
    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
    // "typeRoots": [],                       /* List of folders to include type definitions from. */
    // "types": [],                           /* Type declaration files to be included in compilation. */
    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */

    /* Source Map Options */
    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

    /* Experimental Options */
    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */

    /* Advanced Options */
    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
  }
}

めちゃくちゃ項目がありますが、正直使うのは限られているので必要なものだけ抜き出したのが以下になります。

{
  "compilerOptions": {
    "target": "es5",
    "module": "es2015",
    "types":["node"],
    "lib": [
      "es2019",
      "dom"
    ],
    "allowJs": true, // jsコンパイル用
    "checkJs": true,  // js簡易型チェック
    "sourceMap": true,
    "inlineSources": true,
    "outDir": "./dist/",
    "noImplicitAny": true,
    "allowSyntheticDefaultImports": true,
    "moduleResolution": "node"
  }
}

tsconfigの設定を日本語訳してくださっている方がいますので、 お好みの設定を有効にしても大丈夫です。

tsconfig 日本語訳 https://qiita.com/alfas/items/539ade65926deb530e0e

特にこだわりや判らないという方は私と同じにしておいてください。

あまりチェックをガチガチにするとTypeScriptを理解してないと無駄に時間を食ってしまいますので、 自分の力に合わせて設定ファイルを固めてみましょう。

three.jsをとりあえず書いて動かしてみる

それではthree.jsを動かすためにファイルを書いていきましょう。

まずはdistディレクトリとsrcディレクトリを作ります。

mkdir dist
mkdir src

windowsってまとめて同じ階層にディレクトリ作るコマンドってどうやるんですかね……

ディレクトリを作り終わったら、次にdistにwebpackで出力したjsファイルを読み込むためのhtmlを作ります。

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>three-ts</title>
  </head>
  <body>
    <script src="bundle.js"></script>
  </body>
</html>

それではさっそくthree.jsを組んでいきましょう。

まずはわかりやすいようにjavascriptのES6記法で行きます。

公式のチュートリアルに添っていきましょう。

Import via modules https://threejs.org/docs/index.html#manual/en/introduction/Import-via-modules

import * as THREE from 'three';

const scene = new THREE.Scene();

特に何も表示されませんが、動かせるかどうかのチェックです。

問題なくコンパイル出来たら次に進みましょう。

typescriptでキューブを描写してみる

一番シンプルなキューブを描写して回転させるプログラムを書いてみましょう。

手順としては

といった感じです。

って思うけど3Dを動かすというのは思った以上に面倒くさいのです。

0から組んでいこうとすると行列の計算や複雑な数学の知識が必要になるので THREE.jsの恩恵を感じながら組んでいきましょう。

以下ソースになります。

// three.jsライブラリのインポート
import * as THREE from 'three';


window.addEventListener('DOMContentLoaded', () => {

  // レンダラーを作成
  const renderer:THREE.WebGLRenderer = new THREE.WebGLRenderer();
  // レンダラーのサイズを設定
  renderer.setSize(640,480);
  // canvasをbodyに追加
  document.body.appendChild(renderer.domElement);

  // シーンの作成
  const scene:THREE.Scene = new THREE.Scene();

  // カメラを作成
  const camera:THREE.PerspectiveCamera = new THREE.PerspectiveCamera(45, 640/480, 1, 10000);
  camera.position.set(0,0,1000);

  // キューブの作成
  // -----------------------
  // ボックスジオメトリを生成
  const geometry:THREE.BoxGeometry       = new THREE.BoxGeometry( 100, 100, 100 );
  // マテリアルを生成
  const material:THREE.MeshPhongMaterial = new THREE.MeshPhongMaterial( {color: 0x00ff00} );
  // 上記のボックスジオメトリとマテリアルを使ってメッシュを生成
  const cube:THREE.Mesh                  = new THREE.Mesh( geometry, material );

  // シーンにキューブを追加
  scene.add( cube );

  // 平行光源を生成
  const light:THREE.DirectionalLight = new THREE.DirectionalLight(0xffffff);
  // 光源の位置を設定
  light.position.set(1,1,1);
  // シーンに光源を追加
  scene.add(light);


  // 毎フレーム更新関数
  const tick = ():void => {
        // 一定間隔で処理を繰り返す(引数に関数名を渡す)
    requestAnimationFrame(tick);
    // キューブの回転を変更
    cube.rotation.x += 0.01;
    cube.rotation.y += 0.01;
    cube.rotation.z += 0.01;

    // 描画
    renderer.render(scene, camera);
  }

  // 毎フレーム更新関数を実行
  tick();

});

コンパイルすると緑のキューブが回転しているのがわかると思います。

光源やキューブの設定・回転等いろいろ数値をいじくってみて 何所が変わるのかを確かめてみるとよくわかります。

THREE.jsは一筋縄ではいかないので、少しずつ学んでいきましょう。

目標はWebページに良い感じ3D背景を実装するところにします。

それでは！