Scaleform Studio Lua API Reference: Matrix2F object reference

Matrix2F object reference
Functions
expand all | collapse all

Description

A two-dimensional matrix in row-major order.

Functions

Parameters

self :

Matrix2F

The 2D matrix currently in use.

m :

Matrix2F

Matrix which is multiplied by the current matrix.

Returns

Matrix2F

The transformed matrix.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

m :

Matrix2F

The matrix to which append operation is performed.

pt :

scaleform.Point?

The pivot point.

The ? notation indicates that this type is optional: there may be zero or one instances of it.
Returns

Matrix2F

The transformed matrix.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

rot :

number

The rotation angle in radians.

Returns

Matrix2F

The rotated matrix.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

scale :

number

The scaling factor applied.

Returns

Matrix2F

The modified matrix.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

scale_x :

number

The x scaling factor applied.

scale_y :

number

The y scaling factor applied.

Returns

Matrix2F

The modified matrix.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

scale :

scaleform.Size

The scaling factor applied.

Returns

Matrix2F

The modified matrix.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

shearx :

number

Amount to shear the x coordinate.

sheary :

number

Amount to shear the y coordinate.

Returns

Matrix2F

The sheared matrix.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

tx :

number

Translation value along the x axis.

ty :

number

Translation value along the y axis.

Returns

Matrix2F

The translated matrix.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

Returns

boolean

Returns true if the matrix reverses handedness and false otherwise.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

r :

table

The rectangle to be transformed.

Returns

table

The transformed rectangle.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

r :

table

The inverse rectangle.

Returns

table

The transformed rectangle.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

Returns

table

An array of floats.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

Returns

number

The determinant value.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

Returns

Matrix2F

The inverse of the original matrix.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

Returns

number

The scale value.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

Returns

number

The rotation value.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

Returns

number

The scale value.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

Returns

number

The scale value.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

Returns

number

The scale value.

Parameters
This function does not accept any parameters.
Returns

Matrix2F

The newly created matrix.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

Returns

Matrix2F

The inverted matrix.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

epsilon :

number

Value by which the matrix is rotated.

Returns

boolean

Returns true if the matrix has arbitrary rotation and false otherwise.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

Returns

boolean

Returns true if identity matrix and false otherwise.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

Returns

boolean

Returns true if the matrix is valid and false otherwise.

Parameters
This function does not accept any parameters.
Returns

Matrix2F

The newly created matrix.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

m :

Matrix2F

The matrix to be multiplied.

Returns

Matrix2F

The transformed matrix.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

rot :

number

The rotation angle in radians.

Returns

Matrix2F

The rotated matrix.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

scale :

number

The scaling factor applied.

Returns

Matrix2F

The modified matrix.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

shearx :

number

Amount to shear the x coordinate.

sheary :

number

Amount to shear the y coordinate.

Returns

Matrix2F

The sheared matrix.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

tx :

number

Translation value along the x axis.

ty :

number

Translation value along the y axis.

Returns

Matrix2F

The translated matrix.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

Returns
This function does not return any values.
Parameters

radians :

number

The rotation angle in radians.

Returns

Matrix2F

The newly created matrix.

Parameters

scale :

number

The scale factor applied.

Returns

Matrix2F

The newly created matrix.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

Returns
This function does not return any values.
Parameters

self :

Matrix2F

The 2D matrix currently in use.

m :

Matrix2F

Matrix to inverse.

Returns
This function does not return any values.
Parameters

self :

Matrix2F

The 2D matrix currently in use.

m1 :

Matrix2F

The matrix 1.

m2 :

Matrix2F

The matrix 2.

t :

number

Amount to interpolate between the values of the two matrices.

Returns
This function does not return any values.
Parameters

self :

Matrix2F

The 2D matrix currently in use.

mtx :

Matrix2F

The passed matrix.

Returns
This function does not return any values.
Parameters

self :

Matrix2F

The 2D matrix currently in use.

parlSrc :

table

An array of three points of the original parallelogram.

parlDst :

table

An array of three points of the transformed parallelogram.

Returns

Matrix2F

The transformed parallelogram.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

parl :

table

An array representing the coordinates of the parallelogram.

x1 :

number

The x coordinate value of the bottom left corner of the rectangle.

y1 :

number

The y coordinate value of a bottom left corner of the rectangle.

x2 :

number

The x coordinate value of top right corner point of the rectangle.

y2 :

number

The y coordinate value of top right corner point of the rectangle.

Returns

table

The transformed rectangle.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

x1 :

number

The x coordinate value of the bottom left corner of the rectangle.

y1 :

number

The y coordinate value of a bottom left corner of the rectangle.

x2 :

number

The x coordinate value of top right corner point of the rectangle.

y2 :

number

The y coordinate value of top right corner point of the rectangle.

parl :

table

An array representing the coordinates of the parallelogram.

Returns

Matrix2F

The transformed parallelogram.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

srcX1 :

number

The x coordinate value of the bottom left corner of the rectangle.

srcY1 :

number

The y coordinate value of a bottom left corner of the rectangle.

srcX2 :

number

The x coordinate value of top right corner point of the rectangle.

srcY2 :

number

The y coordinate value of top right corner point of the rectangle.

destX1 :

number

The x coordinate value of the bottom left corner of the new rectangle.

destY1 :

number

The y coordinate value of the bottom left corner of the new rectangle.

destX2 :

number

The x coordinate value of the top right corner of the new rectangle

destY2 :

number

The y coordinate value of the top right corner of the new rectangle.

Returns

table

The transformed rectangle.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

m0 :

Matrix2F

The matrix to be multiplied.

m1 :

Matrix2F

The second matrix to be appended.

m2 :

Matrix2F

The optional third matrix to be appended.

Returns
This function does not return any values.
Parameters

self :

Matrix2F

The 2D matrix currently in use.

x :

number

The scale factor to be applied.

Returns
This function does not return any values.
Parameters

self :

Matrix2F

The 2D matrix currently in use.

y :

number

The scale factor to be applied.

Returns
This function does not return any values.
Parameters

self :

Matrix2F

The 2D matrix currently in use.

Returns
This function does not return any values.
Parameters

sh :

number

The shear factor along the x coordinate.

sv :

number

The shear factor along the y coordinate.

Returns

Matrix2F

The newly created matrix.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

Returns

number

The matrix element.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

Returns

number

The matrix element.

Parameters

mtx :

Matrix2F

The 2D matrix currently in use.

mtx2 :

Matrix2F

A matrix to swap with the original matrix.

Returns
This function does not return any values.
Parameters

self :

Matrix2F

The 2D matrix currently in use.

Returns

number

The matrix element.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

Returns

number

The matrix element.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

pt :

scaleform.Point

The point which is to be transformed.

Returns

scaleform.Point

A point containing the result of the transformation.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

pt :

scaleform.Point

The point to be transformed.

Returns

scaleform.Point

A point containing the result of the transformation.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

pt :

scaleform.Point

Vector to transform.

Returns

scaleform.Point

A point containing the result of the transformation.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

pt :

scaleform.Point

Vector to transform.

Returns

scaleform.Point

A point containing the result of the transformation.

Parameters
This function does not accept any parameters.
Returns

Matrix2F

The newly created matrix.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

Returns

number

The matrix element.

Parameters

self :

Matrix2F

The 2D matrix currently in use.

Returns

number

The matrix element.

 Matrix2F.Append (self, m) : Matrix2F
Appends the matrix by multiplying the specified matrix by the current matrix.  Matrix2F.AppendRelative (self, m, pt) : Matrix2F
Performs the Append transform operation relative to a specified origin/pivot point.  Matrix2F.AppendRotation (self, rot) : Matrix2F
Appends a rotation to the matrix.  Matrix2F.AppendScaling (self, scale_x, scale_y) : Matrix2F
Appends a scale change to the matrix.  Matrix2F.AppendScaling (self, scale) : Matrix2F
Appends a scale change to the matrix.  Matrix2F.AppendScaling (self, scale) : Matrix2F
Appends a scale change to the matrix.  Matrix2F.AppendShearing (self, shearx, sheary) : Matrix2F
Appends a shearing to the matrix.  Matrix2F.AppendTranslation (self, tx, ty) : Matrix2F
Appends a translation to the matrix.  Matrix2F.GetInverse (self) : Matrix2F
Returns the inverse of the original matrix.  Matrix2F.Identity () : Matrix2F
Creates a new identity matrix.  Matrix2F.Invert (self) : Matrix2F
Inverts the matrix.  Matrix2F.New () : Matrix2F
Creates a new matrix.  Matrix2F.Prepend (self, m) : Matrix2F
Prepend a matrix by multiplying the current matrix by the passed matrix.  Matrix2F.PrependRotation (self, rot) : Matrix2F
Prepends a rotation to the matrix.  Matrix2F.PrependScaling (self, scale) : Matrix2F
Prepends a scale change to the matrix.  Matrix2F.PrependShearing (self, shearx, sheary) : Matrix2F
Prepends a shearing to the matrix.  Matrix2F.PrependTranslation (self, tx, ty) : Matrix2F
Prepends a translation to the matrix.  Matrix2F.Rotation (radians) : Matrix2F
Creates a rotation matrix.  Matrix2F.Scaling (scale) : Matrix2F
Creates a scale matrix.  Matrix2F.SetParlToParl (self, parlSrc, parlDst) : Matrix2F
Transforms a parallelogram to a new parallelogram.  Matrix2F.SetRectToParl (self, x1, y1, x2, y2, parl) : Matrix2F
Transforms a rectangle to a parallelogram.  Matrix2F.Shearing (sh, sv) : Matrix2F
Creates a shear matrix.  Matrix2F.Translation () : Matrix2F
Creates a translation matrix.  scaleform.Actor.local_matrix (self) : Matrix2F
Returns the 2D transform matrix on the actor.  scaleform.Actor.world_matrix (self) : Matrix2F
Returns the concatenated matrix (all ancestor transforms, times the matrix).  scaleform.Actor.world_matrix_3d (self) : Matrix2F
Returns the concatenated world matrix (complete 2D + 3D world matrix).  scaleform.ShapeComponent.create_gradient_matrix (w, h, rot, tx, ty) : Matrix2F
  scaleform.Stage.transform_to_screen_matrix () : Matrix2F
Returns the transform to convert from stage coordinates to screen (window) coordinates.  Matrix3F.Invert (self) : Matrix3F
Inverts the matrix.  scaleform.Actor.bounds (self, matrix) : scaleform.Rect?
Returns the character bounds in specified coordinate space.  scaleform.Actor.concatenate_matrix (self, matrix)
Concatenates the passed matrix to the actor.  scaleform.Actor.rect_bounds (self, matrix) : scaleform.Rect?
Returns character bounds excluding stroke.  scaleform.Actor.set_local_matrix (self, matrix)
Sets a 2D transform matrix on the actor.  scaleform.Actor.visible_bounds (self, matrix) : scaleform.Rect?
Returns the visible bounds.  scaleform.ShapeComponent.set_bitmap_fill (self, imageRes, matrix, repeat, smooth) : boolean
Fills a drawing area with a bitmap image.  scaleform.ShapeComponent.set_gradient_fill (self, gradType, matrix, colors, ratios, focalPointRatio, linearRGB)
Sets a gradient fill.  scaleform.ShapeComponent.set_line_gradient_style (self, gradType, matrix, colors, ratios, focalPointRatio, linearRGB) : boolean
Sets a gradient line style.  scaleform.Stage.set_user_matrix (mat)
Sets the "user" matrix that is applied to shift the view just before the viewport.  scaleform.Stage.translate_point_to_screen (p, userMatrix) : scaleform.Point
Translates a point in Stage coordinates to screen (window) coordinates.  scaleform.Stage.translate_rect_to_screen (rect, userMatrix) : scaleform.Rect
Translates a rectangle in Stage coordinates to screen (window) coordinates.  scaleform.VisualComponent.bounds (self, matrix) : scaleform.Rect
Returns the component bounds multiplied by the provided matrix.  scaleform.VisualComponent.rect_bounds (self, matrix) : scaleform.Rect
Returns the component bounds excluding any stroke multiplied by the provided matrix.  self : Matrix2F
The 2D matrix currently in use.  m : Matrix2F
Matrix which is multiplied by the current matrix.  Matrix2F
The transformed matrix.  Matrix2F
A two-dimensional matrix in row-major order.  self : Matrix2F
The 2D matrix currently in use.  m : Matrix2F
The matrix to which append operation is performed.  pt : scaleform.Point?
The pivot point.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  Matrix2F
The transformed matrix.  scaleform.Point
Point should be in the form of a table {x=a, y=b}
{ PropertyType : string, x : number, y : number, }  self : Matrix2F
The 2D matrix currently in use.  rot : number
The rotation angle in radians.  Matrix2F
The rotated matrix.A numeric value.  self : Matrix2F
The 2D matrix currently in use.  scale : number
The scaling factor applied.  Matrix2F
The modified matrix.  self : Matrix2F
The 2D matrix currently in use.  scale_x : number
The x scaling factor applied.  scale_y : number
The y scaling factor applied.  Matrix2F
The modified matrix.  self : Matrix2F
The 2D matrix currently in use.  scale : scaleform.Size
The scaling factor applied.  Matrix2F
The modified matrix.  scaleform.Size
Width should be in the form of a table {width=a, height=b}
{ height : number, width : number, }  self : Matrix2F
The 2D matrix currently in use.  shearx : number
Amount to shear the x coordinate.  sheary : number
Amount to shear the y coordinate.  Matrix2F
The sheared matrix.  self : Matrix2F
The 2D matrix currently in use.  tx : number
Translation value along the x axis.  ty : number
Translation value along the y axis.  Matrix2F
The translated matrix.  Matrix2F.DoesFlip (self) : boolean
Returns true if the matrix reverses handedness.  self : Matrix2F
The 2D matrix currently in use.  booleantrue or false.  Matrix2F.EncloseTransform (self, r) : table
Transforms a rectangle and returns its bounding area.  self : Matrix2F
The 2D matrix currently in use.  r : table
The rectangle to be transformed.  table
The transformed rectangle.A Lua table consisting of paired keys and values.  Matrix2F.EncloseTransformByInverse (self, r) : table
Transforms a rectangle by its inverse and returns its bounding area.  self : Matrix2F
The 2D matrix currently in use.  r : table
The inverse rectangle.  table
The transformed rectangle.  Matrix2F.GetAsFloat2x4 (self) : table
Returns the matrix as an array of floats.  self : Matrix2F
The 2D matrix currently in use.  table
An array of floats.  Matrix2F.GetDeterminant (self) : number
Obtains the determinant of the 2x2 rotation/scale part only.  self : Matrix2F
The 2D matrix currently in use.  number  self : Matrix2F
The 2D matrix currently in use.  Matrix2F
The inverse of the original matrix.  Matrix2F.GetMaxScale (self) : number
Returns the maximum scale factor that this transform applies.  self : Matrix2F
The 2D matrix currently in use.  number  Matrix2F.GetRotation (self) : number
Returns the rotation component (in radians).  self : Matrix2F
The 2D matrix currently in use.  number  Matrix2F.GetScale (self) : number
Returns the isotropic scale, proportional to the diagonal (0,0) - (1,1).  self : Matrix2F
The 2D matrix currently in use.  number  Matrix2F.GetXScale (self) : number
Returns the magnitude scale of the x coordinate output.  self : Matrix2F
The 2D matrix currently in use.  number  Matrix2F.GetYScale (self) : number
Returns the magnitude scale of the y coordinate output.  self : Matrix2F
The 2D matrix currently in use.  number  Matrix2F
The newly created matrix.  self : Matrix2F
The 2D matrix currently in use.  Matrix2F
The inverted matrix.  Matrix2F.IsFreeRotation (self, epsilon) : boolean
Checks whether the matrix has arbitrary rotation.  self : Matrix2F
The 2D matrix currently in use.  epsilon : number
Value by which the matrix is rotated.  boolean  Matrix2F.IsIdentity (self) : boolean
Checks whether the matrix is an identity matrix.  self : Matrix2F
The 2D matrix currently in use.  boolean  Matrix2F.IsValid (self) : boolean
Determines whether the matrix is valid or not.  self : Matrix2F
The 2D matrix currently in use.  boolean  Matrix2F
The newly created matrix.  self : Matrix2F
The 2D matrix currently in use.  m : Matrix2F
The matrix to be multiplied.  Matrix2F
The transformed matrix.  self : Matrix2F
The 2D matrix currently in use.  rot : number
The rotation angle in radians.  Matrix2F
The rotated matrix.  self : Matrix2F
The 2D matrix currently in use.  scale : number
The scaling factor applied.  Matrix2F
The modified matrix.  self : Matrix2F
The 2D matrix currently in use.  shearx : number
Amount to shear the x coordinate.  sheary : number
Amount to shear the y coordinate.  Matrix2F
The sheared matrix.  self : Matrix2F
The 2D matrix currently in use.  tx : number
Translation value along the x axis.  ty : number
Translation value along the y axis.  Matrix2F
The translated matrix.  Matrix2F.Reset (self)
Resets the matrix back to the identity matrix.  self : Matrix2F
The 2D matrix currently in use.  radians : number
The rotation angle in radians.  Matrix2F
The newly created matrix.  scale : number
The scale factor applied.  Matrix2F
The newly created matrix.  Matrix2F.SetIdentity (self)
Sets the matrix to the identity matrix.  self : Matrix2F
The 2D matrix currently in use.  Matrix2F.SetInverse (self, m)
Sets the matrix to the inverse of the passed matrix.  self : Matrix2F
The 2D matrix currently in use.  m : Matrix2F
Matrix to inverse.  Matrix2F.SetLerp (self, m1, m2, t)
Creates a new matrix from a blend of the passed two matrices m1 and m2, parameterized by t.  self : Matrix2F
The 2D matrix currently in use.  m1 : Matrix2F
The matrix 1.  m2 : Matrix2F
The matrix 2.  t : number
Amount to interpolate between the values of the two matrices.  Matrix2F.SetMatrix (self, mtx)
Creates a new matrix from the passed values.  self : Matrix2F
The 2D matrix currently in use.  mtx : Matrix2F
The passed matrix.  self : Matrix2F
The 2D matrix currently in use.  parlSrc : table
An array of three points of the original parallelogram.  parlDst : table
An array of three points of the transformed parallelogram.  Matrix2F
The transformed parallelogram.  Matrix2F.SetParlToRect (self, parl, x1, y1, x2, y2) : table
Transforms a parallelogram to a rectangle.  self : Matrix2F
The 2D matrix currently in use.  parl : table
An array representing the coordinates of the parallelogram.  x1 : number
The x coordinate value of the bottom left corner of the rectangle.  y1 : number
The y coordinate value of a bottom left corner of the rectangle.  x2 : number
The x coordinate value of top right corner point of the rectangle.  y2 : number
The y coordinate value of top right corner point of the rectangle.  table
The transformed rectangle.  self : Matrix2F
The 2D matrix currently in use.  x1 : number
The x coordinate value of the bottom left corner of the rectangle.  y1 : number
The y coordinate value of a bottom left corner of the rectangle.  x2 : number
The x coordinate value of top right corner point of the rectangle.  y2 : number
The y coordinate value of top right corner point of the rectangle.  parl : table
An array representing the coordinates of the parallelogram.  Matrix2F
The transformed parallelogram.  Matrix2F.SetRectToRect (self, srcX1, srcY1, srcX2, srcY2, destX1, destY1, destX2, destY2) : table
Transforms a rectangle to a new rectangle.  self : Matrix2F
The 2D matrix currently in use.  srcX1 : number
The x coordinate value of the bottom left corner of the rectangle.  srcY1 : number
The y coordinate value of a bottom left corner of the rectangle.  srcX2 : number
The x coordinate value of top right corner point of the rectangle.  srcY2 : number
The y coordinate value of top right corner point of the rectangle.  destX1 : number
The x coordinate value of the bottom left corner of the new rectangle.  destY1 : number
The y coordinate value of the bottom left corner of the new rectangle.  destX2 : number
The x coordinate value of the top right corner of the new rectangle  destY2 : number
The y coordinate value of the top right corner of the new rectangle.  table
The transformed rectangle.  Matrix2F.SetToAppend (self, m0, m1, m2)
Initializes the current matrix to the result of appended matrices.  self : Matrix2F
The 2D matrix currently in use.  m0 : Matrix2F
The matrix to be multiplied.  m1 : Matrix2F
The second matrix to be appended.  m2 : Matrix2F
The optional third matrix to be appended.  Matrix2F.SetXScale (self, x)
Sets the scale factor to be applied along the x axis.  self : Matrix2F
The 2D matrix currently in use.  x : number
The scale factor to be applied.  Matrix2F.SetYScale (self, y)
Sets the scale factor to be applied along the y axis.  self : Matrix2F
The 2D matrix currently in use.  y : number
The scale factor to be applied.  Matrix2F.SetZero (self)
Set the matrix to all zero components.  self : Matrix2F
The 2D matrix currently in use.  sh : number
The shear factor along the x coordinate.  sv : number
The shear factor along the y coordinate.  Matrix2F
The newly created matrix.  Matrix2F.Shx (self) : number
Access matrix element which represents shearing in X.  self : Matrix2F
The 2D matrix currently in use.  number  Matrix2F.Shy (self) : number
Access matrix element which represents shearing in Y.  self : Matrix2F
The 2D matrix currently in use.  number  Matrix2F.Swap (mtx, mtx2)
Swaps the values of two matrices.  mtx : Matrix2F
The 2D matrix currently in use.  mtx2 : Matrix2F
A matrix to swap with the original matrix.  Matrix2F.Sx (self) : number
Access matrix element which represents scaling in X.  self : Matrix2F
The 2D matrix currently in use.  number  Matrix2F.Sy (self) : number
Access matrix element which represents scaling in Y.  self : Matrix2F
The 2D matrix currently in use.  number  Matrix2F.Transform (self, pt) : scaleform.Point
Transforms the point by the matrix.  self : Matrix2F
The 2D matrix currently in use.  pt : scaleform.Point
The point which is to be transformed.  scaleform.Point
A point containing the result of the transformation.  Matrix2F.TransformByInverse (self, pt) : scaleform.Point
Transforms the point by the inverse of the matrix.  self : Matrix2F
The 2D matrix currently in use.  pt : scaleform.Point
The point to be transformed.  scaleform.Point
A point containing the result of the transformation.  Matrix2F.TransformVector (self, pt) : scaleform.Point
Transforms the vector by the matrix.  self : Matrix2F
The 2D matrix currently in use.  pt : scaleform.Point
Vector to transform.  scaleform.Point
A point containing the result of the transformation.  Matrix2F.TransformVectorByInverse (self, pt) : scaleform.Point
Transforms the vector by the inverse of the matrix.  self : Matrix2F
The 2D matrix currently in use.  pt : scaleform.Point
Vector to transform.  scaleform.Point
A point containing the result of the transformation.  Matrix2F
The newly created matrix.  Matrix2F.Tx (self) : number
Access matrix element which represents translation in X.  self : Matrix2F
The 2D matrix currently in use.  number  Matrix2F.Ty (self) : number
Access matrix element which represents translation in Y.  self : Matrix2F
The 2D matrix currently in use.  number  self : scaleform.Actor
The actor whose transform matrix is retrieved.  Matrix2F
The 2D transform matrix.  self : scaleform.Actor
The actor whose world matrix is retrieved.  Matrix2F
The concatenated world matrix.  self : scaleform.Actor
The actor whose world matrix is retrieved.  Matrix2F
The concatenated world matrix.  w : number
The width of the gradient.  h : number
The height of the gradient.  rot : number
The rotation of gradient in radians.  tx : number
The translation of the gradient along the x axis.  ty : number
The translation of the gradient along the y axis.  Matrix2F
A matrix which can be used when setting the gradient styles on Shapes.  Matrix2F
The transform matrix  self : Matrix2F
The 3D matrix currently in use.  Matrix3F
The inverted matrix.  self : scaleform.Actor
The actor whose bounds is retrieved.  matrix : Matrix2F
The transformation matrix used for calculating the bounding rectangle.  scaleform.Rect?
A rectangle representing character bounds in the coordinate space.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  self : scaleform.Actor
The actor to which a matrix is concatenated.  matrix : Matrix2F
The matrix to concatenate.  self : scaleform.Actor
The actor whose bounds is retrieved.  matrix : Matrix2F
The transformation matrix used for calculating the bounding rectangle.  scaleform.Rect?
A rectangle representing character bounds in the coordinate space.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  self : scaleform.Actor
The actor whose transform matrix is set.  matrix : Matrix2F
The 2D transform matrix to be set.  self : scaleform.Actor
The actor whose bounds is retrieved.  matrix : Matrix2F
The transformation matrix used for calculating the bounding rectangle.  scaleform.Rect?
The The visible bounds.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  self : scaleform.ShapeComponent
The shape component to load.  imageRes : lightuserdata
The image to be filled with.  matrix : Matrix2F
A transformation matrix that can be used to scale or otherwise manipulate the bitmap before applying it to the line style.  repeat : boolean?
Default value of true. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  smooth : boolean?
Default value of true. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  boolean  self : scaleform.ShapeComponent
The shape component to fill.  gradType : string
The gradient type to fill in.  matrix : Matrix2F
A transformation matrix that can be used to scale or otherwise manipulate the bitmap before applying it to the line style.  colors : scaleform.Color[]
Array of colors for the fill.
The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown.
  ratios : number[]
An array of color distribution ratios. [more...]
The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown.
  focalPointRatio : number?
Location of the focal point of the gradient.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  linearRGB : boolean?
Default value of true.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  self : scaleform.ShapeComponent
The shape component to set the line gradient style of.  gradType : string
The gradient type to fill in.  matrix : Matrix2F
A transformation matrix that can be used to scale or otherwise manipulate the bitmap before applying it to the line style.  colors : scaleform.Color[]
Array of colors for the fill.
The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown.
  ratios : number[]
An array of color distribution ratios. [more...]
The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown.
  focalPointRatio : number?
Location of the focal point of the gradient.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  linearRGB : boolean?
Default value of true.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  boolean  mat : Matrix2F
A 2D user matrix that is used to transform all rendering in addition to the regular matrix transform.  p : scaleform.Point
The point in stage coordinates  userMatrix : Matrix2F
The renderer matrix  scaleform.Point
The point in screen coordinates  rect : scaleform.Rect
The rectangle in stage coordinates  userMatrix : Matrix2F
The renderer matrix  scaleform.Rect
The rectangle in screen coordinates  self : scaleform.VisualComponent
The visual component to get the bounds from.  matrix : Matrix2F
The matrix that defines the space the bounds will be transformed into.  scaleform.Rect
The transformed bounds of the component.  self : scaleform.VisualComponent
The visual component to get the bounds from.  matrix : Matrix2F
The matrix that defines the space the bounds will be transformed into.  scaleform.Rect
The transformed bounds of the component.A string of characters.  scaleform.Actor
Generic objects located in a scene.  Matrix3F
A three-dimensional matrix in row-major order.  scaleform.Rect
A rectangle based upon two points.
{ x1 : number, x2 : number, y1 : number, y2 : number, }  scaleform.ShapeComponent
An interface to shape component. A pointer to a memory block that is allocated and maintained in C.  scaleform.Color

{ alpha : integer, blue : integer, green : integer, red : integer, }  scaleform.VisualComponent
An interface to the visual component. A strictly integral numeric value, with no decimal component.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.
Please send us your comment about this page