Class ShadingScene

This class holds all information about the scene that is simulated. A ShadingScene is typically equipped with the following attributes:

A pair of coordinates to locate the scene
Simulation geometries, where the PV potential is calculated
Shading geometries, where no PV potential is calculated but which are responsible for shading

Index

Constructors

Properties

elevationRaster latitude longitude shadingGeometries simulationGeometries

Methods

addColorMap addElevationRaster addShadingGeometry addSimulationGeometry calculate

Constructors

constructor

new ShadingScene(latitude, longitude): ShadingScene
Parameters
- latitude: number
  Latitude of the midpoint of the scene.
- longitude: number
  Longitude of the midpoint of the scene.
Returns ShadingScene
- Defined in main.ts:36

Properties

elevationRaster

elevationRaster: CartesianPoint[]

latitude

latitude: number

longitude

longitude: number

shadingGeometries

shadingGeometries: BufferGeometry<NormalBufferAttributes>[]

simulationGeometries

simulationGeometries: BufferGeometry<NormalBufferAttributes>[]

Methods

addColorMap

addColorMap(colorMap): void
Change the Color Map that is used for the colors of the simulated Three.js mesh. This is optional, the default colorMap is viridis (blue to green to yellow)
Parameters
- colorMap: ColorMap
Returns void
- Defined in main.ts:96

addElevationRaster

addElevationRaster(raster, midpoint, azimuthDivisions): void
Add a elevation model to the simulation scene.
Parameters
- raster: CartesianPoint[]
  List of Points with x,y,z coordinates, representing a digital elevation model (DEM). It is important that all values of x,y and z are given with same units. If x and y are given in lat / lon and z is given in meters, this will result in wrong simulation Results.
- midpoint: CartesianPoint
  The point of the observer, ie the center of the building
- azimuthDivisions: number
  Number of divisions of the azimuth Angle, i.e. the list of the azimuth angle will be [0, ..., 2Pi] where the list has a lenght of azimuthDivisions
Returns void
- Defined in main.ts:85

addShadingGeometry

addShadingGeometry(geometry): void
Adds a geometry as an outer geometry for the shading simulation. These geometries are responsible for shading.
Parameters
- geometry: BufferGeometry<NormalBufferAttributes>
  Arbitrary Three.js geometry
Returns void
Memberof
Scene
- Defined in main.ts:72

addSimulationGeometry

addSimulationGeometry(geometry): void
Adds a geometry as a target for the shading simulation. For these geometries, the PV potential will be simulated. This geometry will also be used as a shading geometry, hence it is not needed to additionally add it by using addShadingGeometry.
Parameters
- geometry: BufferGeometry<NormalBufferAttributes>
  Arbitrary Three.js geometry
Returns void
Memberof
Scene
- Defined in main.ts:59

calculate

calculate(params?): Promise<Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>>
This function is called as a last step, after the scene is fully build. It runs the shading simulation and returns a THREE.js colored mesh. The colors are chosen from the viridis colormap.
Parameters
- params: CalculateParams = {}
Returns Promise<Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>>
A three.js colored mesh of the simulationGeometry.
- Defined in main.ts:139

Generated using TypeDoc