API Docs for: 1.0.0

OBBHelper

Helper that visualizes the object-aligned boundary of a Boundary3D.

Constructor

OBBHelper

(
  • cfg
)

Parameters:

  • cfg

    Configuration

    • [boundary] Number | String | Boundary3D optional

      ID or instance of a Boundary3D.

    • [color=[0.4,0.4,0.4]] Float32Array optional

      Emmissive color

    • [visible=true] Boolean optional

      Indicates whether or not this helper is visible.

Properties

boundary

Boundary3D

A Boundary3D whose AABB we'll dynamically fit this OBBGeometry to.

Fires a OBBHelper/boundary:event event on change.

color

Float32Array

Emissive color of this OBBHelper.

Fires an color event on change.

Default: [0,1,0]

mousePickControl

MousePickControl

The MousePickControl attached to this MousePickHelper.

Fires an MousePickControl/mousePickControl:event event on change.

visible

Boolean

Indicates whether this OBBHelper is visible or not.

Fires a visible event on change.

Default: true

Events

color

Fired whenever this OBBHelper's color property changes.

Event Payload:

  • value Float32Array

    The property's new value

visible

Fired whenever this helper's visible property changes.

Event Payload:

  • value Boolean

    The property's new value