Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SiteModelEntityInterface

Site Model Entities are geometric boundaries that represent any kind of spatial sectioning.

These entities may represent a building, a floor, or even an open space. These entities can also be linked hierarchically via parent/children associations.

Hierarchy

  • SiteModelEntityInterface

Index

Properties

Readonly area

area: number

Calculates the floor 2-dimensional size of the Site Model Entity polygon [m²].

attributes

attributes: Dictionary<string>

Key-value pairs for storing additional user data associated to the Site Model Entity.

Readonly center

center: Vector3

The calculated center point of the Site Model Entity polygon.

children

Children Site Model Entities. A collection of sub-entities whose parent is the current entity.

Readonly height

height: number

The height between the lower and upper planes of the polygon on the Z-axis [m].

name

name: string

The display name name for the Site Model Entity.

parent

Parent Site Model Entity.

polygon

The geometric polygon structure.

type

Type for the Site Model Entity. This can be used to structure Site Model Entities.

Readonly volume

volume: number

Calculates the 3-dimensional size of the Site Model Entity polygon [m³].

zMax

zMax: number

The highest numeric value of the Z-coordinates of the entire Site Model Entity. This value is relative to the local coordinate origin.

zMin

zMin: number

The lowest numeric value of the Z-coordinates of the entire Site Model Entity. This value is relative to the local coordinate origin.

Generated using TypeDoc