160 lines
3.5 KiB
Markdown
160 lines
3.5 KiB
Markdown
---
|
||
outline: [2, 3]
|
||
---
|
||
|
||
# BloomPass
|
||
|
||
- 源文件：`packages/sdk/src/passes/BloomPass.ts`
|
||
- 文档位置：`packages/docs/api/passes/BloomPass.md`
|
||
|
||
## 类：`BloomPass`
|
||
|
||
- 作用：Bloom 通道 用于为场景添加 bloom 效果（光晕效果）
|
||
|
||
### 构造函数
|
||
|
||
#### `new BloomPass()`
|
||
|
||
- 作用：构造函数
|
||
|
||
- 入参：无
|
||
|
||
- 出参：`BloomPass`
|
||
- 返回说明：返回当前类实例。
|
||
|
||
### 属性
|
||
|
||
| 属性名 | 可见性 | 类型 | 作用 |
|
||
| --- | --- | --- | --- |
|
||
| `bloomPass` | `public` | `any` | 用于保存 `bloomPass` 对应的数据。 |
|
||
| `highlightedObjects` | `public` | `Map<THREE.Object3D, THREE.Color>` | 用于保存 `highlightedObjects` 的映射关系。 |
|
||
|
||
### 方法
|
||
|
||
#### `init(): void`
|
||
|
||
- 作用：初始化 Bloom 通道
|
||
|
||
- 入参：无
|
||
|
||
- 出参：`void`
|
||
- 返回说明：无返回值。
|
||
|
||
#### `getOutputNode(scenePassColor: any): any`
|
||
|
||
- 作用：获取 Bloom 效果的输出节点
|
||
|
||
- 入参：
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
| --- | --- | --- | --- |
|
||
| `scenePassColor` | `any` | 是 | - 场景通道的颜色输出节点 |
|
||
|
||
- 出参：`any`
|
||
- 返回说明：Bloom 效果的输出节点
|
||
|
||
#### `setThreshold(value: number): void`
|
||
|
||
- 作用：设置 Bloom 阈值
|
||
|
||
- 入参：
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
| --- | --- | --- | --- |
|
||
| `value` | `number` | 是 | - 阈值，范围 0.0 到 1.0 |
|
||
|
||
- 出参：`void`
|
||
- 返回说明：无返回值。
|
||
|
||
#### `setStrength(value: number): void`
|
||
|
||
- 作用：设置 Bloom 强度
|
||
|
||
- 入参：
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
| --- | --- | --- | --- |
|
||
| `value` | `number` | 是 | - 强度，范围 0.0 到 3.0 |
|
||
|
||
- 出参：`void`
|
||
- 返回说明：无返回值。
|
||
|
||
#### `setRadius(value: number): void`
|
||
|
||
- 作用：设置 Bloom 半径
|
||
|
||
- 入参：
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
| --- | --- | --- | --- |
|
||
| `value` | `number` | 是 | - 半径，范围 0.0 到 1.0 |
|
||
|
||
- 出参：`void`
|
||
- 返回说明：无返回值。
|
||
|
||
#### `addHighlightedObject(object: THREE.Object3D, highlightColor: THREE.Color = new THREE.Color(0, 1, 0)): void`
|
||
|
||
- 作用：添加要高亮的对象
|
||
|
||
- 入参：
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
| --- | --- | --- | --- |
|
||
| `object` | `THREE.Object3D` | 是 | - 要高亮的对象 |
|
||
| `highlightColor` | `THREE.Color` | 否 | - 高亮颜色，默认为绿色 (0, 1, 0) |
|
||
|
||
- 出参：`void`
|
||
- 返回说明：无返回值。
|
||
|
||
#### `removeHighlightedObject(object: THREE.Object3D): void`
|
||
|
||
- 作用：移除要高亮的对象
|
||
|
||
- 入参：
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
| --- | --- | --- | --- |
|
||
| `object` | `THREE.Object3D` | 是 | - 要移除的对象 |
|
||
|
||
- 出参：`void`
|
||
- 返回说明：无返回值。
|
||
|
||
#### `clearHighlightedObjects(): void`
|
||
|
||
- 作用：清空所有要高亮的对象
|
||
|
||
- 入参：无
|
||
|
||
- 出参：`void`
|
||
- 返回说明：无返回值。
|
||
|
||
#### `getHighlightedObjects(): THREE.Object3D<THREE.Object3DEventMap>[]`
|
||
|
||
- 作用：获取当前高亮的对象列表
|
||
|
||
- 入参：无
|
||
|
||
- 出参：`THREE.Object3D<THREE.Object3DEventMap>[]`
|
||
- 返回说明：高亮的对象列表
|
||
|
||
#### `isObjectHighlighted(object: THREE.Object3D): boolean`
|
||
|
||
- 作用：检查对象是否在高亮列表中
|
||
|
||
- 入参：
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
| --- | --- | --- | --- |
|
||
| `object` | `THREE.Object3D` | 是 | - 要检查的对象 |
|
||
|
||
- 出参：`boolean`
|
||
- 返回说明：是否在高亮列表中
|
||
|
||
## 构造示例
|
||
|
||
- 当前 Demo 中没有直接展示 `BloomPass` 的构造调用。
|
||
|
||
## 函数示例
|
||
|
||
- 当前 Demo 中没有直接展示 `BloomPass` 的公开方法调用。
|