Skip to main content
Version: 4.x

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​

Constructors​

new CustomObject()​

new CustomObject(object): CustomObject

Beta

Constructor

Parameters​

• object: Object3D<Object3DEventMap>

Returns​

CustomObject

Defined in​

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

Accessors​

isPartOfBoundingBox​

get isPartOfBoundingBox(): boolean

Beta

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

set isPartOfBoundingBox(value): void

Beta

Parameters​

• value: boolean

Returns​

boolean

Implementation of​

ICustomObject . isPartOfBoundingBox

Defined in​

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

object​

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 shouldPick(): boolean

Beta

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

set shouldPick(value): void

Beta

Parameters​

• value: boolean

Returns​

boolean

Implementation of​

ICustomObject . shouldPick

Defined in​

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

shouldPickBoundingBox​

get shouldPickBoundingBox(): boolean

Beta

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

set shouldPickBoundingBox(value): void

Beta

Parameters​

• value: boolean

Returns​

boolean

Implementation of​

ICustomObject . shouldPickBoundingBox

Defined in​

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

useDepthTest​

get useDepthTest(): boolean

Beta

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

set useDepthTest(value): void

Beta

Parameters​

• value: boolean

Returns​

boolean

Implementation of​

ICustomObject . useDepthTest

Defined in​

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

Methods​

beforeRender()​

beforeRender(_camera): void

Beta

This method is called before rendering of the custom object

Parameters​

• _camera: PerspectiveCamera

Returns​

void

Implementation of​

ICustomObject . beforeRender

Defined in​

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

getBoundingBox()​

getBoundingBox(target): Box3

Beta

Get the bounding box from the object

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

Intersect the object with the raycaster. This function can be overridden to provide custom intersection logic.

Parameters​

• intersectInput: CustomObjectIntersectInput

• closestDistance: undefined | number

Returns​

undefined | CustomObjectIntersection

Implementation of​

ICustomObject . intersectIfCloser

Defined in​

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