enum SpatialComponent
Spatial entities are composed of components, where each component is a chunk of data or behavior the entity provides. This flag describes a set of components, and each component has a matching accessor on the entity. The top 4 bits of this flag are reserved for vendor and experimental components.
Enum Values
| Anchor | A pose the system actively keeps stable relative to the physical world. |
| Bounds2D | A center pose and XY size describing a 2D rectangle, such as the extents of a detected plane, or the shape of a marker. The pose faces out of the surface, so Forward (-Z) is the surface normal, matching how quads and text face in StereoKit. |
| Bounds3D | A center pose and XYZ size describing an oriented bounding volume. When the entity has a front, like a screen or table top, Forward (-Z) is the direction it faces. |
| Label | A semantic category for the entity, like floor or table, see SpatialLabel. |
| Marker | Marker information: the marker’s type, numeric id, and any decoded data. In C, the text and data pointers are only valid until the next frame, so copy them to keep them longer. |
| Mesh | A 3D triangle mesh representing the entity’s shape. |
| Mesh2D | A 2D triangle mesh of the entity’s surface, on the XY plane of its bounds2d pose. |
| None | No components. |
| Parent | A reference to a parent spatial entity this entity is attached to. |
| Persistence | A durable identity that allows the entity to be recognized across sessions and reboots. When Spatial.ComponentsFor lists this for a capability, the app can persist that capability’s entities. |
| PlaneAlignment | The general orientation category of a detected plane, see PlaneAlign. |
| Polygon | A 2D boundary polygon outlining the entity’s surface. In C, the vertex pointer from spatial_entity_get_polygon is only valid until the next frame, so copy it to keep it longer. |
Found an issue with these docs, or have some additional questions? Create an Issue on Github!