Class Vertex

Classdesc

A vertex is a pair of two numbers.

It is used to identify a 2-dimensional point on the x-y-plane.

Requires

IVertexAttr

Requires

SVGSerializable

Requires

UID

Requires

UIDGenerator

Requires

VertexAttr

Requires

VertexListeners

Requires

XYCoords

Implements

Index

Constructors

constructor

Properties

attr className isDestroyed listeners uid x y EPSILON ZERO utils

Constructors

constructor

new Vertex(x?, y?): Vertex
The constructor for the vertex class.
Parameters
- Optional x: number | XYCoords
  The x-coordinate of the new vertex.
- Optional y: number
  The y-coordinate of the new vertex.
Returns Vertex
Name
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:130

Properties

attr

attr: IVertexAttr

Member

Memberof

Instance

`Readonly` className

className: string = "Vertex"

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

isDestroyed

isDestroyed: boolean

Member

isDestroyed

Memberof

Vertex

Instance

listeners

listeners: VertexListeners

Member

Memberof

Instance

`Readonly` uid

uid: string

The UID of this drawable object.

Member

Memberof

Vertex

Instance

x

x: number

Member

Memberof

Vertex

Instance

y

y: number

Member

Memberof

Vertex

Instance

`Static` `Readonly` `Private` EPSILON

EPSILON: 0.000001 = 1.0e-6

An epsilon for comparison

`Static` `Private` `Readonly` ZERO

ZERO: Vertex = ...

`Static` utils

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

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[]
arrayToJSON:function
- arrayToJSON(vertices, precision?): string
- Convert the given vertices (array) to a JSON string.
  Parameters
  - vertices: XYCoords[]
  - Optional precision: number
    (optional) The numeric precision to be used (number of precision digits).
  Returns string
  - Defined in plotboilerplate/src/ts/Vertex.ts:722

Methods

abs

abs(): Vertex
Set both coordinates of this vertex to their absolute value (abs(x), abs(y)).

Returns Vertex
this

Method
abs

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:621

add

add(x, y?): Vertex
Add the passed amount to x- and y- component of this vertex.

This function works with add( {number}, {number} ) and add( {Vertex} ), as well.
Parameters
- x: number | XYCoords
  The amount to add to x (or a vertex itself).
- Optional y: number
  The amount to add to y.
Returns Vertex
this

Method
add

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:254

addX

addX(amountX): Vertex
Add the passed amounts to the x-component of this vertex.
Parameters
- amountX: number
Returns Vertex
this

Method
addX

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:298

addXY

addXY(amountX, amountY): Vertex
Add the passed amounts to the x- and y- components of this vertex.
Parameters
- amountX: number
- amountY: number
Returns Vertex
this

Method
addXY

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:283

addY

addY(amountY): Vertex
Add the passed amounts to the y-component of this vertex.
Parameters
- amountY: number
Returns Vertex
this

Method
addY

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:312

angle

angle(origin?): number
Get the angle of this point (relative to (0,0) or to the given other origin point).
Parameters
- Optional origin: XYCoords
  The vertex to measure the angle from.
Returns number
Method
angle

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:445

clone

clone(): Vertex
Create a copy of this vertex.

Returns Vertex
A new vertex, an exact copy of this.

Method
clone

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:419

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
- Defined in plotboilerplate/src/ts/Vertex.ts:648

difference

difference(vert): Vertex
Get the difference to the passed point.

The difference is (vert.x-this.x, vert.y-this.y).
Parameters
- vert: XYCoords
  The vertex to measure the x-y-difference to.
Returns Vertex
A new vertex.

Method
difference

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:465

distance

distance(vert): number
Get the distance to the passed point (in euclidean metric)
Parameters
- vert: XYCoords
  The vertex to measure the distance to.
Returns number
Method
distance

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:432

equals

equals(vertex): boolean
Check if this vertex equals the passed one.
This function uses an internal epsilon as tolerance.
Parameters
- vertex: XYCoords
  The vertex to compare this with.
Returns boolean
Method
equals

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:404

inv

inv(): Vertex
Change this vertex (x,y) to its inverse (-x,-y).

Returns Vertex
this

Method
inv

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:607

invX

invX(): Vertex
Set the x-component if this vertex to the inverse of its value.

Returns Vertex
this

Method
invX

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:223

invY

invY(): Vertex
Set the y-component if this vertex to the inverse of its value.

Returns Vertex
this

Method
invY

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:236

lerp

lerp(target, t): Vertex
Perform a linear interpolation towards the given target vertex. The amount value t is relative, t=0.0 means no change, t=1.0 means this point will be moved to the exact target position.

t=0.5 will move this point to the middle of the connecting linear segment.
Parameters
- target: XYCoords
  The target position to lerp this vertex to.
- t: number
  The relative amount, usually in [0..1], but other values will work, too.
Returns Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:496

lerpAbs

lerpAbs(target, u): Vertex
Perform a linear interpolation towards the given target vertex (absolute variant). The amount value t is absolute, which means the lerp amount is a direct distance value. This point will have move the amount of the passed distance u.
Parameters
- target: XYCoords
  The target position to lerp this vertex to.
- u: number
Returns Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:513

multiplyScalar

multiplyScalar(scalar): Vertex
Multiply both components of this vertex with the given scalar.

Note: as in
https://threejs.org/docs/#api/math/Vector2.multiplyScalar
Parameters
- scalar: number
  The scale factor; 1.0 means no change.
Returns Vertex
this

Method
multiplyScalar

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:579

rotate

rotate(angle, center): Vertex
This is a vector-like behavior and 'rotates' this vertex around given center.
Parameters
- angle: number
  The angle to 'rotate' this vertex; 0.0 means no change.
- center: XYCoords
  The center of rotation; default is (0,0).
Returns Vertex
this

Method
rotate

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:554

round

round(): Vertex
Round the two components x and y of this vertex.

Returns Vertex
this

Method
round

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:593

scale

scale(factor, center?): Vertex
This is a vector-like behavior and 'scales' this vertex towards/from a given center by one uniform scale factor.
Parameters
- factor: number
  The factor to 'scale' this vertex; 1.0 means no change.
- Optional center: XYCoords
  The origin of scaling; default is (0,0).
Returns Vertex
this

Method
scale

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:480

scaleXY

scaleXY(factors, center?): Vertex
This is a vector-like behavior and 'scales' this vertex towards/from a given center by two independent x- and y- scale factors.
Parameters
- factors: XYCoords
- Optional center: XYCoords
  The origin of scaling; default is (0,0).
Returns Vertex
this

Method
scale

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:534

set

set(x, y?): Vertex
Set the x- and y- component of this vertex.
Parameters
- x: number | XYCoords
  The new x-component.
- Optional y: number
  The new y-component.
Returns Vertex
this

Method
set

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:166

setX

setX(x): Vertex
Set the x-component of this vertex.
Parameters
- x: number
  The new x-component.
Returns Vertex
this

Method
setX

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:196

setY

setY(y): Vertex
Set the y-component of this vertex.
Parameters
- y: number
  The new y-component.
Returns Vertex
this

Method
setY

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:210

sub

sub(x, y?): Vertex
Substract the passed amount from x- and y- component of this vertex.

This function works with sub( {number}, {number} ) and sub( {Vertex} ), as well.
Parameters
- x: number | XYCoords
  The amount to substract from x (or a vertex itself).
- Optional y: number
  The amount to substract from y.
Returns Vertex
this

Method
sub

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:330

subX

subX(amountX): Vertex
Substract the passed amounts from the x-component of this vertex.
Parameters
- amountX: number
Returns Vertex
this

Method
addX

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:374

subXY

subXY(amountX, amountY): Vertex
Substract the passed amounts from the x- and y- components of this vertex.
Parameters
- amountX: number
- amountY: number
Returns Vertex
this

Method
subXY

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:359

subY

subY(amountY): Vertex
Substract the passed amounts from the y-component of this vertex.
Parameters
- amountY: number
Returns Vertex
this

Method
subY

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:388

toString

toString(precision?): string
Get a string representation of this vertex.
Parameters
- Optional precision: number
Returns string
The string representation of this vertex.

Method
toString

Instance
Memberof
Vertex
- Defined in plotboilerplate/src/ts/Vertex.ts:635

`Static` randomVertex

randomVertex(viewPort): Vertex
Create a new random vertex inside the given viewport.
Parameters
- viewPort: {
  max: XYCoords;
  min: XYCoords;
  }
  A {min:Vertex, max:Vertex} viewport specifying the bounds.
  - max: XYCoords
  - min: XYCoords
Returns Vertex
A new vertex with a random position.
- Defined in plotboilerplate/src/ts/Vertex.ts:659

Class Vertex

Classdesc

Requires

Requires

Requires

Requires

Requires

Requires

Requires

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Vertex

Name

Properties

attr

Member

Memberof

Instance

Readonly className

isDestroyed

Member

Memberof

Instance

listeners

Member

Memberof

Instance

Readonly uid

Member

Memberof

Instance

x

Member

Memberof

Instance

y

Member

Memberof

Instance

Static Readonly Private EPSILON

Static Private Readonly ZERO

Static utils

Type declaration

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

Parameters

Returns Vertex[]

arrayToJSON:function

Parameters

Returns string

Methods

abs

Returns Vertex

Method

Instance

Memberof

add

Parameters

Returns Vertex

Method

Instance

Memberof

addX

Parameters

Returns Vertex

Method

Instance

Memberof

addXY

Parameters

Returns Vertex

Method

Instance

Memberof

addY

`Readonly` className

`Readonly` uid

`Static` `Readonly` `Private` EPSILON

`Static` `Private` `Readonly` ZERO

`Static` utils