Computes the shortest spatial distance between two objects.
Namespace:
ceometric.VectorGeometryAssembly: ceometric.VectorGeometry (in ceometric.VectorGeometry.dll) Version: 1.8.0.0 (1.8.0.0)
Syntax
C# |
---|
public double DistanceTo( Edge edge ) |
Visual Basic (Declaration) |
---|
Public Function DistanceTo ( _ edge As Edge _ ) As Double |
Visual C++ |
---|
public: double DistanceTo( Edge^ edge ) |
Parameters
- edge
- Type: ceometric.VectorGeometry..::.Edge
An edge.
Return Value
Returns the shortest spatial distance between the line and edge.Returns 0 if the line intersects the edge.
Remarks
The shortest spatial distance between a line and an edge is either the length of the perpendicular
between the line and the edge or the shorter of the distances from the end points of the edge to the line.
This distance is always positive or zero.