Class FacetSequence

Represents a sequence of facets (points or line segments) of a Geometry specified by a subsequence of a CoordinateSequence.

Inheritance

object

FacetSequence

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: NetTopologySuite.Operation.Distance

Assembly: NetTopologySuite.dll

Syntax

public class FacetSequence

Constructors

FacetSequence(CoordinateSequence, int)

Creates a new sequence for a single point from a CoordinateSequence.

Declaration

public FacetSequence(CoordinateSequence pts, int index)

Parameters

Type	Name	Description
CoordinateSequence	pts	The sequence containing the facet point.
int	index	the index of the point

FacetSequence(CoordinateSequence, int, int)

Creates a new sequence of facets based on a CoordinateSequence.

Declaration

public FacetSequence(CoordinateSequence pts, int start, int end)

Parameters

Type	Name	Description
CoordinateSequence	pts	The sequence containing facet points.
int	start	The index of the start point
int	end	The index of the end point + 1

FacetSequence(Geometry, CoordinateSequence, int, int)

Creates a new sequence of facets based on a CoordinateSequence contained in the given Geometry.

Declaration

public FacetSequence(Geometry geom, CoordinateSequence pts, int start, int end)

Parameters

Type	Name	Description
Geometry	geom	The geometry containing the facets.
CoordinateSequence	pts	The sequence containing the facet points.
int	start	The index of the start point.
int	end	The index of the end point.

Properties

Count

Gets the number of coordinates in this facet sequence

Declaration

public int Count { get; }

Property Value

Type	Description
int

Envelope

Gets the envelope of this facet sequence

Declaration

public Envelope Envelope { get; }

Property Value

Type	Description
Envelope

IsPoint

Tests if this facet sequence consists of only one point

Declaration

public bool IsPoint { get; }

Property Value

Type	Description
bool

Methods

Distance(FacetSequence)

Computes the distance between this and another FacetSequence.

Declaration

public double Distance(FacetSequence facetSeq)

Parameters

Type	Name	Description
FacetSequence	facetSeq	The sequence to compute the distance to.

Returns

Type	Description
double	The minimum distance between the sequences.

GetCoordinate(int)

Gets the coordinate at the given index

Declaration

public Coordinate GetCoordinate(int index)

Parameters

Type	Name	Description
int	index	The index

Returns

Type	Description
Coordinate	The coordinate at the given index

NearestLocations(FacetSequence)

Computes the locations of the nearest points between this sequence and another sequence. The locations are presented in the same order as the input sequences.

Declaration

public GeometryLocation[] NearestLocations(FacetSequence facetSeq)

Parameters

Type	Name	Description
FacetSequence	facetSeq

Returns

Type	Description
GeometryLocation[]	A pair of GeometryLocations for the nearest points.

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()