API Docs for: 2.0.0
Show:

Cursor Class

Extends Object
Defined in: src/viewer/cursor.js:1
Module: BIMSURFER

Manages the cursor icon for a Viewer.

Overview

TODO

Example

TODO

Constructor

Cursor

(
  • [viewer]
)

Defined in src/viewer/cursor.js:1

Parameters:

  • [viewer] Viewer optional

    Parent Viewer, creates this Configs within the default Viewer when omitted

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

Inherited from Object: src/viewer/objects/object.js:377

Whether this Object is active or not.

Fires an active event on change.

boundary

Inherited from Object: src/viewer/objects/object.js:620

The World-space boundary of this Object.

center

Array of Number

Inherited from Object: src/viewer/objects/object.js:644

The World-space center of this Object.

className

String final

Inherited from Component but overwritten in src/viewer/objects/object.js:95

JavaScript class name for this Component.

color

Array(Number)

Inherited from Object: src/viewer/objects/object.js:536

The color of this Object.

Default: [1.0, 1.0, 1.0]

desaturated

Boolean

Inherited from Object: src/viewer/objects/object.js:475

Whether this Object is desaturated.

Default: false

destroyed

Boolean

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

True as soon as this Component has been destroyed

highlighted

Boolean

Inherited from Object: src/viewer/objects/object.js:443

Whether this Object is highlighted.

Default: false

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

label

Boolean

Inherited from Object: src/viewer/objects/object.js:668

Indicates if this Object shows a debug Label.

matrix

Array of Number

Inherited from Object: src/viewer/objects/object.js:595

This Object's transformation matrix.

Default: [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]

metadata

Object

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

Metadata on this component.

opacity

Number

Inherited from Object: src/viewer/objects/object.js:569

Factor in the range [0..1] indicating how transparent this Object is.

A value of 0.0 indicates fully transparent, 1.0 is fully opaque.

This Object will appear transparent only if transparent is also set to true.

Default: 1.0

transparent

Boolean

Inherited from Object: src/viewer/objects/object.js:414

Whether this Object is transparent.

Default: false

viewer

Viewer final

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

The Viewer that contains this Component.

xray

Boolean

Inherited from Object: src/viewer/objects/object.js:507

Whether this Object is X-rayed

Default: false

Events

active

Inherited from Object: src/viewer/objects/object.js:401

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