Interface: ICustomObject
Beta
This interface encasulate a Object3D, and made it possible to add flags to it. It might be extended with more flags in the future.
Accessors
isPartOfBoundingBox
getisPartOfBoundingBox():boolean
Beta
Get whether it should be part of the combined bounding box or not. Default is true.
Returns
boolean
Defined in
packages/utilities/src/customObject/ICustomObject.ts:26
object
getobject():Object3D<Object3DEventMap>
Beta
Get the Object3D
Returns
Object3D<Object3DEventMap>
Defined in
packages/utilities/src/customObject/ICustomObject.ts:19
shouldPick
getshouldPick():boolean
Beta
Get whether it should be picked by the camera manager Default is false.
Returns
boolean
Defined in
packages/utilities/src/customObject/ICustomObject.ts:33
shouldPickBoundingBox
getshouldPickBoundingBox():boolean
Beta
Set or get whether it should be also give the bounding box when picked by the camera Default is false.
Returns
boolean
Defined in
packages/utilities/src/customObject/ICustomObject.ts:40
useDepthTest
getuseDepthTest():boolean
Beta
Get whether it should be rendered with depth test (on top on other objects) Default is true.
Returns
boolean
Defined in
packages/utilities/src/customObject/ICustomObject.ts:47
Methods
beforeRender()
beforeRender(
camera):void
Beta
This method is called before rendering of the custom object
Parameters
• camera: PerspectiveCamera
Returns
void
Defined in
packages/utilities/src/customObject/ICustomObject.ts:69
getBoundingBox()
getBoundingBox(
target):Box3
Beta
Get the bounding box from the object
Parameters
• target: Box3
Returns
Box3
Defined in
packages/utilities/src/customObject/ICustomObject.ts:53
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