Class SymbolicSpace<T>

A symbolic space can be used to indicate an abstract space with a boundary. It is an extended ReferenceSpace with boundaries.

About

A symbolic space is a ReferenceSpace, and is therefore not directly as a position. It indicates a symbolic space and provides several utilities. Both a hierarchical structure and graph connection can be used to connect symbolic spaces together.

Usage

Creation

Creating a symbolic space requires a generic position type. This type indicates how the symbolic position should be interpreted.

Optionally, the space can be initialized with a display name.

const lobby = new SymbolicSpace<Absolute2DPosition>("Main lobby");
const floor = new SymbolicSpace<Absolute2DPosition>("Floor 3");

Parent space

The parent space uses a wrapper for the ReferenceSpace.parentUID.

lobby.parent = floor;

In addition, the parent is also treated as the base reference space.

Creating boundaries

Boundaries can be set of a symbolic space. Both 2D and 3D polygons are supported.

// Triangle boundary
lobby.setBounds([
 new Absolute2DPosition(2, 2),
 new Absolute2DPosition(5, 5),
 new Absolute2DPosition(8, 8)
]);

Positioning of boundaries is always relative to the parent (i.e. if the floor shifts position, you do not have to change the lobby boundaries).

Boundary utilities

Symbolic spaces provide several boundary utilities.

Checking if a position is inside a symbolic space

lobby.isInside(new Absolute2DPosition(4, 4)); // true
lobby.isInside(new Absolute2DPosition(1, 1)); // false

Centroid

The centroid is determined using the boundaries, this will be the position that is used.

`AbsolutePosition` to `SymbolicSpace`

Converting an absolute position to a symbolic space does not provide a single result. Similar to geocoders, the results are sorted based on their probability.

For this, we make use of the [[SymbolicSpaceService]]. This service acts as the data store for symbolic spaces.

`SymbolicSpace` to `AbsolutePosition`

Converting a symbolic space to a position uses the centroid that is calculated from the boundaries.

const object = new DataObject("mvdewync", "Maxim");
const position = lobby.toPosition();

Type Parameters

T extends AbsolutePosition

Hierarchy (View Summary)

ReferenceSpace
- SymbolicSpace
  - Building
  - Floor
  - CellSpace

Constructors

constructor

new SymbolicSpace<T extends AbsolutePosition>(
displayName?: string,
): SymbolicSpace<T>
Type Parameters
- T extends AbsolutePosition
Parameters
- OptionaldisplayName: string
Returns SymbolicSpace<T>
Overrides ReferenceSpace.constructor
- Defined in src/data/SymbolicSpace.ts:122

Properties

centroid

centroid: AbsolutePosition

`Protected`connectedSpaces

connectedSpaces: Map<Vector3, string> = ...

coordinates

coordinates: Vector3[] = []

createdTimestamp

createdTimestamp: number

Created timestamp

displayName

displayName: string

Object display name

origin

origin: AbsolutePosition

parentUID

parentUID: string

`Protected`positionConstructor

positionConstructor: new () => T

priority

priority: number = 0

uid

uid: string

Object identifier

Returns

Unique object identifier

Accessors

angularVelocity

get angularVelocity(): AngularVelocity
Returns AngularVelocity
Inherited from ReferenceSpace.angularVelocity
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:58
set angularVelocity(velocity: AngularVelocity): void
Parameters
- velocity: AngularVelocity
Returns void
Inherited from ReferenceSpace.angularVelocity
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:59

boundaryType

get boundaryType(): new () => T
Get the boundary type

Returns new () => T
Absolute position constructor
- Defined in src/data/SymbolicSpace.ts:131

linearVelocity

get linearVelocity(): LinearVelocity
Returns LinearVelocity
Inherited from ReferenceSpace.linearVelocity
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:56
set linearVelocity(velocity: LinearVelocity): void
Parameters
- velocity: LinearVelocity
Returns void
Inherited from ReferenceSpace.linearVelocity
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:57

orientation

get orientation(): Orientation
Get the orientation of the object relative to the global reference space

Returns Orientation
Inherited from ReferenceSpace.orientation
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:48
set orientation(orientation: Orientation): void
Set the orientation of the object relative to the global reference space
Parameters
- orientation: Orientation
Returns void
Inherited from ReferenceSpace.orientation
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:53

parent

get parent(): SymbolicSpace<any>
Set the parent space

Returns SymbolicSpace<any>
Overrides ReferenceSpace.parent
- Defined in src/data/SymbolicSpace.ts:278
set parent(loc: SymbolicSpace<any>): void
Set the parent symbolic location
Parameters
- loc: SymbolicSpace<any>
  Parent symbolic location
Returns void
Overrides ReferenceSpace.parent
- Defined in src/data/SymbolicSpace.ts:274

position

get position(): AbsolutePosition
Get the current absolute position of the object relative to the global reference space

Returns AbsolutePosition
Absolute position of data object
Inherited from ReferenceSpace.position
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:38
set position(position: AbsolutePosition): void
Set the current absolute position of the object relative to the global reference space
Parameters
- position: AbsolutePosition
Returns void
Inherited from ReferenceSpace.position
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:43

relativePositions

get relativePositions(): RelativePosition<any, Unit>[]
Get relative positions

Returns RelativePosition<any, Unit>[]
Array of relative positions
Inherited from ReferenceSpace.relativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:83
set relativePositions(relativePostions: RelativePosition<any, Unit>[]): void
Parameters
- relativePostions: RelativePosition<any, Unit>[]
Returns void
Inherited from ReferenceSpace.relativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:84

rotationQuaternion

get rotationQuaternion(): Quaternion
Returns Quaternion
Inherited from ReferenceSpace.rotationQuaternion
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:93
set rotationQuaternion(quaternion: Quaternion): void
Parameters
- quaternion: Quaternion
Returns void
Inherited from ReferenceSpace.rotationQuaternion
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:94

scaleMatrix

get scaleMatrix(): Matrix4
Get the transformation matrix for scaling

Returns Matrix4
Transformation matrix
Inherited from ReferenceSpace.scaleMatrix
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:91
set scaleMatrix(matrix: Matrix4): void
Parameters
- matrix: Matrix4
Returns void
Inherited from ReferenceSpace.scaleMatrix
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:92

transformationMatrix

get transformationMatrix(): Matrix4
Returns Matrix4
Inherited from ReferenceSpace.transformationMatrix
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:85
set transformationMatrix(matrix: Matrix4): void
Parameters
- matrix: Matrix4
Returns void
Inherited from ReferenceSpace.transformationMatrix
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:86

translationMatrix

get translationMatrix(): Matrix4
Returns Matrix4
Inherited from ReferenceSpace.translationMatrix
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:95
set translationMatrix(matrix: Matrix4): void
Parameters
- matrix: Matrix4
Returns void
Inherited from ReferenceSpace.translationMatrix
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:96

velocity

get velocity(): Velocity
Returns Velocity
Inherited from ReferenceSpace.velocity
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:54
set velocity(velocity: Velocity): void
Parameters
- velocity: Velocity
Returns void
Inherited from ReferenceSpace.velocity
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:55

Methods

addConnectedSpace

addConnectedSpace(space: SymbolicSpace<any>, position?: T): this
Add a connected space
Parameters
- space: SymbolicSpace<any>
  Connected space
- Optionalposition: T
  Position of connection
Returns this
instance
- Defined in src/data/SymbolicSpace.ts:357

addRelativePosition

addRelativePosition(relativePosition: RelativePosition<any>): this
Add a relative position to this data object
Parameters
- relativePosition: RelativePosition<any>
  Relative position to add
Returns this
Data object instance
Inherited from ReferenceSpace.addRelativePosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:97

bind

bind(
service: DataService<string, SymbolicSpace<T>>,
): DataObjectBinding<SymbolicSpace<T>>
Bind the data object to a service
Parameters
- service: DataService<string, SymbolicSpace<T>>
  Service to bind it to
Returns DataObjectBinding<SymbolicSpace<T>>
Data object binding with a service
Inherited from ReferenceSpace.bind
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:117

clone

clone<T extends SymbolicSpace<T>>(dataType?: Constructor<T>): T
Clone the data object
Type Parameters
- T extends SymbolicSpace<T>
Parameters
- OptionaldataType: Constructor<T>
  Data type to clone to
Returns T
Cloned data object
Inherited from ReferenceSpace.clone
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:123

getBounds

getBounds(): T[]
Get the boundaries of the space

Returns T[]
Array of boundary position
- Defined in src/data/SymbolicSpace.ts:252

getPosition

getPosition(referenceSpace?: TransformationSpace): AbsolutePosition
Get the current absolute position of the object
Parameters
- OptionalreferenceSpace: TransformationSpace
  Reference space to transform it to
Returns AbsolutePosition
Position of the data object
Inherited from ReferenceSpace.getPosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:65

getRelativePosition

getRelativePosition(
referenceObjectUID: string,
type?: string,
): RelativePosition<any>
Get relative position of a specified object
Parameters
- referenceObjectUID: string
  Reference object identifier
- Optionaltype: string
  Constructor type of the relative position
Returns RelativePosition<any>
Relative position to reference object
Inherited from ReferenceSpace.getRelativePosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:110

getRelativePositions

getRelativePositions(referenceObjectUID?: string): RelativePosition<any, Unit>[]
Get relative positions for a different target
Parameters
- OptionalreferenceObjectUID: string
  Reference object identifier
Returns RelativePosition<any, Unit>[]
Array of relative positions for the reference object
Inherited from ReferenceSpace.getRelativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:103

hasRelativePosition

hasRelativePosition(referenceObjectUID: string): boolean
Parameters
- referenceObjectUID: string
Returns boolean
Inherited from ReferenceSpace.hasRelativePosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:111

isConnected

isConnected(space: SymbolicSpace<any>): boolean
Check if the space is connected to another
Parameters
- space: SymbolicSpace<any>
  Space to check if connected
Returns boolean
connected or not
- Defined in src/data/SymbolicSpace.ts:347

isInside

isInside(position: AbsolutePosition): boolean
Check if a position lies within a symbolic location
Parameters
- position: AbsolutePosition
  Absolute position to check
Returns boolean
Point inside boundaries
- Defined in src/data/SymbolicSpace.ts:287

orthographic

orthographic(
    left: number,
    right: number,
    bottom: number,
    top: number,
    near: number,
    far: number,
): ReferenceSpace
Parameters
- left: number
- right: number
- bottom: number
- top: number
- near: number
- far: number
Returns ReferenceSpace
Inherited from ReferenceSpace.orthographic
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:45

perspective

perspective(
    left: number,
    right: number,
    bottom: number,
    top: number,
    near: number,
    far: number,
): ReferenceSpace
Transform perspective
Parameters
- left: number
  Farthest left on the x-axis
- right: number
  Farthest right on the x-axis
- bottom: number
  Farthest down on the y-axis
- top: number
  Farthest up on the y-axis
- near: number
  Distance to the near clipping plane along the -Z axis
- far: number
  Distance to the far clipping plane along the -Z axis
Returns ReferenceSpace
Reference space instance
Inherited from ReferenceSpace.perspective
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:56

referenceUnit

referenceUnit(unit: LengthUnit): ReferenceSpace
Parameters
- unit: LengthUnit
Returns ReferenceSpace
Inherited from ReferenceSpace.referenceUnit
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:58

removeRelativePositions

removeRelativePositions(referenceObjectUID: string): void
Parameters
- referenceObjectUID: string
Returns void
Inherited from ReferenceSpace.removeRelativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:91

reset

reset(): ReferenceSpace
Returns ReferenceSpace
Inherited from ReferenceSpace.reset
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:57

rotation

rotation(r: Quaternion): ReferenceSpace
Parameters
- r: Quaternion
Returns ReferenceSpace
Inherited from ReferenceSpace.rotation
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:61
rotation(r: Euler): ReferenceSpace
Parameters
- r: Euler
Returns ReferenceSpace
Inherited from ReferenceSpace.rotation
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:62
rotation(r: AxisAngle): ReferenceSpace
Parameters
- r: AxisAngle
Returns ReferenceSpace
Inherited from ReferenceSpace.rotation
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:63
rotation(
r: { pitch: number; roll: number; unit?: AngleUnit; yaw: number },
): ReferenceSpace
Parameters
- r: { pitch: number; roll: number; unit?: AngleUnit; yaw: number }
Returns ReferenceSpace
Inherited from ReferenceSpace.rotation
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:64
rotation(
    r: {
        order?: EulerOrder;
        unit?: AngleUnit;
        x: number;
        y: number;
        z: number;
    },
): ReferenceSpace
Parameters
- r: { order?: EulerOrder; unit?: AngleUnit; x: number; y: number; z: number }
Returns ReferenceSpace
Inherited from ReferenceSpace.rotation
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:70
rotation(r: number[]): ReferenceSpace
Parameters
- r: number[]
Returns ReferenceSpace
Inherited from ReferenceSpace.rotation
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:77

scale

scale(kX: number, kY: number, kZ?: number): ReferenceSpace
Parameters
- kX: number
- kY: number
- OptionalkZ: number
Returns ReferenceSpace
Inherited from ReferenceSpace.scale
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:60

`Protected`setArrayBounds

setArrayBounds(bounds: T[]): void
Parameters
- bounds: T[]
Returns void
- Defined in src/data/SymbolicSpace.ts:202

setBounds

setBounds(bounds: T[]): this
Parameters
- bounds: T[]
Returns this
- Defined in src/data/SymbolicSpace.ts:135
setBounds(bounds: RectangleCornerBoundary<T>): this
Parameters
- bounds: RectangleCornerBoundary<T>
Returns this
- Defined in src/data/SymbolicSpace.ts:136
setBounds(bounds: RectangleRotationBoundary<T>): this
Parameters
- bounds: RectangleRotationBoundary<T>
Returns this
- Defined in src/data/SymbolicSpace.ts:137

setParent

setParent(object: string | DataObject): this
Set a parent object to the data object
Parameters
- object: string | DataObject
  Data object or UID to add as parent
Returns this
instance
Inherited from ReferenceSpace.setParent
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:90

setPosition

setPosition(
position: AbsolutePosition,
referenceSpace?: TransformationSpace,
): this
Set the current absolute position of the object
Parameters
- position: AbsolutePosition
  Position to set
- OptionalreferenceSpace: TransformationSpace
  Reference space
Returns this
Data object instance
Inherited from ReferenceSpace.setPosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:72

`Protected`setRectangleBounds

setRectangleBounds(bounds: RectangleRotationBoundary<T>): void
Parameters
- bounds: RectangleRotationBoundary<T>
Returns void
- Defined in src/data/SymbolicSpace.ts:150
setRectangleBounds(bounds: RectangleCornerBoundary<T>): void
Parameters
- bounds: RectangleCornerBoundary<T>
Returns void
- Defined in src/data/SymbolicSpace.ts:151

setUID

setUID(uid: string): this
Set the unique identifier of this object
Parameters
- uid: string
  Unique Identifier
Returns this
Data object instance
Inherited from ReferenceSpace.setUID
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:78

toGeoJSON

toGeoJSON(flat?: boolean): any
Convert the symbolic space to GeoJSON
Parameters
- Optionalflat: boolean
  Flat GeoJSON
Returns any
GeoJSON
- Defined in src/data/SymbolicSpace.ts:445

toLocation

toLocation(): AbstractLocation
Returns AbstractLocation
- Defined in src/data/SymbolicSpace.ts:490

toPosition

toPosition(): T
Convert the symbolic space to an absolute position

Returns T
Absolute position
- Defined in src/data/SymbolicSpace.ts:366

toWKT

toWKT(): string
Convert the symbolic space to well-known text representation

Returns string
WKT
- Defined in src/data/SymbolicSpace.ts:486

transform

transform<In extends AbsolutePosition, Out extends AbsolutePosition = In>(
position: In,
options?: SpaceTransformationOptions,
): Out
Transform a position
Type Parameters
- In extends AbsolutePosition
- Out extends AbsolutePosition = In
Parameters
- position: In
  Position to transform
- Optionaloptions: SpaceTransformationOptions
  Transformation options
Returns Out
Transformed position
Inherited from ReferenceSpace.transform
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:84

translation

translation(dX: number, dY: number, dZ?: number): ReferenceSpace
Parameters
- dX: number
- dY: number
- OptionaldZ: number
Returns ReferenceSpace
Inherited from ReferenceSpace.translation
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:59

update

update(service: DataService<string, SymbolicSpace<T>>): Promise<void>
Update parent reference spaces
Parameters
- service: DataService<string, SymbolicSpace<T>>
  Service to use for updating
Returns Promise<void>
Update promise
Inherited from ReferenceSpace.update
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:44

`Protected`updateCentroid

updateCentroid(): void
Returns void
- Defined in src/data/SymbolicSpace.ts:260

`Static`fromDataObject

fromDataObject(object: DataObject): ReferenceSpace
Create a reference space from another object
Parameters
- object: DataObject
  Reference space
Returns ReferenceSpace
Inherited from ReferenceSpace.fromDataObject
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:28

`Static`fromGeoJSON

fromGeoJSON<T extends typeof SymbolicSpace>(json: any): InstanceType<T>
Create a new symbolic space GeoJSON
Type Parameters
- T extends typeof SymbolicSpace
Parameters
- json: any
  GeoJSON
Returns InstanceType<T>
symbolic space instance
- Defined in src/data/SymbolicSpace.ts:379

`Static`fromWKT

fromWKT<T extends typeof SymbolicSpace>(wktLiteral: string): InstanceType<T>
Type Parameters
- T extends typeof SymbolicSpace
Parameters
- wktLiteral: string
Returns InstanceType<T>
- Defined in src/data/SymbolicSpace.ts:432

Class SymbolicSpace<T>

About

Usage

Creation

Parent space

Creating boundaries

Boundary utilities

Checking if a position is inside a symbolic space

Centroid

AbsolutePosition to SymbolicSpace

SymbolicSpace to AbsolutePosition

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SymbolicSpace<T>

Properties

centroid

ProtectedconnectedSpaces

coordinates

createdTimestamp

displayName

origin

parentUID

ProtectedpositionConstructor

priority

uid

Returns

Accessors

angularVelocity

Returns AngularVelocity

Parameters

Returns void

boundaryType

Returns new () => T

linearVelocity

Returns LinearVelocity

Parameters

Returns void

orientation

Returns Orientation

Parameters

Returns void

parent

Returns SymbolicSpace<any>

Parameters

Returns void

position

Returns AbsolutePosition

Parameters

Returns void

relativePositions

Returns RelativePosition<any, Unit>[]

Parameters

Returns void

rotationQuaternion

Returns Quaternion

Parameters

Returns void

scaleMatrix

Returns Matrix4

Parameters

Returns void

transformationMatrix

Returns Matrix4

Parameters

Returns void

translationMatrix

Returns Matrix4

Parameters

Returns void

velocity

Returns Velocity

`AbsolutePosition` to `SymbolicSpace`

`SymbolicSpace` to `AbsolutePosition`

`Protected`connectedSpaces

`Protected`positionConstructor

`Protected`setArrayBounds