bitbybit.dev v1.0.0-rc.1
    Preparing search index...

    Class Line

    Index

    Constructors

    convert

    • Converts line object to segment array format. Example: {start:[0,0,0], end:[10,5,0]} → [[0,0,0], [10,5,0]]

      Parameters

      Returns Segment3

      segment

      line to segment

      false

    • Converts multiple line objects to segment array format (batch conversion). Example: 3 line objects → 3 segment arrays [[start1, end1], [start2, end2], ...]

      Parameters

      Returns Segment3[]

      segments

      lines to segments

      false

    • Converts segment array to line object format. Example: [[0,0,0], [10,5,0]] → {start:[0,0,0], end:[10,5,0]}

      Parameters

      Returns Line3

      line

      segment to line

      true

    • Converts multiple segment arrays to line object format (batch conversion). Example: 3 segment arrays → 3 line objects with start/end properties

      Parameters

      Returns Line3[]

      lines

      segments to lines

      true

    create

    • Creates a line from two points (line object with start and end properties). Example: start=[0,0,0], end=[10,5,0] → {start:[0,0,0], end:[10,5,0]}

      Parameters

      Returns Line3

      line

      line

      true

    • Creates a segment from two points (array format: [start, end]). Example: start=[0,0,0], end=[10,5,0] → [[0,0,0], [10,5,0]]

      Parameters

      Returns Segment3

      segment

      segment

      true

    • Creates line segments connecting consecutive points in a list (forms a polyline path). Example: points=[[0,0,0], [5,0,0], [5,5,0]] → 2 lines: [0→5] and [5→5,5]

      Parameters

      Returns Line3[]

      lines

      lines between points

      true

    • Creates lines by pairing corresponding start and end points from two arrays. Filters out zero-length lines. Example: starts=[[0,0,0], [5,0,0]], ends=[[0,5,0], [5,5,0]] → 2 lines connecting paired points

      Parameters

      Returns Line3[]

      lines

      start and end points to lines

      true

    get

    • Extracts start point from a line. Example: line={start:[0,0,0], end:[10,5,0]} → [0,0,0]

      Parameters

      Returns Point3

      start point

      line start point

      true

    • Extracts end point from a line. Example: line={start:[0,0,0], end:[10,5,0]} → [10,5,0]

      Parameters

      Returns Point3

      end point

      line end point

      true

    • Calculates length (distance) of a line segment. Example: line={start:[0,0,0], end:[3,4,0]} → 5 (using Pythagorean theorem)

      Parameters

      Returns number

      line length

      line length

      false

    • Calculates point at parameter t along line segment (0=start, 1=end, linear interpolation). Example: line={start:[0,0,0], end:[10,0,0]}, param=0.5 → [5,0,0] (midpoint)

      Parameters

      Returns Point3

      point on line

      point on line

      true

    intersection

    • Calculates intersection point of two lines (or segments if checkSegmentsOnly=true). Returns undefined if lines are parallel, skew, or segments don't overlap. Example: line1={start:[0,0,0], end:[10,0,0]}, line2={start:[5,-5,0], end:[5,5,0]} → [5,0,0]

      Parameters

      Returns Point3

      intersection point or undefined if no intersection

      line-line int

      true

    operations

    • Reverses line direction by swapping start and end points. Example: line={start:[0,0,0], end:[10,5,0]} → {start:[10,5,0], end:[0,0,0]}

      Parameters

      Returns Line3

      reversed line

      reversed line

      true

    transforms

    • Applies transformation matrix to line (rotates, scales, or translates both endpoints). Example: line={start:[0,0,0], end:[10,0,0]} with translation [5,5,0] → {start:[5,5,0], end:[15,5,0]}

      Parameters

      Returns Line3

      transformed line

      transform line

      true

    • Applies multiple transformations to multiple lines (one transform per line). Example: 3 lines with 3 different translation matrices → each line moved independently

      Parameters

      Returns Line3[]

      transformed lines

      transform lines

      true