Building Viewer Settings and Controls

Building Viewer — Settings and Controls

The Settings card and the Solar radiation panel of the 3D Building Viewer (/buildingmodel/buildingmodelbyid?id=<id>&countyid=<countyId> and /buildingmodel/itembyreference?reference=<reference>&x=<x>&y=<y>). Every control is viewer-side; none of them changes stored data.

Settings card

Control	Type	Effect
Show gizmo	checkbox	Shows or hides the orientation gizmo.
Show terrain	checkbox	Shows or hides the terrain. Disabled (greyed) when the view locks the terrain.
Show terminal	checkbox	Shows or hides the status terminal.
Show shade	checkbox	Turns shadows on or off. Locked (off) while solar results are shown with Flat result colours.
Scope Box	checkbox	Enables the scope box.
Scope Box visible	checkbox	Shows the scope box outline. Only available while Scope Box is checked.
Show surrounding elements	checkbox	Shows the neighbouring buildings around the target building.
Transparency	slider, 0–1, step 0.05	Opacity of the surrounding buildings (default 0.5). Only enabled while surroundings are shown.
Fog	slider, 0–1, step 0.01	Fog density.
View range	slider + number box (m)	Radius around the scene centre that is displayed. Bound to the scene radius; the number box is clamped to the slider bounds.

Surrounding elements

• Off at start. Nothing is requested until the box is first checked, so the main scene loads exactly as before.
• First check fetches /buildingmodel/glb/surroundingsbybuildingid?id=<id>&countyid=<countyId> (model/gltf-binary). The target building is not included, so it is never drawn twice. A radius above the display maximum is rejected with HTTP 400.
• Later toggles only show or hide the loaded meshes; there is no refetch.
• Non-selectable. Surrounding buildings have no hover label and cannot be clicked, window-selected or crossing-selected; the Properties panel and the object count are unaffected.
• Transparency is applied as material opacity (1 = opaque, 0 = invisible) with transparent = true and depthWrite = false; the slider updates it live and the target building stays opaque.
• Failure. If the request fails or returns an empty response, the reason is written to the status terminal and the box is unchecked again.
• View range. A surrounding building lying partly or wholly beyond the View range is hidden as a whole, never cut through (restored in DiGi.GIS.WebAPI.UI 3a8f2c7 after the cc97233 revert had not reached the engine copy).

Solar radiation panel

The left panel's Solar radiation card calculates the annual solar radiation on the external walls and roofs of the building and shows it in the scene already loaded. It replaces the former Solar page (/solar, removed with DiGi.GIS.WebAPI.UI#66).

• Where. Both single-building pages. On itembyreference the card appears only when the building can be resolved to its identifier and county; the Multiple Buildings, Communication and Terrain viewers have none.
• Calculate is enabled once the scene is ready and disabled while a calculation runs. A loader covers the view and the status terminal counts the elapsed time; the scene stays loaded.
• Neighbour radius is the page's Radius [m]: empty means 100 m, and a value above 100 m (the solar maximum) is limited to 100 m, shown as 100 m (limited from 300 m).
• Background calculation. A building above the synchronous limits (HTTP 413), or a request made while another calculation holds the server (HTTP 503), is offered Calculate in background. Progress and Cancel calculation appear in the card; the job id is kept in the address (?job=), so a reload resumes it and applies the result when it completes. Every other refusal is reported in the card and the status terminal.
• Results in place. Each wall and roof takes its irradiation colour; clicking one shows its SurfaceSolarRadiationResult in Properties. Other components, terrain, surrounding buildings, the camera, the settings and the object count do not change.
• Flat result colours (in the Results card, checked on load) renders the model unlit, so a surface shows exactly its legend colour from every side, with shade off and edge lines kept; the Lighting card is locked meanwhile. Unchecking it brings the sun and shade back and keeps the colours.
• Results card (right panel, between Properties and Scene): a Solar radiation section with the colour ramp from 0 to 1 200 kWh/m², the neighbour radius, the weather station (a link to its EPW page) and the Flat result colours checkbox. Further analyses add their own sections to the same card.
• Clear restores the original colours, properties, lighting and shade, hides the results and removes ?job=.

Routes used: GET /solar/viewbybuildingmodelid?id=<id>&countyid=<countyId>&radius=<m> (JSON), POST /solar/jobs, GET /solar/jobs/{jobId}, GET /solar/jobs/{jobId}/view, DELETE /solar/jobs/{jobId}.

Related: DiGi.GIS.WebAPI.UI#66, DiGi.GIS.WebAPI.UI#65, DiGi.GIS.WebAPI.UI#68.