LineSegment

Show usages

This class represents a line segment in the plane.

Inheritance Hierarchy

LineSegment

Implemented Interfaces

IPlaneObject

Remarks

A line segment is defined by its two end points.

Type Details

yfiles module: algorithms
yfiles-umd modules: All layout modules, view-layout-bridge
Legacy UMD name: yfiles.algorithms.LineSegment

Constructors

LineSegment

(p1: YPoint, p2: YPoint)

Returns a new LineSegment.

Parameters

options - Object
A map of options to pass to the method.

p1 - YPoint: the first end point of the line segment.
p2 - YPoint: the second end point of the line segment.

Properties

boundingBox

: YRectangle

Gets the smallest Rectangle which contains the object.

Implements

IPlaneObject

deltaX

: number

Gets the distance from start to end point in x-coordinates.

deltaY

: number

Gets the distance from start to end point in y-coordinates.

firstEndPoint

: YPoint

Gets the first end point of the line segment.

isHorizontal

: boolean

Gets if this segment is considered horizontal, that is, the y values of the end points differ by at most 1e-8.

isVertical

: boolean

Gets if this segment is considered vertical, that is, the x values of the end points differ by at most 1e-8.

secondEndPoint

: YPoint

Gets the second end point of the line segment.

slope

: number

Gets the slope of the line segment.

xOffset

: number

Gets the y value of the line on x coordinate 0.

Methods

contains

(point: YPoint) : boolean

Checks whether a given point lies on this line segment.

Parameters

options - Object
A map of options to pass to the method.

point - YPoint: an arbitrary point.

Returns

↪boolean: true if the line segments intersects the box, false otherwise.

intersects

(box: YRectangle) : boolean

Checks whether the line segment intersects a box.

Parameters

options - Object
A map of options to pass to the method.

box - YRectangle: A rectangle.

Returns

↪boolean: true if the line segments intersects the box, false otherwise.

intersects

(p: YPoint) : boolean

Checks whether the line segment intersects a point.

Parameters

options - Object
A map of options to pass to the method.

p - YPoint: a point

Returns

↪boolean: true if the line segments intersects the given point, false otherwise.

isInXIntervall

(x: number) : boolean

Returns if the projection on the X axis of the line segment covers a certain point on the X Axis.

isInYIntervall

(y: number) : boolean

Returns if the projection on the Y axis of the line segment covers a certain point on the Y Axis.

length

() : number

Returns the length of the line segment, this is the value of the Euclidean norm.

Returns

↪number: an value > 0.

toAffineLine

() : AffineLine

Returns the affine line defined by the end points of the line segment.

toString

() : string

String representation of the line.

toYVector

() : YVector

Returns the vector pointing from the first end point to the second end point of the line segment.

Static Methods

boxIntersectsSegment

(box: YRectangle, s: YPoint, t: YPoint) : boolean

Checks whether a line segment intersects a box.

Parameters

options - Object
A map of options to pass to the method.

box - YRectangle: A rectangle.
s - YPoint: first end point of the line segment.
t - YPoint: second end point of the line segment.

Returns

↪boolean: true if the line segments intersects the box, false otherwise.

boxIntersectsSegment

(box: YRectangle, x1: number, y1: number, x2: number, y2: number) : boolean

Checks whether a line segment intersects a box.

Remarks

Implemented using the Cohen-Sutherland algorithm.

Parameters

options - Object
A map of options to pass to the method.

box - YRectangle: A rectangle
x1 - number: x-coordinate of the first end point of the line segment
y1 - number: y-coordinate of the first end point of the line segment
x2 - number: x-coordinate of the second end point of the line segment
y2 - number: y-coordinate of the second end point of the line segment

Returns

↪boolean: true if the line segment intersects the box, false otherwise.

boxIntersectsSegment

(boxX1: number, boxY1: number, boxX2: number, boxY2: number, sX1: number, sY1: number, sX2: number, sY2: number) : boolean

Checks whether a line segment intersects a paraxial box.

Remarks

Implemented using the Cohen-Sutherland algorithm.

Parameters

options - Object
A map of options to pass to the method.

boxX1 - number: x-coordinate of the upper left corner of the box
boxY1 - number: y-coordinate of the upper left corner of the box
boxX2 - number: x-coordinate of the lower right corner of the box
boxY2 - number: y-coordinate of the lower right corner of the box
sX1 - number: x-coordinate of the first end point of the line segment
sY1 - number: y-coordinate of the first end point of the line segment
sX2 - number: x-coordinate of the second end point of the line segment
sY2 - number: y-coordinate of the second end point of the line segment

Returns

↪boolean: true if the line segment intersects the box, false otherwise.

getIntersection

(s1: LineSegment, s2: LineSegment) : YPoint

Returns intersection point between the two line segments, if there is one or null if the two line segments do not intersect.

Parameters

options - Object
A map of options to pass to the method.

s1 - LineSegment: first line segment
s2 - LineSegment: second line segment

isHorizontalSegment

(p1: YPoint, p2: YPoint) : boolean

Determines if the given points define a horizontal line segment.

Remarks

This methods allows for y-coordinate differences of up to 1e-8.

Returns

↪boolean: true if the given points define a horizontal line segment; false otherwise.

isVerticalSegment

(p1: YPoint, p2: YPoint) : boolean

Determines if the given points define a vertical line segment.

Remarks

This methods allows for x-coordinate differences of up to 1e-8.

Returns

↪boolean: true if the given points define a vertical line segment; false otherwise.