Class LineSegment2

constructor

• new LineSegment2(point1, point2): LineSegment2

• Creates a new LineSegment2 from its endpoints.

  Parameters

  • point1: Vec3

  • point2: Vec3

  Returns LineSegment2

Readonly bbox

Readonly direction

Readonly length

center

• get center(): Vec3

• Returns Vec3

p1

• get p1(): Vec3

• Alias for point1.

  Returns Vec3

p2

• get p2(): Vec3

• Alias for point2.

  Returns Vec3

argIntersectsLineSegment

• argIntersectsLineSegment(lineSegment): number[]

• Returns the parameter values at which lineSegment intersects this shape.

  See also intersectsLineSegment

  Parameters

  • lineSegment: LineSegment2

  Returns number[]

at

• at(t): Vec3

• Returns a point a fraction, t, along this line segment. Thus, segment.at(0) returns segment.p1 and segment.at(1) returns segment.p2.

  t should be in [0, 1].

  Parameters

  • t: number

  Returns Vec3

closestPointTo

• closestPointTo(target): Vec3

• Returns the closest point on this to [target]

  Parameters

  • target: Vec3

  Returns Vec3

eq

• eq(other, options?): boolean

• Returns true iff this is equivalent to other.

  Options:

  • tolerance: The maximum difference between endpoints. (Default: 0)
  • ignoreDirection: Allow matching a version of this with opposite direction. (Default: true)

  Parameters

  • other: LineSegment2

  • Optional options: {
        ignoreDirection?: boolean;
        tolerance?: number;
    }

    • Optional ignoreDirection?: boolean

    • Optional tolerance?: number

  Returns boolean

get

• get(t): Vec3

• Gets a point a distance t along this line.

  Parameters

  • t: number

  Returns Vec3

  Deprecated

getTightBoundingBox

• getTightBoundingBox(): Rect2

• Returns a bounding box that precisely fits the content of this shape.

  Note: This bounding box should aligned with the x/y axes. (Thus, it may be possible to find a tighter bounding box not axes-aligned).

  Returns Rect2

intersection

• intersection(other): null | IntersectionResult

• Returns the intersection of this with another line segment.

  WARNING: The parameter value returned by this method does not range from 0 to 1 and is currently a length. This will change in a future release.

  Parameters

  • other: LineSegment2

  Returns null | IntersectionResult

  Deprecated

intersects

• intersects(other): boolean

• Parameters

  • other: LineSegment2

  Returns boolean

intersectsLineSegment

• intersectsLineSegment(lineSegment): Vec3[]

• Returns the points at which this line segment intersects the given line segment.

  Note that intersects returns whether this line segment intersects another line segment. This method, by contrast, returns the point at which the intersection occurs, if such a point exists.

  Parameters

  • lineSegment: LineSegment2

  Returns Vec3[]

nearestPointTo

• nearestPointTo(target): {
      parameterValue: number;
      point: Vec3;
  }

• Returns the nearest point on this to point and the parameterValue at which that point occurs.

  Parameters

  • target: Vec3

  Returns {
      parameterValue: number;
      point: Vec3;
  }

  • parameterValue: number

  • point: Vec3

normalAt

• normalAt(_t): Vec3

• Computes the unit normal vector at $t$.

  Parameters

  • _t: number

  Returns Vec3

signedDistance

• signedDistance(target): number

• Returns the distance from this line segment to target.

  Because a line segment has no interior, this signed distance is equivalent to the full distance between target and this line segment.

  Parameters

  • target: Vec3

  Returns number

splitAt

• splitAt(t): [LineSegment2] | [LineSegment2, LineSegment2]

• Divides this shape into two separate shapes at parameter value $t$.

  Parameters

  • t: number

  Returns [LineSegment2] | [LineSegment2, LineSegment2]

tangentAt

• tangentAt(_t): Vec3

• Parameters

  • _t: number

  Returns Vec3

toString

• toString(): string

• Returns string

transformedBy

• transformedBy(affineTransfm): LineSegment2

• Returns a copy of this line segment transformed by the given affineTransfm.

  Parameters

  • affineTransfm: Mat33

  Returns LineSegment2

Static ofSmallestContainingPoints

• ofSmallestContainingPoints(points): null | LineSegment2

• Returns the smallest line segment that contains all points in points, or null if no such line segment exists.

  Parameters

  • points: readonly Vec3[]

  Returns null | LineSegment2

  Example

  import {LineSegment2, Vec2} from '@js-draw/math';
  console.log(LineSegment2.ofSmallestContainingPoints([Vec2.of(1, 0), Vec2.of(0, 1)]));