feat(all): init commit

This commit is contained in:
plum
2026-04-19 18:46:28 +08:00
commit 5d7f479765
479 changed files with 178500 additions and 0 deletions
@@ -0,0 +1,35 @@
---
outline: [2, 3]
---
# MaterialFactory
- 源文件:`packages/sdk/src/materials/MaterialFactory.ts`
- 文档位置:`packages/docs/api/materials/MaterialFactory.md`
## 类:`MaterialFactory`
- 作用:岩石材质基类 提供纹理加载和材质创建的通用功能
### 方法
#### `configureTexture(texture: THREE.Texture): void`
- 作用:配置纹理属性
- 入参:
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `texture` | `THREE.Texture` | 是 | - 要配置的纹理 |
- 出参:`void`
- 返回说明:无返回值。
## 构造示例
- 当前 Demo 中没有直接展示 `MaterialFactory` 的构造调用。
## 函数示例
- 当前 Demo 中没有直接展示 `MaterialFactory` 的公开方法调用。
@@ -0,0 +1,57 @@
---
outline: [2, 3]
---
# Rock1Material
- 源文件:`packages/sdk/src/materials/Rock1Material.ts`
- 文档位置:`packages/docs/api/materials/Rock1Material.md`
## 类:`Rock1Material`
- 作用:岩石材质类(rock1
- 继承/实现:`extends MaterialFactory`
### 方法
#### `create(options: Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]> = {}, useDisplacement: boolean = true): THREE.MeshStandardMaterial`
- 作用:创建岩石材质(rock1
- 入参:
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `options` | `Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]>` | 否 | - MeshStandardMaterial参数选项,可覆盖默认设置 |
| `useDisplacement` | `boolean` | 否 | - 是否使用位移纹理设置,默认为true |
- 出参:`THREE.MeshStandardMaterial`
- 返回说明:THREE.MeshStandardMaterial - 带有岩石纹理的材质
## 函数:`createRock1Material`
- 作用:创建岩石材质(rock1)的便捷函数
### 签名
```ts
function createRock1Material(options: Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]> = {}, useDisplacement: boolean = true): THREE.MeshStandardMaterial
```
- 入参:
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `options` | `Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]>` | 否 | - MeshStandardMaterial参数选项,可覆盖默认设置 |
| `useDisplacement` | `boolean` | 否 | - 是否使用位移纹理设置,默认为true |
- 出参:`THREE.MeshStandardMaterial`
- 返回说明:THREE.MeshStandardMaterial - 带有岩石纹理的材质
## 构造示例
- 当前 Demo 中没有直接展示 `Rock1Material` 的构造调用。
## 函数示例
- 当前 Demo 中没有直接展示 `Rock1Material` 的公开方法调用。
@@ -0,0 +1,57 @@
---
outline: [2, 3]
---
# Rock2Material
- 源文件:`packages/sdk/src/materials/Rock2Material.ts`
- 文档位置:`packages/docs/api/materials/Rock2Material.md`
## 类:`Rock2Material`
- 作用:岩石材质类(rock2
- 继承/实现:`extends MaterialFactory`
### 方法
#### `create(options: Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]> = {}, useDisplacement: boolean = true): THREE.MeshStandardMaterial`
- 作用:创建岩石材质(rock2
- 入参:
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `options` | `Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]>` | 否 | - MeshStandardMaterial参数选项,可覆盖默认设置 |
| `useDisplacement` | `boolean` | 否 | - 是否使用位移纹理设置,默认为true |
- 出参:`THREE.MeshStandardMaterial`
- 返回说明:THREE.MeshStandardMaterial - 带有岩石纹理的材质
## 函数:`createRock2Material`
- 作用:创建岩石材质(rock2)的便捷函数
### 签名
```ts
function createRock2Material(options: Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]> = {}, useDisplacement: boolean = true): THREE.MeshStandardMaterial
```
- 入参:
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `options` | `Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]>` | 否 | - MeshStandardMaterial参数选项,可覆盖默认设置 |
| `useDisplacement` | `boolean` | 否 | - 是否使用位移纹理设置,默认为true |
- 出参:`THREE.MeshStandardMaterial`
- 返回说明:THREE.MeshStandardMaterial - 带有岩石纹理的材质
## 构造示例
- 当前 Demo 中没有直接展示 `Rock2Material` 的构造调用。
## 函数示例
- 当前 Demo 中没有直接展示 `Rock2Material` 的公开方法调用。
@@ -0,0 +1,57 @@
---
outline: [2, 3]
---
# Rock3Material
- 源文件:`packages/sdk/src/materials/Rock3Material.ts`
- 文档位置:`packages/docs/api/materials/Rock3Material.md`
## 类:`Rock3Material`
- 作用:岩石材质类(rock3
- 继承/实现:`extends MaterialFactory`
### 方法
#### `create(options: Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]> = {}, useDisplacement: boolean = true): THREE.MeshStandardMaterial`
- 作用:创建岩石材质(rock3
- 入参:
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `options` | `Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]>` | 否 | - MeshStandardMaterial参数选项,可覆盖默认设置 |
| `useDisplacement` | `boolean` | 否 | - 是否使用位移纹理设置,默认为true |
- 出参:`THREE.MeshStandardMaterial`
- 返回说明:THREE.MeshStandardMaterial - 带有岩石纹理的材质
## 函数:`createRock3Material`
- 作用:创建岩石材质(rock3)的便捷函数
### 签名
```ts
function createRock3Material(options: Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]> = {}, useDisplacement: boolean = true): THREE.MeshStandardMaterial
```
- 入参:
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `options` | `Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]>` | 否 | - MeshStandardMaterial参数选项,可覆盖默认设置 |
| `useDisplacement` | `boolean` | 否 | - 是否使用位移纹理设置,默认为true |
- 出参:`THREE.MeshStandardMaterial`
- 返回说明:THREE.MeshStandardMaterial - 带有岩石纹理的材质
## 构造示例
- 当前 Demo 中没有直接展示 `Rock3Material` 的构造调用。
## 函数示例
- 当前 Demo 中没有直接展示 `Rock3Material` 的公开方法调用。
@@ -0,0 +1,57 @@
---
outline: [2, 3]
---
# Rock4Material
- 源文件:`packages/sdk/src/materials/Rock4Material.ts`
- 文档位置:`packages/docs/api/materials/Rock4Material.md`
## 类:`Rock4Material`
- 作用:岩石材质类(rock4
- 继承/实现:`extends MaterialFactory`
### 方法
#### `create(options: Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]> = {}, useDisplacement: boolean = true): THREE.MeshStandardMaterial`
- 作用:创建岩石材质(rock4
- 入参:
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `options` | `Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]>` | 否 | - MeshStandardMaterial参数选项,可覆盖默认设置 |
| `useDisplacement` | `boolean` | 否 | - 是否使用位移纹理设置,默认为true |
- 出参:`THREE.MeshStandardMaterial`
- 返回说明:THREE.MeshStandardMaterial - 带有岩石纹理的材质
## 函数:`createRock4Material`
- 作用:创建岩石材质(rock4)的便捷函数
### 签名
```ts
function createRock4Material(options: Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]> = {}, useDisplacement: boolean = true): THREE.MeshStandardMaterial
```
- 入参:
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `options` | `Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]>` | 否 | - MeshStandardMaterial参数选项,可覆盖默认设置 |
| `useDisplacement` | `boolean` | 否 | - 是否使用位移纹理设置,默认为true |
- 出参:`THREE.MeshStandardMaterial`
- 返回说明:THREE.MeshStandardMaterial - 带有岩石纹理的材质
## 构造示例
- 当前 Demo 中没有直接展示 `Rock4Material` 的构造调用。
## 函数示例
- 当前 Demo 中没有直接展示 `Rock4Material` 的公开方法调用。
@@ -0,0 +1,57 @@
---
outline: [2, 3]
---
# Rock5Material
- 源文件:`packages/sdk/src/materials/Rock5Material.ts`
- 文档位置:`packages/docs/api/materials/Rock5Material.md`
## 类:`Rock5Material`
- 作用:岩石材质类(rock5
- 继承/实现:`extends MaterialFactory`
### 方法
#### `create(options: Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]> = {}, useDisplacement: boolean = true): THREE.MeshStandardMaterial`
- 作用:创建岩石材质(rock5
- 入参:
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `options` | `Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]>` | 否 | - MeshStandardMaterial参数选项,可覆盖默认设置 |
| `useDisplacement` | `boolean` | 否 | - 是否使用位移纹理设置,默认为true |
- 出参:`THREE.MeshStandardMaterial`
- 返回说明:THREE.MeshStandardMaterial - 带有岩石纹理的材质
## 函数:`createRock5Material`
- 作用:创建岩石材质(rock5)的便捷函数
### 签名
```ts
function createRock5Material(options: Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]> = {}, useDisplacement: boolean = true): THREE.MeshStandardMaterial
```
- 入参:
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `options` | `Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]>` | 否 | - MeshStandardMaterial参数选项,可覆盖默认设置 |
| `useDisplacement` | `boolean` | 否 | - 是否使用位移纹理设置,默认为true |
- 出参:`THREE.MeshStandardMaterial`
- 返回说明:THREE.MeshStandardMaterial - 带有岩石纹理的材质
## 构造示例
- 当前 Demo 中没有直接展示 `Rock5Material` 的构造调用。
## 函数示例
- 当前 Demo 中没有直接展示 `Rock5Material` 的公开方法调用。
@@ -0,0 +1,57 @@
---
outline: [2, 3]
---
# Rock6Material
- 源文件:`packages/sdk/src/materials/Rock6Material.ts`
- 文档位置:`packages/docs/api/materials/Rock6Material.md`
## 类:`Rock6Material`
- 作用:岩石材质类(rock6
- 继承/实现:`extends MaterialFactory`
### 方法
#### `create(options: Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]> = {}, useDisplacement: boolean = true): THREE.MeshStandardMaterial`
- 作用:创建岩石材质(rock6
- 入参:
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `options` | `Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]>` | 否 | - MeshStandardMaterial参数选项,可覆盖默认设置 |
| `useDisplacement` | `boolean` | 否 | - 是否使用位移纹理设置,默认为true |
- 出参:`THREE.MeshStandardMaterial`
- 返回说明:THREE.MeshStandardMaterial - 带有岩石纹理的材质
## 函数:`createRock6Material`
- 作用:创建岩石材质(rock6)的便捷函数
### 签名
```ts
function createRock6Material(options: Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]> = {}, useDisplacement: boolean = true): THREE.MeshStandardMaterial
```
- 入参:
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `options` | `Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]>` | 否 | - MeshStandardMaterial参数选项,可覆盖默认设置 |
| `useDisplacement` | `boolean` | 否 | - 是否使用位移纹理设置,默认为true |
- 出参:`THREE.MeshStandardMaterial`
- 返回说明:THREE.MeshStandardMaterial - 带有岩石纹理的材质
## 构造示例
- 当前 Demo 中没有直接展示 `Rock6Material` 的构造调用。
## 函数示例
- 当前 Demo 中没有直接展示 `Rock6Material` 的公开方法调用。
@@ -0,0 +1,57 @@
---
outline: [2, 3]
---
# Rock7Material
- 源文件:`packages/sdk/src/materials/Rock7Material.ts`
- 文档位置:`packages/docs/api/materials/Rock7Material.md`
## 类:`Rock7Material`
- 作用:岩石材质类(rock7
- 继承/实现:`extends MaterialFactory`
### 方法
#### `create(options: Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]> = {}, useDisplacement: boolean = true): THREE.MeshStandardMaterial`
- 作用:创建岩石材质(rock6
- 入参:
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `options` | `Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]>` | 否 | - MeshStandardMaterial参数选项,可覆盖默认设置 |
| `useDisplacement` | `boolean` | 否 | - 是否使用位移纹理设置,默认为true |
- 出参:`THREE.MeshStandardMaterial`
- 返回说明:THREE.MeshStandardMaterial - 带有岩石纹理的材质
## 函数:`createRock7Material`
- 作用:创建岩石材质(rock7)的便捷函数
### 签名
```ts
function createRock7Material(options: Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]> = {}, useDisplacement: boolean = true): THREE.MeshStandardMaterial
```
- 入参:
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `options` | `Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]>` | 否 | - MeshStandardMaterial参数选项,可覆盖默认设置 |
| `useDisplacement` | `boolean` | 否 | - 是否使用位移纹理设置,默认为true |
- 出参:`THREE.MeshStandardMaterial`
- 返回说明:THREE.MeshStandardMaterial - 带有岩石纹理的材质
## 构造示例
- 当前 Demo 中没有直接展示 `Rock7Material` 的构造调用。
## 函数示例
- 当前 Demo 中没有直接展示 `Rock7Material` 的公开方法调用。
@@ -0,0 +1,57 @@
---
outline: [2, 3]
---
# Rock8Material
- 源文件:`packages/sdk/src/materials/Rock8Material.ts`
- 文档位置:`packages/docs/api/materials/Rock8Material.md`
## 类:`Rock8Material`
- 作用:岩石材质类(rock8
- 继承/实现:`extends MaterialFactory`
### 方法
#### `create(options: Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]> = {}, useDisplacement: boolean = true): THREE.MeshStandardMaterial`
- 作用:创建岩石材质(rock6
- 入参:
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `options` | `Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]>` | 否 | - MeshStandardMaterial参数选项,可覆盖默认设置 |
| `useDisplacement` | `boolean` | 否 | - 是否使用位移纹理设置,默认为true |
- 出参:`THREE.MeshStandardMaterial`
- 返回说明:THREE.MeshStandardMaterial - 带有岩石纹理的材质
## 函数:`createRock8Material`
- 作用:创建岩石材质(rock8)的便捷函数
### 签名
```ts
function createRock8Material(options: Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]> = {}, useDisplacement: boolean = true): THREE.MeshStandardMaterial
```
- 入参:
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `options` | `Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]>` | 否 | - MeshStandardMaterial参数选项,可覆盖默认设置 |
| `useDisplacement` | `boolean` | 否 | - 是否使用位移纹理设置,默认为true |
- 出参:`THREE.MeshStandardMaterial`
- 返回说明:THREE.MeshStandardMaterial - 带有岩石纹理的材质
## 构造示例
- 当前 Demo 中没有直接展示 `Rock8Material` 的构造调用。
## 函数示例
- 当前 Demo 中没有直接展示 `Rock8Material` 的公开方法调用。
@@ -0,0 +1,57 @@
---
outline: [2, 3]
---
# RockMaterial
- 源文件:`packages/sdk/src/materials/RockMaterial.ts`
- 文档位置:`packages/docs/api/materials/RockMaterial.md`
## 类:`RockMaterial`
- 作用:岩石材质类(rock
- 继承/实现:`extends MaterialFactory`
### 方法
#### `create(options: Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]> = {}, useDisplacement: boolean = true): THREE.MeshStandardMaterial`
- 作用:创建岩石材质(rock
- 入参:
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `options` | `Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]>` | 否 | - MeshStandardMaterial参数选项,可覆盖默认设置 |
| `useDisplacement` | `boolean` | 否 | - 是否使用位移纹理设置,默认为true |
- 出参:`THREE.MeshStandardMaterial`
- 返回说明:THREE.MeshStandardMaterial - 带有岩石纹理的材质
## 函数:`createRockMaterial`
- 作用:创建岩石材质(rock)的便捷函数
### 签名
```ts
function createRockMaterial(options: Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]> = {}, useDisplacement: boolean = true): THREE.MeshStandardMaterial
```
- 入参:
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `options` | `Partial<ConstructorParameters<typeof THREE.MeshStandardMaterial>[0]>` | 否 | - MeshStandardMaterial参数选项,可覆盖默认设置 |
| `useDisplacement` | `boolean` | 否 | - 是否使用位移纹理设置,默认为true |
- 出参:`THREE.MeshStandardMaterial`
- 返回说明:THREE.MeshStandardMaterial - 带有岩石纹理的材质
## 构造示例
- 当前 Demo 中没有直接展示 `RockMaterial` 的构造调用。
## 函数示例
- 当前 Demo 中没有直接展示 `RockMaterial` 的公开方法调用。