API Docs for: 2.0.0
Show:

Light Class

Extends Component
Defined in: src/viewer/lighting/light.js:1
Module: lighting
Parent Module: BIMSURFER

Light is the base class for all light source classes in BIMViewer.

Overview

  • Light is subclassed by AmbientLight, DirLight and PointLight.
  • The number of Lights allowed is governed by the number of varying types supported in your WebGL.

Constructor

Light

(
  • [viewer]
  • [cfg]
)

Defined in src/viewer/lighting/light.js:1

Parameters:

  • [viewer] Viewer optional

    Parent Viewer.

  • [cfg] optional

    Light configuration

    • [id] String optional

      Optional ID, unique among all components in the parent Viewer, generated automatically when omitted.

    • [meta] String:Object optional

      Optional map of user-defined metadata to attach to this Light.

    • [camera] Camera optional

      Camera to control

Methods

destroy

()

Inherited from Component: src/viewer/component.js:389

Destroys this component.

Removes this Component from its Viewer.

Fires a destroyed event on this Component.

error

(
  • message
)

Inherited from Component: src/viewer/component.js:365

Logs an error for this component to the JavaScript console.

The console message will have this format: [ERROR] <component id>: <message>

Parameters:

  • message String

    The message to log

fire

(
  • event
  • value
  • [forget=false]
)

Inherited from Component: src/viewer/component.js:259

Fires an event on this component.

Notifies existing subscribers to the event, retains the event to give to any subsequent notifications on that location as they are made.

Parameters:

  • event String

    The event type name

  • value Object

    The event

  • [forget=false] Boolean optional

    When true, does not retain for subsequent subscribers

log

(
  • message
)

Inherited from Component: src/viewer/component.js:353

Logs a console debugging message for this component.

The console message will have this format: [LOG] <component id>: <message>

Parameters:

  • message String

    The message to log

off

(
  • handle
)

Inherited from Component: src/viewer/component.js:316

Cancels an event subscription that was previously made with on or once.

Parameters:

  • handle String

    Subscription handle

on

(
  • event
  • callback
  • [scope=this]
)
String

Inherited from Component: src/viewer/component.js:286

Subscribes to an event on this component.

The callback is be called with this component as scope.

Parameters:

  • event String

    Publication event

  • callback Function

    Called when fresh data is available at the event

  • [scope=this] Object optional

    Scope for the callback

Returns:

String:

Handle to the subscription, which may be used to unsubscribe with {@link #off}.

once

(
  • event
  • callback
  • [scope=this]
)

Inherited from Component: src/viewer/component.js:335

Subscribes to the next occurrence of the given event, then un-subscribes as soon as the event is handled.

Parameters:

  • event String

    Data event to listen to

  • callback Function(data)

    Called when fresh data is available at the event

  • [scope=this] Object optional

    Scope for the callback

warn

(
  • message
)

Inherited from Component: src/viewer/component.js:377

Logs a warning for this component to the JavaScript console.

The console message will have this format: [WARN] <component id>: <message>

Parameters:

  • message String

    The message to log

Properties

active

Boolean

Provided by the BIMSURFER module.

Defined in src/viewer/effects/render.js:51

Flag which indicates whether this Light is active or not.

Fires an active event on change.

active

Boolean

Defined in src/viewer/lighting/light.js:52

Flag which indicates whether this Light is active or not.

Fires an active event on change.

className

String final

Inherited from Component but overwritten in src/viewer/effects/render.js:27

JavaScript class name for this Component.

className

String final

Defined in src/viewer/lighting/light.js:28

JavaScript class name for this Component.

destroyed

Boolean

Inherited from Component: src/viewer/component.js:229

True as soon as this Component has been destroyed

id

String final

Inherited from Component: src/viewer/component.js:220

Unique ID for this Component within its parent Viewer.

Items in this map

Unknown

Inherited from Component: src/viewer/utils/map.js:13

metadata

Object

Inherited from Component: src/viewer/component.js:212

Metadata on this component.

viewer

Viewer final

Inherited from Component: src/viewer/component.js:203

The Viewer that contains this Component.

Events

active

Provided by the BIMSURFER module.

Defined in src/viewer/effects/render.js:76

Fired whenever this Light's active property changes.

Event Payload:

  • value Object

    The property's new value

active

Defined in src/viewer/lighting/light.js:77

Fired whenever this Light's active property changes.

Event Payload:

  • value Object

    The property's new value

destroyed

Inherited from Component: src/viewer/component.js:409

Fired when this Component is destroyed.