Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Line

Index

Constructors

constructor

Methods

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]}

    group

    create

    shortname

    line

    drawable

    true

    Parameters

    Returns Line3

    line

createSegment

  • 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]]

    group

    create

    shortname

    segment

    drawable

    true

    Parameters

    Returns Segment3

    segment

getEndPoint

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

    group

    get

    shortname

    line end point

    drawable

    true

    Parameters

    Returns Point3

    end point

getPointOnLine

  • 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)

    group

    get

    shortname

    point on line

    drawable

    true

    Parameters

    Returns Point3

    point on line

getStartPoint

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

    group

    get

    shortname

    line start point

    drawable

    true

    Parameters

    Returns Point3

    start point

length

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

    group

    get

    shortname

    line length

    drawable

    false

    Parameters

    Returns number

    line length

lineLineIntersection

  • 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]

    group

    intersection

    shortname

    line-line int

    drawable

    true

    Parameters

    Returns Point3

    intersection point or undefined if no intersection

lineToSegment

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

    group

    convert

    shortname

    line to segment

    drawable

    false

    Parameters

    Returns Segment3

    segment

linesBetweenPoints

  • 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]

    group

    create

    shortname

    lines between points

    drawable

    true

    Parameters

    Returns Line3[]

    lines

linesBetweenStartAndEndPoints

  • 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

    group

    create

    shortname

    start and end points to lines

    drawable

    true

    Parameters

    Returns Line3[]

    lines

linesToSegments

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

    group

    convert

    shortname

    lines to segments

    drawable

    false

    Parameters

    Returns Segment3[]

    segments

reverse

  • 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]}

    group

    operations

    shortname

    reversed line

    drawable

    true

    Parameters

    Returns Line3

    reversed line

segmentToLine

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

    group

    convert

    shortname

    segment to line

    drawable

    true

    Parameters

    Returns Line3

    line

segmentsToLines

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

    group

    convert

    shortname

    segments to lines

    drawable

    true

    Parameters

    Returns Line3[]

    lines

transformLine

  • 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]}

    group

    transforms

    shortname

    transform line

    drawable

    true

    Parameters

    Returns Line3

    transformed line

transformsForLines

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

    group

    transforms

    shortname

    transform lines

    drawable

    true

    Parameters

    Returns Line3[]

    transformed lines

Generated using TypeDoc