-
Notifications
You must be signed in to change notification settings - Fork 491
/
PathPoint.js
265 lines (216 loc) · 7.56 KB
/
PathPoint.js
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
/**
* @author Richard Davey <rich@photonstorm.com>
* @author Pete Baron <pete@photonstorm.com>
* @copyright 2016 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
* The PathPoint class contains data and functions for each point on a Path.
*
* @class Phaser.PathPoint
* @constructor
* @param {number} x - The x coordinate of the PathPoint.
* @param {number} y - The y coordinate of the PathPoint.
* @param {number} vx - The x coordinate of the tangent vector to create the curve from.
* @param {number} vy - The y coordinate of the tangent vector to create the curve from.
* @param {number} [speed=1] - The speed multiplier for PathFollowers on this Path segment.
* @param {object} [data] - The data associated with this point, e.g.: { type: PathPoint.DATA_VALUE, value: XXX }
* @param {Phaser.Path} [branchPath] - A branched path which is attached to this point.
* @param {number} [branchPointIndex] - The index where the branch is attached to on the new path.
*/
Phaser.PathPoint = function (x, y, vx, vy, speed, data, branchPath, branchPointIndex)
{
if (speed === undefined) { speed = 1; }
if (data === undefined) { data = { type: 0, value: 0 }; }
if (branchPath === undefined) { branchPath = null; }
if (branchPointIndex === undefined) { branchPointIndex = 0; }
/**
* @property {number} x - The x coordinate of the PathPoint.
*/
this.x = x;
/**
* @property {number} y - The y coordinate of the PathPoint.
*/
this.y = y;
/**
* @property {number} vx - The x coordinate of the tangent vector to create the curve from.
*/
this.vx = vx;
/**
* @property {number} vy - The y coordinate of the tangent vector to create the curve from.
*/
this.vy = vy;
/**
* @property {number} speed - The speed multiplier for PathFollowers on this path segment.
*/
this.speed = speed;
/**
* @property {object} data - Data associated with this point eg: { type: PathPoint.DATA_VALUE, value: XXX }
*/
this.data = data;
/**
* @property {Phaser.Path} branchPath - A branched path which is attached at this point.
*/
this.branchPath = branchPath;
/**
* @property {number} branchPointIndex - The index where the branch is attached to on the new path.
*/
this.branchPointIndex = branchPointIndex;
/**
* @property {number} branchType - The branch type of the path this point is on. Either 0 (attached) or 1 (joined)
*/
this.branchType = 0;
/**
* @property {number} curve - Once the Hermite curve is calculated, store it to avoid recalculation later.
* @protected
*/
this.curve = null;
/**
* @property {boolean} active - Is this point a selected (or active) point?
* @warn For Path Editor use only
*/
this.active = false;
/**
* @property {array} controlPoints - A list of Phaser.Point objects representing the control points on the segment.
* @warn For Path Editor use only
*/
this.controlPoints = null;
};
Phaser.PathPoint.prototype.constructor = Phaser.PathPoint;
/**
* @constant
* @type {number}
*/
Phaser.PathPoint.DATA_NONE = 0;
/**
* @constant
* @type {number}
*/
Phaser.PathPoint.DATA_PAUSE = 1;
/**
* @constant
* @type {number}
*/
Phaser.PathPoint.DATA_VALUE = 2;
/**
* @constant
* @type {number}
*/
Phaser.PathPoint.DATA_COUNTER = 3;
Phaser.PathPoint.prototype = {
/**
* Sets the x, y and optionally vx and vy properties of this PathPoint.
*
* @method Phaser.PathPoint#setTo
* @param {number} x - The x coordinate of the PathPoint.
* @param {number} y - The y coordinate of the PathPoint.
* @param {number} [vx] - The x coordinate of the tangent vector to create the curve from.
* @param {number} [vy] - The y coordinate of the tangent vector to create the curve from.
* @return {Phaser.PathPoint} This object.
*/
setTo: function (x, y, vx, vy)
{
this.x = x;
this.y = y;
if (vx !== undefined)
{
this.vx = vx;
}
if (vy !== undefined)
{
this.vy = vy;
}
// Invalidate the pre-calculated curve to force it to recalculate with these new settings
this.curve = null;
return this;
},
/**
* Sets the tangent vector properties of this PathPoint.
*
* @method Phaser.PathPoint#setTangent
* @param {number} vx - The x coordinate of the tangent vector to create the curve from.
* @param {number} vy - The y coordinate of the tangent vector to create the curve from.
* @return {Phaser.PathPoint} This object.
*/
setTangent: function (vx, vy)
{
this.vx = vx;
this.vy = vy;
// Invalidate the pre-calculated curve to force it to recalculate with these new settings
this.curve = null;
return this;
},
/**
* Creates a clone of this PathPoint object.
*
* @method Phaser.PathPoint#clone
* @param {Phaser.PathPoint} [out] - An optional PathPoint object into which this object is cloned. If no object is provided a new PathPoint is created.
* @return {Phaser.PathPoint} A clone of this PathPoint.
*/
clone: function (out)
{
if (out === undefined) { out = new Phaser.PathPoint(); }
return out.copy(this);
},
/**
* Copies all of the values from the given PathPoint object into this PathPoint.
* The source PathPoint is untouched by this operation.
*
* @method Phaser.PathPoint#copy
* @param {Phaser.PathPoint} source - The PathPoint object to copy the values from.
* @return {Phaser.PathPoint} This PathPoint object.
*/
copy: function (source)
{
this.x = source.x;
this.y = source.y;
this.vx = source.vx;
this.vy = source.vy;
this.speed = source.speed;
this.data = source.data;
this.branchPath = source.branchPath;
this.branchPointIndex = source.branchPointIndex;
this.curve = null;
this.active = source.active;
return this;
},
/**
* Compare this PathPoint with another PathPoint object and return `true`
* if they have the same `x`, `y` and `speed` properties, after taking the optional
* offset values into consideration.
*
* @method Phaser.PathPoint#equals
* @param {Phaser.PathPoint} pathPoint - The PathPoint to compare against this PathPoint.
* @param {number} [offsetX=0] - A value to apply to the x coordinate before comparison.
* @param {number} [offsetY=0] - A value to apply to the y coordinate before comparison.
* @return {boolean} True if the two PathPoint objects match, after the offsets are applied, or false if they don't.
*/
equals: function (pathPoint, offsetX, offsetY)
{
if (offsetX === undefined) { offsetX = 0; }
if (offsetY === undefined) { offsetY = 0; }
return (this.x === pathPoint.x + offsetX &&
this.y === pathPoint.y + offsetY &&
this.speed === pathPoint.speed);
},
/**
* Serializes this PathPoint into a JSON object and returns it.
*
* @method Phaser.PathPoint#toJSON
* @return {Object} A JSON object representing this PathPoint.
*/
toJSON: function ()
{
return {
x: this.x,
y: this.y,
vx: this.vx,
vy: this.vy,
speed: this.speed,
data: this.data,
branchPath: this.branchPath ? this.branchPath.name : null,
branchPointIndex: this.branchPointIndex,
branchType: this.branchType
};
}
};