Libraries.Game.Graphics.Fonts.FontBoundingBox Documentation

The FontBoundingBox class is used to maintain information about the size of the bounding box for a given font file. The bounding box is the maximum width and height of a font.

Example Code

use Libraries.Game.Graphics.Fonts.all
    use Libraries.Game.Game

    class Main is Game
        action Main
            StartGame()
        end

        action CreateGame
            FontBoundingBox box
            box:SetBoundingBox(0, 0, 100, 100)
            output box:ToText()
        end
    end

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetHashCode()This action gets the hash code for an object.
GetXMaximum()This action returns the rightmost position, on the x-axis, of the bounding box.
GetXMinimum()This action returns the leftmost position, on the x-axis, of the bounding box.
GetYMaximum()This action returns the top position, on the y-axis, of the bounding box.
GetYMinimum()This action returns the bottom position, on the y-axis, of the bounding box.
SetBoundingBox(integer xMinimum, integer yMinimum, integer xMaximum, integer yMaximum)This action sets the dimensions of the bounding box.
SetXMaximum(integer xMaximum)This action sets the rightmost position, on the x-axis, of the bounding box.
SetXMinimum(integer xMinimum)This action sets the leftmost position, on the x-axis, of the bounding box.
SetYMaximum(integer yMaximum)This action sets the top position, on the y-axis, of the bounding box.
SetYMinimum(integer yMinimum)This action sets the bottom position, on the y-axis, of the bounding box.
ToText()This action returns the dimensions of the bounding box as text.
ToText(integer pixelSize, integer emSize)This action returns the dimensions of the bounding box as text, after the dimensions have been scaled based on the font size.

Actions Documentation

Compare(Libraries.Language.Object object)

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)

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Equals(Libraries.Language.Object 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)

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

Return

integer: The integer hash code of the object.

GetXMaximum()

This action returns the rightmost position, on the x-axis, of the bounding box.

Example Code

use Libraries.Game.Graphics.Fonts.all
        use Libraries.Game.Game

        class Main is Game
            action Main
                StartGame()
            end
            
            action CreateGame()
                FontBoundingBox box
                integer right = box:GetXMaximum()
                output right
            end
        end

Return

integer: Returns the rightmost position of the bounding box.

GetXMinimum()

This action returns the leftmost position, on the x-axis, of the bounding box.

Example Code

use Libraries.Game.Graphics.Fonts.all
        use Libraries.Game.Game

        class Main is Game
            action Main
                StartGame()
            end
            
            action CreateGame
                FontBoundingBox box
                integer left = box:GetXMinimum()
                output left
            end
        end

Return

integer: Returns the leftmost position of the bounding box.

GetYMaximum()

This action returns the top position, on the y-axis, of the bounding box.

Example Code

use Libraries.Game.Graphics.Fonts.all
        use Libraries.Game.Game

        class Main is Game
            action Main
                StartGame()
            end

            action CreateGame
                FontBoundingBox box
                integer top = box:GetYMaximum()
                output top
            end
        end

Return

integer: Returns the top position of the bounding box.

GetYMinimum()

This action returns the bottom position, on the y-axis, of the bounding box.

Example Code

use Libraries.Game.Graphics.Fonts.all
        use Libraries.Game.Game

        class Main is Game
            action Main
                StartGame()
            end

            action CreateGame
                FontBoundingBox box
                integer bottom = box:GetYMinimum()
                output bottom
            end
        end

Return

integer: Returns the bottom position of the bounding box.

SetBoundingBox(integer xMinimum, integer yMinimum, integer xMaximum, integer yMaximum)

This action sets the dimensions of the bounding box.

Example Code

use Libraries.Game.Graphics.Fonts.all
        use Libraries.Game.Game

        class Main is Game
            action Main
                StartGame()
            end

            action CreateGame
                FontBoundingBox box
                box:SetBoundingBox(0, 0, 100, 100)
                output box:ToText()
            end
        end

Parameters

SetXMaximum(integer xMaximum)

This action sets the rightmost position, on the x-axis, of the bounding box.

Example Code

use Libraries.Game.Graphics.Fonts.all
        use Libraries.Game.Game

        class Main is Game
            action Main
                StartGame()
            end

            action CreateGame
                FontBoundingBox box
                box:SetXMaximum(10)
                output box:ToText()
            end
        end

Parameters

SetXMinimum(integer xMinimum)

This action sets the leftmost position, on the x-axis, of the bounding box.

Example Code

use Libraries.Game.Graphics.Fonts.all
        use Libraries.Game.Game

        class Main is Game
            action Main
                StartGame()
            end

            action CreateGame
                FontBoundingBox box
                box:SetXMinimum(10)
                output box:ToText()
            end
        end

Parameters

SetYMaximum(integer yMaximum)

This action sets the top position, on the y-axis, of the bounding box.

Example Code

use Libraries.Game.Graphics.Fonts.all
        use Libraries.Game.Game

        class Main is Game
            action Main
                StartGame()
            end 
            
            action CreateGame
                FontBoundingBox box
                box:SetYMaximum(10)
                output box:ToText()
            end
        end

Parameters

SetYMinimum(integer yMinimum)

This action sets the bottom position, on the y-axis, of the bounding box.

Example Code

use Libraries.Game.Graphics.Fonts.all
        use Libraries.Game.Game

        class Main is Game
            action Main
                StartGame()
            end

            action CreateGame
                FontBoundingBox box
                box:SetYMinimum(10)
                output box:ToText()
            end
        end

Parameters

ToText()

This action returns the dimensions of the bounding box as text.

Example Code

use Libraries.Game.Graphics.Fonts.all
        use Libraries.Game.Game

        class Main is Game
            action Main
                StartGame()
            end

            action CreateGame
                FontBoundingBox box
                output box:ToText()
            end
        end

Return

text: Returns the dimensions of the bounding box as text.

ToText(integer pixelSize, integer emSize)

This action returns the dimensions of the bounding box as text, after the dimensions have been scaled based on the font size.

Example Code

use Libraries.Game.Graphics.Fonts.all
        use Libraries.Game.Game

        class Main is Game
            action Main
                StartGame()
            end

            action CreateGame()
                FontBoundingBox box
                box:SetBoundingBox(100, 100, 100, 100)
                output box:ToText(10, 2048)
            end
        end

Parameters

Return

text: Returns the dimensions of the bounding box as text, after being scaled.