# Titanium.UI.Matrix3D

The 3D Matrix is an object for holding values for a 3D affine transform.

Availability

8.0.0

9.2.0

Extends

Titanium.Proxy

# Overview

The 3D Matrix is created by Titanium.UI.createMatrix3D. A 3D transform is used to rotate, scale, translate, or skew the objects in three-dimensional space. A 3D transform is represented by a 4 by 4 matrix.

You create an identity matrix by creating a 3D Matrix with an empty constructor.

# Examples

# Apply a 3D Matrix to a Label

Move a label through a translation that repositions it from 100px to 200px from the top of the display.

var win = Ti.UI.createWindow({
  backgroundColor: 'white'
});

var label = Ti.UI.createLabel({
  font: { fontSize : 50 },
  text: 'Titanium',
  textAlign: 'center',
  top: 100
});
win.add(label);

var button = Ti.UI.createButton({
  title: 'Animate',
  bottom: 20,
  width: 200,
  height: 40
});
win.add(button);

button.addEventListener('click', function() {
  var t1 = Ti.UI.createMatrix3D();
  t1 = t1.translate(0, 100, 200);
  t1.m34 = 1.0 / -90.0;
  var a1 = Ti.UI.createAnimation();
  a1.transform = t1;
  a1.duration = 800;
  label.animate(a1);
});
win.open();

# Properties

# m11

Availability

8.0.0

9.2.0

m11 :Number

The entry at position [1,1] in the matrix.

# m12

Availability

8.0.0

9.2.0

m12 :Number

The entry at position [1,2] in the matrix.

# m13

Availability

8.0.0

9.2.0

m13 :Number

The entry at position [1,3] in the matrix.

# m14

Availability

8.0.0

9.2.0

m14 :Number

The entry at position [1,4] in the matrix.

# m21

Availability

8.0.0

9.2.0

m21 :Number

The entry at position [2,1] in the matrix.

# m22

Availability

8.0.0

9.2.0

m22 :Number

The entry at position [2,2] in the matrix.

# m23

Availability

8.0.0

9.2.0

m23 :Number

The entry at position [2,3] in the matrix.

# m24

Availability

8.0.0

9.2.0

m24 :Number

The entry at position [2,4] in the matrix.

# m31

Availability

8.0.0

9.2.0

m31 :Number

The entry at position [3,1] in the matrix.

# m32

Availability

8.0.0

9.2.0

m32 :Number

The entry at position [3,2] in the matrix.

# m33

Availability

8.0.0

9.2.0

m33 :Number

The entry at position [3,3] in the matrix.

# m34

Availability

8.0.0

9.2.0

m34 :Number

The entry at position [3,4] in the matrix.

# m41

Availability

8.0.0

9.2.0

m41 :Number

The entry at position [4,1] in the matrix.

# m42

Availability

8.0.0

9.2.0

m42 :Number

The entry at position [4,2] in the matrix.

# m43

Availability

8.0.0

9.2.0

m43 :Number

The entry at position [4,3] in the matrix.

# m44

Availability

8.0.0

9.2.0

m44 :Number

The entry at position [4,4] in the matrix.

# Methods

# invert

Availability

8.0.0

9.2.0

invert() → Titanium.UI.Matrix3D

Returns a matrix constructed by inverting this matrix.

Returns

Type: Titanium.UI.Matrix3D

# multiply

Availability

8.0.0

9.2.0

multiply(t2) → Titanium.UI.Matrix3D

Returns a matrix constructed by combining two existing matrix.

The result of this function is the first matrix multiplied by the second matrix. You might perform several multiplications in order to create a single matrix that contains the cumulative effects of several transformations. Note that matrix operations are not commutative - the order in which you concatenate matrices is important. That is, the result of multiplying matrix t1 by matrix t2 does not necessarily equal the result of multiplying matrix t2 by matrix t1.

Parameters

Name	Type	Description
`t2`	Titanium.UI.Matrix3D	Matrix to concatenate to this matrix.

Returns

Type: Titanium.UI.Matrix3D

# rotate

Availability

8.0.0

9.2.0

rotate(angle, x, y, z) → Titanium.UI.Matrix3D

Returns a matrix constructed by rotating this matrix.

Parameters

Name	Type	Description
`angle`	Number	The angle, in degrees, by which to rotate the matrix. A positive value specifies counterclockwise rotation and a negative value specifies clockwise rotation.
`x`	Number	The x part of the vector about which to rotate.
`y`	Number	The y part of the vector about which to rotate.
`z`	Number	The z part of the vector about which to rotate.

Returns

Type: Titanium.UI.Matrix3D

# scale

Availability

8.0.0

9.2.0

scale(sx, sy, sz) → Titanium.UI.Matrix3D

Returns a matrix constructed by scaling this matrix.

Parameters

Name	Type	Description
`sx`	Number	The value by which to scale x values of the matrix.
`sy`	Number	The value by which to scale y values of the matrix.
`sz`	Number	The value by which to scale z values of the matrix.

Returns

Type: Titanium.UI.Matrix3D

# translate

Availability

8.0.0

9.2.0

translate(tx, ty, tz) → Titanium.UI.Matrix3D

Returns a matrix constructed by translating an existing matrix.

Parameters

Name	Type	Description
`tx`	Number	The value by which to move x values with the matrix.
`ty`	Number	The value by which to move y values with the matrix.
`tz`	Number	The value by which to move z values with the matrix.

Returns

Type: Titanium.UI.Matrix3D