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

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.

Parameters

Return

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

Example

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

Equals(Libraries.Language.Object object)

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

Parameters

Return

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

Example

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

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

GetXMaximum()

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

Return

integer: Returns the rightmost position of the bounding box.

Example

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

GetXMinimum()

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

Return

integer: Returns the leftmost position of the bounding box.

Example

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

GetYMaximum()

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

Return

integer: Returns the top position of the bounding box.

Example

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

GetYMinimum()

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

Return

integer: Returns the bottom position of the bounding box.

Example

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

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

This action sets the dimensions of the bounding box.

Parameters

  • integer xMinimum: The leftmost x-coordinate position of the box.
  • integer yMinimum: The lowest y-coordinate position of the box.
  • integer xMaximum: The rightmost x-coordinate position ofthe box.
  • integer yMaximum: The highest y-coordinate position of the box.

Example

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

SetXMaximum(integer xMaximum)

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

Parameters

  • integer xMaximum: The rightmost x-coordinate position of the box.

Example


    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

SetXMinimum(integer xMinimum)

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

Parameters

  • integer xMinimum: The leftmost x-coordinate position of the box.

Example

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

SetYMaximum(integer yMaximum)

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

Parameters

  • integer yMaximum: The top y-coordinate position of the box.

Example

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

SetYMinimum(integer yMinimum)

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

Parameters

  • integer yMinimum: The bottom y-coordinate position of the box.

Example

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

ToText()

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

Return

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

Example

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

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.

Parameters

  • integer pixelSize: The size of a pixel on the display.
  • integer emSize: The size of the EM square for the font.

Return

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

Example

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