Class GeometryEditor

Namespace

NetTopologySuite.Geometries.Utilities

Assembly

NetTopologySuite.dll

A class which supports creating new Geometrys which are modifications of existing ones, maintaining the same type structure.

public class GeometryEditor

Inheritance

object

GeometryEditor

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

Geometry objects are intended to be treated as immutable. This class allows you to "modifies" a Geometrys by traversing them, applying a user-defined GeometryEditor.IGeometryEditorOperation, GeometryEditor.CoordinateSequenceOperation or GeometryEditor.CoordinateOperation and creating a new Geometrys with the same structure but (possibly) modified components.

Examples of the kinds of modifications which can be made are:

• The values of the coordinates may be changed. The editor does not check whether changing coordinate values makes the result Geometry invalid
• The coordinate lists may be changed (e.g. by adding, deleting or modifying coordinates). The modified coordinate lists must be consistent with their original parent component (e.g. a LinearRing must always have at least 4 coordinates, and the first and last coordinate must be equal).
• Components of the original point may be deleted (e.g. holes may be removed from a Polygon, or LineStrings removed from a MultiLineString). Deletions will be propagated up the component tree appropriately.

All changes must be consistent with the original Geometry's structure (e.g. a Polygon cannot be collapsed into a LineString). If changing the structure is required, use a GeometryTransformer.

This class supports creating an edited Geometry using a different GeometryFactory via the GeometryEditor(GeometryFactory) constructor. Examples of situations where this is required is if the geometry is transformed to a new SRID and/or a new PrecisionModel.

Usage notes

• The resulting Geometry is not checked for validity. If validity needs to be enforced, the new Geometry's IsValid method should be called.
• By default the UserData of the input geometry is not copied to the result.

Constructors

GeometryEditor()

Creates a new GeometryEditor object which will create edited Geometry with the same GeometryFactory as the input Geometry.

public GeometryEditor()

See Also

GeometryTransformer

IsValid

GeometryEditor(GeometryFactory)

Creates a new GeometryEditor object which will create edited Geometrys with the given GeometryFactory.

public GeometryEditor(GeometryFactory factory)

Parameters

factory GeometryFactory

The GeometryFactory to create the edited Geometry with.

See Also

GeometryTransformer

IsValid

Properties

CopyUserData

Gets or sets a value indicating if the User Data is copied to the edit result. If so, only the object reference is copied.

public bool CopyUserData { get; set; }

Property Value

bool

See Also

GeometryTransformer

IsValid

Methods

Edit(Geometry, IGeometryEditorOperation)

Edit the input Geometry with the given edit operation. Clients can create subclasses of GeometryEditorOperation or CoordinateOperation to perform required modifications.

public Geometry Edit(Geometry geometry, GeometryEditor.IGeometryEditorOperation operation)

Parameters

geometry Geometry

The Geometry to edit.

operation GeometryEditor.IGeometryEditorOperation

The edit operation to carry out.

Returns

Geometry

A new Geometry which is the result of the editing (which may be empty).

See Also

GeometryTransformer

IsValid

See Also

GeometryTransformer

IsValid