Processing GUI System

THERE IS A NEW VERSION AVAILABLE: https://github.com/What42Pizza/Processing-GUI-System-2

THIS IS A WORK IN PROGRESS.

This is a set of classes you can use in Processing that allows you to easily create GUIs. This was designed in Processing 3.5.3, so you should be using at least that. It might work with earlier versions, but I don't know.

The main file is GUISystem/GUISystem.pde, which shows how to use the classes. All other files in GUISystem will need to be copied into your own project in order to be used. Not all files have to be copied, though. If you only need some classes, then you can just copy the files for those classes, the files for their super classes, and GUI_Functions.pde (which always needs to be copied).

YOU NEED TO HAVE THE FOLLOWING CODE AT THE START OF YOUR PROGRAM FOR THIS TO WORK:

GUI_Functions GUIFunctions = new GUI_Functions();

Classes:

• GUI_Frame
  • GUI_TextFrame
  • GUI_ImageFrame
  • GUI_Button
    • GUI_TextButton
    • GUI_ImageButton

GUI_Frame:

This is the most basic class. You pretty much just place other GUI elements into this.

Vars:

• String Name

• float XPos (0 - 1) (default: 0.25)

• float YPos (0 - 1) (default: 0.25)

• float XSize (0 - 1) (default: 0.5)

• float YSize (0 - 1) (default: 0.5)

• color BackgroundColor (default: 127)

• color EdgeColor (default: 0)

• int EdgeSize (default: 1)

• boolean Draggable (default: false)

• boolean Visible (default: true) (sets whether this frame is visible)

• boolean Enabled (default: true) (sets whether this frame and all children are visible)

• ArrayList <GUI_Frame> Children

• GUI_Frame Parent

Functions:

• void Render ()
• void AddChild (GUI_Frame NewChild)
• GUI_Frame Child (String ChildName)
• GUI_Frame Descendant (String DescendantName)
• boolean HasMouseHovering ()

Constructors:

• GUI_Frame (String Name)
• GUI_Frame (String Name, float XPos, float YPos)
• GUI_Frame (String Name, float XPos, float YPos, float XSize, float YSize)
• GUI_Frame (String Name, ArrayList <GUI_Frame> Children)
• GUI_Frame (String[] Settings)
• GUI_Frame (String[] Settings, GUI_Frame[] Children)
• GUI_Frame (File FrameFolder) (see end of readme)

GUI_TextFrame

GUI_TextFrame is like a frame, but with text.

Vars:

• String Text (default: "Error: text not set")
• color TextColor (default: 0)
• float TextSize (default: 1 (1/100 of screen width or 1/10 of frame width))
• String TextSizeIsRelativeTo (either "FRAME" or "SCREEN"; default: "FRAME")
• int TextAlignX (-1 = LEFT, 0 = CENTER, 1 = RIGHT; default: 0)
• int TextAlignY (-1 = TOP, 0 = CENTER, 1 = BOTTM; default: 0)

No new functions.

Constructors:

• GUI_TextFrame (String Name)
• GUI_TextFrame (String Name, String Text)
• GUI_TextFrame (String Name, float XPos, float YPos, String Text)
• GUI_TextFrame (String Name, float XPos, float YPos, float XSize, float YSize, String Text)
• GUI_TextFrame (String Name, ArrayList <GUI_Frame> Children)
• GUI_TextFrame (String Name, ArrayList <GUI_Frame> Children, String Text)
• GUI_TextFrame (String[] Settings)
• GUI_TextFrame (String[] Settings, GUI_Frame[] Children)
• GUI_TextFrame (File FrameFolder) (see end of readme)

GUI_ImageFrame

GUI_ImageFrame is like a frame, but with an image.

Vars:

• PImage Image (default: null)
• boolean RenderFrame (default: true)

No new functions.

Constructors:

• GUI_ImageFrame (String Name)
• GUI_ImageFrame (String Name, PImage Image)
• GUI_ImageFrame (String Name, float XPos, float YPos, PImage Image)
• GUI_ImageFrame (String Name, float XPos, float YPos, float XSize, float YSize, PImage Image)
• GUI_ImageFrame (String Name, ArrayList <GUI_Frame> Children)
• GUI_ImageFrame (String Name, ArrayList <GUI_Frame> Children, PImage Image)
• GUI_ImageFrame (String[] Settings)
• GUI_ImageFrame (String[] Settings, GUI_Frame[] Children)
• GUI_ImageFrame (File FrameFolder) (see end of readme)

GUI_Button

GUI_Button is the most basic button. You should probably use GUI_TextButton instead of this.

Vars:

• boolean UsePressedColor (default: true)
• color PressedBackgroundColor (default: 63)
• float XMove (default: 0)
• float YMove (default: 1)
• boolean Pressed (read only)

Functions:

• boolean JustClicked()

Constructors:

• GUI_Button (String Name)
• GUI_Button (String Name, float XPos, float YPos)
• GUI_Button (String Name, float XPos, float YPos, float XSize, float YSize)
• GUI_Button (String Name, ArrayList <GUI_Frame> Children)
• GUI_Button (String[] Settings)
• GUI_Button (String[] Settings, GUI_Frame[] Children)
• GUI_Button (File FrameFolder) (see end of readme)

GUI_TextButton

GUI_TextButton is like a button, but with text.

Vars:

• String Text (default: "Error: text not set")
• color TextColor (default: 0)
• float TextSize (default: 1 (1/100 of screen width or 1/10 of frame width))
• String TextSizeIsRelativeTo (either "FRAME" or "SCREEN"; default: "FRAME")
• int TextAlignX (-1 = LEFT, 0 = CENTER, 1 = RIGHT; default: 0)
• int TextAlignY (-1 = TOP, 0 = CENTER, 1 = BOTTM; default: 0)

No new functions.

Constructors:

• GUI_TextButton (String Name)
• GUI_TextButton (String Name, String Text)
• GUI_TextButton (String Name, float XPos, float YPos, String Text)
• GUI_TextButton (String Name, float XPos, float YPos, float XSize, float YSize, String Text)
• GUI_TextButton (String Name, ArrayList <GUI_Frame> Children)
• GUI_TextButton (String Name, ArrayList <GUI_Frame> Children, String Text)
• GUI_TextButton (String[] Settings)
• GUI_TextButton (String[] Settings, GUI_Frame[] Children)
• GUI_TextButton (File FrameFolder) (see end of readme)

GUI_ImageButton

GUI_ImageButton is like a button, but with an image.

Vars:

• PImage Image (default: null)
• boolean RenderFrame (default: true)

No new functions.

Constructors:

• GUI_ImageButton (String Name)
• GUI_ImageButton (String Name, PImage Image)
• GUI_ImageButton (String Name, float XPos, float YPos, PImage Image)
• GUI_ImageButton (String Name, float XPos, float YPos, float XSize, float YSize, PImage Image)
• GUI_ImageButton (String Name, ArrayList <GUI_Frame> Children)
• GUI_ImageButton (String Name, ArrayList <GUI_Frame> Children, PImage Image)
• GUI_ImageButton (String[] Settings)
• GUI_ImageButton (String[] Settings, GUI_Frame[] Children)
• GUI_ImageButton (File FrameFolder) (see end of readme)

Using (File FrameFolder) constructors:

This constructor is used for loading a GUI from files.

The File given has to be a folder, and it has to have a file named Properties.txt. The Properties file holds information the same way that it would be given to a (String[] Settings) constructor.

FrameFolder can also have other folders in it, and they would be the frame's children. In order for it to recognized as a child, it has to start with "Child." followed by the type of class it is. You can place another period if you want to add addition text.

Here's an example of how you would set up a GUI that loads GUI/StartingFrame:

• GUI
  • StartingFrame
    • Properties.txt
    • Child.GUI_Frame.ThisIsANestedFrame
      • Properties.txt
      • Child.GUI_Frame.ThisIsAnotherNestedFrame
        • Properties.txt

Last updated 10/02/20