Class: TimeFlowControl

SuperMap.TimeFlowControl

时间管理类。

new SuperMap.TimeFlowControl(callback, options)

common/control/TimeFlowControl.js, line 7

此类只负责时间上的控制，具体执行的操作需要用户在初始化时的回调函数内部进行实现。 如设置起始时间为 1000，结束时间是 2000，步长设置为 1， 那么表示按照每次1年（可以通过 setSpeed 进行修改）的变化从公元 1000 年开始到公元 2000 年为止，默认每 1 秒会 1 次（通过 setFrequency 修改）

Name Type Description
callback function

每次刷新回调函数。具体的效果需要用户在此回调函数里面实现。
options Object

该类开放的可选属性。

Name Type Default Description
speed number 1 可选

步长（单位 ms）。不能小于 0，（每次刷新的数据之间的间隔为 1ms）。
frequency number 1000 可选

刷新频率（单位 ms）。
startTime number 0 可选

起始时间，必须为数字，且小于等于 endTime。如果不设置，初始化时为 0，建议设置。
endTime number 可选

结束时间，必须为数字，且大于等于 startTime。如果不设置，初始化时使用 new Date() 以当前时间进行设置，建议设置。
repeat boolean true 可选

是否重复循环。
reverse boolean false 可选

是否反向。

Extends

Members

callbackfunction

每次刷新执行的回调函数。

currentTimenumber

记录近期的时间，也就是当前帧运行到的时间。

endTimenumber

记录的结束时间，必须为数字， 如果不设置，初始化时以当前时间进行设置，建议设置

frequencynumber

刷新频率(单位ms)，服务器刷新的时间间隔。

Default Value:
1000

oldTimenumber

记录上一帧的时间，也就是之前运行到的时间。

repeatboolean

是否重复循环。

Default Value:
true

reverseboolean

是否反向。

runningboolean

记录当前是否处于运行中。

speednumber

步长，必须为非负数，默认为1（表示前后两次渲染的数据之间的间隔为1）

Default Value:
1

startTimenumber

记录的起始时间，必须为数字， 如果不设置，初始化时为0，建议设置

Methods

inherited destroy()

common/control/TimeControlBase.js, line 408

销毁 Animator 对象，释放资源。

inherited getCurrentTime(){number}

common/control/TimeControlBase.js, line 348

获取当前时间。

Returns:
Type Description
number 返回当前时间。

inherited getEndTime(){number}

common/control/TimeControlBase.js, line 318

获取结束时间。

Returns:
Type Description
number 返回当前的结束时间。

inherited getFrequency(){number}

common/control/TimeControlBase.js, line 252

获取刷新频率。

Returns:
Type Description
number 返回当前的刷新频率。

inherited getRepeat(){boolean}

common/control/TimeControlBase.js, line 368

获取是否重复循环，默认是 true。

Returns:
Type Description
boolean 返回是否重复循环。

inherited getReverse(){boolean}

common/control/TimeControlBase.js, line 388

获取是否反向，默认是false。

Returns:
Type Description
boolean 返回是否反向。

inherited getRunning(){boolean}

common/control/TimeControlBase.js, line 398

获取运行状态。

Returns:
Type Description
boolean true 代表正在运行，false 发表没有运行。

inherited getSpeed(){number}

common/control/TimeControlBase.js, line 226

获取步长。

Returns:
Type Description
number 返回当前的步长

inherited getStartTime(){number}

common/control/TimeControlBase.js, line 285

获取起始时间。

Returns:
Type Description
number 返回当前的起始时间。

inherited pause()

common/control/TimeControlBase.js, line 168

暂停。

inherited setCurrentTime(currentTime){boolean}

common/control/TimeControlBase.js, line 328

设置当前时间。

Name Type Description
currentTime number

需要设置的当前时间。
Returns:
Type Description
boolean true 代表设置成功，false 设置失败。

inherited setEndTime(endTime){boolean}

common/control/TimeControlBase.js, line 295

设置结束时间，设置完成后如果当前时间大于结束，则从起始时间开始。

Name Type Description
endTime number

需要设置的结束时间。
Returns:
Type Description
boolean true 代表设置成功，false 设置失败（endTime 小于开始时间时失败）。

inherited setFrequency(frequency){boolean}

common/control/TimeControlBase.js, line 236

设置刷新频率。

Name Type Default Description
frequency number 1000 可选

刷新频率，单位为 ms。
Returns:
Type Description
boolean true 代表设置成功，false 设置失败（frequency 小于 0 时失败）。

inherited setRepeat(repeat)

common/control/TimeControlBase.js, line 358

设置是否重复循环。

Name Type Default Description
repeat boolean true 可选

是否重复循环。

inherited setReverse(reverse)

common/control/TimeControlBase.js, line 378

设置是否反向。

Name Type Default Description
reverse boolean false 可选

是否反向。

inherited setSpeed(speed){boolean}

common/control/TimeControlBase.js, line 210

设置步长。

Name Type Default Description
speed number 1 可选

步长，必须为非负数。
Returns:
Type Description
boolean true 代表设置成功，false 设置失败（speed 小于 0 时失败）。

inherited setStartTime(startTime){boolean}

common/control/TimeControlBase.js, line 262

设置起始时间，设置完成后如果当前时间小于起始时间，则从起始时间开始。

Name Type Description
startTime number

需要设置的起始时间。
Returns:
Type Description
boolean true 代表设置成功，false 设置失败（startTime 大于结束时间时失败）。

inherited start()

common/control/TimeControlBase.js, line 153

开始。

inherited stop()

common/control/TimeControlBase.js, line 179

停止，停止后返回起始状态。

tick()

common/control/TimeFlowControl.js, line 131

定时刷新。

inherited toggle()

common/control/TimeControlBase.js, line 195

开关切换，切换的是开始和暂停。

update()

common/control/TimeFlowControl.js, line 143

inherited updateOptions(options)

common/control/TimeControlBase.js, line 115
Name Type Description
options Object

设置参数得可选参数。设置步长，刷新频率、开始结束时间、是否循环、是否反向。