forked from SuperMap/iClient-JavaScript
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathTimeControlBase.js
More file actions
432 lines (358 loc) · 13.7 KB
/
TimeControlBase.js
File metadata and controls
432 lines (358 loc) · 13.7 KB
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
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
/* Copyright© 2000 - 2021 SuperMap Software Co.Ltd. All rights reserved.
* This program are made available under the terms of the Apache License, Version 2.0
* which accompanies this distribution and is available at http://www.apache.org/licenses/LICENSE-2.0.html.*/
import {SuperMap} from '../SuperMap';
import {Events} from '../commontypes/Events';
/**
* @class SuperMap.TimeControlBase
* @classdesc 时间控制基类类。
* @category Control
* @param {Object} options - 该类开放的可选属性。
* @param {number} [options.speed=1] - 速度。不能小于 0，（每帧渲染的数据之间的间隔为1），设置越大速度越快。
* @param {number} [options.frequency=1000] - 刷新频率（单位 ms），服务器刷新的时间间隔。
* @param {number} [options.startTime=0] - 起始时间，必须为数字，且小于等于 endTime。如果不设置，初始化时为 0，建议设置。
* @param {number} [options.endTime] - 结束时间，必须为数字，且大于等于 startTime。如果不设置，初始化时以当前时间进行设置，建议设置。
* @param {boolean} [options.repeat=true] - 是否重复循环。
* @param {boolean} [options.reverse=false] - 是否反向。
*/
export class TimeControlBase {
constructor(options) {
//设置步长，刷新频率、开始结束时间、是否循环、是否反向
var me = this;
options = options || {};
/**
* @member {number} [SuperMap.TimeControlBase.prototype.speed=1]
* @description 步长，必须为非负数，默认为1（表示前后两次渲染的数据之间的间隔为1）
*/
this.speed = (options.speed && options.speed >= 0) ? options.speed : 1;
/**
* @member {number} [SuperMap.TimeControlBase.prototype.frequency=1000]
* @description 刷新频率(单位ms)，服务器刷新的时间间隔。
*/
this.frequency = (options.speed && options.frequency >= 0) ? options.frequency : 1000;
/**
* @member {number} [SuperMap.TimeControlBase.prototype.startTime=0]
* @description 记录的起始时间，必须为数字，
* 如果不设置，初始化时为0，建议设置
*/
this.startTime = (options.startTime && options.startTime != null) ? options.startTime : 0;
/**
* @member {number} SuperMap.TimeControlBase.prototype.endTime
* @description 记录的结束时间，必须为数字，
* 如果不设置，初始化时以当前时间进行设置，建议设置
*/
this.endTime = (options.endTime && options.endTime != null && options.endTime >= me.startTime) ? options.endTime : +new Date();
/**
* @member {boolean} [SuperMap.TimeControlBase.prototype.repeat=true]
* @description 是否重复循环。
*/
this.repeat = (options.repeat !== undefined) ? options.repeat : true;
/**
* @member {boolean} [SuperMap.TimeControlBase.prototype.reverse=false]
* @description 是否反向。
*/
this.reverse = (options.reverse !== undefined) ? options.reverse : false;
/**
* @member {number} SuperMap.TimeControlBase.prototype.currentTime
* @description 记录近期的时间，也就是当前帧运行到的时间。
*/
this.currentTime = null;
/**
* @member {number} SuperMap.TimeControlBase.prototype.oldTime
* @description 记录上一帧的时间，也就是之前运行到的时间。
*/
this.oldTime = null;
/**
* @member {boolean} [SuperMap.TimeControlBase.prototype.running=false]
* @description 记录当前是否处于运行中。
*/
this.running = false;
/**
* @private
* @member {Array.<string>} SuperMap.TimeControlBase.prototype.EVENT_TYPES
* @description 此类支持的事件类型。
*
*/
this.EVENT_TYPES = ["start", "pause", "stop"];
/**
* @private
* @member {SuperMap.Events} SuperMap.TimeControlBase.prototype.events
* @description 事件
*/
me.events = new Events(this, null, this.EVENT_TYPES);
me.speed = Number(me.speed);
me.frequency = Number(me.frequency);
me.startTime = Number(me.startTime);
me.endTime = Number(me.endTime);
me.startTime = Date.parse(new Date(me.startTime));
me.endTime = Date.parse(new Date(me.endTime));
//初始化当前时间
me.currentTime = me.startTime;
this.CLASS_NAME = "SuperMap.TimeControlBase";
}
/**
* @function SuperMap.TimeControlBase.prototype.updateOptions
* @param {Object} options - 设置参数得可选参数。设置步长，刷新频率、开始结束时间、是否循环、是否反向。
*/
updateOptions(options) {
//设置步长，刷新频率、开始结束时间、是否循环、是否反向
var me = this;
options = options || {};
if (options.speed && options.speed >= 0) {
me.speed = options.speed;
me.speed = Number(me.speed);
}
if (options.speed && options.frequency >= 0) {
me.frequency = options.frequency;
me.frequency = Number(me.frequency);
}
if (options.startTime && options.startTime != null) {
me.startTime = options.startTime;
me.startTime = Date.parse(new Date(me.startTime));
}
if (options.endTime && options.endTime != null && options.endTime >= me.startTime) {
me.endTime = options.endTime;
me.endTime = Date.parse(new Date(me.endTime));
}
if (options.repeat != null) {
me.repeat = options.repeat;
}
if (options.reverse != null) {
me.reverse = options.reverse;
}
}
/**
* @function SuperMap.TimeControlBase.prototype.start
* @description 开始。
*/
start() {
var me = this;
if (!me.running) {
me.running = true;
me.tick();
me.events.triggerEvent('start', me.currentTime);
}
}
/**
* @function SuperMap.TimeControlBase.prototype.pause
* @description 暂停。
*/
pause() {
var me = this;
me.running = false;
me.events.triggerEvent('pause', me.currentTime);
}
/**
* @function SuperMap.TimeControlBase.prototype.stop
* @description 停止，停止后返回起始状态。
*/
stop() {
var me = this;
//停止时 时间设置为开始时间
me.currentTime = me.startTime;
//如果正在运行，修改为初始时间即可绘制一帧
if (me.running) {
me.running = false;
}
me.events.triggerEvent('stop', me.currentTime);
}
/**
* @function SuperMap.TimeControlBase.prototype.toggle
* @description 开关切换，切换的是开始和暂停。
*/
toggle() {
var me = this;
if (me.running) {
me.pause();
} else {
me.start();
}
}
/**
* @function SuperMap.TimeControlBase.prototype.setSpeed
* @description 设置步长。
* @param {number} [speed=1] - 步长，必须为非负数。
* @returns {boolean} true 代表设置成功，false 设置失败（speed 小于 0 时失败）。
*/
setSpeed(speed) {
var me = this;
if (speed >= 0) {
me.speed = speed;
return true;
}
return false;
}
/**
* @function SuperMap.TimeControlBase.prototype.getSpeed
* @description 获取步长。
* @returns {number} 返回当前的步长
*/
getSpeed() {
return this.speed;
}
/**
* @function SuperMap.TimeControlBase.prototype.setFrequency
* @description 设置刷新频率。
* @param {number} [frequency=1000] - 刷新频率，单位为 ms。
* @returns {boolean} true 代表设置成功，false 设置失败（frequency 小于 0 时失败）。
*/
setFrequency(frequency) {
var me = this;
if (frequency >= 0) {
me.frequency = frequency;
return true;
}
return false;
}
/**
* @function SuperMap.TimeControlBase.prototype.getFrequency
* @description 获取刷新频率。
* @returns {number} 返回当前的刷新频率。
*/
getFrequency() {
return this.frequency;
}
/**
* @function SuperMap.TimeControlBase.prototype.setStartTime
* @description 设置起始时间，设置完成后如果当前时间小于起始时间，则从起始时间开始。
* @param {number} startTime - 需要设置的起始时间。
* @returns {boolean} true 代表设置成功，false 设置失败（startTime 大于结束时间时失败）。
*/
setStartTime(startTime) {
var me = this;
startTime = Date.parse(new Date(startTime));
//起始时间不得大于结束时间
if (startTime > me.endTime) {
return false;
}
me.startTime = startTime;
//如果当前时间小于了起始时间，则从当前起始时间开始
if (me.currentTime < me.startTime) {
me.currentTime = me.startTime;
me.tick();
}
return true;
}
/**
* @function SuperMap.TimeControlBase.prototype.getStartTime
* @description 获取起始时间。
* @returns {number} 返回当前的起始时间。
*/
getStartTime() {
return this.startTime;
}
/**
* @function SuperMap.TimeControlBase.prototype.setEndTime
* @description 设置结束时间，设置完成后如果当前时间大于结束，则从起始时间开始。
* @param {number} endTime - 需要设置的结束时间。
* @returns {boolean} true 代表设置成功，false 设置失败（endTime 小于开始时间时失败）。
*/
setEndTime(endTime) {
var me = this;
me.endTime = Date.parse(new Date(me.endTime));
//结束时间不得小于开始时间
if (endTime < me.startTime) {
return false;
}
me.endTime = endTime;
//如果当前时间大于了结束时间，则从起始时间开始
if (me.currentTime >= me.endTime) {
me.currentTime = me.startTime;
me.tick();
}
return true;
}
/**
* @function SuperMap.TimeControlBase.prototype.getEndTime
* @description 获取结束时间。
* @returns {number} 返回当前的结束时间。
*/
getEndTime() {
return this.endTime;
}
/**
* @function SuperMap.TimeControlBase.prototype.setCurrentTime
* @description 设置当前时间。
* @param {number} currentTime - 需要设置的当前时间。
* @returns {boolean} true 代表设置成功，false 设置失败。
*/
setCurrentTime(currentTime) {
var me = this;
me.currentTime = Date.parse(new Date(me.currentTime));
//结束时间不得小于开始时间
if (currentTime >= me.startTime && currentTime <= me.endTime) {
me.currentTime = currentTime;
me.startTime = me.currentTime;
me.tick();
return true;
}
return false;
}
/**
* @function SuperMap.TimeControlBase.prototype.getCurrentTime
* @description 获取当前时间。
* @returns {number} 返回当前时间。
*/
getCurrentTime() {
return this.currentTime;
}
/**
* @function SuperMap.TimeControlBase.prototype.setRepeat
* @description 设置是否重复循环。
* @param {boolean} [repeat=true] - 是否重复循环。
*/
setRepeat(repeat) {
this.repeat = repeat;
}
/**
* @function SuperMap.TimeControlBase.prototype.getRepeat
* @description 获取是否重复循环，默认是 true。
* @returns {boolean} 返回是否重复循环。
*/
getRepeat() {
return this.repeat;
}
/**
* @function SuperMap.TimeControlBase.prototype.setReverse
* @description 设置是否反向。
* @param {boolean} [reverse=false] - 是否反向。
*/
setReverse(reverse) {
this.reverse = reverse;
}
/**
* @function SuperMap.TimeControlBase.prototype.getReverse
* @description 获取是否反向，默认是false。
* @returns {boolean} 返回是否反向。
*/
getReverse() {
return this.reverse;
}
/**
* @function SuperMap.TimeControlBase.prototype.getRunning
* @description 获取运行状态。
* @returns {boolean} true 代表正在运行，false 发表没有运行。
*/
getRunning() {
return this.running;
}
/**
* @function SuperMap.TimeControlBase.prototype.destroy
* @description 销毁 Animator 对象，释放资源。
*/
destroy() {
var me = this;
me.speed = null;
me.frequency = null;
me.startTime = null;
me.endTime = null;
me.currentTime = null;
me.repeat = null;
me.running = false;
me.reverse = null;
}
tick() {
//TODO 每次刷新执行的操作。子类实现
}
}
SuperMap.TimeControlBase = TimeControlBase;