API Docs for: 0.0.2
Show:

Atlantis.Matrix Class

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

Create a matrix. Parameter can be a matrix, an array of 16 floats or nothing (all fields case are sets to 0).

Constructor

Atlantis.Matrix

(
  • UNKNOWN
)

Defined in Framework\Matrix.js:11

Parameters:

Methods

add

(
  • matA
  • matB
)
Atlantis.Matrix static

Defined in Framework\Matrix.js:291

Add two matrix.

Parameters:

Returns:

Atlantis.Matrix:

Return a new matrix.

add

(
  • matrix
)

Defined in Framework\Matrix.js:276

Add a matrix to this matrix.

Parameters:

createOrthograhic

(
  • width
  • height
  • zNear
  • zFar
)
Atlantis.Matrix static

Defined in Framework\Matrix.js:436

Create an orthogonal projection matrix.

Parameters:

Returns:

Atlantis.Matrix:

createOrthographicOffCenter

(
  • width
  • height
  • zNear
  • zFar
)
Atlantis.Matrix static

Defined in Framework\Matrix.js:460

Create a customized orthogonal projection matrix.

Parameters:

Returns:

Atlantis.Matrix:

createPerspectiveFieldOfView

(
  • fov
  • aspect
  • near
  • far
)
Atlantis.Matrix static

Defined in Framework\Matrix.js:491

Create a perspective field of view matrix with Left hand notation.

Parameters:

  • fov Number

    Desired field of view (Math.PI / 4 is a good value)

  • aspect Number

    Desired aspect ratio (Screen width / height)

  • near Number

    Near clip

  • far Number

    Far clip

Returns:

Atlantis.Matrix:

Return a matrix of this type of perspective.

createPerspectiveFieldOfViewRH

(
  • fov
  • aspect
  • near
  • far
)
Atlantis.Matrix static

Defined in Framework\Matrix.js:510

Create a perspective field of view matrix with Right hand notation.

Parameters:

  • fov Number

    Desired field of view (Math.PI / 4 is a good value)

  • aspect Number

    Desired aspect ratio (Screen width / height)

  • near Number

    Near clip

  • far Number

    Far clip

Returns:

Atlantis.Matrix:

Return a matrix of this type of perspective.

createPerspectiveOffCenter

(
  • left
  • right
  • bottom
  • top
  • zNear
  • zFar
)
Atlantis.Matrix static

Defined in Framework\Matrix.js:529

Create a custom perspective matrix.

Parameters:

  • left Number

    Minimum X value of the viewing volume.

  • right Number

    Maximum X value of the viewing volume.

  • bottom Number

    Minimum Y value of the viewing volume.

  • top Number

    Maximum Y value of the viewing volume.

  • zNear Number

    Minimum Z value of the viewing volume.

  • zFar Number

    Maximum Z value of the viewing volume.

Returns:

Atlantis.Matrix:

Return a new custom perspective matrix.

createPerspectiveOffCenter

(
  • left
  • right
  • bottom
  • top
  • zNear
  • zFar
)
Atlantis.Matrix static

Defined in Framework\Matrix.js:554

Create a custom perspective matrix (Right hand).

Parameters:

  • left Number

    Minimum X value of the viewing volume.

  • right Number

    Maximum X value of the viewing volume.

  • bottom Number

    Minimum Y value of the viewing volume.

  • top Number

    Maximum Y value of the viewing volume.

  • zNear Number

    Minimum Z value of the viewing volume.

  • zFar Number

    Maximum Z value of the viewing volume.

Returns:

Atlantis.Matrix:

Return a new custom perspective matrix.

createRotationX

(
  • rotation
)
Atlantis.Matrix static

Defined in Framework\Matrix.js:305

Create a rotation matrix on X axis.

Parameters:

Returns:

Atlantis.Matrix:

Return a rotation matrix on X axis.

createRotationX

(
  • rotation
)
Atlantis.Matrix static

Defined in Framework\Matrix.js:343

Create a rotation matrix on Z axis.

Parameters:

Returns:

Atlantis.Matrix:

Return a rotation matrix on Z axis.

createRotationY

(
  • rotation
)
Atlantis.Matrix static

Defined in Framework\Matrix.js:324

Create a rotation matrix on Y axis.

Parameters:

Returns:

Atlantis.Matrix:

Return a rotation matrix on Y axis.

createScale

(
  • sx
  • sy
  • sz
)
Atlantis.Matrix static

Defined in Framework\Matrix.js:364

Create a scale matrix.

Parameters:

  • sx Number

    Desired scale on X axis.

  • sy Number

    Desired scale on Y axis.

  • sz Number

    Desired scale on Z axis.

Returns:

Atlantis.Matrix:

Return a scale matrix.

createTranslation

(
  • x
  • y
  • z
)
static

Defined in Framework\Matrix.js:381

Create a translation matrix.

Parameters:

Returns:

Return a matrix translation.

createWorld

(
  • position
  • forward
  • upVector
)
Atlantis.Matrix static

Defined in Framework\Matrix.js:642

Create a world matrix.

Parameters:

Returns:

Atlantis.Matrix:

Return a world matrix.

getBackward

() Atlantis.Matrix

Defined in Framework\Matrix.js:228

Gets the backward of the matrix.

Returns:

Atlantis.Matrix:

Return a the backward vector of the matrix.

getDown

() Atlantis.Matrix

Defined in Framework\Matrix.js:204

Gets the down of the matrix.

Returns:

Atlantis.Matrix:

Return a the down vector of the matrix.

getForward

() Atlantis.Matrix

Defined in Framework\Matrix.js:252

Gets the forward of the matrix.

Returns:

Atlantis.Matrix:

Return a the forward vector of the matrix.

getIdentityValues

() Array

Defined in Framework\Matrix.js:47

Gets identity value for push it into matrix.

Returns:

Array:

Return an array that correspond of identity matrix.

getLeft

() Atlantis.Matrix

Defined in Framework\Matrix.js:132

Gets the left of the matrix.

Returns:

Atlantis.Matrix:

Return a the left vector of the matrix.

getMatrixIdentity

() Atlantis.Matrix static

Defined in Framework\Matrix.js:83

Gets an identity matrix.

Returns:

Atlantis.Matrix:

Return an identity matrix.

getRight

() Atlantis.Matrix

Defined in Framework\Matrix.js:156

Gets the right of the matrix.

Returns:

Atlantis.Matrix:

Return a the right vector of the matrix.

getUp

() Atlantis.Matrix

Defined in Framework\Matrix.js:180

Gets the up of the matrix.

Returns:

Atlantis.Matrix:

Return a the up vector of the matrix.

getZeroValues

() Array

Defined in Framework\Matrix.js:62

Gets an array of values setted to 0.

Returns:

Array:

Return an array with 0.

invert

()

Defined in Framework\Matrix.js:575

Invert the current Matrix.

invert

(
  • matrix
)
Atlantis.Matrix static

Defined in Framework\Matrix.js:629

Calculate the inverse of the specified matrix.

Parameters:

  • matrix Object

    The matrix to use.

Returns:

Atlantis.Matrix:

Return the inverse of the matrix.

multiply

(
  • matrixA
  • matrixB
  • matrixC
)
Atlantis.Matrix static

Defined in Framework\Matrix.js:710

Multiply a two matrix.

Parameters:

Returns:

Atlantis.Matrix:

Return a new matrix.

multiply

(
  • matrix
)

Defined in Framework\Matrix.js:669

Multiply this matrix by another matrix.

Parameters:

set

(
  • values
)

Defined in Framework\Matrix.js:33

Set all values of the matrix.

Parameters:

  • values Array

    An array of 16 values who start at M11 and stop at M44

setBackward

(
  • vector
)

Defined in Framework\Matrix.js:217

Sets the backward of the matrix.

Parameters:

setDown

(
  • vector
)

Defined in Framework\Matrix.js:193

Sets the down of the matrix.

Parameters:

setForward

(
  • vector
)

Defined in Framework\Matrix.js:241

Sets the forward of the matrix.

Parameters:

setIdentity

()

Defined in Framework\Matrix.js:75

Sets the matrix to identity.

setLeft

(
  • vector
)

Defined in Framework\Matrix.js:121

Sets the left of the matrix.

Parameters:

setRight

(
  • vector
)

Defined in Framework\Matrix.js:145

Sets the right of the matrix.

Parameters:

setTranslation

(
  • position
)

Defined in Framework\Matrix.js:265

Sets translation.

Parameters:

  • position Atlantis.Vetor3

    The position to set.

setUp

(
  • vector
)

Defined in Framework\Matrix.js:169

Sets the up of the matrix.

Parameters:

subtract

(
  • matrix
)

Defined in Framework\Matrix.js:730

Subtract a matrix to this matrix.

Parameters:

subtract

(
  • matA
  • matB
)
Atlantis.Matrix static

Defined in Framework\Matrix.js:745

Subtract two matrix.

Parameters:

Returns:

Atlantis.Matrix:

Return a new matrix.

toArray

() Array

Defined in Framework\Matrix.js:95

Gets values of matrix in array. Start at M11 to M44.

Returns:

Array:

An array of values.

toString

() String

Defined in Framework\Matrix.js:759

Gets a string from this object.

Returns:

String: