OptionaldisplayName: stringProtectedconnectedMetadata for the connections in connectedSpaces: what a connection is (a door, an
opening, a stairs link, ...) and how wide it is. The connection points themselves stay in
the connectedSpaces map.
Created timestamp
Object display name
ProtectedpositionOptionalslantObject identifier
Get the orientation of the object relative to the global reference space
Set the orientation of the object relative to the global reference space
Set the parent symbolic location
Get the current absolute position of the object relative to the global reference space
Absolute position of data object
Set the current absolute position of the object relative to the global reference space
Get relative positions
Array of relative positions
Get the transformation matrix for scaling
Transformation matrix
Add a connected space
The connection is recorded on both this space and, when it is called through
[[connectAdjacentSpaces]], on the other space as well. Use connection to describe what
the connection is; a connection without metadata is treated as adjacent.
Connected space
Optionalposition: Absolute2DPosition | Absolute3DPosition
Position of the connection
Optionalconnection: SpaceConnectionOptions = {}
Connection metadata (kind and width)
instance
Add a relative position to this data object
Relative position to add
Data object instance
ProtectedconnectionRestores a position from a vector stored in the connection map.
The stored connection vector
The position, of this space's boundary type
ProtectedextrudeFlatten local bounds to the ground plane and, when a ceiling height is given, extrude them to that height. Used by spaces that derive their volume from a 2D footprint (floors, cell spaces).
Local boundary positions
OptionalceilingHeight: number
Ceiling height in meters
The extruded bounds
Get the boundaries of the space
Array of boundary position
Get the connections of this space with their metadata and connection points.
Connections added through [[addConnectedSpace]] without metadata are returned as adjacent
connections; their position is restored from the boundary map.
The connections
Get the connection to a specific space.
The connected space
The connection, or undefined when the spaces are not connected
Get the current absolute position of the object
OptionalreferenceSpace: TransformationSpace
Reference space to transform it to
Position of the data object
Get relative position of a specified object
Reference object identifier
Optionaltype: string
Constructor type of the relative position
Relative position to reference object
Get relative positions for a different target
OptionalreferenceObjectUID: string
Reference object identifier
Array of relative positions for the reference object
Check if the space is connected to another
Space to check if connected
connected or not
Check if a position lies within a symbolic location
Absolute position to check
Point inside boundaries
Transform perspective
Farthest left on the x-axis
Farthest right on the x-axis
Farthest down on the y-axis
Farthest up on the y-axis
Distance to the near clipping plane along the -Z axis
Distance to the far clipping plane along the -Z axis
Reference space instance
OptionalkZ: numberProtectedsetSet the floor this cell space belongs to
Floor object
cell space instance
Set a parent object to the data object
Data object or UID to add as parent
instance
Set the current absolute position of the object
Position to set
OptionalreferenceSpace: TransformationSpace
Reference space
Data object instance
ProtectedsetSet the unique identifier of this object
Unique Identifier
Data object instance
Convert the symbolic space to GeoJSON
Optionalflat: boolean
Flat GeoJSON
GeoJSON
Convert the symbolic space to an absolute position
Absolute position
Convert the symbolic space to well-known text representation
WKT
OptionaldZ: numberUpdate parent reference spaces
Service to use for updating
Update promise
ProtectedupdateStaticfromCreate a reference space from another object
Reference space
StaticfromCreate a new symbolic space GeoJSON
GeoJSON
symbolic space instance
Staticfrom
A zone represents an abstract symbolic space on a floor.