Titanium SDK # Titanium.UI.Matrix3D
The 3D Matrix is an object for holding values for a 3D affine transform.
8.0.0
9.2.0# 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();
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
# apiName READONLY
8.0.0 9.2.0The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button
returns Ti.UI.Button.
# bubbleParent
8.0.0 9.2.0Indicates if the proxy will bubble an event to its parent.
Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.
Default: true
# Methods
# addEventListener
8.0.0 9.2.0Adds the specified callback as an event listener for the named event.
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. |
Returns
- Type
- void
# applyProperties
8.0.0 9.2.0Applies the properties to the proxy.
Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.
Parameters
| Name | Type | Description |
|---|---|---|
props | Dictionary | A dictionary of properties to apply. |
Returns
- Type
- void
# fireEvent
8.0.0 9.2.0Fires a synthesized event to any registered listeners.
Parameters
| Name | 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. |
Returns
- Type
- void
# invert
8.0.0 9.2.0Returns a matrix constructed by inverting this matrix.
Returns
- Type
- Titanium.UI.Matrix3D
# multiply
8.0.0 9.2.0Returns 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
# removeEventListener
8.0.0 9.2.0Removes the specified callback as an event listener for the named event.
Multiple listeners can be registered for the same event, so the
callback parameter is used to determine which listener to remove.
When adding a listener, you must save a reference to the callback function in order to remove the listener later:
var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);
To remove the listener, pass in a reference to the callback function:
window.removeEventListener('click', listener);
Parameters
| Name | Type | Description |
|---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to |
Returns
- Type
- void
# rotate
8.0.0 9.2.0Returns 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
8.0.0 9.2.0Returns 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
8.0.0 9.2.0Returns 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