VertTuple | plotboilerplate

classdesc: An abstract base classes for vertex tuple constructs, like Lines or Vectors.
abstract
requires: UID
requires: Vertex
requires: XYCoords

Type parameters

T: VertTuple<T>

Hierarchy

VertTuple
- Vector
- Line

Index

Constructors

constructor

Properties

Methods

Object literals

vtutils

Constructors

constructor

new VertTuple(a: Vertex, b: Vertex, factory: (a: Vertex, b: Vertex) => T): VertTuple

- Defined in src/ts/VertTuple.ts:63
Creates an instance.

name

VertTuple

Parameters
- a: Vertex
  
  The tuple's first point.
- b: Vertex
  
  The tuple's second point.
- factory: (a: Vertex, b: Vertex) => T
  - - (a: Vertex, b: Vertex): T
    - Parameters
      - a: Vertex
      - b: Vertex
      Returns T
Returns VertTuple

Properties

a

member: {Vertex}
memberof: VertTuple
instance

b

member: {Vertex}
memberof: VertTuple
instance

Private factory

factory: (a: Vertex, b: Vertex) => T

The factory is used by the clone method.

Type declaration

- (a: Vertex, b: Vertex): T
- Parameters
  - a: Vertex
  - b: Vertex
  Returns T

isDestroyed

isDestroyed: boolean

member: isDestroyed
memberof: VertTuple
instance

Readonly uid

uid: UID

The UID of this drawable object.

member: {UID}
memberof: VertTuple
instance
readonly

Methods

add

add(amount: XYCoords): VertTuple<T>

- Defined in src/ts/VertTuple.ts:128
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<T>

this

angle

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

- Defined in src/ts/VertTuple.ts:186
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(): T

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

method

cloneLine

instance

memberof

VertTuple

Returns T

A type safe clone if this instance.

colinear

colinear(line: VertTuple<T>): boolean

- Defined in src/ts/VertTuple.ts:241
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<T>
Returns boolean

true if both lines are co-linear.

denominator

denominator(line: VertTuple<T>): number

- Defined in src/ts/VertTuple.ts:225
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<T>
Returns number

destroy

destroy(): void

- Defined in src/ts/VertTuple.ts:347
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): Vertex

- Defined in src/ts/VertTuple.ts:298
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

- Defined in src/ts/VertTuple.ts:257
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

- Defined in src/ts/VertTuple.ts:278
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.

length

length(): number

- Defined in src/ts/VertTuple.ts:87
Get the length of this line.

method

length

instance

memberof

VertTuple

Returns number

moveTo

moveTo(newA: Vertex): VertTuple<T>

- Defined in src/ts/VertTuple.ts:170
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<T>

this

normalize

normalize(): VertTuple<T>

- Defined in src/ts/VertTuple.ts:142
Normalize this line (set to length 1).

method

normalize

instance

memberof

VertTuple

Returns VertTuple<T>

this

pointDistance

pointDistance(p: Vertex): number

- Defined in src/ts/VertTuple.ts:312
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<T>

- 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<T>

this

setLength

setLength(length: number): VertTuple<T>

- Defined in src/ts/VertTuple.ts:100
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<T>

this (for chaining)

sub

sub(amount: XYCoords): VertTuple<T>

- Defined in src/ts/VertTuple.ts:113
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<T>

this

toString

toString(): string

- Defined in src/ts/VertTuple.ts:338
Create a string representation of this line.

method

totring

instance

memberof

VertTuple

Returns string

The string representing this line.

vertAt

vertAt(t: number): Vertex

- Defined in src/ts/VertTuple.ts:210
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:357
Parameters
- v: XYCoords
- w: XYCoords
Returns number

Generated using TypeDoc