Class Vector3d

Hierarchy (View Summary)

Vector3d
- Vector

Implements

ICoordinates3d

Index

Constructors

Properties

x y z

Accessors

angle length origin

Methods

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

Constructors

`Protected`constructor

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

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
- Defined in Core/Utils/Vectors.ts:47
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
- Defined in Core/Utils/Vectors.ts:55

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
- Defined in Core/Utils/Vectors.ts:63
set length(length: number): void
Sets the x,y values using the length
Parameters
- length: number
  the length to set
Returns void
- Defined in Core/Utils/Vectors.ts:71

`Static`origin

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

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

Methods

add

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

addTo

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

copy

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

Returns Vector3d
the cloned current vector
- Defined in Core/Utils/Vectors.ts:122

distanceTo

distanceTo(v: Vector3d): number
Calculates the distance between the current vector and the given one
Parameters
- v: Vector3d
  the vector used for calculating the distance from the current one
Returns number
the distance between the vectors
- Defined in Core/Utils/Vectors.ts:131

distanceToSq

distanceToSq(v: Vector3d): number
Get the distance squared between two vectors
Parameters
- v: Vector3d
  the vector used for calculating the distance from the current one
Returns number
the distance squared between the vectors
- Defined in Core/Utils/Vectors.ts:140

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
- Defined in Core/Utils/Vectors.ts:149

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
- Defined in Core/Utils/Vectors.ts:157

getLengthSq

getLengthSq(): number
Get the squared length value

Returns number
the squared length value
- Defined in Core/Utils/Vectors.ts:167

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
- Defined in Core/Utils/Vectors.ts:176

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
- Defined in Core/Utils/Vectors.ts:184

normalize

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

Returns void
- Defined in Core/Utils/Vectors.ts:193

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
- Defined in Core/Utils/Vectors.ts:206

setTo

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

sub

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

subFrom

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

`Static`clone

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

`Static`create

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