Scaleform Studio Lua API Reference: scaleform.VisualComponent object reference
scaleform.VisualComponent object reference
Description
An interface to the visual component.
A visual component has dimensions and bounds.
Inheritance 
Related help topics
Functions
Parameters
Returns
self : |
The visual component to get the bounds from. | |
matrix : |
The matrix that defines the space the bounds will be transformed into. |
|
The transformed bounds of the component. |
Parameters
Returns
self : |
The visual component to get the dimensions of. |
|
Returns the size of the component or nil if there are no dimensions. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
scaleform.ComponentThe root type of all actor components.
scaleform.BitmapComponentAn interface to bitmap component.
scaleform.ContainerComponentAn interface to container component.
scaleform.AnimationComponentControls a timeline animation
scaleform.ShapeComponentAn interface to shape component.
scaleform.SpriteComponentRepresents a sprite object.
scaleform.TextComponentRepresent the text field.
scaleform.VisualComponent.bounds (self, matrix) : scaleform.RectReturns the component bounds multiplied by the provided matrix.
self : scaleform.VisualComponentThe visual component to get the bounds from.
matrix : Matrix2FThe matrix that defines the space the bounds will be transformed into.
scaleform.RectThe transformed bounds of the component.
scaleform.VisualComponentAn interface to the visual component.
Matrix2FA two-dimensional matrix in row-major order.
scaleform.RectA rectangle based upon two points.
{ x1 : number, x2 : number, y1 : number, y2 : number, }
scaleform.VisualComponent.dimensions (self) : scaleform.Size?Get the component dimensions in stage space.
self : scaleform.VisualComponentThe visual component to get the dimensions of.
scaleform.Size?Returns the size of the component or nil if there are no dimensions.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.SizeWidth should be in the form of a table {width=a, height=b}
{ height : number, width : number, }
scaleform.VisualComponent.rect_bounds (self, matrix) : scaleform.RectReturns the component bounds excluding any stroke multiplied by the provided matrix.
self : scaleform.VisualComponentThe visual component to get the bounds from.
matrix : Matrix2FThe matrix that defines the space the bounds will be transformed into.
scaleform.RectThe transformed bounds of the component.A numeric value.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.