Interface: ICustomObject
Defined in: packages/utilities/src/customObject/ICustomObject.ts:14
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.
Properties
receiveShadow?
readonlyoptionalreceiveShadow?:boolean
Defined in: packages/utilities/src/customObject/ICustomObject.ts:56
Beta
Whether CAD shadows fall on this object. Optional. When omitted, the object does not receive shadows.
Deprecated
No longer read. Request the shadow on the material instead with
CustomObjectEffectMaterial.setReceivesShadow.
Accessors
isPartOfBoundingBox
Get Signature
get isPartOfBoundingBox():
boolean
Defined in: packages/utilities/src/customObject/ICustomObject.ts:26
Beta
Get whether it should be part of the combined bounding box or not. Default is true.
Returns
boolean
object
Get Signature
get object():
Object3D
Defined in: packages/utilities/src/customObject/ICustomObject.ts:19
Beta
Get the Object3D
Returns
Object3D
shouldPick
Get Signature
get shouldPick():
boolean
Defined in: packages/utilities/src/customObject/ICustomObject.ts:33
Beta
Get whether it should be picked by the camera manager Default is false.
Returns
boolean
shouldPickBoundingBox
Get Signature
get shouldPickBoundingBox():
boolean
Defined in: packages/utilities/src/customObject/ICustomObject.ts:40
Beta
Set or get whether it should be also give the bounding box when picked by the camera Default is false.
Returns
boolean
useDepthTest
Get Signature
get useDepthTest():
boolean
Defined in: packages/utilities/src/customObject/ICustomObject.ts:47
Beta
Get whether it should be rendered with depth test (on top on other objects) Default is true.
Returns
boolean
Methods
beforeRender()
beforeRender(
camera):void
Defined in: packages/utilities/src/customObject/ICustomObject.ts:78
Beta
This method is called before rendering of the custom object
Parameters
camera
PerspectiveCamera
Returns
void
getBoundingBox()
getBoundingBox(
target):Box3
Defined in: packages/utilities/src/customObject/ICustomObject.ts:62
Beta
Get the bounding box from the object
Parameters
target
Box3
Returns
Box3
intersectIfCloser()
intersectIfCloser(
intersectInput,closestDistance):CustomObjectIntersection|undefined
Defined in: packages/utilities/src/customObject/ICustomObject.ts:69
Beta
Intersect the object with the raycaster. This function can be overridden to provide custom intersection logic.
Parameters
intersectInput
closestDistance
number | undefined
Returns
CustomObjectIntersection | undefined