/
Object2D.ts
373 lines (339 loc) · 15.1 KB
/
Object2D.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
import type { CommonArea, CommonOffset, CommonSize, CompositeOperation, CompositeOperationString } from "@akashic/pdi-types";
import { ExceptionFactory } from "./ExceptionFactory";
import type { Matrix } from "./Matrix";
import { PlainMatrix } from "./Matrix";
/**
* `Object2D` のコンストラクタに渡すことができるパラメータ。
* 各メンバの詳細は `Object2D` の同名メンバの説明を参照すること。
*/
export interface Object2DParameterObject {
/**
* このオブジェクトの横位置。実際の座標位置はscaleX, scaleY, angle, anchorX, anchorYの値も考慮する必要がある。
* @default 0
*/
x?: number;
/**
* このオブジェクトの縦位置。実際の座標位置はscaleX, scaleY, angle, anchorX, anchorYの値も考慮する必要がある。
* @default 0
*/
y?: number;
/**
* このオブジェクトの横幅。実際の表示領域としてはscaleX, scaleY, angleの値も考慮する必要がある。
* @default 0
*/
width?: number;
/**
* このオブジェクトの縦幅。実際の表示領域としてはscaleX, scaleY, angleの値も考慮する必要がある。
* @default 0
*/
height?: number;
/**
* 0~1でオブジェクトの不透明度を表す。
* この値が0の場合、Rendererは描画処理を省略する。
* @default 1
*/
opacity?: number;
/**
* オブジェクトの横方向の倍率。
* @default 1
*/
scaleX?: number;
/**
* オブジェクトの縦方向の倍率。
* @default 1
*/
scaleY?: number;
/**
* オブジェクトの回転。度数で指定する。
* @default 0
*/
angle?: number;
/**
* 描画時の合成方法を指定する。
* 省略された場合、合成方法を指定しない(親の合成方法を利用する)。
* なお `CompositeOperation` での指定は非推奨である。 `CompositeOperationString` を利用すること。
* @default undefined
*/
compositeOperation?: CompositeOperation | CompositeOperationString;
/**
* オブジェクトのアンカーの横位置。アンカーについては以下の通り。
* * アンカーとして設定した箇所がこのオブジェクトの基点 (位置、拡縮・回転の基点) となる。
* * 単位は相対値 (左上端が (0, 0) 中央が (0.5, 0,5) 右下端が (1,1) ) である。
* 初期値は `0` である。
*
* NOTE: `anchorX` または `anchorY` のどちらかを明示的に `null` に指定した場合、
* このオブジェクトのアンカーは前バージョン(v2.x.x 以前)のデフォルトの挙動 (位置 `x`, `y` は左上端を基準に、拡大・縮小・回転の基点は中央を基準に決定) と同様になる。
* これは前バージョンとの後方互換性のために存在する。
* * @default 0
*/
anchorX?: number | null;
/**
* オブジェクトのアンカーの縦位置。アンカーについては以下の通り。
* * アンカーとして設定した箇所がこのオブジェクトの基点 (位置、拡縮・回転の基点) となる。
* * 単位は相対値 (左上端が (0, 0) 中央が (0.5, 0,5) 右下端が (1,1) ) である。
* 初期値は `0` である。
*
* NOTE: `anchorX` または `anchorY` のどちらを明示的に `null` に指定した場合、
* このオブジェクトのアンカーは前バージョン(v2.x.x 以前)のデフォルトの挙動 (位置 `x`, `y` は左上端を基準に、拡大・縮小・回転の基点は中央を基準に決定) と同様になる。
* これは前バージョンとの後方互換性のために存在する。
* * @default 0
*/
anchorY?: number | null;
}
/**
* 二次元の幾何的オブジェクト。位置とサイズ (に加えて傾きや透明度も) を持つ。
* ゲーム開発者は `E` を使えばよく、通常このクラスを意識する必要はない。
*/
export class Object2D implements CommonArea {
/**
* このオブジェクトの横位置。
* 初期値は `0` である。実際の座標位置はscaleX, scaleY, angle, anchorX, anchorYの値も考慮する必要がある。
* `E` や `Camera2D` においてこの値を変更した場合、 `modified()` を呼び出す必要がある。
*/
x: number;
/**
* このオブジェクトの縦位置。
* 初期値は `0` である。実際の座標位置はscaleX, scaleY, angle, anchorX, anchorYの値も考慮する必要がある。
* `E` や `Camera2D` においてこの値を変更した場合、 `modified()` を呼び出す必要がある。
*/
y: number;
/**
* このオブジェクトの横幅。
* 初期値は `0` である。実際の表示領域としてはscaleX, scaleY, angleの値も考慮する必要がある。
* `E` や `Camera2D` においてこの値を変更した場合、 `modified()` を呼び出す必要がある。
*/
width: number;
/**
* このオブジェクトの縦幅。
* 初期値は `0` である。実際の表示領域としてはscaleX, scaleY, angleの値も考慮する必要がある。
* `E` や `Camera2D` においてこの値を変更した場合、 `modified()` を呼び出す必要がある。
*/
height: number;
/**
* 0~1でオブジェクトの不透明度を表す。
* 初期値は `1` である。本値が0の場合、Rendererは描画処理を省略する。
* `E` においてこの値を変更した場合、 `modified()` を呼び出す必要がある。
*/
opacity: number;
/**
* オブジェクトの横方向の倍率。
* 初期値は `1` である。
* `E` や `Camera2D` においてこの値を変更した場合、 `modified()` を呼び出す必要がある。
*/
scaleX: number;
/**
* オブジェクトの縦方向の倍率。
* 初期値は `1` である。
* `E` や `Camera2D` においてこの値を変更した場合、 `modified()` を呼び出す必要がある。
*/
scaleY: number;
/**
* オブジェクトの回転。度数 (時計回り) で指定する。
* 初期値は `0` である。
* `E` や `Camera2D` においてこの値を変更した場合、 `modified()` を呼び出す必要がある。
*/
angle: number;
/**
* 描画時の合成方法を指定する。
* 初期値は `undefined` となり、合成方法を指定しないことを意味する。
* `E` においてこの値を変更した場合、 `modified()` を呼び出す必要がある。
*/
compositeOperation: CompositeOperation | CompositeOperationString | undefined;
/**
* オブジェクトのアンカーの横位置。アンカーについては以下の通り。
* * アンカーとして設定した箇所がこのオブジェクトの基点 (位置、拡縮・回転の基点) となる。
* * 単位は相対値 (左上端が (0, 0) 中央が (0.5, 0,5) 右下端が (1,1) ) である。
* 初期値は `0` である。
* `E` や `Camera2D` においてこの値を変更した場合、 `modified()` を呼び出す必要がある。
*
* NOTE: `anchorX` または `anchorY` のどちらを明示的に `null` に指定した場合、
* このオブジェクトのアンカーは前バージョン(v2.x.x 以前)のデフォルトの挙動 (位置 `x`, `y` は左上端を基準に、拡大・縮小・回転の基点は中央を基準に決定) と同様になる。
* これは前バージョンとの後方互換性のために存在する。
*/
anchorX: number | null;
/**
* オブジェクトのアンカーの縦位置。アンカーについては以下の通り。
* * アンカーとして設定した箇所がこのオブジェクトの基点 (位置、拡縮・回転の基点) となる。
* * 単位は相対値 (左上端が (0, 0) 中央が (0.5, 0,5) 右下端が (1,1) ) である。
* 初期値は `0` である。
* `E` や `Camera2D` においてこの値を変更した場合、 `modified()` を呼び出す必要がある。
*
* NOTE: `anchorX` または `anchorY` のどちらを明示的に `null` に指定した場合、
* このオブジェクトのアンカーは前バージョン(v2.x.x 以前)のデフォルトの挙動 (位置 `x`, `y` は左上端を基準に、拡大・縮小・回転の基点は中央を基準に決定) と同様になる。
* これは前バージョンとの後方互換性のために存在する。
*/
anchorY: number | null;
/**
* 変換行列のキャッシュ。 `Object2D` は状態に変更があった時、本値の_modifiedをtrueにする必要がある。
* 初期値は `undefined` であり、 `getMatrix()` によって必要な時に生成されるため、
* `if (this._matrix) this._matrix._modified = true` という式で記述する必要がある。
*
* エンジンに組み込まれているSprite等のエンティティ群は、
* すでに本処理を組み込んでいるため通常ゲーム開発者はこの値を意識する必要はない。
* `Object2D` を継承したクラスを新たに作る場合には、本フィールドを適切に操作しなければならない。
* @private
*/
_matrix: Matrix | undefined;
/**
* デフォルト値で `Object2D` のインスタンスを生成する。
*/
constructor();
/**
* 指定されたパラメータで `Object2D` のインスタンスを生成する。
* @param param 初期化に用いるパラメータのオブジェクト
*/
constructor(param: Object2DParameterObject);
constructor(param?: Object2DParameterObject) {
if (!param) {
this.x = 0;
this.y = 0;
this.width = 0;
this.height = 0;
this.opacity = 1;
this.scaleX = 1;
this.scaleY = 1;
this.angle = 0;
this.compositeOperation = undefined;
this.anchorX = 0;
this.anchorY = 0;
this._matrix = undefined;
} else {
this.x = param.x || 0;
this.y = param.y || 0;
this.width = param.width || 0;
this.height = param.height || 0;
this.opacity = param.opacity != null ? param.opacity : 1;
this.scaleX = param.scaleX != null ? param.scaleX : 1;
this.scaleY = param.scaleY != null ? param.scaleY : 1;
this.angle = param.angle || 0;
this.compositeOperation = param.compositeOperation;
// `null` に後方互換性のための意味を持たせているので、 `=== undefined` で比較する
this.anchorX = param.anchorX === undefined ? 0 : param.anchorX;
this.anchorY = param.anchorY === undefined ? 0 : param.anchorY;
this._matrix = undefined;
}
}
/**
* オブジェクトを移動する。
* このメソッドは `x` と `y` を同時に設定するためのユーティリティメソッドである。
* `E` や `Camera2D` においてこのメソッドを呼び出した場合、 `modified()` を呼び出す必要がある。
* @param x X座標
* @param y Y座標
*/
moveTo(x: number, y: number): void;
/**
* オブジェクトを移動する。
* このメソッドは `x` と `y` を同時に設定するためのユーティリティメソッドである。
* `E` や `Camera2D` においてこのメソッドを呼び出した場合、 `modified()` を呼び出す必要がある。
* @param obj X,Y座標
*/
moveTo(obj: CommonOffset): void;
moveTo(posOrX: number | CommonOffset, y?: number): void {
if (typeof posOrX === "number" && typeof y !== "number") {
throw ExceptionFactory.createAssertionError("Object2D#moveTo: arguments must be CommonOffset or pair of x and y as a number.");
}
if (typeof posOrX === "number") {
this.x = posOrX;
this.y = y!;
} else {
this.x = posOrX.x;
this.y = posOrX.y;
}
}
/**
* オブジェクトを相対的に移動する。
* このメソッドは `x` と `y` を同時に加算するためのユーティリティメソッドである。
* `E` や `Camera2D` においてこのメソッドを呼び出した場合、 `modified()` を呼び出す必要がある。
* @param x X座標に加算する値
* @param y Y座標に加算する値
*/
moveBy(x: number, y: number): void {
this.x += x;
this.y += y;
}
/**
* オブジェクトのサイズを設定する。
* このメソッドは `width` と `height` を同時に設定するためのユーティリティメソッドである。
* `E` や `Camera2D` においてこのメソッドを呼び出した場合、 `modified()` を呼び出す必要がある。
* @param width 幅
* @param height 高さ
*/
resizeTo(width: number, height: number): void;
/**
* オブジェクトのサイズを設定する。
* このメソッドは `width` と `height` を同時に設定するためのユーティリティメソッドである。
* `E` や `Camera2D` においてこのメソッドを呼び出した場合、 `modified()` を呼び出す必要がある。
* @param size 幅と高さ
*/
resizeTo(size: CommonSize): void;
resizeTo(sizeOrWidth: number | CommonSize, height?: number): void {
if (typeof sizeOrWidth === "number" && typeof height !== "number") {
throw ExceptionFactory.createAssertionError(
"Object2D#resizeTo: arguments must be CommonSize or pair of width and height as a number."
);
}
if (typeof sizeOrWidth === "number") {
this.width = sizeOrWidth;
this.height = height!;
} else {
this.width = sizeOrWidth.width;
this.height = sizeOrWidth.height;
}
}
/**
* オブジェクトのサイズを相対的に変更する。
* このメソッドは `width` と `height` を同時に加算するためのユーティリティメソッドである。
* `E` や `Camera2D` においてこのメソッドを呼び出した場合、 `modified()` を呼び出す必要がある。
* @param width 加算する幅
* @param height 加算する高さ
*/
resizeBy(width: number, height: number): void {
this.width += width;
this.height += height;
}
/**
* オブジェクトの拡大率を設定する。
* このメソッドは `scaleX` と `scaleY` に同じ値を同時に設定するためのユーティリティメソッドである。
* `E` や `Camera2D` においてこのメソッドを呼び出した場合、 `modified()` を呼び出す必要がある。
* @param scale 拡大率
*/
scale(scale: number): void {
this.scaleX = scale;
this.scaleY = scale;
}
/**
* オブジェクトのアンカーの位置を設定する。
* このメソッドは `anchorX` と `anchorY` を同時に設定するためのユーティリティメソッドである。
* `E` や `Camera2D` においてこのメソッドを呼び出した場合、 `modified()` を呼び出す必要がある。
*/
anchor(x: number, y: number): void {
this.anchorX = x;
this.anchorY = y;
}
/**
* このオブジェクトの変換行列を得る。
*/
getMatrix(): Matrix {
if (!this._matrix) {
this._matrix = new PlainMatrix();
} else if (!this._matrix._modified) {
return this._matrix;
}
this._updateMatrix();
this._matrix._modified = false;
return this._matrix;
}
/**
* 公開のプロパティから内部の変換行列キャッシュを更新する。
* @private
*/
_updateMatrix(): void {
if (this.angle || this.scaleX !== 1 || this.scaleY !== 1 || this.anchorX !== 0 || this.anchorY !== 0) {
// @ts-ignore
this._matrix.update(this.width, this.height, this.scaleX, this.scaleY, this.angle, this.x, this.y, this.anchorX, this.anchorY);
} else {
// @ts-ignore
this._matrix.reset(this.x, this.y);
}
}
}