中

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 Object3D.layers| layers property which is an instance of this class.

Core Class

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 Object3D.layers| layers property which is an instance of this class.

Hierarchy

  • EventDispatcher
    • Layers

Constructors

  • Returns Layers

Properties

_uuid

_uuid: string | null

_listeners

_listeners: Map<Symbol, Listener<never>[]>

Accessors

  • get mask(): number

    Returns number

  • set mask(value: number): void

    Parameters

    • value: number

    Returns void

  • get uuid(): string

    Returns string

  • set uuid(uuid: string): void

    Parameters

    • uuid: string

    Returns void

Methods

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

    Parameters

    • channel: number

      an integer from 0 to 31.

    Returns this

  • Add membership of this layer.

    Parameters

    • channel: number

      an integer from 0 to 31.

    Returns this

  • Toggle membership of layer.

    Parameters

    • channel: number

      an integer from 0 to 31.

    Returns this

  • Remove membership of this layer.

    Parameters

    • channel: number

      an integer from 0 to 31.

    Returns this

  • 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

  • Copies the mask of given layers to this.

    Parameters

    Returns void

  • Returns a new Layers with the same mask as this one.

    Returns Layers

  • Adds a listener to an event type.

    Type Parameters

    • T

    Parameters

    • type: EventType<T>

      The type of event to listen to.

    • listener: Listener<T>

      The function that gets called when the event is fired.

    Returns void

  • Only active the listener one times and then off it| it.

    Type Parameters

    • T

    Parameters

    • type: EventType<T>
    • listener: Listener<T>

    Returns void

  • Checks if listener is added to an event type.

    Type Parameters

    • T

    Parameters

    • type: EventType<T>
    • listener: Listener<T>

    Returns boolean

  • Removes a listener from listening list.

    Type Parameters

    • T

    Parameters

    • type: EventType<T>
    • listener: Listener<T>

    Returns void

  • Active the event and call the registered listener.

    Parameters

    • type: EventType<never>

    Returns void

  • Active the event and call the registered listener.

    Type Parameters

    • T

    Parameters

    • type: EventType<T>
    • payload: T

    Returns void

  • Removes all listeners from listening list.

    Returns void