Class: TimeFlowControl

TimeFlowControl

时间管理类。

new SuperMap.TimeFlowControl(callback, options)

common/control/TimeFlowControl.js, line 4

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

Name Type Description
callback function

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

该类开放的可选属性。如：
speed - {number}步长(单位ms)。不能小于0，默认为1（表示每次刷新的数据之间的间隔为1ms）。
frequency - {number} 刷新频率(单位ms)，默认为1000ms。
startTime - {number}起始时间，必须为数字，且小于等于endTime。如果不设置，初始化时为0，建议设置。
endTime - {number}结束时间，必须为数字，且大于等于startTime。如果不设置，初始化时以当前时间进行设置，建议设置。
repeat - {boolean} 是否重复循环。默认为true。
reverse - {boolean} 是否反向。默认为false。

Extends

Members

callbackfunction

每次刷新执行的回调函数

currentTimenumber

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

endTimenumber

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

frequencynumber

刷新频率(单位ms)，服务器刷新的时间间隔，默认为1s

oldTimenumber

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

repeatboolean

是否重复循环，默认为true。

reverseboolean

是否反向，默认为false。

runningboolean

记录当前是否处于运行中，默认为false。

speednumber

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

startTimenumber

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

Methods

inherited destroy()

common/control/TimeControlBase.js, line 407

销毁Animator对象，释放资源。

inherited getCurrentTime(){number}

common/control/TimeControlBase.js, line 347

获取当前时间

Returns:
Type Description
number 返回当前时间

inherited getEndTime(){number}

common/control/TimeControlBase.js, line 317

获取结束时间

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

inherited getFrequency(){number}

common/control/TimeControlBase.js, line 251

获取刷新频率。

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

inherited getRepeat(){boolean}

common/control/TimeControlBase.js, line 367

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

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

inherited getReverse(){boolean}

common/control/TimeControlBase.js, line 387

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

Returns:
Type Description
boolean 返回是否反向

inherited getRunning(){boolean}

common/control/TimeControlBase.js, line 397

获取运行状态

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

inherited getSpeed(){number}

common/control/TimeControlBase.js, line 225

获取步长。

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

inherited getStartTime(){number}

common/control/TimeControlBase.js, line 284

获取起始时间

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

inherited pause()

common/control/TimeControlBase.js, line 167

暂停

inherited setCurrentTime(currentTime){boolean}

common/control/TimeControlBase.js, line 327

设置当前时间

Name Type Description
currentTime number

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

inherited setEndTime(endTime){boolean}

common/control/TimeControlBase.js, line 294

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

Name Type Description
endTime number

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

inherited setFrequency(frequency){boolean}

common/control/TimeControlBase.js, line 235

设置刷新频率。

Name Type Description
frequency number

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

inherited setRepeat(repeat)

common/control/TimeControlBase.js, line 357

设置是否重复循环

Name Type Description
repeat boolean

是否重复循环

inherited setReverse(reverse)

common/control/TimeControlBase.js, line 377

设置是否反向

Name Type Description
reverse boolean

是否反向

inherited setSpeed(speed){boolean}

common/control/TimeControlBase.js, line 209

设置步长。

Name Type Description
speed number

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

inherited setStartTime(startTime){boolean}

common/control/TimeControlBase.js, line 261

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

Name Type Description
startTime number

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

inherited start()

common/control/TimeControlBase.js, line 152

开始

inherited stop()

common/control/TimeControlBase.js, line 178

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

tick()

common/control/TimeFlowControl.js, line 127

定时刷新

inherited toggle()

common/control/TimeControlBase.js, line 194

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

update()

common/control/TimeFlowControl.js, line 138

inherited updateOptions(options)

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

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