useTimeline
响应式的时间线。可以控制当前时间,开始、结束时间,时间速率等。
使用
js
const { currentTime } = useTimeline()
js
const clock = new Cesium.Clock()
const { play } = useTimeline(clock)
play()
useTimeline
接受一个可选的 Cesium.Clock
作为参数。默认情况下,通过 useViewer
获取上下文中 viewer.clock
。
currentTime
, startTime
, stopTime
都是精确到毫秒的Unix时间戳。rate
用于控制时间流速,小于0时可以让时间倒流。需要注意的是,paused
为只读属性。如果希望让时间暂停/流动,请调用 play()
或pause()
方法。
更多用法请见Demo与类型声明。
返回值
返回值都为函数或者响应式变量。
rate
: number,表示时间流动速率。paused
: 只读的boolean,表示时间是否停止。currentTime
: number,表示当前时间(unix时间戳)。startTime
: number,表示时间轴的开始时间(unix时间戳)。stopTime
: number, 表示时间轴的结束时间(unix时间戳)。play
: 函数,用于使时间开始流动。pause
: 函数,用于使时间暂停。
demo
类型声明
Details
ts
/**
* Reactive timeline. Used To control currentTime, start/endTime, time rate...
*
* Time are all Unix Time Stamp in milliseconds.
*/
export declare function useTimeline(clock?: Cesium.Clock): {
rate: Ref<number, number>
paused: Readonly<Ref<boolean, boolean>>
currentTime: Ref<number, number>
startTime: Ref<number, number>
stopTime: Ref<number, number>
play: () => void
pause: () => void
}