Repository navigation
DiGi.GIS.WebAPI.UI.Controllers
Provides the pages and partial views of the administrative area feature.
The data itself is owned by the GIS Web API (gis/administrativeareal2D); this controller only reads it and renders it, so the query rules stay owned by that service and cannot drift here.
public class AdministrativeAreal2DController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → AdministrativeAreal2DController
Initializes a new instance of the AdministrativeAreal2DController class.
public AdministrativeAreal2DController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The System.Net.Http.IHttpClientFactory used to create HTTP clients.
AdministrativeAreal2DController.GetAdministrativeAreal2DReferencePathsByNameAsync(string, CancellationToken) Method
Searches for administrative area reference paths by name.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetAdministrativeAreal2DReferencePathsByNameAsync(string text, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));text System.String
The text to search for within the name column.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> representing the asynchronous operation, containing the result of the search.
AdministrativeAreal2DController.GetAdministrativeAreal2DReferencesByAdministrativeArealTypeAsync(Nullable<AdministrativeArealType>, Nullable<int>, Nullable<bool>, CancellationToken) Method
Retrieves administrative 2D area references based on the specified administrative areal type, parent identifier, and unique code filter.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetAdministrativeAreal2DReferencesByAdministrativeArealTypeAsync(System.Nullable<DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType> administrativeArealType, System.Nullable<int> parentId, System.Nullable<bool> uniqueCode, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));administrativeArealType System.Nullable<DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType>
The type of the administrative area.
parentId System.Nullable<System.Int32>
The optional identifier of the parent administrative area.
uniqueCode System.Nullable<System.Boolean>
An optional flag indicating whether to filter by unique code.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> representing the asynchronous operation result.
AdministrativeAreal2DController.GetAdministrativeAreal2DReferencesByCodeAsync(string, CancellationToken) Method
Retrieves administrative areal 2D references by the specified code asynchronously.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetAdministrativeAreal2DReferencesByCodeAsync(string code, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));code System.String
The code used to retrieve the administrative areal 2D references.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> representing the asynchronous operation result.
AdministrativeAreal2DController.GetAdministrativeAreal2DReferencesByIdAsync(int, CancellationToken) Method
Retrieves the administrative areal 2D references by their identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetAdministrativeAreal2DReferencesByIdAsync(int id, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));id System.Int32
The unique identifier of the administrative areal 2D reference.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult.
Retrieves an administrative areal 2D item by its specified code.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemByCodeAsync(string code, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));code System.String
The code of the item to retrieve.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult.
AdministrativeAreal2DController.GetItemsByAdministrativeArealTypeAsync(Nullable<AdministrativeArealType>, CancellationToken) Method
Retrieves items filtered by the specified administrative area type.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemsByAdministrativeArealTypeAsync(System.Nullable<DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType> administrativeArealType, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));administrativeArealType System.Nullable<DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType>
The administrative area type (e.g., country, voivodeship, county, municipality) to filter by.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> representing the asynchronous operation result containing the items or an error response.
AdministrativeAreal2DController.GetPolygonsByIdAsync(int, Nullable<double>, Nullable<int>, CancellationToken) Method
Retrieves the outlines of an administrative area, reduced for drawing as an overview map.
An area whose territory is disconnected is stored as one row per polygon part, so an area identified by a code is drawn from every row sharing that code. An area addressed directly (a municipality or a subdivision) is drawn from its own row alone.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetPolygonsByIdAsync(int id, System.Nullable<double> reductionFactor=null, System.Nullable<int> minCount=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));id System.Int32
The unique identifier of the administrative area.
reductionFactor System.Nullable<System.Double>
The optional reduction factor used to simplify the geometry of the retrieved polygons. When omitted, a factor matching the size of the area is applied.
minCount System.Nullable<System.Int32>
The optional fewest points a reduced outline may keep. When omitted, a count matching the size of the area is applied.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A Microsoft.AspNetCore.Mvc.IActionResult carrying one flat coordinate list per outline.
Gives the fewest points an outline of the given kind of area is allowed to keep.
private static int MinimumPointCount(DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType administrativeArealType);administrativeArealType DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType
The kind of administrative area.
System.Int32
The fewest points to keep.
Gives the reduction factor an outline of the given kind of area is simplified with.
private static double ReductionFactor(DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType administrativeArealType);administrativeArealType DiGi.GIS.PostgreSQL.Enums.AdministrativeArealType
The kind of administrative area.
System.Double
The reduction factor.
Starts the Administrative Areal 2D view.
public Microsoft.AspNetCore.Mvc.IActionResult Start();Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult result that renders the start view.
Provides the pages and partial views of the building feature.
The data itself is owned by the GIS Web API (gis/building2D); this controller only reads it and renders it.
public class Building2DController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → Building2DController
Initializes a new instance of the Building2DController class.
public Building2DController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The System.Net.Http.IHttpClientFactory used to create System.Net.Http.HttpClient instances.
Building2DController.CountyIdAsync(HttpClient, Nullable<double>, Nullable<double>, CancellationToken) Method
Asynchronously resolves which county a plan position falls in.
Used only as a fallback: the 3D viewer knows a building by its reference and its centroid, and the reference alone does not say which county partition holds it.
private static System.Threading.Tasks.Task<System.Nullable<int>> CountyIdAsync(System.Net.Http.HttpClient httpClient, System.Nullable<double> x, System.Nullable<double> y, System.Threading.CancellationToken cancellationToken);httpClient System.Net.Http.HttpClient
The HTTP client used for the requests.
x System.Nullable<System.Double>
The X coordinate, in PL-1992 (EPSG:2180) metres. This value can be null.
y System.Nullable<System.Double>
The Y coordinate, in PL-1992 (EPSG:2180) metres. This value can be null.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<System.Nullable<System.Int32>>
The identifier of the county, or null when it cannot be resolved.
Building2DController.GetBuilding2DReferencesByAdministrativeAreal2DIdAsync(int, CancellationToken) Method
Asynchronously retrieves building 2D references associated with the specified administrative areal 2D identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetBuilding2DReferencesByAdministrativeAreal2DIdAsync(int administrativeAreal2DId, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));administrativeAreal2DId System.Int32
The administrative areal 2D identifier to filter by.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> representing the asynchronous operation.
Building2DController.GetDetailsByReferenceAsync(string, Nullable<int>, Nullable<double>, Nullable<double>, CancellationToken) Method
Renders the standalone building details page for the specified building reference (used e.g. by the "Show" button of the 3D viewer "Details" panel).
The partial view _Building2DView cannot be rendered on its own: it depends on the scripts, styles and AJAX loading logic of the references master-detail layout. The building context is therefore injected into Building2DDetailsView, which renders only the details side and loads the partial through the same AJAX pipeline.
The building data is partitioned per county, so the by-reference lookup requires a county identifier. When it is not provided, it is resolved from the optional x/y point (e.g. the building centroid known to the 3D viewer).
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetDetailsByReferenceAsync(string? reference, System.Nullable<int> countyId=null, System.Nullable<double> x=null, System.Nullable<double> y=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));reference System.String
The unique reference string of the building.
countyId System.Nullable<System.Int32>
The optional unique identifier of the county associated with the building.
x System.Nullable<System.Double>
The optional X coordinate of a point inside the building used to resolve the county when countyId is not provided.
y System.Nullable<System.Double>
The optional Y coordinate of a point inside the building used to resolve the county when countyId is not provided.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> rendering the building details page.
Asynchronously retrieves a building 2D item by its unique identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemByIdAsync(long id, System.Nullable<int> countyId, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));id System.Int64
The unique identifier of the item to retrieve.
countyId System.Nullable<System.Int32>
The optional unique identifier of the county associated with the item.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation, containing the Microsoft.AspNetCore.Mvc.IActionResult result.
Building2DController.GetPolygonByIdAsync(long, Nullable<int>, Nullable<double>, Nullable<int>, CancellationToken) Method
Retrieves the outline of a building footprint, reduced for drawing.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetPolygonByIdAsync(long id, System.Nullable<int> countyId, System.Nullable<double> reductionFactor=null, System.Nullable<int> minCount=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));id System.Int64
The unique identifier of the building.
countyId System.Nullable<System.Int32>
The optional county identifier used to filter the request.
reductionFactor System.Nullable<System.Double>
The optional reduction factor for simplifying the polygon geometry.
minCount System.Nullable<System.Int32>
The optional fewest points the reduced outline may keep.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> carrying the outline as a space separated coordinate list.
Initializes and returns the start view for the 2D building interface.
public Microsoft.AspNetCore.Mvc.IActionResult Start();Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult result that renders the starting view.
Provides controller endpoints for accessing and managing building data, acting as an interface between the client and the underlying GIS building data services.
public class BuildingDataController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → BuildingDataController
Initializes a new instance of the BuildingDataController class.
public BuildingDataController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The System.Net.Http.IHttpClientFactory used to create and manage System.Net.Http.HttpClient instances for making API requests.
Asynchronously retrieves a building data table based on the specified reference and an optional county identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetTableByReferenceAsync(string reference, System.Nullable<int> countyId=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));reference System.String
The unique reference string used to look up the table.
countyId System.Nullable<System.Int32>
The optional ID of the county associated with the request.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult representing the HTTP response.
Provides controller endpoints for accessing analytical DiGi.Analytical.Building.Classes.BuildingModel data, acting as an interface between the client and the underlying GIS building data services.
public class BuildingModelController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → BuildingModelController
Initializes a new instance of the BuildingModelController class.
public BuildingModelController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The System.Net.Http.IHttpClientFactory used to create and manage System.Net.Http.HttpClient instances for making API requests.
BuildingModelController.AddTerrainAsync(List<GLTFNode>, HttpClient, Point2D, CancellationToken) Method
Adds the ground surface around the given point to the nodes of a scene.
The surface is optional: no stored elevation points, an undeployed or unreachable terrain service and a timeout all leave the scene exactly as it was, so a building scene never depends on terrain being there.
private static System.Threading.Tasks.Task AddTerrainAsync(System.Collections.Generic.List<DiGi.GLTF.Classes.GLTFNode> gLTFNodes, System.Net.Http.HttpClient httpClient, DiGi.Geometry.Planar.Classes.Point2D? center, System.Threading.CancellationToken cancellationToken);gLTFNodes System.Collections.Generic.List<DiGi.GLTF.Classes.GLTFNode>
The nodes of the scene being built.
httpClient System.Net.Http.HttpClient
The HTTP client used for the request.
center DiGi.Geometry.Planar.Classes.Point2D
The centre of the ground to show, in PL-1992 (EPSG:2180) metres. This value can be null.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task
A System.Threading.Tasks.Task representing the asynchronous operation.
Renders the 3D viewer page for a single building. The page itself carries no geometry; the viewer streams the binary glTF payload from the glb endpoint.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetBuildingModelByIdAsync(long id, System.Nullable<int> countyId, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));id System.Int64
The unique identifier of the building.
countyId System.Nullable<System.Int32>
The optional unique identifier of the county associated with the building.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
An Microsoft.AspNetCore.Mvc.IActionResult rendering the glTF scene view.
BuildingModelController.GetBuildingsGLBByRadiusAsync(double, double, double, CancellationToken) Method
Asynchronously retrieves all building models within the specified circular area from the PostgreSQL database via the GIS Web API, converts each DiGi.Analytical.Building.Classes.BuildingModel into a batched DiGi.GLTF.Classes.GLTFScene with buildings selectable as whole envelopes and streams it as a binary glTF (.glb) payload.
The search is purely spatial: the area may span multiple counties, so no county identifier is required.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetBuildingsGLBByRadiusAsync(double centerX, double centerY, double radius, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));centerX System.Double
The X coordinate of the center of the search circle.
centerY System.Double
The Y coordinate of the center of the search circle.
radius System.Double
The radius of the search circle in meters.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> holding the .glb file.
Asynchronously creates a DiGi.Analytical.Building.Classes.BuildingModel for the building with the specified unique identifier (see BuildingModelAsync(this HttpClient, long, Nullable<int>, double, double, CancellationToken)), converts each of its components (walls, floors and roofs) into a separate node of a batched DiGi.GLTF.Classes.GLTFScene (translated to a local origin) and streams it as a binary glTF (.glb) payload.
Each component carries its own identity in the scene object map, so the 3D viewer can hit-test and select individual components instead of the building as a whole.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetGLBBuildingModelByIdAsync(long id, System.Nullable<int> countyId, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));id System.Int64
The unique identifier of the building.
countyId System.Nullable<System.Int32>
The optional unique identifier of the county associated with the building.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> holding the .glb file.
Asynchronously loads a DiGi.Analytical.Building.Classes.BuildingModel from the GIS Web API by searching for the building at the specified coordinates, converts its components into separate selectable DiGi.GLTF.Classes.GLTFNode instances and renders the 3D viewer page.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemByReferenceAsync(string reference, double x, double y, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));reference System.String
The reference of the building model.
The X coordinate of the building centroid.
The Y coordinate of the building centroid.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> rendering the 3D glTF scene view or a not found response.
Renders the 3D viewer page for all buildings within the specified circular area. The page itself carries no geometry; the viewer streams the binary glTF payload from the glb endpoint.
The search is purely spatial: the area may span multiple counties, so no county identifier is required.
public Microsoft.AspNetCore.Mvc.IActionResult GetItemsByRadius(double centerX, double centerY, double radius);centerX System.Double
The X coordinate of the center of the search circle.
centerY System.Double
The Y coordinate of the center of the search circle.
radius System.Double
The radius of the search circle in meters.
Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult rendering the glTF scene view.
Handles the HTTP GET request to the root endpoint and returns the 3D viewer landing page.
public Microsoft.AspNetCore.Mvc.IActionResult Start();Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult representing the start view.
Provides the communication analysis feature: an input page for the analyzed circular area, the 3D scene view with the antenna toolbar and the calculation endpoint that fetches the analyzed area buildings and solves the radio propagation between the placed antennas in process.
public class CommunicationController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → CommunicationController
Initializes a new instance of the CommunicationController class.
public CommunicationController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The System.Net.Http.IHttpClientFactory used to create System.Net.Http.HttpClient instances.
Executes the communication calculation for the antennas placed in the 3D view.
The buildings of the analyzed area are fetched as DiGi.Analytical.Building.Classes.BuildingModel instances and converted to DiGi.Communication.Classes.ScatteringObject instances, packaged together with the antennas into a DiGi.Communication.Classes.GeometricalPropagationModel and solved in process (DiGi.Communication.Classes.ScatteringSolver + DiGi.Communication.Classes.AngularPowerDistributionSolver); nothing is persisted.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> CalculateAsync(DiGi.GIS.WebAPI.UI.Classes.CommunicationCalculationParameter? communicationCalculationParameter, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));communicationCalculationParameter CommunicationCalculationParameter
The analyzed circular area and the antennas placed by the user.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> holding the DiGi.Communication.WebAPI.Classes.GeometricalPropagationResult JSON grouped by delay (ascending): the propagation ellipsoids, the scattering polylines (one per DiGi.Communication.Classes.ScatteringPointGroup) and the angular power distribution vectors, all in world coordinates.
Renders the communication 3D scene view for all buildings within the specified circular area (streamed as a binary glTF payload from the existing glb endpoint) together with the antenna toolbar.
public Microsoft.AspNetCore.Mvc.IActionResult GetBuildingsByRadius(double centerX, double centerY, double radius);centerX System.Double
The X coordinate of the center of the analyzed circular area.
centerY System.Double
The Y coordinate of the center of the analyzed circular area.
radius System.Double
The radius of the analyzed circular area in meters.
Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult rendering the communication scene view.
Initializes and returns the start view of the communication analysis feature.
public Microsoft.AspNetCore.Mvc.IActionResult Start();Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult result that renders the starting view.
Provides controller endpoints for accessing and managing EPW file data.
public class EPWFileController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → EPWFileController
Initializes a new instance of the EPWFileController class.
public EPWFileController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The HTTP client factory.
Asynchronously retrieves an EPW file based on the specified coordinates.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetEPWFileAsync(double x, double y, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));The X coordinate, in PL-1992 (EPSG:2180) metres.
The Y coordinate, in PL-1992 (EPSG:2180) metres.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult representing the HTTP response.
Controller responsible for handling requests related to heat transfer coefficients, providing data based on year or building reference.
public class HeatTransferCoefficientController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → HeatTransferCoefficientController
Initializes a new instance of the HeatTransferCoefficientController class.
public HeatTransferCoefficientController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The HTTP client factory used to create clients for external API communication.
HeatTransferCoefficientController.GetRegulatedHeatTransferCoefficientsByReferenceAsync(string, Nullable<int>, CancellationToken) Method
Retrieves regulated heat transfer coefficients for a building identified by its reference, determining the applicable year based on the building's construction data.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetRegulatedHeatTransferCoefficientsByReferenceAsync(string reference, System.Nullable<int> countyId, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));reference System.String
The unique reference string of the building.
countyId System.Nullable<System.Int32>
The optional identifier for the county associated with the building.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
An Microsoft.AspNetCore.Mvc.IActionResult containing a partial view with the coefficient data, or an error result if the request fails.
Provides the controller logic for handling requests to the home page of the GIS WebAPI user interface.
public class HomeController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → HomeController
Initializes a new instance of the HomeController class.
The landing pages carry no data of their own, so nothing is injected here.
public HomeController();Returns the view for the About page.
public Microsoft.AspNetCore.Mvc.IActionResult About();Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult result.
Returns the view for the Start page.
public Microsoft.AspNetCore.Mvc.IActionResult Start();Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult result.
Controller responsible for handling requests related to occupancy data for 2D buildings.
public class OccupancyDataController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → OccupancyDataController
Initializes a new instance of the OccupancyDataController class.
public OccupancyDataController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The HTTP client factory used to create clients for external API communication.
OccupancyDataController.GetBuilding2DItemByReferenceAsync(string, Nullable<int>, CancellationToken) Method
Retrieves the occupancy data and building reference for a specific 2D building item by its reference.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetBuilding2DItemByReferenceAsync(string reference, System.Nullable<int> countyId, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));reference System.String
The unique reference string of the building.
countyId System.Nullable<System.Int32>
The optional ID of the county associated with the building.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult, which returns a partial view containing the occupancy data if successful; otherwise, a bad request or no content response.
Controller providing endpoints for managing and retrieving orthodata and coverage factor information.
public class OrtoDatasController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → OrtoDatasController
Initializes a new instance of the OrtoDatasController class.
public OrtoDatasController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The HTTP client factory used to create System.Net.Http.HttpClient instances.
Retrieves the estimated orthophoto coverage factor of a single administrative area.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetEstimatedCoverageFactorAsync(int administrativeAreal2DId, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));administrativeAreal2DId System.Int32
The unique identifier of the administrative area.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult with the coverage factor or error status.
Retrieves the estimated orthophoto coverage factors of several administrative areas at once.
The values come back in the order the identifiers were given, which is what lets the page update one progress bar per row without matching anything up.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetEstimatedCoverageFactorsAsync(System.Collections.Generic.IEnumerable<int> administrativeAreal2DIds, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));administrativeAreal2DIds System.Collections.Generic.IEnumerable<System.Int32>
The unique identifiers of the administrative areas.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult with the list of coverage factor values or error status.
Retrieves orthodata and building 2D reference information based on a provided reference and optional county ID.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemByReferenceAsync(string reference, System.Nullable<int> countyId, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));reference System.String
The unique reference string for the item.
countyId System.Nullable<System.Int32>
The optional identifier for the county.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation. The task result contains an Microsoft.AspNetCore.Mvc.IActionResult representing the partial view or error response.
[TEMPORARY] Solar calculations for the 3D viewer Lighting panel, hosted locally until a DiGi.Solar backed endpoint is available on the central GIS Web API. The route contract (solar/sundirection) is final - when the central endpoint exists this controller becomes a proxy like the other controllers in this project, and the consuming frontend (gltf-viewer.js) stays unchanged.
public class SolarController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → SolarController
Calculates the sun position for a world location and a local date and time.
public Microsoft.AspNetCore.Mvc.IActionResult GetSunDirection(double x, double y, string? date, double hour);The X coordinate in the EPSG:2180 coordinate system [m].
The Y coordinate in the EPSG:2180 coordinate system [m].
date System.String
The local calendar date in the yyyy-MM-dd format.
hour System.Double
The local time of day as a decimal hour in the 0-24 range.
Microsoft.AspNetCore.Mvc.IActionResult
JSON with the true solar angles: azimuth [deg] (0 = north, clockwise) and altitude [deg] above the horizon (negative at night).
Provides the terrain feature: the ground surface of an area as a DiGi.Geometry.Spatial.Classes.Mesh3D, as a binary glTF payload and as a 3D viewer page.
The surface itself is reconstructed by the GIS Web API terrain endpoints (gis/terrain) from the elevation points stored per county; this controller only relays them, so the query limits (maximum radius, mesh edge length, tolerance defaults) stay owned by that service and cannot drift here.
Every surface returned here is a two-and-a-half dimensional height field: exactly one elevation per plan position. It models ground, and cannot express a vertical face, an overhang or a canopy.
public class TerrainController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → TerrainController
Initializes a new instance of the TerrainController class.
public TerrainController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The System.Net.Http.IHttpClientFactory used to create System.Net.Http.HttpClient instances.
Builds the name of a rectangular terrain area, used as the scene name and as the viewer page title.
private static string BoundingBoxName(double x_1, double y_1, double x_2, double y_2);x_1 System.Double
The X coordinate of the first corner, in PL-1992 (EPSG:2180) metres.
y_1 System.Double
The Y coordinate of the first corner, in PL-1992 (EPSG:2180) metres.
x_2 System.Double
The X coordinate of the second corner, in PL-1992 (EPSG:2180) metres.
y_2 System.Double
The Y coordinate of the second corner, in PL-1992 (EPSG:2180) metres.
System.String
The name of the area.
Builds the circular area a request asked for, resolving the radius from either the radius or the diameter.
An area that cannot be served (a coordinate or a radius that is not a usable number) is built all the same and rejected afterwards by TerrainRequestUri(this Circle2D, Nullable<double>), so what a terrain request may ask for is decided in one place.
private static DiGi.Geometry.Planar.Classes.Circle2D Circle2D(double x, double y, System.Nullable<double> radius, System.Nullable<double> diameter);The X coordinate of the centre, in PL-1992 (EPSG:2180) metres.
The Y coordinate of the centre, in PL-1992 (EPSG:2180) metres.
radius System.Nullable<System.Double>
The search radius in metres. Optional when diameter is supplied.
diameter System.Nullable<System.Double>
The search diameter in metres, used only when radius is absent.
DiGi.Geometry.Planar.Classes.Circle2D
The requested area.
Builds the name of a circular terrain area, used as the scene name and as the viewer page title.
private static string CircleName(double x, double y, System.Nullable<double> radius, System.Nullable<double> diameter);The X coordinate of the centre, in PL-1992 (EPSG:2180) metres.
The Y coordinate of the centre, in PL-1992 (EPSG:2180) metres.
radius System.Nullable<System.Double>
The search radius in metres. Optional when diameter is supplied.
diameter System.Nullable<System.Double>
The search diameter in metres, used only when radius is absent.
System.String
The name of the area.
TerrainController.GetGLBMesh3DByBoundingBoxAsync(double, double, double, double, Nullable<double>, CancellationToken) Method
Asynchronously retrieves the terrain surface inside an axis aligned bounding box and streams it as a binary glTF (.glb) payload for the 3D viewer.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetGLBMesh3DByBoundingBoxAsync(double x_1, double y_1, double x_2, double y_2, System.Nullable<double> tolerance, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));x_1 System.Double
The X coordinate of the first corner, in PL-1992 (EPSG:2180) metres.
y_1 System.Double
The Y coordinate of the first corner, in PL-1992 (EPSG:2180) metres.
x_2 System.Double
The X coordinate of the second corner, in PL-1992 (EPSG:2180) metres.
y_2 System.Double
The Y coordinate of the second corner, in PL-1992 (EPSG:2180) metres.
tolerance System.Nullable<System.Double>
An optional tolerance for the spatial query, in metres. When omitted the terrain service applies its own default.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> holding the .glb file.
TerrainController.GetGLBMesh3DByCircleAsync(double, double, Nullable<double>, Nullable<double>, Nullable<double>, CancellationToken) Method
Asynchronously retrieves the terrain surface inside a circle and streams it as a binary glTF (.glb) payload for the 3D viewer.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetGLBMesh3DByCircleAsync(double x, double y, System.Nullable<double> radius, System.Nullable<double> diameter, System.Nullable<double> tolerance, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));The X coordinate of the centre, in PL-1992 (EPSG:2180) metres.
The Y coordinate of the centre, in PL-1992 (EPSG:2180) metres.
radius System.Nullable<System.Double>
The search radius in metres. Optional when diameter is supplied.
diameter System.Nullable<System.Double>
The search diameter in metres, used only when radius is absent.
tolerance System.Nullable<System.Double>
An optional tolerance for the spatial query, in metres. When omitted the terrain service applies its own default.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> holding the .glb file.
TerrainController.GetMesh3DByBoundingBoxAsync(double, double, double, double, Nullable<double>, CancellationToken) Method
Asynchronously retrieves the terrain surface inside an axis aligned bounding box given by two opposite corners.
Corner order does not matter.
A terrain payload is optional by contract: when the area holds no stored elevation points, or the terrain service cannot answer, the response is 204 rather than an error - see TerrainJsonAsync(this HttpClient, string, CancellationToken).
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetMesh3DByBoundingBoxAsync(double x_1, double y_1, double x_2, double y_2, System.Nullable<double> tolerance, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));x_1 System.Double
The X coordinate of the first corner, in PL-1992 (EPSG:2180) metres.
y_1 System.Double
The Y coordinate of the first corner, in PL-1992 (EPSG:2180) metres.
x_2 System.Double
The X coordinate of the second corner, in PL-1992 (EPSG:2180) metres.
y_2 System.Double
The Y coordinate of the second corner, in PL-1992 (EPSG:2180) metres.
tolerance System.Nullable<System.Double>
An optional tolerance for the spatial query, in metres. When omitted the terrain service applies its own default.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> carrying the DiGi.Geometry.Spatial.Classes.Mesh3D as JSON.
TerrainController.GetMesh3DByCircleAsync(double, double, Nullable<double>, Nullable<double>, Nullable<double>, CancellationToken) Method
Asynchronously retrieves the terrain surface inside a circle centred on the given plan coordinate.
Either radius or diameter must be supplied; radius wins when both are.
A terrain payload is optional by contract: when the area holds no stored elevation points, or the terrain service cannot answer, the response is 204 rather than an error - see TerrainJsonAsync(this HttpClient, string, CancellationToken).
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetMesh3DByCircleAsync(double x, double y, System.Nullable<double> radius, System.Nullable<double> diameter, System.Nullable<double> tolerance, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));The X coordinate of the centre, in PL-1992 (EPSG:2180) metres.
The Y coordinate of the centre, in PL-1992 (EPSG:2180) metres.
radius System.Nullable<System.Double>
The search radius in metres. Optional when diameter is supplied.
diameter System.Nullable<System.Double>
The search diameter in metres, used only when radius is absent.
tolerance System.Nullable<System.Double>
An optional tolerance for the spatial query, in metres. When omitted the terrain service applies its own default.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> carrying the DiGi.Geometry.Spatial.Classes.Mesh3D as JSON.
Renders the 3D viewer page for the terrain inside an axis aligned bounding box. The page itself carries no geometry; the viewer streams the binary glTF payload from the glb endpoint.
public Microsoft.AspNetCore.Mvc.IActionResult GetTerrainByBoundingBox(double x_1, double y_1, double x_2, double y_2);x_1 System.Double
The X coordinate of the first corner, in PL-1992 (EPSG:2180) metres.
y_1 System.Double
The Y coordinate of the first corner, in PL-1992 (EPSG:2180) metres.
x_2 System.Double
The X coordinate of the second corner, in PL-1992 (EPSG:2180) metres.
y_2 System.Double
The Y coordinate of the second corner, in PL-1992 (EPSG:2180) metres.
Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult rendering the glTF scene view.
Renders the 3D viewer page for the terrain inside a circle. The page itself carries no geometry; the viewer streams the binary glTF payload from the glb endpoint.
public Microsoft.AspNetCore.Mvc.IActionResult GetTerrainByCircle(double centerX, double centerY, double radius);centerX System.Double
The X coordinate of the centre of the requested area.
centerY System.Double
The Y coordinate of the centre of the requested area.
radius System.Double
The radius of the requested area in metres.
Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult rendering the glTF scene view.
Converts the terrain surface behind the given request into a batched DiGi.GLTF.Classes.GLTFScene and renders it as a binary glTF (.glb) response body.
Missing terrain is answered with 204 at every step. The viewer treats an empty payload as "nothing to draw" and keeps the rest of the page working, so a request for an area the terrain store does not cover yet degrades instead of failing.
private System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GLBResultAsync(string requestUri, string name, DiGi.Geometry.Spatial.Classes.Point3D referencePoint, System.Threading.CancellationToken cancellationToken);requestUri System.String
The terrain service URL to read the surface from.
name System.String
The name given to the scene and to its single node.
referencePoint DiGi.Geometry.Spatial.Classes.Point3D
The world point the scene is translated to a local origin around. The centre of the requested area, matching what the building scenes use, so a terrain scene and a building scene of the same area share one local origin.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A System.Threading.Tasks.Task<> holding the .glb file, or a no content status.
Initializes and returns the start view of the terrain feature.
public Microsoft.AspNetCore.Mvc.IActionResult Start();Microsoft.AspNetCore.Mvc.IActionResult
An Microsoft.AspNetCore.Mvc.IActionResult result that renders the starting view.
Provides API endpoints for retrieving and managing year built data.
public class YearBuiltDataController : Microsoft.AspNetCore.Mvc.ControllerInheritance System.Object → Microsoft.AspNetCore.Mvc.ControllerBase → Microsoft.AspNetCore.Mvc.Controller → YearBuiltDataController
Initializes a new instance of the YearBuiltDataController class.
public YearBuiltDataController(System.Net.Http.IHttpClientFactory httpClientFactory);httpClientFactory System.Net.Http.IHttpClientFactory
The System.Net.Http.IHttpClientFactory used to create HTTP clients.
Retrieves a year built data item based on the specified reference and optional county identifier.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> GetItemByReferenceAsync(string reference, System.Nullable<int> countyId, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));reference System.String
The unique reference of the item to retrieve.
countyId System.Nullable<System.Int32>
The optional identifier of the county associated with the item.
cancellationToken System.Threading.CancellationToken
A cancellation token that can be used by the caller to cancel the asynchronous operation.
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>
A task that represents the asynchronous operation, containing an Microsoft.AspNetCore.Mvc.IActionResult result.