Class Selection

Provides selection behaviour for the viewer Supports multi-selection as long as all objects are from the same vim.

Hierarchy

Selection

Index

Constructors

Accessors

count objects onValueChanged vim

Methods

add clear dispose focus getBoundingBox has remove select toggle

Constructors

constructor

new Selection(): Selection
Returns Selection
- Defined in src/viewer/selection.ts:22

Accessors

count

get count(): number
Returns current selection object count

Returns number
- Defined in src/viewer/selection.ts:126

objects

get objects(): IterableIterator<VimObject>
Returns selected object as an iterator.

Returns IterableIterator<VimObject>
- Defined in src/viewer/selection.ts:44

onValueChanged

get onValueChanged(): ISignal
Event called when selection changes or is cleared

Returns ISignal
- Defined in src/viewer/selection.ts:29

vim

get vim(): Vim
Returns the vim from which elements are selected. Cross-vim selection is not supported.

Returns Vim
- Defined in src/viewer/selection.ts:37

Methods

add

add(...objects: VimObject[]): void
Adds given objects to the current selection
Parameters
- Rest ...objects: VimObject[]
Returns void
- Defined in src/viewer/selection.ts:133

clear

clear(): void
Clears selection

Returns void
- Defined in src/viewer/selection.ts:193

dispose

dispose(): void
Disposes all resources and stops animations.

Returns void
- Defined in src/viewer/selection.ts:204

focus

focus(object: VimObject): void
Adds focus highlight to a single object. Pass undefined to remove highlight
Parameters
- object: VimObject
Returns void
- Defined in src/viewer/selection.ts:77

getBoundingBox

getBoundingBox(target?: Box3): Box3
Returns the bounding box of the selection or undefined if no selection.
Parameters
- target: Box3 = ...
  
  box to use for result.
Returns Box3
- Defined in src/viewer/selection.ts:52

has

has(object: VimObject): boolean
Returns true if given object is currently selected
Parameters
- object: VimObject
Returns boolean
- Defined in src/viewer/selection.ts:119

remove

remove(...objects: VimObject[]): void
Remove given objects from the current selection
Parameters
- Rest ...objects: VimObject[]
Returns void
- Defined in src/viewer/selection.ts:151

select

select(object: VimObject | VimObject[]): void
Select given objects and unselect all other objects using no or undefined as argument will clear selection.
Parameters
- object: VimObject | VimObject[]
Returns void
- Defined in src/viewer/selection.ts:91

toggle

toggle(...objects: VimObject[]): void
Adds unselected elements of given objects to the selection Remove selected elements of given objects from the selection
Parameters
- Rest ...objects: VimObject[]
Returns void
- Defined in src/viewer/selection.ts:171

Generated using TypeDoc