Class: BaseScene

// ES5 引入方式
const { BaseScene } = zondy.layer

// ES6 引入方式
import { BaseScene } from '@mapgis/webclient-common'

const scene = new BaseScene({
  sceneIndex: 0,
  sceneName: '主场景'
})

Extends

• Evented

Members

allSublayersCollection

当前场景下扁平化后的全部子图层集合。

该属性基于 sublayers 动态展开多层嵌套子图层，返回顺序与层级遍历顺序一致。

extendedPropsObject

当前场景的扩展属性。

该属性通常用于保留服务端附加字段或业务自定义配置。

layerSceneLayer null

当前场景所属的场景服务图层。

该属性仅在运行时用于建立场景与其父级图层之间的关联关系，toJSON 不会导出该属性。

sceneIndexNumber

当前场景在场景文档中的顺序索引。

该值来源于初始化配置或服务元信息，创建后通常作为只读标识使用。

sceneModeString

当前场景模式或场景类型标识。

该属性来源于初始化配置，用于区分不同场景模式。

sceneNameString

当前场景名称。

该值通常来源于服务配置，可用于场景列表展示或按名称定位场景。

sceneRangeExtent null

当前场景的范围。

该属性来自初始化配置或 JSON 恢复结果，通常用于描述场景包围盒；未提供时为 null。

sublayersCollection null

当前场景的直接子图层集合。

该属性来源于初始化配置；当传入数组时会自动转换为 SubLayer 集合，并为每个子图层补充父级图层关联。

Methods

clone(){BaseScene}

document/layer/BaseScene.js, line 189

克隆当前基础场景对象。

会基于当前实例的序列化结果创建新的 BaseScene 实例，适用于复制场景配置而不共享引用。

Returns:

Type	Description
BaseScene	克隆后的基础场景对象。

findSublayerById(id){SceneSubLayer|null}

document/layer/BaseScene.js, line 136

根据子图层 id 查找场景中的子图层。

该方法会在 allSublayers 扁平集合中检索，适用于从多层嵌套子图层结构中快速定位目标子图层。

Name	Type	Description
id	String | Number	子图层 id。

Returns:

Type	Description
SceneSubLayer | null	匹配到的子图层；未找到时返回 null。

inherited fire(type, data, propagate){Object}

base/Evented.js, line 523

激发指定类型的事件

Name	Type	Description
type	string	可选 事件类型
data	Object	可选 待传递的数据
propagate	Boolean	可选 是否传播到父级

Returns:

Type	Description
Object	当前实例

inherited off(types, fn, context){Object}

base/Evented.js, line 337

移除事件
示例如下:
[1、移除一个事件的指定回调函数]
[2、移除一个事件的所有回调函数]
[3、移除多个事件的同一个指定的回调函数]
[4、移除多个指定事件的回调函数]
[5、删除时指定上下文 - types类型为字符串]
[6、删除时指定上下文 - types类型为对象]

Name	Type	Description
types	string	可选 移除指定事件类型上绑定的回调函数 当类型为字符串时，可以移除单个或多个事件类型绑定的回调函数，单个事件："click"，多个事件：以空格分割:"click double-click"； 当types为对象时，使用如下方式移除事件：{'click': onClickFun, 'mouse-move': onMouseMoveFun}
fn	function	可选 事件回调函数，当types为字符串，且不指定要删除的回调函数时，删除该事件上的所有回调函数
context	Object	可选 事件回调函数的this关键字将指向的对象

Returns:

Type	Description
Object	当前实例

Examples

移除一个事件的指定回调函数

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
}
// 调用MapView或SceneView的off方法移除一个事件的回调函数
view.off('click', clickFunction)

移除一个事件的所有回调函数

// 一个事件的回调函数1
const clickFunction1 = function (event) {
  console.log("点击事件1:", event)
}

// 一个事件的回调函数2
const clickFunction2 = function (event) {
  console.log("点击事件2:", event)
}

// 调用MapView或SceneView的off方法移除一个事件的所有回调函数
// 不指定回调函数，则移除该事件上的所有绑定的回调函数
view.off('click')

移除多个事件的同一个指定的回调函数

// 多个事件的同一个回调函数
const eventFunction = function (event) {
  console.log("事件:", event)
}
// 调用MapView或SceneView的off方法移除多个事件的同一个指定的回调函数
view.off('click double-click', eventFunction)

移除多个指定事件的回调函数

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("click事件:", event)
}
// 调用MapView或SceneView的off方法移除多个指定事件的回调函数
view.off({
   // 移除click事件上一个指定的函数
  "click": clickFunction,
  // 移除double-click上所有指定的函数
  "double-click": undefined
})

删除时指定上下文 - types类型为字符串

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
}
// 调用MapView或SceneView的off方法移除一个事件的回调函数
view.off('click', clickFunction, view)
// 调用MapView或SceneView的off方法移除一个事件的所有回调函数
view.off('click', undefined, view)

删除时指定上下文 - types类型为对象

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("click事件:", event)
}
// 调用MapView或SceneView的off方法移除多个指定事件的回调函数
view.off({
   // 移除click事件上一个指定的函数
  "click": clickFunction,
  // 移除double-click上所有指定的函数
  "double-click": undefined
}, view)

inherited on(types, fn, context){Object}

base/Evented.js, line 240

注册一个新的监听事件;
示例如下：
[1、注册一个事件]
[2、一次注册多个事件 - 同一个回调函数]
[3、一次注册多个事件 - 分别指回调应函数]
[4、当types为字符串时 - 指定上下文]
[5、当types为对象时 - 指定上下文]

Name	Type	Default	Description
types	String | Object	null	可选 事件类型 当types为字符串时，可以定义单个或多个事件，单个事件："click"，多个事件：以空格分割:"click double-click"； 当types为对象时，使用如下方式指定事件：{'click': onClickFun, 'mouse-move': onMouseMoveFun}
fn	function	null	可选 事件回调函数
context	Object	null	可选 事件回调函数的this关键字将指向的对象

Returns:

Type	Description
Object	当前实例

Examples

注册一个事件

// 初始化一个点击事件回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
}
// 调用MapView或SceneView的on方法注册一个点击事件
view.on('click', clickFunction)

一次注册多个事件 - 同一个回调函数

// 初始化一个事件回调函数
const eventFunction = function (event) {
  console.log("事件:", event)
}

// 调用MapView或SceneView的on方法注册多个事件
// 多个事件类型使用同一个回调函数
view.on('click right-click-down', eventFunction)

一次注册多个事件 - 分别指回调应函数

// 初始化一个左键点击事件回调函数
const clickFunction = function (event) {
  console.log("click事件:", event)
}

// 初始化一个右键按下事件回调函数
const rightClickFunction = function (event) {
  console.log("right-click-down事件:", event)
}

// 调用MapView或SceneView的on方法注册多个事件
// 每一个事件类型，使用单独的回调函数
// 注意使用此种方式，一种类型的事件仅能指定一个回调函数
view.on({
  "click": clickFunction,
  "right-click-down": rightClickFunction
})

指定上下文 - types类型为字符串

// 初始化一个点击事件回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
  console.log("上下文对象:", this)
}
// 调用MapView或SceneView的on方法注册一个点击事件
// 指定view为回调函数的上下文对象
view.on('click', clickFunction, view)

指定上下文 - types类型为对象

// 初始化一个点击事件回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
  console.log("上下文对象:", this)
}
// 调用MapView或SceneView的on方法注册一个点击事件
// 指定view为回调函数的上下文对象
view.on({
  "click": clickFunction,
  "right-click-down": clickFunction
}, view)

inherited once(types, fn, context){Object}

base/Evented.js, line 592

事件监听，仅触发一次

Name	Type	Description
types	string	可选 将侦听器函数（fn）添加到对象的特定事件类型中。您还可以传递几个空格分隔的类型（例如“click dblclick”），也可以传入例如 {click: onClick, mousemove: onMouseMove}。
fn	function	可选 侦听器函数
context	Object	可选 指定侦听器的上下文（this关键字将指向的对象）

Returns:

Type	Description
Object	当前实例

toJSON(){Object}

document/layer/BaseScene.js, line 151

导出为 JSON 配置。

返回结果包含当前场景的基础属性、范围、扩展属性和可序列化的直接子图层信息，不包含运行时关联的 layer 属性。

Returns:

Type	Description
Object	场景配置对象。

BaseScene.fromJSON(json){BaseScene}

document/layer/BaseScene.js, line 176

通过 JSON 配置创建一个新的基础场景对象。

适用于从持久化配置或服务响应结果中恢复 BaseScene 实例，通常与 toJSON 配套使用。

Name	Type	Default	Description
json	Object	{}	可选 场景配置对象。

Returns:

Type	Description
BaseScene	新的基础场景对象。