Class CircularString

CircularString class

A multi-vertex curve with circular interpolation between points.

public class CircularString : Curve, ICircularString

Constructors

NameDescription
CircularString()Initializes a new instance of the CircularString class.
CircularString(ICircularString)Initializes a new instance of the CircularString class.
CircularString(IEnumerable<IPoint>)Initializes a new instance of the CircularString class.

Properties

NameDescription
CoordinateDimension { get; }Gets the number of coordinate dimensions for this Geometry.
Count { get; }Gets the number of points in the CircularString.
Dimension { get; }Gets the topological dimension of this Geometry.
override EndPoint { get; }Returns a copy of the end point of the curve.
override GeometryType { get; }Gets the type of the geometry.
override HasCurveGeometry { get; }Gets a value indicating whether this geometry is or contains curve (not linear) geometry.
HasM { get; set; }Gets a value indicating whether this instance has M coordinate.
HasZ { get; set; }Gets a value indicating whether this instance has Z coordinate.
IsClosed { get; }Gets a values indicating whether a curve is closed. A curve is closed if its start point is equal to its end point.
override IsEmpty { get; }Gets a value indicating whether this instance is empty.
IsSimple { get; }Gets a value indicating whether this instance is simple from SFA point of view.
IsValid { get; }Gets a value indicating whether this instance is valid.
Item { get; set; }Gets or sets the IPoint at the specified index.
SpatialReferenceSystem { get; set; }Gets SpatialReferenceSystem of this instance. This property can be null, if SpatialReferenceSystem is unset. Assigning new SpatialReferenceSystem will not perform any coordinate transformation, only reference will change.
override StartPoint { get; }Returns a copy of the starting point of the curve.

Methods

NameDescription
AddPoint(IPoint)Adds a point to the end of the circular string.
AddPoint(double, double)Adds a point to the end of the circular string.
AddPoint(double, double, double)Adds a point to the end of the circular string.
AddPoint(double, double, double, double)Adds a point to the end of the circular string.
AsBinary()Translates this geometry to its Well-Known Binary representation.
AsBinary(WkbVariant)Translates this geometry to its Well-Known Binary representation.
AsImage(Measurement, Measurement, Renderer, VectorSymbolizer)Export this geometry to an image representation.
AsImage(AbstractPath, Measurement, Measurement, Renderer, VectorSymbolizer)Export this geometry to an image representation.
AsImage(string, Measurement, Measurement, Renderer, VectorSymbolizer)Export this geometry to an image representation.
AsText()Translates this geometry to its Well-Known Text representation.
AsText(WktVariant)Translates this geometry to its Well-Known Text representation.
AsText(WktVariant, NumericFormat)Translates this geometry to its Well-Known Text representation.
override Clone()Clones this instance.
CoveredBy(IGeometry)Determines whether this geometry is covered by a specified geometry.
Covers(IGeometry)Determines whether this geometry covers a specified geometry.
Crosses(IGeometry)Determines if this geometry and a specified geometry cross.
Difference(IGeometry)Subtracts a specified geometry from this geometry.
Disjoint(IGeometry)Determines if this geometry is disjoint from a specified geometry.
Equals(ICircularString)Indicates whether the current object is equal to another object of the same type.
override Equals(object)Determines whether the specified object is equal to the current object.
GetArea()Computes the area of this geometry.
GetBuffer(double, int)Computes a buffer region around this geometry.
GetCentroid()Computes the centroid of this geometry.
GetConvexHull()Computes the convex hull of this geometry.
GetDistanceTo(IGeometry)Computes the minimum distance between this geometry and a specified geometry.
GetEnumerator()Returns an enumerator that iterates through the collection.
GetExtent()Computes and returns a bounding extent of this geometry.
override GetHashCode()Serves as the default hash function.
GetLength()Computes the length of this geometry.
Intersection(IGeometry)Builds an intersection between this geometry and a specified geometry.
Intersects(Extent)Determines whether this geometry intersects a specified extent.
Intersects(IGeometry)Determines if this geometry and a specified geometry intersects.
Overlaps(IGeometry)Determines whether this geometry overlap with a specified geometry.
Relate(IGeometry, string)Determines if DE-9IM intersection matrix of this geometry and a specified geometry matches provided pattern.
ReplacePolygonsByLines()Gets polygons represented as lines of this geometry.
override Reverse()Reverses order of points in this CircularString.
RoundM(int)Rounds M coordinate to a specified number of fractional digits.
RoundXY(int)Rounds X and Y coordinates to a specified number of fractional digits.
RoundZ(int)Rounds Z coordinate to a specified number of fractional digits.
override SetEmpty()Makes this Geometry empty.
SpatiallyContains(IGeometry)Determines whether this geometry spatially contains a specified geometry.
SpatiallyEquals(IGeometry)Determines if this geometry spatially equal to a specified geometry.
SymDifference(IGeometry)Builds a symmetric difference between this geometry and a specified geometry.
ToEditable()Gets an editable copy of this geometry. (3 methods)
ToEditable<T>()Gets an editable copy of this geometry.
ToLinearGeometry()Gets approximate or equivalent non-curve version of this geometry using the default tolerance. (2 methods)
ToLinearGeometry(double)Gets approximate or equivalent non-curve version of this geometry using the specified tolerance. (2 methods)
override ToString()Returns a string that represents the current object.
ToSvg()Translates this geometry to Svg representation.
Touches(IGeometry)Determines if this geometry and a specified geometry touch.
Union(IGeometry)Unites this geometry and a specified geometry.
Within(Extent)Determines whether this geometry is within a specified extent.
Within(IGeometry)Determines whether this geometry is within a specified geometry.
operator ==Implements the operator ==.
operator !=Implements the operator !=.

Remarks

The CircularString consists of one or more circular arc segments connected end to end. The first three points define the first segment. The first point is the start point of the arc. The second point is any intermediate point on the arc other than the start or end point. The third point is the end of the arc. Subsequent arcs are defined by their intermediate and end points only, as the start point is implicitly defined as the previous segment’s end point.

See Also