Class LayerSet

Represents an immutable set of scene layers, supporting set operations like union, intersection, and difference.

Index

Constructors

Properties

Methods

contains except fromBit fromId fromMask intersect isEmpty PredefinedIds toArray union

Constructors

`Protected`constructor

new LayerSet(): LayerSet
Snap Hidden
Returns LayerSet

Properties

`Static`All

A LayerSet containing all available layers.

`Readonly`mask

mask: number

The underlying bitmask representing the set of active layers.

`Static`None

An empty LayerSet containing no layers.

Methods

contains

contains(other: LayerSet): boolean
Returns true if this set contains all layers in the given LayerSet.
Parameters
- other: LayerSet
Returns boolean

except

except(other: LayerSet): LayerSet
Returns a new LayerSet with all layers from the given set removed.
Parameters
- other: LayerSet
Returns LayerSet

`Static`fromBit

fromBit(bit: number): LayerSet
Creates a LayerSet from a single bit index.
Parameters
- bit: number
Returns LayerSet

`Static`fromId

fromId(layerId: LayerId): LayerSet
Creates a LayerSet from a single LayerId.
Parameters
- layerId: LayerId
Returns LayerSet

`Static`fromMask

fromMask(mask: number): LayerSet
Creates a LayerSet from a raw bitmask value.
Parameters
- mask: number
Returns LayerSet

intersect

intersect(other: LayerSet): LayerSet
Returns a new LayerSet containing only layers present in both sets.
Parameters
- other: LayerSet
Returns LayerSet

isEmpty

isEmpty(): boolean
Returns true if this set contains no layers.

Returns boolean

`Static`PredefinedIds

PredefinedIds(): LayerSet
Returns the collection of predefined layer identifiers.

Returns LayerSet

toArray

toArray(): LayerId[]
Returns an array of all LayerId values in this set.

Returns LayerId[]

union

union(other: LayerSet): LayerSet
Returns a new LayerSet combining all layers from both sets.
Parameters
- other: LayerSet
Returns LayerSet