Version12.5.0

You are reading 12.5.0. See this page in 13.4.1.

Titanium.UI.Matrix3D

proxyiPhoneiPadmacOSsince 8.0.0

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

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();

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 18

apiName

Stringsince Android 3.2.0, iPhone 3.2.0, iPad 3.2.0, macOS 9.2.0read-only

Inherited from Titanium.Proxy

The name of the API that this proxy corresponds to.

bubbleParent

Booleansince Android 3.0.0, iPhone 3.0.0, iPad 3.0.0, macOS 9.2.0

Inherited from Titanium.Proxy

Indicates if the proxy will bubble an event to its parent.

Default: true

m11

Number

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

m12

Number

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

m13

Number

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

m14

Number

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

m21

Number

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

m22

Number

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

m23

Number

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

m24

Number

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

m31

Number

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

m32

Number

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

m33

Number

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

m34

Number

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

m41

Number

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

m42

Number

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

m43

Number

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

m44

Number

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

Methods 9

addEventListener

Inherited from Titanium.Proxy

Adds the specified callback as an event listener for the named event.

Parameters
Parameters	Type	Description
name	String	Name of the event.
callback	Callback<Titanium.Event>	Callback function to invoke when the event is fired. 4 fields bubbles Boolean True if the event will try to bubble up if possible. cancelBubble Boolean Set to true to stop the event from bubbling. source Object Source object that fired the event. type String Name of the event fired.

applyProperties

since 3.0.0

Inherited from Titanium.Proxy

Applies the properties to the proxy.

Parameters
Parameters	Type	Description
props	Dictionary	A dictionary of properties to apply.

fireEvent

Inherited from Titanium.Proxy

Fires a synthesized event to any registered listeners.

Parameters
Parameters	Type	Description
name	String	Name of the event.
event?	Dictionary	A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

invert

Returns a matrix constructed by inverting this matrix.

Returns Titanium.UI.Matrix3D

multiply

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
Parameters	Type	Description
t2	Titanium.UI.Matrix3D	Matrix to concatenate to this matrix.

Returns Titanium.UI.Matrix3D

removeEventListener

Inherited from Titanium.Proxy

Removes the specified callback as an event listener for the named event.

Parameters
Parameters	Type	Description
name	String	Name of the event.
callback	Callback<Titanium.Event>	Callback function to remove. Must be the same function passed to `addEventListener`. 4 fields bubbles Boolean True if the event will try to bubble up if possible. cancelBubble Boolean Set to true to stop the event from bubbling. source Object Source object that fired the event. type String Name of the event fired.

rotate

Returns a matrix constructed by rotating this matrix.

Parameters
Parameters	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 Titanium.UI.Matrix3D

scale

Returns a matrix constructed by scaling this matrix.

Parameters
Parameters	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 Titanium.UI.Matrix3D

translate

Returns a matrix constructed by translating an existing matrix.

Parameters
Parameters	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 Titanium.UI.Matrix3D