Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Zone

A zone represents an abstract symbolic space on a floor.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Zone(displayName?: string): Zone

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

    Absolute position constructor

      • new (): T

      • Returns T

parent

position

  • get position(): AbsolutePosition
  • set position(position: AbsolutePosition): void

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

    Returns AbsolutePosition

    Absolute position of data object

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

    Parameters

    • position: AbsolutePosition

    Returns void

    Absolute position of data object

relativePositions

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

  • Get relative positions

    Returns RelativePosition<any, Unit>[]

    Array of relative positions

  • Get relative positions

    Parameters

    • relativePostions: RelativePosition<any, Unit>[]

    Returns void

    Array of relative positions

rotationQuaternion

  • get rotationQuaternion(): Quaternion

  • Returns Quaternion

scaleMatrix

  • get scaleMatrix(): Matrix4

  • Get the transformation matrix for scaling

    Returns Matrix4

    Transformation matrix

transformationMatrix

  • get transformationMatrix(): Matrix4

  • Returns Matrix4

Methods

addConnectedSpace

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

addRelativePosition

  • addRelativePosition(relativePosition: RelativePosition<any, Unit>): Zone

  • Add a relative position to this data object

    Parameters

    • relativePosition: RelativePosition<any, Unit>

      Relative position to add

    Returns Zone

    Data object instance

bind

  • bind(service: DataService<string, Zone>): 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 the data object

    Returns Zone

    Cloned data object

getBounds

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

getPosition

  • getPosition(referenceSpace?: TransformationSpace): AbsolutePosition

  • Get the current absolute position of the object

    Parameters

    • Optional referenceSpace: TransformationSpace

    Returns AbsolutePosition

    Position of the data object

getRelativePosition

  • getRelativePosition(referenceObjectUID: string, type?: string): 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?: string): RelativePosition<any, Unit>[]

  • Get relative positions for a different target

    Parameters

    • Optional referenceObjectUID: string

    Returns RelativePosition<any, Unit>[]

    Array of relative positions for the reference object

hasRelativePosition

  • hasRelativePosition(referenceObjectUID: string): boolean

  • Parameters

    • referenceObjectUID: string

    Returns boolean

isConnected

isInside

  • isInside(position: AbsolutePosition): boolean

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

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

referenceUnit

  • referenceUnit(unit: LengthUnit): ReferenceSpace

  • Parameters

    • unit: LengthUnit

    Returns ReferenceSpace

removeRelativePositions

  • removeRelativePositions(referenceObjectUID: string): void

  • Parameters

    • referenceObjectUID: string

    Returns void

reset

  • reset(): ReferenceSpace

  • Returns ReferenceSpace

rotation

  • rotation(r: Quaternion): ReferenceSpace
  • rotation(r: Euler): ReferenceSpace
  • rotation(r: AxisAngle): ReferenceSpace
  • rotation(r: { pitch: number; roll: number; unit?: AngleUnit; yaw: number }): ReferenceSpace
  • rotation(r: { order?: EulerOrder; unit?: AngleUnit; x: number; y: number; z: number }): ReferenceSpace
  • rotation(r: number[]): ReferenceSpace

  • Parameters

    • r: Quaternion

    Returns ReferenceSpace

  • Parameters

    • r: Euler

    Returns ReferenceSpace

  • Parameters

    • r: AxisAngle

    Returns ReferenceSpace

  • Parameters

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

    Returns 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

  • Parameters

    • r: number[]

    Returns ReferenceSpace

scale

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

  • Parameters

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

    Returns ReferenceSpace

Protected setArrayBounds

  • setArrayBounds(localBounds: Absolute3DPosition[] | Absolute2DPosition[]): Zone

setBounds

setFloor

setParent

  • setParent(object: string | DataObject): Zone

  • Set a parent object to the data object

    Parameters

    • object: string | DataObject

      Data object or UID to add as parent

    Returns Zone

    instance

setPosition

  • setPosition(position: AbsolutePosition, referenceSpace?: TransformationSpace): Zone

  • Set the current absolute position of the object

    Parameters

    • position: AbsolutePosition

      Position to set

    • Optional referenceSpace: TransformationSpace

    Returns Zone

    Data object instance

Protected setRectangleBounds

setUID

  • setUID(uid: string): Zone

  • Set the unique identifier of this object

    Parameters

    • uid: string

      Unique Identifier

    Returns Zone

    Data object instance

toGeoJSON

  • toGeoJSON(): any

toPosition

  • toPosition(): Absolute3DPosition | Absolute2DPosition

toWKT

  • toWKT(): string

transform

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

  • Transform a position

    Type parameters

    • In: AbsolutePosition<In>

    • Out: AbsolutePosition<Out> = In

    Parameters

    • position: In

      Position to transform

    • Optional options: SpaceTransformationOptions

    Returns Out

    Transformed position

translation

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

  • Parameters

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

    Returns ReferenceSpace

update

  • update(service: DataService<string, Zone>): Promise<void>

  • Update parent reference spaces

    Parameters

    • service: DataService<string, Zone>

      Service to use for updating

    Returns Promise<void>

    Update promise

Protected updateCentroid

  • updateCentroid(): void

Static fromGeoJSON

  • fromGeoJSON<T>(json: any): InstanceType<T>

Static fromWKT

  • fromWKT<T>(wktLiteral: string): InstanceType<T>