API Docs for: 2.0.0
Show:

Position Class

Extends Component
Defined in: src/viewer/labelling/position.js:1
Module: labelling

A Position is a spatial location within a Viewer.

Overview

A Position provides its coordinates in each of BIMSurfer's five coordinate systems:

  • pos - 3D coordinates within the Position's local Model coordinate system.
  • worldPos - 3D coordinates within the Viewer's current World coordinate system, after transformation by the Position's modelling matrix.
  • viewPos - 3D coordinates within the Viewer's current View coordinate system, after transformation by the Viewer's view matrix.
  • projPos - 3D coordinates within the Viewer's current Projection coordinate system, after transformation by the Viewer's projection matrix.
  • canvasPos - 2D coordinates within the Viewer's current Canvas coordinate system.

Example

// Create a Viewer
var viewer = new BIMSURFER.Viewer({ element: "myDiv" });

// Create a Camera
var camera = new BIMSURFER.Camera(viewer, {
    eye: [20, 20, -20]
});

// Create a CameraControl to interact with the Camera
var cameraControl = new BIMSURFER.CameraControl(viewer, {
   camera: camera
});

// Create a Position
new BIMSURFER.Position(viewer, {
   pos: [0,0,0],
   matrix: BIMSURFER.math.translationMat4v([4, 0,0])
});

Constructor

Position

(
  • [viewer]
  • [cfg]
)

Defined in src/viewer/labelling/position.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 Position.

    • [pos] Array of Number optional

      Position's 3D location.

    • [matrix=[1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]] Array of Number optional

      Transform matrix - a one-dimensional, sixteen element array of elements, an identity matrix by default.

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

canvasPos

Array of Number final

Defined in src/viewer/labelling/position.js:271

This Position's 2D coordinates within the Canvas coordinate system.

className

String final

Inherited from Component but overwritten in src/viewer/labelling/position.js:62

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

matrix

Array of Number

Defined in src/viewer/labelling/position.js:161

This Positions's 4x4 modelling 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.

pos

Array of Number

Defined in src/viewer/labelling/position.js:126

The Position's 3D coordinates within its local Model coordinate system, ie. before transformation by the Position's matrix.

Default: [0,0,0]

projPos

Array of Number final

Defined in src/viewer/labelling/position.js:248

This Position's 3D homogeneous coordinates within the Projection coordinate system, ie. after transformation by the Viewer's projection matrix.

viewer

Viewer final

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

The Viewer that contains this Component.

viewPos

Array of Number final

Defined in src/viewer/labelling/position.js:222

This Position's 3D coordinates within the View coordinate system, ie. after transformation by the Viewer's view matrix and before transformation by the Viewer's projection matrix.

worldPos

Array of Number final

Defined in src/viewer/labelling/position.js:188

This Position's 3D coordinates within the World coordinate system, ie. after transformation by the Position's matrix and before transformation by Viewer's viewing matrix.

Default: [0,0,0]

Events

destroyed

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

Fired when this Component is destroyed.