Appearance
Class: ViewRoaming
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new ViewRoaming(viewer): ViewRoaming
Parameters
| Name | Type |
|---|---|
viewer | Viewer |
Returns
Defined in
src/interaction/ViewRoaming/index.ts:104
Properties
cancelCallback
• cancelCallback: () => void
漫游被取消时（调用 viewer.flyTo 或 camera.flyTo 时）的回调函数
Type declaration
▸ (): void
漫游被取消时（调用 viewer.flyTo 或 camera.flyTo 时）的回调函数
Returns
void
Defined in
src/interaction/ViewRoaming/index.ts:77
completeCallback
• completeCallback: () => void
漫游完成时的回调函数，如果是循环漫游，则是漫游完一轮的回调函数。
Memberof
ViewRoaming
Type declaration
▸ (): void
漫游完成时的回调函数，如果是循环漫游，则是漫游完一轮的回调函数。
Returns
void
Memberof
ViewRoaming
Defined in
src/interaction/ViewRoaming/index.ts:83
repeat
• repeat: boolean
是否循环漫游。
Memberof
ViewRoaming
Defined in
src/interaction/ViewRoaming/index.ts:89
roamingCallback
• roamingCallback: (object: RoamingViews, i: number, elapsed: number) => void
正在漫游中的回调函数，该函数的第一个参数是一个对象，包含当前视点的属性， 第二个参数是当前所处段的索引，第三个参数是每一段的进度。
Memberof
ViewRoaming
Type declaration
▸ (object, i, elapsed): void
正在漫游中的回调函数，该函数的第一个参数是一个对象，包含当前视点的属性， 第二个参数是当前所处段的索引，第三个参数是每一段的进度。
Parameters
| Name | Type |
|---|---|
object | RoamingViews |
i | number |
elapsed | number |
Returns
void
Memberof
ViewRoaming
Defined in
src/interaction/ViewRoaming/index.ts:94
Accessors
roamingViews
• get roamingViews(): RoamingViews[]
获取当前的视点数组，设置视点数组见 setRoamingViews
Returns
Default Value
ts
[];Memberof
ViewRoaming
Defined in
src/interaction/ViewRoaming/index.ts:431
showHelper
• get showHelper(): boolean
是否显示辅助物，包括路径曲线和每个视角的方位（使用视锥体的方位表示）。
Returns
boolean
Memberof
ViewRoaming
Default Value
ts
false;Defined in
src/interaction/ViewRoaming/index.ts:440
• set showHelper(value): void
Parameters
| Name | Type |
|---|---|
value | boolean |
Returns
void
Defined in
src/interaction/ViewRoaming/index.ts:444
Methods
resume
▸ resume(): void
继续漫游。暂停漫游见 pause。
Returns
void
Defined in
src/interaction/ViewRoaming/index.ts:145
pause
▸ pause(): void
暂停漫游。继续漫游见 resume。
Returns
void
Defined in
src/interaction/ViewRoaming/index.ts:152
setRoamingViews
▸ setRoamingViews(roamingViews): void
设置视点数组。一个视点为一个对象，定义为一个世界坐标和一个世界坐标系下的方位（一个方向和一个 up 轴组成一个方位）。 最后一个视点的 duration、delay、easingFunction 会被忽略，因为已到达终点，漫游结束。 提示：相机的世界坐标、方向和 up 轴可直接读取自 camera.positionWC、camera.directionWC 和 camera.upWC。 更多缓动函数，见 http://47.92.86.16:8700/cesium/Build/Documentation/EasingFunction.html?classFilter=EasingFunction
Parameters
| Name | Type | Description |
|---|---|---|
roamingViews | RoamingViews[] | 视点数组。每个视点需包含相机的世界坐标、方向和 up 轴，还有可选的持续时间、延迟时间和缓动函数。 |
Returns
void
Example
js
const viewRoaming = new joDVF.ViewRoaming(viewer);
// 相机的世界坐标、方向和 up 轴可直接读取自 camera.positionWC 、camera.directionWC 和 camera.upWC
viewRoaming.setRoamingViews([
{
x: -2331367.832195439,
y: 5383103.437110797,
z: 2495188.4131367374,
directionX: 0.8954760019355185,
directionY: 0.14254199547129612,
directionZ: 0.4216687200690141,
upX: -0.32832549033505276,
upY: 0.8511760136908274,
upZ: 0.40951406094741083,
easingFunction: Cesium.EasingFunction.QUADRACTIC_OUT
},
{
x: -2331324.2426973204,
y: 5383112.224099962,
z: 2495212.0369561943,
directionX: 0.7878611540458561,
directionY: 0.04695020449907578,
directionZ: 0.6140606486683761,
upX: -0.35931373394010874,
upY: 0.8448355685472831,
upZ: 0.3964170817704577,
duration: 5000,
delay: 1000,
easingFunction: Cesium.EasingFunction.QUADRACTIC_IN
}
]);
viewRoaming.start();Defined in
src/interaction/ViewRoaming/index.ts:200
start
▸ start(repeat): void
开始漫游。漫游之前需要先设置视点，见 setRoamingViews。
Parameters
| Name | Type | Description |
|---|---|---|
repeat | boolean | 是否循环漫游。注意，如果传入该参数则会修改 ViewRoaming#repeat 的值。 |
Returns
void
Defined in
src/interaction/ViewRoaming/index.ts:371
stop
▸ stop(): void
停止漫游。停止漫游后可重新开始漫游，见 ViewRoaming#start。
Returns
void
Defined in
src/interaction/ViewRoaming/index.ts:395
destroy
▸ destroy(): void
销毁。释放资源，例如移除监听函数。如果不再使用该实例，请务必调用该方法。
Returns
void
Defined in
src/interaction/ViewRoaming/index.ts:408