Class: Line

new Line(begin, end)

Line shape.

Parameters:

Name	Type	Description
`begin`	dwv.math.Point2D	A Point2D representing the beginning of the line.
`end`	dwv.math.Point2D	A Point2D representing the end of the line.

Source: src/math/line.js, line 13

Methods

equals(rhs) → {boolean}

Check for equality.

Parameters:

Name	Type	Description
`rhs`	dwv.math.Line	The object to compare to.

Source: src/math/line.js, line 39

Returns:

True if both objects are equal.

Type:: boolean

getBegin() → {dwv.math.Point2D}

Get the begin point of the line.

Source: src/math/line.js, line 19

Returns:

The beginning point of the line.

Type:: dwv.math.Point2D

getDeltaX() → {number}

Get the line delta in the X direction.

Source: src/math/line.js, line 50

Returns:

The delta in the X direction.

Type:: number

getDeltaY() → {number}

Get the line delta in the Y direction.

Source: src/math/line.js, line 59

Returns:

The delta in the Y direction.

Type:: number

getEnd() → {dwv.math.Point2D}

Get the end point of the line.

Source: src/math/line.js, line 28

Returns:

The ending point of the line.

Type:: dwv.math.Point2D

getInclination() → {number}

Get the inclination of the line.

Source: src/math/line.js, line 131

Returns:

The inclination of the line.

Type:: number

getIntercept() → {number}

Get the intercept of the line.

Source: src/math/line.js, line 119

Returns:

The slope of the line.

Type:: number

getLength() → {number}

Get the length of the line.

Source: src/math/line.js, line 68

Returns:

The length of the line.

Type:: number

getMidpoint() → {dwv.math.Point2D}

Get the mid point of the line.

Source: src/math/line.js, line 98

Returns:

The mid point of the line.

Type:: dwv.math.Point2D

getSlope() → {number}

Get the slope of the line.

Source: src/math/line.js, line 110

Returns:

The slope of the line.

Type:: number

getWorldLength(spacingX, spacingY) → {number}

Get the length of the line according to a spacing.

Parameters:

Name	Type	Description
`spacingX`	number	The X spacing.
`spacingY`	number	The Y spacing.

Source: src/math/line.js, line 83

Returns:

The length of the line with spacing or null for null spacings.

Type:: number

quantify(viewController) → {object}

Quantify a line according to view information.

Parameters:

Name	Type	Description
`viewController`	object	The associated view controller.

Source: src/math/line.js, line 222

Returns:

A quantification object.

Type:: object