API Docs

Class: Analysis

BIM. Analysis

new Analysis()

The base class for performing analysis on a building information model.

Author:
  • drajmarsh

Classes

Adjacency
Model
Surface
SurfaceShell

Methods

clearCachedData() <static>

Clears any cached data from previous projects.

computeSensorCoverage(gridElem) <static>

Computes the sensor coverage for the given data grid.

Parameters:
Name Type Description
gridElem BIM.DataGrid

The data grid element to calculate over.
Returns:

Returns true if the calculation was successful and the element's data was updated.

Type
boolean

computeSpatialAdjacencies(building) <static>

Regenerates the simulation model from the given building.

This method first checks to reuse any existing simulation model of the given building, or creates a new one if necessary. It then calls the computeSpatialAdjacencies() method on the simulation model instance to (re)generate simulation surfaces for all spatial elements on all levels within the building/structure. It then iterates to compute areas of adjacency between each set of surfaces.

Parameters:
Name Type Description
building BIM.Structure

The building to create/update the simulation model for.
Returns:

Returns the simulation model that was created or updated.

Type
BIM.Analysis.Model

hasAnalysisModel(structure) <static>

Checks if the given building/structure has an analysis model currently computed.

Parameters:
Name Type Description
structure BIM.Structure

The building/structure to check.
Returns:

Returns true is an analysis model was found.

Type
boolean