API Docs for: v2.1.0
Show:

CGSGVector2D Class

Defined in: src\utils\math\class.vector2D.js:26
Module: Math

A 2D vector object

Methods

add

(
  • vector
)
public

Defined in src\utils\math\class.vector2D.js:61

returns a new vector added to the value passed in parameter

Parameters:

addEquals

(
  • vector
)
public

Defined in src\utils\math\class.vector2D.js:71

add to this vector, the value passed in parameter

Parameters:

copy

() CGSGVector2D public

Defined in src\utils\math\class.vector2D.js:52

Returns:

CGSGVector2D:

a new CGSGVector2D, clone of this one

cross

() public

Defined in src\utils\math\class.vector2D.js:271

Get cross product of this vector and another vector

divide

(
  • vector
)
public

Defined in src\utils\math\class.vector2D.js:124

return a new vector divided by the value passed in parameter

Parameters:

divideByFloat

(
  • f
)
public

Defined in src\utils\math\class.vector2D.js:166

Divide x and y by f

Parameters:

divideByFloatEquals

(
  • f
)
public

Defined in src\utils\math\class.vector2D.js:176

Divide x and y by f

Parameters:

divideEquals

(
  • vector
)
public

Defined in src\utils\math\class.vector2D.js:134

divide to this vector, the value passed in parameter

Parameters:

dot

() public

Defined in src\utils\math\class.vector2D.js:262

Get dot product of this vector and another vector

getDistance

(
  • vector
)
Number public

Defined in src\utils\math\class.vector2D.js:187

Compute the euclidian distance between this vector and the one passe in parameter

Parameters:

Returns:

Number:

getLength

() Number public

Defined in src\utils\math\class.vector2D.js:214

Returns:

Number:

getSquaredLength

() Number public

Defined in src\utils\math\class.vector2D.js:223

Returns:

Number:

multiply

(
  • vector
)
public

Defined in src\utils\math\class.vector2D.js:103

returns a new vector multiplied to the value passed in parameter

Parameters:

multiplyByFloat

(
  • f
)
public

Defined in src\utils\math\class.vector2D.js:145

Multiply x and y by f

Parameters:

multiplyByFloatEquals

(
  • f
)
public

Defined in src\utils\math\class.vector2D.js:155

Multiply x and y by f

Parameters:

multiplyEquals

(
  • vector
)
public

Defined in src\utils\math\class.vector2D.js:113

multiply to this vector, the value passed in parameter

Parameters:

normalize

() public

Defined in src\utils\math\class.vector2D.js:232

Normalize this vector

perp

() public

Defined in src\utils\math\class.vector2D.js:315

Get a perpendicular vector of this vector

perpendicular

() public

Defined in src\utils\math\class.vector2D.js:324

Get a vector perpendicular to this vector and another vector

project

() public

Defined in src\utils\math\class.vector2D.js:333

Get a projected vector of this vector and another vector

rotate

(
  • angle
)
public

Defined in src\utils\math\class.vector2D.js:201

rotate this vector around its origin

Parameters:

sign

() public

Defined in src\utils\math\class.vector2D.js:251

Determines if a given vector is to the right or left of this vector.

subtract

(
  • vector
)
public

Defined in src\utils\math\class.vector2D.js:82

returns a new vector subtracted from the value passed in parameter

Parameters:

subtractEquals

(
  • vector
)
public

Defined in src\utils\math\class.vector2D.js:92

subtract to this vector, the value passed in parameter

Parameters:

toString

() public

Defined in src\utils\math\class.vector2D.js:344

Get a string representing this vector

unit

() public

Defined in src\utils\math\class.vector2D.js:280

Get unit vector of this vector and another vector

unitEquals

() public

Defined in src\utils\math\class.vector2D.js:306

Get unit vector of this vector and another vector

unitFast

() public

Defined in src\utils\math\class.vector2D.js:289

Get approximation of unit vector of this vector and another vector