Skip to content

DiGi.GIS.WebAPI.UI.Classes

github-actions[bot] edited this page Jul 15, 2026 · 7 revisions

DiGi.GIS.WebAPI.UI.Classes Namespace

Classes

AntennaParameter Class

Represents a single antenna sent by the communication 3D view: its world location and the communication functions selected by the user (mapped to DiGi.Communication.Enums.Function).

public class AntennaParameter

Inheritance System.Object → AntennaParameter

Properties

AntennaParameter.Functions Property

Gets or sets the names of the selected DiGi.Communication.Enums.Function values (e.g. Transmitter, Receiver).

public System.Collections.Generic.List<string>? Functions { get; set; }

Property Value

System.Collections.Generic.List<System.String>

AntennaParameter.X Property

Gets or sets the X coordinate of the antenna in world coordinates.

public double X { get; set; }

Property Value

System.Double

AntennaParameter.Y Property

Gets or sets the Y coordinate of the antenna in world coordinates.

public double Y { get; set; }

Property Value

System.Double

AntennaParameter.Z Property

Gets or sets the height of the antenna top above the ground plane (Z = 0) in meters.

public double Z { get; set; }

Property Value

System.Double

Building2DGLTFNodeConverter Class

Converts a DiGi.GIS.Classes.Building2D into DiGi.GLTF.Classes.GLTFNode instances by extruding its 2D footprint by the number of storeys (see ToGLTF_GLTFNodes(this Building2D, double, double)).

Registered automatically at startup by assembly scanning (see Program.cs); the generic DiGi.GLTF engine consults it when converting DiGi.Core.Interfaces.ISerializableObject instances.

public class Building2DGLTFNodeConverter : DiGi.GLTF.Classes.GLTFNodeConverter<DiGi.GIS.Classes.Building2D>

Inheritance System.Object → DiGi.GLTF.Classes.GLTFNodeConverter<DiGi.GIS.Classes.Building2D> → Building2DGLTFNodeConverter

Methods

Building2DGLTFNodeConverter.Convert(Building2D, double) Method

Converts the specified DiGi.GIS.Classes.Building2D into DiGi.GLTF.Classes.GLTFNode instances holding geometry in world coordinates.

public override System.Collections.Generic.List<DiGi.GLTF.Classes.GLTFNode>? Convert(DiGi.GIS.Classes.Building2D serializableObject, double tolerance);

Parameters

serializableObject DiGi.GIS.Classes.Building2D

The DiGi.GIS.Classes.Building2D to be converted.

tolerance System.Double

The distance tolerance used during triangulation.

Returns

System.Collections.Generic.List<DiGi.GLTF.Classes.GLTFNode>
A list of DiGi.GLTF.Classes.GLTFNode instances, or null if the building has no geometry.

CommunicationCalculationParameter Class

Represents the payload of a communication calculation request sent by the communication 3D view: the analyzed circular area (used to fetch the buildings on the fly) and the antennas placed by the user.

public class CommunicationCalculationParameter

Inheritance System.Object → CommunicationCalculationParameter

Properties

CommunicationCalculationParameter.Antennas Property

Gets or sets the antennas placed by the user in the 3D view.

public System.Collections.Generic.List<DiGi.GIS.WebAPI.UI.Classes.AntennaParameter>? Antennas { get; set; }

Property Value

System.Collections.Generic.List<AntennaParameter>

CommunicationCalculationParameter.CenterX Property

Gets or sets the X coordinate of the center of the analyzed circular area.

public double CenterX { get; set; }

Property Value

System.Double

CommunicationCalculationParameter.CenterY Property

Gets or sets the Y coordinate of the center of the analyzed circular area.

public double CenterY { get; set; }

Property Value

System.Double

CommunicationCalculationParameter.Conductivity Property

Gets or sets the default electrical conductivity applied to the scattering object mesh cells [S/m].

public System.Nullable<double> Conductivity { get; set; }

Property Value

System.Nullable<System.Double>

CommunicationCalculationParameter.DefaultSimpleMultipathPowerDelayProfile Property

Gets or sets the default simple multipath power delay profile name.

public string? DefaultSimpleMultipathPowerDelayProfile { get; set; }

Property Value

System.String

CommunicationCalculationParameter.Frequencies Property

Gets or sets the frequencies of the propagating electromagnetic wave [MHz].

AI-NOTE (multi-frequency extensibility): the payload is a list so the calculation can be executed for multiple frequencies in one request. The 3D view currently sends a single frequency; once the per frequency toggling UI is implemented, the additional values flow through this property without any backend change.

public System.Collections.Generic.List<double>? Frequencies { get; set; }

Property Value

System.Collections.Generic.List<System.Double>

CommunicationCalculationParameter.Polarization Property

Gets or sets the polarization type of the propagating electromagnetic wave (Vertical or Horizontal).

public string? Polarization { get; set; }

Property Value

System.String

CommunicationCalculationParameter.Radius Property

Gets or sets the radius of the analyzed circular area in meters.

public double Radius { get; set; }

Property Value

System.Double

CommunicationCalculationParameter.RelativePermittivity Property

Gets or sets the default relative electrical permittivity applied to the scattering object mesh cells [-].

public System.Nullable<double> RelativePermittivity { get; set; }

Property Value

System.Nullable<System.Double>

CommunicationCalculationParameter.StoreyHeight Property

Gets or sets the storey height in meters used for the building extrusions.

public System.Nullable<double> StoreyHeight { get; set; }

Property Value

System.Nullable<System.Double>

Clone this wiki locally