API Docs for: 2.0.0
Show:

Effect Class

Extends Component
Defined in: src/viewer/effects/effect.js:1
Module: effect
Parent Module: BIMSURFER

An Effect is a the base class for visual effects that are applied to ObjectSets.

Overview

Constructor

Effect

(
  • [viewer]
  • [cfg]
)

Defined in src/viewer/effects/effect.js:1

Parameters:

  • [viewer] Viewer optional

    Parent Viewer.

  • [cfg] optional

    Configs

    • [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 Effect.

    • [objectSet] ObjectSet optional

      The ObjectSet to apply this Effect to.

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

Defined in src/viewer/effects/effect.js:64

Flag which indicates whether this Effect is active or not.

Fires an active event on change.

className

String final

Inherited from Component but overwritten in src/viewer/effects/effect.js:29

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.

invert

Boolean

Defined in src/viewer/effects/effect.js:133

Flag which inverts the Object that this Effect applies to.

  • When true, this Effect applies to Object that are in the viewer but not in the objectSet.
  • When false, this Effect applies to Object that are in the viewer and also in the objectSet.

Fires an invert event on change.

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.

objectSet

ObjectSet

Defined in src/viewer/effects/effect.js:40

The ObjectSet that this Effect applies to.

viewer

Viewer final

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

The Viewer that contains this Component.

Events

active

Defined in src/viewer/effects/effect.js:118

Fired whenever this Effect'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.

invert

Defined in src/viewer/effects/effect.js:161

Fired whenever this Effect's invert property changes.

Event Payload:

  • value Object

    The property's new value