Skip to main content

Interface: SimulatorPlane

Defined in: src/world/planes/SimulatorPlane.ts:5

Properties

area

area: number

Defined in: src/world/planes/SimulatorPlane.ts:13

Total surface area in square meters


label?

optional label: string

Defined in: src/world/planes/SimulatorPlane.ts:10

Optional semantic label for the plane (e.g., 'table', 'floor')


polygon

polygon: Vector2[]

Defined in: src/world/planes/SimulatorPlane.ts:28

The boundary points of the plane in Local Space (X, Z). Since +Y is normal, these points lie on the flat surface.


position

position: Vector3

Defined in: src/world/planes/SimulatorPlane.ts:18

The center point of the plane in World Space. This corresponds to the origin of the plane's local coordinate system.


quaternion

quaternion: Quaternion

Defined in: src/world/planes/SimulatorPlane.ts:23

Rotation of the plane in World Space. Applying this rotation to (0,1,0) yields the plane's normal.


type

type: SimulatorPlaneType

Defined in: src/world/planes/SimulatorPlane.ts:7

'horizontal' or 'vertical'