API Docs for: 0.0.2
Show:

Atlantis.Vector2 Class

Defined in: Framework\Vector2.js:38
Module: Framework
Parent Module: Atlantis

Create a new Vector2

Constructor

Atlantis.Vector2

()

Defined in Framework\Vector2.js:38

Item Index

Methods

Methods

add

(
  • value
)

Defined in Framework\Vector2.js:86

Add this vector by another vector or value.

Parameters:

add

(
  • A
  • Another
)
static

Defined in Framework\Vector2.js:102

Add two vectors.

Parameters:

distance

(
  • A
  • Another
)
static

Defined in Framework\Vector2.js:214

Gets the distance between two vectors.

Parameters:

divide

(
  • value
)

Defined in Framework\Vector2.js:144

Divide this vector by another vector

Parameters:

divide

(
  • A
  • Another
)
static

Defined in Framework\Vector2.js:160

Divide two vectors.

Parameters:

dot

(
  • First
  • Second
)
Number static

Defined in Framework\Vector2.js:238

Calculate the dot product of two vectors.

Parameters:

Returns:

Number:

Return the dot product of the two vectors.

getDistance

(
  • vector2
)
Number

Defined in Framework\Vector2.js:202

Gets distance between this vector and the vector passed in parameter.

Parameters:

Returns:

Number:

The distance between this vector and the vector passed in parameter.

getDistance

(
  • vector2
)
Number

Defined in Framework\Vector2.js:226

Gets distance between this vector and the vector passed in parameter.

Parameters:

Returns:

Number:

The distance between this vector and the vector passed in parameter.

lerp

(
  • First
  • Second
  • amount
)
static

Defined in Framework\Vector2.js:258

Performs a linear interpolation between to vectors.

Parameters:

Returns:

max

(
  • vec1
  • vec2
)
static

Defined in Framework\Vector2.js:286

Gets a vector of the maximum of the two vectors.

Parameters:

Returns:

Return a vector that correspond of the maximum of the two vectors.

min

(
  • vec1
  • vec2
)
static

Defined in Framework\Vector2.js:271

Gets a vector of the minimum of the two vectors.

Parameters:

Returns:

Return a vector that correspond of the minimum of the two vectors.

multiply

(
  • value
)

Defined in Framework\Vector2.js:173

Multiply this vector by another vector or a value.

Parameters:

multiply

(
  • A
  • Another
)
static

Defined in Framework\Vector2.js:189

Multiply two vectors.

Parameters:

negate

()

Defined in Framework\Vector2.js:301

Negate this vector

negate

(
  • A
)
Atlantis.Vector2 static

Defined in Framework\Vector2.js:316

Negate a vector.

Parameters:

Returns:

Atlantis.Vector2:

Return the negated vector.

normalize

(
  • A
)
static

Defined in Framework\Vector2.js:343

Parameters:

normalize

()

Defined in Framework\Vector2.js:330

Normalize this vector.

One

()

Defined in Framework\Vector2.js:62

Gets a Vector3 with all coordinates sets to one.

set

(
  • X
  • Y
)

Defined in Framework\Vector2.js:388

Sets the coordinates.

Parameters:

subtract

(
  • A
  • Another
)
static

Defined in Framework\Vector2.js:131

Subtract two vectors.

Parameters:

subtract

(
  • value
)

Defined in Framework\Vector2.js:115

Substract this vector by another vector or value.

Parameters:

toString

() String

Defined in Framework\Vector2.js:399

Gets a string from this object.

Returns:

String:

transform

(
  • position
  • matrix
)
Atlantis.Matrix

Defined in Framework\Vector2.js:355

Gets a transformed Vector3 from a position and a matrix.

Parameters:

Returns:

Atlantis.Matrix:

A tranformed vector.

transformCoordinate

(
  • position
  • matrix
)
Atlantis.Vector4

Defined in Framework\Vector2.js:372

Gets a transformed Vector3 from a position and a matrix.

Parameters:

Returns:

Atlantis.Vector4:

A tranformed vector.

UnitX

()

Defined in Framework\Vector2.js:70

Gets a Vector3 with X coordinate set to one.

UnitY

()

Defined in Framework\Vector2.js:78

Gets a Vector3 with Y coordinate set to one.

Zero

()

Defined in Framework\Vector2.js:54

Gets a Vector3 with all coordinates sets to zero.