savio 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8a837ea050d5cd7e54c5b9f8cea93183f254790aba04518affabc2112e69d55d
+  data.tar.gz: ff533e972e728cc937d0f237c097b4d9fb427d1b0d68241a5544be721d2e25d0
+SHA512:
+  metadata.gz: c6f30fe529ceb5f0827cfe1e603cc277ecd4a13b7f40c1105286dfe7313a44d39615ad330e53c3c04e885ad74a004cdb4c768a7e73bd1a1d3265479b75f323ad
+  data.tar.gz: ec3e89e754d3cccd0a7c4b735c4e1ebb636f25f78ff34d5a4bd1bac8b5193dc3be1e445cd9200a7c2cdad0320dd4583074dffbf531c6e07429052bb82b4964a8

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,223 @@
+# | *Sav***IO**
+![Screenshot](https://github.com/TheRealSavi/savio/blob/master/preview.png)
+## 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 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 deafult.
+
+| 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 slider slides | true
+| displayName | The label on top | "Default"
+| 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
+|showValue| If the value 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 |
+
+### Basic Usage:
+
+    if slippyTheSlider.value == 69
+	    puts "nice"
+    end
+
+# | Buttons:
+**On top of** all the basic parameters and methods a **Button** can **also** use these:
+
+### Params:
+| Variable | Description | Default |
+|--|--|--|
+|value | Anything you want to be tied to the button | 0
+|selected | Whether the button is selected or not | false
+|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| The color of the labels| '#F5F5F5'
+|selectedColor|Color of the slider line | '#00B3EC'
+|labelColor| Color of the sliders knob | '#F5F5F5'
+
+### Example:
+
+    buttonBob = Button.new(
+      x: 830, y: 90,
+      displayName: "Enable Bob?",
+      selectedColor: "purple"
+    )
+
+### 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. |
+| .deslect(*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)*
+
+
+### Basic Usage:
+
+    if buttonBob.selected == true
+	    puts "Bob is now enabled! Hi Bob!"
+    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| 'gray'
+|activeColor|The color of the box when focused | 'green'
+
+### 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 |
+
+### 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.rb

@@ -0,0 +1,81 @@
+require "savio/version"
+require 'ruby2d'
+
+module Savio
+  class Error < StandardError; end
+
+  require 'savio/IORenderable.rb'
+  require 'savio/InputBox.rb'
+  require 'savio/Slider.rb'
+  require 'savio/Button.rb'
+  require 'savio/ButtonManager.rb'
+  require 'savio/hsv2rgb.rb'
+  require 'savio/ColorSlider.rb'
+  require 'savio/Scene.rb'
+  require 'savio/io.rb'
+
+  def self.makeBool(value)
+    case value
+      when true, 'true', 1, '1', 't' then true
+      when false, 'false', nil, '', 0, '0', 'f' then false
+    else
+      return "no"
+    end
+  end
+
+  def self.guessType(value)
+    if value.to_i.to_s == value
+      return "int"
+    elsif value.to_f.to_s == value
+      return "float"
+    elsif value == "true" || value == "false"
+      return "bool"
+    else
+      return "str"
+    end
+  end
+
+  def self.listen()
+    @listening = true
+  end
+
+  def self.stop()
+    @listening = false
+  end
+
+  def self.listening
+    return @listening
+  end
+
+
+  @elements = []
+  def self.elements
+    @elements
+  end
+
+  def self.addElement(element)
+    @elements.push(element)
+  end
+
+  def self.removeElement(element)
+    @elements.delete(element)
+  end
+
+
+  def self.hide
+    @elements.each do |e|
+      e.remove
+    end
+  end
+
+  def self.unhide
+    @elements.each do |e|
+      e.add
+    end
+  end
+
+
+end
+
+include Savio
+Savio.listen

data/lib/savio/Button.rb

@@ -0,0 +1,185 @@
+module Savio
+  class Button
+    include IORenderable
+
+    attr_accessor :value, :enforceManager
+    attr_reader :selected, :buttonManager
+
+    @@buttons = []
+    def self.buttons
+      @@buttons
+    end
+
+    def initialize(args = {})
+      super(args)
+
+      @@buttons.push(self)
+
+      @value = args[:value] || 0
+
+      @baseColor = args[:baseColor] || '#F5F5F5'
+      @selectedColor = args[:selectedColor] || '#00B3EC'
+      @labelColor = args[:labelColor] || '#F5F5F5'
+
+      @selected = args[:selected] || false
+
+      @buttonManager = args[:buttonManager] || nil
+
+      @enforceManager = args[:enforceManager] || true
+
+      @type = args[:type] || 'toggle'
+      if @type != 'toggle' && @type != 'clicker'
+        @type = 'toggle'
+      end
+
+      @onClick = Proc.new {}
+
+      build()
+    end
+
+    def type=(newType)
+      if newType == 'toggle' || newType == 'clicker'
+        @type = newType
+      end
+    end
+
+    def baseColor=(c)
+      @baseColor = c
+      rebuild()
+    end
+    def selectedColor=(c)
+      @selectedColor = c
+      rebuild()
+    end
+    def labelColor=(c)
+      @labelColor = c
+      rebuild()
+    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)
+      click()
+      if enforce == true && @buttonManager != nil
+        @buttonManager.select(self)
+      else
+        @selectCircle.add
+        @selected = true
+        if @type == 'clicker'
+          if @type == 'clicker'
+            fade = Thread.new {
+              @selectCircle.add
+              sleep(0.06)
+              @selectCircle.remove
+            }
+          end
+          deselect(enforce)
+        end
+      end
+    end
+
+    def deselect(enforce = @enforceManager)
+      if enforce == true && @buttonManager != nil
+        @buttonManager.deselect(self)
+      else
+        @selectCircle.remove
+        @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
+
+      @nameLabel = Text.new(
+        @displayName.to_s,
+        x: @x + @size * 2, y: @y - @size * 1.5,
+        size: @size * 2,
+        color: @labelColor,
+        z: @z
+      )
+      @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
+      )
+
+      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