Class LineSegment

An immutable line segment in pixel space.

Hierarchy

LineSegment

Index

Constructors

Properties

color end start

Methods

equalValue length fromCoordinates

Constructors

constructor

new LineSegment(start: Point, end: Point, color: PenColor): LineSegment
Construct a line segment from start and end points.
Parameters
- start: Point
  
  one end of the line segment
- end: Point
  
  the other end of the line segment
- color: PenColor
  
  line segment color
Returns LineSegment

Properties

`Readonly` color

color: PenColor

line segment color

`Readonly` end

end: Point

the other end of the line segment

`Readonly` start

start: Point

one end of the line segment

Methods

equalValue

equalValue(that: LineSegment): boolean
Returns
true iff this and that represent the same line segment
Parameters
- that: LineSegment
  
  line segment to compare this with
Returns boolean

length

length(): number
Compute the length of this segment.

Returns
the length of the line segment

Returns number

`Static` fromCoordinates

fromCoordinates(startx: number, starty: number, endx: number, endy: number, color: PenColor): LineSegment
Construct a line segment from coordinate pairs.

Returns
line segment from (startx,starty) to (endx,endy) colored color
Parameters
- startx: number
  
  x-coordinate of start point
- starty: number
  
  y-coordinate of start point
- endx: number
  
  x-coordinate of end point
- endy: number
  
  y-coordinate of end point
- color: PenColor
  
  line segment color
Returns LineSegment

Generated using TypeDoc