Scaleform Studio Lua API Reference: Matrix3F object reference
Matrix3F object reference
Description
A three-dimensional matrix in row-major order.
Constructors and accessors 
Other related reference items
Related help topics
Functions
Parameters
Returns
angleRad : | number |
The rotation angle in radians. |
xaxis : | number |
The x axis to rotate about. |
yaxis : | number |
The y axis to rotate about. |
zaxis : | number |
The z axis to rotate about. |
pivotx : | number |
The pivot point of the rotation around x axis. |
pivoty : | number |
The pivot point of the rotation around y axis. |
pivotz : | number |
The pivot point of the rotation around z axis. |
|
The newly created matrix. |
Matrix3F.Append (self, m) : Matrix3FAppends the matrix by multiplying the specified matrix by the current matrix.
Matrix3F.Identity () : Matrix3FCreates a new identity matrix.
Matrix3F.Invert (self) : Matrix3FInverts the matrix.
Matrix3F.New () : Matrix3FCreates a new matrix.
Matrix3F.Prepend (self, m) : Matrix3FPrepend a matrix by multiplying the current matrix by the passed matrix.
Matrix3F.Rotation (angleRad, xaxis, yaxis, zaxis, pivotx, pivoty, pivotz) : Matrix3FCreates a rotation matrix.
Matrix3F.Translation (dx, dy, dz) : Matrix3FCreates a translation matrix.
scaleform.Actor.local_matrix_3d (self) : Matrix3FReturns the 3D transform matrix on the actor.
scaleform.Actor.projection_matrix_3d (self, inherit) : Matrix3F?Returns the projection matrix set on the actor for drawing 3D movie clips.
scaleform.Actor.view_matrix_3d (self, inherit) : Matrix3F?Returns the view matrix set on the actor for drawing 3D movie clips.
scaleform.Actor.set_local_matrix_3d (self, matrix) Sets a 3D transform matrix on the actor.
scaleform.Actor.set_projection_matrix_3d (self, matrix) Sets a projection matrix on the actor for drawing 3D movie clips.
scaleform.Actor.set_view_matrix_3d (self, matrix) Sets a view matrix on the actor for drawing 3D movie clips.
self : Matrix3FThe 3D matrix currently in use.
m : Matrix3FMatrix which is multiplied by the current matrix.
Matrix3FThe transformed matrix.
Matrix3FA three-dimensional matrix in row-major order.
Matrix3F.AsTable (self) : tableReturns the matrix as an array of floats.
self : Matrix3FThe 3D matrix currently in use.
tableAn array of floats.A Lua table consisting of paired keys and values.
Matrix3FThe newly created matrix.
self : Matrix2FThe 3D matrix currently in use.
Matrix3FThe inverted matrix.
Matrix2FA two-dimensional matrix in row-major order.
Matrix3FThe newly created matrix.
self : Matrix3FThe 3D matrix currently in use.
m : Matrix3FThe matrix to be multiplied.
Matrix3FThe transformed matrix.
angleRad : numberThe rotation angle in radians.
xaxis : numberThe x axis to rotate about.
yaxis : numberThe y axis to rotate about.
zaxis : numberThe z axis to rotate about.
pivotx : numberThe pivot point of the rotation around x axis.
pivoty : numberThe pivot point of the rotation around y axis.
pivotz : numberThe pivot point of the rotation around z axis.
Matrix3FThe newly created matrix.A numeric value.
dx : numberTranslation value along the x axis.
dy : numberTranslation value along the y axis.
dz : numberTranslation value along the z axis.
Matrix3FThe newly created matrix.
self : scaleform.ActorThe actor whose transform matrix is retrieved.
Matrix3FThe 3D transform matrix.
self : scaleform.ActorThe actor whose projection matrix is retrieved.
inherit : booleanA boolean flag.
Matrix3F?The projection matrix.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
self : scaleform.ActorThe actor whose view matrix is retrieved.
inherit : booleanA boolean flag.
Matrix3F?The view matrix.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
self : scaleform.ActorThe actor whose transform matrix is set.
matrix : Matrix3FThe 3D transform matrix to be set.
self : scaleform.ActorThe actor whose projection matrix is set.
matrix : Matrix3FThe projection matrix to set.
self : scaleform.ActorThe actor whose view matrix is set.
matrix : Matrix3FThe view matrix to set.
scaleform.ActorGeneric objects located in a scene. true or false.Indicates a table.
This documentation uses the term table to mean an anonymous, temporary Lua table that contains named data values. You typically use these tables to pass data or settings to a function, or to hold data returned by a function.Indicates an object.
This documentation uses the term object to mean a named Lua table or userdata value that maintains a state. Some object types may have multiple instances existing at the same time, each with its own state; these objects typically have creation functions or accessors that you must call in order to get an instance. Some object types have only one instance, which you always access through the object's name.Indicates a named variable within a namespace, object or table; or an element within an enumeration.Indicates a code sample.Indicates an enumeration.
This documentation uses the term enumeration to mean a named Lua table that contains only a set of constant values. These values typically identify a predefined set of options for some setting or behavior. You might pass an enumeration value to a function, or test the value returned by a function against the items in the enumeration to see which option is currently set.Indicates a named variable within a namespace or object that has a pre-set constant value.Indicates a category: a semantic grouping of related API elements.Indicates a namespace.
This documentation uses the term namespace to mean a named Lua table that exists in only one single instance, intended as a container for an interface of related objects, functions and data variables.Indicates an output value returned by a function.Indicates a named function within a namespace or object.Indicates an input parameter for a function.