C# Class Accord.Math.Geometry.LineSegment

The class encapsulates 2D line segment and provides some tool methods related to lines.

The class provides some methods which are related to line segments: distance to point, finding intersection point, etc.

A line segment may be converted to a Line.

Sample usage:

 // create a segment LineSegment segment = new LineSegment( new Point( 0, 0 ), new Point( 3, 4 ) ); // get segment's length float length = segment.Length; // get intersection point with a line Point? intersection = segment.GetIntersectionWith( new Line( new Point( -3, 8 ), new Point( 0, 4 ) ) );

Show file Open project: accord-net/framework Class Usage Examples

Public Methods

Method	Description
DistanceToPoint ( System.Point point ) : float	Calculate Euclidean distance between a point and a finite line segment.
Equals ( object obj ) : bool	Check if this instance of LineSegment equals to the specified one.
GetHashCode ( ) : int	Get hash code for this instance.
GetIntersectionWith ( Line other ) : Point?	Finds, provided it exists, the intersection point with the specified Line. If the line and the segment do not intersect, the method returns . If the line and the segment share multiple points, the method throws an InvalidOperationException.
GetIntersectionWith ( LineSegment other ) : Point?	Finds, provided it exists, the intersection point with the specified LineSegment. If the two segments do not intersect, the method returns . If the two segments share multiple points, this throws an InvalidOperationException.
LineSegment ( System.Point start, System.Point end ) : System	Initializes a new instance of the LineSegment class.
ToString ( ) : string	Get string representation of the class.
operator ( ) : bool	Equality operator - checks if two line segments have equal parameters.

Private Methods

Method	Description
LocateProjection ( System.Point point ) : ProjectionLocation

Method Details

DistanceToPoint() public method

Calculate Euclidean distance between a point and a finite line segment.

public DistanceToPoint ( System.Point point ) : float
point	System.Point	The point to calculate the distance to.
return	float

Equals() public method

Check if this instance of LineSegment equals to the specified one.

public Equals ( object obj ) : bool
obj	object	Another line segment to check equalty to.
return	bool

GetHashCode() public method

Get hash code for this instance.

public GetHashCode ( ) : int
return	int

GetIntersectionWith() public method

Finds, provided it exists, the intersection point with the specified Line.

If the line and the segment do not intersect, the method returns . If the line and the segment share multiple points, the method throws an InvalidOperationException.

Thrown if this segment is a portion of /// line.

public GetIntersectionWith ( Line other ) : Point?
other	Line	to find intersection with.
return	Point?

GetIntersectionWith() public method

Finds, provided it exists, the intersection point with the specified LineSegment.

If the two segments do not intersect, the method returns . If the two segments share multiple points, this throws an InvalidOperationException.

Thrown if the segments overlap - if they have /// multiple points in common.

public GetIntersectionWith ( LineSegment other ) : Point?
other	LineSegment	to find intersection with.
return	Point?

LineSegment() public method

Initializes a new instance of the LineSegment class.

Thrown if the two points are the same.

public LineSegment ( System.Point start, System.Point end ) : System
start	System.Point	Segment's start point.
end	System.Point	Segment's end point.
return	System

ToString() public method

Get string representation of the class.

public ToString ( ) : string
return	string

operator() public static method

Equality operator - checks if two line segments have equal parameters.

public static operator ( ) : bool
return	bool