Class Helpers

Provides utility functions to create scene helpers, such as bounding boxes, grids, axes...

Index

Constructors

Accessors

Methods

addBoundingBox addOBB create3DTileBoundingVolume createArrow createAxes createBoxHelper createGrid createSelectionBox remove3DTileBoundingVolume removeBoundingBox removeOBB update3DTileBoundingVolume

Constructors

constructor

new Helpers(): Helpers
Returns Helpers

Accessors

`Static`axisSize

get axisSize(): number
Returns number
- Defined in helpers/Helpers.ts:238
set axisSize(v): void
Parameters
- v: number
Returns void
- Defined in helpers/Helpers.ts:234

Methods

`Static`addBoundingBox

addBoundingBox(obj, color): void
Adds a bounding box helper to the object. If a bounding box is already present, it is updated instead.
Parameters
- obj: Object3D<Object3DEventMap>
  The object to decorate.
- color: string | Color
  The color.
Returns void
Example
```
// add a bounding box to 'obj'
Helpers.addBoundingBox(obj, 'green');
```
- Defined in helpers/Helpers.ts:209

`Static`addOBB

addOBB(obj, obb, color): void
Adds an oriented bounding box (OBB) helper to the object. If a bounding box is already present, it is updated instead.
Parameters
- obj: Object3D<Object3DEventMap>
  The object to decorate.
- obb: OBB
  The OBB.
- color: Color
  The color.
Returns void
Example
```
// add an OBB to 'obj'
Helpers.addOBB(obj, obj.OBB, 'green');
```
- Defined in helpers/Helpers.ts:271

`Static`create3DTileBoundingVolume

create3DTileBoundingVolume(entity, obj, metadata, color): null | {
    absolute: boolean;
    object3d:
        | VolumeHelper
        | SphereHelper
        | Mesh<BufferGeometry<NormalBufferAttributes>, MeshBasicMaterial, Object3DEventMap>
        | LineSegments<BufferGeometry<NormalBufferAttributes> | LineSegmentsGeometry, LineBasicMaterial>;
}
Creates a bounding volume helper to the 3D Tile object and returns it. The bounding volume can contain a sphere, a region, or a box.
Parameters
- entity: Tiles3D<Material, EntityUserData>
  The entity.
- obj: Object3D<Object3DEventMap>
  The object to decorate.
- metadata: ProcessedTile
  The tile metadata
- color: string | Color
  The color.
Returns null | {
    absolute: boolean;
    object3d:
        | VolumeHelper
        | SphereHelper
        | Mesh<BufferGeometry<NormalBufferAttributes>, MeshBasicMaterial, Object3DEventMap>
        | LineSegments<BufferGeometry<NormalBufferAttributes> | LineSegmentsGeometry, LineBasicMaterial>;
}
The helper object, or null if it could not be created.
Example
```
// add a bounding box to 'obj'
Helpers.create3DTileBoundingVolume(entity, obj, volume, 'green');
```
- Defined in helpers/Helpers.ts:306

`Static`createArrow

createArrow(start, end): ArrowHelper
Creates an arrow between the two points.
Parameters
- start: Vector3
  The starting point.
- end: Vector3
  The end point.
Returns ArrowHelper
- Defined in helpers/Helpers.ts:421

`Static`createAxes

createAxes(size): AxesHelper
Create an axis helper.
Parameters
- size: number
  The size of the helper.
Returns AxesHelper
- Defined in helpers/Helpers.ts:383

`Static`createBoxHelper

createBoxHelper(box, color): BoundingBoxHelper
Parameters
- box: Box3
- color: Color
Returns BoundingBoxHelper
- Defined in helpers/Helpers.ts:224

`Static`createGrid

createGrid(origin, size, subdivs): GridHelper
Create a grid on the XZ plane.
Parameters
- origin: Vector3
  The grid origin.
- size: number
  The size of the grid.
- subdivs: number
  The number of grid subdivisions.
Returns GridHelper
- Defined in helpers/Helpers.ts:366

`Static`createSelectionBox

createSelectionBox(obj, color): BoundingBoxHelper
Creates a selection bounding box helper around the specified object.
Parameters
- obj: Object3D<Object3DEventMap>
  The object to decorate.
- color: Color
  The color.
Returns BoundingBoxHelper
the created box helper.
Example
```
// add a bounding box to 'obj'
Helpers.createSelectionBox(obj, 'green');
```
- Defined in helpers/Helpers.ts:252

`Static`remove3DTileBoundingVolume

remove3DTileBoundingVolume(obj): void
Parameters
- obj: Object3D<Object3DEventMap>
Returns void
- Defined in helpers/Helpers.ts:392

`Static`removeBoundingBox

removeBoundingBox(obj): void
Removes an existing bounding box from the object, if any.
Parameters
- obj: Object3D<Object3DEventMap>
  The object to update.
Returns void
Example
```
Helpers.removeBoundingBox(obj);
```
- Defined in helpers/Helpers.ts:435

`Static`removeOBB

removeOBB(obj): void
Parameters
- obj: Object3D<Object3DEventMap>
Returns void
- Defined in helpers/Helpers.ts:283

`Static`update3DTileBoundingVolume

update3DTileBoundingVolume(obj, properties): void
Parameters
- obj: Object3D<Object3DEventMap>
- properties: {
  color: Color;
  }
  - color: Color
Returns void
- Defined in helpers/Helpers.ts:406

Class Helpers

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns Helpers

Accessors

StaticaxisSize

Returns number

Parameters

Returns void

Methods

StaticaddBoundingBox

Parameters

Returns void

Example

StaticaddOBB

Parameters

Returns void

Example

Staticcreate3DTileBoundingVolume

Parameters

Returns null | { absolute: boolean; object3d: | VolumeHelper | SphereHelper | Mesh<BufferGeometry<NormalBufferAttributes>, MeshBasicMaterial, Object3DEventMap> | LineSegments<BufferGeometry<NormalBufferAttributes> | LineSegmentsGeometry, LineBasicMaterial>; }

Example

StaticcreateArrow

Parameters

Returns ArrowHelper

StaticcreateAxes

Parameters

Returns AxesHelper

StaticcreateBoxHelper

Parameters

Returns BoundingBoxHelper

StaticcreateGrid

Parameters

Returns GridHelper

StaticcreateSelectionBox

Parameters

Returns BoundingBoxHelper

Example

Staticremove3DTileBoundingVolume

Parameters

Returns void

StaticremoveBoundingBox

Parameters

Returns void

Example

StaticremoveOBB

Parameters

Returns void

Staticupdate3DTileBoundingVolume

Parameters

color: Color

Returns void

Settings

On This Page

`Static`axisSize

`Static`addBoundingBox

`Static`addOBB

`Static`create3DTileBoundingVolume

Returns null | {
absolute: boolean;
object3d:
| VolumeHelper
| SphereHelper
| Mesh<BufferGeometry<NormalBufferAttributes>, MeshBasicMaterial, Object3DEventMap>
| LineSegments<BufferGeometry<NormalBufferAttributes> | LineSegmentsGeometry, LineBasicMaterial>;
}

`Static`createArrow

`Static`createAxes

`Static`createBoxHelper

`Static`createGrid

`Static`createSelectionBox

`Static`remove3DTileBoundingVolume

`Static`removeBoundingBox

`Static`removeOBB

`Static`update3DTileBoundingVolume