-
Notifications
You must be signed in to change notification settings - Fork 0
/
PBImage.ts
100 lines (91 loc) · 2.35 KB
/
PBImage.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
/**
* @author Ikaros Kappler
* @date 2019-01-30
* @modified 2019-03-23 Added JSDoc tags.
* @modified 2020-03-25 Ported this class from vanilla-JS to Typescript.
* @modified 2021-01-20 Added UID.
* @modified 2022-02-02 Added the `destroy` method.
* @modified 2022-02-02 Cleared the `PBImage.toSVGString` function (deprecated). Use `drawutilssvg` instead.
* @version 1.2.0
*
* @file PBImage
* @fileoverview As native Image objects have only a position and with
* and height thei are not suitable for UI dragging interfaces.
* @public
**/
import { Vertex } from "./Vertex";
import { UIDGenerator } from "./UIDGenerator";
import { SVGSerializable, UID } from "./interfaces";
/**
* @classdesc A wrapper for image objects. Has an upper left and a lower right corner point.
*
* @requires Vertex
* @requires SVGSerializable
* @requires UID
* @requires UIDGenerator
*/
export class PBImage implements SVGSerializable {
/**
* Required to generate proper CSS classes and other class related IDs.
**/
readonly className: string = "PBImage";
/**
* The UID of this drawable object.
*
* @member {UID}
* @memberof PBImage
* @instance
* @readonly
*/
readonly uid: UID;
/**
* @member {Vertex}
* @memberof PBImage
* @instance
*/
image: HTMLImageElement;
/**
* @member {Vertex}
* @memberof PBImage
* @instance
*/
upperLeft: Vertex;
/**
* @member {Vertex}
* @memberof PBImage
* @instance
*/
lowerRight: Vertex;
/**
* @member isDestroyed
* @memberof PBImage
* @type {boolean}
* @instance
*/
isDestroyed: boolean;
/**
* The constructor.
*
* @constructor
* @name PBImage
* @param {Image} image - The actual image.
* @param {Vertex} upperLeft - The upper left corner.
* @param {Vertex} lowerRight - The lower right corner.
**/
constructor(image: HTMLImageElement, upperLeft: Vertex, lowerRight: Vertex) {
this.uid = UIDGenerator.next();
this.image = image;
this.upperLeft = upperLeft;
this.lowerRight = lowerRight;
}
/**
* This function should invalidate any installed listeners and invalidate this object.
* After calling this function the object might not hold valid data any more and
* should not be used.
*/
destroy() {
this.upperLeft.destroy();
this.lowerRight.destroy();
this.isDestroyed = true;
}
}