A floor represents a symbolic space inside a building.

Hierarchy (view full)

Constructors

Properties

ceilingHeight: number
centroid: AbsolutePosition
connectedSpaces: Map<Vector3, string> = ...
coordinates: Vector3[] = []
createdTimestamp: number

Created timestamp

displayName: string

Object display name

floorLevel: number
groundHeight: number = undefined
origin: AbsolutePosition
parentUID: string
positionConstructor: (new () => Absolute3DPosition | Absolute2DPosition)

Type declaration

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

priority: number = 0
uid: string

Object identifier

Returns

Unique object identifier

Accessors

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

    Returns (new () => T)

    Absolute position constructor

      • new (): T
      • Returns T

  • 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

  • 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

  • get rotationQuaternion(): Quaternion
  • Returns Quaternion

  • set rotationQuaternion(quaternion): void
  • Parameters

    • quaternion: Quaternion

    Returns void

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

    Returns Matrix4

    Transformation matrix

  • set scaleMatrix(matrix): void
  • Parameters

    • matrix: Matrix4

    Returns void

  • get transformationMatrix(): Matrix4
  • Returns Matrix4

  • set transformationMatrix(matrix): void
  • Parameters

    • matrix: Matrix4

    Returns void

  • get translationMatrix(): Matrix4
  • Returns Matrix4

  • set translationMatrix(matrix): void
  • Parameters

    • matrix: Matrix4

    Returns void

Methods

  • Add a relative position to this data object

    Parameters

    • relativePosition: RelativePosition<any, Unit>

      Relative position to add

    Returns this

    Data object instance

  • Bind the data object to a service

    Parameters

    • service: DataService<string, Floor>

      Service to bind it to

    Returns DataObjectBinding<Floor>

    Data object binding with a service

  • Clone the data object

    Type Parameters

    Parameters

    • Optional dataType: Constructor<T>

      Data type to clone to

    Returns T

    Cloned data object

  • 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

  • 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

  • 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

  • Parameters

    • referenceObjectUID: string

    Returns boolean

  • Check if a position lies within a symbolic location

    Parameters

    • position: AbsolutePosition

      Absolute position to check

    Returns boolean

    Point inside boundaries

  • Parameters

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

    Returns 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

  • Parameters

    • unit: LengthUnit

    Returns ReferenceSpace

  • Parameters

    • referenceObjectUID: string

    Returns void

  • Returns 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

  • Parameters

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

    Returns ReferenceSpace

  • Set the building this floor belongs to

    Parameters

    Returns this

    instance

  • Set the ceiling height of the floor

    Parameters

    • height: number

      Ceiling height of the floor

    Returns this

    Floor instance

  • Set the floor number

    Parameters

    • floor: number

      Floor number

    • Optional floorHeight: number = 3

      Ceiling floor height (meters)

    Returns this

    Floor instance

  • Set the ground height of the floor

    Parameters

    • height: number

      Height of the floor

    Returns this

    Floor instance

  • Set the height of the floor

    Parameters

    • height: number

      Height of the floor

    Returns this

    Floor instance

    Deprecated

    Use setGroundHeight

  • Set a parent object to the data object

    Parameters

    • object: string | DataObject

      Data object or UID to add as parent

    Returns this

    instance

  • Set the current absolute position of the object

    Parameters

    • position: AbsolutePosition

      Position to set

    • Optional referenceSpace: TransformationSpace

      Reference space

    Returns this

    Data object instance

  • Set the unique identifier of this object

    Parameters

    • uid: string

      Unique Identifier

    Returns this

    Data object instance

  • 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

  • Parameters

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

    Returns ReferenceSpace

  • Update parent reference spaces

    Parameters

    • service: DataService<string, Floor>

      Service to use for updating

    Returns Promise<void>

    Update promise

  • Create a reference space from another object

    Parameters

    • object: DataObject

      Reference space

    Returns ReferenceSpace