RoamConfigProvider - CooSDK Documentation

new CooSDK.RoamConfigProvider(props)

键盘漫游热键配置对象，可以自定义改变CooRun SDK的漫游方式，速度以及键盘控制按键。

Name Type Description

props

Object

optional

包含如下属性的Object：

Name	Type	Default	Description
`areaColor`	ColorObj	`new ColorObj(0.059, 0.165, 0.271, 0.75)`	optional 漫游限制区域颜色（默认科技蓝）。
`areaGradient`	Number	`60`	optional 漫游限制区域梯度，以倾斜边与水平方向的水平角度为准，不可为负。
`areaMaxHeight`	Number		漫游限制区域最大高度。
`areaMinHeight`	Number		漫游限制区域最小高度。
`areaPointArray`	Array.<PositionObj>		漫游限制区域边界点。
`areaWheelSpeedScale`	Number	`0.35`	optional 鼠标滚轮漫游速度缩放比例，默认0.35。
`isAreaVisible`	Boolean	`true`	optional 是否显示漫游限制区域。
`isMouseLDClick`	Boolean	`true`	optional 鼠标左键双击定位是否触发飞行动作。
`isRoateAroundEarth`	Boolean	`true`	optional 是否配置场景拖动惯性效果。
`isReset`	Boolean	`false`	optional 是否重置漫游配置。
`isSetHotkey`	Boolean	`false`	optional 是否生效热键配置。
`keyBackward`	String	`"S"`	optional 后退键。
`keyForward`	String	`"W"`	optional 前进键。
`keyHeightDown`	String	`"G"`	optional 高度下降键。
`keyHeightUp`	String	`"T"`	optional 高度抬升键。
`keyHome`	String	`"H"`	optional 主页键。
`keyLeft`	String	`"A"`	optional 向左移动键。
`keyMoveSpeed`	Number	`1.0`	optional 键盘控制场景移动的速度，单位：米。
`keyMoveSpeedUp`	String	`"↑"`	optional 移动速度增加键。
`keyMoveSpeedDown`	String	`"↓"`	optional 移动速度减小键。
`keyRight`	String	`"D"`	optional 向右移动键。
`keyRotateDown`	String	`"F"`	optional 向下低头键。
`keyRotateSpeed`	Number	`1`	optional 键盘控制场景旋转的速度，单位：度。
`keyRotateSpeedDown`	String	`"→"`	optional 旋转速度减小键。
`keyRotateSpeedUp`	String	`"←"`	optional 旋转速度增加键。
`keyRotateUp`	String	`"R"`	optional 向上抬头键。
`keyTurnLeft`	String	`"Q"`	optional 向左旋转键。
`keyTurnRight`	String	`"E"`	optional 向右旋转键。
`maxHeight`	Number		optional 最大漫游高度。
`minHeight`	Number		optional 最低漫游高度。
`mouseSpeedScale`	Number	`1.0`	optional 鼠标漫游速度缩放比例，默认1，取值必须大于0.1。
`roamEnable`	EnumRoamEnable	`EnumRoamEnable.BOTH`	optional 漫游启用类型，可控制鼠标、键盘是否能控制场景。
`roamMode`	EnumRoamMode	`EnumRoamMode.NORMAL`	optional 待修改的漫游模式。
`roamType`	EnumRoamType	`EnumRoamType.ALL`	optional 漫游相交类型，设定指定类型后将只在该图层进行漫游生效。
`screen`	CooMap \| ScreenObj	`null`	optional 所属窗口，默认为CooMap所拥有的主窗口。

Example:

// 修改键盘移动、旋转速度
var roamConfigProvider = new CooSDK.RoamConfigProvider({
     roamMode: CooSDK.EnumRoamMode.NORMAL,
     keyMoveSpeed: 0.1,
     keyRotateSpeed: 0.5
});

Demo:

CooSDK Application 漫游参数及键盘热键配置demo

Members

areaColor : ColorObj

获取或者设置漫游限制区域颜色（默认科技蓝）。

Default Value: new ColorObj(0.059, 0.165, 0.271, 0.75)

areaGradient : Number

获取或者设置漫游限制区域梯度，以倾斜边与水平方向的水平角度为准，不可为负。

Default Value: 60

areaMaxHeight : Number

获取或者设置漫游限制区域最大高度。

areaMinHeight : Number

获取或者设置漫游限制区域最小高度。

areaPointArray : Array.<PositionObj>

获取或者设置漫游限制区域边界点。

areaWheelSpeedScale : Number

获取或者设置鼠标滚轮漫游速度缩放比例，默认0.35。

Default Value: 0.35

isAreaVisible : Boolean

获取或者设置是否显示漫游限制区域。

Default Value: true

isMouseLDClick : Boolean

获取或者设置鼠标左键双击定位是否触发飞行动作。

Default Value: true

isReset : Boolean

获取或者设置是否重置漫游配置。

Default Value: false

isRoateAroundEarth : Boolean

获取或者设置是否配置场景拖动惯性效果。

Default Value: true

isSetHotkey : Boolean

获取或者设置是否生效热键配置。

Default Value: false

keyBackward : String

获取或者设置后退键。

Default Value: "S"

keyForward : String

获取或者设置前进键。

Default Value: "W"

keyHeightDown : String

获取或者设置高度下降键。

Default Value: "G"

keyHeightUp : String

获取或者设置高度抬升键。

Default Value: "T"

keyHome : String

获取或者设置主页键。

Default Value: "H"

keyLeft : String

获取或者设置向左移动键。

Default Value: "A"

keyMoveSpeed : Number

获取或者设置键盘移动速度。

Default Value: 1.0

keyMoveSpeedDown : String

获取或者设置移动速度减小键。

Default Value: "↓"

keyMoveSpeedUp : String

获取或者设置移动速度增加键。

Default Value: "↑"

keyRight : String

获取或者设置向右移动键。

Default Value: "D"

keyRotateDown : String

获取或者设置向下低头键。

Default Value: "F"

keyRotateSpeed : Number

获取或者设置键盘旋转速度。

Default Value: 5.7295779513082330

keyRotateSpeedDown : String

获取或者设置旋转速度减小键。

Default Value: "→"

keyRotateSpeedUp : String

获取或者设置旋转速度增加键。

Default Value: "←"

keyRotateUp : String

获取或者设置向上抬头键。

Default Value: "R"

keyTurnLeft : String

获取或者设置向左旋转键。

Default Value: "Q"

keyTurnRight : String

获取或者设置向右旋转键。

Default Value: "E"

maxHeight : Number

获取或者设置漫游最大高度。

minHeight : Number

获取或者设置漫游最小高度。

mouseSpeedScale : Number

获取或者设置鼠标漫游速度缩放比例，默认1，取值必须大于0.1。

Default Value: 1.0

roamEnable : EnumRoamEnable

获取或者设置漫游启用类型，可控制鼠标、键盘是否能控制场景。

Default Value: EnumRoamEnable.BOTH

roamMode : EnumRoamMode

获取或者设置待修改的漫游模式。

Default Value: EnumRoamMode.NORMAL

roamType : EnumRoamType

获取或者设置漫游相交类型,设定指定类型后将只在该图层进行漫游生效。

Default Value: EnumRoamType.ALL

screen : CooMap|ScreenObj

获取或者设置所属窗口，默认为CooMap所拥有的主窗口。

Default Value: null

Methods

destroy()

从场景中销毁自身。

Returns:

null 空值。

Example:

// 销毁对象
roamConfigProvider = roamConfigProvider.destroy();

update(props)

更新单个或者多个对象属性，使之立即生效。

一般用于多个属性的同时更新，避免性能开销过大。

Name Type Description

props

Object

optional

包含如下属性的Object：

Name	Type	Default	Description
`areaColor`	ColorObj		optional 漫游限制区域颜色（默认科技蓝）。
`areaGradient`	Number		optional 漫游限制区域梯度，以倾斜边与水平方向的水平角度为准，不可为负。
`areaMaxHeight`	Number		optional 漫游限制区域最大高度。
`areaMinHeight`	Number		optional 漫游限制区域最小高度。
`areaPointArray`	Array.<PositionObj>		optional 漫游限制区域边界点。
`areaWheelSpeedScale`	Number		optional 鼠标滚轮漫游速度缩放比例，默认0.35。
`isAreaVisible`	Boolean	`true`	optional 是否显示漫游限制区域。
`isMouseLDClick`	Boolean	`true`	optional 鼠标左键双击定位是否触发飞行动作。
`isReset`	Boolean		optional 是否重置漫游配置。
`isRoateAroundEarth`	Boolean		optional 是否配置场景拖动惯性效果。
`isSetHotkey`	Boolean		optional 是否生效热键配置。
`keyBackward`	String		optional 后退键。
`keyForward`	String		optional 前进键。
`keyHeightDown`	String		optional 高度下降键。
`keyHeightUp`	String		optional 高度抬升键。
`keyHome`	String		optional 主页键。
`keyLeft`	String		optional 向左移动键。
`keyMoveSpeed`	Number		optional 键盘控制场景移动的速度，单位：米。
`keyMoveSpeedDown`	String		optional 移动速度减小键。
`keyMoveSpeedUp`	String		optional 移动速度增加键。
`keyRight`	String		optional 向右移动键。
`keyRotateDown`	String		optional 向下低头键。
`keyRotateSpeed`	Number		optional 键盘控制场景旋转的速度，单位：度。
`keyRotateSpeedDown`	String		optional 旋转速度减小键。
`keyRotateSpeedUp`	String		optional 旋转速度增加键。
`keyRotateUp`	String		optional 向上抬头键。
`keyTurnLeft`	String		optional 向左旋转键。
`keyTurnRight`	String		optional 向右旋转键。
`maxHeight`	Number		optional 最大漫游高度。
`minHeight`	Number		optional 最低漫游高度。
`mouseSpeedScale`	Number		optional 鼠标漫游速度缩放比例，默认1，取值必须大于0.1。
`roamEnable`	EnumRoamEnable		optional 漫游启用类型，可控制鼠标、键盘是否能控制场景。
`roamMode`	EnumRoamMode		optional 待修改的漫游模式。
`roamType`	EnumRoamType		optional 漫游相交类型。

Example:

// 修改键盘热键映射
roamConfigProvider.update({
   isSetHotkey: true,
   keyHome : "L"
});