ThreeLayerInterface

自定义 three.js 图层接口。这是一份供实现者遵循的规范，并不是导出的方法或类。

自定义 three.js 图层包含一个 three.js (opens new window) 场景。开发者可以使用地图相机，直接在地图的 GL 上下文中渲染 three.js 对象。可以使用 Map#addLayer 将这些图层添加到地图。

自定义 three.js 图层必须具有唯一的 id，且 type 必须为 'three'。图层可以实现 onAdd、onRemove、prerender 和 render。

属性

id (string (opens new window))

图层的唯一 ID。

lightColor (number (opens new window) | Color (opens new window) | string (opens new window))

光源颜色。可以是十六进制颜色、three.js Color (opens new window) 实例或 CSS 样式字符串。省略时使用根据当前日期和时间计算的动态光源颜色。可以通过 light 事件或 Map#getLight 获取当前的动态光源。

maxzoom (number (opens new window))

图层的最大缩放级别。当缩放级别大于或等于 maxzoom 时，图层会隐藏。取值可以是 0 至 24（含）之间的任意数字。未提供 maxzoom 时，图层在所有缩放级别下均可见。

minzoom (number (opens new window))

图层的最小缩放级别。当缩放级别小于 minzoom 时，图层会隐藏。取值可以是 0 至 24（含）之间的任意数字。未提供 minzoom 时，图层在所有缩放级别下均可见。

type (string (opens new window))

图层类型。必须为 'three'。

实例成员

onAdd(map, context)

通过 Map#addLayer 将图层添加到 Map 时调用的可选方法。图层可以借此初始化 three.js 资源并注册事件监听器。

参数

map (Map) 刚刚添加此图层的 Mini Tokyo 3D Map。

context (Object (opens new window)) 此图层包含的 three.js 渲染器、场景和相机。

名称	说明
context.camera PerspectiveCamera (opens new window)	相机对象。
context.renderer WebGLRenderer (opens new window)	渲染器对象。
context.scene Scene (opens new window)	场景对象。

---

onRemove(map, context)

通过 Map#removeLayer 从 Map 中移除图层时调用的可选方法。图层可以借此清理 three.js 资源和事件监听器。

参数

map (Map) 刚刚移除此图层的 Mini Tokyo 3D Map。

context (Object (opens new window)) 此图层包含的 three.js 渲染器、场景和相机。

名称	说明
context.camera PerspectiveCamera (opens new window)	相机对象。
context.renderer WebGLRenderer (opens new window)	渲染器对象。
context.scene Scene (opens new window)	场景对象。

---

prerender(map, context)

在每个渲染帧中、绘制场景之前调用的可选方法。图层可以借此更新对象、uniform 或动画，或渲染到最终绘制将使用的离屏目标。图层不得假定任何特定的 GL 状态，且在渲染之前必须绑定帧缓冲。

参数

map (Map) 此图层所属的 Mini Tokyo 3D Map。

context (Object (opens new window)) 此图层包含的 three.js 渲染器、场景和相机。

名称	说明
context.camera PerspectiveCamera (opens new window)	相机对象。
context.renderer WebGLRenderer (opens new window)	渲染器对象。
context.scene Scene (opens new window)	场景对象。

---

render(map, context)

在每个渲染帧中绘制图层时调用的可选方法。实现后，该方法负责最终绘制，可以渲染到离屏目标并执行后处理（例如泛光），然后再合成到地图上。相机、光源和雾均已配置完毕。未实现时，将使用默认渲染器绘制图层的场景。

参数

map (Map) 此图层所属的 Mini Tokyo 3D Map。

context (Object (opens new window)) 此图层包含的 three.js 渲染器、场景和相机。

名称	说明
context.camera PerspectiveCamera (opens new window)	相机对象。
context.renderer WebGLRenderer (opens new window)	渲染器对象。
context.scene Scene (opens new window)	场景对象。