Class Segment

constructor

• new Segment(...args): Segment

• Parameters

  • Rest...args:
        | []
        | [Point, Point]
        | [number, number, number, number]
        | [[number, number, number, number]]

    Segment may be constructed by two points, or by array of four numbers, or by four numbers

  Returns Segment

pe

ps

box

• get box(): Box

• Bounding box

  Returns Box

  bounding box of a segment

end

• get end(): Point

• End point

  Returns Point

  end point

length

• get length(): number

• Length of a segment

  Returns number

  length of a segment

name

• get name(): string

• Shape name

  Returns string

  name of the shape

slope

• get slope(): number

• Slope of the line - angle to axe x in radians from 0 to 2PI

  Returns number

  slope in radians from 0 to 2PI

start

• get start(): Point

• Start point

  Returns Point

  start point

vertices

• get vertices(): [Point, Point]

• Start and end point of the segment

  Returns [Point, Point]

  array of start and end point

clone

• clone(): Segment

• Return new cloned instance of segment

  Returns Segment

contains

• contains(pt): boolean

• Check if segment contains point

  Parameters

  • pt: Point

    Query point

  Returns boolean

  true if segment contains point

definiteIntegral

• definiteIntegral(ymin?): number

• Calculate definite integral of the segment over y=ymin.

  Parameters

  • ymin: number = 0.0

  Returns number

  definite integral

distanceTo

• distanceTo(shape): [number, Segment]

• Calculate distance and shortest segment from segment to shape and return as array [distance, shortest segment]

  Parameters

  • shape: Shape<any> | Polygon

    Shape of the one of supported types Point, Line, Circle, Segment, Arc, Polygon or Planar Set

  Returns [number, Segment]

  distance from segment to shape and shortest segment between segment and shape (started at segment, ended at shape)

equalTo

• equalTo(seg): boolean

• Check if segment is equal to other segment

  Parameters

  • seg: Segment

    query segment

  Returns boolean

  true if equals to query segment, false otherwise

intersect

• intersect(shape): Point[]

• Returns array of intersection points between segment and other shape

  Parameters

  • shape: Shape<any>

    Shape of the one of supported types
    

  Returns Point[]

isZeroLength

• isZeroLength(): boolean

• Check if the segment's length is zero.

  Returns boolean

  true if segment start is equal to segment end up to DP_TOL

middle

• middle(): Point

• Get middle point

  Returns Point

  middle point of the segment

pointAtLength

• pointAtLength(length): Point

• Get point at given length

  Parameters

  • length: number

    The length along the segment

  Returns Point

  point at given length

reverse

• reverse(): Segment

• Reverse segment

  Returns Segment

  new segment with swapped start and end points

sortPoints

• sortPoints(pts): Point[]

• Sort given array of points from segment start to end, assuming all points lay on the segment

  Parameters

  • pts: Point[]

    array of points

  Returns Point[]

  new array sorted

split

• split(pt): [] | [Segment, Segment] | [Segment]

• When point belongs to segment, return array of two segments split by given point, if point is inside segment. Returns clone of this segment if query point is incident to start or end point of the segment. Returns empty array if point does not belong to segment

  Parameters

  • pt: Point

    Query point

  Returns [] | [Segment, Segment] | [Segment]

tangentInEnd

• tangentInEnd(): Vector

• Get normalized vector of tagent line on end point

  Returns Vector

  unit vector in the direction from end to start

tangentInStart

• tangentInStart(): Vector

• Get normalized vector of tagent line on start point

  Returns Vector

  unit vector in the direction from start to end

transform

• transform(matrix?): Segment

• Return new segment transformed using affine transformation matrix

  Parameters

  • matrix: Matrix = ...

    affine transformation matrix

  Returns Segment

  transformed segment