Class Zone

A zone represents an abstract symbolic space on a floor.

Hierarchy (view full)

Constructors

constructor

Properties

boundaries centroid connectedSpaces coordinates createdTimestamp displayName origin parentUID positionConstructor priority slant? uid

Accessors

boundaryType parent position relativePositions rotationQuaternion scaleMatrix transformationMatrix translationMatrix

Methods

addConnectedSpace addRelativePosition bind clone getBounds getPosition getRelativePosition getRelativePositions hasRelativePosition isConnected isInside orthographic perspective referenceUnit removeRelativePositions reset rotation scale setArrayBounds setBounds setFloor setParent setPosition setRectangleBounds setUID toGeoJSON toLocation toPosition toWKT transform translation update updateCentroid fromDataObject fromGeoJSON fromWKT

Constructors

constructor

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

origin

origin: AbsolutePosition

parentUID

parentUID: string

Protected positionConstructor

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

Type declaration

    • new (): Absolute2DPosition | Absolute3DPosition

    • Returns Absolute2DPosition | Absolute3DPosition

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 (new () => T)

    Absolute position constructor

      • new (): T

      • Returns T

parent

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

  • set position(position): void

  • Set the current absolute position of the object relative to the global reference space

    Parameters

    • position: AbsolutePosition

    Returns void

relativePositions

  • get relativePositions(): RelativePosition<any, Unit>[]

  • Get relative positions

    Returns RelativePosition<any, Unit>[]

    Array of relative positions

  • set relativePositions(relativePostions): void

  • Parameters

    • relativePostions: RelativePosition<any, Unit>[]

    Returns void

rotationQuaternion

  • get rotationQuaternion(): Quaternion

  • Returns Quaternion

  • set rotationQuaternion(quaternion): void

  • Parameters

    • quaternion: Quaternion

    Returns void

scaleMatrix

  • get scaleMatrix(): Matrix4

  • Get the transformation matrix for scaling

    Returns Matrix4

    Transformation matrix

  • set scaleMatrix(matrix): void

  • Parameters

    • matrix: Matrix4

    Returns void

transformationMatrix

  • get transformationMatrix(): Matrix4

  • Returns Matrix4

  • set transformationMatrix(matrix): void

  • Parameters

    • matrix: Matrix4

    Returns void

translationMatrix

  • get translationMatrix(): Matrix4

  • Returns Matrix4

  • set translationMatrix(matrix): void

  • Parameters

    • matrix: Matrix4

    Returns void

Methods

addConnectedSpace

addRelativePosition

  • addRelativePosition(relativePosition): this

  • Add a relative position to this data object

    Parameters

    • relativePosition: RelativePosition<any, Unit>

      Relative position to add

    Returns this

    Data object instance

bind

  • bind(service): DataObjectBinding<Zone>

  • Bind the data object to a service

    Parameters

    • service: DataService<string, Zone>

      Service to bind it to

    Returns DataObjectBinding<Zone>

    Data object binding with a service

clone

  • clone<T>(dataType?): T

  • Clone the data object

    Type Parameters

    Parameters

    • Optional dataType: Constructor<T>

      Data type to clone to

    Returns T

    Cloned data object

getBounds

  • getBounds(): (Absolute2DPosition | Absolute3DPosition)[]

  • Get the boundaries of the space

    Returns (Absolute2DPosition | Absolute3DPosition)[]

    Array of boundary position

getPosition

  • getPosition(referenceSpace?): AbsolutePosition

  • Get the current absolute position of the object

    Parameters

    • Optional referenceSpace: TransformationSpace

      Reference space to transform it to

    Returns AbsolutePosition

    Position of the data object

getRelativePosition

  • getRelativePosition(referenceObjectUID, type?): RelativePosition<any, Unit>

  • Get relative position of a specified object

    Parameters

    • referenceObjectUID: string

      Reference object identifier

    • Optional type: string

      Constructor type of the relative position

    Returns RelativePosition<any, Unit>

    Relative position to reference object

getRelativePositions

  • getRelativePositions(referenceObjectUID?): RelativePosition<any, Unit>[]

  • Get relative positions for a different target

    Parameters

    • Optional referenceObjectUID: string

      Reference object identifier

    Returns RelativePosition<any, Unit>[]

    Array of relative positions for the reference object

hasRelativePosition

  • hasRelativePosition(referenceObjectUID): boolean

  • Parameters

    • referenceObjectUID: string

    Returns boolean

isConnected

isInside

  • isInside(position): boolean

  • Check if a position lies within a symbolic location

    Parameters

    • position: AbsolutePosition

      Absolute position to check

    Returns boolean

    Point inside boundaries

orthographic

  • orthographic(left, right, bottom, top, near, far): ReferenceSpace

  • Parameters

    • left: number
    • right: number
    • bottom: number
    • top: number
    • near: number
    • far: number

    Returns ReferenceSpace

perspective

  • perspective(left, right, bottom, top, near, far): 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

referenceUnit

  • referenceUnit(unit): ReferenceSpace

  • Parameters

    • unit: LengthUnit

    Returns ReferenceSpace

removeRelativePositions

  • removeRelativePositions(referenceObjectUID): void

  • Parameters

    • referenceObjectUID: string

    Returns void

reset

  • reset(): ReferenceSpace

  • Returns ReferenceSpace

rotation

  • rotation(r): ReferenceSpace

  • Parameters

    • r: Quaternion

    Returns ReferenceSpace

  • rotation(r): ReferenceSpace

  • Parameters

    • r: Euler

    Returns ReferenceSpace

  • rotation(r): ReferenceSpace

  • Parameters

    • r: AxisAngle

    Returns ReferenceSpace

  • rotation(r): ReferenceSpace

  • Parameters

    • r: {
          pitch: number;
          roll: number;
          unit?: AngleUnit;
          yaw: number;
      }
      • pitch: number
      • roll: number
      • Optional unit?: AngleUnit
      • yaw: number

    Returns ReferenceSpace

  • rotation(r): 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

  • rotation(r): ReferenceSpace

  • Parameters

    • r: number[]

    Returns ReferenceSpace

scale

  • scale(kX, kY, kZ?): ReferenceSpace

  • Parameters

    • kX: number
    • kY: number
    • Optional kZ: number

    Returns ReferenceSpace

Protected setArrayBounds

setBounds

setFloor

setParent

  • setParent(object): this

  • Set a parent object to the data object

    Parameters

    • object: string | DataObject

      Data object or UID to add as parent

    Returns this

    instance

setPosition

  • setPosition(position, referenceSpace?): this

  • Set the current absolute position of the object

    Parameters

    • position: AbsolutePosition

      Position to set

    • Optional referenceSpace: TransformationSpace

      Reference space

    Returns this

    Data object instance

Protected setRectangleBounds

setUID

  • setUID(uid): this

  • Set the unique identifier of this object

    Parameters

    • uid: string

      Unique Identifier

    Returns this

    Data object instance

toGeoJSON

toLocation

toPosition

  • toPosition(): Absolute2DPosition | Absolute3DPosition

  • Convert the symbolic space to an absolute position

    Returns Absolute2DPosition | Absolute3DPosition

    Absolute position

toWKT

transform

  • transform<In, Out>(position, options?): Out

  • Transform a position

    Type Parameters

    • In extends AbsolutePosition
    • Out extends AbsolutePosition = In

    Parameters

    • position: In

      Position to transform

    • Optional options: SpaceTransformationOptions

      Transformation options

    Returns Out

    Transformed position

translation

  • translation(dX, dY, dZ?): ReferenceSpace

  • Parameters

    • dX: number
    • dY: number
    • Optional dZ: number

    Returns ReferenceSpace

update

  • update(service): Promise<void>

  • Update parent reference spaces

    Parameters

    • service: DataService<string, Zone>

      Service to use for updating

    Returns Promise<void>

    Update promise

Protected updateCentroid

Static fromDataObject

  • fromDataObject(object): ReferenceSpace

  • Create a reference space from another object

    Parameters

    • object: DataObject

      Reference space

    Returns ReferenceSpace

Static fromGeoJSON

Static fromWKT

Settings

Member Visibility

Theme

On This Page

constructorboundariescentroidconnectedSpacescoordinatescreatedTimestampdisplayNameoriginparentUIDpositionConstructorpriorityslantuidboundaryTypeparentpositionrelativePositionsrotationQuaternionscaleMatrixtransformationMatrixtranslationMatrixaddConnectedSpaceaddRelativePositionbindclonegetBoundsgetPositiongetRelativePositiongetRelativePositionshasRelativePositionisConnectedisInsideorthographicperspectivereferenceUnitremoveRelativePositionsresetrotationscalesetArrayBoundssetBoundssetFloorsetParentsetPositionsetRectangleBoundssetUIDtoGeoJSONtoLocationtoPositiontoWKTtransformtranslationupdateupdateCentroidfromDataObjectfromGeoJSONfromWKT