API Docs for: 2.0.0
Show:

Geometry Class

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

TODO

Overview

TODO

Example

Creating a triangle mesh Geometry


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

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

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

// Create a triangle mesh Geometry

var geometry = new BIMSURFER.Geometry(viewer, {

   primitive: "triangles",

   positions: [
       5, 5, 5, -5, 5, 5, -5, -5, 5, 5, -5, 5, // v0-v1-v2-v3 front
       5, 5, 5, 5, -5, 5, 5, -5, -5, 5, 5, -5, // v0-v3-v4-v5 right
       5, 5, 5, 5, 5, -5, -5, 5, -5, -5, 5, 5, // v0-v5-v6-v1 top
       -5, 5, 5, -5, 5, -5, -5, -5, -5, -5, -5, 5, // v1-v6-v7-v2 left
       -5, -5, -5, 5, -5, -5, 5, -5, 5, -5, -5, 5, // v7-v4-v3-v2 bottom
       5, -5, -5, -5, -5, -5, -5, 5, -5, 5, 5, -5 // v4-v7-v6-v5 back
   ],

   normals: [
       0, 0, 1, 0, 0, 1, 0, 0, 1, 0, 0, 1, // v0-v1-v2-v3 front
       1, 0, 0, 1, 0, 0, 1, 0, 0, 1, 0, 0, // v0-v3-v4-v5 right
       0, 1, 0, 0, 1, 0, 0, 1, 0, 0, 1, 0, // v0-v5-v6-v1 top
      -1, 0, 0, -1, 0, 0, -1, 0, 0, -1, 0, 0, // v1-v6-v7-v2 left
       0, -1, 0, 0, -1, 0, 0, -1, 0, 0, -1, 0, // v7-v4-v3-v2 bottom
       0, 0, -1, 0, 0, -1, 0, 0, -1, 0, 0, -1 // v4-v7-v6-v5 back
   ],

   indices: [
       0, 1, 2, 0, 2, 3, // back
       4, 5, 6, 4, 6, 7,  // front
       8, 9, 10, 8, 10, 11, // right
       12, 13, 14, 12, 14, 15, // top
       16, 17, 18, 16, 18, 19, // left
       20, 21, 22, 20, 22, 23 // bottom
   ]
});

// Create an Object that uses our Geometry
// Note that an Object can have multiple Geometries

new BIMSURFER.BoxObject(viewer, {
   id: "foo",
   type: "IfcWall",
   geometries: [ geometry ]
});

Constructor

Geometry

(
  • [viewer]
  • [cfg]
)

Defined in src/viewer/geometry/geometry.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 BoxGeometry.

    • [primitive="triangles"] String optional

      The primitive type. Accepted values are 'points', 'lines', 'line-loop', 'line-strip', 'triangles', 'triangle-strip' and 'triangle-fan'.

    • [positions] Array of Number optional

      Positions array.

    • [normals] Array of Number optional

      Normals array.

    • [uv] Array of Number optional

      UVs array.

    • [uv2] Array of Number optional

      Second UVs array, for a second UV level.

    • [colors] Array of Number optional

      Vertex colors.

    • [indices] Array of Number optional

      Indices array.

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

className

String final

Inherited from Component but overwritten in src/viewer/geometry/geometry.js:97

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

destroyed

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

Fired when this Component is destroyed.