LineSegment Class

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

Inheritance Hierarchy

SystemObject
Accord.Math.GeometryLineSegment

Namespace: Accord.Math.Geometry
Assembly: Accord.Math (in Accord.Math.dll) Version: 3.8.0

Syntax

Copy

public sealed class LineSegment

Public NotInheritable Class LineSegment

Request Example View Source

The LineSegment type exposes the following members.

Constructors

	Name	Description
	LineSegment	Initializes a new instance of the LineSegment class.

Top

Properties

	Name	Description
	End	End point of the line segment.
	Length	Get segment's length - Euclidean distance between its Start and End points.
	Start	Start point of the line segment.

Top

Methods

	Name	Description
	DistanceToPoint	Calculate Euclidean distance between a point and a finite line segment.
	Equals	Check if this instance of LineSegment equals to the specified one. (Overrides ObjectEquals(Object).)
	GetHashCode	Get hash code for this instance. (Overrides ObjectGetHashCode.)
	GetIntersectionWith(Line)	Finds, provided it exists, the intersection point with the specified Line.
	GetIntersectionWith(LineSegment)	Finds, provided it exists, the intersection point with the specified LineSegment.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Get string representation of the class. (Overrides ObjectToString.)

Top

Operators

	Name	Description
	Equality	Equality operator - checks if two line segments have equal parameters.
	(LineSegment to Line)	Converts this LineSegment to a Line by discarding its endpoints and extending it infinitely in both directions.
	Inequality	Inequality operator - checks if two lines have different parameters.

Top

Extension Methods

	Name	Description
	HasMethod	Checks whether an object implements a method with the given name. (Defined by ExtensionMethods.)
	IsEqual	Compares two objects for equality, performing an elementwise comparison if the elements are vectors or matrices. (Defined by Matrix.)
	To(Type)	Overloaded. Converts an object into another type, irrespective of whether the conversion can be done at compile time or not. This can be used to convert generic types to numeric types during runtime. (Defined by ExtensionMethods.)
	ToT	Overloaded. Converts an object into another type, irrespective of whether the conversion can be done at compile time or not. This can be used to convert generic types to numeric types during runtime. (Defined by ExtensionMethods.)

Top

Remarks

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:

Copy

// 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 ) ) );

Reference

Accord.Math.Geometry Namespace