ThreeJS Layers

A Layers object assigns an Object3D to one or more of the 32 layers numbered 0 to 31 - the layers are internally stored as a bit mask, and all Object3Ds are by default members of layer 0.

This can be used to control visibility; an object must share a layer with a camera in order to be rendered when the camera's view is rendered.

Every class that derives from Object3D has an Object3D.layers property that is an instance of this class.

Constructor

Layers()

Create a new Layers object, with membership initially set to layer 0.

Properties

.mask : Integer

A bit mask storing which of the 32 layers this layers object is currently a member of.

Methods

.disable ( layer : Integer ) : undefined

layer - an integer from 0 to 31.

Remove membership of this layer.

.enable ( layer : Integer ) : undefined

layer - an integer from 0 to 31.

Add membership of this layer.

.set ( layer : Integer ) : undefined

layer - an integer from 0 to 31.

Set membership to layer, and remove membership all other layers.

.test ( layers : Layers ) : Boolean

layers - a Layers object

Returns true if this and the passed layers object have at least one layer in common.

.isEnabled ( layer : Integer ) : Boolean

layer - an integer from 0 to 31.

Returns true if the given layer is enabled.

.toggle ( layer : Integer ) : undefined

layer - an integer from 0 to 31.

Toggle membership of layer.

.enableAll () : undefined

Add membership to all layers.

.disableAll () : undefined

Remove membership from all layers.