Skip to content

DiGi.Analytical.Urban.Classes

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

DiGi.Analytical.Urban.Classes Namespace

Classes

BuildingModelBoundingBoxRelation Class

Represents a one-to-one bidirectional relationship between a DiGi.Analytical.Building.Classes.BuildingModel and a DiGi.Analytical.Classes.BoundingBox.

public class BuildingModelBoundingBoxRelation : DiGi.Core.Relation.Classes.OneToOneBidirectionalRelation<DiGi.Analytical.Building.Classes.BuildingModel, DiGi.Analytical.Classes.BoundingBox>, DiGi.Analytical.Urban.Interfaces.IUrbanRelation, DiGi.Analytical.Urban.Interfaces.IUrbanObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Relation.Interfaces.IRelation, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Relation.Classes.RelationDiGi.Core.Relation.Classes.Relation<DiGi.Analytical.Building.Classes.BuildingModel,DiGi.Analytical.Classes.BoundingBox>DiGi.Core.Relation.Classes.OneToOneRelation<DiGi.Analytical.Building.Classes.BuildingModel,DiGi.Analytical.Classes.BoundingBox>DiGi.Core.Relation.Classes.OneToOneBidirectionalRelation<DiGi.Analytical.Building.Classes.BuildingModel,DiGi.Analytical.Classes.BoundingBox> → BuildingModelBoundingBoxRelation

Implements DiGi.Analytical.Urban.Interfaces.IUrbanRelation, DiGi.Analytical.Urban.Interfaces.IUrbanObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Relation.Interfaces.IRelation, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject

Constructors

BuildingModelBoundingBoxRelation(BuildingModel, BoundingBox) Constructor

Initializes a new instance of the BuildingModelBoundingBoxRelation class.

public BuildingModelBoundingBoxRelation(DiGi.Analytical.Building.Classes.BuildingModel? buildingModel, DiGi.Analytical.Classes.BoundingBox? boundingBox3D);

Parameters

buildingModel DiGi.Analytical.Building.Classes.BuildingModel

The building model associated with this relation.

boundingBox3D DiGi.Analytical.Classes.BoundingBox

The 3D bounding box associated with this relation.

BuildingModelBoundingBoxRelation(BuildingModelBoundingBoxRelation) Constructor

Initializes a new instance of the BuildingModelBoundingBoxRelation class using an existing relation instance.

public BuildingModelBoundingBoxRelation(DiGi.Analytical.Urban.Classes.BuildingModelBoundingBoxRelation? buildingModelBoundingBoxRelation);

Parameters

buildingModelBoundingBoxRelation BuildingModelBoundingBoxRelation

The existing BuildingModelBoundingBoxRelation instance to copy from.

BuildingModelBoundingBoxRelation(JsonObject) Constructor

Initializes a new instance of the BuildingModelBoundingBoxRelation class using the specified JSON object.

public BuildingModelBoundingBoxRelation(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The System.Text.Json.Nodes.JsonObject containing the data used to initialize the relation.

UrbanInformation Class

Represents urban-related information for a building object, providing spatial context through coordinates.

public class UrbanInformation : DiGi.Core.Classes.SerializableObject, DiGi.Analytical.Building.Interfaces.IBuildingObject, DiGi.Analytical.Interfaces.IAnalyticalObject, DiGi.Core.Interfaces.IObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObject → UrbanInformation

Implements DiGi.Analytical.Building.Interfaces.IBuildingObject, DiGi.Analytical.Interfaces.IAnalyticalObject, DiGi.Core.Interfaces.IObject

Constructors

UrbanInformation() Constructor

Initializes a new instance of the UrbanInformation class.

public UrbanInformation();

UrbanInformation(UrbanInformation) Constructor

Initializes a new instance of the UrbanInformation class using an existing UrbanInformation instance.

public UrbanInformation(DiGi.Analytical.Urban.Classes.UrbanInformation? urbanInformation);

Parameters

urbanInformation UrbanInformation

The source UrbanInformation object to copy data from. This value can be null.

UrbanInformation(JsonObject) Constructor

Initializes a new instance of the UrbanInformation class using the specified System.Text.Json.Nodes.JsonObject.

public UrbanInformation(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The System.Text.Json.Nodes.JsonObject containing the data used to initialize this instance.

Properties

UrbanInformation.Coordinates Property

Gets or sets the geographic coordinates associated with the urban information.

public DiGi.Core.Classes.Coordinates? Coordinates { get; set; }

Property Value

DiGi.Core.Classes.Coordinates

UrbanModel Class

Represents an urban model that manages urban-related information and relation clusters within a parametrized GUID object framework.

public class UrbanModel : DiGi.Core.Parameter.Classes.ParametrizedGuidObject, DiGi.Analytical.Urban.Interfaces.IUrbanGuidObject, DiGi.Analytical.Urban.Interfaces.IUrbanObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.IGuidObject, DiGi.Core.Interfaces.IUniqueObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IGuidModel, DiGi.Core.Interfaces.ISerializableModel, DiGi.Core.Interfaces.IModel

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.Parameter.Classes.ParametrizedObjectDiGi.Core.Parameter.Classes.ParametrizedGuidObject → UrbanModel

Implements DiGi.Analytical.Urban.Interfaces.IUrbanGuidObject, DiGi.Analytical.Urban.Interfaces.IUrbanObject, DiGi.Core.Interfaces.IObject, DiGi.Core.Interfaces.IGuidObject, DiGi.Core.Interfaces.IUniqueObject, DiGi.Core.Interfaces.ISerializableObject, DiGi.Core.Interfaces.ICloneableObject<DiGi.Core.Interfaces.ISerializableObject>, DiGi.Core.Interfaces.ICloneableObject, DiGi.Core.Interfaces.IGuidModel, DiGi.Core.Interfaces.ISerializableModel, DiGi.Core.Interfaces.IModel

Constructors

UrbanModel(UrbanModel) Constructor

Initializes a new instance of the UrbanModel class by cloning an existing urban model.

public UrbanModel(DiGi.Analytical.Urban.Classes.UrbanModel? urbanModel);

Parameters

urbanModel UrbanModel

The source UrbanModel to clone from; if null, a default instance is initialized.

UrbanModel(JsonObject) Constructor

Initializes a new instance of the UrbanModel class from the specified JSON object.

public UrbanModel(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The System.Text.Json.Nodes.JsonObject containing the data used to initialize the model; may be null.

Properties

UrbanModel.UrbanInformation Property

Gets or sets the urban information associated with this urban model.

public DiGi.Analytical.Urban.Classes.UrbanInformation UrbanInformation { get; set; }

Property Value

UrbanInformation

Methods

UrbanModel.GetBoundingBox() Method

Gets the axis-aligned bounding box encompassing all building models within the urban model.

public DiGi.Geometry.Spatial.Classes.BoundingBox3D? GetBoundingBox();

Returns

DiGi.Geometry.Spatial.Classes.BoundingBox3D
The DiGi.Geometry.Spatial.Classes.BoundingBox3D representing the combined bounding box of all buildings, or null if no valid bounding boxes could be determined.

UrbanModel.GetBoundingBox(BuildingModel) Method

Gets the axis-aligned bounding box of the specified building model.

public DiGi.Geometry.Spatial.Classes.BoundingBox3D? GetBoundingBox(DiGi.Analytical.Building.Classes.BuildingModel? buildingModel);

Parameters

buildingModel DiGi.Analytical.Building.Classes.BuildingModel

The building model for which to retrieve the bounding box.

Returns

DiGi.Geometry.Spatial.Classes.BoundingBox3D
A DiGi.Geometry.Spatial.Classes.BoundingBox3D representing the bounding box of the building model, or null if it cannot be determined or the provided model is null.

UrbanModel.GetBuildingModels() Method

Gets all building models contained in the urban model.

public System.Collections.Generic.List<DiGi.Analytical.Building.Classes.BuildingModel>? GetBuildingModels();

Returns

System.Collections.Generic.List<DiGi.Analytical.Building.Classes.BuildingModel>
A list of DiGi.Analytical.Building.Classes.BuildingModel instances contained in the urban model, or null if none are available.

UrbanModel.Remove(BuildingModel) Method

Removes the specified building model from the urban model.

public bool Remove(DiGi.Analytical.Building.Classes.BuildingModel? buildingModel);

Parameters

buildingModel DiGi.Analytical.Building.Classes.BuildingModel

The building model to be removed.

Returns

System.Boolean
True if the building model was successfully removed; otherwise, false.

UrbanModel.Remove(GuidReference) Method

Removes the specified GUID reference from the urban model.

public bool Remove(DiGi.Core.Classes.GuidReference? guidReference);

Parameters

guidReference DiGi.Core.Classes.GuidReference

The GUID reference of the object to be removed.

Returns

System.Boolean
True if the reference was successfully removed; otherwise, false.

UrbanModel.Update(BuildingModel) Method

Updates the specified building model within the urban model, refreshing its associated bounding box relations.

public bool Update(DiGi.Analytical.Building.Classes.BuildingModel? buildingModel);

Parameters

buildingModel DiGi.Analytical.Building.Classes.BuildingModel

The building model instance to be updated.

Returns

System.Boolean
True if the update operation was successful; otherwise, false.

UrbanModelFile Class

Represents a file that stores and manages an UrbanModel.

public class UrbanModelFile : DiGi.Core.IO.File.Classes.ValueFile<DiGi.Analytical.Urban.Classes.UrbanModel>, DiGi.Analytical.Urban.Interfaces.IUrbanObject, DiGi.Core.Interfaces.IObject

Inheritance System.ObjectDiGi.Core.Classes.ObjectDiGi.Core.Classes.SerializableObjectDiGi.Core.IO.File.Classes.FileDiGi.Core.IO.File.Classes.ValueFile<UrbanModel> → UrbanModelFile

Implements DiGi.Analytical.Urban.Interfaces.IUrbanObject, DiGi.Core.Interfaces.IObject

Constructors

UrbanModelFile(UrbanModelFile) Constructor

Initializes a new instance of the UrbanModelFile class using the specified UrbanModelFile.

public UrbanModelFile(DiGi.Analytical.Urban.Classes.UrbanModelFile? urbanModelFile);

Parameters

urbanModelFile UrbanModelFile

The UrbanModelFile instance to copy from.

UrbanModelFile(string) Constructor

Initializes a new instance of the UrbanModelFile class using the specified file path.

public UrbanModelFile(string? path);

Parameters

path System.String

The path to the urban model file.

UrbanModelFile(JsonObject) Constructor

Initializes a new instance of the UrbanModelFile class using the specified JSON object.

public UrbanModelFile(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The System.Text.Json.Nodes.JsonObject used to initialize the urban model file.

UrbanRelationCluster Class

Represents a cluster of urban relations associated with analytical GUID objects, implementing the urban object interface.

public class UrbanRelationCluster : DiGi.Core.Relation.Classes.UniqueObjectRelationCluster<DiGi.Analytical.Interfaces.IAnalyticalGuidObject, DiGi.Analytical.Urban.Interfaces.IUrbanRelation>, DiGi.Analytical.Urban.Interfaces.IUrbanObject, DiGi.Core.Interfaces.IObject

Inheritance System.ObjectDiGi.Core.Classes.Cluster<DiGi.Core.Classes.TypeReference,DiGi.Core.Interfaces.IUniqueReference,DiGi.Analytical.Interfaces.IAnalyticalGuidObject>DiGi.Core.Classes.ValueCluster<DiGi.Core.Classes.TypeReference,DiGi.Core.Interfaces.IUniqueReference,DiGi.Analytical.Interfaces.IAnalyticalGuidObject>DiGi.Core.Classes.SerializableObjectValueCluster<DiGi.Core.Classes.TypeReference,DiGi.Core.Interfaces.IUniqueReference,DiGi.Analytical.Interfaces.IAnalyticalGuidObject>DiGi.Core.Classes.UniqueObjectValueCluster<DiGi.Analytical.Interfaces.IAnalyticalGuidObject>DiGi.Core.Relation.Classes.UniqueObjectRelationCluster<DiGi.Analytical.Interfaces.IAnalyticalGuidObject,DiGi.Analytical.Urban.Interfaces.IUrbanRelation> → UrbanRelationCluster

Implements DiGi.Analytical.Urban.Interfaces.IUrbanObject, DiGi.Core.Interfaces.IObject

Constructors

UrbanRelationCluster() Constructor

Initializes a new instance of the UrbanRelationCluster class.

public UrbanRelationCluster();

UrbanRelationCluster(UrbanRelationCluster) Constructor

Initializes a new instance of the UrbanRelationCluster class using an existing UrbanRelationCluster instance.

public UrbanRelationCluster(DiGi.Analytical.Urban.Classes.UrbanRelationCluster? urbanRelationCluster);

Parameters

urbanRelationCluster UrbanRelationCluster

The source UrbanRelationCluster instance to copy from.

UrbanRelationCluster(IEnumerable<IAnalyticalGuidObject>) Constructor

Initializes a new instance of the UrbanRelationCluster class using the specified collection of analytical GUID objects.

public UrbanRelationCluster(System.Collections.Generic.IEnumerable<DiGi.Analytical.Interfaces.IAnalyticalGuidObject>? analyticalGuidObjects);

Parameters

analyticalGuidObjects System.Collections.Generic.IEnumerable<DiGi.Analytical.Interfaces.IAnalyticalGuidObject>

The collection of DiGi.Analytical.Interfaces.IAnalyticalGuidObject instances to initialize the cluster with.

UrbanRelationCluster(JsonObject) Constructor

Initializes a new instance of the UrbanRelationCluster class using the specified JSON object.

public UrbanRelationCluster(System.Text.Json.Nodes.JsonObject? jsonObject);

Parameters

jsonObject System.Text.Json.Nodes.JsonObject

The JSON object used to initialize the instance. This value can be null.

Clone this wiki locally