Class Vector

2D vector specialization built on top of Vector3d.

Hierarchy (View Summary)

Vector3d
- Vector

Index

Constructors

Properties

x y z

Accessors

angle length origin

Methods

add addTo copy div divTo getLengthSq mult multTo normalize rotate setTo sub subFrom clone create

Constructors

`Protected`constructor

new Vector(x?: number, y?: number): Vector
Internal
Vector constructor, creating an instance with the given coordinates
Parameters
- x: number = originPoint.x
  X coordinate
- y: number = originPoint.y
  Y coordinate
Returns Vector
Overrides Vector3d.constructor
- Defined in Core/Utils/Vectors.ts:258

Properties

x

x: number

X coordinate of the vector

y

y: number

Y coordinate of the vector

z

z: number

Z coordinate

Accessors

angle

get angle(): number
Returns the current vector angle, based on x,y values

Returns number
the current vector angle, based on x,y values
Inherited from Vector3d.angle
- Defined in Core/Utils/Vectors.ts:56
set angle(angle: number): void
Sets the x,y values using an angle, length must be greater than 0
Parameters
- angle: number
  the angle to set
Returns void
Inherited from Vector3d.angle
- Defined in Core/Utils/Vectors.ts:64

length

get length(): number
Returns the current vector length, based on x,y values

Returns number
the current vector length, based on x,y values
Inherited from Vector3d.length
- Defined in Core/Utils/Vectors.ts:72
set length(length: number): void
Sets the x,y values using the length
Parameters
- length: number
  the length to set
Returns void
Inherited from Vector3d.length
- Defined in Core/Utils/Vectors.ts:80

`Static`origin

get origin(): Vector
A new vector, with coordinates in the origin point

Returns Vector
a new vector, with coordinates in the origin point
Overrides Vector3d.origin
- Defined in Core/Utils/Vectors.ts:266

Methods

add

add(v: ICoordinates | ICoordinates3d): Vector3d
Adds the current and the given vector together, without modifying them
Parameters
- v: ICoordinates | ICoordinates3d
  the vector used for the sum operation
Returns Vector3d
the sum vector
Inherited from Vector3d.add
- Defined in Core/Utils/Vectors.ts:113

addTo

addTo(v: ICoordinates | ICoordinates3d): void
Adds the given vector to the current one, modifying it
Parameters
- v: ICoordinates | ICoordinates3d
  the vector to add to the current one
Returns void
Inherited from Vector3d.addTo
- Defined in Core/Utils/Vectors.ts:121

copy

copy(): Vector3d
Copies the current vector, cloning it

Returns Vector3d
the cloned current vector
Inherited from Vector3d.copy
- Defined in Core/Utils/Vectors.ts:131

div

div(n: number): Vector3d
Divides the given scalar and the current vector together, without modifying it
Parameters
- n: number
  the scalar value to divide from the current vector
Returns Vector3d
the divided vector
Inherited from Vector3d.div
- Defined in Core/Utils/Vectors.ts:140

divTo

divTo(n: number): void
Divides the given scalar from the current vector, modifying it
Parameters
- n: number
  the scalar value to divide from the current vector
Returns void
Inherited from Vector3d.divTo
- Defined in Core/Utils/Vectors.ts:148

getLengthSq

getLengthSq(): number
Get the squared length value

Returns number
the squared length value
Inherited from Vector3d.getLengthSq
- Defined in Core/Utils/Vectors.ts:158

mult

mult(n: number): Vector3d
Multiplies the given scalar and the current vector together, without modifying it
Parameters
- n: number
  the scalar value to multiply to the vector
Returns Vector3d
the multiplied vector
Inherited from Vector3d.mult
- Defined in Core/Utils/Vectors.ts:167

multTo

multTo(n: number): void
Multiplies the given scalar to the current vector, modifying it
Parameters
- n: number
  the scalar value to multiply to the vector
Returns void
Inherited from Vector3d.multTo
- Defined in Core/Utils/Vectors.ts:175

normalize

normalize(): void
Normalizes the current vector, modifying it

Returns void
Inherited from Vector3d.normalize
- Defined in Core/Utils/Vectors.ts:184

rotate

rotate(angle: number): Vector3d
Creates a new vector, rotating the current one, without modifying it
Parameters
- angle: number
  the rotation angle
Returns Vector3d
the rotated vector
Inherited from Vector3d.rotate
- Defined in Core/Utils/Vectors.ts:197

setTo

setTo(c: ICoordinates | ICoordinates3d): void
Set the vector to the specified velocity
Parameters
- c: ICoordinates | ICoordinates3d
  the coordinates used to set the current vector
Returns void
Inherited from Vector3d.setTo
- Defined in Core/Utils/Vectors.ts:209

sub

sub(v: ICoordinates | ICoordinates3d): Vector3d
Subtracts the current and the given vector together, without modifying them
Parameters
- v: ICoordinates | ICoordinates3d
  the vector used for the subtract operation
Returns Vector3d
the subtracted vector
Inherited from Vector3d.sub
- Defined in Core/Utils/Vectors.ts:220

subFrom

subFrom(v: ICoordinates | ICoordinates3d): void
Subtracts the given vector from the current one, modifying it
Parameters
- v: ICoordinates | ICoordinates3d
  the vector to subtract from the current one
Returns void
Inherited from Vector3d.subFrom
- Defined in Core/Utils/Vectors.ts:228

`Static`clone

clone(source: ICoordinates): Vector
Clones the given vector
Parameters
- source: ICoordinates
  the vector to clone
Returns Vector
a new vector instance, created from the given one
Overrides Vector3d.clone
- Defined in Core/Utils/Vectors.ts:275

`Static`create

create(x: number | ICoordinates, y?: number): Vector
Creates a new vector instance
Parameters
- x: number | ICoordinates
  X coordinate
- Optionaly: number
  Y coordinate
Returns Vector
the new vector created
Overrides Vector3d.create
- Defined in Core/Utils/Vectors.ts:285