Layers
A Layers object assigns an Object3D to 1 or more of 32 layers numbered 0 to 31 - internally the layers are stored as a bit mask, and by default all Object3Ds are a member of layer 0. This can be used to control visibility - an object must share a layer with a camera to be visible when that camera's view is renderered. All classes that inherit from Object3D have an layers property which is an instance of this class.
Hierarchy
- EventDispatcher
- Layers
Accessors
uuid
-
get uuid(): string
Returns string
-
set uuid(uuid: string): void
Parameters
- uuid: string
Returns void
mask
-
get mask(): number
Returns number
-
set mask(value: number): void
Parameters
- value: number
Returns void
Methods
on
once
has
off
emit
-
Active the event and call the registered listener.
Parameters
- type: EventType<never>
Returns void
clear
-
Removes all listeners from listening list.
Returns void
set
-
Set membership to layer, and remove membership all other layers.
Parameters
- channel: number
an integer from 0 to 31.
Returns this
- channel: number
enable
-
Add membership of this layer.
Parameters
- channel: number
an integer from 0 to 31.
Returns this
- channel: number
toggle
-
Toggle membership of layer.
Parameters
- channel: number
an integer from 0 to 31.
Returns this
- channel: number
disable
-
Remove membership of this layer.
Parameters
- channel: number
an integer from 0 to 31.
Returns this
- channel: number
test
-
Returns true if this and the passed layers object are members of the same set of layers.
Parameters
- layers: Layers
a Layers object.
Returns boolean
- layers: Layers
A Layers object assigns an Object3D to 1 or more of 32 layers numbered 0 to 31 - internally the layers are stored as a bit mask, and by default all Object3Ds are a member of layer 0. This can be used to control visibility - an object must share a layer with a camera to be visible when that camera's view is renderered. All classes that inherit from Object3D have an layers property which is an instance of this class.