dojox/gfx3d/_base.matrix (version 1.10)

See the dojox/gfx3d/_base.matrix reference documentation for more information.

Property Summary

  • identityan identity matrix constant: identity * (x, y, z) == (x, y, z)

Method Summary

  • _degToRad(degree)
  • _multiplyPoint(m,x,y,z) applies a matrix to a point
  • _project(m,x,y,z) applies a matrix to a point
  • _radToDeg(radian)
  • cameraRotateX(angle) forms a rotating matrix (about the x axis) in cameraTransform manner
  • cameraRotateXg(degree) forms a rotating matrix (about the x axis)in cameraTransform manner
  • cameraRotateY(angle) forms a rotating matrix (about the y axis) in cameraTransform manner
  • cameraRotateYg(degree) forms a rotating matrix (about the y axis) in cameraTransform manner
  • cameraRotateZ(angle) forms a rotating matrix (about the z axis) in cameraTransform manner
  • cameraRotateZg(degree) forms a rotating matrix (about the z axis) in cameraTransform manner
  • cameraTranslate(a,b,c) forms a translation matrix
  • clone(matrix) creates a copy of a 3D matrix
  • invert(matrix) inverts a 2D matrix
  • Matrix3D(arg) a 3D matrix object
  • multiply(matrix) combines matrices by multiplying them sequentially in the given order
  • multiplyPoint(matrix,a,b,c) applies a matrix to a point
  • normalize(matrix) converts an object to a matrix, if necessary
  • project(matrix,a,b,c) applies a matrix to a point
  • rotateX(angle) forms a rotating matrix (about the x axis)
  • rotateXg(degree) forms a rotating matrix (about the x axis)
  • rotateY(angle) forms a rotating matrix (about the y axis)
  • rotateYg(degree) forms a rotating matrix (about the y axis)
  • rotateZ(angle) forms a rotating matrix (about the z axis)
  • rotateZg(degree) forms a rotating matrix (about the z axis)
  • scale(a,b,c) forms a scaling matrix
  • translate(a,b,c) forms a translation matrix

Properties

identity
Defined by: dojox/gfx3d/matrix

an identity matrix constant: identity * (x, y, z) == (x, y, z)

Methods

_degToRad(degree)
Defined by dojox/gfx3d/matrix
Parameter Type Description
degree undefined
Returns:number
_multiplyPoint(m,x,y,z)
Defined by dojox/gfx3d/matrix

applies a matrix to a point

Parameter Type Description
m undefined
x Number

an x coordinate of a point

y Number

a y coordinate of a point

z Number

a z coordinate of a point

Returns:object
_project(m,x,y,z)
Defined by dojox/gfx3d/matrix

applies a matrix to a point

Parameter Type Description
m undefined
x Number

an x coordinate of a point

y Number

a y coordinate of a point

z Number

a z coordinate of a point

Returns:Object
_radToDeg(radian)
Defined by dojox/gfx3d/matrix
Parameter Type Description
radian undefined
Returns:number
cameraRotateX(angle)
Defined by dojox/gfx3d/matrix

forms a rotating matrix (about the x axis) in cameraTransform manner

The resulting matrix is used to rotate points around the origin of coordinates (0, 0) by specified angle.

Parameter Type Description
angle Number

an angle of rotation in radians (>0 for CW)

Returns:instance
cameraRotateXg(degree)
Defined by dojox/gfx3d/matrix

forms a rotating matrix (about the x axis)in cameraTransform manner

The resulting matrix is used to rotate points around the origin of coordinates (0, 0) by specified degree. See dojox.gfx3d.matrix.rotateX() for comparison.

Parameter Type Description
degree Number

an angle of rotation in degrees (>0 for CW)

Returns:undefined
cameraRotateY(angle)
Defined by dojox/gfx3d/matrix

forms a rotating matrix (about the y axis) in cameraTransform manner

The resulting matrix is used to rotate points around the origin of coordinates (0, 0) by specified angle.

Parameter Type Description
angle Number

an angle of rotation in radians (>0 for CW)

Returns:instance
cameraRotateYg(degree)
Defined by dojox/gfx3d/matrix

forms a rotating matrix (about the y axis) in cameraTransform manner

The resulting matrix is used to rotate points around the origin of coordinates (0, 0) by specified degree. See dojox.gfx3d.matrix.rotateY() for comparison.

Parameter Type Description
degree Number

an angle of rotation in degrees (>0 for CW)

Returns:undefined
cameraRotateZ(angle)
Defined by dojox/gfx3d/matrix

forms a rotating matrix (about the z axis) in cameraTransform manner

The resulting matrix is used to rotate points around the origin of coordinates (0, 0) by specified angle.

Parameter Type Description
angle Number

an angle of rotation in radians (>0 for CW)

Returns:instance
cameraRotateZg(degree)
Defined by dojox/gfx3d/matrix

forms a rotating matrix (about the z axis) in cameraTransform manner

The resulting matrix is used to rotate points around the origin of coordinates (0, 0) by specified degree. See dojox.gfx3d.matrix.rotateZ() for comparison.

Parameter Type Description
degree Number

an angle of rotation in degrees (>0 for CW)

Returns:undefined
cameraTranslate(a,b,c)
Defined by dojox/gfx3d/matrix

forms a translation matrix

The resulting matrix is used to translate (move) points by specified offsets.

Parameter Type Description
a Number | Object

an x coordinate value, or a point-like object, which specifies offsets for 3 dimensions

b Number
Optional

a y coordinate value

c Number
Optional

a z coordinate value

Returns:instance
clone(matrix)
Defined by dojox/gfx3d/matrix

creates a copy of a 3D matrix

Parameter Type Description
matrix Object

a 3D matrix-like object to be cloned

Returns:instance
invert(matrix)
Defined by dojox/gfx3d/matrix

inverts a 2D matrix

Parameter Type Description
matrix Object

a 3D matrix object to be applied

Returns:instance
Matrix3D(arg)
Defined by dojox/gfx3d/matrix

a 3D matrix object

Normalizes a 3D matrix-like object. If arrays is passed, all objects of the array are normalized and multiplied sequentially.

Parameter Type Description
arg Object

a 3D matrix-like object, a number, or an array of such objects

multiply(matrix)
Defined by dojox/gfx3d/matrix

combines matrices by multiplying them sequentially in the given order

Parameter Type Description
matrix Object

a 3D matrix object to be applied

Returns:instance
multiplyPoint(matrix,a,b,c)
Defined by dojox/gfx3d/matrix

applies a matrix to a point

Parameter Type Description
matrix Object

a 3D matrix object to be applied

a Number | Object

an x coordinate of a point, or an Object specifying the whole point

b Number
Optional

a y coordinate of a point

c Number
Optional

a z coordinate of a point

Returns:undefined
normalize(matrix)
Defined by dojox/gfx3d/matrix

converts an object to a matrix, if necessary

Converts any 3D matrix-like object or an array of such objects to a valid dojox.gfx3d.matrix.Matrix3D object.

Parameter Type Description
matrix Object

an object, which is converted to a matrix, if necessary

Returns:instance
project(matrix,a,b,c)
Defined by dojox/gfx3d/matrix

applies a matrix to a point

Parameter Type Description
matrix Object

a 3D matrix object to be applied

a Number | Point

an x coordinate of a point, or an Object specifying the whole point

b Number
Optional

a y coordinate of a point

c Number
Optional

a z coordinate of a point

Returns:undefined
rotateX(angle)
Defined by dojox/gfx3d/matrix

forms a rotating matrix (about the x axis)

The resulting matrix is used to rotate points around the origin of coordinates (0, 0) by specified angle.

Parameter Type Description
angle Number

an angle of rotation in radians (>0 for CW)

Returns:instance
rotateXg(degree)
Defined by dojox/gfx3d/matrix

forms a rotating matrix (about the x axis)

The resulting matrix is used to rotate points around the origin of coordinates (0, 0) by specified degree. See dojox.gfx3d.matrix.rotateX() for comparison.

Parameter Type Description
degree Number

an angle of rotation in degrees (>0 for CW)

Returns:undefined
rotateY(angle)
Defined by dojox/gfx3d/matrix

forms a rotating matrix (about the y axis)

The resulting matrix is used to rotate points around the origin of coordinates (0, 0) by specified angle.

Parameter Type Description
angle Number

an angle of rotation in radians (>0 for CW)

Returns:instance
rotateYg(degree)
Defined by dojox/gfx3d/matrix

forms a rotating matrix (about the y axis)

The resulting matrix is used to rotate points around the origin of coordinates (0, 0) by specified degree. See dojox.gfx3d.matrix.rotateY() for comparison.

Parameter Type Description
degree Number

an angle of rotation in degrees (>0 for CW)

Returns:undefined
rotateZ(angle)
Defined by dojox/gfx3d/matrix

forms a rotating matrix (about the z axis)

The resulting matrix is used to rotate points around the origin of coordinates (0, 0) by specified angle.

Parameter Type Description
angle Number

an angle of rotation in radians (>0 for CW)

Returns:instance
rotateZg(degree)
Defined by dojox/gfx3d/matrix

forms a rotating matrix (about the z axis)

The resulting matrix is used to rotate points around the origin of coordinates (0, 0) by specified degree. See dojox.gfx3d.matrix.rotateZ() for comparison.

Parameter Type Description
degree Number

an angle of rotation in degrees (>0 for CW)

Returns:undefined
scale(a,b,c)
Defined by dojox/gfx3d/matrix

forms a scaling matrix

The resulting matrix is used to scale (magnify) points by specified offsets.

Parameter Type Description
a Number | Object

a scaling factor used for the x coordinate, or a uniform scaling factor used for the all coordinates, or a point-like object, which specifies scale factors for 3 dimensions

b Number
Optional

a scaling factor used for the y coordinate

c Number
Optional

a scaling factor used for the z coordinate

Returns:instance
translate(a,b,c)
Defined by dojox/gfx3d/matrix

forms a translation matrix

The resulting matrix is used to translate (move) points by specified offsets.

Parameter Type Description
a Number | Object

an x coordinate value, or a point-like object, which specifies offsets for 3 dimensions

b Number
Optional

a y coordinate value

c Number
Optional

a z coordinate value

Returns:instance
Error in the documentation? Can’t find what you are looking for? Let us know!