Class: CustomObject

Beta

This class encasulate a Object3D, and made it possible to add flags to it. It might be extended with more flags in the future.

Implements

• ICustomObject

Constructors

new CustomObject()

new CustomObject(object): CustomObject

Beta

Parameters

• object: Object3D<Object3DEventMap>

Returns

CustomObject

Defined in

packages/utilities/src/customObject/CustomObject.ts:26

Accessors

isPartOfBoundingBox

Get Signature

get isPartOfBoundingBox(): boolean

Beta

Set or get whether it should be part of the combined bounding box or not. Default is true.

Returns

boolean

Set Signature

set isPartOfBoundingBox(value): void

Beta

Get whether it should be part of the combined bounding box or not. Default is true.

Parameters

• value: boolean

Returns

void

Implementation of

ICustomObject.isPartOfBoundingBox

Defined in

packages/utilities/src/customObject/CustomObject.ts:43

---

object

Get Signature

get object(): Object3D<Object3DEventMap>

Beta

Get the Object3D

Returns

Object3D<Object3DEventMap>

Implementation of

ICustomObject.object

Defined in

packages/utilities/src/customObject/CustomObject.ts:34

---

shouldPick

Get Signature

get shouldPick(): boolean

Beta

Set or get whether it should be picked by the camera manager Default is false.

Returns

boolean

Set Signature

set shouldPick(value): void

Beta

Get whether it should be picked by the camera manager Default is false.

Parameters

• value: boolean

Returns

void

Implementation of

ICustomObject.shouldPick

Defined in

packages/utilities/src/customObject/CustomObject.ts:56

---

shouldPickBoundingBox

Get Signature

get shouldPickBoundingBox(): boolean

Beta

Set or get whether it should be also give the bounding box when picked by the camera Default is false.

Returns

boolean

Set Signature

set shouldPickBoundingBox(value): void

Beta

Set or get whether it should be also give the bounding box when picked by the camera Default is false.

Parameters

• value: boolean

Returns

void

Implementation of

ICustomObject.shouldPickBoundingBox

Defined in

packages/utilities/src/customObject/CustomObject.ts:69

---

useDepthTest

Get Signature

get useDepthTest(): boolean

Beta

Get whether it should be rendered with depth test (on top on other objects) Default is true.

Returns

boolean

Set Signature

set useDepthTest(value): void

Beta

Get whether it should be rendered with depth test (on top on other objects) Default is true.

Parameters

• value: boolean

Returns

void

Implementation of

ICustomObject.useDepthTest

Defined in

packages/utilities/src/customObject/CustomObject.ts:82

Methods

beforeRender()

beforeRender(_camera): void

Beta

Parameters

• _camera: PerspectiveCamera

Returns

void

Implementation of

ICustomObject.beforeRender

Defined in

packages/utilities/src/customObject/CustomObject.ts:139

---

getBoundingBox()

getBoundingBox(target): Box3

Beta

Parameters

• target: Box3

Returns

Box3

Implementation of

ICustomObject.getBoundingBox

Defined in

packages/utilities/src/customObject/CustomObject.ts:94

---

intersectIfCloser()

intersectIfCloser(intersectInput, closestDistance): undefined | CustomObjectIntersection

Beta

Parameters

• intersectInput: CustomObjectIntersectInput

• closestDistance: undefined | number

Returns

undefined | CustomObjectIntersection

Implementation of

ICustomObject.intersectIfCloser

Defined in

packages/utilities/src/customObject/CustomObject.ts:104