@realsee/five 6.7.2 → 6.8.0-alpha.1

package/docs_markdown/five/classes/PBMPointCloud.md

@@ -0,0 +1,41 @@
+[**如视 Five SDK**](../../README.md)
+
+***
+
+[如视 Five SDK](../../modules.md) / [five](../README.md) / PBMPointCloud
+
+# Class: PBMPointCloud
+
+Defined in: lib/five/model/objects/pbmPointCloud.ts:5
+
+PBM 对象
+
+## Extends
+
+- `Points`\<`THREE.BufferGeometry`, [`PBMPointCloudMaterial`](PBMPointCloudMaterial.md)\>
+
+## Constructors
+
+### Constructor
+
+> **new PBMPointCloud**(`geometry`, `materials`): `PBMPointCloud`
+
+Defined in: lib/five/model/objects/pbmPointCloud.ts:8
+
+#### Parameters
+
+##### geometry
+
+`BufferGeometry`
+
+##### materials
+
+[`PBMPointCloudMaterial`](PBMPointCloudMaterial.md)
+
+#### Returns
+
+`PBMPointCloud`
+
+#### Overrides
+
+`THREE.Points<THREE.BufferGeometry, PBMPointCloudMaterial>.constructor`

package/docs_markdown/five/classes/PBMPointCloudMaterial.md

@@ -0,0 +1,371 @@
+[**如视 Five SDK**](../../README.md)
+
+***
+
+[如视 Five SDK](../../modules.md) / [five](../README.md) / PBMPointCloudMaterial
+
+# Class: PBMPointCloudMaterial
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:114
+
+## Extends
+
+- [`PBMMaterial`](../interfaces/PBMMaterial.md)
+
+## Constructors
+
+### Constructor
+
+> **new PBMPointCloudMaterial**(`parameters?`): `PBMPointCloudMaterial`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:154
+
+#### Parameters
+
+##### parameters?
+
+[`PBMPointCloudMaterialParameters`](../interfaces/PBMPointCloudMaterialParameters.md)
+
+#### Returns
+
+`PBMPointCloudMaterial`
+
+#### Overrides
+
+`PBMMaterial.constructor`
+
+## Properties
+
+### brightness
+
+> **brightness**: `number`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:136
+
+***
+
+### clippers
+
+> **clippers**: readonly [`PBMClipperParameter`](../interfaces/PBMClipperParameter.md)[]
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:149
+
+***
+
+### clipping
+
+> **clipping**: `boolean` = `true`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:148
+
+***
+
+### colorBrightness
+
+> **colorBrightness**: `number`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:138
+
+***
+
+### colorSaturation
+
+> **colorSaturation**: `number`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:137
+
+***
+
+### colorStyle
+
+> **colorStyle**: [`PBMColorStyle`](../type-aliases/PBMColorStyle.md)
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:130
+
+***
+
+### constantColor
+
+> **constantColor**: `Vector3`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:131
+
+***
+
+### customShaders
+
+> **customShaders**: readonly [`PBMCustomShader`](PBMCustomShader.md)[] = `[]`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:150
+
+***
+
+### distanceGain
+
+> **distanceGain**: `number`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:140
+
+***
+
+### floorIndex
+
+> **floorIndex**: `number`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:132
+
+***
+
+### floorStyle
+
+> **floorStyle**: [`PBMFloorStyle`](../type-aliases/PBMFloorStyle.md)
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:134
+
+***
+
+### gradientTexture
+
+> **gradientTexture**: `Texture`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:135
+
+***
+
+### isPBMPointCloudMaterial
+
+> `readonly` **isPBMPointCloudMaterial**: `true`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:116
+
+***
+
+### isShaderMaterial
+
+> `readonly` **isShaderMaterial**: `true`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:117
+
+***
+
+### modelAlpha
+
+> **modelAlpha**: `number`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:129
+
+***
+
+### modelBoundingMax
+
+> **modelBoundingMax**: `Vector3`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:145
+
+***
+
+### modelBoundingMin
+
+> **modelBoundingMin**: `Vector3`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:144
+
+***
+
+### onBeforeRender()?
+
+> `optional` **onBeforeRender**: (`renderer`, `scene`, `camera`, `geometry`, `object`, `group`) => `void`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:152
+
+#### Parameters
+
+##### renderer
+
+`WebGLRenderer`
+
+##### scene
+
+`Scene`
+
+##### camera
+
+`Camera`
+
+##### geometry
+
+`BufferGeometry` | `Geometry`
+
+##### object
+
+`Object3D`
+
+##### group
+
+`Group`
+
+#### Returns
+
+`void`
+
+***
+
+### outlineGain
+
+> **outlineGain**: `number`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:139
+
+***
+
+### pointBack
+
+> **pointBack**: [`PBMPointBack`](../type-aliases/PBMPointBack.md)
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:128
+
+***
+
+### pointMaxPixel
+
+> **pointMaxPixel**: `number`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:125
+
+***
+
+### pointMinPixel
+
+> **pointMinPixel**: `number`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:124
+
+***
+
+### pointScale
+
+> **pointScale**: `number`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:123
+
+***
+
+### pointShape
+
+> **pointShape**: [`PBMPointShape`](../type-aliases/PBMPointShape.md)
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:127
+
+***
+
+### pointSize
+
+> **pointSize**: [`PBMPointSize`](../type-aliases/PBMPointSize.md)
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:126
+
+***
+
+### shaderType
+
+> `readonly` **shaderType**: `"pointcloud"` = `'pointcloud'`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:119
+
+***
+
+### shownFloorIndex
+
+> **shownFloorIndex**: `number`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:133
+
+***
+
+### useEDL
+
+> **useEDL**: `boolean`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:141
+
+***
+
+### useHQDepth
+
+> **useHQDepth**: `boolean`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:143
+
+***
+
+### useHQWeight
+
+> **useHQWeight**: `boolean`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:142
+
+***
+
+### vertexMarks
+
+> **vertexMarks**: `boolean`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:122
+
+## Methods
+
+### clone()
+
+> **clone**(): `this`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:682
+
+Return a new material with the same parameters as this material.
+
+#### Returns
+
+`this`
+
+#### Overrides
+
+`PBMMaterial.clone`
+
+***
+
+### copy()
+
+> **copy**(`source`): `this`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:652
+
+Copy the parameters from the passed material into this material.
+
+#### Parameters
+
+##### source
+
+`PBMPointCloudMaterial`
+
+#### Returns
+
+`this`
+
+#### Overrides
+
+`PBMMaterial.copy`
+
+***
+
+### ~~refreshUniforms()~~
+
+> **refreshUniforms**(): `void`
+
+Defined in: lib/five/model/materials/pbmPointCloudMaterial.ts:691
+
+#### Returns
+
+`void`
+
+#### Deprecated
+
+已经不需要再被调用了

package/docs_markdown/five/classes/PBMSkinnedMesh.md

@@ -0,0 +1,67 @@
+[**如视 Five SDK**](../../README.md)
+
+***
+
+[如视 Five SDK](../../modules.md) / [five](../README.md) / PBMSkinnedMesh
+
+# Class: PBMSkinnedMesh
+
+Defined in: lib/five/model/objects/pbmMesh.ts:18
+
+## Extends
+
+- `SkinnedMesh`\<`THREE.BufferGeometry`, [`PBMMeshMaterial`](PBMMeshMaterial.md)[]\>
+
+## Constructors
+
+### Constructor
+
+> **new PBMSkinnedMesh**(`geometry`, `materials`, `useVertexTexture?`): `PBMSkinnedMesh`
+
+Defined in: lib/five/model/objects/pbmMesh.ts:23
+
+#### Parameters
+
+##### geometry
+
+`BufferGeometry`
+
+##### materials
+
+[`PBMMeshMaterial`](PBMMeshMaterial.md)[]
+
+##### useVertexTexture?
+
+`boolean`
+
+#### Returns
+
+`PBMSkinnedMesh`
+
+#### Overrides
+
+`THREE.SkinnedMesh<THREE.BufferGeometry, PBMMeshMaterial[]>.constructor`
+
+## Properties
+
+### geometry
+
+> **geometry**: `BufferGeometry`
+
+Defined in: lib/five/model/objects/pbmMesh.ts:20
+
+#### Overrides
+
+`THREE.SkinnedMesh.geometry`
+
+***
+
+### material
+
+> **material**: [`PBMMeshMaterial`](PBMMeshMaterial.md)[]
+
+Defined in: lib/five/model/objects/pbmMesh.ts:21
+
+#### Overrides
+
+`THREE.SkinnedMesh.material`