Scaleform Studio Lua API Reference: scaleform.Rect table reference

scaleform.Rect table reference
Data Members
expand all | collapse all

Description

A rectangle based upon two points.

Data Members

x1 : number
X coordinate of point 1
x2 : number
X coordinate of point 2
y1 : number
Y coordinate of point 1
y2 : number
Y coordinate of point 2
 scaleform.Actor.bounds (self, matrix) : scaleform.Rect?
Returns the character bounds in specified coordinate space.  scaleform.Actor.rect_bounds (self, matrix) : scaleform.Rect?
Returns character bounds excluding stroke.  scaleform.Actor.scale9_grid (self) : scaleform.Rect?
Returns the scale9grid set on the actor.  scaleform.Actor.visible_bounds (self, matrix) : scaleform.Rect?
Returns the visible bounds.  scaleform.Actor.world_bounds (self) : scaleform.Rect?
Returns the transformed bounds of character in root movie space.  scaleform.physics.Fixture.aabb_by_index (self, index) : scaleform.Rect
Get the fixture's AABB.  scaleform.physics.Shape.compute_aabb (self, position, rotation, chainShapeChildIndex) : scaleform.Rect
Given a transform, compute the associated axis aligned bounding box for a child shape.  scaleform.Rect (init) : scaleform.Rect
Create an initialized rectangle table.  scaleform.Stage.rect () : scaleform.Rect
Returns the rectangle of the stage.  scaleform.Stage.safe_rect () : scaleform.Rect
Returns the safe rectangle.  scaleform.Stage.translate_rect_to_screen (rect, userMatrix) : scaleform.Rect
Translates a rectangle in Stage coordinates to screen (window) coordinates.  scaleform.Stage.visible_frame_rect () : scaleform.Rect
Gets currently visible frame rectangle in pixels.  scaleform.TextComponent.rect (self) : scaleform.Rect
Returns the position and dimensions of the text component.  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.  scaleform.Actor.perform_hit_test (self, rect, checkShape) : boolean
Test if rect intersects or contains the actor.  scaleform.Actor.set_bounds (self, bounds)
Sets the bounds of the actor.  scaleform.Actor.set_scale9_grid (self, rect)
Sets a scale9grid on the actor.  scaleform.CameraComponent.center_on_rect (self, rect)
Move the camera to center the rect on screen.  scaleform.ContainerComponent.actors_in_rect (self, rect, testShape) : scaleform.Actor[]
Gets the container's objects that are inside a rect.  scaleform.Rect (init) : scaleform.Rect
Create an initialized rect table.  scaleform.ShapeComponent.draw_rect (self, rect) : boolean
Draws a rect using current line and fill styles.  scaleform.ShapeComponent.draw_round_rect (self, rect, radii) : boolean
Draws a rounded rect using current line and fill styles.  scaleform.ShapeComponent.draw_round_rect_complex (self, rect, top_left_rad, top_right_rad, bot_left_rad, bot_right_rad) : boolean
Draws a complex rounded rect using current line and fill styles.  scaleform.Stage.make_area_visible (screen, box, flags)
Scrolls viewport to make 'box' fully visible inside the 'screen'.  scaleform.Stage.set_rect (rect)
Sets the rectangle of the stage in pixels.  scaleform.Stage.set_safe_rect (rect)
Sets the safe rectangle.  scaleform.TextComponent.set_rect (self, rect)
Sets the position and dimensions of the text component.  scaleform.Rect.x1 : number
X coordinate of point 1 A numeric value.  scaleform.Rect.x2 : number
X coordinate of point 2  scaleform.Rect.y1 : number
Y coordinate of point 1  scaleform.Rect.y2 : number
Y coordinate of point 2  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 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 scale9grid is applied.  scaleform.Rect?
The scale9grid applied on the actor.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  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.Actor
The actor whose bounds is retrieved.  scaleform.Rect?
The transformed bounds of character.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  self : scaleform.physics.Fixture
The fixture currently in use.  index : number
The child index of the fixture proxy.  scaleform.Rect
The AABB for the fixture currently in use.  self : scaleform.physics.Shape
The shape currently in use.  position : scaleform.Point
The world position of the shape.  rotation : number
The world rotation of the shape.  chainShapeChildIndex : integer?
The child shape index.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Rect
Returns the computed aabb for the child shape.  init : scaleform.Rect?
An table arguments to initialize the returned scaleform.Rect table with. [more...]
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Rect
Returns a fully constructed rectangle table.  scaleform.Rect
A rectangle of the stage.  scaleform.Rect
The safe rectangle, coordinates are in pixels.  rect : scaleform.Rect
The rectangle in stage coordinates  userMatrix : Matrix2F
The renderer matrix  scaleform.Rect
The rectangle in screen coordinates  scaleform.Rect
The currently visible rectangle.  self : scaleform.TextComponent
The text component whose dimensions is set.  scaleform.Rect
The rectangle within the text 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.  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.Actor
The actor to perform the hit test on.  rect : scaleform.Rect
A rectangle to test the object against.  checkShape : boolean
Check the actor shape against the rect.  boolean  self : scaleform.Actor
The actor whose bound is set.  bounds : scaleform.Rect
The bounds - position and dimensions - set for the actor.  self : scaleform.Actor
The actor to which a scale9grid is applied.  rect : scaleform.Rect
A rectangle to which the Scale9grid is applied.  self : scaleform.CameraComponent
The camera component currently in use.  rect : scaleform.Rect
The desired view rectangle.  self : scaleform.ContainerComponent
The container that contains the objects to test are in a a rect.  rect : scaleform.Rect
The rect to test.  testShape : boolean?
The control whether to test the object's shape against the rect.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Actor[]
Returns a list of objects in the rect.
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.
  init : scaleform.Rect?
A partial table of values used to initialize the Rect.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.Rect
Returns a fully constructed Rect table.  self : scaleform.ShapeComponent
The shape component to draw the rect in.  rect : scaleform.Rect
The rect relative to the registration point of the parent actor.  boolean  self : scaleform.ShapeComponent
The shape component to draw the rounded rect in.  rect : scaleform.Rect
The rect relative to the registration point of the parent actor.  radii : scaleform.Size
The radii the ellipse used to draw the rounded corners.  boolean  self : scaleform.ShapeComponent
The shape component to draw the rounded rect in.  rect : scaleform.Rect
The rect relative to the registration point of the parent actor.  top_left_rad : number
The radius of the circle draw the top left corner.  top_right_rad : number
The radius of the circle draw the top right corner.  bot_left_rad : number
The radius of the circle draw the bottom left corner.  bot_right_rad : number
The radius of the circle draw the bottom right corner.  boolean  screen : scaleform.Rect
A rectangle in screen pixels.  box : scaleform.Rect
The area that should become visible, in stage pixel coordinates.  flags : integer?
Bit flags.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  rect : scaleform.Rect
Rectangle for changing the position and orientation of the stage.  rect : scaleform.Rect
The desired safe rectangle, in pixels.  self : scaleform.TextComponent
The text component whose dimensions is set.  rect : scaleform.Rect
The rectangle to use.  scaleform.Actor
Generic objects located in a scene.  Matrix2F
A two-dimensional matrix in row-major order.  scaleform.Rect
A rectangle based upon two points.
{ x1 : number, x2 : number, y1 : number, y2 : number, }  scaleform.physics.Fixture
An interface to attach shapes to the fixtures.  scaleform.physics.Shape
Represents shape used in fixtures.  scaleform.Point
Point should be in the form of a table {x=a, y=b}
{ PropertyType : string, x : number, y : number, }A strictly integral numeric value, with no decimal component.  scaleform.TextComponent
Represent the text field.  scaleform.VisualComponent
An interface to the visual component. true or false.  scaleform.CameraComponent
An interface to camera component.  scaleform.ContainerComponent
An interface to container component.  scaleform.ShapeComponent
An interface to shape component.  scaleform.Size
Width should be in the form of a table {width=a, height=b}
{ height : number, width : number, }A string of characters.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