API Docs for: 0.0.2
Show:

Atlantis.Vector3 Class

Defined in: Framework\Vector3.js:11
Module: Framework
Parent Module: Atlantis

Create a vector with three coordinates. If you pass a Vector3 in first parameter, its filed are copied to the new vector (work like a copy constructor).

Constructor

Atlantis.Vector3

(
  • The
  • The
)

Defined in Framework\Vector3.js:11

Parameters:

Methods

add

(
  • vec1
  • vec2
)
Atlantis.Vector3 static

Defined in Framework\Vector3.js:138

Add two vectors.

Parameters:

Returns:

Atlantis.Vector3:

Return a new Vector3

add

(
  • vector
)

Defined in Framework\Vector3.js:120

Add a Vector3 to the current vector.

Parameters:

Backward

()

Defined in Framework\Vector3.js:112

Gets a Vector3 with Z coordinate set to one.

cross

(
  • vec1
  • vec2
)
Atlantis.Vector3 static

Defined in Framework\Vector3.js:246

Calculates the cross products of two vectors.

Parameters:

Returns:

Atlantis.Vector3:

the cross products of the two vectors.

distance

(
  • vector
)
Number static

Defined in Framework\Vector3.js:262

Gets the distance between two vectors.

Parameters:

Returns:

Number:

Return the distance between two vectors.

distanceSquared

(
  • vec1
  • vec2
)
Number

Defined in Framework\Vector3.js:273

Gets the distance squared between to vectors.

Parameters:

Returns:

Number:

divide

(
  • vector
)

Defined in Framework\Vector3.js:184

divide a Vector3 to the current vector.

Parameters:

divide

(
  • vec1
  • vec2
)
Atlantis.Vector3 static

Defined in Framework\Vector3.js:201

Divide two vectors.

Parameters:

Returns:

Atlantis.Vector3:

Return a new Vector3.

dot

(
  • vec1
  • vec2
)
Number static

Defined in Framework\Vector3.js:287

Calculates the dot product of two vectors.

Parameters:

Returns:

Number:

Return the dot product of two vectors.

Down

()

Defined in Framework\Vector3.js:80

Gets a Vector3 with Y coordinate set to -1.

Forward

()

Defined in Framework\Vector3.js:104

Gets a Vector3 with Z coordinate set to -1.

Left

()

Defined in Framework\Vector3.js:96

Gets a Vector3 with X coordinate set to -1.

length

() Number

Defined in Framework\Vector3.js:299

Gets the length of the vector.

Returns:

Number:

Return the length of the vector.

lerp

(
  • vector
  • amount
)

Defined in Framework\Vector3.js:308

Linear interpolation between this vector and the vector passed in parameter.

Parameters:

  • vector Atlantis.Vector3

    A vector to use for interpolation

  • amount Number

    Value between 0 and 1 indicating the weight of vector.

lerp

(
  • vec1
  • vec2
  • amount
)
Atlantis.Vector3 static

Defined in Framework\Vector3.js:320

Linearly interpolates between two vectors.

Parameters:

Returns:

Atlantis.Vector3:

Return a interpolated Vector3.

max

(
  • vec1
  • vec2
)
Atlantis.Vector3 static

Defined in Framework\Vector3.js:352

Gets a vector of the maximum of the two vectors.

Parameters:

Returns:

Atlantis.Vector3:

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

min

(
  • vec1
  • vec2
)
Atlantis.Vector3 static

Defined in Framework\Vector3.js:336

Gets a vector of the minimum of the two vectors.

Parameters:

Returns:

Atlantis.Vector3:

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

multiply

(
  • A
  • Another
)
Atlantis.Vector3

Defined in Framework\Vector3.js:233

Multiply a two vectors.

Parameters:

Returns:

Atlantis.Vector3:

Return a new vector.

multiply

(
  • vector
)

Defined in Framework\Vector3.js:215

multiply a Vector3 to the current vector.

Parameters:

negate

(
  • vector
)
Atlantis.Vector3 static

Defined in Framework\Vector3.js:378

Negate a vector.

Parameters:

Returns:

Atlantis.Vector3:

Return a negated vector.

negate

()

Defined in Framework\Vector3.js:368

Negate the vector.

normalize

() static

Defined in Framework\Vector3.js:391

Normalize vector.

normalize

(
  • vector
)
Atlantis.Vector3

Defined in Framework\Vector3.js:405

Normalize a vector.

Parameters:

Returns:

Atlantis.Vector3:

result A normalized vector.

One

()

Defined in Framework\Vector3.js:40

Gets a Vector3 with all coordinates sets to one.

Right

()

Defined in Framework\Vector3.js:88

Gets a Vector3 with X coordinate set to one.

set

(
  • x
  • y
  • z
)

Defined in Framework\Vector3.js:452

Changes the 3 coordinates.

Parameters:

  • x Object

    The new X coordinate.

  • y Object

    The new Y coordinate.

  • z Object

    The new Z coordinate.

subtract

(
  • vec1
  • vec2
)
Atlantis.Vector3 static

Defined in Framework\Vector3.js:170

Subtract two vectors.

Parameters:

Returns:

Atlantis.Vector3:

Return a news Vector3.

subtract

(
  • vector
)

Defined in Framework\Vector3.js:152

Subtract a Vector3 to the current vector.

Parameters:

toString

() String

Defined in Framework\Vector3.js:465

Gets a string from this object.

Returns:

String:

tranform

(
  • position
  • matrix
)
Atlantis.Vector3 static

Defined in Framework\Vector3.js:417

Gets a transformed Vector3 from a position and a matrix.

Parameters:

Returns:

Atlantis.Vector3:

A tranformed vector.

transformCoordinate

(
  • position
  • matrix
)
Atlantis.Vector4 static

Defined in Framework\Vector3.js:435

Gets an homogeneous transformed vector from a position and a matrix.

Parameters:

Returns:

Atlantis.Vector4:

A tranformed vector.

UnitX

()

Defined in Framework\Vector3.js:48

Gets a Vector3 with X coordinate set to one.

UnitY

()

Defined in Framework\Vector3.js:56

Gets a Vector3 with Y coordinate set to one.

UnitZ

()

Defined in Framework\Vector3.js:64

Gets a Vector3 with Z coordinate set to one.

Up

()

Defined in Framework\Vector3.js:72

Gets a Vector3 with Y coordinate set to one.

Zero

()

Defined in Framework\Vector3.js:32

Gets a Vector3 with all coordinates sets to zero.