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(materials: ViewerMaterials): Selection
Parameters
- materials: ViewerMaterials
Returns Selection
- Defined in src/vim-webgl-viewer/selection.ts:29

Accessors

count

get count(): number
Returns the current count of selected objects.

Returns number
- Defined in src/vim-webgl-viewer/selection.ts:139

objects

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

Returns IterableIterator<IObject>
- Defined in src/vim-webgl-viewer/selection.ts:52

onValueChanged

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

Returns ISignal
- Defined in src/vim-webgl-viewer/selection.ts:37

vim

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

Returns Vim
- Defined in src/vim-webgl-viewer/selection.ts:45

Methods

add

add(...objects: IObject[]): void
Adds the given objects to the current selection.
Parameters
- Rest ...objects: IObject[]
  
  The objects to add to the selection.
Returns void
- Defined in src/vim-webgl-viewer/selection.ts:147

clear

clear(): void
Clears the current selection.

Returns void
- Defined in src/vim-webgl-viewer/selection.ts:210

dispose

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

Returns void
- Defined in src/vim-webgl-viewer/selection.ts:221

focus

focus(object: IObject): void
Adds focus highlight to a single object. Pass undefined to remove the highlight.
Parameters
- object: IObject
  
  The object to focus on, or undefined to remove the highlight.
Returns void
- Defined in src/vim-webgl-viewer/selection.ts:86

getBoundingBox

getBoundingBox(target??: Box3): Box3
Retrieves the bounding box of the selection. Returns undefined if there's no selection.

Returns
The bounding box of the selection or undefined if no selection exists.
Parameters
- Optional target: Box3 = ...
  
  Optional parameter to specify a box to use for the result.
Returns Box3
- Defined in src/vim-webgl-viewer/selection.ts:61

has

has(object: IObject): boolean
Returns true if the given object is currently selected.

Returns
True if the object is selected, false otherwise.
Parameters
- object: IObject
  
  The object to check for selection.
Returns boolean
- Defined in src/vim-webgl-viewer/selection.ts:132

remove

remove(...objects: IObject[]): void
Removes the given objects from the current selection.
Parameters
- Rest ...objects: IObject[]
  
  The objects to remove from the selection.
Returns void
- Defined in src/vim-webgl-viewer/selection.ts:166

select

select(object: IObject | IObject[]): void
Selects the given objects and unselects all other objects. Pass null, undefined, or an empty array as argument to clear selection.
Parameters
- object: IObject | IObject[]
  
  The object or array of objects to select, or null, undefined, or an empty array to clear the selection.
Returns void
- Defined in src/vim-webgl-viewer/selection.ts:102

toggle

toggle(...objects: IObject[]): void
Toggles the selection state of the given objects:
- Adds unselected elements of the given objects to the selection.
- Removes selected elements of the given objects from the selection.
Parameters
- Rest ...objects: IObject[]
  
  The objects to toggle selection for.
Returns void
- Defined in src/vim-webgl-viewer/selection.ts:188

Generated using TypeDoc