LazyGui

java.lang.Object
- com.krab.lazy.LazyGui

```
public class LazyGui
extends java.lang.Object
```
Main class for controlling the GUI from a processing sketch. Should be initialized as a global variable in processing setup() function with new LazyGui(this). Registers itself at end of the draw() method and displays the GUI whenever draw() ends. Allows the library user to get the value of a gui control element at any time inside draw(), even repeatedly inside loops. If the control element does not exist yet at the time its value is requested it gets newly created just in time. Please note that only one LazyGui object is expected to exist in any given sketch, due to internal static classes.

Constructor Summary

Constructors
Constructor and Description
`LazyGui(processing.core.PApplet sketch)` Main constructor for the LazyGui object which acts as a central hub for all GUI related methods.
`LazyGui(processing.core.PApplet sketch, LazyGuiSettings settings)` Constructor for the LazyGui object which acts as a central hub for all GUI related methods.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`button(java.lang.String path)` Gets the value of a button control element and sets it to false.
`void`	`clearFolder()` Clears the global path prefix stack, removing all its elements.
`PickerColor`	`colorPicker(java.lang.String path)` Gets the color value of a color picker control element.
`PickerColor`	`colorPicker(java.lang.String path, float grayNorm)` Gets the color value of a color picker control element.
`PickerColor`	`colorPicker(java.lang.String path, float hueNorm, float saturationNorm, float brightnessNorm)` Gets the color value of a color picker control element.
`PickerColor`	`colorPicker(java.lang.String path, float hueNorm, float saturationNorm, float brightnessNorm, float alphaNorm)` Gets the color value of a color picker control element.
`PickerColor`	`colorPicker(java.lang.String path, int hex)` Gets the color value of a color picker control element.
`void`	`colorPickerHueAdd(java.lang.String path, float hueToAdd)` Adds hue to the color picker, looping it correctly in both directions at the [0,1] boundary.
`void`	`colorPickerSet(java.lang.String path, int hex)` Sets the color picker to a given hex value.
`ColorPoint`	`colorPoint(int color, float pos)` Helper function for calling `gui.gradient(String path, ColorPoint...
`void`	`createSave()` Creates a new, sequentially numbered save file in the gui save folder inside the sketch data folder.
`void`	`createSave(java.lang.String path)` Creates a new save file or overwrites an existing one while auto-detecting whether the parameter is a relative or an absolute path to it on disk.
`void`	`draw()` Updates and draws the GUI on the main processing canvas.
`void`	`draw(processing.core.PGraphics targetCanvas)` Updates and draws the GUI on the specified parameter canvas, assuming its size is identical to the main sketch size.
`java.lang.String`	`getFolder()` Gets the current path prefix stack, inserting a forward slash after each folder name in the stack.
`processing.core.PGraphics`	`getGuiCanvas()` Utility method for displaying the GUI before draw() ends for the purposes of recording.
`processing.core.PFont`	`getMainFont()` Gets the main font as currently used by the GUI.
`processing.core.PFont`	`getSideFont()` Gets the side font as currently used by the GUI.
`java.lang.String`	`getVersion()` Returns the current version of the library as a string in the format v{major}.{minor}.{patch} according to semantic versioning.
`processing.core.PGraphics`	`gradient(java.lang.String path)` Gets a gradient as an image with size matching the main processing sketch size.
`processing.core.PGraphics`	`gradient(java.lang.String path, ColorPoint... colorPoints)` Gets a gradient as an image with size matching the main processing sketch size.
`processing.core.PGraphics`	`gradient(java.lang.String path, int defaultHexColor)` Gets a gradient as an image with size matching the main processing sketch size.
`processing.core.PGraphics`	`gradient(java.lang.String path, int[] defaultColors)` Gets a gradient as an image with size matching the main processing sketch size.
`PickerColor`	`gradientColorAt(java.lang.String path, float position)` Gets a single color from a gradient at the specified position in the range [0, 1].
`boolean`	`hasChanged()` Returns whether the current folder or any of its recursively nested children changed last frame.
`boolean`	`hasChanged(java.lang.String path)` Returns whether a control element value, folder or any of its recursively nested children changed last frame.
`void`	`hide(java.lang.String path)` Hide any chosen element or folder except the root window.
`void`	`hideCurrentFolder()` Hides the folder at the current path prefix stack.
`void`	`hideGui()` Hides the GUI completely and skips displaying it.
`void`	`hideGuiToggle()` Hides the gui if it was visible.
`static float`	`hueModulo(float hue)` Hue values loop at the 1 - 0 border both in the positive and negative direction, just like two pi loops back to 0.
`boolean`	`isMouseOutsideGui()` Utility function to tell if the latest mouse event collided and interacted with the GUI.
`boolean`	`isMouseOverGui()` Utility function to tell if the latest mouse event collided and interacted with the GUI.
`void`	`loadSave(java.lang.String path)` Loads a save file from disk, overwriting the current values in the running gui whose gui paths match with the saved elements.
`void`	`plotSet(java.lang.String path, float xyz)` Sets the vector value of a 2D grid control element with an extra z slider.
`void`	`plotSet(java.lang.String path, float x, float y)` Sets the vector value of a 2D control element.
`void`	`plotSet(java.lang.String path, float x, float y, float z)` Sets the vector value of a 2D grid control element with an extra z slider.
`void`	`plotSet(java.lang.String path, processing.core.PVector valueToSet)` Sets the vector value of a 2D grid control element with an extra z slider.
`processing.core.PVector`	`plotXY(java.lang.String path)` Gets the vector value of a 2D grid control element.
`processing.core.PVector`	`plotXY(java.lang.String path, float defaultXY)` Gets the vector value of a 2D grid control element.
`processing.core.PVector`	`plotXY(java.lang.String path, float defaultX, float defaultY)` Gets the vector value of a 2D grid control element.
`processing.core.PVector`	`plotXY(java.lang.String path, processing.core.PVector defaultXY)` Gets the vector value of a 2D grid control element.
`processing.core.PVector`	`plotXYZ(java.lang.String path)` Gets the vector value of a 2D grid control element with an extra z slider.
`processing.core.PVector`	`plotXYZ(java.lang.String path, float defaultXYZ)` Gets the vector value of a 2D grid control element with an extra z slider.
`processing.core.PVector`	`plotXYZ(java.lang.String path, float defaultX, float defaultY, float defaultZ)` Gets the vector value of a 2D grid control element with an extra z slider.
`processing.core.PVector`	`plotXYZ(java.lang.String path, processing.core.PVector defaultXYZ)` Gets the vector value of a 2D grid control element with an extra z slider.
`void`	`popFolder()` Pops the last pushed folder name from the global path prefix stack.
`void`	`pushFolder(java.lang.String folderName)` Pushes a folder name to the global path prefix stack.
`java.lang.String`	`radio(java.lang.String path, java.util.List<java.lang.String> options)` Gets the currently selected string from a list of options in a gui control element.
`java.lang.String`	`radio(java.lang.String path, java.util.List<java.lang.String> options, java.lang.String defaultOption)` Gets the currently selected string from a list of options in a gui control element.
`java.lang.String`	`radio(java.lang.String path, java.lang.String[] options)` Gets the currently selected string from an array of options in a gui control element.
`java.lang.String`	`radio(java.lang.String path, java.lang.String[] options, java.lang.String defaultOption)` Gets the currently selected string from an array of options in a gui control element.
`void`	`radioSet(java.lang.String path, java.lang.String optionToSet)` Sets the radio element value to a given parameter.
`void`	`radioSetOptions(java.lang.String path, java.util.List<java.lang.String> optionsToSet)` Sets the radio options to a given list of strings, overwriting any existing list.
`void`	`radioSetOptions(java.lang.String path, java.lang.String[] optionsToSet)` Sets the radio options to a given array of strings, overwriting any existing list.
`void`	`show(java.lang.String path)` Makes any control element or folder visible again if it has been hidden by the hide() function.
`void`	`showCurrentFolder()` Shows the folder at the current path prefix stack.
`void`	`showGui()` Shows the GUI if it was hidden with 'h' or hideGui().
`float`	`slider(java.lang.String path)` Gets the value of a float slider control element.
`float`	`slider(java.lang.String path, float defaultValue)` Gets the value of a float slider control element.
`float`	`slider(java.lang.String path, float defaultValue, float min, float max)` Gets the value of a float slider control element.
`void`	`sliderAdd(java.lang.String path, float amountToAdd)` Adds a float to the value of a float or int slider control element manually at runtime without requiring user interaction.
`int`	`sliderInt(java.lang.String path)` Gets the value of an integer slider control element.
`int`	`sliderInt(java.lang.String path, int defaultValue)` Gets the value of an integer slider control element.
`int`	`sliderInt(java.lang.String path, int defaultValue, int min, int max)` Gets the value of an integer slider control element.
`void`	`sliderIntSet(java.lang.String path, int value)` Sets the value of an integer slider control element manually at runtime without requiring user interaction.
`void`	`sliderSet(java.lang.String path, float value)` Sets the value of a float slider control element manually at runtime without requiring user interaction.
`java.lang.String`	`text(java.lang.String path)` Gets the current value of a text input element.
`java.lang.String`	`text(java.lang.String path, java.lang.String content)` Gets the current value of an editable text field element.
`void`	`textSet(java.lang.String path, java.lang.String content)` Sets the current value of an editable text field element.
`boolean`	`toggle(java.lang.String path)` Gets the current value of a toggle control element.
`boolean`	`toggle(java.lang.String path, boolean defaultValue)` Gets the current value of a toggle control element.
`void`	`toggleSet(java.lang.String path, boolean value)` Sets the value of a boolean toggle control element.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LazyGui
```
public LazyGui(processing.core.PApplet sketch)
```
    Main constructor for the LazyGui object which acts as a central hub for all GUI related methods. Meant to be initialized once in setup() with new LazyGui(this). Registers itself at end of the draw() method and displays the GUI whenever draw() ends.
    
    Parameters:
    
    sketch - the sketch that uses this gui, should be 'this' from the calling side
  - LazyGui
```
public LazyGui(processing.core.PApplet sketch,
               LazyGuiSettings settings)
```
    Constructor for the LazyGui object which acts as a central hub for all GUI related methods. Meant to be initialized once in setup() with new LazyGui(this). Registers itself at end of the draw() method and displays the GUI whenever draw() ends.
    
    Parameters:
    
    sketch - main processing sketch class to display the GUI on and use keyboard and mouse input from
    
    settings - settings to apply (loading a save on startup will overwrite them)
    
    See Also:
    
    LazyGuiSettings
- Method Detail
  - getGuiCanvas
```
public processing.core.PGraphics getGuiCanvas()
```
    Utility method for displaying the GUI before draw() ends for the purposes of recording. Does not update the gui, only returns the previous frame's gui canvas. Can be confusing when displayed due to seeing duplicated GUI images with slightly different content.
    
    Returns:
    
    previous frame's gui canvas
  - draw
```
public void draw()
```
    Updates and draws the GUI on the main processing canvas. Gets called automatically at the end of draw() by default, but can also be called manually to display the GUI at a better time during the frame. The GUI will not draw itself multiple times per one frame, so the automatic execution is skipped when this is called manually. Must stay public because otherwise this registering won't work: app.registerMethod("draw", this); Calls draw(PGraphics) internally with the default sketch PGraphics.
    
    See Also:
    
    draw(PGraphics)
  - draw
```
public void draw(processing.core.PGraphics targetCanvas)
```
    Updates and draws the GUI on the specified parameter canvas, assuming its size is identical to the main sketch size. Gets called automatically at the end of draw(). LazyGui will enforce itself being drawn only once per frame internally, which can be useful for including the gui in a recording. If it does get called manually, it will get drawn when requested and then skip its automatic execution for that frame.
    Resets any potential hint(DISABLE_DEPTH_TEST) to the default hint(ENABLE_DEPTH_TEST) when done, because it needs the DISABLE_DEPTH_TEST to draw the GUI over 3D scenes and has currently no way to save or query the original hint state.
    
    Parameters:
    
    targetCanvas - canvas to draw the GUI on
  - isMouseOutsideGui
```
public boolean isMouseOutsideGui()
```
    Utility function to tell if the latest mouse event collided and interacted with the GUI. For example with a mouse controlled brush you might not want to draw on the main canvas when you only want to adjust brush properties in the GUI and you don't expect that to affect the artwork.
    
    Returns:
    
    whether you should use this mouse press in your processing sketch
  - isMouseOverGui
```
public boolean isMouseOverGui()
```
    Utility function to tell if the latest mouse event collided and interacted with the GUI. Inverse of isMouseOutsideGui().
    
    Returns:
    
    whether you should ignore this mouse press in your processing sketch
  - slider
```
public float slider(java.lang.String path)
```
    Gets the value of a float slider control element. lazily initializes it if needed and uses a default value of 0.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    Returns:
    
    current float value of the slider
  - slider
```
public float slider(java.lang.String path,
                    float defaultValue)
```
    Gets the value of a float slider control element. lazily initializes it if needed and uses a specified default value.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    defaultValue - default value to set the slider to
    
    Returns:
    
    current float value of the slider
  - slider
```
public float slider(java.lang.String path,
                    float defaultValue,
                    float min,
                    float max)
```
    Gets the value of a float slider control element. lazily initializes it if needed and uses a default value specified in the parameter. along with enforcing a minimum and maximum of reachable values.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    defaultValue - the default value, ideally between min and max
    
    min - the value cannot go below this, min < max must be true
    
    max - the value cannot go above this, max > min must be true
    
    Returns:
    
    current float value of the slider
  - sliderSet
```
public void sliderSet(java.lang.String path,
                      float value)
```
    Sets the value of a float slider control element manually at runtime without requiring user interaction. Does not block changing the value in the future in any way. Can be used as a non-interactive value display if you set the value every frame. Initializes a new float slider at the given path if needed with the value parameter used as a default value and with no constraint on min and max value.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    value - value to set the float slider at the path to
  - sliderAdd
```
public void sliderAdd(java.lang.String path,
                      float amountToAdd)
```
    Adds a float to the value of a float or int slider control element manually at runtime without requiring user interaction. Does not block changing the value in the future in any way. Initializes a new float slider at the given path if needed with default value 0 and with no constraint on min and max value.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    amountToAdd - value to set the float slider at the path to
  - sliderInt
```
public int sliderInt(java.lang.String path)
```
    Gets the value of an integer slider control element. lazily initializes it if needed and uses a default value of 0.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    Returns:
    
    current float value of the slider
  - sliderInt
```
public int sliderInt(java.lang.String path,
                     int defaultValue)
```
    Gets the value of an integer slider control element. lazily initializes it if needed and uses the specified default value.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    defaultValue - default value to set the slider to
    
    Returns:
    
    current float value of the slider
  - sliderInt
```
public int sliderInt(java.lang.String path,
                     int defaultValue,
                     int min,
                     int max)
```
    Gets the value of an integer slider control element. lazily initializes it if needed and uses a default value specified in the parameter. along with enforcing a minimum and maximum of reachable values.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    defaultValue - the default value, ideally between min and max
    
    min - the value cannot go below this, min < max must be true
    
    max - the value cannot go above this, max > min must be true
    
    Returns:
    
    current float value of the slider
  - sliderIntSet
```
public void sliderIntSet(java.lang.String path,
                         int value)
```
    Sets the value of an integer slider control element manually at runtime without requiring user interaction. Initializes a new float slider at the given path if needed. Does not block changing the value in the future in any way. with the value param used as a default value and with no constraint on min and max value.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    value - value to set the float slider at the path to
  - plotXY
```
public processing.core.PVector plotXY(java.lang.String path)
```
    Gets the vector value of a 2D grid control element. Lazily initializes it if needed and sets all values to 0 by default.
    
    Parameters:
    
    path - forward slash separated unique path to the plot control element
    
    Returns:
    
    current xy value with z always set to 0
  - plotXY
```
public processing.core.PVector plotXY(java.lang.String path,
                                      float defaultXY)
```
    Gets the vector value of a 2D grid control element. Lazily initializes it if needed and sets its values to the parameter default.
    
    Parameters:
    
    path - forward slash separated unique path to the plot control element
    
    defaultXY - default xy value
    
    Returns:
    
    current xy value with z always set to 0
  - plotXY
```
public processing.core.PVector plotXY(java.lang.String path,
                                      float defaultX,
                                      float defaultY)
```
    Gets the vector value of a 2D grid control element. Lazily initializes it if needed and sets its values to the parameter defaults.
    
    Parameters:
    
    path - forward slash separated unique path to the plot control element
    
    defaultX - default x value
    
    defaultY - default y value
    
    Returns:
    
    current xy value with z always set to 0
  - plotXY
```
public processing.core.PVector plotXY(java.lang.String path,
                                      processing.core.PVector defaultXY)
```
    Gets the vector value of a 2D grid control element. Lazily initializes it if needed and sets its values to the parameter defaults.
    
    Parameters:
    
    path - forward slash separated unique path to the plot control element
    
    defaultXY - default xy values, z value is ignored
    
    Returns:
    
    current xy value with z always set to 0
  - plotXYZ
```
public processing.core.PVector plotXYZ(java.lang.String path)
```
    Gets the vector value of a 2D grid control element with an extra z slider. Lazily initializes it if needed and sets its xyz values to 0 by default.
    
    Parameters:
    
    path - forward slash separated unique path to the plot control element
    
    Returns:
    
    current xyz values
  - plotXYZ
```
public processing.core.PVector plotXYZ(java.lang.String path,
                                       float defaultXYZ)
```
    Gets the vector value of a 2D grid control element with an extra z slider. Lazily initializes it if needed and sets its values to the parameter defaults.
    
    Parameters:
    
    path - forward slash separated unique path to the plot control element
    
    defaultXYZ - default xyz values
    
    Returns:
    
    current xyz values
  - plotXYZ
```
public processing.core.PVector plotXYZ(java.lang.String path,
                                       float defaultX,
                                       float defaultY,
                                       float defaultZ)
```
    Gets the vector value of a 2D grid control element with an extra z slider. Lazily initializes it if needed and sets its values to the parameter defaults.
    
    Parameters:
    
    path - forward slash separated unique path to the plot control element
    
    defaultX - default x value
    
    defaultY - default y value
    
    defaultZ - default z value
    
    Returns:
    
    current xyz values
  - plotXYZ
```
public processing.core.PVector plotXYZ(java.lang.String path,
                                       processing.core.PVector defaultXYZ)
```
    Gets the vector value of a 2D grid control element with an extra z slider. Lazily initializes it if needed and sets its values to the parameter defaults.
    
    Parameters:
    
    path - forward slash separated unique path to the plot control element
    
    defaultXYZ - default xyz values
    
    Returns:
    
    current xyz values
  - plotSet
```
public void plotSet(java.lang.String path,
                    float xyz)
```
    Sets the vector value of a 2D grid control element with an extra z slider. Lazily initializes it if needed and sets each of its x,y,z values to the parameter default.
    
    Parameters:
    
    path - forward slash separated unique path to the plot control element
    
    xyz - value to set to each axis
  - plotSet
```
public void plotSet(java.lang.String path,
                    float x,
                    float y)
```
    Sets the vector value of a 2D control element. Lazily initializes it if needed and sets its x,y values to the parameter defaults. The extra z slider will not be shown if the plot is initialized in this way.
    
    Parameters:
    
    path - forward slash separated unique path to the plot control element
    
    x - x value to set
    
    y - y value to set
  - plotSet
```
public void plotSet(java.lang.String path,
                    float x,
                    float y,
                    float z)
```
    Sets the vector value of a 2D grid control element with an extra z slider. Lazily initializes it if needed and sets each of its x,y,z values to the separate parameter defaults.
    
    Parameters:
    
    path - forward slash separated unique path to the plot control element
    
    x - x value to set
    
    y - y value to set
    
    z - z value to set
  - plotSet
```
public void plotSet(java.lang.String path,
                    processing.core.PVector valueToSet)
```
    Sets the vector value of a 2D grid control element with an extra z slider. Lazily initializes it if needed and sets each of its x,y,z values to the separate parameter defaults.
    
    Parameters:
    
    path - forward slash separated unique path to the plot control element
    
    valueToSet - vector value to set
  - toggle
```
public boolean toggle(java.lang.String path)
```
    Gets the current value of a toggle control element. lazily initializes it if needed and sets its value to false by default.
    
    Parameters:
    
    path - forward slash separated unique path to the control element.
    
    Returns:
    
    current value of the toggle
  - toggle
```
public boolean toggle(java.lang.String path,
                      boolean defaultValue)
```
    Gets the current value of a toggle control element. lazily initializes it if needed and sets its value to the specified parameter default.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    defaultValue - default value of the toggle
    
    Returns:
    
    current value of the toggle
  - toggleSet
```
public void toggleSet(java.lang.String path,
                      boolean value)
```
    Sets the value of a boolean toggle control element. Does not block changing the value in the future in any way. Lazily initializes the toggle if needed.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    value - current value of the toggle
  - button
```
public boolean button(java.lang.String path)
```
    Gets the value of a button control element and sets it to false. Lazily initializes the button if needed. Meant to be used inside draw() like this:
```
 if(gui.button("actions/print")){
     println("hello world");
 }
 
```
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    Returns:
    
    button value that can only be true once per user interaction
  - radio
```
public java.lang.String radio(java.lang.String path,
                              java.util.List<java.lang.String> options)
```
    Gets the currently selected string from a list of options in a gui control element. Lazily initializes the radio element if needed - any later changes in the options parameter will be ignored. Sets the default value to the first value in the list.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    options - list of options to display
    
    Returns:
    
    currently selected string
  - radio
```
public java.lang.String radio(java.lang.String path,
                              java.util.List<java.lang.String> options,
                              java.lang.String defaultOption)
```
    Gets the currently selected string from a list of options in a gui control element. Lazily initializes the radio element if needed - any later changes in the options parameter will be ignored. Sets the default value to the specified parameter value, which must be contained in the options list, or it will be ignored.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    options - list of options to display
    
    defaultOption - default option to select, which must also be found in the options, or it will be ignored
    
    Returns:
    
    currently selected string
  - radio
```
public java.lang.String radio(java.lang.String path,
                              java.lang.String[] options)
```
    Gets the currently selected string from an array of options in a gui control element. Lazily initializes the radio element if needed - any later changes in the options parameter will be ignored. Sets the default value to the specified parameter value, which must be contained in the options array, or it will be ignored.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    options - list of options to display
    
    Returns:
    
    currently selected string
  - radio
```
public java.lang.String radio(java.lang.String path,
                              java.lang.String[] options,
                              java.lang.String defaultOption)
```
    Gets the currently selected string from an array of options in a gui control element. Lazily initializes the radio element if needed - any later changes in the options parameter will be ignored. Sets the default value to the specified parameter value, which must be contained in the options array, or it will be ignored.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    options - list of options to display
    
    defaultOption - default option to select, must also be found in options, or it is ignored
    
    Returns:
    
    currently selected string
  - radioSet
```
public void radioSet(java.lang.String path,
                     java.lang.String optionToSet)
```
    Sets the radio element value to a given parameter. Does not lazily initialize the radio element because it doesn't know what all the options should be. If the option to set is not found in the radio's existing list of options - it is ignored and a warning message is printed to console.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    optionToSet - string option to set the radio element to
  - radioSetOptions
```
public void radioSetOptions(java.lang.String path,
                            java.util.List<java.lang.String> optionsToSet)
```
    Sets the radio options to a given list of strings, overwriting any existing list.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    optionsToSet - list of options to set
  - radioSetOptions
```
public void radioSetOptions(java.lang.String path,
                            java.lang.String[] optionsToSet)
```
    Sets the radio options to a given array of strings, overwriting any existing list.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    optionsToSet - list of options to set
  - colorPicker
```
public PickerColor colorPicker(java.lang.String path)
```
    Gets the color value of a color picker control element. Lazily initializes the color picker if needed. Default hsba values are (1,1,0,1) - therefore default color is black.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    Returns:
    
    current hex and hsba values in a PickerColor object
  - colorPicker
```
public PickerColor colorPicker(java.lang.String path,
                               float grayNorm)
```
    Gets the color value of a color picker control element. Lazily initializes the color picker if needed with the specified grayNorm brightness in the range [0,1]. Default hsba values are (0,0,grayNorm,1).
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    grayNorm - default brightness in the range [0,1]
    
    Returns:
    
    current hex and hsba values in a PickerColor object
  - colorPicker
```
public PickerColor colorPicker(java.lang.String path,
                               float hueNorm,
                               float saturationNorm,
                               float brightnessNorm)
```
    Gets the color value of a color picker control element. Lazily initializes the color picker if needed with the specified defaults.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    hueNorm - default hue in the range [0,1]
    
    saturationNorm - default saturation in the range [0,1]
    
    brightnessNorm - default brightness in the range [0,1]
    
    Returns:
    
    current hex and hsba values in a PickerColor object
  - colorPicker
```
public PickerColor colorPicker(java.lang.String path,
                               float hueNorm,
                               float saturationNorm,
                               float brightnessNorm,
                               float alphaNorm)
```
    Gets the color value of a color picker control element. Lazily initializes the color picker if needed with the specified defaults.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    hueNorm - default hue in the range [0,1]
    
    saturationNorm - default saturation in the range [0,1]
    
    brightnessNorm - default brightness in the range [0,1]
    
    alphaNorm - default alpha in the range [0,1]
    
    Returns:
    
    current hex and hsba values in a PickerColor object
  - colorPicker
```
public PickerColor colorPicker(java.lang.String path,
                               int hex)
```
    Gets the color value of a color picker control element. Lazily initializes the color picker if needed with the parameter hex value as default color.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    hex - hex color as an integer like 0xFF123456, also works with processing 'color' type
    
    Returns:
    
    hex and hsba values in a PickerColor object
  - colorPickerSet
```
public void colorPickerSet(java.lang.String path,
                           int hex)
```
    Sets the color picker to a given hex value. Lazily initializes the color picker if needed with the parameter hex value as default color. Does not block changing the value in the future in any way.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    hex - hex color to set, also works with processing 'color' type
  - colorPickerHueAdd
```
public void colorPickerHueAdd(java.lang.String path,
                              float hueToAdd)
```
    Adds hue to the color picker, looping it correctly in both directions at the [0,1] boundary. Lazily initializes the color picker if needed with default color 0xFF000000 (full alpha black). Does not block changing the value in the future in any way.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    hueToAdd - hue to add, with the hue value being normalized to the range [0,1]
  - hueModulo
```
public static float hueModulo(float hue)
```
    Hue values loop at the 1 - 0 border both in the positive and negative direction, just like two pi loops back to 0.
    
    Parameters:
    
    hue - value to transfer to the [0-1] range without changing apparent color value
    
    Returns:
    
    hue in the range between 0-1
  - text
```
public java.lang.String text(java.lang.String path)
```
    Gets the current value of a text input element. Lazily initializes the text input element if needed with its content set to an empty string.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    Returns:
    
    current value of a string input element
  - text
```
public java.lang.String text(java.lang.String path,
                             java.lang.String content)
```
    Gets the current value of an editable text field element. Lazily initializes the string input if needed with the specified default.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    content - default value for the text content
    
    Returns:
    
    current value of a string input element
  - textSet
```
public void textSet(java.lang.String path,
                    java.lang.String content)
```
    Sets the current value of an editable text field element. Lazily initializes the text input element if needed and then sets its value to the specified content value. Setting it every frame will result in the text field effectively being read-only.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    content - default value for the text content
  - gradient
```
public processing.core.PGraphics gradient(java.lang.String path)
```
    Gets a gradient as an image with size matching the main processing sketch size. Lazily initializes the gradient picker if needed.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    Returns:
    
    PGraphics after endDraw() - ready to be displayed as an image
  - gradient
```
public processing.core.PGraphics gradient(java.lang.String path,
                                          int defaultHexColor)
```
    Gets a gradient as an image with size matching the main processing sketch size. Lazily initializes the gradient picker if needed and uses the same default color for every color stop.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    defaultHexColor - the same default color for the 4 default color stops
    
    Returns:
    
    PGraphics after endDraw() - ready to be displayed as an image
  - gradient
```
public processing.core.PGraphics gradient(java.lang.String path,
                                          int[] defaultColors)
```
    Gets a gradient as an image with size matching the main processing sketch size. Lazily initializes the gradient picker if needed with the specified colors at some sensible positions.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    defaultColors - default color array for all the colors in the gradient if you're pasting colors in the format of #ef8e38 try replacing # with 0xFF
    
    Returns:
    
    PGraphics ready to be displayed as an image
  - colorPoint
```
public ColorPoint colorPoint(int color,
                             float pos)
```
    Helper function for calling `gui.gradient(String path, ColorPoint... colorPoints)` without having to mention the ColorPoint class.
    
    Parameters:
    
    color - hex color such as 0xFF123456, also works with processing 'color' type
    
    pos - floating point position on the gradient between 0 and 1
    
    Returns:
    
    ColorPoint object with color and position to be used as default values of a gradient
  - gradient
```
public processing.core.PGraphics gradient(java.lang.String path,
                                          ColorPoint... colorPoints)
```
    Gets a gradient as an image with size matching the main processing sketch size. Lazily initializes the gradient picker if needed with the specified color points as the default colors and positions. An instance of ColorPoint can be created either with `new ColorPoint(color(255,0,0), 0.5)` or with gui.colorPoint(color(255, 0, 0), position) So an example of calling this function would be `gui.gradient("path", gui.colorPoint(color(255,0,0), 0), gui.colorPoint(color(0,255,0), 1))`
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    colorPoints - varargs of ColorPoint - the position should be between 0 and 1
    
    Returns:
    
    PGraphics ready to be displayed as an image
  - gradientColorAt
```
public PickerColor gradientColorAt(java.lang.String path,
                                   float position)
```
    Gets a single color from a gradient at the specified position in the range [0, 1]. Lazily initializes the gradient picker if needed with autogenerated grayscale colors. Faster than get(x,y) by keeping a copy of the gradient in a lookup table in memory.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    position - normalized position in the [0, 1] range you'd like to know the color of
    
    Returns:
    
    PickerColor color at the specified position in the gradient
  - hasChanged
```
public boolean hasChanged()
```
    Returns whether the current folder or any of its recursively nested children changed last frame. Only true for exactly one frame after the change. Calling this function does not change the boolean value it returns, only the next draw() call will reset it. Equivalent to passing an empty string parameter to the overloaded hasChanged(String path), i.e. `hasChanged("")`. When called outside any pushFolder() and popFolder() calls, it will return true if anything in the whole gui has changed.
    
    Returns:
    
    true if the control element value has changed this frame, false otherwise
  - hasChanged
```
public boolean hasChanged(java.lang.String path)
```
    Returns whether a control element value, folder or any of its recursively nested children changed last frame. Only true for exactly one frame after the change. Calling this function does not change the boolean value it returns, only the next draw() call will reset it. Prepends the current path stack to the path.
    
    Parameters:
    
    path - forward slash separated unique path to the control element
    
    Returns:
    
    true if the control element value has changed this frame, false otherwise
  - pushFolder
```
public void pushFolder(java.lang.String folderName)
```
    Pushes a folder name to the global path prefix stack. Can be used multiple times in pairs just like pushMatrix() and popMatrix(). Removes leading and trailing slashes to enforce consistency, but allows slashes to appear either escaped or anywhere else inside the string. Any GUI control element call will apply all the folders in the stack as a prefix to their own path parameter. This is useful for not repeating the whole path string every time you want to call a control element.
    
    Parameters:
    
    folderName - one folder's name to push to the stack
    
    See Also:
    
    getFolder()
  - popFolder
```
public void popFolder()
```
    Pops the last pushed folder name from the global path prefix stack. Can be used multiple times in pairs just like pushMatrix() and popMatrix(). Warns once when the stack is empty and popFolder() is attempted. Any GUI control element call will apply all the folders in the stack as a prefix to their own path parameter. This is useful for not repeating the whole path string every time you want to call a control element.
  - clearFolder
```
public void clearFolder()
```
    Clears the global path prefix stack, removing all its elements. Nothing will be prefixed in subsequent calls to control elements. Also happens every time draw() ends and LazyGui.draw() begins, in order for LazyGui to be certain of what the current path is for its own control elements like the options folder and so the library user doesn't have to pop all of their folders, since they get cleared every frame.
  - getFolder
```
public java.lang.String getFolder()
```
    Gets the current path prefix stack, inserting a forward slash after each folder name in the stack. Mostly used internally by LazyGui, but it can also be useful for debugging.
    
    Returns:
    
    entire path prefix stack concatenated to one string
  - hide
```
public void hide(java.lang.String path)
```
    Hide any chosen element or folder except the root window. Hides both the row and any affected opened windows under that node. The GUI then skips it while drawing, but still returns its values and allows interaction from code as if it was still visible. Can be called once in `setup()` or repeatedly every frame, the result is the same. Does not initialize a control and has no effect on controls that have not been initialized yet.
    
    Parameters:
    
    path - path to the control or folder being hidden - it will get prefixed by the current path prefix stack to get the full path
  - hideCurrentFolder
```
public void hideCurrentFolder()
```
    Hides the folder at the current path prefix stack. See hide(String path)
  - show
```
public void show(java.lang.String path)
```
    Makes any control element or folder visible again if it has been hidden by the hide() function. Has no effect on visible elements. Does not reveal any windows except for those that were open and then hidden by the hide() function. Does not initialize a control and has no effect on controls that have not been initialized yet.
    
    Parameters:
    
    path - path to the control element or folder being hidden - it will get prefixed by the current path prefix stack to get the full path
  - showCurrentFolder
```
public void showCurrentFolder()
```
    Shows the folder at the current path prefix stack. See show(String path)
  - createSave
```
public void createSave()
```
    Creates a new, sequentially numbered save file in the gui save folder inside the sketch data folder. Works the same way as clicking the "Create new save" gui button inside the built-in 'saves' window. Respects the current 'custom save name' inside the 'saves' window.
    
    See Also:
    
    createSave(String path), LazyGuiSettings.setOverwriteLastLoadedSave(boolean)
  - createSave
```
public void createSave(java.lang.String path)
```
    Creates a new save file or overwrites an existing one while auto-detecting whether the parameter is a relative or an absolute path to it on disk. Relative paths get saved inside the standard gui save folder and are immediately accessible from the 'saves' window. Absolute paths get saved wherever the absolute path leads. Ignores the custom save name inside the 'saves' window, because the parameter already contains a file name. Uses java.nio.file.Paths.get(fileName).isAbsolute() for its auto-detection.
    
    Parameters:
    
    path - name of the new save file or its entire absolute path, ".json" file type suffix is optional and will be appended if missing
  - loadSave
```
public void loadSave(java.lang.String path)
```
    Loads a save file from disk, overwriting the current values in the running gui whose gui paths match with the saved elements. Accepts both relative and absolute file paths. Attempts to first find the save file inside the standard gui save folder, and if it doesn't find it there then it tries to assume the String parameter is an absolute path and tries to load that.
    
    Parameters:
    
    path - name of the existing save file inside the save folder or its entire absolute path, ".json" file type suffix is optional and will be appended if missing
  - getMainFont
```
public processing.core.PFont getMainFont()
```
    Gets the main font as currently used by the GUI.
    
    Returns:
    
    main gui font
  - getSideFont
```
public processing.core.PFont getSideFont()
```
    Gets the side font as currently used by the GUI.
    
    Returns:
    
    side gui font
  - hideGui
```
public void hideGui()
```
    Hides the GUI completely and skips displaying it. Has no effect if the gui is already hidden. Reveal the gui again with showGui() or pressing 'h'.
  - hideGuiToggle
```
public void hideGuiToggle()
```
    Hides the gui if it was visible. Shows the gui if it was hidden.
  - showGui
```
public void showGui()
```
    Shows the GUI if it was hidden with 'h' or hideGui(). Has no effect if the gui is already visible.
  - getVersion
```
public java.lang.String getVersion()
```
    Returns the current version of the library as a string in the format v{major}.{minor}.{patch} according to semantic versioning. Example: v1.6.0
    
    Returns:
    
    "prettyVersion" value from library.properties

Class LazyGui

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LazyGui

LazyGui

Method Detail

getGuiCanvas

draw

draw

isMouseOutsideGui

isMouseOverGui

slider

slider

slider

sliderSet

sliderAdd

sliderInt

sliderInt

sliderInt

sliderIntSet

plotXY

plotXY

plotXY

plotXY

plotXYZ

plotXYZ

plotXYZ

plotXYZ

plotSet

plotSet

plotSet

plotSet

toggle

toggle

toggleSet

button

radio

radio

radio

radio

radioSet

radioSetOptions

radioSetOptions

colorPicker

colorPicker

colorPicker

colorPicker

colorPicker

colorPickerSet

colorPickerHueAdd

hueModulo

text

text

textSet

gradient

gradient

gradient

colorPoint

gradient

gradientColorAt

hasChanged

hasChanged

pushFolder

popFolder

clearFolder

getFolder

hide

hideCurrentFolder

show

showCurrentFolder

createSave

createSave

loadSave

getMainFont

getSideFont

hideGui

hideGuiToggle

showGui