savio 0.1.5 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a8f5301cac1dd32ee16091ccc8591adb75ffaa16914a432ff98a930977dc3ed
-  data.tar.gz: 20c6ef7442e96b9f3d05180240fbf98391281b4304238754c4c3b7be248726ad
+  metadata.gz: 9975ed5556bca2236e60870fe41481ccb6067da3817721d3acfc8bbe337f8dfe
+  data.tar.gz: 6a15f45c3c8bba686a1f70d604b532f037007635842985ebf01ade3b96999ca3
 SHA512:
-  metadata.gz: 8ee92641fa82e6ce0c73609e8367ae10df5968f5adf6a3313103201fadf665db4f4324cdbcff0f2f336e9e7b7f40b0ca0f143a5c5584ec469c20631980616a49
-  data.tar.gz: 0e95bd3a5840fd132b65e06d9df92d75fca22c1432e3f6177b9380546e5fc7a60677ad774ad487e28957c955feb7066a90ce3a0e9e8ed2ec137ce4ed14694d4c
+  metadata.gz: 312d42bc7d9c08dac70b0e60ef7da172ca909acbf00b5a5dc9865702dff19be46823a7360b7ce731a83b46a0e8bdc2bdc18e69788ec319757f481748f7c1d458
+  data.tar.gz: ebcda30b1685410d07c59f06cc71c6116007b198c5f8b86a2e3ffbf78c1e57dcc60faa58c633969a76e9a37916748cacbaefd35cb6d0bf49df6d36d5d244cb6c

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in savio.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 TheRealSavi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,261 @@
+# | *Sav***IO**
+[![Gem Version](https://badge.fury.io/rb/savio.svg)](https://badge.fury.io/rb/savio)
+## What is it?
+
+SavIO is an input/output library created to be used with **Ruby2D**. It adds multiple ways for the user to interact with your application, including :
+
+ - Sliders
+ - Buttons
+ - Text Input
+ - Color Picker (Work In Progress)
+
+## How to install?
+
+Easy! do:
+
+    gem install savio
+
+then in your program do:
+
+    require "savio"
+
+## How do they work?
+
+
+ Good question! Part of the goal when developing SavIO was to make it as **intuitive** and **simple** as possible, while also being highly **versatile**, **powerful**, and **customizable**.
+
+# | ALL OBJECTS
+#### All SavIO objects inherit these basic properties.
+
+#### You can access an array of all SavIO Objects by using Savio.elements
+##### Example:
+
+    Savio.elements.each do |element|
+	    element.x += 1 #Moves all elements over by 1 pixel
+    end
+
+##### SavIO Commands:
+    Savio.hide         #This will hide all elements
+    Savio.unhide       #This will bring them all back
+    Savio.stop         #This stops the mouse and keyboard event listeners
+    Savio.listen       #Starts the mouse and keyboard event listeners
+    Savio.listening    #returns true or false if its listening or not
+
+
+## **Creation:**
+
+    myAwesomeOBJECT = OBJECTNAME.new(params)
+
+### Params:
+
+all SavIO object's parameters are optional, if it is not defined then it will use the default.
+
+| Variable | Description | Default |
+|--|--|--|
+| x | The x position | 0
+| y | The y Position | 0
+| z | The z Position | 1
+| size | The scaling value | 10
+| enabled | If the object can be interacted with by the user | true
+| displayName | The name of the object | ""
+| draggingEnabled | If the object itself can be moved around the window | false
+| dragType | "move" or "duplicate" If draggingEnabled is true, this is what happens when it drags | "move"
+| shown | If the object is shown or not | true
+
+### Example:
+
+`myAwesomeOBJECT = OBJECTNAME.new(x: 100, y: 30, z:2, size: 13, displayName: "Swag")`
+
+
+### Methods:
+----
+| Method | Description |
+|--|--|
+|.remove() | removes the object from the screen |
+| .add() | adds the object back to the screen |
+|.rebuild() | rebuilds the object |
+|.context() | returns a hash with all the variables that make the object |
+
+# | Sliders:
+**On top of** all the basic parameters and methods a **Slider** can **also** use these:
+
+### Params:
+| Variable | Description | Default |
+|--|--|--|
+|length | How long the slider is | 100
+|min | The minimum value of the slider | 0
+|max | The maximum value of the slider | 100
+|value| The value of the slider | Random between min and max
+|style|'knob' or 'fill' changes the style the slider is shown with|'knob' |
+|showValue| If the value label should be shown| true
+|labelColor| The color of the labels| '#F5F5F5'
+|sliderColor| Color of the slider line | '#757575'
+|knobColor| Color of the sliders knob | '#5BB36A'
+
+### Example:
+
+    slippyTheSlider = Slider.new(x: 830, y: 40, length: 220, draggingEnabled: true, dragType: "duplicate")
+
+### Methods:
+----
+| Method | Description |
+|--|--|
+|.moveKnob(**x**) | Moves the knob to that **x** pixel location on the screen and finds and sets equivalent value for the slider |
+|.setValue(**value**)|Sets the sliders value to that value and moves the knob there (same as .value=)|
+| .value = **value** | Sets the sliders value to that **value** and moves the knob there (same as .setValue)|
+|.onChange| Calls the given proc any time the sliders **value** is updated(see basic usage)|
+
+### Basic Usage:
+
+    if slippyTheSlider.value == 69
+	    puts "nice"
+    end
+
+-----
+
+    slippyTheSlider.onChange do
+      puts "Value Changed! new value is: " + slippyTheSlider.value.to_s
+    end
+
+# | Buttons:
+**On top of** all the basic parameters and methods a **Button** can **also** use these:
+
+### Params:
+| Variable | Description | Default |
+|--|--|--|
+|selected | Whether the button is selected or not | false
+|type | Whether the button will act normally('toggle') or instantly deselect itself('clicker') | 'toggle'
+|style|'box' or 'badge'. Determines the style the button should be rendered with| 'badge'
+|length|Only used for the 'box' style. Determines the length of the button| @size * 10
+|height|Only used for the 'box' style. Determines the height of the button| @size * 1.2
+|cooldownTime|Time needed to wait in seconds until the button may be clicked again| 0.0
+|buttonManager | The manager that controls this button | nil
+|enforceManager| When a manager is defined, whether the manager should force this button to follow its rule | true
+|baseColor| Color shown when the button is deselected| '#F5F5F5'
+|selectedColor|Color shown when the button is selected | '#00B3EC'
+|labelColor| Color of the buttons displayName label | '#F5F5F5'
+
+### Example:
+
+    clickyBob = Button.new(
+      x: 830, y: 90,
+      displayName: "Enable Bob?",
+      selectedColor: "purple",
+      type : 'clicker'
+    )
+-----
+    anotherButton = Button.new(
+      x: 830, y: 150,
+      displayName: "Enable flux capacitors?",
+    )
+
+
+### Methods:
+----
+| Method | Description |
+|--|--|
+|.select(*enforce*) | Selects the button. if left empty *enforce* will be the buttons **@enforceManager** state. when true the manager will enforce its rule on the button. when false, the button will perform as if it were not controlled. |
+|.deselect(*enforce*) | Deselects the button. *enforce* works the same as .select() *(see above)* |
+|.toggle(*enforce*) | Toggles the buttons Selection state. *enforce* works the same as .select() *(see above)*
+|.selected = **bool** | Selects or deselects the button whether given true or false |
+|.timeLastClicked| returns the unix time of the last click
+| .onClick | Takes in a proc that will be ran every time the button gets selected (See example and basic usage)|
+
+### Basic Usage:
+
+    clickyBob.onClick do
+	    puts "Bob is now enabled! Hi Bob!"
+    end
+-----
+    if anotherButton.selected == true do
+      puts "Flux capacitors now enabled"
+    end
+
+# | ButtonManager:
+Now I'm sure after reading how a **button** works you're saying, "What in the hell is a **manager**?"
+
+## Let me explain, it's **very simple**.
+A **ButtonManager** is a simple and easy way to **manage a group of multiple buttons**.  More specifically, it **controls** the state of **all the buttons** in its group **depending on** the state of **all the other buttons** in its group.
+
+## This is not considered a standard SavIO Object and does not inherit the typical parameters and methods.
+
+### Creation:
+
+    theSwagMaster = ButtonManager.new(type: "checkbox")
+
+
+### Params:
+| Param |Description  | Default|
+|--|--|--|
+| type | either "radio" or "checkbox" Decides how the manager should control its buttons | "radio"
+
+### Methods:
+----
+| Method | Description |
+|--|--|
+|.addButton(**button**) | Adds the **button** to the group of buttons controlled by the manager. This is done automatically when a buttons **@buttonManager** is set to the manager. If called this way however, it will also automatically set the buttons **@buttonManager** to this manager, so they will always be linked.|
+|.removeButton(**button**, *overwrite*) | Removes the **button** from the group of buttons controlled by the manager. This is done automatically when a buttons **@buttonManager** is changed or removed. *overwrite* is not required and is automatically set to true. When true, this will overwrite the **button**'s **@buttonManager** and set it to nil. When false it will not overwrite the buttons **@buttonManager**. **It is highly recommended not to change this since** it will desynchronize the button and manager and cause issues. It is used internally to prevent recursion when removed the manager from the **button** rather than from the **manager**
+|.toggle(**button**) | Toggles the **button** according to the rule of the manager. This is done automatically by the **button** when **button**.toggle() is called and this manager is used. This is true also for .select() and .deselect().
+| .select(**button**) | Selects the **button** according to the rule of the manager.
+| .deselect(**button**) | Deselects the **button** according to the rule of the manager |
+
+### Variables :
+|Variable|Description  | Type |
+|--|--|--|
+| buttons |an array of all the buttons that are controlled by this manager  |array |
+| selected | an array of all the buttons that are currently selected and in control of this manager | array |
+
+
+### Basic Usage:
+
+    theSwagMaster.selected.each do |button|
+	    puts button.to_s + " Is currently selected!"
+    end
+--
+
+    if theSwagMaster.selected.include?(button)
+	    puts "This button is currently selected!"
+    end
+
+# | InputBox:
+**On top of** all the basic parameters and methods an **InputBox** can **also** use these:
+### Params:
+| Variable | Description | Default |
+|--|--|--|
+|selected | Whether it is currently focused | false
+|value | The current text input in the field | **@displayName**
+|displayName | The value shown in the text field when nothing is in it. AKA the default value. if a value was specified, this will be overwritten with it. | **@value** or "Default"
+|length| The length of the text box | **@size** * 10
+|width| The width of the text box| **@size** * 1.2
+|color| The color of the box when not focused| '#F5F5F5'
+|activeColor|The color of the box when focused | '#5BB36A'
+|activeTextColor| The color of the text when focused | '#F5F5F5'
+|inactiveTextColor| The color of the text when not focused | '#757575'
+
+### Example:
+
+    askMeAnything = InputBox.new(
+      x: 830, y: 180, size: 30,
+      activeColor: 'purple',
+      displayName: "What would you like to ask?"
+    )
+
+### Methods:
+----
+| Method | Description |
+|--|--|
+|.addKey(**key**) | Simulates a key input of given **key** |
+| .updateDisplay() | Adds the line follower marker to the text box |
+|.select() | Focuses the text box and lets you type in it |
+|.deselect() | Loses focus of the text box and finalizes value|
+|.toggle() | Toggles the selection value of the text box |
+|.selected=(**bool**) | Selects or deselects the text box based on the **bool**  |
+
+### Basic Usage:
+
+    if askMeAnything.value == "Favorite Color?"
+	    puts "Purple"
+    end
+
+# | ColorSlider:
+These technically work but I'm not done with them so for now I wont bother with documentation.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "savio"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/savio/Button.rb

@@ -0,0 +1,253 @@
+module Savio
+  class Button
+    include IORenderable
+
+    attr_accessor :value, :enforceManager
+    attr_reader :selected, :buttonManager, :style, :length, :height, :type, :timeLastClicked, :cooldownTime
+
+    @@buttons = []
+    def self.buttons
+      @@buttons
+    end
+
+    def initialize(args = {})
+      super(args)
+
+      @@buttons.push(self)
+
+      @baseColor = args[:baseColor] || Savio::Colors::White
+      @selectedColor = args[:selectedColor] || Savio::Colors::Blue
+      @labelActiveColor = args[:labelActiveColor] || Savio::Colors::White
+      @labelInactiveColor = args[:labelInactiveColor] || Savio::Colors::White
+
+      @cooldownTime = args[:cooldownTime] || 0.0
+      @timeLastClicked = 0.0
+
+      @selected = args[:selected] || false
+
+      @buttonManager = args[:buttonManager] || nil
+      @enforceManager = args[:enforceManager] || true
+
+      @type = args[:type] || 'toggle'
+      if @type != 'toggle' && @type != 'clicker'
+        @type = 'toggle'
+      end
+
+      @style = args[:style] || 'badge'
+      if @style != 'box' && @style != 'badge'
+        @style = 'badge'
+      end
+
+      if @style == 'box'
+        @size *= 2
+        @labelActiveColor = args[:labelActiveColor] || Savio::Colors::White
+        @labelInactiveColor = args[:labelInactiveColor] || Savio::Colors::Gray
+      end
+
+      @length = args[:length] || @size * 10
+      @height = args[:height] || @size * 2
+
+      @onClick = Proc.new {}
+
+      build()
+    end
+
+    def size=(size)
+      @length = size * 10
+      @height = size * 2
+      super(size)
+    end
+    def type=(newType)
+      if newType == 'toggle' || newType == 'clicker'
+        @type = newType
+      end
+    end
+    def style=(style)
+      if style == 'box' || style == 'badge'
+        @style = style
+        rebuild()
+      end
+    end
+
+    def cooldownTime=(cooldown)
+      @cooldownTime = cooldown.to_f
+    end
+
+    def baseColor=(c)
+      @baseColor = c
+      rebuild()
+    end
+    def selectedColor=(c)
+      @selectedColor = c
+      rebuild()
+    end
+    def labelColor=(c)
+      @labelColor = c
+      rebuild()
+    end
+
+    def selected=(bool)
+      if bool == true
+        select()
+      elsif bool == false
+        deselect()
+      end
+    end
+
+    def onClick(&proc)
+      @onClick = proc
+    end
+
+    def buttonManager=(newManager)
+      if @buttonManager != nil
+        if newManager.class.name != 'Savio::ButtonManager'
+          raise ArgumentError, 'Given object ' + newManager.to_s + ' is not a ButtonManager. Must be of type ButtonManager'
+        end
+        @buttonManager.removeButton(self, false)
+      end
+
+      if newManager != nil
+        @buttonManager = newManager
+        if @buttonManager.buttons.include?(self) != true
+          @buttonManager.addButton(self)
+        end
+      else
+        @buttonManager = nil
+      end
+    end
+
+    def select(enforce = @enforceManager)
+      if Time.now.to_f - @timeLastClicked.to_f >= @cooldownTime.to_f
+        @timeLastClicked = Time.now.to_f
+        click()
+        if enforce == true && @buttonManager != nil
+          @buttonManager.select(self)
+        else
+          @selectCircle.add
+          @nameLabel.color = @labelActiveColor
+          @selected = true
+          if @type == 'clicker'
+            fade = Thread.new {
+              @selectCircle.add
+              @nameLabel.color = @labelActiveColor
+              sleep(0.06)
+              @selectCircle.remove
+              @nameLabel.color = @labelInactiveColor
+            }
+            deselect(enforce)
+          end
+        end
+      end
+    end
+
+    def deselect(enforce = @enforceManager)
+      if enforce == true && @buttonManager != nil
+        @buttonManager.deselect(self)
+      else
+        @selectCircle.remove
+        @nameLabel.color = @labelInactiveColor
+        @selected = false
+      end
+    end
+
+    def toggle(enforce = @enforceManager)
+      if @selected
+        deselect(enforce)
+      else
+        select(enforce)
+      end
+    end
+
+    def remove()
+      super()
+      @nameLabel.remove
+      @baseCircle.remove
+      @selectCircle.remove
+    end
+
+    def add()
+      super()
+      @nameLabel.add
+      @baseCircle.add
+      @selectCircle.add
+      if @selected
+        select()
+      else
+        deselect()
+      end
+    end
+
+    def click()
+      @onClick.call()
+    end
+
+    def build()
+      @shown = true
+      case @style
+      when 'badge'
+        @baseCircle = Circle.new(
+          x: @x, y: @y,
+          radius: @size,
+          color: @baseColor,
+          z: @z
+        )
+        @selectCircle = Circle.new(
+          x: @x, y: @y,
+          radius: @size * 0.8,
+          color: @selectedColor,
+          z: @z+1
+        )
+        @nameLabel = Text.new(
+          @displayName.to_s,
+          x: @x + @size * 2, y: @y - @size * 1.5,
+          size: @size * 2,
+          color: @labelInactiveColor,
+          z: @z
+        )
+        @nameLabel.y = @baseCircle.y - @baseCircle.radius / 4 - @nameLabel.height / 2
+      when 'box'
+        @baseCircle = Rectangle.new(
+          x: @x, y: @y,
+          height: @height, width: @length,
+          color: @baseColor,
+          z: @z
+        )
+        @selectCircle = Rectangle.new(
+          x: @x + (@height * 0.1), y: @y + (@height * 0.1),
+          height: @height - (@height * 0.2), width: @length - (@height * 0.2),
+          color: @selectedColor,
+          z: @z+1
+        )
+        @nameLabel = Text.new(
+          @displayName.to_s,
+          x: @x, y: @y,
+          size: @size,
+          color: @labelInactiveColor,
+          z: @z+2
+        )
+        @nameLabel.x = @baseCircle.x + @baseCircle.width / 2 - @nameLabel.width / 2
+        @nameLabel.y = @baseCircle.y + @baseCircle.height / 2 - @nameLabel.height / 2
+      end
+
+      if @buttonManager == nil
+        if @selected
+          select()
+        else
+          deselect()
+        end
+      else
+        if @buttonManager.class.name != 'Savio::ButtonManager'
+          raise ArgumentError, 'Given object ' + @buttonManager.to_s + ' is not a ButtonManager. Must be of type ButtonManager'
+        end
+        @buttonManager.addButton(self)
+
+        if @selected
+          @buttonManager.select(self)
+        else
+          @buttonManager.deselect(self)
+        end
+      end
+
+    end
+  end
+end