Back to Aframe

real-world-meshing

docs/components/real-world-meshing.md

1.7.11.7 KB
Original Source

Set this component on the scene element to render meshes corresponding to 3D surfaces detected in user's environment: this includes planes and meshes corresponding to floor, ceiling, walls and other objects. Each plane or meshes comes with a label indicating the type of surface or object.

This component requires a browser with support for the WebXR Mesh Detection Module and the WebXR Plane Detection Module. The system / headset used might require additional scene setup by the use like setting up floor, walls, ceiling or labeling furniture in the space.

Example

html
<a-scene real-world-meshing></a-scene>

Properties

PropertyDescriptionDefault Value
filterLabelsList of labels corresponding to the surfaces that will be rendered. Can constrain rendering to certain surfaces like desks, walls, tables... All surfaces will be rendered if left empty.[]
meshesEnabledIf meshes will be rendered as returned by the WebXR Mesh Detection Module.true
meshMixinMixin applied to the entities corresponding to the detected meshes.''
planesEnabledIf planes will be rendered as returned by the WebXR Plane Detection Module.true
planeMixinMixin applied to the entities corresponding to the detected planes.''