vector2 | jslib-utils

Index

Interfaces

IVector2

Variables

PRECISION

Functions

Variables

Private Const PRECISION

PRECISION: 1000000000 = 1000000000

Functions

add

add(vector1: IVector2, vector2: IVector2): IVector2

- Defined in vector2/add.ts:10
Adds two vectors and returns the result.

Parameters
- vector1: IVector2
  
  First vector.
- vector2: IVector2
  
  Second vector.
Returns IVector2

distance

distance(vector1: IVector2, vector2: IVector2): number

- Defined in vector2/distance.ts:10
Returns the distance between two vectors.

Parameters
- vector1: IVector2
  
  Point1 position.
- vector2: IVector2
  
  Point2 position.
Returns number

divide

divide(vector1: IVector2, vector2: IVector2): IVector2

- Defined in vector2/divide.ts:10
Divides two vectors and returns the result.

Parameters
- vector1: IVector2
  
  First vector.
- vector2: IVector2
  
  Second vector.
Returns IVector2

dot

dot(vector1: IVector2, vector2: IVector2): number

- Defined in vector2/dot.ts:10
Returns the dot product of two vectors.

Parameters
- vector1: IVector2
  
  First vector.
- vector2: IVector2
  
  Second vector.
Returns number

length

length(vector: IVector2): number

- Defined in vector2/length.ts:10
Returns length of a vector.

Parameters
- vector: IVector2
  
  Vector.
Returns number

multiply

multiply(vector1: IVector2, vector2: IVector2): IVector2

- Defined in vector2/multiply.ts:10
Multiplies two vectors and returns the result.

Parameters
- vector1: IVector2
  
  First vector.
- vector2: IVector2
  
  Second vector.
Returns IVector2

negate

negate(vector: IVector2): IVector2

- Defined in vector2/negate.ts:9
Returns the negated coordinated of a vector.

Parameters
- vector: IVector2
  
  Vector to negate.
Returns IVector2

pointIntersection

pointIntersection(vector1: IVector2, size1: number, vector2: IVector2, size2: number): boolean

- Defined in vector2/pointIntersection.ts:12
Checks for intersection between two vectors.

Parameters
- vector1: IVector2
  
  First vector.
- size1: number
  
  First size;
- vector2: IVector2
  
  Second vector.
- size2: number
  
  Second size.
Returns boolean

positionAroundVector2

positionAroundVector2(vector: IVector2, distance: number, radian: number): IVector2

- Defined in vector2/positionAroundVector2.ts:18
Returns a vector positioned around another vector.

Parameters
- vector: IVector2
  
  Center point position.
- distance: number
  
  Distance from the center point.
- radian: number
  
  Radian value.
Returns IVector2

Private Const roundToPrecision

roundToPrecision(value: number): number

- Defined in vector2/positionAroundVector2.ts:8
Parameters
- value: number
Returns number

scale

scale(vector: IVector2, value: number): IVector2

- Defined in vector2/scale.ts:10
Scales a vector by a value.

Parameters
- vector: IVector2
  
  Vector to scale.
- value: number
  
  Value to scale by.
Returns IVector2

subtract

subtract(vector1: IVector2, vector2: IVector2): IVector2

- Defined in vector2/subtract.ts:10
Subtracts two vectors and returns the result.

Parameters
- vector1: IVector2
  
  First vector.
- vector2: IVector2
  
  Second vector.
Returns IVector2

traverse

traverse(vector: IVector2, callback: function, step?: number): void

- Defined in vector2/traverse.ts:12
Loops through the dimensions of a vector. Starts at zero, so keep in mind that the number of callbacks will be the dimension sizes +1;

Parameters
- vector: IVector2
  
  Vector to traverse.
- callback: function
  
  Callback for each step.
  - - (vector: IVector2): void
    - Parameters
      - vector: IVector2
      Returns void
- Default value step: number = 1
  
  Step size (default: 1).
Returns void

Generated using TypeDoc