Line | plotboilerplate

classdesc: A line consists of two vertices a and b.

This is some refactored code from my 'Morley Triangle' test
https://github.com/IkarosKappler/morleys-trisector-theorem
requires: Vertex

Hierarchy

VertTuple<Line>
- Line

Implements

SVGSerializable

Index

Constructors

constructor

Properties

Methods

Object literals

vtutils

Constructors

constructor

new Line(a: Vertex, b: Vertex): Line

Overrides VertTuple.constructor
- Defined in src/ts/Line.ts:41
Creates an instance of Line.

name

Line

Parameters
- a: Vertex
  
  The line's first point.
- b: Vertex
  
  The line's second point.
Returns Line

Properties

a

member: {Vertex}
memberof: VertTuple
instance

b

member: {Vertex}
memberof: VertTuple
instance

Readonly className

className: string = "Line"

Required to generate proper CSS classes and other class related IDs.

Readonly uid

uid: UID

The UID of this drawable object.

member: {UID}
memberof: VertTuple
instance
readonly

Methods

add

add(amount: XYCoords): VertTuple<Line>

Inherited from VertTuple.add
- Defined in src/ts/VertTuple.ts:125
Add the given vertex to this line's end points.

method

add

instance

memberof

VertTuple

Parameters
- amount: XYCoords
  
  The amount (x,y) to add.
Returns VertTuple<Line>

this

angle

angle(line?: VertTuple<any>): number

Inherited from VertTuple.angle
- Defined in src/ts/VertTuple.ts:189
Get the angle between this and the passed line (in radians).

method

angle

instance

memberof

VertTuple

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

clone

clone(): Line

Inherited from VertTuple.clone
- Defined in src/ts/VertTuple.ts:339
Create a deep clone of this instance.

method

cloneLine

instance

memberof

VertTuple

Returns Line

A type safe clone if this instance.

colinear

colinear(line: VertTuple<Line>): boolean

Inherited from VertTuple.colinear
- Defined in src/ts/VertTuple.ts:248
Checks if this and the given line are co-linear.

The constant Vertex.EPSILON is used for tolerance.

method

colinear

instance

memberof

VertTuple

Parameters
- line: VertTuple<Line>
Returns boolean

true if both lines are co-linear.

denominator

denominator(line: VertTuple<Line>): number

Inherited from VertTuple.denominator
- Defined in src/ts/VertTuple.ts:231
Get the denominator of this and the given line.

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

method

denominator

instance

memberof

VertTuple

Parameters
- line: VertTuple<Line>
Returns number

getClosestPoint

getClosestPoint(p: Vertex): Vertex

Inherited from VertTuple.getClosestPoint
- Defined in src/ts/VertTuple.ts:308
Get the closest point on this line to the specified point.

method

getClosestPoint

instance

memberof

VertTuple

Parameters
- p: Vertex
  
  The point (vertex) to measre the distance to.
Returns Vertex

The point on the line that is closest to p.

getClosestT

getClosestT(p: XYCoords): number

Inherited from VertTuple.getClosestT
- Defined in src/ts/VertTuple.ts:265
Get the closest position T from this line to the specified point.

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

name

getClosetT

method

getClosestT

instance

memberof

VertTuple

Parameters
- p: XYCoords
  
  The point (vertex) to measure the distance to.
Returns number

The line position t of minimal distance to p.

hasPoint

hasPoint(point: XYCoords, insideBoundsOnly?: boolean): boolean

Inherited from VertTuple.hasPoint
- Defined in src/ts/VertTuple.ts:287
Check if the given point is located on this line. Optionally also check if that point is located between point a and b.

method

hasPoint

instance

memberof

VertTuple

Parameters
- point: XYCoords
  
  The point to check.
- Optional insideBoundsOnly: boolean
  
  If set to to true (default=false) the point must be between start and end point of the line.
Returns boolean

True if the given point is on this line.

intersection

intersection(line: Line): Vertex | undefined

- Defined in src/ts/Line.ts:67
Get the intersection if this line and the specified line.

method

intersection

instance

memberof

Line

Parameters
- line: Line
  
  The second line.
Returns Vertex | undefined

The intersection (may lie outside the end-points) or undefined if both lines are parallel.

length

length(): number

Inherited from VertTuple.length
- Defined in src/ts/VertTuple.ts:81
Get the length of this line.

method

length

instance

memberof

VertTuple

Returns number

moveTo

moveTo(newA: Vertex): VertTuple<Line>

Inherited from VertTuple.moveTo
- Defined in src/ts/VertTuple.ts:172
Move this line to a new location.

method

moveTo

instance

memberof

VertTuple

Parameters
- newA: Vertex
  
  The new desired location of 'a'. Vertex 'b' will be moved, too.
Returns VertTuple<Line>

this

normalize

normalize(): VertTuple<Line>

Inherited from VertTuple.normalize
- Defined in src/ts/VertTuple.ts:140
Normalize this line (set to length 1).

method

normalize

instance

memberof

VertTuple

Returns VertTuple<Line>

this

pointDistance

pointDistance(p: Vertex): number

Inherited from VertTuple.pointDistance
- Defined in src/ts/VertTuple.ts:323
The the minimal distance between this line and the specified point.

method

pointDistance

instance

memberof

VertTuple

Parameters
- p: Vertex
  
  The point (vertex) to measre the distance to.
Returns number

The absolute minimal distance.

scale

scale(factor: number): VertTuple<Line>

Inherited from VertTuple.scale
- Defined in src/ts/VertTuple.ts:156
Scale this line by the given factor.

method

scale

instance

memberof

VertTuple

Parameters
- factor: number
  
  The factor for scaling (1.0 means no scale).
Returns VertTuple<Line>

this

setLength

setLength(length: number): VertTuple<Line>

Inherited from VertTuple.setLength
- Defined in src/ts/VertTuple.ts:95
Set the length of this vector to the given amount. This only works if this vector is not a null vector.

method

setLength

memberof

VertTuple

Parameters
- length: number
  
  The desired length.
Returns VertTuple<Line>

this (for chaining)

sub

sub(amount: XYCoords): VertTuple<Line>

Inherited from VertTuple.sub
- Defined in src/ts/VertTuple.ts:109
Substract the given vertex from this line's end points.

method

sub

instance

memberof

VertTuple

Parameters
- amount: XYCoords
  
  The amount (x,y) to substract.
Returns VertTuple<Line>

this

toSVGString

toSVGString(options: { className?: string }): string

- Defined in src/ts/Line.ts:103
Create an SVG representation of this line.

deprecated

DEPRECATION Please use the drawutilssvg library and an XMLSerializer instead.

method

toSVGString

instance

memberof

Line

Parameters
- options: { className?: string }
  - Optional className?: string
Returns string

The SVG string representing this line.

toString

toString(): string

Inherited from VertTuple.toString
- Defined in src/ts/VertTuple.ts:352
Create a string representation of this line.

method

totring

instance

memberof

VertTuple

Returns string

The string representing this line.

vertAt

vertAt(t: number): Vertex

Inherited from VertTuple.vertAt
- Defined in src/ts/VertTuple.ts:214
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).
method

vertAt

instance

memberof

VertTuple
Parameters
- t: number
  
  The position scalar.
Returns Vertex

The vertex a position t.

Object literals

Static Private vtutils

vtutils: object

dist2

dist2(v: XYCoords, w: XYCoords): number

- Defined in src/ts/VertTuple.ts:361
Parameters
- v: XYCoords
- w: XYCoords
Returns number

Generated using TypeDoc