Libraries.Interface.Controls.Button

This action returns a default behavior for this paricular control. Some controls do nothing by default, like a TextBox that responds to different kinds of input. Others, however, have default behaviors, like a Button or a MenuItem. If there is no default behavior, this action returns undefined.

This action adds a different Item2D into this one, storing the added Item2D at a specific index in the internal array.

Example Code

use Libraries.Interface.Item2D

        Item2D parentItem
        Item2D child
        parentItem:Add(0, child)

This action adds a different Item2D into this one. This makes a few things happen. 1. The added item will get this item as its parent. 2. The added item's x and y coordinates will become relative to this Item. 3. Most actions on this Item will also affect the added Item.

Example Code

use Libraries.Interface.Item2D

        Item2D parentItem
        Item2D child
        parentItem:Add(child)

This action adds a new Behavior to this Item.

The FIT_FONT layout style is used to ensure a Control's height can fit the Font used in this LayoutProperties, plus padding from the children elements. FIT_FONT is only effective for the vertical layout style, and requires that a Font is present in this LayoutProperties.

This action adds a FocusListener to the Item. When the Item receives a FocusEvent due to either gaining or losing the focus, the listener will be notified.

Example Code

use Libraries.Interface.Item
        use Libraries.Interface.Events.FocusListener
        Item myItem
        FocusListener listener
        myItem:AddFocusListener(listener)

This action adds a MouseListener to the Item. If the Item ever receives a MouseEvent due to a mouse click, the mouse listener will be notified.

Example Code

use Libraries.Interface.Item
        use Libraries.Interface.Events.MouseListener
        Item myItem
        MouseListener listener
        myItem:AddMouseListener(listener)

This action adds a MouseMovementListener to the Item. If the Item ever receives a MouseEvent due to mouse movement, the listener will be notified.

Example Code

use Libraries.Interface.Item
        use Libraries.Interface.Events.MouseMovementListener
        Item myItem
        MouseMovementListener listener
        myItem:AddMouseMovementListener(listener)

This action adds a MouseWheelListener to the Item. If the Item ever receives a MouseEvent due to the mouse wheel being scrolled, the listener will be notified.

Example Code

use Libraries.Interface.Item
        use Libraries.Interface.Events.MouseWheelListener
        Item myItem
        MouseWheelListener listener
        myItem:AddMouseWheelListener(listener)

This action adds a TouchListener to the Item. If the Item ever receives a TouchEvent, the listener will be notified.

Example Code

use Libraries.Interface.Item
        use Libraries.Interface.Events.TouchListener
        Item myItem
        TouchListener listener
        myItem:AddTouchListener(listener)

This action is used to advance the item forward in time in physics space to synchronize it for time of impact solving. This action is used internally and users should not need to use this action. Attribute Parameter time The amount of seconds to advance the item forward in time

This action applies an angular impulse to this item. The units are in kilogram units squared per second. This modifies the angular velocity of this item. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D

    Item2D item
    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:ApplyAngularImpulse(80)

This action applies a force to this item at the passed point. The force is in kilogram units per second per second. The point is the screen coordinates where the point will be applied. If the point is not on the center of the item, then a torque will be introduced causing the item to rotate. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Compute.Vector2
    use Libraries.Interface.Item2D

    Item2D item
    Vector2 force
    Vector2 point

    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    
    force:Set(300, 350)
    point:Set(100, 100)    // apply the force to the top right corner of the item
    
    item:ApplyForce(force, point)

This action applies a force to this item at the center of the item. The force is in kilogram units per second per second. No torque is introduced to the item when using this action. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Compute.Vector2
    use Libraries.Interface.Item2D

    Item2D item
    Vector2 force

    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    
    force:Set(300, 350)
    
    item:ApplyForce(force)

This action applies a linear impulse to this item at the passed point. The impulse is in kilogram units per second. This immeadietly modifies the linear velocity of this item. The point is the screen coordinates where the impulse will be applied. If the point is not the center of the item, then the angular velocity of this item will also be modified. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D
    use Libraries.Compute.Vector2

    Item2D item
    Vector2 impulse
    Vector2 point

    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)

    impulse:Set(100)
    point:Set(100, 100)     // apply the impulse to the top right corner

    item:ApplyLinearImpulse(impulse, point)

This action applies a torque to this item. The units are kilogram units squared per second per second. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D

    Item2D item
    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:ApplyTorque(350)

This action returns whether or not this Item is allowing its children to receive mouse events if the Item is custom drawing. If the Item isn't using custom drawing, this value is irrelevant -- children objects always receive mouse events before the parent if the parent isn't performing custom drawing.

This action is used to indicate that two items have just begun colliding. When two Items collide, the BeginCollision action should be called on both of them, with the other item passed as a parameter to the action. Note that this action does nothing by default, but classes that inherit from Item may override it.

Example Code

use Libraries.Interface.Item

        Item collider1
        Item collider2
        collider1:BeginCollision(collider2)
        collider2:BeginCollision(collider1)

Whether or not this Control should automatically be laid out during the next Update loop.

This action gets the position of the center of this item in global (world) coordinates.

This action stops all behaviors this Item is following without finishing them.

This action obtains the Input Table from this control, copies it, assigns it a group name, sets the control to use the new input table, and then adds it to the global input table hash table.

Example Code

use Libraries.Game.Game
        use Libraries.Interface.Controls.TextBox
        use Libraries.Game.InputTable

        class Main is Game
            action Main
                StartGame()
            end

            action CreateGame
                TextBox box
                InputTable copy = box:CopyAndActivateInputTable("New Group")
            end

            action Update(number seconds)
            end
        end

This action sets the mass, mass moment of inertia, and how the 2D item should move (via linear velocity) to be at the desired location.

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Example Code

Object o
        Object t
        integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

This action computes the distance of the passed point from the collision shape attached to this item. This action is used internally and users should not need to use this action.

This action tests if a point in global x,y coordinates is contained inside this Item2D. The global coordinates are considered to be the x and y coordinates of this Item plus its offsetX and offsetY values.

Example Code

use Libraries.Interface.Item2D

        Item2D item
        item:SetPosition(50, 50)
        item:SetWidth(100)
        item:SetHeight(50)
        boolean value = item:Contains(125, 70)

This action obtains the Input Table from this control, copies it, assigns it a group name, sets the control to use the new input table, and then adds it to the global input table hash table.

Example Code

use Libraries.Game.Game
        use Libraries.Interface.Controls.TextBox
        use Libraries.Game.InputTable

        class Main is Game
            action Main
                StartGame()
            end

            action CreateGame
                TextBox box
                InputTable copy = box:CopyAndActivateInputTable("New Group")
            end

            action Update(number seconds)
            end
        end

This action creates the nodes for this item for the broadphase collision. This action is needed in order to add the item to the collision detection system. This action is used internally and users should not need to use this action.

This action destroys the nodes for this item for the broadphase collision, essentially removing it from the collision detection system. This action is used internally and users should not need to use this action.

This action is used to free up any additional memory that is being used by this Item for purposes such as graphics. Note that the Item class doesn't have any extra memory that needs to be released with this action, but some classes which inherit from Item, such as Libraries.Game.Graphics.Drawable, do.

This action is used to call Dispose on this Item and on the entire children hierarchy of this Item.

This action is used to call Dispose on the entire children hierarchy of this Item. This will not call Dispose on this Item.

The Draw action is used to perform custom drawing on this Item and its children. This is only called during the Game engine's draw phase if this Item has enabled custom drawing via the SetCustomDrawing action. This is an advanced feature, and shouldn't be used by most users. If custom drawing is enabled, this action should be overriden -- if it isn't, the Item will attempt to provide default rendering for itself, its view, and its children, without regard to depth buffering. This action is responsible for instructing the provided Painter on how to draw this item, the view, and its children, and in what order to do so.

This action will remove all items from this item's children hierarchy. Note that this will not empty the hierarchies of the contained Items.

Example Code

use Libraries.Interface.Item2D

        Item2D parentItem
        Item2D child1
        Item2D child2
        Item2D grandchild
        parentItem:Add(child1)
        parentItem:Add(child2)
        child1:Add(grandChild)
        parentItem:Empty()

This action will call Empty on the entire children hierarchy of this item, and then empty this item as well.

This action is used to call Empty on all children contained in this item's children hierarchy. This will not empty the children of this item.

This action enables physics for this item. Passing true turns on physics for this item while passing false turns off physics for this item.

Example Code

use Libraries.Game.Graphics.Drawable

    Drawable circle
    circle:LoadFilledCircle(30)
    circle:EnablePhysics(true)

A layout which is used to arrange the children of this object.

This action determines if two objects are equal based on their hash code values.

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(t)

This action gets the linear velocity of this item in units per second. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D
    use Libraries.Compute.Vector2

    Item2D item
    Vector2 velocity

    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    velocity:Set(100, 0)
    item:SetLinearVelocity(velocity)

    Vector2 currentVelocity = item:GetLinearVelocity()

This action is used to indicate that two items that were previously colliding no longer are. The FinishCollision action should be called on both Items involved, with the other item passed as a parameter to the action. Note that this action does nothing by default, but classes that inherit from Item may override it.

Example Code

use Libraries.Interface.Item

        Item collider1
        Item collider2
        collider1:FinishCollision(collider2)
        collider2:FinishCollision(collider1)

This action will flip the Item2D across the X-axis. This flip is represented by the internal vertices of the Item2D. For classes that inherit from Item and can draw on the screen, this will flip the drawn image on the screen.

Example Code

use Libraries.Interface.Item2D
        
        Item2D myItem
        myItem:FlipX()

This action will flip the Item2D across the Y-axis. This flip is represented by the internal vertices of the Item2D. For classes that inherit from Item and can draw on the screen, this will flip the drawn image on the screen.

Example Code

use Libraries.Interface.Item2D
        
        Item2D myItem
        myItem:FlipY()

This action sets focus on this Item. If the Item is not focusable, it will instead look through the parent hierarchy and set focus on the first focusable ancestor. If no focusable Item can be found, this action will have no effect.

This action is fired if the item received the focus.

The LayoutProperties that were last used to define the properties of this Control. Used to indicate when graphics should be reloaded due to Layout changes.

This action returns the current accessiblity code for this Item

This action returns the name of the accessiblity code for this Item as Text

This action returns the parent of this Item2D. An Item2D gets a parent when it is added to another Item using the Add action.

Example Code

use Libraries.Interface.Item2D

        Item2D parentItem
        Item2D child
        parentItem:Add(child)
        Item2D item = child:GetParent()

This action gets the inverse inertia of this item (i.e., one divided by the inertia of this item). Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D

    Item2D item
    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:SetMass(20)
    number inverseInertia = item:GetInverseInertia()

This action gets this item's angular velocity in radians per second. Physics must be enabled in this item before using this action.

Example Code

use Libraries.Interface.Item2D

    Item2D item
    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:SetAngularVelocity(0.1)
    number angularVelocity = item:GetAngularVelocity()

This action is used to get the bounding box of the item. A bounding box is an axis-alligned rectangle containing the shape used for broadphase collision. This action is used internally and users should not need to use this action.

This action returns a rectangle that fully encloses the four corners of the Item as it is represented by its internal vertices array. Note that the rectangle produced by this action will be larger than the actual box formed by this Item's vertices if the Item is rotated.

Example Code

use Libraries.Interface.Item2D
        use Libraries.Game.Shapes.Rectangle

        Item2D myItem
        myItem:SetBoundingBox(20, 80, 100, 100)
        Rectangle box = myItem:GetBoundingRectangle()

This action returns the x coordinate of the center of this Item2D.

Example Code

use Libraries.Interface.Item2D
        Item2D myItem
        myItem:SetWidth(20)
        myItem:SetX(100)
        number x = myItem:GetCenterX()

This action returns the y coordinate of the center of this Item2D.

Example Code

use Libraries.Interface.Item2D
        Item2D myItem
        myItem:SetHeight(20)
        myItem:SetY(100)
        number y = myItem:GetCenterY()

This action gets the children of this item in an array.

Example Code

use Libraries.Interface.Item2D

    Item2D parent
    Item2D child1
    Item2D child2

    parent:Add(child1)
    parent:Add(child2)

    Array<Item2D> children = parent:GetChildren()

This action gets the clipping coordinates of this Item2D. The coordinates are returned via the two provided Vector2 parameters, the first vector storing the x values of the left and right sides of the clipping coordinates and the second vector storing the y values of the bottom and top sides. The returned boolean value indicates if this Item uses these clipping coordinates (i.e. if this Item or one of its parent Items has clipping enabled). If the clipping is valid, the action returns true. Otherwise, it returns false.

This action gets the total force on this item. The units are kilogram units per second per second. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D
    use Libraries.Compute.Vector2

    Item2D item
    Vector2 force

    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    force:Set(300, 350)
    item:SetForce(force)
    Vector2 totalForce = item:GetForce()

This action gets this item's angular velocity in radians per second. Physics must be enabled in this item before using this action.

Example Code

use Libraries.Interface.Item2D

    Item2D item
    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:SetAngularVelocity(0.1)
    number angularVelocity = item:GetAngularVelocity()

This is an action used internally to retrieve the head of the linked list of collisions with this item. This action is used internally and users should not need to use this action.

This action returns the LayoutProperties that were last used to define the Control, and thus describe its current state. Note that if the Control hasn't been laid out yet, this will return undefined.

This action obtains the default font for this control. This allows individual controls to customize their default font properties on a per control basis. By default, the system asks for the default system font name on a per control basis, then loads that font and returns it. Font loading is shared, so loading many fonts of the same type and size is not particularly expensive and can be done without much concern for memory requirements.

Example Code

use Libraries.Interface.Controls.TextBox
        use Libraries.Game.Graphics.Font

        TextBox box
        text name = box:GetDefaultFont()
        output name

This action returns the default LayoutProperties used for this Control.

This action applies a linear impulse to this item at the passed point. The impulse is in kilogram units per second. This immeadietly modifies the linear velocity of this item. The point is the screen coordinates where the impulse will be applied. If the point is not the center of the item, then the angular velocity of this item will also be modified. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D
    use Libraries.Compute.Vector2

    Item2D item
    Vector2 impulse
    Vector2 point

    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)

    impulse:Set(100)
    point:Set(100, 100)     // apply the impulse to the top right corner

    item:ApplyLinearImpulse(impulse, point)

This action returns the current internal description of the Item.

Example Code

use Libraries.Interface.Item

        Item item
        item:SetDescription("Used for demo purposes.")
        output "My item's description is : " + item:GetDescription()

This action returns an Iterator containing all of the FocusListeners that have been added to this Item using the AddFocusListener action.

This action returns the Font being used by this Control. How this Font is used varies between Controls, and in some cases the Control will ignore it entirely (for example, ScrollPanes), but typically this sets the font that's used for the default label on many Controls, such as Buttons. If the Font is undefined, many Controls will omit their default label.

This action returns the base Font size to be used by this Control, if the Control uses a Font.

This action gets the total force on this item. The units are kilogram units per second per second. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D
    use Libraries.Compute.Vector2

    Item2D item
    Vector2 force

    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    force:Set(300, 350)
    item:SetForce(force)
    Vector2 totalForce = item:GetForce()

This action applies a force to this item at the center of the item. The force is in kilogram units per second per second. No torque is introduced to the item when using this action. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Compute.Vector2
    use Libraries.Interface.Item2D

    Item2D item
    Vector2 force

    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    
    force:Set(300, 350)
    
    item:ApplyForce(force)

This action returns the Item's global x coordinate. This is the actual world coordinate that the item exists at after it has been offset by its parent's position. If this Item doesn't have a parent, and the offset hasn't been set manually, this is the same as GetX().

Example Code

use Libraries.Interface.Item2D
        Item2D myItem
        myItem:SetOffsetX(100)
        myItem:SetX(30)
        number globalX = myItem:GetGlobalX()

This action returns the Item's global y coordinate. This is the actual world coordinate that the item exists at after it has been offset by its parent's position. If this Item doesn't have a parent, and the offset hasn't been set manually, this is the same as GetY().

Example Code

use Libraries.Interface.Item2D
        Item2D myItem
        myItem:SetOffsetY(60)
        myItem:SetX(90)
        number globalY = myItem:GetGlobalY()

This action returns the Item's global z value. For an Item2D, this simply returns the Item2D's current z value.

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

This action will return the currently set height of the Item2D.

Example Code

use Libraries.Interface.Item2D
        Item2D myItem
        number height = myItem:GetHeight()

The SetHorizontalLayoutMode is used to determine how the width of a Control is calculated. It should be one of the following constants: STANDARD, which will calculate the width as a set number of pixels plus a percentage of the container's width. FILL, which will make the width fill the remaining width of the container. FIT_CONTENTS, which will calculate the width to fit the children contents.

This action gets the rotational inertia of this item. The inertia is in kilogram units squared.

Example Code

use Libraries.Interface.Item2D

    Item2D item
    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:SetMass(20)
    number inertia = item:GetInertia()

This action returns the input group for this Item. When used with the Game libraries, this tag describes what InputTable (if any) can interact with this Item due to input.

Example Code

use Libraries.Interface.Item

        Item item
        item:SetInputGroup("arrowKeys")
        output "My item's input group is : " + item:GetInputGroup()

This action gets the inverse inertia of this item (i.e., one divided by the inertia of this item). Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D

    Item2D item
    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:SetMass(20)
    number inverseInertia = item:GetInverseInertia()

This action gets the inverse mass of the item (i.e., one divided by the mass of this item). Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D

    Item2D item
    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:SetMass(20)
    number inverseMass = item:GetInverseMass()

This action returns an Item2D that was previously added to this Item2D by finding it at the given index in the internal array of children Items.

Example Code

use Libraries.Interface.Item2D

        Item2D parentItem
        Item2D child1
        Item2D child2
        parentItem:Add(child1)
        parentItem:Add(child2)
        Item temp = parentItem:GetItem(0)

This action searches through all Items stored in this Item2D and finds the deepest Item which contains the given point in global coordinates.

Example Code

use Libraries.Interface.Item2D

        Item2D parentItem
        Item2D child
        Item2D grandchild
        parentItem:Add(child)
        child:Add(grandchild)
        grandchild:SetHeight(100)
        grandchild:SetWidth(100)
        Item2D temp = parentItem:GetItemAt(75, 75)

This action returns the number of items contained in this Item2D.

Example Code

use Libraries.Interface.Item2D

        Item2D parentItem
        Item2D child1
        Item2D child2
        parentItem:Add(child1)
        parentItem:Add(child2)
        integer size = parentItem:GetItemCount()

This action returns an iterator containing all the items contained in this Item2D.

Example Code

use Libraries.Interface.Item2D
        use Libraries.Containers.Iterator

        Item2D parentItem
        Item2D child1
        Item2D child2
        parentItem:Add(child1)
        parentItem:Add(child2)
        Iterator<Item2D> iterator = parentItem:GetItems()

This is an action used internally to retrieve the head of the liked list of joints connected to this item. This action is used internally and users should not need to use this action.

This action returns the text used for this Control's label, if it has one.

This action returns the current Layer2Dthat this Item2D is a part of in the Game libraries.

This action returns the best suited LayoutProperties stored by the Control for use with the given container width and height. The Control will attempt to find the most restricted LayoutProperties that is still valid, prioritizing width over height in case of equal values.

Given the local coordinates of a vector, this action computes the screen coordinates of the corresponding vector.

This action gets the linear velocity of this item in units per second. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D
    use Libraries.Compute.Vector2

    Item2D item
    Vector2 velocity

    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    velocity:Set(100, 0)
    item:SetLinearVelocity(velocity)

    Vector2 currentVelocity = item:GetLinearVelocity()

Given a global point (i.e., the screen coordinates of the point), this action computes the corresponding point relative to the center of this item.

Example Code

use Libraries.Interface.Item2D
    use Libraries.Compute.Vector2

    Item2D item
    Vector2 worldPoint

    item:SetWidth(100)
    item:SetHeight(100)
    item:SetPosition(400, 350)
    
    worldPoint:Set(400, 350)    // the lower left corner of the item

    Vector2 localPoint = item:GetLocalPoint(worldPoint)

Given the screen coordinates of a vector, this action computes the local coordinates of the vector (i.e., the coordinates of the vector relative to the center of this item)

Example Code

use Libraries.Interface.Item2D
    use Libraries.Compute.Vector2

    Item2D item
    Vector2 worldVector

    item:SetWidth(100)
    item:SetHeight(100)
    item:SetPosition(400, 350)
    
    worldVector:Set(400, 350)    // the lower left corner of the item

    Vector2 localVector = item:GetLocalVector(worldVector)

This action gets the position of the center of this item in local coordinates (i.e., with respect to itself).

Given a global point (i.e., the screen coordinates of the point), this action computes the corresponding point relative to the center of this item.

Example Code

use Libraries.Interface.Item2D
    use Libraries.Compute.Vector2

    Item2D item
    Vector2 worldPoint

    item:SetWidth(100)
    item:SetHeight(100)
    item:SetPosition(400, 350)
    
    worldPoint:Set(400, 350)    // the lower left corner of the item

    Vector2 localPoint = item:GetLocalPoint(worldPoint)

Given the screen coordinates of a vector, this action computes the local coordinates of the vector (i.e., the coordinates of the vector relative to the center of this item)

Example Code

use Libraries.Interface.Item2D
    use Libraries.Compute.Vector2

    Item2D item
    Vector2 worldVector

    item:SetWidth(100)
    item:SetHeight(100)
    item:SetPosition(400, 350)
    
    worldVector:Set(400, 350)    // the lower left corner of the item

    Vector2 localVector = item:GetLocalVector(worldVector)

This action returns the mass of the item in kilograms. Physics must be enabled on this item before using this action. If the item is non-responsive or unmovable, the mass is zero.

Example Code

use Libraries.Interface.Item2D

    Item2D item
    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:SetMass(20)
    number mass = item:GetMass()

This action is used to advance the item forward in time in physics space to synchronize it for time of impact solving. This action is used internally and users should not need to use this action. Attribute Parameter time The amount of seconds to advance the item forward in time

This action returns an Iterator containing all of the MouseListeners that have been added to this Item using the AddMouseListener action.

This action returns an Iterator containing all of the MouseMovementListeners that have been added to this Item using the AddMouseMovementListener action.

This action returns an Iterator containing all of the MouseWheelListeners that have been added to this Item using the AddMouseWheelListener action.

This action returns the current internal name of the Item.

Example Code

use Libraries.Interface.Item

        Item item
        item:SetName("My Item")
        output "My item's name is " + item:GetName()

This action returns the next focus item. When this Item has the focus and the user requests the focus to advance (e.g. by pressing the tab key), the returned value is the next item to receive that focus, if it is defined. If it isn't defined, the focus can not advance from this Item.

This action gets the number of broadphase nodes this item has. This action is used internally and users should not need to use this action.

This action returns all of the broadphase nodes attached to this item in an array. This action is used internally and users should not need to use this action.

This action returns the X offset of the Item. The offset tells the Item where to relate its X position to. In other words, the X offset is where an X coordinate of 0 is for this Item. This is automatically set when using an action to add an Item to another Item.

Example Code

use Libraries.Interface.Item2D
        Item2D myItem
        myItem:SetOffsetX(100)
        number offset = myItem:GetOffsetX()

This action returns the Y offset of the item. The offset tells the Item where to relate its Y position to. In other words, the Y offset is where a Y coordinate of 0 is for this item. This is automatically set when using an action to add an Item to another Item.

Example Code

use Libraries.Interface.Item2D
        Item2D myItem
        myItem:SetOffsetY(75)
        number offset = myItem:GetOffsetY()

This action returns the Z offset of the item. The offset tells the Item where to relate its Z position to. In other words, the Z offset is where a Z coordinate of 0 is for this item. This is automatically set when using an action to add an Item to another Item.

Example Code

use Libraries.Interface.Item2D
        Item2D myItem
        myItem:SetOffsetZ(75)
        number offset = myItem:GetOffsetZ()

This action will return the current X origin of this Item2D. By default, the origin is at the coordinates 0, 0.

Example Code

use Libraries.Interface.Item2D
        
        Item2D myItem
        myItem:SetSize(100, 200)
        myItem:SetOriginCenter()
        number xOrigin = myItem:GetOriginX()

This action will return the current Y origin of this Item2D. By default, the origin is at the coordinates 0, 0.

Example Code

use Libraries.Interface.Item2D
        
        Item2D myItem
        myItem:SetSize(100, 200)
        myItem:SetOriginCenter()
        number yOrigin = myItem:GetOriginY()

This action returns the parent of this Item2D. An Item2D gets a parent when it is added to another Item using the Add action.

Example Code

use Libraries.Interface.Item2D

        Item2D parentItem
        Item2D child
        parentItem:Add(child)
        Item2D item = child:GetParent()

This action sets the x position of the Control in pixels, if the container's Layout supports it. If the Control has also been set to use a percentage of the container's width to set the x position, then the two values will be added together.

This action sets the y position of the Control in pixels, if the container's Layout supports it. If the Control has also been set to use a percentage of the container's height to set the y position, then the two values will be added together.

This action returns the x position of the Control relative to the size of its container, if the container's Layout supports it.

This action returns the y position of the Control relative to the size of its container, if the container's Layout supports it.

This action computes the distance of the passed point from the collision shape attached to this item. This action is used internally and users should not need to use this action.

This action sets the x position of the Control relative to the size of its container, if the container's Layout supports it.

This action sets the y position of the Control relative to the size of its container, if the container's Layout supports it.

This action returns the target x position of the Control in pixels. Note that this may not be used by some layouts (such as FlowLayout).

This action returns the target y position of the Control in pixels. Note that this may not be used by some layouts (such as FlowLayout).

The GetContextMenu action returns this Control's context menu, if it has one. A context menu is a PopupMenu which appears when a user wants additonal context about this Control (most commonly by right-clicking on the Control).

This action returns the previous focus item. When this Item has the focus and the user requests the focus to move backwards (e.g. by pressing shift & tab), the returned value is the previous item to receive that focus, if it is defined. If it isn't defined, the focus can not move backwards from this Item.

This action is used to update this items position in physics space after physics solving is finished for this item. This action is used internally and users should not need to use this action.

This action gets the inverse mass of the item (i.e., one divided by the mass of this item). Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D

    Item2D item
    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:SetMass(20)
    number inverseMass = item:GetInverseMass()

This action gets the total torque on this item. The units are kilogram units squared per second per second. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D

    Item2D item

    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:SetTorque(200)
    number totalTorque = item:GetTorque()

Gets the current degree of rotation of this Item.

Example Code

use Libraries.Interface.Item2D

        Item2D myItem
        myItem:SetRotation(90)
        number rotation = myItem:GetRotation()

Gets the current rotation of this Item in radians.

Example Code

use Libraries.Interface.Item2D

        Item2D myItem
        myItem:SetRotation(90)
        number rotation = myItem:GetRotationInRadians()

This action will return the current x-scaling value of this Item2D. By default, the x-scaling value of an Item is 1.

Example Code

use Libraries.Interface.Item2D
        
        Item2D myItem
        myItem:SetSize(100, 200)
        myItem:Scale(1.25)
        number scaleX = myItem:GetScaleX()

This action will return the current y-scaling value of this Item2D. By default, the y-scaling value of an Item is 1.

Example Code

use Libraries.Interface.Item2D
        
        Item2D myItem
        myItem:SetSize(100, 200)
        myItem:Scale(1.25)
        number scaleY = myItem:GetScaleY()

This action returns the x coordinate of the Item on the screen. If the Item hasn't been attached to a Layer, this will return a "Not a Number" value instead.

This action returns the y coordinate of the Item on the screen. If the Item hasn't been attached to a Layer, this will return a "Not a Number" value instead.

This item returns the collision shape of this item. The collision shape is the shape the collision system will use to test for collisions with this item. Note that this may be different from the shape drawn on the screen.

Example Code

use Libraries.Game.Drawable
    use Libraries.Game.Collision.Shapes.Circle

    Drawable ball
    ball:Load("ball.png")
    Circle circle
    circle:SetRadius(30)
    ball:SetShape(circle)
    CollisionShape2D shape = ball:GetShape()

This action returns an integer representing the type of collision shape currently attached to this item.

This action gets the children of this item in an array.

Example Code

use Libraries.Interface.Item2D

    Item2D parent
    Item2D child1
    Item2D child2

    parent:Add(child1)
    parent:Add(child2)

    Array<Item2D> children = parent:GetChildren()

This action returns the swept movement of this item used for time of impact solving for the physics system. This action is used internally and users should not need to call this action.

This action gets the total torque on this item. The units are kilogram units squared per second per second. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D

    Item2D item

    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:SetTorque(200)
    number totalTorque = item:GetTorque()

This action returns an Iterator containing all of the TouchListeners that have been added to this Item using the AddTouchListener action.

This action returns the position of the item in physical space. This acction is used internally and should not be used by users to get the position of this item on the screen.

This action gets the position of the item in physics space from the previous frame. This action is used internally and users should not need to use this action

The GetVerticalLayoutMode is used to determine how the height of a Control is calculated. It should be one of the following constants: STANDARD, which will calculate the height as a set number of pixels plus a percentage of the container's height. FILL, which will make the height fill the remaining height of the container. FIT_CONTENTS, which will calculate the height to fit the children contents. FIT_FONT, which will fit the height of the Control to the line height of the Font set in this LayoutProperties.

The SetClipping action is used to enable or disable clipping. If it is enabled, when the Item and its children are drawn as part of the QueueForDrawing action, any pixels that would be drawn outside of the unrotated dimensions of the Item are not rendered. In other words, the Item will only draw inside the exact rectangle formed by its x, y position and its width and height.

This action searches through all Items stored in this Item2D and finds the deepest Item which contains the given point in global coordinates. This action will only return items which are visible (that is, IsShowing() returns true).

Example Code

use Libraries.Interface.Item2D

        Item2D parentItem
        Item2D child
        Item2D grandchild
        parentItem:Add(child)
        child:Add(grandchild)
        grandchild:SetHeight(100)
        grandchild:SetWidth(100)
        Item2D temp = parentItem:GetVisibleItemAt(75, 75)

This action will return the currently set width of the Item2D.

Example Code

use Libraries.Interface.Item2D
        Item2D myItem
        number width = myItem:GetWidth()

This action gets the position of the center of this item in global (world) coordinates.

Given a point relative to the center of this item, this action computes and returns that point in screen coordinates.

Example Code

use Libraries.Interface.Item2D
    use Libraries.Compute.Vector2

    Item2D item
    Vector2 localPoint

    item:SetWidth(100)
    item:SetHeight(100)
    item:SetPosition(400, 250)
    
    localPoint:Set(0, 0)    // Get the coordinates of the center of the item

    Vector2 worldPoint = item:GetWorldPoint(localPoint)

Given the local coordinates of a vector, this action computes the screen coordinates of the corresponding vector.

This action returns the currently set X coordinate of the Item.

Example Code

use Libraries.Interface.Item2D
        Item2D myItem
        number value = myItem:GetX()

This action returns the currently set Y coordinate of the Item.

Example Code

use Libraries.Interface.Item2D
        Item2D myItem
        number value = myItem:GetY()

This action returns the currently set Z value of this Item2D.

Example Code

use Libraries.Interface.Item2D
        Item2D myItem
        number value = myItem:GetZ()

This action returns an integer representing the type of collision shape currently attached to this item.

This action is used to indicate that an Item and all Items that were added to it should not be visible on the screen. Note that the Item class on its own cannot be drawn on the screen, but classes that inherit from it such as Libraries.Game.Graphics.Drawable can be. By default, Items are considered visible.

Example Code

use Libraries.Interface.Item

        Item item
        item:Hide()

This action returns whether or not this Item accepts mouse input. If the value is true, this will intercept incoming mouse events, triggering any related MouseListeners and InputSets and preventing the mouse event from propagating to other Items on the Layer. The default value is true.

This action returns the nearest parent object that is accessible. This can be anything that the programmer wants to be accessible, from user interface components in a 2D interface to 3D components relative in 3-space on screen. By default, items have no accessible parent and are self-contained, but user interface components normally override the behavior so that controls can be logically nested within each other. attribute: returns Item

The IsClipping action returns true if pixel clipping is enabled, or false if it is disabled. If it is enabled, when the Item and its children are drawn as part of the QueueForDrawing action, any pixels that would be drawn outside of the unrotated dimensions of the Item are not rendered. In other words, the Item will only draw inside the exact rectangle formed by its x, y position and its width and height.

This action determines whether this item is collidable.

Example Code

use Libraries.Game.Graphics.Drawable
    
    Drawable circle
    circle:LoadFilledCircle(30)
    circle:SetCollidable(true)
    boolean result = circle:IsCollidable

The IsCustomDrawing action returns whether or not this Item is directly managing how itself and its children are drawn. When this value is true, the Item is responsible for determining its rendering via the Draw(Painter2D) action -- if this action isn't overridden, the Item and its children won't be drawn. This is an advanced feature only necessary for complex custom components, and most users will not need to use this functionality.

Whether or not this button is currently depressed, e.g. by a mouse click or touch event.

This action returns whether or not any items are contained in this Item.

Example Code

use Libraries.Interface.Item2D

        Item2D parentItem
        Item2D child1
        parentItem:Add(child1)
        boolean wasEmpty = parentItem:IsEmpty()

This action sets this item's angular velocity in radians per second. Physics must be enabled in this item before using this action.

Example Code

use Libraries.Interface.Item2D

    Item2D item
    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:SetAngularVelocity(0.1)

This action will return if the Item2D is currently flipped across the x-axis.

Example Code

use Libraries.Interface.Item2D
        
        Item2D myItem
        myItem:FlipX()
        boolean flip = myItem:IsFlippedX()

This action will return if the Item2D is currently flipped across the y-axis.

Example Code

use Libraries.Interface.Item2D
        
        Item2D myItem
        myItem:FlipY()
        boolean flip = myItem:IsFlippedY()

This action returns whether or not the Item can currently receive focus. This property can be set with SetFocusable().

The IsFocused action determines if this Item is currently focused, returning true if it is, or false if it is not.

This action gets the number of broadphase nodes this item has. This action is used internally and users should not need to use this action.

This action returns true if the item has been added to a Layer, or false otherwise.

This action determines whether physics is currently enabled for this item.

Example Code

use Libraries.Game.Graphics.Drawable

    Drawable circle
    circle:LoadFilledCircle(30)
    circle:EnablePhysics(true)
    boolean result = circle:IsPhysicsEnabled()

This action sets this item to be collidable. Passing true turns on collision for this item while passing false turns off collision for this item.

Example Code

use Libraries.Game.Graphics.Drawable
    
    Drawable circle
    circle:LoadFilledCircle(30)
    circle:SetCollidable(true)

This action determines whether physics is currently enabled for this item.

Example Code

use Libraries.Game.Graphics.Drawable

    Drawable circle
    circle:LoadFilledCircle(30)
    circle:EnablePhysics(true)
    boolean result = circle:IsPhysicsEnabled()

This action returns whether the Item is currently set to be visible on the screen.

Example Code

use Libraries.Interface.Item

        Item item
        item:Hide()
        boolean visible = item:IsShowing()

This action gets the position of the center of this item in local coordinates (i.e., with respect to itself).

This action sets the x-component of this item's linear velocity in units per second. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D

    Item2D item

    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:SetLinearVelocityX(100)

This action creates the nodes for this item for the broadphase collision. This action is needed in order to add the item to the collision detection system. This action is used internally and users should not need to use this action.

This action is used to load the graphical components of the Control. This is handled automatically by the Game engine as needed, and most users shouldn't need to use this action directly.

This action will load the Button as a single image, using the image file at the given path. The path is relative to the project's directory.

Example Code

use Libraries.Game.Game
    use Libraries.Interface.Layouts.ManualLayout
    use Libraries.Interface.Controls.Button
    
    class Main is Game
        action Main
            StartGame()
        end
    
        action CreateGame
            ManualLayout layout
            SetLayout(layout)
    
            Button button
            button:LoadImage("Resources/MyImage.png")
            button:SetPixelWidth(100)
            button:SetPixelHeight(100)
            button:SetPixelX(100)
            button:SetPixelY(100)
            Add(button)
        end
    end

This action will load the Button as a single image, using the provided Drawable as an icon.

Example Code

use Libraries.Game.Game
    use Libraries.Interface.Layouts.ManualLayout
    use Libraries.Interface.Controls.Button
    use Libraries.Game.Graphics.Drawable  

    class Main is Game
        action Main
            StartGame()
        end
    
        action CreateGame
            ManualLayout layout
            SetLayout(layout)
    
            Drawable drawable
            drawable:Load("Resources/MyImage.png")

            Button button
            button:LoadImage(drawable)
            button:SetPixelWidth(100)
            button:SetPixelHeight(100)
            button:SetPixelX(100)
            button:SetPixelY(100)
            Add(button)
        end
    end

This action will load the Button as a single image, using the given image file.

Example Code

use Libraries.Game.Game
    use Libraries.Interface.Layouts.ManualLayout
    use Libraries.Interface.Controls.Button
    use Libraries.System.File    

    class Main is Game
        action Main
            StartGame()
        end
    
        action CreateGame
            ManualLayout layout
            SetLayout(layout)
    
            File file
            file:SetPath("Resources/MyImage.png")

            Button button
            button:LoadImage(file)
            button:SetPixelWidth(100)
            button:SetPixelHeight(100)
            button:SetPixelX(100)
            button:SetPixelY(100)
            Add(button)
        end
    end

This action is fired if the item lost the focus.

The default LayoutProperties, used by many controls to set their base visual information and provide default values.

This action will increase the x and y coordinates of this Item by the values stored in the provided Vector2.

Example Code

use Libraries.Interface.Item2D
        use Libraries.Compute.Vector2

        Item2D myItem
        myItem:SetX(50)
        myItem:SetY(80)
        Vector2 vector
        vector:Set(25, -20)
        myItem:Move(vector)

This action will increase the x and y coordinates of this Item by the given amounts.

Example Code

use Libraries.Interface.Item2D

        Item2D myItem
        myItem:SetX(50)
        myItem:SetY(80)
        myItem:Move(25, -20)

This action will increase the x-coordinate of this Item by the given amount.

Example Code

use Libraries.Interface.Item2D

        Item2D myItem
        myItem:SetX(50)
        myItem:MoveX(25)

This action will increase the y-coordinate of this Item by the given amount.

Example Code

use Libraries.Interface.Item2D

        Item2D myItem
        myItem:SetY(50)
        myItem:MoveY(25)

This action will increase the z-coordinate of this Item by the given amount.

Example Code

use [email protected]

        Item2D myItem
        myItem:SetZ(5)
        myItem:MoveZ(2)

This action returns whether or not the Control is in need of laying out by its container (or the parent Layer2D, if no container Control exists).

The FILL layout style will attempt to fill the remaining width or height of the container with this Control. Note that this is only effective if the container's dimensions are already known independently of this element's size -- for example, a FILL layout can't be effectively used if the container's layout style is FIT_CONTENTS.

This action will notify all SelectionListeners which have been added to the Control of the given SelectionEvent.

Checks to see if the Item2D's internal vertices are up to date, and updates them if they are not. This is used primarily internally to ensure that the item's vertices are properly aligned before use, e.g. to project an image on the screen at the coordinates of the vertices. Most users will never need to use this action directly.

This action takes a mouse event and handles it. It will first test to see if the mouse event took place within the bounds of this Item. If so, it will notify any MouseListeners of the event. If the event was not contained within this Item, or if there are no MouseListeners on this Item, the Item will ask its parent Item to process the mouse event, if there is a parent.

Example Code

use Libraries.Interface.Item2D
        use Libraries.Interface.Events.MouseEvent
        use Libraries.Interface.Events.MouseListener
        Item2D myItem
        MouseListener listener
        myItem:AddMouseListener(listener)
        MouseEvent event
        event:eventType = event:CLICKED_MOUSE
        myItem:ProcessMouseEvent(event)

FIX ME: Needs comments

This action is used to draw this Item on the screen, and then draw all of the Item's children hierarchy on the screen. Note that Items themselves can not be drawn, but some classes that extend the Item class, such as the Libraries.Game.Graphics.Drawable class, can be. To see how they draw, see their documentation.

This action obtains the Input Table from this control, copies it, assigns it a group name, sets the control to use the new input table, and then adds it to the global input table hash table.

Example Code

use Libraries.Game.Game
        use Libraries.Interface.Controls.TextBox
        use Libraries.Game.InputTable

        class Main is Game
            action Main
                StartGame()
            end

            action CreateGame
                TextBox box
                InputTable copy = box:CopyAndActivateInputTable("New Group")
            end

            action Update(number seconds)
            end
        end

This action adds a different Item2D into this one. This makes a few things happen. 1. The added item will get this item as its parent. 2. The added item's x and y coordinates will become relative to this Item. 3. Most actions on this Item will also affect the added Item.

Example Code

use Libraries.Interface.Item2D

        Item2D parentItem
        Item2D child
        parentItem:Add(child)

This action adds a different Item2D into this one, storing the added Item2D at a specific index in the internal array.

Example Code

use Libraries.Interface.Item2D

        Item2D parentItem
        Item2D child
        parentItem:Add(0, child)

The FIT_CONTENTS layout style will calculate this Control's dimensions as the combined total dimensions of its children elements. Because children elements often need to have some concrete information about the parent's dimensions, it's recommended to only use this in one of the two directions (horizontally or vertically) for the Control. For example, FlowLayouts work well with elements with a predetermined STANDARD horizontal layout style and using FIT_CONTENTS for the vertical layout style.

This action removes a FocusListener from the Item. The listener will no longer receive notification if the Item gets a FocusEvent.

Example Code

use Libraries.Interface.Item
        use Libraries.Interface.Events.FocusListener
        Item myItem
        FocusListener listener
        myItem:AddFocusListener(listener)
        myItem:RemoveFocusListener(listener)

This action removes a MouseListener from the Item. The listener will no longer receive notification if the Item gets a mouse click event.

Example Code

use Libraries.Interface.Item
        use Libraries.Interface.Events.MouseListener
        Item myItem
        MouseListener listener
        myItem:AddMouseListener(listener)
        myItem:RemoveMouseListener(listener)

This action removes a MouseMovementListener from the Item. The listener will no longer receive notification if the Item gets a mouse movement event.

Example Code

use Libraries.Interface.Item
        use Libraries.Interface.Events.MouseMovementListener
        Item myItem
        MouseMovementListener listener
        myItem:AddMouseMovementListener(listener)
        myItem:RemoveMouseMovementListener(listener)

This action removes a MouseWheelListener from the Item. The listener will no longer receive notification if the Item gets a mouse wheel event.

Example Code

use Libraries.Interface.Item
        use Libraries.Interface.Events.MouseWheelListener
        Item myItem
        MouseWheelListener listener
        myItem:AddMouseWheelListener(listener)
        myItem:RemoveMouseWheelListener(listener)

This action removes a TouchListener from the Item. The listener will no longer receive notification if the Item gets a TouchEvent.

Example Code

use Libraries.Interface.Item
        use Libraries.Interface.Events.TouchListener
        Item myItem
        TouchListener listener
        myItem:AddTouchListener(listener)
        myItem:RemoveTouchListener(listener)

This action requests that this Control should be laid out by its container (or the Layer2D if there is no containing Control) during the next Update.

This action sets the y-component of this item's linear velocity in units per second. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D

    Item2D item

    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:SetLinearVelocityY(100)

This action is used to indicate that the Control no longer needs to be laid out. This is called internally by the system as needed, and shouldn't be necessary for most users.

This action sets the mass, mass moment of inertia, and how the 2D item should move (via linear velocity) to be at the desired location.

The Resize action is used to recalculate the size and position of Controls that are being controlled by a Layout. Calling Resize on an Item2D won't have a direct effect on it, but if the Item's children hierarchy contains any Controls, those Controls will be resized.

Rotates this Item2D by the given number of degrees. This will also rotate all Items in the children hierarchy of this Item.

Example Code

use Libraries.Interface.Item

        Item myItem
        myItem:Rotate(65)

This action will multiply the current scaling value by the given number. A parameter of 0 or less will be ignored.

Example Code

use Libraries.Interface.Item2D
        
        Item2D myItem
        myItem:SetSize(100, 200)
        myItem:SetScale(1.5)
        myItem:Scale(1.1)

This action will multiply the x scaling and y scaling values, respectively, by the given numbers. A parameter of 0 or less will be ignored.

Example Code

use Libraries.Interface.Item2D
        
        Item2D myItem
        myItem:SetSize(100, 200)
        myItem:SetScale(1.5)
        myItem:Scale(1.1, 0.9)

This action will multiply the current scaling value by the given number. A parameter of 0 or less will be ignored. This action will increase or decrease the scale of the object from the center, and update the Item's x,y coordinates to reflect the new bottom-left corner of the Item.

Example Code

use Libraries.Interface.Item2D
        
        Item2D myItem
        myItem:SetSize(100, 200)
        myItem:SetScale(1.5)
        myItem:ScaleFromCenter(1.1)

This action will multiply the current scaling values of the x and y planes by the given number. A parameter of 0 or less will be ignored. This action will increase or decrease the scale of the object from the center, and update the Item's x,y coordinates to reflect the new bottom-left corner of the Item.

Example Code

use Libraries.Interface.Item2D
        
        Item2D myItem
        myItem:SetSize(100, 200)
        myItem:SetScale(1.5)
        myItem:ScaleFromCenter(1.1, 0.9)

This action selects an item in the Control using first letter navigation, if the Control supports it. If the Control doesn't support first letter navigation, this will do nothing.

This action sets whether or not this Item accepts mouse input. If set to true, this will intercept incoming mouse events, triggering any related MouseListeners and InputSets and preventing the mouse event from propagating to other Items on the Layer. The default value is true.

This action changes the accessibility code for this Item. This should be done with care because setting the accessiblity code to the incorrect type can cause accessibility to stop functioning or, in some cases, cause the program to crash.

This action gets the rotational inertia of this item. The inertia is in kilogram units squared.

Example Code

use Libraries.Interface.Item2D

    Item2D item
    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:SetMass(20)
    number inertia = item:GetInertia()

This action sets this item's angular velocity in radians per second. Physics must be enabled in this item before using this action.

Example Code

use Libraries.Interface.Item2D

    Item2D item
    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:SetAngularVelocity(0.1)

This action returns the default LayoutProperties used for this Control.

This action will set the x coordinate, y coordinate, width, and height of the Item2D, respectively.

Example Code

use Libraries.Interface.Item2D

        Item2D myItem
        myItem:SetBoundingBox(50, 200, 100, 75)

This action will set the X and Y coordinates of the Item so that the center of the Item is located at the given X, Y coordinates.

Example Code

use Libraries.Interface.Item
        Item myItem
        myItem:SetCenter(70, 40)

This action will set the X coordinate of the Item so that the center of the Item is aligned with the given X coordinate value.

Example Code

use Libraries.Interface.Item
        Item myItem
        myItem:SetCenterX(70)

This action will set the Y coordinate of the Item so that the center of the Item is aligned with the given Y coordinate value.

Example Code

use Libraries.Interface.Item
        Item myItem
        myItem:SetCenterY(65)

The SetChildrenProcessingMouseEvents action is used to set whether or not children items should receive mouse events if this Item is using custom drawing. This affects only custom drawing Items -- if the Item isn't drawing, children objects will always receive the mouse events first. This value is false by default. This is an advanced feature only necessary for complex custom components, and most users will not need to use this.

This action sets the clipping coordinates of the given painter to respect the coordinates of this Item (if it's clipping) as well as any clipping being performed by parent Items. This action is called automatically by the Game engine as necessary, and most users will never need to use this action directly.

The SetClipping action is used to enable or disable clipping. If it is enabled, when the Item and its children are drawn as part of the QueueForDrawing action, any pixels that would be drawn outside of the unrotated dimensions of the Item are not rendered. In other words, the Item will only draw inside the exact rectangle formed by its x, y position and its width and height.

This action sets this item to be collidable. Passing true turns on collision for this item while passing false turns off collision for this item.

Example Code

use Libraries.Game.Graphics.Drawable
    
    Drawable circle
    circle:LoadFilledCircle(30)
    circle:SetCollidable(true)

This action gets the position of the item in physics space from the previous frame. This action is used internally and users should not need to use this action

This action sets the total torque on this item. The units are kilogram units squared per second per second. This action should be used to set the total torque on this item. If we want to apply a torque to this item, we should use the ApplyTorque actions instead. Physics must be enabled on this action before using this action.

Example Code

use Libraries.Interface.Item2D

    Item2D item

    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:SetTorque(200)

This action sets the total force on this item. The units are kilogram units per second per second. This action should be used to set the total force on this item. If we want to apply a force to this item, we should use the ApplyForce actions instead. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D
    use Libraries.Compute.Vector2

    Item2D item
    Vector2 force

    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    force:Set(300, 350)
    item:SetForce(force)

This is an action used internally by the physics system to keep track of the collisions with this item in a linked list structure. This action sets the head of the linked list of collisions to the passed CollisionEdge2D object. This action is used internally and users should not need to use this action.

The SetCustomDrawing action is used to indicate that this Item wants to directly manage how itself and its children are drawn. When this is set to true, the Item must be responsible for determining this rendering via the Draw(Painter2D) action -- if this action isn't overridden, the Item and its children won't be drawn. This is an advanced feature only necessary for complex custom components, and most users will not need to use this functionality.

This action applies an angular impulse to this item. The units are in kilogram units squared per second. This modifies the angular velocity of this item. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D

    Item2D item
    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:ApplyAngularImpulse(80)

Sets whether or not this button is depressed. This is purely an internal state and doesn't affect the button's appearance. This function won't need to be called directly by most users.

This action sets the internal description of the Item.

Example Code

use Libraries.Interface.Item

        Item item
        item:SetDescription("Used for demo purposes.")

This action will set the Item2D to be flipped across the X-axis according to the boolean. If the boolean value is false, the Item2D will be set to its unflipped state. If it is true, the Item will be set to its flipped state.

Example Code

use Libraries.Interface.Item2D
        
        Item2D myItem
        myItem:SetFlipX(true)

This action will set the Item2D to be flipped across the Y-axis according to the boolean. If the boolean value is false, the Item2D will be set to its unflipped state. If it is true, the Item will be set to its flipped state.

Example Code

use Libraries.Interface.Item2D
        
        Item2D myItem
        myItem:SetFlipY(true)

The SetFocusable action sets whether or not this Item should be focusable. If the Item is currently focused and made unfocusable, then it will lose focus, and there will be no focused element.

This action sets the Font to be used by this Control. How this Font is used varies between Controls, and in some cases the Control will ignore it entirely (for example, ScrollPanes), but typically this sets the font that's used for the default label on many Controls, such as Buttons. If the Font is undefined, many Controls will omit their default label.

This action sets the base Font size to be used by this Control, if the Control uses a Font.

This action sets the total force on this item. The units are kilogram units per second per second. This action should be used to set the total force on this item. If we want to apply a force to this item, we should use the ApplyForce actions instead. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D
    use Libraries.Compute.Vector2

    Item2D item
    Vector2 force

    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    force:Set(300, 350)
    item:SetForce(force)

This action applies a torque to this item. The units are kilogram units squared per second per second. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D

    Item2D item
    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:ApplyTorque(350)

This action returns the swept movement of this item used for time of impact solving for the physics system. This action is used internally and users should not need to call this action.

This action will set the height of the Item2D.

Example Code

use Libraries.Interface.Item2D
        Item2D myItem
        myItem:SetHeight(70)

The SetHorizontalLayoutMode is used to determine how the width of a Control is calculated. It should be one of the following constants: STANDARD, which will calculate the width as a set number of pixels plus a percentage of the container's width. FILL, which will make the width fill the remaining width of the container. FIT_CONTENTS, which will calculate the width to fit the children contents.

This action sets the Icon used by this Control. Different Controls use this Icon differently, depending on their purpose.

This action sets the input group for this Item. When used with the Game libraries, this tag describes what InputTable (if any) can interact with this Item due to input.

Example Code

use Libraries.Interface.Item

        Item item
        item:SetInputGroup("arrowKeys")
        output "My item's input group is : " + item:GetInputGroup()

This action sets a value inside the internal item array of this Item2D.

Example Code

use Libraries.Interface.Item2D

        Item2D parentItem
        Item2D child1
        Item2D child2
        parentItem:Add(child1)
        parentItem:SetItem(0, child2)

This is an action used internally by the physics system to keep track of the joints connected to this item in a linked list structure. This action sets the head of the linked list of collisions to the passed CollisionEdge2D object. This action is used internally and users should not need to use this action.

This action sets the text in this Control's label, if it has one.

This action is used by the Game libraries to create a reference to the layer that this Item2D exists on. It is automatically called as needed by the Layer2Dclass. Most users will never need to use this action directly.

This action is used to load the graphical components of the Control. This is handled automatically by the Game engine as needed, and most users shouldn't need to use this action directly.

Given a point relative to the center of this item, this action computes and returns that point in screen coordinates.

Example Code

use Libraries.Interface.Item2D
    use Libraries.Compute.Vector2

    Item2D item
    Vector2 localPoint

    item:SetWidth(100)
    item:SetHeight(100)
    item:SetPosition(400, 250)
    
    localPoint:Set(0, 0)    // Get the coordinates of the center of the item

    Vector2 worldPoint = item:GetWorldPoint(localPoint)

This action sets the linear velocity of this item in units per second. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D
    use Libraries.Compute.Vector2

    Item2D item
    Vector2 velocity

    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    velocity:Set(100, 0)
    item:SetLinearVelocity(velocity)

This action sets the x-component of this item's linear velocity in units per second. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D

    Item2D item

    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:SetLinearVelocityX(100)

This action sets the y-component of this item's linear velocity in units per second. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D

    Item2D item

    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:SetLinearVelocityY(100)

This action is used to syncronize the item's position in physics space with its position in the tree used for broadphase collision. This action is used internally and users should not need to use this action.

This action sets the position of the item in physics space from the previous frame. This action is used internally and users should not need to use this action.

This action sets the next focus item. When this Item has the focus and the user requests the focus to advance (e.g. by pressing the tab key), the focus will move to the next focus item, if it is defined.

This action returns all of the broadphase nodes attached to this item in an array. This action is used internally and users should not need to use this action.

This action will set both the X and Y offsets of the item, respectively.

Example Code

use Libraries.Interface.Item2D
        Item2D myItem
        myItem:SetOffset(100, 75)

This action will set X, Y, and Z offsets of the item, respectively.

Example Code

use Libraries.Interface.Item2D
        Item2D myItem
        myItem:SetOffset(100, 75, 2)

This action sets the X offset of the Item. The offset tells the Item where to relate its X position to. In other words, the X offset is where an X coordinate of 0 is for this Item. This is automatically set when using an action to add an Item to another Item.

Example Code

use Libraries.Interface.Item2D
        Item2D myItem
        myItem:SetOffsetX(100)

This action sets the Y offset of the item. The offset tells the Item where to relate its Y position to. In other words, the Y offset is where a Y coordinate of 0 is for this item. This is automatically set when using an action to add an Item to another Item.

Example Code

use Libraries.Interface.Item2D
        Item2D myItem
        myItem:SetOffsetY(75)

This action sets the Z offset of the item. The offset tells the Item where to relate its Z position to. In other words, the Z offset is where a Z coordinate of 0 is for this item. This is automatically set when using an action to add an Item to another Item.

Example Code

use Libraries.Interface.Item2D
        Item2D myItem
        myItem:SetOffsetZ(75)

This action will set the origin of the Item to be at the given location in the Item. This is used when projecting the Item's vertices onto the screen, i.e. when determining where to draw a picture on the screen.

Example Code

use Libraries.Interface.Item2D

        Item2D myItem
        myItem:SetOrigin(20, 20)

This action will set the origin of the Item to be at the current center of the Item's width and height bounds.

Example Code

use Libraries.Interface.Item2D

        Item2D myItem
        myItem:SetSize(50, 80)
        myItem:SetOriginCenter()

This action sets a reference to the parent item. It is called automatically when an Item2D is added as a child to another Item2D. Most users will not need to use this action directly.

This action returns the target x position of the Control in pixels. Note that this may not be used by some layouts (such as FlowLayout).

This action returns the target y position of the Control in pixels. Note that this may not be used by some layouts (such as FlowLayout).

This action sets the x position of the Control relative to the size of its container, if the container's Layout supports it.

This action sets the y position of the Control relative to the size of its container, if the container's Layout supports it.

This action is used to get the bounding box of the item. A bounding box is an axis-alligned rectangle containing the shape used for broadphase collision. This action is used internally and users should not need to use this action.

This action returns the x position of the Control relative to the size of its container, if the container's Layout supports it.

This action returns the y position of the Control relative to the size of its container, if the container's Layout supports it.

This action sets the x position of the Control in pixels, if the container's Layout supports it. If the Control has also been set to use a percentage of the container's width to set the x position, then the two values will be added together.

This action sets the y position of the Control in pixels, if the container's Layout supports it. If the Control has also been set to use a percentage of the container's height to set the y position, then the two values will be added together.

The SetPopupMenu action attaches a PopupMenu to this Control, which can be opened by interacting with it (most commonly by right-clicking on the Control).

This action will set both the X coordinate and the Y coordinate of the Item, in that order.

Example Code

use Libraries.Interface.Item
        Item myItem
        myItem:SetPosition(30, 70)

This action will set both the X and Y coordinates of this Item2D, and will additionally set the Z value of this Item2D.

Example Code

use Libraries.Interface.Item2D
        Item2D myItem
        myItem:SetPosition(30, 70, 3)

This action sets the previous focus item. When this Item has the focus and the user requests the focus to move backwards (e.g. by pressing shift & tab), the focus will move to the previous focus item, if it is defined.

This action determines whether this item is collidable.

Example Code

use Libraries.Game.Graphics.Drawable
    
    Drawable circle
    circle:LoadFilledCircle(30)
    circle:SetCollidable(true)
    boolean result = circle:IsCollidable

This action returns the mass of the item in kilograms. Physics must be enabled on this item before using this action. If the item is non-responsive or unmovable, the mass is zero.

Example Code

use Libraries.Interface.Item2D

    Item2D item
    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:SetMass(20)
    number mass = item:GetMass()

This action applies a force to this item at the passed point. The force is in kilogram units per second per second. The point is the screen coordinates where the point will be applied. If the point is not on the center of the item, then a torque will be introduced causing the item to rotate. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Compute.Vector2
    use Libraries.Interface.Item2D

    Item2D item
    Vector2 force
    Vector2 point

    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    
    force:Set(300, 350)
    point:Set(100, 100)    // apply the force to the top right corner of the item
    
    item:ApplyForce(force, point)

This action returns the LayoutProperties that were last used to define the Control, and thus describe its current state. Note that if the Control hasn't been laid out yet, this will return undefined.

Sets this Item2D to be rotated to an angle of the given number of degrees. This will also rotate all Items in the children hierarchy of this Item.

Example Code

use Libraries.Interface.Item2D

        Item2D myItem
        myItem:SetRotation(90)

This action sets separate scaling values for the x and y planes on this Item2D. This will cause the vertices of this Item to be calculated based on a scaled percentage of the width and height. The default scaling values are 1.0, or 100% of the Item's width and height.

Example Code

use Libraries.Interface.Item2D
        
        Item2D myItem
        myItem:SetSize(100, 200)
        myItem:SetScale(1.5, 0.75)

This action sets the scale of this Item2D, causing the vertices of the item to be calculated based on a scaled percentage of the width and height. The default scaling values are 1.0, or 100% of the Item's width and height.

Example Code

use Libraries.Interface.Item2D
        
        Item2D myItem
        myItem:SetSize(100, 200)
        myItem:SetScale(1.25)

This action sets the scale of this Item2D, causing the vertices of the item to be calculated based on a scaled percentage of the width and height. The default scaling values are 1.0, or 100% of the Item's width and height. This action will increase or decrease the scale of the object from the center, and update the Item's x,y coordinates to reflect the new bottom-left corner of the Item.

Example Code

use Libraries.Interface.Item2D
        
        Item2D myItem
        myItem:SetSize(100, 200)
        myItem:SetScaleFromCenter(1.25)

This action sets separate scaling values for the x and y planes on this Item2D. This will cause the vertices of this Item to be calculated based on a scaled percentage of the width and height. The default scaling values are 1.0, or 100% of the Item's width and height. This action will increase or decrease the scale of the object from the center, and update the Item's x,y coordinates to reflect the new bottom-left corner of the Item.

Example Code

use Libraries.Interface.Item2D
        
        Item2D myItem
        myItem:SetSize(100, 200)
        myItem:SetScaleFromCenter(1.5, 0.75)

This action sets the scaling value of the x plane on this Item2D. This will cause the vertices of this Item to be calculated based on a scaled percentage of the width. The default scaling values are 1.0, or 100% of the Item's width and height.

Example Code

use Libraries.Interface.Item2D
        
        Item2D myItem
        myItem:SetSize(100, 200)
        myItem:SetScaleX(1.5)

This action sets the scaling value of the y plane on this Item2D. This will cause the vertices of this Item to be calculated based on a scaled percentage of the height. The default scaling values are 1.0, or 100% of the Item's width and height.

Example Code

use Libraries.Interface.Item2D
        
        Item2D myItem
        myItem:SetSize(100, 200)
        myItem:SetScaleY(0.75)

This item returns the collision shape of this item. The collision shape is the shape the collision system will use to test for collisions with this item. Note that this may be different from the shape drawn on the screen.

Example Code

use Libraries.Game.Drawable
    use Libraries.Game.Collision.Shapes.Circle

    Drawable ball
    ball:Load("ball.png")
    Circle circle
    circle:SetRadius(30)
    ball:SetShape(circle)
    CollisionShape2D shape = ball:GetShape()

This action sets the collision shape of this item. The collision shape is the shape the collision system will use to test for collisions with this item. Note that this may be different from the shape drawn on the screen. A copy of the passed shape is used for the collison shape for this item.

Example Code

use Libraries.Game.Drawable
    use Libraries.Game.Collision.Shapes.Circle

    Drawable ball
    ball:Load("ball.png")
    Circle circle
    circle:SetRadius(30)
    ball:SetShape(circle)

This action will set the width and height of the Item2D, respectively.

Example Code

use Libraries.Interface.Item2D

        Item2D myItem
        myItem:SetSize(100, 50)

This action enables physics for this item. Passing true turns on physics for this item while passing false turns off physics for this item.

Example Code

use Libraries.Game.Graphics.Drawable

    Drawable circle
    circle:LoadFilledCircle(30)
    circle:EnablePhysics(true)

This action returns the best suited LayoutProperties stored by the Control for use with the given container width and height. The Control will attempt to find the most restricted LayoutProperties that is still valid, prioritizing width over height in case of equal values.

This action sets the total torque on this item. The units are kilogram units squared per second per second. This action should be used to set the total torque on this item. If we want to apply a torque to this item, we should use the ApplyTorque actions instead. Physics must be enabled on this action before using this action.

Example Code

use Libraries.Interface.Item2D

    Item2D item

    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    item:SetTorque(200)

This action is used internally by the physics system to set the position of this item in the physics world. This action is used internally and users users should not need to use this action.

This action sets the position of the item in physical space. This action is used internally and should not be used by users to set the position of this item on the screen.

This action sets the position of the item in physics space from the previous frame. This action is used internally and users should not need to use this action.

This action destroys the nodes for this item for the broadphase collision, essentially removing it from the collision detection system. This action is used internally and users should not need to use this action.

This item is used to test whether a passed point is on the collision shape of this item.

Example Code

use Libraries.Interface.Drawable
    use Libraries.Compute.Vector2

    Drawable circle
    circle:LoadFilledCircle(30)
    circle:SetPosition(350, 400)
    Vector2 point
    point:Set(365, 410)
    boolean result = circle:TestPoint(point)

The GetVerticalLayoutMode is used to determine how the height of a Control is calculated. It should be one of the following constants: STANDARD, which will calculate the height as a set number of pixels plus a percentage of the container's height. FILL, which will make the height fill the remaining height of the container. FIT_CONTENTS, which will calculate the height to fit the children contents. FIT_FONT, which will fit the height of the Control to the line height of the Font set in this LayoutProperties.

The IsClipping action returns true if pixel clipping is enabled, or false if it is disabled. If it is enabled, when the Item and its children are drawn as part of the QueueForDrawing action, any pixels that would be drawn outside of the unrotated dimensions of the Item are not rendered. In other words, the Item will only draw inside the exact rectangle formed by its x, y position and its width and height.

This action will set the width of the Item2D.

Example Code

use Libraries.Interface.Item2D
        Item2D myItem
        myItem:SetWidth(50)

This action sets the X coordinate of the Item.

Example Code

use Libraries.Interface.Item2D
        Item2D myItem
        myItem:SetX(35.0)

This action sets the Y coordinate of the Item.

Example Code

use Libraries.Interface.Item2D
        Item2D myItem
        myItem:SetY(210.0)

This action sets the Z value of the Item2D. For Item2D, the z value is used during layer sorting to determine ordering, where lower z values will be placed first.

Example Code

use Libraries.Interface.Item2D
        Item2D myItem
        myItem:SetZ(3)

get the old target global center of the obje

This action is used to indicate that an Item and all Items that were added to it should be visible on the screen. Note that the Item class on its own cannot be drawn on the screen, but classes that inherit from it such as Libraries.Game.Graphics.Drawable can be. By default, Items are considered visible.

Example Code

use Libraries.Interface.Item

        Item item
        item:Show()

This action sets the linear velocity of this item in units per second. Physics must be enabled on this item before using this action.

Example Code

use Libraries.Interface.Item2D
    use Libraries.Compute.Vector2

    Item2D item
    Vector2 velocity

    item:SetWidth(100)
    item:SetHeight(100)
    item:EnablePhysics(true)
    velocity:Set(100, 0)
    item:SetLinearVelocity(velocity)

This action is used to syncronize the item's position in physics space with its position in the tree used for broadphase collision. This action is used internally and users should not need to use this action.

This action is used to update this items position in physics space after physics solving is finished for this item. This action is used internally and users should not need to use this action.

This item is used to test whether a passed point is on the collision shape of this item.

Example Code

use Libraries.Interface.Drawable
    use Libraries.Compute.Vector2

    Drawable circle
    circle:LoadFilledCircle(30)
    circle:SetPosition(350, 400)
    Vector2 point
    point:Set(365, 410)
    boolean result = circle:TestPoint(point)

This action updates the item. It takes a number parameter that should indicate how many seconds have passed since the last time this action was called. This action does nothing in the Item class, but any class that inherits from Item may override it.

Example Code

use Libraries.Interface.Item
        use Libraries.System.DateTime
        
        class Main is Item

            action Main
                // We'll use a DateTime object to count seconds.
                DateTime time
                number currentTime = time:GetEpochTime()
                number newTime = 0

                repeat while GetX() < 300
                    // Check what the time is now.
                    newTime = time:GetEpochTime()

                    // Calculate how many seconds have passed, then call Update.
                    Update( (newTime - currentTime)/1000 )

                    // Store the old time.
                    currentTime = newTime
                end
            end

            // Our update action will move our Item to the right at 200 units a second.
            action Update(number secondsSinceUpdate)
                SetX(GetX() + 200 * secondsSinceUpdate)
            end
        end

This action is used internally by the physics system to set the position of this item in the physics world. This action is used internally and users users should not need to use this action.

This action sets the position of the item in physical space. This action is used internally and should not be used by users to set the position of this item on the screen.

This action returns the position of the item in physical space. This acction is used internally and should not be used by users to get the position of this item on the screen.