Skip to content

Layers

new Layers()

THREE equivalent: THREE.Layers

32-bit bitmask for layer-based visibility filtering. Used by Raycaster and camera to control which objects are tested or rendered.

Name Type Description
mask number The raw bitmask. Default 1 (layer 0 enabled).
Method Description
set(layer: number): void Enables only the given layer (clears all others).
enable(layer: number): void Enables a layer without affecting others.
enableAll(): void Enables all 32 layers.
disable(layer: number): void Disables a single layer.
disableAll(): void Disables all layers.
toggle(layer: number): void Toggles a layer on or off.
test(layers: Layers): boolean Returns true if any layer in common is enabled.
isEnabled(layer: number): boolean Returns true if the given layer is enabled.