141 lines
2.8 KiB
Markdown
141 lines
2.8 KiB
Markdown
---
|
||
outline: [2, 3]
|
||
---
|
||
|
||
# CSS2DRendererManager
|
||
|
||
- 源文件：`packages/sdk/src/manager/CSS2DRendererManager.ts`
|
||
- 文档位置：`packages/docs/api/manager/CSS2DRendererManager.md`
|
||
|
||
## 类：`CSS2DRendererManager`
|
||
|
||
- 作用：CSS2D 渲染管理类 负责管理 CSS2D 渲染器和 CSS2D 对象
|
||
|
||
### 构造函数
|
||
|
||
#### `new CSS2DRendererManager(viewer: Viewer)`
|
||
|
||
- 作用：构造函数
|
||
|
||
- 入参：
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
| --- | --- | --- | --- |
|
||
| `viewer` | `Viewer` | 是 | - 视图实例 |
|
||
|
||
- 出参：`CSS2DRendererManager`
|
||
- 返回说明：返回当前类实例。
|
||
|
||
### 属性
|
||
|
||
| 属性名 | 可见性 | 类型 | 作用 |
|
||
| --- | --- | --- | --- |
|
||
| `renderer` | `public` | `CSS2DRenderer` | CSS2D 渲染器 |
|
||
| `viewer` | `public` | `Viewer` | 视图实例 |
|
||
| `objects` | `public` | `Map<string, CSS2DObject>` | CSS2D 对象集合 |
|
||
|
||
### 方法
|
||
|
||
#### `init(): void`
|
||
|
||
- 作用：初始化 CSS2D 渲染器
|
||
|
||
- 入参：无
|
||
|
||
- 出参：`void`
|
||
- 返回说明：无返回值。
|
||
|
||
#### `handleResize(): void`
|
||
|
||
- 作用：处理窗口大小变化
|
||
|
||
- 入参：无
|
||
|
||
- 出参：`void`
|
||
- 返回说明：无返回值。
|
||
|
||
#### `createObject(element: HTMLElement, position: THREE.Vector3): CSS2DObject`
|
||
|
||
- 作用：创建 CSS2D 对象
|
||
|
||
- 入参：
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
| --- | --- | --- | --- |
|
||
| `element` | `HTMLElement` | 是 | - DOM 元素 |
|
||
| `position` | `THREE.Vector3` | 是 | - 位置 |
|
||
|
||
- 出参：`CSS2DObject`
|
||
- 返回说明：CSS2D 对象
|
||
|
||
#### `addObject(object: CSS2DObject, parent: THREE.Object3D = this.viewer.scene): void`
|
||
|
||
- 作用：添加 CSS2D 对象到场景
|
||
|
||
- 入参：
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
| --- | --- | --- | --- |
|
||
| `object` | `CSS2DObject` | 是 | - CSS2D 对象 |
|
||
| `parent` | `THREE.Object3D` | 否 | - 父对象，默认为场景 |
|
||
|
||
- 出参：`void`
|
||
- 返回说明：无返回值。
|
||
|
||
#### `removeObject(object: CSS2DObject): void`
|
||
|
||
- 作用：从场景中移除 CSS2D 对象
|
||
|
||
- 入参：
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
| --- | --- | --- | --- |
|
||
| `object` | `CSS2DObject` | 是 | - CSS2D 对象 |
|
||
|
||
- 出参：`void`
|
||
- 返回说明：无返回值。
|
||
|
||
#### `render(): void`
|
||
|
||
- 作用：渲染 CSS2D 场景
|
||
|
||
- 入参：无
|
||
|
||
- 出参：`void`
|
||
- 返回说明：无返回值。
|
||
|
||
#### `dispose(): void`
|
||
|
||
- 作用：清理资源
|
||
|
||
- 入参：无
|
||
|
||
- 出参：`void`
|
||
- 返回说明：无返回值。
|
||
|
||
#### `getRenderer(): CSS2DRenderer`
|
||
|
||
- 作用：获取 CSS2D 渲染器实例
|
||
|
||
- 入参：无
|
||
|
||
- 出参：`CSS2DRenderer`
|
||
- 返回说明：CSS2D 渲染器
|
||
|
||
#### `getObjects(): CSS2DObject[]`
|
||
|
||
- 作用：获取所有 CSS2D 对象
|
||
|
||
- 入参：无
|
||
|
||
- 出参：`CSS2DObject[]`
|
||
- 返回说明：CSS2D 对象数组
|
||
|
||
## 构造示例
|
||
|
||
- 当前 Demo 中没有直接展示 `CSS2DRendererManager` 的构造调用。
|
||
|
||
## 函数示例
|
||
|
||
- 当前 Demo 中没有直接展示 `CSS2DRendererManager` 的公开方法调用。
|