From f3011c416073bcb5a919bb26db0c61682157deff Mon Sep 17 00:00:00 2001 From: KrabCode Date: Sun, 1 Sep 2024 12:05:26 +0200 Subject: [PATCH] regen javadoc --- docs/allclasses-frame.html | 5 +- docs/allclasses-noframe.html | 5 +- docs/com/krab/lazy/Input.html | 8 +- docs/com/krab/lazy/KeyState.html | 4 +- docs/com/krab/lazy/LazyGui.html | 187 +++++++++++++++--------- docs/com/krab/lazy/LazyGuiSettings.html | 68 ++++++--- docs/com/krab/lazy/PickerColor.html | 4 +- docs/com/krab/lazy/ShaderReloader.html | 4 +- docs/com/krab/lazy/package-frame.html | 5 +- docs/com/krab/lazy/package-summary.html | 20 ++- docs/com/krab/lazy/package-tree.html | 5 +- docs/constant-values.html | 4 +- docs/deprecated-list.html | 4 +- docs/help-doc.html | 4 +- docs/index-files/index-1.html | 4 +- docs/index-files/index-10.html | 4 +- docs/index-files/index-11.html | 4 +- docs/index-files/index-12.html | 4 +- docs/index-files/index-13.html | 4 +- docs/index-files/index-14.html | 8 +- docs/index-files/index-15.html | 4 +- docs/index-files/index-2.html | 4 +- docs/index-files/index-3.html | 12 +- docs/index-files/index-4.html | 4 +- docs/index-files/index-5.html | 4 +- docs/index-files/index-6.html | 8 +- docs/index-files/index-7.html | 4 +- docs/index-files/index-8.html | 4 +- docs/index-files/index-9.html | 4 +- docs/index.html | 2 +- docs/overview-tree.html | 5 +- 31 files changed, 256 insertions(+), 154 deletions(-) diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html index 023cf08..6b2c573 100644 --- a/docs/allclasses-frame.html +++ b/docs/allclasses-frame.html @@ -2,9 +2,9 @@ - + All Classes - + @@ -12,6 +12,7 @@

All Classes

+ + + +
    +
  • +

    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 - must have at least two elements - the position is expected to be between 0 and 1
    +
    Returns:
    +
    PGraphics ready to be displayed as an image
    +
    +
    • +
@@ -1682,7 +1735,7 @@

gradientColorAt

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 1D lookup table in memory.
+ 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
diff --git a/docs/com/krab/lazy/LazyGuiSettings.html b/docs/com/krab/lazy/LazyGuiSettings.html index 29b21de..85194fb 100644 --- a/docs/com/krab/lazy/LazyGuiSettings.html +++ b/docs/com/krab/lazy/LazyGuiSettings.html @@ -2,9 +2,9 @@ - + LazyGuiSettings - + @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -194,97 +194,103 @@

Method Summary

LazyGuiSettings +setDefaultGradientBlendType(java.lang.String defaultGradientBlendType) +
Set the default gradient blend type for all gradient control elements.
+ + + +LazyGuiSettings setHideBuiltInFolders(boolean shouldHideFolders)
Should the built-in folders start hidden? That is the automatically created gui folders like "options" and "saves".
- + LazyGuiSettings setHideRadioValue(boolean hideRadioValue)
Hide the selected value text on the right of the radio row and replace it with a generic folder icon.
- + LazyGuiSettings setHotkeyMouseWheelActive(boolean shouldMouseChangePrecision)
The mouse wheel changes a slider's precision when hovering over it.
- + LazyGuiSettings setKeyboardDelay(int millisDelayToSet)
Set the delay in milliseconds for the keyboard buffer to be considered a new input.
- + LazyGuiSettings setLoadLatestSaveOnStartup(boolean loadLatestSaveOnStartup)
When this is set to false it disables the default attempt to load the latest save.
- + LazyGuiSettings setLoadSpecificSaveOnStartup(java.lang.String fileName)
Loads a specific save file on startup, tries to look inside the save folder for the file first before assuming the user gave the absolute path.
- + LazyGuiSettings setLoadSpecificSaveOnStartupOnce(java.lang.String fileName)
Loads a specific save file on startup if the gui finds its save folder empty.
- + LazyGuiSettings setMainFontSize(int mainFontSize)
This sets the main font size used everywhere by the gui.
- + LazyGuiSettings setMouseConfineToWindow(boolean mouseShouldConfineToWindow)
Should the mouse be locked inside the sketch window? You can still exit the sketch with ESC.
- + LazyGuiSettings setMouseHideWhenDragging(boolean mouseShouldHideWhenDragging)
Should the mouse be hidden when dragging a slider or a plot? Hiding the mouse can give the user a more immersive feeling, but it can also be disorienting.
- + LazyGuiSettings setShowSquigglyEqualsInsideSliders(boolean showSquigglyEquals)
Show the approximately equals double tilde '≈' in sliders when visually shown values are not exactly equal to the actual float values used by the program.
- + LazyGuiSettings setSideFontSize(int sideFontSize)
This sets the usually smaller side font size used in a few places by the gui.
- + LazyGuiSettings setSketchNameOverride(java.lang.String sketchNameOverride)
Overrides what the root window title displays.
- + LazyGuiSettings setSmooth(int smoothValue)
Override the default antialiasing level of `smooth(4)` for the GUI canvas.
- + LazyGuiSettings setStartGuiHidden(boolean shouldHideGui)
Should the gui start hidden? Toggle hiding with the 'H' hotkey.
- + LazyGuiSettings setThemeCustom(int windowBorderColor, int normalBackgroundColor, @@ -294,25 +300,25 @@

Method Summary

Sets a custom theme defined by individual hex colors.
- + LazyGuiSettings setThemePreset(java.lang.String themePreset)
Sets one theme from the preset options on startup.
- + LazyGuiSettings setWindowRestoreAlways()
The GUI will always load window positions, sizes and openness on startup and then always try to overwrite them when loading other saves.
- + LazyGuiSettings setWindowRestoreNever()
The GUI will never load window positions, sizes and openness.
- + LazyGuiSettings setWindowRestoreOnlyOnStartup()
The GUI will load window positions, sizes and openness on startup and then ignore any saved window states when loading other saves.
@@ -826,7 +832,7 @@

setWindowRestoreAlways

-
    +

    • setWindowRestoreNever

      public LazyGuiSettings setWindowRestoreNever()
      @@ -837,6 +843,22 @@

      setWindowRestoreNever

+ + + +
    +
  • +

    setDefaultGradientBlendType

    +
    public LazyGuiSettings setDefaultGradientBlendType(java.lang.String defaultGradientBlendType)
    +
    Set the default gradient blend type for all gradient control elements.
    +
    +
    Parameters:
    +
    defaultGradientBlendType - one of the allowed strings in the gradient "blend" radio options - "mix", "hsv", "oklab"
    +
    Returns:
    +
    this settings object for chaining statements easily
    +
    +
    • +
diff --git a/docs/com/krab/lazy/PickerColor.html b/docs/com/krab/lazy/PickerColor.html index 3ab1dcf..1ee13e8 100644 --- a/docs/com/krab/lazy/PickerColor.html +++ b/docs/com/krab/lazy/PickerColor.html @@ -2,9 +2,9 @@ - + PickerColor - + diff --git a/docs/com/krab/lazy/ShaderReloader.html b/docs/com/krab/lazy/ShaderReloader.html index 35eeb5a..4777b89 100644 --- a/docs/com/krab/lazy/ShaderReloader.html +++ b/docs/com/krab/lazy/ShaderReloader.html @@ -2,9 +2,9 @@ - + ShaderReloader - + diff --git a/docs/com/krab/lazy/package-frame.html b/docs/com/krab/lazy/package-frame.html index f4c9c99..80a5d99 100644 --- a/docs/com/krab/lazy/package-frame.html +++ b/docs/com/krab/lazy/package-frame.html @@ -2,9 +2,9 @@ - + com.krab.lazy - + @@ -13,6 +13,7 @@

Classes

    +
  • ColorPoint
  • Input
  • KeyState
  • LazyGui
    • diff --git a/docs/com/krab/lazy/package-summary.html b/docs/com/krab/lazy/package-summary.html index be87110..c0742dc 100644 --- a/docs/com/krab/lazy/package-summary.html +++ b/docs/com/krab/lazy/package-summary.html @@ -2,9 +2,9 @@ - + com.krab.lazy - + @@ -81,36 +81,42 @@

    Package com.krab.lazy

    +ColorPoint + +
    Used for initializing a gradient with a set of default colors at default positions.
    + + + Input
    Static wrapper for a utility class that keeps track of all currently pressed keys to simplify the code for complex keyboard interaction, because Processing doesn't offer that.
    - + KeyState
    Data transfer object for representing a keyboard button state.
    - + LazyGui
    Main class for controlling the GUI from a processing sketch.
    - + LazyGuiSettings
    Settings to apply once inside the main LazyGui constructor on startup before loading any saves that might overwrite them.
    - + PickerColor
    Data transfer object for ColorPicker value.
    - + ShaderReloader
    Utility class for live-coding shaders diff --git a/docs/com/krab/lazy/package-tree.html b/docs/com/krab/lazy/package-tree.html index e1be2bc..cd21787 100644 --- a/docs/com/krab/lazy/package-tree.html +++ b/docs/com/krab/lazy/package-tree.html @@ -2,9 +2,9 @@ - + com.krab.lazy Class Hierarchy - + @@ -75,6 +75,7 @@

    Class Hierarchy

    • java.lang.Object
        +
      • com.krab.lazy.ColorPoint
      • com.krab.lazy.Input
      • com.krab.lazy.KeyState
      • com.krab.lazy.LazyGui
        • diff --git a/docs/constant-values.html b/docs/constant-values.html index 693fee5..cf1b530 100644 --- a/docs/constant-values.html +++ b/docs/constant-values.html @@ -2,9 +2,9 @@ - + Constant Field Values - + diff --git a/docs/deprecated-list.html b/docs/deprecated-list.html index 041a2ae..69417e1 100644 --- a/docs/deprecated-list.html +++ b/docs/deprecated-list.html @@ -2,9 +2,9 @@ - + Deprecated List - + diff --git a/docs/help-doc.html b/docs/help-doc.html index cf36b01..8afd60d 100644 --- a/docs/help-doc.html +++ b/docs/help-doc.html @@ -2,9 +2,9 @@ - + API Help - + diff --git a/docs/index-files/index-1.html b/docs/index-files/index-1.html index e38b641..8d2dc6c 100644 --- a/docs/index-files/index-1.html +++ b/docs/index-files/index-1.html @@ -2,9 +2,9 @@ - + A-Index - + diff --git a/docs/index-files/index-10.html b/docs/index-files/index-10.html index 4612a5f..af1999e 100644 --- a/docs/index-files/index-10.html +++ b/docs/index-files/index-10.html @@ -2,9 +2,9 @@ - + L-Index - + diff --git a/docs/index-files/index-11.html b/docs/index-files/index-11.html index 5b6f58e..1f2c472 100644 --- a/docs/index-files/index-11.html +++ b/docs/index-files/index-11.html @@ -2,9 +2,9 @@ - + M-Index - + diff --git a/docs/index-files/index-12.html b/docs/index-files/index-12.html index 47fae03..4bd8e55 100644 --- a/docs/index-files/index-12.html +++ b/docs/index-files/index-12.html @@ -2,9 +2,9 @@ - + P-Index - + diff --git a/docs/index-files/index-13.html b/docs/index-files/index-13.html index 058241e..e4af294 100644 --- a/docs/index-files/index-13.html +++ b/docs/index-files/index-13.html @@ -2,9 +2,9 @@ - + R-Index - + diff --git a/docs/index-files/index-14.html b/docs/index-files/index-14.html index 7d62458..614b0d5 100644 --- a/docs/index-files/index-14.html +++ b/docs/index-files/index-14.html @@ -2,9 +2,9 @@ - + S-Index - + @@ -104,6 +104,10 @@

        S

        Set a custom data folder for the gui to use for json saves and png screenshots.
        +
        setDefaultGradientBlendType(String) - Method in class com.krab.lazy.LazyGuiSettings
        +
        +
        Set the default gradient blend type for all gradient control elements.
        +
        setHideBuiltInFolders(boolean) - Method in class com.krab.lazy.LazyGuiSettings
        Should the built-in folders start hidden? diff --git a/docs/index-files/index-15.html b/docs/index-files/index-15.html index 8304145..f572169 100644 --- a/docs/index-files/index-15.html +++ b/docs/index-files/index-15.html @@ -2,9 +2,9 @@ - + T-Index - + diff --git a/docs/index-files/index-2.html b/docs/index-files/index-2.html index f256420..b16b482 100644 --- a/docs/index-files/index-2.html +++ b/docs/index-files/index-2.html @@ -2,9 +2,9 @@ - + B-Index - + diff --git a/docs/index-files/index-3.html b/docs/index-files/index-3.html index 223ec4e..b268dcc 100644 --- a/docs/index-files/index-3.html +++ b/docs/index-files/index-3.html @@ -2,9 +2,9 @@ - + C-Index - + @@ -104,6 +104,14 @@

        C

        Sets the color picker to a given hex value.
        +
        ColorPoint - Class in com.krab.lazy
        +
        +
        Used for initializing a gradient with a set of default colors at default positions.
        +
        +
        colorPoint(int, float) - Method in class com.krab.lazy.LazyGui
        +
        +
        Helper function for calling `gui.gradient(String path, ColorPoint...
        +
        com.krab.lazy - package com.krab.lazy
         
        createSave() - Method in class com.krab.lazy.LazyGui
        diff --git a/docs/index-files/index-4.html b/docs/index-files/index-4.html index 6db4775..9517f0e 100644 --- a/docs/index-files/index-4.html +++ b/docs/index-files/index-4.html @@ -2,9 +2,9 @@ - + D-Index - + diff --git a/docs/index-files/index-5.html b/docs/index-files/index-5.html index 4eab367..c758303 100644 --- a/docs/index-files/index-5.html +++ b/docs/index-files/index-5.html @@ -2,9 +2,9 @@ - + F-Index - + diff --git a/docs/index-files/index-6.html b/docs/index-files/index-6.html index 5b74da0..0d05e85 100644 --- a/docs/index-files/index-6.html +++ b/docs/index-files/index-6.html @@ -2,9 +2,9 @@ - + G-Index - + @@ -128,6 +128,10 @@

        G

        Gets a gradient as an image with size matching the main processing sketch size.
        +
        gradient(String, ColorPoint...) - Method in class com.krab.lazy.LazyGui
        +
        +
        Gets a gradient as an image with size matching the main processing sketch size.
        +
        gradientColorAt(String, float) - Method in class com.krab.lazy.LazyGui
        Gets a single color from a gradient at the specified position in the range [0, 1].
        diff --git a/docs/index-files/index-7.html b/docs/index-files/index-7.html index 6fa1438..7ffabe5 100644 --- a/docs/index-files/index-7.html +++ b/docs/index-files/index-7.html @@ -2,9 +2,9 @@ - + H-Index - + diff --git a/docs/index-files/index-8.html b/docs/index-files/index-8.html index fde3ca0..c8847d3 100644 --- a/docs/index-files/index-8.html +++ b/docs/index-files/index-8.html @@ -2,9 +2,9 @@ - + I-Index - + diff --git a/docs/index-files/index-9.html b/docs/index-files/index-9.html index 1b4bb0b..13131e5 100644 --- a/docs/index-files/index-9.html +++ b/docs/index-files/index-9.html @@ -2,9 +2,9 @@ - + K-Index - + diff --git a/docs/index.html b/docs/index.html index eaf0a57..2e74f8a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2,7 +2,7 @@ - + Generated Documentation (Untitled) @@ -79,6 +79,7 @@

        Class Hierarchy