Commit b7b8f5fe authored by Riegel's avatar Riegel
Browse files

Update extensions README.md

parent dd7ed73f
Pipeline #10209 passed with stage
in 1 minute and 13 seconds
......@@ -2,44 +2,28 @@
Extension modules to the core functionality of CityDoctor2.
# Loading
The extension modules can be loaded into Maven by two methods:
Except for CityDoctorGUI, all extension modules are not loaded into the Maven project by default.
Loading an extension module can be done by either loading the Maven module directly, or by adjusting the CityDoctorParent
pom.xml and moving the respective modules out of the comment-block in the module list found at the end of the file.
1. Adjusting the pom.xml file of CityDoctorParent by moving the respective modules out of the comment block in the module list (found near the end of the file).
2. Importing the module with Maven.
The CityDoctorGUI extension module is loaded by default.
# Building
If the modules are loaded by including them in the CityDoctorParent pom, Maven will
automatically build them while building CityDoctor2.
If the modules are loaded directly, they need to be built directly with Maven.
If a module was loaded by including it in the module list of CityDoctorParent, Maven will
automatically build it while building CityDoctor2.
If a module is imported with Maven, it needs to be built directly with Maven.
After building, the jars can be found in the **/target** subdirectory of each respective extension module.
After building, the jars can be found in the **/target** subdirectory of each respective extension module's directory.
# Module Information
## CityDoctorAutoPro
![Maintenance Level: Deprecated](../resources/Badges/MaintenanceLevel_Deprecated.svg)
The AutoPro (short for automated processing) module is an interface for the conversion of the internal data model to a C++
representation, to allow use of advanced functionalities of CGAL with CityDoctor2.
### Usage
> ⚠ The AutoPro module is deprecated and will be removed in a future release, once the CGAL functionalities have been ported to Java.
AutoPro requires a collection of .dll-files to run, some of which are not available as FOSS and thus cannot be
distributed with this project.
Access to the collection, or information about the required .dll-files, can be granted upon request for a valid reason.
Contact a Maintainer of this project for further information in this regard.
---
## CityDoctorGUI
![Maintenance Level: Actively Maintained](../resources/Badges/MaintenanceLevel_ActivelyMaintained.svg)
The GUI module offers a graphical user interface for CityDoctor2, including a model viewer allowing for visual
inspection of validation results and found errors.
The GUI module offers a graphical user interface for CityDoctor2, including a model viewer, allowing the visual
inspection of validation results and detected errors.
### View-Plugins
......@@ -64,7 +48,6 @@ Lastly, the GUI can also be started by calling `MainWindow.main(args[])`.
---
## CityDoctorHealer
![Maintenance Level: Inactively Maintained](../resources/Badges/MaintenanceLevel_InactivelyMaintained.svg)
CityDoctorHealer implements functionalities for the automated repair of geometries containing errors.
The healer uses naive approaches to fix geometrical errors, and thus, it cannot be guaranteed that semantical
......@@ -86,42 +69,56 @@ can be changed by calling `Healer.setNumberOfIterations(int limit)`.
---
## CityDoctorHealerGUI
CityDoctorGUI-view for CityDoctorHealer. Allows fine control over the automated healing steps, including a preview of the
result of each healing step.
### Usage
See [CityDoctorGUI View-plugins](#view-plugins)
---
## CityDoctorHealerGenetic
![Maintenance Level: Abandoned](../resources/Badges/MaintenanceLevel_Abandoned.svg)
CityDoctorHealerGenetic uses a genetical algorithm to establish an optimal CityDoctorHealer healing-plan for geometries containing errors.
### Usage
> ⚠ This module has been abandoned. As of writing the module is still functional, but it may break at any time.
>Issues, bug reports and suggestions for this module will not be processed. Use at your own discretion.
> ⚠ This module is currently not being developed and in a prototypical state. As of CityDoctor2 version 3.15.0, this module is
> still functional, but may break at any point.
Usage is nearly identical to CityDoctorHealer, only requiring changing the classpath to the HealerGenetic jar.
A View for usage with CityDoctorGUI is included.
A View-Plugin for CityDoctorGUI is included.
---
## CityDoctorHealerGUI
## CityDoctorAutoPro
![Maintenance Level: Inactively Maintained](../resources/Badges/MaintenanceLevel_InactivelyMaintained.svg)
CityDoctorGUI-view for CityDoctorHealer. Allows fine control over the automated healing steps, including a preview of the
result of each healing step.
The AutoPro (short for automated processing) module is an interface for the conversion of the internal data model to a C++
representation, to allow use of advanced functionalities of CGAL with CityDoctor2.
### Usage
See [CityDoctorGUI View-plugins](#view-plugins)
> ⚠ The AutoPro module is deprecated and will be removed in a future release, once the CGAL functionalities have been ported to Java.
AutoPro requires a collection of .dll-files to run, some of which are not available as FOSS and thus cannot be
distributed with this project.
Access to the collection, or information about the required .dll-files, can be granted upon request for a valid reason.
Contact a Maintainer of this project for further information in this regard.
---
## CityDoctorWebService
![Maintenance Level: Abandoned](../resources/Badges/MaintenanceLevel_Abandoned.svg)
Contains a web service implementation for CityDoctor2.
### Usage
> ⚠ This module has been abandoned. As of writing the module is still functional, but it may break at any time.
>Issues, bug reports and suggestions for this module will not be processed. Use at your own discretion.
>Issues, bug reports and suggestions for this module will not be processed.
> ⚠ CityDoctorWebservice requires connection to a PostgreSQL Server. Connection parameters need to be set in the
pgpass.conf file found in the /DBScripts directory.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment