NetTopologySuite v2.1.0 Release Notes

Release Date: 2020-08-04 // about 1 year ago
    • โšก๏ธ Updated JTS compatibility to 1.17.0.
      • See JTS' own release notes for details of what's included in this; those will not be reproduced here.
      • Note that the API breaking change included in JTS 1.17.0 was not ported to this release. You may safely cast Polygon.ExteriorRing, any element of Polygon.InteriorRings, and the return value of Polygon.GetInteriorRingN to LinearRing instead.
    • ๐Ÿ‘Œ Improve xmldoc.
    • ๐Ÿ›  Fix some packaging issues.
    • โž• Add GeometryFactoryEx, which allows callers to force polygon rings to be a certain orientation.
    • Unseal NtsGeometryServices in order to allow subclasses to alter the behavior of CreateGeometryFactory.
    • Mark a few useful members on QuadEdge as public instead of internal (they are public in JTS).
    • GML readers read Z values now.
    • CoordinateSequence and Coordinate methods that accept Ordinate enum values now treat values greater than Measure16 the same way they treat all other "Ordinate value is not present in this instance" situations. In the most literal sense, this is technically a behavior breaking change, but only for people who are both casting integer values >32 to Ordinate enum values and actually using them with Coordinate or CoordinateSequence instances with at least 19 dimensions, at least 17 of which are measures.
    • ๐ŸŽ STRtree<T>.Remove now has a possibility of working as expected when T is a value type, instead of never removing anything. It now uses the default equality comparer for the type. Reference types still use object reference equality, for backwards compatibility and performance reasons (it's OK to do this for value types, because Remove was essentially a really slow no-op for them anyway).
    • The internal Coordinate subclass that we use for everything other than XY / XYZ / XYM / XYZM now handles "missing" ordinate values consistently with how other Coordinate types handle them.
    • Copying a Geometry no longer clobbers its GeometryFactory with a brand new one based on the SRID (JTS uses a separate field for this, so this is more faithful).
    • More methods on GeometryFactory have been marked virtual, for consistency with JTS.
    • ๐Ÿ›  Fix an incorrect port: GeometryTransformer.Transform was inappropriately transforming a LinearRing into a plain LineString, which is never better.
    • The center of a Bintree Interval is now computed correctly (JTS does not have a method for this; previously, it was the same as the width).
    • โž• Add Envelope.Diameter to get the largest possible distance between any two points that both intersect the bounding box.
    • ๐Ÿ›  Fix an issue with VoronoiDiagramBuilder clipping.
    • Start using Microsoft.DotNet.ApiCompat to help us avoid accidentally making API breaking changes.
    • ๐Ÿ‘€ In the same spirit of the improvements to WKT number formatting that came with JTS 1.17.0, also work around a very old bug in .NET Framework / earlier versions of .NET Core before 3.0. For details of the bug and its fix in .NET Core 3.0, see: https://devblogs.microsoft.com/dotnet/floating-point-parsing-and-formatting-improvements-in-net-core-3-0/
    • โž• Add IEntireCoordinateSequenceFilter. Very similar to ICoordinateSequenceFilter, but it is only called once per CoordinateSequence, to enable some significant performance optimizations. We do not currently take advantage of this in NTS, but we're already looking at opportunities, and we're excited to see what you do with it!

Previous changes from v2.0.0

  • ๐Ÿš€ This major release represents several efforts to improve usability and consistency throughout NTS, brought on by some changes in JTS 1.16.0 that we felt would not be best to port as-is.

    ๐Ÿš€ As such, this release contains many breaking changes, some of which are very significant. Because the NuGet ecosystem heavily favors using SemVer for versioning, we felt that it's time to start deviating from using the JTS compatibility version numbering scheme that we have used in the past, and call this first release 2.0.0.

    Some of the breaking changes:

    ๐Ÿ“ฆ 1. NetTopologySuite is, again, the primary NTS package.

    1. GeoAPI has been gutted. The relevant useful parts are now inside of NTS.
    2. Many interfaces have been removed, in favor of just using their corresponding classes. ๐Ÿ‘ 4. Coordinate.Z is no longer stored in a field on the base class. Full Z support is added by subclasses.
    3. Ordinate / Ordinates now define 16 spatial dimensions and 16 measure dimensions.
    4. ICoordinateSequence (now just CoordinateSequence) now uses integer ordinate indexes. 0๏ธโƒฃ 7. By default, reading WKT without "Z", "M", or "ZM" tags using WKTWriter will now give a geometry that appears to support holding Z values, even if no Z values are actually present.
      • Set IsOldNtsCoordinateSyntaxAllowed to false to prevent this, but keep in mind that this will break things like "POINT (1 2 3)" that older versions of NTS supported.

    GeoAPI issues addressed in 2.0.0, in the order they were closed:

    ๐Ÿšš 1. NetTopologySuite/GeoAPI#54: Remove obsolete interfaces, classes and members

    1. NetTopologySuite/GeoAPI#55: Future of Coordinate class ๐Ÿšš 3. NetTopologySuite/GeoAPI#59: Remove ICloneable implementations across the board
    2. NetTopologySuite/GeoAPI#64: Target just .NET Standard 2.0 ๐Ÿšš 5. NetTopologySuite/GeoAPI#65: Remove reflection-based GeometryServiceProvider.Instance bootstrap
    3. NetTopologySuite/GeoAPI#68: Replace notable interfaces with abstract classes, for multiple reasons ๐Ÿšš 7. NetTopologySuite/GeoAPI#70: Remove (standalone) GeoAPI

    NTS issues addressed in 2.0.0, in the order they were closed:

    โšก๏ธ 1. #265: Update to JTS 1.16.0

    1. #292: Target just .NET Standard 2.0 โšก๏ธ 3. #294: Update to JTS 1.16.1 ๐Ÿ‘ป 4. #282: Exception while fetching Interior Point - NetTopologySuite.Geometries.TopologyException ๐Ÿšš 5. #291: Remove obsolete types and members
    2. #316: Mark a few more things obsolete ๐Ÿ’ป 7. #289: DistanceComputer.PointToSegmentString skips the last vertex of an ICoordinateSequence ๐Ÿšš 8. #308: Remove IGeometry warts ๐Ÿ“ฆ 9. #315: Tweak NuGet packages again
    3. #244: Consider replacing AssemblyInfo.cs and *.nuspec with additional things in *.csproj
    4. #309: Make IsWithinDistance an extension method
    5. #311: Fix the design of Ordinate values to be consistent and behave predictably
    6. #246: Aggregate operations ๐Ÿ‘ 14. #324: Support MSSQL-compatible WKT writing
    7. #156: WKTWriter doesn't create the expected result