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

# Class: CuttingPlanes

## Hierarchy

- [`Geometry`](Geometry.md)

  ↳ **`CuttingPlanes`**

## Table of contents

### Constructors

- [constructor](CuttingPlanes.md#constructor)

### Accessors

- [area](CuttingPlanes.md#area)
- [color](CuttingPlanes.md#color)
- [key](CuttingPlanes.md#key)
- [keyType](CuttingPlanes.md#keytype)
- [owner](CuttingPlanes.md#owner)
- [planes](CuttingPlanes.md#planes)
- [property](CuttingPlanes.md#property)
- [shellSize](CuttingPlanes.md#shellsize)
- [typeName](CuttingPlanes.md#typename)
- [volume](CuttingPlanes.md#volume)

### Methods

- [delete](CuttingPlanes.md#delete)
- [distanceTo](CuttingPlanes.md#distanceto)
- [edit](CuttingPlanes.md#edit)
- [equals](CuttingPlanes.md#equals)
- [moveTo](CuttingPlanes.md#moveto)
- [fromKey](CuttingPlanes.md#fromkey)

## Constructors

### constructor

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

#### Parameters

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

#### Returns

[`CuttingPlanes`](CuttingPlanes.md)

#### Overrides

[Geometry](Geometry.md).[constructor](Geometry.md#constructor)

## Accessors

### area

• `get` **area**(): `any`

#### Returns

`any`

#### Inherited from

Geometry.area

___

### color

• `get` **color**(): `GeometryColor`

#### Returns

`GeometryColor`

#### Inherited from

Geometry.color

___

### key

• `get` **key**(): `number`

#### Returns

`number`

#### Inherited from

Geometry.key

___

### keyType

• `get` **keyType**(): `any`

#### Returns

`any`

#### Inherited from

Geometry.keyType

___

### owner

• `get` **owner**(): [`Segment`](Segment.md)

#### Returns

[`Segment`](Segment.md)

#### Inherited from

Geometry.owner

___

### planes

• `get` **planes**(): `any`

#### Returns

`any`

___

### property

• `get` **property**(): `GeometryProperty`

#### Returns

`GeometryProperty`

#### Inherited from

Geometry.property

___

### shellSize

• `get` **shellSize**(): `any`

#### Returns

`any`

#### Inherited from

Geometry.shellSize

___

### typeName

• `get` **typeName**(): `string`

#### Returns

`string`

#### Overrides

Geometry.typeName

___

### volume

• `get` **volume**(): `any`

#### Returns

`any`

#### Inherited from

Geometry.volume

## Methods

### delete

▸ **delete**(): `void`

#### Returns

`void`

#### Inherited from

[Geometry](Geometry.md).[delete](Geometry.md#delete)

___

### distanceTo

▸ **distanceTo**(`geom`, `path1?`, `path2?`): `Float32Array`

#### Parameters

| Name | Type |
| :------ | :------ |
| `geom` | [`Geometry`](Geometry.md) |
| `path1?` | `Int32Array` |
| `path2?` | `Int32Array` |

#### Returns

`Float32Array`

#### Inherited from

[Geometry](Geometry.md).[distanceTo](Geometry.md#distanceto)

___

### edit

▸ **edit**(`planes`): `void`

#### Parameters

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

#### Returns

`void`

___

### equals

▸ **equals**(`obj`): `boolean`

#### Parameters

| Name | Type |
| :------ | :------ |
| `obj` | [`IKey`](../interfaces/IKey.md) |

#### Returns

`boolean`

#### Inherited from

[Geometry](Geometry.md).[equals](Geometry.md#equals)

___

### moveTo

▸ **moveTo**(`segment`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `segment` | [`Segment`](Segment.md) |

#### Returns

`void`

#### Inherited from

[Geometry](Geometry.md).[moveTo](Geometry.md#moveto)

___

### fromKey

▸ **fromKey**(`key`): [`Geometry`](Geometry.md)

#### Parameters

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

#### Returns

[`Geometry`](Geometry.md)

#### Inherited from

[Geometry](Geometry.md).[fromKey](Geometry.md#fromkey)