Class: DepthMesh
Defined in: src/depth/DepthMesh.ts:22
Extends
Constructors
Constructor
new DepthMesh(
depthOptions,width,height,depthTextures?):DepthMesh
Defined in: src/depth/DepthMesh.ts:56
Parameters
depthOptions
width
number
height
number
depthTextures?
Returns
DepthMesh
Overrides
Properties
downsampledGeometry?
optionaldownsampledGeometry:BufferGeometry<NormalBufferAttributes,BufferGeometryEventMap>
Defined in: src/depth/DepthMesh.ts:33
downsampledMesh?
optionaldownsampledMesh:Mesh<BufferGeometry<NormalBufferAttributes,BufferGeometryEventMap>,Material<MaterialEventMap> |Material<MaterialEventMap>[],Object3DEventMap>
Defined in: src/depth/DepthMesh.ts:34
isXRScript
isXRScript:
boolean=true
Defined in: src/core/Script.ts:100
Inherited from
xb?
optionalxb:XBObjectOptions
Defined in: src/interaction/InteractionTypes.ts:34
Inherited from
isDepthMesh
staticisDepthMesh:boolean=true
Defined in: src/depth/DepthMesh.ts:23
Accessors
depthTextureUniforms
Get Signature
get depthTextureUniforms(): {
uColor: {value:Color; };uDebug: {value:number; };uDepthTexture: {value:Texture<unknown,TextureEventMap> |null; };uDepthTextureArray: {value:Texture<unknown,TextureEventMap> |null; };uIsTextureArray: {value:number; };uLightDirection: {value:Vector3; };uMaxDepth: {value:number; };uMinDepth: {value:number; };uNormDepthBufferFromNormView: {value:Matrix4; };uOpacity: {value:number; };uRawValueToMeters: {value:number; };uResolution: {value:Vector2; };uUseDerivativeNormals: {value:boolean; };uUsingFloatDepth: {value:boolean; }; } |undefined
Defined in: src/depth/DepthMesh.ts:146
Returns
{ uColor: { value: Color; }; uDebug: { value: number; }; uDepthTexture: { value: Texture<unknown, TextureEventMap> | null; }; uDepthTextureArray: { value: Texture<unknown, TextureEventMap> | null; }; uIsTextureArray: { value: number; }; uLightDirection: { value: Vector3; }; uMaxDepth: { value: number; }; uMinDepth: { value: number; }; uNormDepthBufferFromNormView: { value: Matrix4; }; uOpacity: { value: number; }; uRawValueToMeters: { value: number; }; uResolution: { value: Vector2; }; uUseDerivativeNormals: { value: boolean; }; uUsingFloatDepth: { value: boolean; }; } | undefined
Methods
dispose()
dispose():
void
Defined in: src/core/Script.ts:270
Called when the script is removed from the scene. Opposite of init.
Returns
void
Inherited from
disposeResources()
disposeResources():
void
Defined in: src/depth/DepthMesh.ts:448
Called by Depth at terminal teardown, not on Script disconnection.
Returns
void
getColliderFromHandle()
getColliderFromHandle(
handle):RapierCollider|undefined
Defined in: src/depth/DepthMesh.ts:435
Parameters
handle
number
Returns
RapierCollider | undefined
init()
init(
_?):void|Promise<void>
Defined in: src/core/Script.ts:109
Initializes an instance with XR controllers, grips, hands, and default options. We allow all scripts to quickly access its user (e.g., user.isSelecting(), user.hands), world (e.g., physical depth mesh, lighting estimation, and recognized objects), and scene (the root of three.js's scene graph). If this returns a promise, we will wait for it.
Parameters
_?
object
Returns
void | Promise<void>
Inherited from
initPhysics()
initPhysics(
_physics):void|Promise<void>
Defined in: src/core/Script.ts:119
Enables depth-aware interactions with physics. See /samples/advanced/ballpit
Parameters
_physics
Returns
void | Promise<void>
Inherited from
initRapierPhysics()
initRapierPhysics(
rapier,blendedWorld):void
Defined in: src/depth/DepthMesh.ts:341
Parameters
rapier
blendedWorld
Returns
void
onHoverEnter()
onHoverEnter(
_event):void
Defined in: src/core/Script.ts:222
Called when a source starts hovering over this object.
Parameters
_event
The hover source, target, surface, and intersection.
Call event.stopPropagation() to stop bubbling to ancestor Scripts.
Returns
void
Inherited from
onHoverExit()
onHoverExit(
_event):void
Defined in: src/core/Script.ts:228
Called when a source stops hovering over this object.
Parameters
_event
The hover source, target, surface, and intersection.
Call event.stopPropagation() to stop bubbling to ancestor Scripts.
Returns
void
Inherited from
onHovering()
onHovering(
_event):void
Defined in: src/core/Script.ts:234
Called while a source hovers over this object.
Parameters
_event
The hover source, target, surface, and intersection.
Call event.stopPropagation() to stop bubbling to ancestor Scripts.
Returns
void
Inherited from
onKeyDown()
onKeyDown(
_event):void
Defined in: src/core/Script.ts:159
Called on keyboard keypress.
Parameters
_event
Event containing .code to read the keyboard key.
Returns
void
Inherited from
onKeyUp()
onKeyUp(
_event):void
Defined in: src/core/Script.ts:160
Parameters
_event
Returns
void
Inherited from
onLongSelect()
onLongSelect(
_event):void
Defined in: src/core/Script.ts:153
Called when an object selection reaches the long-select delay.
Parameters
_event
Returns
void
Inherited from
onObjectGrabbing()
onObjectGrabbing(
_event):void
Defined in: src/core/Script.ts:260
Called every frame a hand is grabbing this object.
Parameters
_event
Returns
void
Inherited from
onObjectGrabEnd()
onObjectGrabEnd(
_event):void
Defined in: src/core/Script.ts:265
Called when a hand stops grabbing this object. This ends built-in direct-touch manipulation without ending contact.
Parameters
_event
Returns
void
Inherited from
onObjectGrabStart()
onObjectGrabStart(
_event):void
Defined in: src/core/Script.ts:256
Called when a hand starts grabbing this object (touching + pinching). A grab starts built-in direct-touch manipulation when enabled.
Parameters
_event
Returns
void
Inherited from
onObjectLongSelect()
onObjectLongSelect(
_event):void
Defined in: src/core/Script.ts:210
Called once when a captured selection is held for the long-select delay. Manipulation captures do not emit this callback.
Parameters
_event
The controller and completed hold duration.
Call event.stopPropagation() to stop bubbling to ancestor Scripts.
Call event.stopGlobalPropagation() to suppress global selection callbacks
for the rest of this capture
Returns
void
Inherited from
onObjectManipulate()
onObjectManipulate(
_event):void
Defined in: src/core/Script.ts:216
Called for each phase of an automatic object manipulation. Call
event.stopPropagation() to stop bubbling. Calling preventDefault()
on a start event suppresses the automatic action.
Parameters
_event
Returns
void
Inherited from
onObjectSelectEnd()
onObjectSelectEnd(
_event):void
Defined in: src/core/Script.ts:201
Called when a source stops selecting the object this Script represents.
Parameters
_event
The completed state and end reason.
Call event.stopPropagation() to stop bubbling to ancestor Scripts.
Call event.stopGlobalPropagation() to suppress global selection callbacks
for the rest of this capture
Returns
void
Inherited from
onObjectSelectStart()
onObjectSelectStart(
_event):void
Defined in: src/core/Script.ts:193
Called when a source starts selecting the object this Script represents.
Parameters
_event
event.target is the logical object and
event.source.controller identifies the controller.
Call event.stopPropagation() to stop bubbling to ancestor Scripts.
Call event.stopGlobalPropagation() to suppress global selection callbacks
for the rest of this capture
Returns
void
Inherited from
MeshScript.onObjectSelectStart
onObjectTouchEnd()
onObjectTouchEnd(
_event):void
Defined in: src/core/Script.ts:251
Called when a hand's index finger stops touching this object. This ends the default selection lifecycle after the touch callback.
Parameters
_event
Returns
void
Inherited from
onObjectTouching()
onObjectTouching(
_event):void
Defined in: src/core/Script.ts:246
Called every frame that a hand's index finger is touching this object. The object remains selected during these frames unless touch selection was prevented when contact started.
Parameters
_event
Returns
void
Inherited from
onObjectTouchStart()
onObjectTouchStart(
_event):void
Defined in: src/core/Script.ts:240
Called when a hand's index finger starts touching this object.
Direct touch starts the object's selection lifecycle by default. Call
event.preventDefault() to handle contact without selecting.
Parameters
_event
Returns
void
Inherited from
onSelect()
onSelect(
_event):void
Defined in: src/core/Script.ts:145
Called whenever pinch / mouse click successfully completes, globally.
Parameters
_event
The interaction source and completed target.
Returns
void
Inherited from
onSelectEnd()
onSelectEnd(
_event):void
Defined in: src/core/Script.ts:139
Called whenever pinch / mouse click discontinues, globally.
Parameters
_event
The completed state and end reason.
Returns
void
Inherited from
onSelecting()
onSelecting(
_event):void
Defined in: src/core/Script.ts:150
Called whenever pinch / mouse click is happening, globally.
Parameters
_event
Returns
void
Inherited from
onSelectStart()
onSelectStart(
_event):void
Defined in: src/core/Script.ts:133
Called whenever pinch / mouse click starts, globally.
Parameters
_event
The interaction source and optional captured target.
Returns
void
Inherited from
onSimulatorStarted()
onSimulatorStarted():
void
Defined in: src/core/Script.ts:125
Returns
void
Inherited from
onSqueeze()
onSqueeze(
_event):void
Defined in: src/core/Script.ts:182
Called whenever gamepad trigger successfully completes, globally.
Parameters
_event
event.source.controller identifies the controller.
Returns
void
Inherited from
onSqueezeEnd()
onSqueezeEnd(
_event):void
Defined in: src/core/Script.ts:171
Called whenever gamepad trigger stops, globally.
Parameters
_event
event.source.controller identifies the controller.
Returns
void
Inherited from
onSqueezeStart()
onSqueezeStart(
_event):void
Defined in: src/core/Script.ts:166
Called whenever gamepad trigger starts, globally.
Parameters
_event
event.source.controller identifies the controller.
Returns
void
Inherited from
onSqueezing()
onSqueezing(
_event):void
Defined in: src/core/Script.ts:176
Called whenever gamepad is being triggered, globally.
Parameters
_event
Returns
void
Inherited from
onXRSessionEnded()
onXRSessionEnded():
void
Defined in: src/core/Script.ts:123
Returns
void
Inherited from
onXRSessionStarted()
onXRSessionStarted(
_session?):void
Defined in: src/core/Script.ts:122
Parameters
_session?
Returns
void
Inherited from
physicsStep()
physicsStep():
void
Defined in: src/core/Script.ts:120
Returns
void
Inherited from
raycast()
raycast(
raycaster,intersects):boolean
Defined in: src/depth/DepthMesh.ts:380
Customizes raycasting to compute normals for intersections. Uses a 2D projective grid walk over the depth heightfield when depth data is available, avoiding brute-force tests across all grid triangles.
Parameters
raycaster
The raycaster object.
intersects
Intersection<Object3D<Object3DEventMap>>[]
Array to store intersections.
Returns
boolean
- True if intersections are found.
Overrides
MeshScript.raycast
setCustomMaterial()
setCustomMaterial(
material,onUpdate?):void
Defined in: src/depth/DepthMesh.ts:157
Sets a custom material (such as a WebGPU NodeMaterial) and registers a callback to synchronize uniforms on depth updates.
Parameters
material
The material to apply to the depth mesh.
onUpdate?
() => void
Optional callback invoked whenever depth uniforms change.
Returns
void
update()
update(
_time?,_frame?):void
Defined in: src/core/Script.ts:114
Runs per frame.
Parameters
_time?
number
_frame?
Returns
void
Inherited from
updateDepth()
updateDepth(
depthData,projectionMatrixInverse,depthDataFormat):void
Defined in: src/depth/DepthMesh.ts:179
Updates the depth data and geometry positions based on the provided camera and depth data.
Parameters
depthData
Readonly<XRCPUDepthInformation>
projectionMatrixInverse
depthDataFormat
XRDepthDataFormat
Returns
void
updateFullResolutionGeometry()
updateFullResolutionGeometry(
depthData,depthDataFormat):void
Defined in: src/depth/DepthMesh.ts:263
Method to manually update the full resolution geometry. Only needed if options.updateFullResolutionGeometry is false.
Parameters
depthData
depthDataFormat
XRDepthDataFormat
Returns
void
updatePose()
updatePose(
translation,quaternion):void
Defined in: src/depth/DepthMesh.ts:249
Parameters
translation
quaternion
Returns
void