Skip to main content

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 rendered.

All classes that inherit from Object3D have an Object3D.layers property which is an instance of this class.

Examples​

[example:webgl_layers WebGL / layers]

Constructor​

Layers​

function Layers( ): void;

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

Properties​

mask​

mask: Integer;

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

Methods​

disable​

function disable( layer: Integer ): undefined;

layer - an integer from 0 to 31.

Remove membership of this layer.

enable​

function enable( layer: Integer ): undefined;

layer - an integer from 0 to 31.

Add membership of this layer.

set​

function set( layer: Integer ): undefined;

layer - an integer from 0 to 31.

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

test​

function 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​

function isEnabled( layer: Integer ): Boolean;

layer - an integer from 0 to 31.

Returns true if the given layer is enabled.

toggle​

function toggle( layer: Integer ): undefined;

layer - an integer from 0 to 31.

Toggle membership of layer.

enableAll​

function enableAll( ): undefined;

Add membership to all layers.

disableAll​

function disableAll( ): undefined;

Remove membership from all layers.

Source​

src/core/Layers.js