85 lines
1.8 KiB
Markdown
85 lines
1.8 KiB
Markdown
---
|
||
outline: [2, 3]
|
||
---
|
||
|
||
# ParametricRing
|
||
|
||
- 源文件：`packages/sdk/src/parametric/ParametricRing.ts`
|
||
- 文档位置：`packages/docs/api/parametric/ParametricRing.md`
|
||
|
||
## 类：`ParametricRing`
|
||
|
||
- 作用：高精度参数化圆环 支持完全自定义的圆环生成，包括内外半径、分段数等参数 可用于创建套管损害、裂缝等可视化效果
|
||
- 继承/实现：`extends Mesh<BufferGeometry, Material>；implements IParametricGeometry`
|
||
|
||
### 构造函数
|
||
|
||
#### `new ParametricRing(options: IRingOptions = {})`
|
||
|
||
- 作用：创建参数化圆环
|
||
|
||
- 入参：
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
| --- | --- | --- | --- |
|
||
| `options` | `IRingOptions` | 否 | - 圆环配置选项 |
|
||
|
||
- 出参：`ParametricRing`
|
||
- 返回说明：返回当前类实例。
|
||
|
||
### 属性
|
||
|
||
| 属性名 | 可见性 | 类型 | 作用 |
|
||
| --- | --- | --- | --- |
|
||
| `options` | `public` | `Required<IRingOptions>` | 用于保存 `options` 对应的数据。 |
|
||
|
||
### 方法
|
||
|
||
#### `createGeometry(): RingGeometry`
|
||
|
||
- 作用：创建圆环几何体
|
||
|
||
- 入参：无
|
||
|
||
- 出参：`RingGeometry`
|
||
- 返回说明：返回 `RingGeometry`。
|
||
|
||
#### `updateParameters(options: Partial<IRingOptions>): void`
|
||
|
||
- 作用：更新圆环参数
|
||
|
||
- 入参：
|
||
|
||
| 参数名 | 类型 | 必填 | 说明 |
|
||
| --- | --- | --- | --- |
|
||
| `options` | `Partial<IRingOptions>` | 是 | - 新的圆环配置选项 |
|
||
|
||
- 出参：`void`
|
||
- 返回说明：无返回值。
|
||
|
||
#### `updateGeometry(): void`
|
||
|
||
- 作用：更新几何体
|
||
|
||
- 入参：无
|
||
|
||
- 出参：`void`
|
||
- 返回说明：无返回值。
|
||
|
||
#### `dispose(): void`
|
||
|
||
- 作用：销毁资源
|
||
|
||
- 入参：无
|
||
|
||
- 出参：`void`
|
||
- 返回说明：无返回值。
|
||
|
||
## 构造示例
|
||
|
||
- 当前 Demo 中没有直接展示 `ParametricRing` 的构造调用。
|
||
|
||
## 函数示例
|
||
|
||
- 当前 Demo 中没有直接展示 `ParametricRing` 的公开方法调用。
|