Class CellSpace

A cell space is an OGC standard from the IndoorGML schema that identifies a space

Hierarchy

Constructors

constructor

Properties

boundaries centroid connectedSpaces coordinates createdTimestamp displayName parentUID positionConstructor priority slant uid

Accessors

boundaryType parent position relativePositions rotationQuaternion scaleMatrix transformationMatrix

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 toPosition toWKT transform translation update updateCentroid 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

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

parent

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

  • set position(position: AbsolutePosition): 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

    Array of relative positions

    Returns RelativePosition<any, Unit>[]

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

  • Parameters

    • relativePostions: RelativePosition<any, Unit>[]

    Returns void

rotationQuaternion

  • get rotationQuaternion(): Quaternion

  • Returns Quaternion

  • set rotationQuaternion(quaternion: Quaternion): void

  • Parameters

    • quaternion: Quaternion

    Returns void

scaleMatrix

  • get scaleMatrix(): Matrix4

  • Get the transformation matrix for scaling

    Returns

    Transformation matrix

    Returns Matrix4

  • set scaleMatrix(matrix: Matrix4): void

  • Parameters

    • matrix: Matrix4

    Returns void

transformationMatrix

  • get transformationMatrix(): Matrix4

  • Returns Matrix4

  • set transformationMatrix(matrix: Matrix4): void

  • Parameters

    • matrix: Matrix4

    Returns void

Methods

addConnectedSpace

addRelativePosition

  • Add a relative position to this data object

    Returns

    Data object instance

    Parameters

    • relativePosition: RelativePosition<any, Unit>

      Relative position to add

    Returns CellSpace

bind

  • Bind the data object to a service

    Returns

    Data object binding with a service

    Parameters

    • service: DataService<string, CellSpace>

      Service to bind it to

    Returns DataObjectBinding<CellSpace>

clone

  • Clone the data object

    Returns

    Cloned data object

    Returns CellSpace

getBounds

  • Get the boundaries of the space

    Returns

    Array of boundary position

    Returns (Absolute3DPosition | Absolute2DPosition)[]

getPosition

  • 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

getRelativePosition

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

getRelativePositions

  • 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>[]

hasRelativePosition

  • Parameters

    • referenceObjectUID: string

    Returns boolean

isConnected

isInside

  • Check if a position lies within a symbolic location

    Returns

    Point inside boundaries

    Parameters

    • position: AbsolutePosition

      Absolute position to check

    Returns boolean

orthographic

  • Parameters

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

    Returns ReferenceSpace

perspective

  • 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

referenceUnit

  • Parameters

    • unit: LengthUnit

    Returns ReferenceSpace

removeRelativePositions

  • Parameters

    • referenceObjectUID: string

    Returns void

reset

  • Returns ReferenceSpace

rotation

  • 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

  • Parameters

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

    Returns ReferenceSpace

Protected setArrayBounds

setBounds

setFloor

setParent

  • Set a parent object to the data object

    Returns

    instance

    Parameters

    • object: string | DataObject

      Data object or UID to add as parent

    Returns CellSpace

setPosition

  • Set the current absolute position of the object

    Returns

    Data object instance

    Parameters

    • position: AbsolutePosition

      Position to set

    • Optional referenceSpace: TransformationSpace

      Reference space

    Returns CellSpace

Protected setRectangleBounds

setUID

  • Set the unique identifier of this object

    Returns

    Data object instance

    Parameters

    • uid: string

      Unique Identifier

    Returns CellSpace

toGeoJSON

toPosition

toWKT

transform

  • 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

translation

  • Parameters

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

    Returns ReferenceSpace

update

  • Update parent reference spaces

    Returns

    Update promise

    Parameters

    • service: DataService<string, CellSpace>

      Service to use for updating

    Returns Promise<void>

Protected updateCentroid

Static fromGeoJSON

Static fromWKT

Settings

Member Visibility

Theme