Class VertTuple<T>

constructor

• new VertTuple<T>(a, b, factory): VertTuple<T>

• Creates an instance.

  Type Parameters

  • T extends VertTuple<T>

  Parameters

  • a: Vertex

    The tuple's first point.
  • b: Vertex

    The tuple's second point.
  • factory: ((a, b) => T)
    • • (a, b): T

      • Parameters

        • a: Vertex
        • b: Vertex

        Returns T

  Returns VertTuple<T>

  Name

  VertTuple

a

b

isDestroyed

Readonly uid

add

• add(amount): VertTuple<T>

• Add the given vertex to this line's end points.

  Parameters

  • amount: XYCoords

    The amount (x,y) to add.

  Returns VertTuple<T>

  this

  Method

  add

  Instance

  Memberof

  VertTuple

angle

• angle(line?): number

• Get the angle between this and the passed line (in radians).

  Parameters

  • Optional line: VertTuple<any>

    (optional) The line to calculate the angle to. If null the baseline (x-axis) will be used.

  Returns number

  this

  Method

  angle

  Instance

  Memberof

  VertTuple

clone

• clone(): T

• Create a deep clone of this instance.

  Returns T

  A type safe clone if this instance.

  Method

  cloneLine

  Instance

  Memberof

  VertTuple

colinear

• colinear(line): boolean

• Checks if this and the given line are co-linear.

  The constant Vertex.EPSILON is used for tolerance.

  Parameters

  • line: VertTuple<T>

  Returns boolean

  true if both lines are co-linear.

  Method

  colinear

  Instance

  Memberof

  VertTuple

denominator

• denominator(line): number

• Get the denominator of this and the given line.

  If the denominator is zero (or close to zero) both line are co-linear.

  Parameters

  • line: VertTuple<T>

  Returns number

  Method

  denominator

  Instance

  Memberof

  VertTuple

destroy

• destroy(): void

• This function should invalidate any installed listeners and invalidate this object. After calling this function the object might not hold valid data any more and should not be used.

  Returns void

getClosestPoint

• getClosestPoint(p): Vertex

• Get the closest point on this line to the specified point.

  Parameters

  • p: Vertex

    The point (vertex) to measre the distance to.

  Returns Vertex

  The point on the line that is closest to p.

  Method

  getClosestPoint

  Instance

  Memberof

  VertTuple

getClosestT

• getClosestT(p): number

• Get the closest position T from this line to the specified point.

  The counterpart for this function is Line.vertAt(Number).

  Parameters

  • p: XYCoords

    The point (vertex) to measure the distance to.

  Returns number

  The line position t of minimal distance to p.

  Name

  getClosetT

  Method

  getClosestT

  Instance

  Memberof

  VertTuple

hasPoint

• hasPoint(point, insideBoundsOnly?, epsilon?): boolean

• Check if the given point is located on this line. Optionally also check if that point is located between point a and b.

  Parameters

  • point: XYCoords

    The point to check.
  • Optional insideBoundsOnly: boolean

    [optional] If set to to true (default=false) the point must be between start and end point of the line.
  • Optional epsilon: number

    [optional] A tolerance.

  Returns boolean

  True if the given point is on this line.

  Method

  hasPoint

  Instance

  Memberof

  VertTuple

length

• length(): number

• Get the length of this line.

  Returns number

  Method

  length

  Instance

  Memberof

  VertTuple

moveTo

• moveTo(newA): VertTuple<T>

• Move this line to a new location.

  Parameters

  • newA: Vertex

    The new desired location of 'a'. Vertex 'b' will be moved, too.

  Returns VertTuple<T>

  this

  Method

  moveTo

  Instance

  Memberof

  VertTuple

normalize

• normalize(): VertTuple<T>

• Normalize this line (set to length 1).

  Returns VertTuple<T>

  this

  Method

  normalize

  Instance

  Memberof

  VertTuple

pointDistance

• pointDistance(p): number

• The the minimal distance between this line and the specified point.

  Parameters

  • p: XYCoords

    The point (vertex) to measre the distance to.

  Returns number

  The absolute minimal distance.

  Method

  pointDistance

  Instance

  Memberof

  VertTuple

scale

• scale(factor): VertTuple<T>

• Scale this line by the given factor.

  Parameters

  • factor: number

    The factor for scaling (1.0 means no scale).

  Returns VertTuple<T>

  this

  Method

  scale

  Instance

  Memberof

  VertTuple

setLength

• setLength(length): VertTuple<T>

• Set the length of this vector to the given amount. This only works if this vector is not a null vector.

  Parameters

  • length: number

    The desired length.

  Returns VertTuple<T>

  this (for chaining)

  Method

  setLength

  Memberof

  VertTuple

sub

• sub(amount): VertTuple<T>

• Substract the given vertex from this line's end points.

  Parameters

  • amount: XYCoords

    The amount (x,y) to substract.

  Returns VertTuple<T>

  this

  Method

  sub

  Instance

  Memberof

  VertTuple

toString

• toString(): string

• Create a string representation of this line.

  Returns string

  The string representing this line.

  Method

  totring

  Instance

  Memberof

  VertTuple

vertAt

• vertAt(t): Vertex

• Get line point at position t in [0 ... 1]:
  

  [P(0)]=[A]--------------------[P(t)]------[B]=[P(1)]

  
  
  The counterpart of this function is Line.getClosestT(Vertex).

  Parameters

  • t: number

    The position scalar.

  Returns Vertex

  The vertex a position t.

  Method

  vertAt

  Instance

  Memberof

  VertTuple