Class Vector

Classdesc

A vector (Vertex,Vertex) is a line with a visible direction.

Vectors are drawn with an arrow at their end point.
The Vector class extends the Line class.

Requires

VertTuple

Requires

Vertex

Hierarchy (view full)

VertTuple<Vector>
- Vector

Implements

SVGSerializable

Index

Constructors

constructor

Properties

a b className isDestroyed uid utils vtutils

Constructors

constructor

new Vector(vertA, vertB): Vector
The constructor.
Parameters
- vertA: Vertex
  The start vertex of the vector.
- vertB: Vertex
  The end vertex of the vector.
Returns Vector
Name
Vector
Overrides VertTuple.constructor
- Defined in plotboilerplate/src/ts/Vector.ts:49

Properties

a

a: Vertex

Member

Memberof

VertTuple

Instance

b

b: Vertex

Member

Memberof

VertTuple

Instance

`Readonly` className

className: string = "Vector"

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

isDestroyed

isDestroyed: boolean

Member

isDestroyed

Memberof

VertTuple

Instance

`Readonly` uid

uid: string

The UID of this drawable object.

Member

Memberof

VertTuple

Instance

`Static` utils

utils: {
buildArrowHead: ((zA, zB, headlen, scaleX, scaleY) => Vertex[]);
} = ...

Type declaration

buildArrowHead: ((zA, zB, headlen, scaleX, scaleY) => Vertex[])
Generate a four-point arrow head, starting at the vector end minus the arrow head length.

The first vertex in the returned array is guaranteed to be the located at the vector line end minus the arrow head length.

Due to performance all params are required.

The params scaleX and scaleY are required for the case that the scaling is not uniform (x and y scaling different). Arrow heads should not look distored on non-uniform scaling.

If unsure use 1.0 for scaleX and scaleY (=no distortion). For headlen use 8, it's a good arrow head size.

Example: buildArrowHead( new Vertex(0,0), new Vertex(50,100), 8, 1.0, 1.0 )
- - (zA, zB, headlen, scaleX, scaleY): Vertex[]
  - Parameters
    - zA: XYCoords
      The start vertex of the vector to calculate the arrow head for.
    - zB: XYCoords
      The end vertex of the vector.
    - headlen: number
      The length of the arrow head (along the vector direction. A good value is 12).
    - scaleX: number
      The horizontal scaling during draw.
    - scaleY: number
      the vertical scaling during draw.
    Returns Vertex[]

`Static` `Private` vtutils

vtutils: {
dist2: ((v, w) => number);
} = ...

Type declaration

dist2: ((v, w) => number)
- - (v, w): number
  - Parameters
    - v: XYCoords
    - w: XYCoords
    Returns number

Methods

add

add(amount): VertTuple<Vector>
Add the given vertex to this line's end points.
Parameters
- amount: XYCoords
  The amount (x,y) to add.
Returns VertTuple<Vector>
this

Method
add

Instance
Memberof
VertTuple
Inherited from VertTuple.add
- Defined in plotboilerplate/src/ts/VertTuple.ts:130

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
Inherited from VertTuple.angle
- Defined in plotboilerplate/src/ts/VertTuple.ts:188

clone

clone(): Vector
Create a deep clone of this instance.

Returns Vector
A type safe clone if this instance.

Method
cloneLine

Instance
Memberof
VertTuple
Inherited from VertTuple.clone
- Defined in plotboilerplate/src/ts/VertTuple.ts:339

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<Vector>
Returns boolean
true if both lines are co-linear.

Method
colinear

Instance
Memberof
VertTuple
Inherited from VertTuple.colinear
- Defined in plotboilerplate/src/ts/VertTuple.ts:243

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<Vector>
Returns number
Method
denominator

Instance
Memberof
VertTuple
Inherited from VertTuple.denominator
- Defined in plotboilerplate/src/ts/VertTuple.ts:227

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
Inherited from VertTuple.destroy
- Defined in plotboilerplate/src/ts/VertTuple.ts:360

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
Inherited from VertTuple.getClosestPoint
- Defined in plotboilerplate/src/ts/VertTuple.ts:311

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
Inherited from VertTuple.getClosestT
- Defined in plotboilerplate/src/ts/VertTuple.ts:259

getOrthogonal

getOrthogonal(): Vector
Get the orthogonal "vector" of this vector (rotated by 90° clockwise).

Returns Vector
A new vector with the same length that stands on this vector's point a.

Name
getOrthogonal

Method
getOrthogonal

Instance
Memberof
Vector
- Defined in plotboilerplate/src/ts/Vector.ts:129

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
Inherited from VertTuple.hasPoint
- Defined in plotboilerplate/src/ts/VertTuple.ts:281

intersection

intersection(line): Vertex
Get the intersection if this vector and the specified vector.
Parameters
- line: Vector
  The second vector.
Returns Vertex
The intersection (may lie outside the end-points).

Method
intersection

Instance
Memberof
Line
- Defined in plotboilerplate/src/ts/Vector.ts:102

inv

inv(): Vector
This function computes the inverse of the vector, which means 'a' stays untouched.

Returns Vector
this for chaining.
- Defined in plotboilerplate/src/ts/Vector.ts:87

inverse

inverse(): Vector
The inverse of a vector is a vector with the same magnitude but oppose direction.

Please not that the origin of this vector changes here: a->b becomes b->a.

Returns Vector
- Defined in plotboilerplate/src/ts/Vector.ts:75

length

length(): number
Get the length of this line.

Returns number
Method
length

Instance
Memberof
VertTuple
Inherited from VertTuple.length
- Defined in plotboilerplate/src/ts/VertTuple.ts:89

moveTo

moveTo(newA): VertTuple<Vector>
Move this line to a new location.
Parameters
- newA: Vertex
  The new desired location of 'a'. Vertex 'b' will be moved, too.
Returns VertTuple<Vector>
this

Method
moveTo

Instance
Memberof
VertTuple
Inherited from VertTuple.moveTo
- Defined in plotboilerplate/src/ts/VertTuple.ts:172

normalize

normalize(): VertTuple<Vector>
Normalize this line (set to length 1).

Returns VertTuple<Vector>
this

Method
normalize

Instance
Memberof
VertTuple
Inherited from VertTuple.normalize
- Defined in plotboilerplate/src/ts/VertTuple.ts:144

perp

perp(): Vector
Get the perpendicular of this vector which is located at a.

Returns Vector
A new vector being the perpendicular of this vector sitting on a.
- Defined in plotboilerplate/src/ts/Vector.ts:59

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
Inherited from VertTuple.pointDistance
- Defined in plotboilerplate/src/ts/VertTuple.ts:325

scale

scale(factor): VertTuple<Vector>
Scale this line by the given factor.
Parameters
- factor: number
  The factor for scaling (1.0 means no scale).
Returns VertTuple<Vector>
this

Method
scale

Instance
Memberof
VertTuple
Inherited from VertTuple.scale
- Defined in plotboilerplate/src/ts/VertTuple.ts:158

setLength

setLength(length): VertTuple<Vector>
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<Vector>
this (for chaining)

Method
setLength

Memberof
VertTuple
Inherited from VertTuple.setLength
- Defined in plotboilerplate/src/ts/VertTuple.ts:102

sub

sub(amount): VertTuple<Vector>
Substract the given vertex from this line's end points.
Parameters
- amount: XYCoords
  The amount (x,y) to substract.
Returns VertTuple<Vector>
this

Method
sub

Instance
Memberof
VertTuple
Inherited from VertTuple.sub
- Defined in plotboilerplate/src/ts/VertTuple.ts:115

toString

toString(): string
Create a string representation of this line.

Returns string
The string representing this line.

Method
totring

Instance
Memberof
VertTuple
Inherited from VertTuple.toString
- Defined in plotboilerplate/src/ts/VertTuple.ts:351

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
Inherited from VertTuple.vertAt
- Defined in plotboilerplate/src/ts/VertTuple.ts:212

Class Vector

Classdesc

Requires

Requires

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Vector

Name

Properties

a

Member

Memberof

Instance

b

Member

Memberof

Instance

Readonly className

isDestroyed

Member

Memberof

Instance

Readonly uid

Member

Memberof

Instance

Static utils

Type declaration

buildArrowHead: ((zA, zB, headlen, scaleX, scaleY) => Vertex[])

Parameters

Returns Vertex[]

Static Private vtutils

Type declaration

dist2: ((v, w) => number)

Parameters

Returns number

Methods

add

Parameters

Returns VertTuple<Vector>

Method

Instance

Memberof

angle

Parameters

Returns number

Method

Instance

Memberof

clone

Returns Vector

Method

Instance

Memberof

colinear

Parameters

Returns boolean

Method

Instance

Memberof

denominator

Parameters

Returns number

Method

Instance

Memberof

destroy

Returns void

getClosestPoint

Parameters

Returns Vertex

Method

Instance

`Readonly` className

`Readonly` uid

`Static` utils

`Static` `Private` vtutils