DOMMatrix: 2D / 3D 変形(アフィン変換)の行列を扱う DOM API

2021/05/18
このエントリーをはてなブックマークに追加

はじめに

null です。 図面(PDF や画像)を共有して注釈でコミュニケーションする Web アプリ を開発しております。

DOM 要素をアフィン変換(移動・拡縮・回転・剪断)するには CSS の transform プロパティSVG の transform 属性 を使うと思います。 translate, scale, rotate をそれぞれ 個別の CSS プロパティとする提案 もあり、すでに Firefox と Safari でサポートされています。

図形を扱う Web アプリを作っていると、 CSS transform で実現できる DOM 要素の変形だけでなく、スクリプトでも座標変換したいケースが出てきます。たとえば次のアニメーションのように、回転させた図形をリサイズしたい場合。リサイズを CSS transform や SVG transform の拡縮で実現すると線の太さが変わってしまうので、リサイズは座標計算で実現したいところです。回転行列とポインターの移動量から新たな座標とサイズを算出するにあたり、行列演算がほしくなります。

図形の回転とリサイズ
図形の回転とリサイズ

行列による座標変換の計算には、ブラウザーに組み込まれている DOMMatrix が使えます。ごく一般的な行列演算であればサードパーティライブラリは不要です。

DOMMatrix

コード例を見るのが早いと思います。

// 次の順に座標変換を適用するのと同等の行列を生成します。
//  1. 左へ 20px、上へ 30px、手前へ 50px 移動
//  2. 時計回りに 90° 回転
//  3. 上下左右へ 2 倍に拡大
// (一般に行列 X と Y による座標変換をこの順で適用するのと同等の行列は積 YX で求められます、順序に注意してください。)
const matrix = new DOMMatrix()
  .scaleSelf(2)
  .rotateSelf(0, 0, 90)
  .translateSelf(-20, -30, 50)

// 座標 (100, 150, 200) に座標変換を適用します。
const transformed = matrix.transformPoint({ x: 100, y: 150, z: 200 })

console.log(transformed)
// -> DOMPoint {x: -240, y: 160.00000000000003, z: 250, w: 1}

DOMMatrixReadOnlyDOMMatrix は 4×4 行列を表します。 m11 プロパティで (1, 1) 成分、 m12 プロパティで (1, 2) 成分、…、 m44 プロパティで (4, 4) 成分にアクセスできます。 DOMMatrixReadOnly は名前のとおり読み取り専用で、各プロパティ値を設定できず、自身を変更するメソッドを持ちません。 DOMMatrixDOMMatrixReadOnly を継承し、各プロパティの setter や scaleSelf() などの自身を変更するメソッドを持ちます。
https://triple-underscore.github.io/geometry-ja.html#DOMMatrix

m11 m21 m31 m41
m12 m22 m32 m42
m13 m23 m33 m43
m14 m24 m34 m44

2D 変形では m11, m12, m21, m22, m41, m42 だけを扱います。この 6 つの成分は特別に a, b, c, d, e, f プロパティでアクセスできます。この 6 つ以外の成分が単位行列に一致するときは is2D プロパティが true になります。

a c 0 e
b d 0 f
0 0 1 0
0 0 0 1

DOMMatrixReadOnlyDOMMatrix でできる操作を見ていきましょう。

DOMMatrixReadOnly/DOMMatrix 初期化

コード例は DOMMatrix で記述しますが、 DOMMatrixReadOnly でも同じように使えます。

// 単位行列
new DOMMatrix()

// 2D 変形用の 2×3 行列: 6 要素の配列 [a, b, c, d, e, f]
new DOMMatrix([1, 2, 3, 4, 5, 6])

// 3D 変形用の 4×4 行列: 16 要素の配列 [m11, m12, ..., m44]
new DOMMatrix([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16])

// CSS transform で有効な文字列
new DOMMatrix('matrix(1,2,3,4,5,6)')
new DOMMatrix('matrix3d(1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16)')
new DOMMatrix('translate(10px,20px)')
new DOMMatrix('translate3d(10px,20px,30px)')
new DOMMatrix('scale(2)')
new DOMMatrix('rotate(45deg)')
new DOMMatrix('rotateX(45deg)')
new DOMMatrix('skewX(30deg)')

// 座標 (10, 20) を中心に時計回りに 45° 回転
new DOMMatrix('translate(10px,20px) rotate(45deg) translate(-10px,-20px)')

// プロパティ(の一部)直接指定
DOMMatrix.fromMatrix({ a: 1, b: 2, c: 3, d: 4, e: 5, f: 6 })
DOMMatrix.fromMatrix({ m44: 16 })

// 型付き配列(6 要素 または 16 要素)
DOMMatrix.fromFloat32Array(Float32Array.of(1, 2, 3, 4, 5, 6))
DOMMatrix.fromFloat64Array(Float64Array.of(1, 2, 3, 4, 5, 6))

DOMMatrixReadOnly インスタンスメソッド(DOMMatrix でも利用可)

ここで紹介するメソッドのすべての引数は省略可能です。特筆しない限りデフォルト引数は行列なら単位行列、座標・移動量・回転角なら 0、拡大率なら 1 です。

transformPoint() は新しい DOMPoint インスタンス(後述)を返します。 transformPoint() 以外のメソッドは新しい DOMMatrix インスタンスを返します(DOMMatrixReadOnly ではありません)。

const m = new DOMMatrixReadOnly()

// 逆行列
m.inverse()

// 積
m.multiply(anotherMatrix)

// 平行移動
m.translate(tx, ty, tz)


// 拡大縮小、 デフォルト引数は scaleX: 1, scaleY: scaleX, scaleZ: 1, 他は 0
// (引数 2 つ以上なら軸ごとに異なる倍率で拡縮、引数 1 つなら xy 方向に同じ倍率で拡縮)
m.scale(scaleX, scaleY, scaleZ, originX, originY, originZ)

// m.scale(scale, scale, scale, originX, originY, originZ) と同じ
m.scale3d(scale, originX, originY, originZ)

// 非推奨、 m.scale(scaleX === undefined ? 1 : scaleX, scaleY === undefined ? 1 : scaleY) と同じ
m.scaleNonUniform(scaleX, scaleY)


// xyz 軸まわりの回転: x, y, z 軸まわりに、この順で、それぞれ rotX, rotY, rotZ (単位は度)だけ時計回りに回転
m.rotate(rotX, rotY, rotZ)

// 任意の軸まわりの回転: (x, y, z) 方向を回転軸として angle (単位は度)だけ時計回りに回転
m.rotateAxisAngle(x, y, z, angle)

// (1, 0) 方向から (x, y) 方向への回転角だけ x 軸まわりに回転
// m.rotate(Math.atan2(y, x) * 180 / Math.PI) と同じ
// たとえば (1, 1) なら 45° で m.rotate(45) と同じ
m.rotateFromVector(x, y)


// 水平剪断
// https://developer.mozilla.org/docs/Web/CSS/transform-function/skewX()
m.skewX(sx)

// 鉛直剪断
// https://developer.mozilla.org/docs/Web/CSS/transform-function/skewY()
m.skewY(sy)


// 点の座標変換、デフォルト引数は x: 0, y: 0, z: 0, w: 1
m.transformPoint({ x, y, z, w })

DOMMatrix インスタンスメソッド

いずれも this 自身を変更して this 自身を返します。

const m = new DOMMatrix()

// DOMMatrixReadOnly の `Self` が付かない各メソッドと同等の演算により自身を変更
m.multiplySelf(anotherMatrix)
m.translateSelf(tx, ty, tz)
m.scaleSelf(scaleX, scaleY, scaleZ, originX, originY, originZ)
m.scale3dSelf(scale, originX, originY, originZ)
m.rotateSelf(rotX, rotY, rotZ)
m.rotateAxisAngleSelf(x, y, z, angle)
m.rotateFromVectorSelf(x, y)
m.skewXSelf(sx)
m.skewYSelf(sy)

// 逆行列
m.invertSelf()

// 左からの積
m.preMultiplySelf(anotherMatrix)

// CSS transform で有効な文字列のパース
m.setMatrixValue('matrix(1,2,3,4,5,6)')
m.setMatrixValue('translate(10px,20px) rotate(45deg) translate(-10px,-20px)')

DOMPoint

DOMPointReadOnlyDOMPointx y z 軸の各座標と視座 w で点を表します。 DOMPointReadOnly は名前のとおり読み取り専用で、各プロパティ値を設定できません。 DOMPointDOMPointReadOnly を継承し、各プロパティの setter を持ちます。
https://triple-underscore.github.io/geometry-ja.html#DOMPoint

行列による座標変換 API として DOMMatrixReadOnly.prototype.transformPoint({ x, y, z, w }) を紹介しましたが、 DOMPointReadOnly.prototype.matrixTransform(matrix) でも同じことができます。違いは this と引数の型の縛りです。 transformPointthis として DOMMatrixReadOnly を継承したオブジェクトが必要で、引数は座標ライクなオブジェクト(x, y, z, w プロパティが影響)(省略可)です。 matrixTransform()this として DOMPointReadOnly を継承したオブジェクトが必要で、引数は行列ライクなオブジェクト(a, …, f, m11, …, m44 プロパティが影響)(省略可)です。私は基本的に transformPoint({ x, y, z }) を使えば良いと思っています: どうせ DOMMatrix は作るので DOMPoint を作らずに済む方がラクですし、行列を構築するメソッドチェインから流れるように座標変換できて読みやすいからです。

WebKitCSSMatrix と MSCSSMatrix

もしあの IE で行列が使いたくなったらどうしましょう? IE 10+ には MSCSSMatrix があります。

DOMMatrix が標準化されるより前、 Safari と Chrome には WebKitCSSMatrix という名前で現在の DOMMatrixReadOnly の機能の一部が実装されていました。下記リンクから当時のインターフェイスを参照できます。現在では Safari も Chrome も WebKitCSSMatrixDOMMatrix のエイリアスになっています。今後わざわざ WebKitCSSMatrix を使う機会はないでしょう。

IE 10+ に組み込まれている MSCSSMatrixWebKitCSSMatrix と同様のインターフェイスを持ちます。 transformPoint() がないので、点を座標変換するには行列同士の積 multiply() を使います。

const Matrix = window.DOMMatrix || window.MSCSSMatrix

const matrix = new Matrix()
  .scale(2)
  .rotate(0, 0, 90)
  .translate(-20, -30, 50)

const point = new Matrix()
point.e = 100   // x
point.f = 150   // y
point.m43 = 200 // z

const transformed = matrix.multiply(point)
console.log(transformed.e, transformed.f, transformed.m43)
// -> -240 160.00000000000003 250

Can I use で DOMMatrix の歴史が垣間見られます。
https://caniuse.com/dommatrix

SVGMatrix

SVGMatrix は 2D 変形用の 2×3 行列です。 IE 9+ で使えます。 a, b, c, d, e, f プロパティはありますが m11, m12, …, m44 プロパティはありません。 DOMMatrixReadOnly が持つメソッドの一部が同じ名前で使えます(次のリンク先参照)。
https://triple-underscore.github.io/SVG11/coords.html#InterfaceSVGMatrix

SVGMatrix は MDN に Deprecated と明記されています。 SVG 1.1 では SVGMatrix を使う仕様だったインターフェイスが SVG 2 では DOMMatrixDOMMatrixReadOnly を使うよう変更されていますSVGGraphicsElement.prototype.getScreenCTMSVGTransform.prototype.matrix など)。が、現在の主要ブラウザー(Chrome 91, Firefox 88, Safari 14.1, IE 11)はいずれも DOMMatrix ではなく SVGMatrix を利用する実装になっています。(もしかしたら後方互換性のためにずっとこのままかもしれませんね。)

SVGMatrix は下記例のとおり DOMMatrix に比べると扱いづらいです。 DOMMatrix が使える場面では DOMMatrix を使いましょう。必要なら DOMMatrix.fromMatrix()SVGMatrix から DOMMatrix を生成できます。

const svg = document.createElementNS('http://www.w3.org/2000/svg', 'svg')

// SVGMatrix インスタンスは new SVGMatrix() では生成できず SVGSVGElement インスタンスが必要、
// しかも生成時に初期化できない(createSVGMatrix() は引数を取らない)
const svgMatrix = svg
  .createSVGMatrix()
  .scale(2)
  .rotate(0, 0, 90)
  .translate(-20, -30)

// SVGPoint インスタンスは new SVGPoint() では生成できず SVGSVGElement インスタンスが必要、
// しかも生成時に初期化できない(createSVGPoint() は引数を取らない)
const svgPoint = svg.createSVGPoint()
svgPoint.x = 100
svgPoint.y = 150

// transformPoint() がないので matrixTransform() を使う
const transformed = svgPoint.matrixTransform(svgMatrix)

// DOMMatrix に変換した方が扱いやすいかもしれない
DOMMatrix.from(svgMatrix).transformPoint({ x: 100, y: 150 })

// DOMPointReadOnly.prototype.matrixTransform() の引数は SVGMatrix でも OK
new DOMPoint(100, 150).matrixTransform(svgMatrix)

TypeScript 使用上の注意:
SVGMatrix の IDL 属性は DOMMatrix より少ないのですが、 TypeScript 4.2.4 現在、 lib.dom.d.ts の SVGMatrix 型定義type SVGMatrix = DOMMatrix と記述されており、実際の SVGMatrix にないメンバーを使ってもコンパイルが通ってしまいます(補完候補としても出てきてしまいます)。

まとめ

座標変換のための行列を扱う DOMMatrix とその周辺の API を紹介しました。

その他の記事

Other Articles

2021/09/16
[ECMAScript] Pipe operator 論争まとめ – F# か Hack か両方か

2021/07/05
TypeScript v4.3 の機能を使って immutable ライブラリの型付けを頑張る

2021/06/25
Denoでwasmを動かすだけの話

2021/03/29
GoのWASMがライブラリではなくアプリケーションであること

2021/03/26
Pythonプロジェクトの共通のひな形を作る

2021/03/25
インラインスタイルと Tailwind CSS と Tailwind CSS 入力補助ライブラリと Tailwind CSS in JS

2021/03/23
Serverless NEGを使ってApp Engineにカスタムドメインをワイルドカードマッピング

2021/01/07
esbuild の機能が足りないならプラグインを自作すればいいじゃない

2020/08/26
TypeScriptで関数の部分型を理解しよう

2020/06/16
[Web フロントエンド] esbuild が爆速すぎて webpack / Rollup にはもう戻れない

2020/03/19
[Web フロントエンド] Elm に心折れ Mint に癒しを求める

2020/02/28
さようなら、TypeScript enum

2020/02/14
受付のLooking Glassに加えたひと工夫

2020/01/28
カブクエンジニア開発合宿に行ってきました 2020冬

2020/01/30
Renovateで依存ライブラリをリノベーションしよう 〜 Bitbucket編 〜

2019/12/27
Cloud Tasks でも deferred ライブラリが使いたい

2019/12/25
*, ::before, ::after { flex: none; }

2019/12/21
Top-level awaitとDual Package Hazard

2019/12/20
Three.jsからWebGLまで行きて帰りし物語

2019/12/18
Three.jsに入門+手を検出してAR.jsと組み合わせてみた

2019/12/04
WebXR AR Paint その2

2019/11/06
GraphQLの入門書を翻訳しました

2019/09/20
Kabuku Connect 即時見積機能のバックエンド開発

2019/08/14
Maker Faire Tokyo 2019でARゲームを出展しました

2019/07/25
夏休みだョ!WebAssembly Proposal全員集合!!

2019/07/08
鵜呑みにしないで! —— 書籍『クリーンアーキテクチャ』所感 ≪null 篇≫

2019/07/03
W3C Workshop on Web Games参加レポート

2019/06/28
TypeScriptでObject.assign()に正しい型をつける

2019/06/25
カブクエンジニア開発合宿に行ってきました 2019夏

2019/06/21
Hola! KubeCon Europe 2019の参加レポート

2019/06/19
Clean Resume きれいな環境できれいな履歴書を作成する

2019/05/20
[Web フロントエンド] 状態更新ロジックをフレームワークから独立させる

2019/04/16
C++のenable_shared_from_thisを使う

2019/04/12
OpenAPI 3 ファーストな Web アプリケーション開発(Python で API 編)

2019/04/08
WebGLでレイマーチングを使ったCSGを実現する

2019/04/02
『エンジニア採用最前線』に感化されて2週間でエンジニア主導の求人票更新フローを構築した話

2019/03/29
その1 Jetson TX2でk3s(枯山水)を動かしてみた

2019/03/27
任意のブラウザ上でJestで書いたテストを実行する

2019/02/08
TypeScript で “radian” と “degree” を間違えないようにする

2019/02/05
Python3でGoogle Cloud ML Engineをローカルで動作する方法

2019/01/18
SIGGRAPH Asia 2018 参加レポート

2019/01/08
お正月だョ!ECMAScript Proposal全員集合!!

2019/01/08
カブクエンジニア開発合宿に行ってきました 2018秋

2018/12/25
OpenAPI 3 ファーストな Web アプリケーション開発(環境編)

2018/12/23
いまMLKitカスタムモデル(TF Lite)は使えるのか

2018/12/21
[IoT] Docker on JetsonでMQTTを使ってCloud IoT Coreと通信する

2018/12/11
TypeScriptで実現する型安全な多言語対応(Angularを例に)

2018/12/05
GASでCompute Engineの時間に応じた自動停止/起動ツールを作成する 〜GASで簡単に好きなGoogle APIを叩く方法〜

2018/12/02
single quotes な Black を vendoring して packaging

2018/11/14
3次元データに2次元データの深層学習の技術(Inception V3, ResNet)を適用

2018/11/04
Node Knockout 2018 に参戦しました

2018/10/24
SIGGRAPH 2018参加レポート-後編(VR/AR)

2018/10/11
Angular 4アプリケーションをAngular 6に移行する

2018/10/05
SIGGRAPH 2018参加レポート-特別編(VR@50)

2018/10/03
Three.jsでVRしたい

2018/10/02
SIGGRAPH 2018参加レポート-前編

2018/09/27
ズーム可能なSVGを実装する方法の解説

2018/09/25
Kerasを用いた複数入力モデル精度向上のためのTips

2018/09/21
競技プログラミングの勉強会を開催している話

2018/09/19
Ladder Netwoksによる半教師あり学習

2018/08/10
「Maker Faire Tokyo 2018」に出展しました

2018/08/02
Kerasを用いた複数時系列データを1つの深層学習モデルで学習させる方法

2018/07/26
Apollo GraphQLでWebサービスを開発してわかったこと

2018/07/19
【深層学習】時系列データに対する1次元畳み込み層の出力を可視化

2018/07/11
きたない requirements.txt から Pipenv への移行

2018/06/26
CSS Houdiniを味見する

2018/06/25
不確実性を考慮した時系列データ予測

2018/06/20
Google Colaboratory を自分のマシンで走らせる

2018/06/18
Go言語でWebAssembly

2018/06/15
カブクエンジニア開発合宿に行ってきました 2018春

2018/06/08
2018 年の tree shaking

2018/06/07
隠れマルコフモデル 入門

2018/05/30
DASKによる探索的データ分析(EDA)

2018/05/10
TensorFlowをソースからビルドする方法とその効果

2018/04/23
EGLとOpenGLを使用するコードのビルド方法〜libGLからlibOpenGLへ

2018/04/23
技術書典4にサークル参加してきました

2018/04/13
Python で Cura をバッチ実行するためには

2018/04/04
ARCoreで3Dプリント風エフェクトを実現する〜呪文による積層造形映像制作の舞台裏〜

2018/04/02
深層学習を用いた時系列データにおける異常検知

2018/04/01
音声ユーザーインターフェースを用いた新方式積層造形装置の提案

2018/03/31
Container builderでコンテナイメージをBuildしてSlackで結果を受け取る開発スタイルが捗る

2018/03/23
ngUpgrade を使って AngularJS から Angular に移行

2018/03/14
Three.jsのパフォーマンスTips

2018/02/14
C++17の新機能を試す〜その1「3次元版hypot」

2018/01/17
時系列データにおける異常検知

2018/01/11
異常検知の基礎

2018/01/09
three.ar.jsを使ったスマホAR入門

2017/12/17
Python OpenAPIライブラリ bravado-core の発展的な使い方

2017/12/15
WebAssembly(wat)を手書きする

2017/12/14
AngularJS を Angular に移行: ng-annotate 相当の機能を TypeScrpt ファイルに適用

2017/12/08
Android Thingsで4足ロボットを作る ~ Android ThingsとPCA9685でサーボ制御)

2017/12/06
Raspberry PIとDialogflow & Google Cloud Platformを利用した、3Dプリンターボット(仮)の開発 (概要編)

2017/11/20
カブクエンジニア開発合宿に行ってきました 2017秋

2017/10/19
Android Thingsを使って3Dプリント戦車を作ろう ① ハードウェア準備編

2017/10/13
第2回 魁!! GPUクラスタ on GKE ~PodからGPUを使う編~

2017/10/05
第1回 魁!! GPUクラスタ on GKE ~GPUクラスタ構築編~

2017/09/13
「Maker Faire Tokyo 2017」に出展しました。

2017/09/11
PyConJP2017に参加しました

2017/09/08
bravado-coreによるOpenAPIを利用したPythonアプリケーション開発

2017/08/23
OpenAPIのご紹介

2017/08/18
EuroPython2017で2名登壇しました。

2017/07/26
3DプリンターでLチカ

2017/07/03
Three.js r86で何が変わったのか

2017/06/21
3次元データへの深層学習の適用

2017/06/01
カブクエンジニア開発合宿に行ってきました 2017春

2017/05/08
Three.js r85で何が変わったのか

2017/04/10
GCPのGPUインスタンスでレンダリングを高速化

2017/02/07
Three.js r84で何が変わったのか

2017/01/27
Google App EngineのFlexible EnvironmentにTmpfsを導入する

2016/12/21
Three.js r83で何が変わったのか

2016/12/02
Three.jsでのクリッピング平面の利用

2016/11/08
Three.js r82で何が変わったのか

2016/12/17
SIGGRAPH 2016 レポート

2016/11/02
カブクエンジニア開発合宿に行ってきました 2016秋

2016/10/28
PyConJP2016 行きました

2016/10/17
EuroPython2016で登壇しました

2016/10/13
Angular 2.0.0ファイナルへのアップグレード

2016/10/04
Three.js r81で何が変わったのか

2016/09/14
カブクのエンジニアインターンシッププログラムについての詩

2016/09/05
カブクのエンジニアインターンとして3ヶ月でやった事 〜高橋知成の場合〜

2016/08/30
Three.js r80で何が変わったのか

2016/07/15
Three.js r79で何が変わったのか

2016/06/02
Vulkanを試してみた

2016/05/20
MakerGoの作り方

2016/05/08
TensorFlow on DockerでGPUを使えるようにする方法

2016/04/27
Blenderの3DデータをMinecraftに送りこむ

2016/04/20
Tensorflowを使ったDeep LearningにおけるGPU性能調査

→
←

関連職種

Recruit

フロントエンドエンジニア(TypeScript)

業務内容

業務内容 当ポジションは弊社Webサービスのフロントエンド機能設計及び実装を担当します。 サービス毎の開発チー […]

→
←

お客様のご要望に「Kabuku」はお応えいたします。
ぜひお気軽にご相談ください。

お電話でも受け付けております
03-6380-2750
営業時間:09:30~18:00
※土日祝は除く