[gs-longan](../README.md) / Color

# Class: Color

## Hierarchy

- `Attribute`

  ↳ **`Color`**

## Table of contents

### Constructors

- [constructor](Color.md#constructor)

### Accessors

- [ambient](Color.md#ambient)
- [baseColor](Color.md#basecolor)
- [cuttingFaceColor](Color.md#cuttingfacecolor)
- [cuttingFaceTexture](Color.md#cuttingfacetexture)
- [edgeColor](Color.md#edgecolor)
- [faceColor](Color.md#facecolor)
- [faceEmissive](Color.md#faceemissive)
- [faceMetallic](Color.md#facemetallic)
- [faceRoughness](Color.md#faceroughness)
- [faceTexture](Color.md#facetexture)
- [faceTransparency](Color.md#facetransparency)
- [light](Color.md#light)
- [lineColor](Color.md#linecolor)
- [markerColor](Color.md#markercolor)
- [specular](Color.md#specular)
- [value](Color.md#value)
- [vertexColor](Color.md#vertexcolor)

### Methods

- [setAmbient](Color.md#setambient)
- [setBaseColor](Color.md#setbasecolor)
- [setCuttingFace](Color.md#setcuttingface)
- [setCuttingFaceTexture](Color.md#setcuttingfacetexture)
- [setEdge](Color.md#setedge)
- [setFace](Color.md#setface)
- [setFaceEmissive](Color.md#setfaceemissive)
- [setFaceMetallic](Color.md#setfacemetallic)
- [setFaceRoughness](Color.md#setfaceroughness)
- [setFaceTexture](Color.md#setfacetexture)
- [setFaceTransparency](Color.md#setfacetransparency)
- [setLight](Color.md#setlight)
- [setLine](Color.md#setline)
- [setMarker](Color.md#setmarker)
- [setSpecular](Color.md#setspecular)
- [setVertex](Color.md#setvertex)
- [unset](Color.md#unset)
- [unsetAmbient](Color.md#unsetambient)
- [unsetBaseColor](Color.md#unsetbasecolor)
- [unsetCuttingFace](Color.md#unsetcuttingface)
- [unsetCuttingFaceTexture](Color.md#unsetcuttingfacetexture)
- [unsetEdge](Color.md#unsetedge)
- [unsetFace](Color.md#unsetface)
- [unsetFaceEmissive](Color.md#unsetfaceemissive)
- [unsetFaceMetallic](Color.md#unsetfacemetallic)
- [unsetFaceRoughness](Color.md#unsetfaceroughness)
- [unsetFaceTexture](Color.md#unsetfacetexture)
- [unsetFaceTransparency](Color.md#unsetfacetransparency)
- [unsetLight](Color.md#unsetlight)
- [unsetLine](Color.md#unsetline)
- [unsetMarker](Color.md#unsetmarker)
- [unsetSpecular](Color.md#unsetspecular)
- [unsetVertex](Color.md#unsetvertex)

## Constructors

### constructor

• **new Color**(`key`): [`Color`](Color.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `key` | `number` |

#### Returns

[`Color`](Color.md)

#### 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`](Color.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `color` | `ArrayLike`\<`number`\> |

#### Returns

[`Color`](Color.md)

___

### setBaseColor

▸ **setBaseColor**(`color`): [`Color`](Color.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `color` | `ArrayLike`\<`number`\> |

#### Returns

[`Color`](Color.md)

___

### setCuttingFace

▸ **setCuttingFace**(`color`): [`Color`](Color.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `color` | `ArrayLike`\<`number`\> |

#### Returns

[`Color`](Color.md)

___

### setCuttingFaceTexture

▸ **setCuttingFaceTexture**(`name`): [`Color`](Color.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `name` | `string` |

#### Returns

[`Color`](Color.md)

___

### setEdge

▸ **setEdge**(`color`): [`Color`](Color.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `color` | `ArrayLike`\<`number`\> |

#### Returns

[`Color`](Color.md)

___

### setFace

▸ **setFace**(`color`): [`Color`](Color.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `color` | `ArrayLike`\<`number`\> |

#### Returns

[`Color`](Color.md)

___

### setFaceEmissive

▸ **setFaceEmissive**(`color`): [`Color`](Color.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `color` | `ArrayLike`\<`number`\> |

#### Returns

[`Color`](Color.md)

___

### setFaceMetallic

▸ **setFaceMetallic**(`metallic`): [`Color`](Color.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `metallic` | `number` |

#### Returns

[`Color`](Color.md)

___

### setFaceRoughness

▸ **setFaceRoughness**(`roughness`): [`Color`](Color.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `roughness` | `number` |

#### Returns

[`Color`](Color.md)

___

### setFaceTexture

▸ **setFaceTexture**(`name`): [`Color`](Color.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `name` | `string` |

#### Returns

[`Color`](Color.md)

___

### setFaceTransparency

▸ **setFaceTransparency**(`alpha`): [`Color`](Color.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `alpha` | `number` |

#### Returns

[`Color`](Color.md)

___

### setLight

▸ **setLight**(`color`): [`Color`](Color.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `color` | `ArrayLike`\<`number`\> |

#### Returns

[`Color`](Color.md)

___

### setLine

▸ **setLine**(`color`): [`Color`](Color.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `color` | `ArrayLike`\<`number`\> |

#### Returns

[`Color`](Color.md)

___

### setMarker

▸ **setMarker**(`color`): [`Color`](Color.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `color` | `ArrayLike`\<`number`\> |

#### Returns

[`Color`](Color.md)

___

### setSpecular

▸ **setSpecular**(`color`): [`Color`](Color.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `color` | `number` |

#### Returns

[`Color`](Color.md)

___

### setVertex

▸ **setVertex**(`color`): [`Color`](Color.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `color` | `ArrayLike`\<`number`\> |

#### Returns

[`Color`](Color.md)

___

### unset

▸ **unset**(): [`Color`](Color.md)

#### Returns

[`Color`](Color.md)

___

### unsetAmbient

▸ **unsetAmbient**(): [`Color`](Color.md)

#### Returns

[`Color`](Color.md)

___

### unsetBaseColor

▸ **unsetBaseColor**(): [`Color`](Color.md)

#### Returns

[`Color`](Color.md)

___

### unsetCuttingFace

▸ **unsetCuttingFace**(): [`Color`](Color.md)

#### Returns

[`Color`](Color.md)

___

### unsetCuttingFaceTexture

▸ **unsetCuttingFaceTexture**(): [`Color`](Color.md)

#### Returns

[`Color`](Color.md)

___

### unsetEdge

▸ **unsetEdge**(): [`Color`](Color.md)

#### Returns

[`Color`](Color.md)

___

### unsetFace

▸ **unsetFace**(): [`Color`](Color.md)

#### Returns

[`Color`](Color.md)

___

### unsetFaceEmissive

▸ **unsetFaceEmissive**(): [`Color`](Color.md)

#### Returns

[`Color`](Color.md)

___

### unsetFaceMetallic

▸ **unsetFaceMetallic**(): [`Color`](Color.md)

#### Returns

[`Color`](Color.md)

___

### unsetFaceRoughness

▸ **unsetFaceRoughness**(): [`Color`](Color.md)

#### Returns

[`Color`](Color.md)

___

### unsetFaceTexture

▸ **unsetFaceTexture**(): [`Color`](Color.md)

#### Returns

[`Color`](Color.md)

___

### unsetFaceTransparency

▸ **unsetFaceTransparency**(): [`Color`](Color.md)

#### Returns

[`Color`](Color.md)

___

### unsetLight

▸ **unsetLight**(): [`Color`](Color.md)

#### Returns

[`Color`](Color.md)

___

### unsetLine

▸ **unsetLine**(): [`Color`](Color.md)

#### Returns

[`Color`](Color.md)

___

### unsetMarker

▸ **unsetMarker**(): [`Color`](Color.md)

#### Returns

[`Color`](Color.md)

___

### unsetSpecular

▸ **unsetSpecular**(): [`Color`](Color.md)

#### Returns

[`Color`](Color.md)

___

### unsetVertex

▸ **unsetVertex**(): [`Color`](Color.md)

#### Returns

[`Color`](Color.md)