@belife/belife-bim-air 1.6.1-zy.86.patch.7 → 1.6.1-zy.86.patch.9

package/docs/classes/Longan.Color.md

@@ -0,0 +1,877 @@
+[gs-bim-air](../gs-bim-air.md) / [Longan](../modules/Longan.md) / Color
+
+# Class: Color
+
+[Longan](../modules/Longan.md).Color
+
+## Hierarchy
+
+- `Attribute`
+
+  ↳ **`Color`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Longan.Color.md#constructor)
+
+### Accessors
+
+- [ambient](Longan.Color.md#ambient)
+- [baseColor](Longan.Color.md#basecolor)
+- [cuttingFaceColor](Longan.Color.md#cuttingfacecolor)
+- [cuttingFaceTexture](Longan.Color.md#cuttingfacetexture)
+- [edgeColor](Longan.Color.md#edgecolor)
+- [faceColor](Longan.Color.md#facecolor)
+- [faceEmissive](Longan.Color.md#faceemissive)
+- [faceMetallic](Longan.Color.md#facemetallic)
+- [faceRoughness](Longan.Color.md#faceroughness)
+- [faceTexture](Longan.Color.md#facetexture)
+- [faceTransparency](Longan.Color.md#facetransparency)
+- [light](Longan.Color.md#light)
+- [lineColor](Longan.Color.md#linecolor)
+- [markerColor](Longan.Color.md#markercolor)
+- [specular](Longan.Color.md#specular)
+- [value](Longan.Color.md#value)
+- [vertexColor](Longan.Color.md#vertexcolor)
+
+### Methods
+
+- [setAmbient](Longan.Color.md#setambient)
+- [setBaseColor](Longan.Color.md#setbasecolor)
+- [setCuttingFace](Longan.Color.md#setcuttingface)
+- [setCuttingFaceTexture](Longan.Color.md#setcuttingfacetexture)
+- [setEdge](Longan.Color.md#setedge)
+- [setFace](Longan.Color.md#setface)
+- [setFaceEmissive](Longan.Color.md#setfaceemissive)
+- [setFaceMetallic](Longan.Color.md#setfacemetallic)
+- [setFaceRoughness](Longan.Color.md#setfaceroughness)
+- [setFaceTexture](Longan.Color.md#setfacetexture)
+- [setFaceTransparency](Longan.Color.md#setfacetransparency)
+- [setLight](Longan.Color.md#setlight)
+- [setLine](Longan.Color.md#setline)
+- [setMarker](Longan.Color.md#setmarker)
+- [setSpecular](Longan.Color.md#setspecular)
+- [setVertex](Longan.Color.md#setvertex)
+- [unset](Longan.Color.md#unset)
+- [unsetAmbient](Longan.Color.md#unsetambient)
+- [unsetBaseColor](Longan.Color.md#unsetbasecolor)
+- [unsetCuttingFace](Longan.Color.md#unsetcuttingface)
+- [unsetCuttingFaceTexture](Longan.Color.md#unsetcuttingfacetexture)
+- [unsetEdge](Longan.Color.md#unsetedge)
+- [unsetFace](Longan.Color.md#unsetface)
+- [unsetFaceEmissive](Longan.Color.md#unsetfaceemissive)
+- [unsetFaceMetallic](Longan.Color.md#unsetfacemetallic)
+- [unsetFaceRoughness](Longan.Color.md#unsetfaceroughness)
+- [unsetFaceTexture](Longan.Color.md#unsetfacetexture)
+- [unsetFaceTransparency](Longan.Color.md#unsetfacetransparency)
+- [unsetLight](Longan.Color.md#unsetlight)
+- [unsetLine](Longan.Color.md#unsetline)
+- [unsetMarker](Longan.Color.md#unsetmarker)
+- [unsetSpecular](Longan.Color.md#unsetspecular)
+- [unsetVertex](Longan.Color.md#unsetvertex)
+
+## Constructors
+
+### constructor
+
+• **new Color**(`key`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `key` | `number` |
+
+#### Overrides
+
+Attribute.constructor
+
+## Accessors
+
+### ambient
+
+• `get` **ambient**(): `ArrayLike`<`number`\>
+
+#### Returns
+
+`ArrayLike`<`number`\>
+
+• `set` **ambient**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `ArrayLike`<`number`\> |
+
+#### Returns
+
+`void`
+
+___
+
+### baseColor
+
+• `get` **baseColor**(): `ArrayLike`<`number`\>
+
+#### Returns
+
+`ArrayLike`<`number`\>
+
+• `set` **baseColor**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `ArrayLike`<`number`\> |
+
+#### Returns
+
+`void`
+
+___
+
+### cuttingFaceColor
+
+• `get` **cuttingFaceColor**(): `ArrayLike`<`number`\>
+
+#### Returns
+
+`ArrayLike`<`number`\>
+
+• `set` **cuttingFaceColor**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `ArrayLike`<`number`\> |
+
+#### Returns
+
+`void`
+
+___
+
+### cuttingFaceTexture
+
+• `get` **cuttingFaceTexture**(): `string`
+
+#### Returns
+
+`string`
+
+• `set` **cuttingFaceTexture**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `string` |
+
+#### Returns
+
+`void`
+
+___
+
+### edgeColor
+
+• `get` **edgeColor**(): `ArrayLike`<`number`\>
+
+#### Returns
+
+`ArrayLike`<`number`\>
+
+• `set` **edgeColor**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `ArrayLike`<`number`\> |
+
+#### Returns
+
+`void`
+
+___
+
+### faceColor
+
+• `get` **faceColor**(): `ArrayLike`<`number`\>
+
+#### Returns
+
+`ArrayLike`<`number`\>
+
+• `set` **faceColor**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `ArrayLike`<`number`\> |
+
+#### Returns
+
+`void`
+
+___
+
+### faceEmissive
+
+• `get` **faceEmissive**(): `ArrayLike`<`number`\>
+
+#### Returns
+
+`ArrayLike`<`number`\>
+
+• `set` **faceEmissive**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `ArrayLike`<`number`\> |
+
+#### Returns
+
+`void`
+
+___
+
+### faceMetallic
+
+• `get` **faceMetallic**(): `number`
+
+#### Returns
+
+`number`
+
+• `set` **faceMetallic**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `number` |
+
+#### Returns
+
+`void`
+
+___
+
+### faceRoughness
+
+• `get` **faceRoughness**(): `number`
+
+#### Returns
+
+`number`
+
+• `set` **faceRoughness**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `number` |
+
+#### Returns
+
+`void`
+
+___
+
+### faceTexture
+
+• `get` **faceTexture**(): `string`
+
+#### Returns
+
+`string`
+
+• `set` **faceTexture**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `string` |
+
+#### Returns
+
+`void`
+
+___
+
+### faceTransparency
+
+• `get` **faceTransparency**(): `number`
+
+#### Returns
+
+`number`
+
+• `set` **faceTransparency**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `number` |
+
+#### Returns
+
+`void`
+
+___
+
+### light
+
+• `get` **light**(): `ArrayLike`<`number`\>
+
+#### Returns
+
+`ArrayLike`<`number`\>
+
+• `set` **light**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `ArrayLike`<`number`\> |
+
+#### Returns
+
+`void`
+
+___
+
+### lineColor
+
+• `get` **lineColor**(): `ArrayLike`<`number`\>
+
+#### Returns
+
+`ArrayLike`<`number`\>
+
+• `set` **lineColor**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `ArrayLike`<`number`\> |
+
+#### Returns
+
+`void`
+
+___
+
+### markerColor
+
+• `get` **markerColor**(): `ArrayLike`<`number`\>
+
+#### Returns
+
+`ArrayLike`<`number`\>
+
+• `set` **markerColor**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `ArrayLike`<`number`\> |
+
+#### Returns
+
+`void`
+
+___
+
+### specular
+
+• `get` **specular**(): `number`
+
+#### Returns
+
+`number`
+
+• `set` **specular**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `number` |
+
+#### Returns
+
+`void`
+
+___
+
+### value
+
+• `get` **value**(): `string`
+
+#### Returns
+
+`string`
+
+___
+
+### vertexColor
+
+• `get` **vertexColor**(): `ArrayLike`<`number`\>
+
+#### Returns
+
+`ArrayLike`<`number`\>
+
+• `set` **vertexColor**(`value`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `ArrayLike`<`number`\> |
+
+#### Returns
+
+`void`
+
+## Methods
+
+### setAmbient
+
+▸ **setAmbient**(`color`): [`Color`](Longan.Color.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `color` | `ArrayLike`<`number`\> |
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### setBaseColor
+
+▸ **setBaseColor**(`color`): [`Color`](Longan.Color.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `color` | `ArrayLike`<`number`\> |
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### setCuttingFace
+
+▸ **setCuttingFace**(`color`): [`Color`](Longan.Color.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `color` | `ArrayLike`<`number`\> |
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### setCuttingFaceTexture
+
+▸ **setCuttingFaceTexture**(`name`): [`Color`](Longan.Color.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### setEdge
+
+▸ **setEdge**(`color`): [`Color`](Longan.Color.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `color` | `ArrayLike`<`number`\> |
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### setFace
+
+▸ **setFace**(`color`): [`Color`](Longan.Color.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `color` | `ArrayLike`<`number`\> |
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### setFaceEmissive
+
+▸ **setFaceEmissive**(`color`): [`Color`](Longan.Color.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `color` | `ArrayLike`<`number`\> |
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### setFaceMetallic
+
+▸ **setFaceMetallic**(`metallic`): [`Color`](Longan.Color.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `metallic` | `number` |
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### setFaceRoughness
+
+▸ **setFaceRoughness**(`roughness`): [`Color`](Longan.Color.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `roughness` | `number` |
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### setFaceTexture
+
+▸ **setFaceTexture**(`name`): [`Color`](Longan.Color.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### setFaceTransparency
+
+▸ **setFaceTransparency**(`alpha`): [`Color`](Longan.Color.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `alpha` | `number` |
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### setLight
+
+▸ **setLight**(`color`): [`Color`](Longan.Color.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `color` | `ArrayLike`<`number`\> |
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### setLine
+
+▸ **setLine**(`color`): [`Color`](Longan.Color.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `color` | `ArrayLike`<`number`\> |
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### setMarker
+
+▸ **setMarker**(`color`): [`Color`](Longan.Color.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `color` | `ArrayLike`<`number`\> |
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### setSpecular
+
+▸ **setSpecular**(`color`): [`Color`](Longan.Color.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `color` | `number` |
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### setVertex
+
+▸ **setVertex**(`color`): [`Color`](Longan.Color.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `color` | `ArrayLike`<`number`\> |
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### unset
+
+▸ **unset**(): [`Color`](Longan.Color.md)
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### unsetAmbient
+
+▸ **unsetAmbient**(): [`Color`](Longan.Color.md)
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### unsetBaseColor
+
+▸ **unsetBaseColor**(): [`Color`](Longan.Color.md)
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### unsetCuttingFace
+
+▸ **unsetCuttingFace**(): [`Color`](Longan.Color.md)
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### unsetCuttingFaceTexture
+
+▸ **unsetCuttingFaceTexture**(): [`Color`](Longan.Color.md)
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### unsetEdge
+
+▸ **unsetEdge**(): [`Color`](Longan.Color.md)
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### unsetFace
+
+▸ **unsetFace**(): [`Color`](Longan.Color.md)
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### unsetFaceEmissive
+
+▸ **unsetFaceEmissive**(): [`Color`](Longan.Color.md)
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### unsetFaceMetallic
+
+▸ **unsetFaceMetallic**(): [`Color`](Longan.Color.md)
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### unsetFaceRoughness
+
+▸ **unsetFaceRoughness**(): [`Color`](Longan.Color.md)
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### unsetFaceTexture
+
+▸ **unsetFaceTexture**(): [`Color`](Longan.Color.md)
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### unsetFaceTransparency
+
+▸ **unsetFaceTransparency**(): [`Color`](Longan.Color.md)
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### unsetLight
+
+▸ **unsetLight**(): [`Color`](Longan.Color.md)
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### unsetLine
+
+▸ **unsetLine**(): [`Color`](Longan.Color.md)
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### unsetMarker
+
+▸ **unsetMarker**(): [`Color`](Longan.Color.md)
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### unsetSpecular
+
+▸ **unsetSpecular**(): [`Color`](Longan.Color.md)
+
+#### Returns
+
+[`Color`](Longan.Color.md)
+
+___
+
+### unsetVertex
+
+▸ **unsetVertex**(): [`Color`](Longan.Color.md)
+
+#### Returns
+
+[`Color`](Longan.Color.md)