API Docs

Class: Adjacency

BIM.Analysis. Adjacency

Defines an area of adjacency between two BIM elements, typically spaces.

Adjacencies are calculated by looking for areas of overlap between coplanar surfaces that face in opposite directions. Once calculated, they are used to determine areas of heat, air and sound flow between spaces in a building.

new Adjacency( [config])

Creates a new adjacency.

Parameters:
Name Type Argument Description
config object <optional>

An optional configuration object.
Properties of config:
Name Type Argument Description
surface1 BIM.Analysis.Surface <optional>

The first overlapping surface.
surface2 BIM.Analysis.Surface <optional>

The second overlapping surface.
adjacency BIM.Analysis.Adjacency <optional>

The corresponding adjacency in the opposite surface.
construction BIM.Construction <optional>

The construction materials of the surface.
polygons Array <optional>

An array of polygons defining the area(s) of adjacency.
area number <optional>

The total surface area of the adjacency, in m2.
Author:
  • drajmarsh

Members

:BIM.Analysis.Adjacency

adjacency

Stores the corresponding adjacency in the opposite surface.

Type
:number

area

Stores the total surface area of the adjacency, in m2.

Type
  • number
:BIM.Construction

construction

Stores the construction materials of the surface.

Type
:boolean

isAdjacency <readonly>

A flag identifying this object as an area of adjacency.

Type
  • boolean
:Array.<PD.Polygon>

polygons

Stores an array of polygons defining the area(s) of adjacency.

Type
:BIM.Analysis.Surface

surface1

Stores the first overlapping surface.

Type
:BIM.Analysis.Surface

surface2

Stores the second overlapping surface.

Type