API Docs

Class: Shading

PD. Shading

new Shading()

A class for managing and performing shading calculations.

Author:
  • drajmarsh

Members

:number

_totalShadingMaskCalcTime <static>

The total time taken for the previous five (5) detailed shading mask calculations.

Type
  • number
:Map

cachedSolarAnalysisElements <static>

Stores the last set of elements solar analysis was computed for.

Type
  • Map

Methods

computePointShading(sunPath) <static>

Computes the sky patch shading for the given sun-path element.

Parameters:
Name Type Description
sunPath BIM.SunPath

The sun-path element to compute.
Returns:

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

Type
boolean

computeVisibleSky(gridElem) <static>

Computes the percentage visible sky 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 was updated.

Type
boolean