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

# Class: ObjectSelector

## Hierarchy

- [`ViewerOperator`](ViewerOperator.md)

  ↳ **`ObjectSelector`**

## Table of contents

### Constructors

- [constructor](ObjectSelector.md#constructor)

### Properties

- [downPixelPos](ObjectSelector.md#downpixelpos)
- [downPos](ObjectSelector.md#downpos)
- [keyDown](ObjectSelector.md#keydown)
- [keyPress](ObjectSelector.md#keypress)
- [keyUp](ObjectSelector.md#keyup)
- [lButtonDown](ObjectSelector.md#lbuttondown)
- [lButtonDownAndMove](ObjectSelector.md#lbuttondownandmove)
- [lButtonUp](ObjectSelector.md#lbuttonup)
- [mButtonDown](ObjectSelector.md#mbuttondown)
- [mButtonDownAndMove](ObjectSelector.md#mbuttondownandmove)
- [mButtonUp](ObjectSelector.md#mbuttonup)
- [mouseMove](ObjectSelector.md#mousemove)
- [mouseWheel](ObjectSelector.md#mousewheel)
- [objectSelected](ObjectSelector.md#objectselected)
- [objectUnSelected](ObjectSelector.md#objectunselected)
- [rButtonDown](ObjectSelector.md#rbuttondown)
- [rButtonDownAndMove](ObjectSelector.md#rbuttondownandmove)
- [rButtonUp](ObjectSelector.md#rbuttonup)
- [touchCancel](ObjectSelector.md#touchcancel)
- [touchEnd](ObjectSelector.md#touchend)
- [touchMove](ObjectSelector.md#touchmove)
- [touchStart](ObjectSelector.md#touchstart)
- [typeName](ObjectSelector.md#typename)
- [windowKeyDown](ObjectSelector.md#windowkeydown)
- [windowKeyPress](ObjectSelector.md#windowkeypress)
- [windowKeyUp](ObjectSelector.md#windowkeyup)

### Accessors

- [clickPos](ObjectSelector.md#clickpos)
- [edgeSelection](ObjectSelector.md#edgeselection)
- [enable](ObjectSelector.md#enable)
- [faceSelection](ObjectSelector.md#faceselection)
- [isAreaSelect](ObjectSelector.md#isareaselect)
- [isMultiSelect](ObjectSelector.md#ismultiselect)
- [persistent](ObjectSelector.md#persistent)
- [selectionKey](ObjectSelector.md#selectionkey)
- [vertexSelection](ObjectSelector.md#vertexselection)
- [viewer](ObjectSelector.md#viewer)

### Methods

- [fina](ObjectSelector.md#fina)
- [init](ObjectSelector.md#init)
- [onKeyDown](ObjectSelector.md#onkeydown)
- [onKeyPress](ObjectSelector.md#onkeypress)
- [onKeyUp](ObjectSelector.md#onkeyup)
- [onLButtonDown](ObjectSelector.md#onlbuttondown)
- [onLButtonDownAndMove](ObjectSelector.md#onlbuttondownandmove)
- [onLButtonUp](ObjectSelector.md#onlbuttonup)
- [onMButtonDown](ObjectSelector.md#onmbuttondown)
- [onMButtonDownAndMove](ObjectSelector.md#onmbuttondownandmove)
- [onMButtonUp](ObjectSelector.md#onmbuttonup)
- [onMouseMove](ObjectSelector.md#onmousemove)
- [onMouseWheel](ObjectSelector.md#onmousewheel)
- [onRButtonDown](ObjectSelector.md#onrbuttondown)
- [onRButtonDownAndMove](ObjectSelector.md#onrbuttondownandmove)
- [onRButtonUp](ObjectSelector.md#onrbuttonup)
- [onTouchCancel](ObjectSelector.md#ontouchcancel)
- [onTouchEnd](ObjectSelector.md#ontouchend)
- [onTouchMove](ObjectSelector.md#ontouchmove)
- [onTouchStart](ObjectSelector.md#ontouchstart)
- [onWindowKeyDown](ObjectSelector.md#onwindowkeydown)
- [onWindowKeyPress](ObjectSelector.md#onwindowkeypress)
- [onWindowKeyUp](ObjectSelector.md#onwindowkeyup)
- [selectByArea](ObjectSelector.md#selectbyarea)
- [selectByPoint](ObjectSelector.md#selectbypoint)

## Constructors

### constructor

• **new ObjectSelector**(): [`ObjectSelector`](ObjectSelector.md)

#### Returns

[`ObjectSelector`](ObjectSelector.md)

#### Overrides

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

## Properties

### downPixelPos

• **downPixelPos**: `Float32Array` = `null`

___

### downPos

• **downPos**: `Float32Array` = `null`

___

### keyDown

• **keyDown**: [`List`](List.md)\<(`sender`: [`ViewerOperator`](ViewerOperator.md), `event`: [`ViewerEvent`](ViewerEvent.md)) => `void`\>

#### Inherited from

[ViewerOperator](ViewerOperator.md).[keyDown](ViewerOperator.md#keydown)

___

### keyPress

• **keyPress**: [`List`](List.md)\<(`sender`: [`ViewerOperator`](ViewerOperator.md), `event`: [`ViewerEvent`](ViewerEvent.md)) => `void`\>

#### Inherited from

[ViewerOperator](ViewerOperator.md).[keyPress](ViewerOperator.md#keypress)

___

### keyUp

• **keyUp**: [`List`](List.md)\<(`sender`: [`ViewerOperator`](ViewerOperator.md), `event`: [`ViewerEvent`](ViewerEvent.md)) => `void`\>

#### Inherited from

[ViewerOperator](ViewerOperator.md).[keyUp](ViewerOperator.md#keyup)

___

### lButtonDown

• **lButtonDown**: [`List`](List.md)\<(`sender`: [`ViewerOperator`](ViewerOperator.md), `event`: [`ViewerEvent`](ViewerEvent.md)) => `void`\>

#### Inherited from

[ViewerOperator](ViewerOperator.md).[lButtonDown](ViewerOperator.md#lbuttondown)

___

### lButtonDownAndMove

• **lButtonDownAndMove**: [`List`](List.md)\<(`sender`: [`ViewerOperator`](ViewerOperator.md), `event`: [`ViewerEvent`](ViewerEvent.md)) => `void`\>

#### Inherited from

[ViewerOperator](ViewerOperator.md).[lButtonDownAndMove](ViewerOperator.md#lbuttondownandmove)

___

### lButtonUp

• **lButtonUp**: [`List`](List.md)\<(`sender`: [`ViewerOperator`](ViewerOperator.md), `event`: [`ViewerEvent`](ViewerEvent.md)) => `void`\>

#### Inherited from

[ViewerOperator](ViewerOperator.md).[lButtonUp](ViewerOperator.md#lbuttonup)

___

### mButtonDown

• **mButtonDown**: [`List`](List.md)\<(`sender`: [`ViewerOperator`](ViewerOperator.md), `event`: [`ViewerEvent`](ViewerEvent.md)) => `void`\>

#### Inherited from

[ViewerOperator](ViewerOperator.md).[mButtonDown](ViewerOperator.md#mbuttondown)

___

### mButtonDownAndMove

• **mButtonDownAndMove**: [`List`](List.md)\<(`sender`: [`ViewerOperator`](ViewerOperator.md), `event`: [`ViewerEvent`](ViewerEvent.md)) => `void`\>

#### Inherited from

[ViewerOperator](ViewerOperator.md).[mButtonDownAndMove](ViewerOperator.md#mbuttondownandmove)

___

### mButtonUp

• **mButtonUp**: [`List`](List.md)\<(`sender`: [`ViewerOperator`](ViewerOperator.md), `event`: [`ViewerEvent`](ViewerEvent.md)) => `void`\>

#### Inherited from

[ViewerOperator](ViewerOperator.md).[mButtonUp](ViewerOperator.md#mbuttonup)

___

### mouseMove

• **mouseMove**: [`List`](List.md)\<(`sender`: [`ViewerOperator`](ViewerOperator.md), `event`: [`ViewerEvent`](ViewerEvent.md)) => `void`\>

#### Inherited from

[ViewerOperator](ViewerOperator.md).[mouseMove](ViewerOperator.md#mousemove)

___

### mouseWheel

• **mouseWheel**: [`List`](List.md)\<(`sender`: [`ViewerOperator`](ViewerOperator.md), `event`: [`ViewerEvent`](ViewerEvent.md)) => `void`\>

#### Inherited from

[ViewerOperator](ViewerOperator.md).[mouseWheel](ViewerOperator.md#mousewheel)

___

### objectSelected

• **objectSelected**: [`List`](List.md)\<() => `void`\>

___

### objectUnSelected

• **objectUnSelected**: [`List`](List.md)\<() => `void`\>

___

### rButtonDown

• **rButtonDown**: [`List`](List.md)\<(`sender`: [`ViewerOperator`](ViewerOperator.md), `event`: [`ViewerEvent`](ViewerEvent.md)) => `void`\>

#### Inherited from

[ViewerOperator](ViewerOperator.md).[rButtonDown](ViewerOperator.md#rbuttondown)

___

### rButtonDownAndMove

• **rButtonDownAndMove**: [`List`](List.md)\<(`sender`: [`ViewerOperator`](ViewerOperator.md), `event`: [`ViewerEvent`](ViewerEvent.md)) => `void`\>

#### Inherited from

[ViewerOperator](ViewerOperator.md).[rButtonDownAndMove](ViewerOperator.md#rbuttondownandmove)

___

### rButtonUp

• **rButtonUp**: [`List`](List.md)\<(`sender`: [`ViewerOperator`](ViewerOperator.md), `event`: [`ViewerEvent`](ViewerEvent.md)) => `void`\>

#### Inherited from

[ViewerOperator](ViewerOperator.md).[rButtonUp](ViewerOperator.md#rbuttonup)

___

### touchCancel

• **touchCancel**: [`List`](List.md)\<(`sender`: [`ViewerOperator`](ViewerOperator.md), `event`: [`ViewerEvent`](ViewerEvent.md)) => `void`\>

#### Inherited from

[ViewerOperator](ViewerOperator.md).[touchCancel](ViewerOperator.md#touchcancel)

___

### touchEnd

• **touchEnd**: [`List`](List.md)\<(`sender`: [`ViewerOperator`](ViewerOperator.md), `event`: [`ViewerEvent`](ViewerEvent.md)) => `void`\>

#### Inherited from

[ViewerOperator](ViewerOperator.md).[touchEnd](ViewerOperator.md#touchend)

___

### touchMove

• **touchMove**: [`List`](List.md)\<(`sender`: [`ViewerOperator`](ViewerOperator.md), `event`: [`ViewerEvent`](ViewerEvent.md)) => `void`\>

#### Inherited from

[ViewerOperator](ViewerOperator.md).[touchMove](ViewerOperator.md#touchmove)

___

### touchStart

• **touchStart**: [`List`](List.md)\<(`sender`: [`ViewerOperator`](ViewerOperator.md), `event`: [`ViewerEvent`](ViewerEvent.md)) => `void`\>

#### Inherited from

[ViewerOperator](ViewerOperator.md).[touchStart](ViewerOperator.md#touchstart)

___

### typeName

• **typeName**: `string` = `"ObjectSelector"`

#### Overrides

[ViewerOperator](ViewerOperator.md).[typeName](ViewerOperator.md#typename)

___

### windowKeyDown

• **windowKeyDown**: [`List`](List.md)\<(`sender`: [`ViewerOperator`](ViewerOperator.md), `event`: [`ViewerEvent`](ViewerEvent.md)) => `void`\>

#### Inherited from

[ViewerOperator](ViewerOperator.md).[windowKeyDown](ViewerOperator.md#windowkeydown)

___

### windowKeyPress

• **windowKeyPress**: [`List`](List.md)\<(`sender`: [`ViewerOperator`](ViewerOperator.md), `event`: [`ViewerEvent`](ViewerEvent.md)) => `void`\>

#### Inherited from

[ViewerOperator](ViewerOperator.md).[windowKeyPress](ViewerOperator.md#windowkeypress)

___

### windowKeyUp

• **windowKeyUp**: [`List`](List.md)\<(`sender`: [`ViewerOperator`](ViewerOperator.md), `event`: [`ViewerEvent`](ViewerEvent.md)) => `void`\>

#### Inherited from

[ViewerOperator](ViewerOperator.md).[windowKeyUp](ViewerOperator.md#windowkeyup)

## Accessors

### clickPos

• `get` **clickPos**(): `Float32Array`

#### Returns

`Float32Array`

___

### edgeSelection

• `get` **edgeSelection**(): `boolean`

获取顶点可选性

#### Returns

`boolean`

• `set` **edgeSelection**(`onoff`): `void`

设置边可选性

#### Parameters

| Name | Type |
| :------ | :------ |
| `onoff` | `boolean` |

#### Returns

`void`

___

### enable

• `get` **enable**(): `boolean`

#### Returns

`boolean`

#### Inherited from

ViewerOperator.enable

• `set` **enable**(`enable`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `enable` | `boolean` |

#### Returns

`void`

#### Inherited from

ViewerOperator.enable

___

### faceSelection

• `get` **faceSelection**(): `boolean`

获取面可选性

#### Returns

`boolean`

• `set` **faceSelection**(`onoff`): `void`

设置面可选性

#### Parameters

| Name | Type |
| :------ | :------ |
| `onoff` | `boolean` |

#### Returns

`void`

___

### isAreaSelect

• `get` **isAreaSelect**(): `boolean`

#### Returns

`boolean`

• `set` **isAreaSelect**(`value`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | `boolean` |

#### Returns

`void`

___

### isMultiSelect

• `get` **isMultiSelect**(): `boolean`

#### Returns

`boolean`

• `set` **isMultiSelect**(`isMultiSelect`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `isMultiSelect` | `boolean` |

#### Returns

`void`

___

### persistent

• `get` **persistent**(): `boolean`

#### Returns

`boolean`

#### Inherited from

ViewerOperator.persistent

• `set` **persistent**(`persistent`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `persistent` | `boolean` |

#### Returns

`void`

#### Inherited from

ViewerOperator.persistent

___

### selectionKey

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

#### Returns

`any`

___

### vertexSelection

• `get` **vertexSelection**(): `boolean`

获取顶点可选性

#### Returns

`boolean`

• `set` **vertexSelection**(`onoff`): `void`

设置顶点可选性

#### Parameters

| Name | Type |
| :------ | :------ |
| `onoff` | `boolean` |

#### Returns

`void`

___

### viewer

• `get` **viewer**(): [`Viewer`](Viewer.md)

#### Returns

[`Viewer`](Viewer.md)

#### Inherited from

ViewerOperator.viewer

• `set` **viewer**(`viewer`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `viewer` | [`Viewer`](Viewer.md) |

#### Returns

`void`

#### Inherited from

ViewerOperator.viewer

## Methods

### fina

▸ **fina**(): `void`

#### Returns

`void`

#### Inherited from

[ViewerOperator](ViewerOperator.md).[fina](ViewerOperator.md#fina)

___

### init

▸ **init**(): `void`

#### Returns

`void`

#### Inherited from

[ViewerOperator](ViewerOperator.md).[init](ViewerOperator.md#init)

___

### onKeyDown

▸ **onKeyDown**(`e`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `e` | [`ViewerEvent`](ViewerEvent.md) |

#### Returns

`void`

#### Inherited from

[ViewerOperator](ViewerOperator.md).[onKeyDown](ViewerOperator.md#onkeydown)

___

### onKeyPress

▸ **onKeyPress**(`e`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `e` | [`ViewerEvent`](ViewerEvent.md) |

#### Returns

`void`

#### Inherited from

[ViewerOperator](ViewerOperator.md).[onKeyPress](ViewerOperator.md#onkeypress)

___

### onKeyUp

▸ **onKeyUp**(`e`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `e` | [`ViewerEvent`](ViewerEvent.md) |

#### Returns

`void`

#### Inherited from

[ViewerOperator](ViewerOperator.md).[onKeyUp](ViewerOperator.md#onkeyup)

___

### onLButtonDown

▸ **onLButtonDown**(`e`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `e` | [`ViewerEvent`](ViewerEvent.md) |

#### Returns

`void`

#### Overrides

[ViewerOperator](ViewerOperator.md).[onLButtonDown](ViewerOperator.md#onlbuttondown)

___

### onLButtonDownAndMove

▸ **onLButtonDownAndMove**(`e`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `e` | [`ViewerEvent`](ViewerEvent.md) |

#### Returns

`void`

#### Inherited from

[ViewerOperator](ViewerOperator.md).[onLButtonDownAndMove](ViewerOperator.md#onlbuttondownandmove)

___

### onLButtonUp

▸ **onLButtonUp**(`e`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `e` | [`ViewerEvent`](ViewerEvent.md) |

#### Returns

`void`

#### Overrides

[ViewerOperator](ViewerOperator.md).[onLButtonUp](ViewerOperator.md#onlbuttonup)

___

### onMButtonDown

▸ **onMButtonDown**(`e`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `e` | [`ViewerEvent`](ViewerEvent.md) |

#### Returns

`void`

#### Inherited from

[ViewerOperator](ViewerOperator.md).[onMButtonDown](ViewerOperator.md#onmbuttondown)

___

### onMButtonDownAndMove

▸ **onMButtonDownAndMove**(`e`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `e` | [`ViewerEvent`](ViewerEvent.md) |

#### Returns

`void`

#### Inherited from

[ViewerOperator](ViewerOperator.md).[onMButtonDownAndMove](ViewerOperator.md#onmbuttondownandmove)

___

### onMButtonUp

▸ **onMButtonUp**(`e`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `e` | [`ViewerEvent`](ViewerEvent.md) |

#### Returns

`void`

#### Inherited from

[ViewerOperator](ViewerOperator.md).[onMButtonUp](ViewerOperator.md#onmbuttonup)

___

### onMouseMove

▸ **onMouseMove**(`e`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `e` | [`ViewerEvent`](ViewerEvent.md) |

#### Returns

`void`

#### Inherited from

[ViewerOperator](ViewerOperator.md).[onMouseMove](ViewerOperator.md#onmousemove)

___

### onMouseWheel

▸ **onMouseWheel**(`e`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `e` | [`ViewerEvent`](ViewerEvent.md) |

#### Returns

`void`

#### Inherited from

[ViewerOperator](ViewerOperator.md).[onMouseWheel](ViewerOperator.md#onmousewheel)

___

### onRButtonDown

▸ **onRButtonDown**(`e`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `e` | [`ViewerEvent`](ViewerEvent.md) |

#### Returns

`void`

#### Inherited from

[ViewerOperator](ViewerOperator.md).[onRButtonDown](ViewerOperator.md#onrbuttondown)

___

### onRButtonDownAndMove

▸ **onRButtonDownAndMove**(`e`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `e` | [`ViewerEvent`](ViewerEvent.md) |

#### Returns

`void`

#### Inherited from

[ViewerOperator](ViewerOperator.md).[onRButtonDownAndMove](ViewerOperator.md#onrbuttondownandmove)

___

### onRButtonUp

▸ **onRButtonUp**(`e`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `e` | [`ViewerEvent`](ViewerEvent.md) |

#### Returns

`void`

#### Inherited from

[ViewerOperator](ViewerOperator.md).[onRButtonUp](ViewerOperator.md#onrbuttonup)

___

### onTouchCancel

▸ **onTouchCancel**(`e`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `e` | [`ViewerEvent`](ViewerEvent.md) |

#### Returns

`void`

#### Inherited from

[ViewerOperator](ViewerOperator.md).[onTouchCancel](ViewerOperator.md#ontouchcancel)

___

### onTouchEnd

▸ **onTouchEnd**(`e`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `e` | [`ViewerEvent`](ViewerEvent.md) |

#### Returns

`void`

#### Inherited from

[ViewerOperator](ViewerOperator.md).[onTouchEnd](ViewerOperator.md#ontouchend)

___

### onTouchMove

▸ **onTouchMove**(`e`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `e` | [`ViewerEvent`](ViewerEvent.md) |

#### Returns

`void`

#### Inherited from

[ViewerOperator](ViewerOperator.md).[onTouchMove](ViewerOperator.md#ontouchmove)

___

### onTouchStart

▸ **onTouchStart**(`e`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `e` | [`ViewerEvent`](ViewerEvent.md) |

#### Returns

`void`

#### Inherited from

[ViewerOperator](ViewerOperator.md).[onTouchStart](ViewerOperator.md#ontouchstart)

___

### onWindowKeyDown

▸ **onWindowKeyDown**(`e`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `e` | [`ViewerEvent`](ViewerEvent.md) |

#### Returns

`void`

#### Overrides

[ViewerOperator](ViewerOperator.md).[onWindowKeyDown](ViewerOperator.md#onwindowkeydown)

___

### onWindowKeyPress

▸ **onWindowKeyPress**(`e`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `e` | [`ViewerEvent`](ViewerEvent.md) |

#### Returns

`void`

#### Inherited from

[ViewerOperator](ViewerOperator.md).[onWindowKeyPress](ViewerOperator.md#onwindowkeypress)

___

### onWindowKeyUp

▸ **onWindowKeyUp**(`e`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `e` | [`ViewerEvent`](ViewerEvent.md) |

#### Returns

`void`

#### Overrides

[ViewerOperator](ViewerOperator.md).[onWindowKeyUp](ViewerOperator.md#onwindowkeyup)

___

### selectByArea

▸ **selectByArea**(`downPos`, `upPos`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `downPos` | `any` |
| `upPos` | `any` |

#### Returns

`void`

___

### selectByPoint

▸ **selectByPoint**(`pos`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `pos` | `any` |

#### Returns

`void`