Class Selection

An object selection.

Object selections use render layers to facilitate quick and efficient visibility changes.

Hierarchy

Set<Object3D>
- Selection

Index

Constructors

Properties

[toStringTag] exclusive size [species]

Accessors

Methods

[iterator] add clear delete entries forEach getLayer has indexOf isExclusive keys set setExclusive setLayer setVisible toggle values

Constructors

constructor

new Selection(iterable?, layer?): Selection
Constructs a new selection.
Parameters
- Optional iterable: Iterable<Object3D<Object3DEventMap>>
  
  A collection of objects that should be added to this selection.
- Optional layer: number
  
  A dedicated render layer for selected objects.
Returns Selection

Overrides Set<Object3D>.constructor

Properties

`Readonly` [toStringTag]

[toStringTag]: string

exclusive

exclusive: boolean

Controls whether objects that are added to this selection should be removed from all other layers.

`Readonly` size

size: number

Returns

the number of (unique) elements in Set.

`Static` `Readonly` [species]

[species]: SetConstructor

Accessors

layer

get layer(): number
The render layer for selected objects.

Returns number
set layer(arg): void
Parameters
- arg: number
Returns void

Methods

[iterator]

[iterator](): IterableIterator<Object3D<Object3DEventMap>>
Iterates over values in the set.

Returns IterableIterator<Object3D<Object3DEventMap>>

Inherited from Set.[iterator]

add

add(object): Selection
Adds an object to this selection.

If exclusive is set to true, the object will also be removed from all other layers.
Parameters
- object: Object3D<Object3DEventMap>
  
  The object that should be selected.
Returns Selection
This selection.

Overrides Set.add

clear

clear(): Selection
Clears this selection.

Returns Selection
This selection.

Overrides Set.clear

delete

delete(value): boolean
Removes a specified value from the Set.
Parameters
- value: Object3D<Object3DEventMap>
Returns boolean
Returns true if an element in the Set existed and has been removed, or false if the element does not exist.

Inherited from Set.delete

entries

entries(): IterableIterator<[Object3D<Object3DEventMap>, Object3D<Object3DEventMap>]>
Returns an iterable of [v,v] pairs for every value v in the set.

Returns IterableIterator<[Object3D<Object3DEventMap>, Object3D<Object3DEventMap>]>

Inherited from Set.entries

forEach

forEach(callbackfn, thisArg?): void
Executes a provided function once per each value in the Set object, in insertion order.
Parameters
- callbackfn: ((value, value2, set) => void)
  - - (value, value2, set): void
    - Parameters
      
      value: Object3D<Object3DEventMap>
      
      value2: Object3D<Object3DEventMap>
      
      set: Set<Object3D<Object3DEventMap>>
      
      Returns void
- Optional thisArg: any
Returns void

Inherited from Set.forEach

getLayer

getLayer(): number
Returns the current render layer for selected objects.

The default layer is 10. If this collides with your own custom layers, please change it before rendering!

Returns number
The layer.

Deprecated
Use layer instead.

has

has(value): boolean
Parameters
- value: Object3D<Object3DEventMap>
Returns boolean
a boolean indicating whether an element with the specified value exists in the Set or not.

Inherited from Set.has

indexOf

indexOf(object): number
An alias for has.
Parameters
- object: Object3D<Object3DEventMap>
  
  An object.
Returns number
Returns 0 if the given object is currently selected, or -1 otherwise.

Deprecated
Added for backward-compatibility.

isExclusive

isExclusive(): number
Indicates whether objects that are added to this selection will be removed from all other layers.

Returns number
Whether this selection is exclusive. Default is false.

Deprecated
Use exclusive instead.

keys

keys(): IterableIterator<Object3D<Object3DEventMap>>
Despite its name, returns an iterable of the values in the set.

Returns IterableIterator<Object3D<Object3DEventMap>>

Inherited from Set.keys

set

set(objects): Selection
Clears this selection and adds the given objects.
Parameters
- objects: Iterable<Object3D<Object3DEventMap>>
  
  The objects that should be selected.
Returns Selection
This selection.

setExclusive

setExclusive(value): void
Controls whether objects that are added to this selection should be removed from all other layers.
Parameters
- value: number
  
  Whether this selection should be exclusive.
Returns void

Deprecated
Use exclusive instead.

setLayer

setLayer(value): void
Sets the render layer for selected objects.

The current selection will be updated accordingly.
Parameters
- value: number
  
  The layer. Range is [0, 31].
Returns void

Deprecated
Use layer instead.

setVisible

setVisible(visible): Selection
Sets the visibility of all selected objects.

This method enables or disables render layer 0 of all selected objects.
Parameters
- visible: boolean
  
  Whether the selected objects should be visible.
Returns Selection
This selection.

toggle

toggle(object): boolean
Removes an existing object from the selection. If the object doesn't exist it's added instead.
Parameters
- object: Object3D<Object3DEventMap>
  
  The object.
Returns boolean
Returns true if the object is added, false otherwise.

values

values(): IterableIterator<Object3D<Object3DEventMap>>
Returns an iterable of values in the set.

Returns IterableIterator<Object3D<Object3DEventMap>>

Inherited from Set.values