Skip to main content

Class: ARPlacementBox

Extra-Helpers.ARPlacementBox

This class is a set of two coincident planes. The first is just a cute box outline with rounded corners and damped opacity to indicate the floor extents of a scene. It is purposely larger than the scene's bounding box by RADIUS on all sides so that small scenes are still visible / selectable. Its center is actually carved out by vertices to ensure its fragment shader doesn't add much time.

The child plane is a simple plane with the same extents for use in hit testing (translation is triggered when the touch hits the plane, rotation otherwise).

Hierarchy

  • Mesh<BufferGeometry, MeshBasicMaterial>

    ARPlacementBox

Properties

hitPlane

hitPlane: Mesh<BufferGeometry, MeshBasicMaterial>

Defined in

webgi/src/extras/webxr/arPlacementBox.ts:104


shadowHeight

shadowHeight: number

Defined in

webgi/src/extras/webxr/arPlacementBox.ts:105


boundingSize

Readonly boundingSize: Vector3

Defined in

webgi/src/extras/webxr/arPlacementBox.ts:106

Constructors

constructor

new ARPlacementBox(boundingBox, camera, placeOnWall?)

Parameters

NameTypeDefault value
boundingBoxBox3Bundefined
cameraCameraundefined
placeOnWallbooleanfalse

Overrides

Mesh<BufferGeometry, MeshBasicMaterial\>.constructor

Defined in

webgi/src/extras/webxr/arPlacementBox.ts:113

Methods

getHit

getHit(scene, screenX, screenY): null | Vector3

Get the world hit position if the touch coordinates hit the box, and null otherwise. Pass the scene in to get access to its raycaster.

Parameters

NameType
sceneObject3D<Event>
screenXnumber
screenYnumber

Returns

null | Vector3

Defined in

webgi/src/extras/webxr/arPlacementBox.ts:158


getExpandedHit

getExpandedHit(scene, screenX, screenY): null | Vector3

Parameters

NameType
sceneObject3D<Event>
screenXnumber
screenYnumber

Returns

null | Vector3

Defined in

webgi/src/extras/webxr/arPlacementBox.ts:166


updateOpacity

updateOpacity(delta): void

Call on each frame with the frame delta to fade the box.

Parameters

NameType
deltanumber

Returns

void

Defined in

webgi/src/extras/webxr/arPlacementBox.ts:211


dispose

dispose(): void

Call this to clean up Three's cache when you remove the box.

Returns

void

Defined in

webgi/src/extras/webxr/arPlacementBox.ts:220

Accessors

offsetHeight

get offsetHeight(): number

Offset the height of the box relative to the bottom of the scene. Positive is up, so generally only negative values are used.

Returns

number

Defined in

webgi/src/extras/webxr/arPlacementBox.ts:187

set offsetHeight(offset): void

Offset the height of the box relative to the bottom of the scene. Positive is up, so generally only negative values are used.

Parameters

NameType
offsetnumber

Returns

void

Defined in

webgi/src/extras/webxr/arPlacementBox.ts:178


show

get show(): boolean

Set the box's visibility; it will fade in and out.

Returns

boolean

Defined in

webgi/src/extras/webxr/arPlacementBox.ts:204

set show(visible): void

Set the box's visibility; it will fade in and out.

Parameters

NameType
visibleboolean

Returns

void

Defined in

webgi/src/extras/webxr/arPlacementBox.ts:198