Class Zone

A zone represents an abstract symbolic space on a floor.

Hierarchy

CellSpace
- Zone
  - Corridor

Constructors

constructor

new Zone(displayName?: string): Zone
Parameters
- Optional displayName: string
Returns Zone
Inherited from CellSpace.constructor
- Defined in src/data/SymbolicSpace.ts:117

Properties

boundaries

boundaries: CellBoundary[] = []

centroid

centroid: AbsolutePosition

`Protected` connectedSpaces

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

coordinates

coordinates: Vector3[] = []

createdTimestamp

createdTimestamp: number

Created timestamp

displayName

displayName: string

Object display name

parentUID

parentUID: string

`Protected` positionConstructor

positionConstructor: (new () => Absolute3DPosition | Absolute2DPosition)

Type declaration

- new (): Absolute3DPosition | Absolute2DPosition
- Returns Absolute3DPosition | Absolute2DPosition

priority

priority: number = 0

`Optional` slant

slant?: Slant

uid

uid: string

Object identifier

Returns

Unique object identifier

Accessors

boundaryType

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

Returns
Absolute position constructor

Returns (new () => T)
- - new (): T
  - Returns T
Inherited from CellSpace.boundaryType
- Defined in src/data/SymbolicSpace.ts:127

parent

get parent(): Floor
Returns Floor
Inherited from CellSpace.parent
- Defined in src/data/gml/CellSpace.ts:39
set parent(floor: Floor): void
Set the parent symbolic location
Parameters
- floor: Floor
  
  Parent symbolic location
Returns void
Inherited from CellSpace.parent
- Defined in src/data/gml/CellSpace.ts:35

position

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

Returns
Absolute position of data object

Returns AbsolutePosition
Inherited from CellSpace.position
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:59
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 CellSpace.position
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:64

relativePositions

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

Returns
Array of relative positions

Returns RelativePosition<any, Unit>[]
Inherited from CellSpace.relativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:92
set relativePositions(relativePostions: RelativePosition<any, Unit>[]): void
Parameters
- relativePostions: RelativePosition<any, Unit>[]
Returns void
Inherited from CellSpace.relativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:93

rotationQuaternion

get rotationQuaternion(): Quaternion
Returns Quaternion
Inherited from CellSpace.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 CellSpace.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
Transformation matrix

Returns Matrix4
Inherited from CellSpace.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 CellSpace.scaleMatrix
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:92

transformationMatrix

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

Methods

addConnectedSpace

addConnectedSpace(space: SymbolicSpace<any>, position?: Absolute3DPosition | Absolute2DPosition): Zone
Add a connected space

Returns
instance
Parameters
- space: SymbolicSpace<any>
  
  Connected space
- Optional position: Absolute3DPosition | Absolute2DPosition
  
  Position of connection
Returns Zone
Inherited from CellSpace.addConnectedSpace
- Defined in src/data/SymbolicSpace.ts:308

addRelativePosition

addRelativePosition(relativePosition: RelativePosition<any, Unit>): Zone
Add a relative position to this data object

Returns
Data object instance
Parameters
- relativePosition: RelativePosition<any, Unit>
  
  Relative position to add
Returns Zone
Inherited from CellSpace.addRelativePosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:108

bind

bind(service: DataService<string, Zone>): DataObjectBinding<Zone>
Bind the data object to a service

Returns
Data object binding with a service
Parameters
- service: DataService<string, Zone>
  
  Service to bind it to
Returns DataObjectBinding<Zone>
Inherited from CellSpace.bind
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:131

clone

clone(): Zone
Clone the data object

Returns
Cloned data object

Returns Zone
Inherited from CellSpace.clone
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:137

getBounds

getBounds(): (Absolute3DPosition | Absolute2DPosition)[]
Get the boundaries of the space

Returns
Array of boundary position

Returns (Absolute3DPosition | Absolute2DPosition)[]
Inherited from CellSpace.getBounds
- Defined in src/data/SymbolicSpace.ts:231

getPosition

getPosition(referenceSpace?: TransformationSpace): AbsolutePosition
Get the current absolute position of the object

Returns
Position of the data object
Parameters
- Optional referenceSpace: TransformationSpace
  
  Reference space to transform it to
Returns AbsolutePosition
Inherited from CellSpace.getPosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:71

getRelativePosition

getRelativePosition(referenceObjectUID: string, type?: string): RelativePosition<any, Unit>
Get relative position of a specified object

Returns
Relative position to reference object
Parameters
- referenceObjectUID: string
  
  Reference object identifier
- Optional type: string
  
  Constructor type of the relative position
Returns RelativePosition<any, Unit>
Inherited from CellSpace.getRelativePosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:123

getRelativePositions

getRelativePositions(referenceObjectUID?: string): RelativePosition<any, Unit>[]
Get relative positions for a different target

Returns
Array of relative positions for the reference object
Parameters
- Optional referenceObjectUID: string
  
  Reference object identifier
Returns RelativePosition<any, Unit>[]
Inherited from CellSpace.getRelativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:115

hasRelativePosition

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

isConnected

isConnected(space: SymbolicSpace<any>): boolean
Check if the space is connected to another

Returns
connected or not
Parameters
- space: SymbolicSpace<any>
  
  Space to check if connected
Returns boolean
Inherited from CellSpace.isConnected
- Defined in src/data/SymbolicSpace.ts:297

isInside

isInside(position: AbsolutePosition): boolean
Check if a position lies within a symbolic location

Returns
Point inside boundaries
Parameters
- position: AbsolutePosition
  
  Absolute position to check
Returns boolean
Inherited from CellSpace.isInside
- Defined in src/data/SymbolicSpace.ts:265

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 CellSpace.orthographic
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:42

perspective

perspective(left: number, right: number, bottom: number, top: number, near: number, far: number): ReferenceSpace
Transform perspective

Returns
Reference space instance
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
Inherited from CellSpace.perspective
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:54

referenceUnit

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

removeRelativePositions

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

reset

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

rotation

rotation(r: Quaternion): ReferenceSpace
Parameters
- r: Quaternion
Returns ReferenceSpace
Inherited from CellSpace.rotation
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:59
rotation(r: Euler): ReferenceSpace
Parameters
- r: Euler
Returns ReferenceSpace
Inherited from CellSpace.rotation
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:60
rotation(r: AxisAngle): ReferenceSpace
Parameters
- r: AxisAngle
Returns ReferenceSpace
Inherited from CellSpace.rotation
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:61
rotation(r: { pitch: number; roll: number; unit?: AngleUnit; yaw: number }): ReferenceSpace
Parameters
- r: { pitch: number; roll: number; unit?: AngleUnit; yaw: number }
  - pitch: number
  - roll: number
  - Optional unit?: AngleUnit
  - yaw: number
Returns ReferenceSpace
Inherited from CellSpace.rotation
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:62
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 }
  - Optional order?: EulerOrder
  - Optional unit?: AngleUnit
  - x: number
  - y: number
  - z: number
Returns ReferenceSpace
Inherited from CellSpace.rotation
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:68
rotation(r: number[]): ReferenceSpace
Parameters
- r: number[]
Returns ReferenceSpace
Inherited from CellSpace.rotation
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:75

scale

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

`Protected` setArrayBounds

setArrayBounds(localBounds: Absolute2DPosition[] | Absolute3DPosition[]): Zone
Parameters
- localBounds: Absolute2DPosition[] | Absolute3DPosition[]
Returns Zone
Inherited from CellSpace.setArrayBounds
- Defined in src/data/gml/CellSpace.ts:43

setBounds

setBounds(bounds: (Absolute3DPosition | Absolute2DPosition)[]): Zone
Parameters
- bounds: (Absolute3DPosition | Absolute2DPosition)[]
Returns Zone
Inherited from CellSpace.setBounds
- Defined in src/data/SymbolicSpace.ts:131
setBounds(bounds: RectangleCornerBoundary<Absolute3DPosition | Absolute2DPosition>): Zone
Parameters
- bounds: RectangleCornerBoundary<Absolute3DPosition | Absolute2DPosition>
Returns Zone
Inherited from CellSpace.setBounds
- Defined in src/data/SymbolicSpace.ts:132
setBounds(bounds: RectangleRotationBoundary<Absolute3DPosition | Absolute2DPosition>): Zone
Parameters
- bounds: RectangleRotationBoundary<Absolute3DPosition | Absolute2DPosition>
Returns Zone
Inherited from CellSpace.setBounds
- Defined in src/data/SymbolicSpace.ts:133

setFloor

setFloor(floor: Floor): Zone
Set the floor this cell space belongs to

Returns
cell space instance
Parameters
- floor: Floor
  
  Floor object
Returns Zone
Inherited from CellSpace.setFloor
- Defined in src/data/gml/CellSpace.ts:29

setParent

setParent(object: string | DataObject): Zone
Set a parent object to the data object

Returns
instance
Parameters
- object: string | DataObject
  
  Data object or UID to add as parent
Returns Zone
Inherited from CellSpace.setParent
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:100

setPosition

setPosition(position: AbsolutePosition, referenceSpace?: TransformationSpace): Zone
Set the current absolute position of the object

Returns
Data object instance
Parameters
- position: AbsolutePosition
  
  Position to set
- Optional referenceSpace: TransformationSpace
  
  Reference space
Returns Zone
Inherited from CellSpace.setPosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:79

`Protected` setRectangleBounds

setRectangleBounds(bounds: RectangleRotationBoundary<Absolute3DPosition | Absolute2DPosition>): void
Parameters
- bounds: RectangleRotationBoundary<Absolute3DPosition | Absolute2DPosition>
Returns void
Inherited from CellSpace.setRectangleBounds
- Defined in src/data/SymbolicSpace.ts:146
setRectangleBounds(bounds: RectangleCornerBoundary<Absolute3DPosition | Absolute2DPosition>): void
Parameters
- bounds: RectangleCornerBoundary<Absolute3DPosition | Absolute2DPosition>
Returns void
Inherited from CellSpace.setRectangleBounds
- Defined in src/data/SymbolicSpace.ts:147

setUID

setUID(uid: string): Zone
Set the unique identifier of this object

Returns
Data object instance
Parameters
- uid: string
  
  Unique Identifier
Returns Zone
Inherited from CellSpace.setUID
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:86

toGeoJSON

toGeoJSON(): any
Convert the symbolic space to GeoJSON

Returns
GeoJSON

Returns any
Inherited from CellSpace.toGeoJSON
- Defined in src/data/SymbolicSpace.ts:366

toPosition

toPosition(): Absolute3DPosition | Absolute2DPosition
Convert the symbolic space to an absolute position

Returns
Absolute position

Returns Absolute3DPosition | Absolute2DPosition
Inherited from CellSpace.toPosition
- Defined in src/data/SymbolicSpace.ts:318

toWKT

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

Returns
WKT

Returns string
Inherited from CellSpace.toWKT
- Defined in src/data/SymbolicSpace.ts:395

transform

transform<In, Out>(position: In, options?: SpaceTransformationOptions): Out
Transform a position

Returns
Transformed position
Type Parameters
- In extends AbsolutePosition<In>
- Out extends AbsolutePosition<Out> = In
Parameters
- position: In
  
  Position to transform
- Optional options: SpaceTransformationOptions
  
  Transformation options
Returns Out
Inherited from CellSpace.transform
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:83

translation

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

update

update(service: DataService<string, Zone>): Promise<void>
Update parent reference spaces

Returns
Update promise
Parameters
- service: DataService<string, Zone>
  
  Service to use for updating
Returns Promise<void>
Inherited from CellSpace.update
- Defined in node_modules/@openhps/core/dist/types/data/object/space/ReferenceSpace.d.ts:41

`Protected` updateCentroid

updateCentroid(): void
Returns void
Inherited from CellSpace.updateCentroid
- Defined in src/data/SymbolicSpace.ts:239

`Static` fromGeoJSON

fromGeoJSON<T>(json: any): InstanceType<T>
Create a new symbolic space GeoJSON

Returns
symbolic space instance
Type Parameters
- T extends typeof SymbolicSpace
Parameters
- json: any
  
  GeoJSON
Returns InstanceType<T>
Inherited from CellSpace.fromGeoJSON
- Defined in src/data/SymbolicSpace.ts:332

`Static` fromWKT

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

Class Zone

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional displayName: string

Returns Zone

Properties

boundaries

centroid

Protected connectedSpaces

coordinates

createdTimestamp

displayName

parentUID

Protected positionConstructor

Type declaration

Returns Absolute3DPosition | Absolute2DPosition

priority

Optional slant

uid

Returns

Accessors

boundaryType

Returns

Returns (new () => T)

Returns T

parent

Returns Floor

Parameters

floor: Floor

Returns void

position

Returns

Returns AbsolutePosition

Parameters

position: AbsolutePosition

Returns void

relativePositions

Returns

Returns RelativePosition<any, Unit>[]

Parameters

relativePostions: RelativePosition<any, Unit>[]

Returns void

rotationQuaternion

Returns Quaternion

Parameters

quaternion: Quaternion

Returns void

scaleMatrix

Returns

Returns Matrix4

Parameters

matrix: Matrix4

Returns void

transformationMatrix

Returns Matrix4

Parameters

matrix: Matrix4

Returns void

Methods

addConnectedSpace

Returns

Parameters

space: SymbolicSpace<any>

Optional position: Absolute3DPosition | Absolute2DPosition

Returns Zone

addRelativePosition

Returns

Parameters

relativePosition: RelativePosition<any, Unit>

Returns Zone

bind

Returns

Parameters

`Optional` displayName: string

`Protected` connectedSpaces

`Protected` positionConstructor

`Optional` slant

`Optional` position: Absolute3DPosition | Absolute2DPosition

`Optional` referenceSpace: TransformationSpace

`Optional` type: string

`Optional` referenceObjectUID: string