Class Vector

Represents a 2D Vector

Hierarchy

Vector

Index

Constructors

constructor

Properties

Accessors

x
y

Methods

Constructors

constructor

new Vector(): Vector
new Vector(x: number, y: number): Vector
new Vector(startPoint: Point, endPoint: Point): Vector

- Defined in lib/geometry.ts:113
Returns Vector
- Defined in lib/geometry.ts:115
Parameters
- x: number
- y: number
Returns Vector
- Defined in lib/geometry.ts:116
Parameters
- startPoint: Point
- endPoint: Point
Returns Vector

Properties

_x

_x: number

_y

_y: number

Static RAD_TO_DEGREES

RAD_TO_DEGREES: number = 180 / Math.PI

Ratio between Radians and degrees

Accessors

x

get x(): number

- Defined in lib/geometry.ts:133
Length of Vector on X-Axis

Returns number

y

get y(): number

- Defined in lib/geometry.ts:138
Length of Vector on Y-Axis

Returns number

Methods

add

add(coordX: number, coordY: number): Vector
add(newVector: Vector): Vector

- Defined in lib/geometry.ts:149
Adds coordinates of a Vector

Parameters
- coordX: number
  
  Addition on X-Axis
- coordY: number
  
  Addition on Y-Axis
Returns Vector

Current Vector
- Defined in lib/geometry.ts:156
Adds coordinates of a Vector

Parameters
- newVector: Vector
  
  Addition on X-Axis
Returns Vector

Current Vector

clone

clone(): Vector

- Defined in lib/geometry.ts:400
Clones current Vector

Returns Vector

A copy of current Vector

getAngle

getAngle(v?: Vector): number

- Defined in lib/geometry.ts:328
Returns the direction of the Vector. A zero-length Vector has an angle of 0

Parameters
- Optional v: Vector
  
  Relative to this vector
Returns number

The direction of the Vector in degrees

getAngleRad

getAngleRad(v?: Vector): number

- Defined in lib/geometry.ts:338
Returns the direction of the Vector. A zero-length Vector has an angle of 0

Parameters
- Optional v: Vector
  
  Relative to this vector
Returns number

The direction of the Vector in radians

getDotProduct

getDotProduct(v: Vector): number

- Defined in lib/geometry.ts:365
Returns the dot product of vectors

Parameters
- v: Vector
  
  Second vector
Returns number

dot product

getLength

getLength(): number

- Defined in lib/geometry.ts:225
Returns length of Vector

Returns number

length (magnitude) of the Vector

getMagnitude

getMagnitude(): number

- Defined in lib/geometry.ts:234
Returns length of Vector (synonym of getLength)

Returns number

length (magnitude) of the Vector

getNormal

getNormal(): Vector

- Defined in lib/geometry.ts:354
Returns a normal Vector

Returns Vector

A new orthogonal Vector

getProjection

getProjection(v: Vector): Vector

- Defined in lib/geometry.ts:373
Returns the orthogonal projection on provided vector

Parameters
- v: Vector
  
  Projection Vector. Resulting Vector is collinear to this one
Returns Vector

isZeroLength

isZeroLength(): boolean

- Defined in lib/geometry.ts:216
Checks if vector is a zero Vector

Returns boolean

true only if the length of the Vector is zero

multiply

multiply(value: number): Vector

- Defined in lib/geometry.ts:272
Multiplies the length of the Vector

Parameters
- value: number
  
  Multiplier
Returns Vector

Current Vector

normalize

normalize(): Vector

- Defined in lib/geometry.ts:243
Changes the length of the Vector to 1

Returns Vector

current Vector

rotate

rotate(degrees: number): Vector

- Defined in lib/geometry.ts:296
Rotates Vector

Parameters
- degrees: number
  
  Rotation angle in degrees
Returns Vector

Current Vector

rotateRad

rotateRad(rad: number): Vector

- Defined in lib/geometry.ts:307
Rotates Vector

Parameters
- rad: number
  
  Rotation angle in radians
Returns Vector

Current Vector

scale

scale(value: number): Vector

- Defined in lib/geometry.ts:285
Multiplies the length of the Vector (synonym of multiply)

Parameters
- value: number
  
  Multiplier
Returns Vector

Current Vector

set

set(newX: number, newY: number): Vector

- Defined in lib/geometry.ts:204
Sets new values for Vector

Parameters
- newX: number
  
  New X-Axis value
- newY: number
  
  New Y-Axis value
Returns Vector

Current Vector

sub

sub(coordX: number, coordY: number): Vector
sub(newVector: Vector): Vector

- Defined in lib/geometry.ts:177
Substracts coordinates of a Vector

Parameters
- coordX: number
  
  Substraction on X-Axis
- coordY: number
  
  Substraction on Y-Axis
Returns Vector

Current Vector
- Defined in lib/geometry.ts:184
Substracts coordinates of a Vector

Parameters
- newVector: Vector
  
  Addition on X-Axis
Returns Vector

Current Vector

truncate

truncate(maxLength: number): Vector

- Defined in lib/geometry.ts:257
Limits the length of a Vector, trucates it if necessary

Parameters
- maxLength: number
  
  The maximum length (magnitude) allowed for the Vector
Returns Vector

current Vector

Generated using TypeDoc