savio 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94f357a3819daf51a638f59c3467b55e80f0076c51e69bc106aac402a752650f
-  data.tar.gz: b00b804986834a8ac252ba9c90814b550c0c5361f2f4cee1aeb7936ebbe3ef94
+  metadata.gz: 3b9718ed09ba01941d92b7d59dabf07b88e4fe6d44c39f8d3d10e06b8467c7ca
+  data.tar.gz: f86e29857ba48e2b9108058674517106b74acd5bcdb55438ad50e71ade537ace
 SHA512:
-  metadata.gz: 327c6bdce586b41a05bfdf539a5baf2d9cb9b76d7911f9cb7f8116546917f3866343446440775c28939ff0c02c35acbad04082b0ebaebf7af0f113770232b054
-  data.tar.gz: a638f761b674dd600aa510abfba0beac19ab6f6a56efd3f3d586cf817a9e4bc5dc0bcefe6e8aa8730b707413a11fee7a70fa306c64fd8016946d94db3ad376fb
+  metadata.gz: acc7c66f028e73ab48b15367a933c0fc10c6d41839ea495646578281ba659e4146e10fb74159aad703a2955511b37ed2009a69dcfef274cbf9c4d70d0558179a
+  data.tar.gz: 65c9e78ac89080304c0315ffe36699658aa43321a12ef8847a6a697db9dc86ba2d8ad4c93ee40b27e103458174aef880e86a17d10999f3d23095403db4d17935

data/README.md

@@ -1,4 +1,5 @@
 # | *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 :
@@ -47,7 +48,7 @@ then in your program do:
 
 ### Params:
 
-all SavIO object's parameters are optional, if it is not defined then it will use the deafult.
+all SavIO object's parameters are optional, if it is not defined then it will use the default.
 
 | Variable | Description | Default |
 |--|--|--|
@@ -55,8 +56,8 @@ all SavIO object's parameters are optional, if it is not defined then it will us
 | 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"
+| enabled | If the object can be interacted with by the user | true
+| displayName | The name of the object | "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
@@ -85,9 +86,9 @@ all SavIO object's parameters are optional, if it is not defined then it will us
 |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
+|showValue| If the value label should be shown| true
 |labelColor| The color of the labels| '#F5F5F5'
-|sliderColor|Color of the slider line | '#757575'
+|sliderColor| Color of the slider line | '#757575'
 |knobColor| Color of the sliders knob | '#5BB36A'
 
 ### Example:
@@ -99,7 +100,8 @@ all SavIO object's parameters are optional, if it is not defined then it will us
 | 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 |
+|.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)|
 
 ### Basic Usage:
 
@@ -115,34 +117,52 @@ all SavIO object's parameters are optional, if it is not defined then it will us
 |--|--|--|
 |value | Anything you want to be tied to the button | 0
 |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| The color of the labels| '#F5F5F5'
-|selectedColor|Color of the slider line | '#00B3EC'
-|labelColor| Color of the sliders knob | '#F5F5F5'
+|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:
 
-    buttonBob = Button.new(
+    clickyBob = Button.new(
       x: 830, y: 90,
       displayName: "Enable Bob?",
-      selectedColor: "purple"
+      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. |
-| .deslect(*enforce*) | Deselects the button. *enforce* works the same as .select() *(see above)* |
+|.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:
 
-    if buttonBob.selected == true
+    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**?"
@@ -220,6 +240,7 @@ A **ButtonManager** is a simple and easy way to **manage a group of multiple but
 |.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:
 

data/lib/savio/Button.rb

@@ -3,7 +3,7 @@ module Savio
     include IORenderable
 
     attr_accessor :value, :enforceManager
-    attr_reader :selected, :buttonManager
+    attr_reader :selected, :buttonManager, :style, :length, :height, :type, :timeLastClicked, :cooldownTime
 
     @@buttons = []
     def self.buttons
@@ -21,10 +21,12 @@ module Savio
       @selectedColor = args[:selectedColor] || '#00B3EC'
       @labelColor = args[:labelColor] || '#F5F5F5'
 
+      @cooldownTime = args[:cooldownTime] || 0.0
+      @timeLastClicked = 0.0
+
       @selected = args[:selected] || false
 
       @buttonManager = args[:buttonManager] || nil
-
       @enforceManager = args[:enforceManager] || true
 
       @type = args[:type] || 'toggle'
@@ -32,16 +34,43 @@ module Savio
         @type = 'toggle'
       end
 
+      @style = args[:style] || 'badge'
+      if @style != 'box' && @style != 'badge'
+        @style = 'badge'
+      end
+
+      if @style == 'box'
+        @size *= 2
+        @labelColor = args[:baseColor] || '#01042A'
+      end
+      @length = args[:length] || @size * 10
+      @height = args[:height] || @size * 1.2
+
       @onClick = Proc.new {}
 
       build()
     end
 
+    def size=(size)
+      @length = size * 10
+      @height = size * 1.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
@@ -56,6 +85,14 @@ module Savio
       rebuild()
     end
 
+    def selected=(bool)
+      if bool == true
+        select()
+      elsif bool == false
+        deselect()
+      end
+    end
+
     def onClick(&proc)
       @onClick = proc
     end
@@ -79,21 +116,22 @@ module Savio
     end
 
     def select(enforce = @enforceManager)
-      click()
-      if enforce == true && @buttonManager != nil
-        @buttonManager.select(self)
-      else
-        @selectCircle.add
-        @selected = true
-        if @type == 'clicker'
+      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
+          @selected = true
           if @type == 'clicker'
             fade = Thread.new {
               @selectCircle.add
               sleep(0.06)
               @selectCircle.remove
             }
+            deselect(enforce)
           end
-          deselect(enforce)
         end
       end
     end
@@ -140,26 +178,48 @@ module Savio
 
     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
-      )
+      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: @labelColor,
+          z: @z
+        )
+      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: @labelColor,
+          z: @z+2
+        )
+      end
 
       if @buttonManager == nil
         if @selected

data/lib/savio/InputBox.rb

@@ -16,6 +16,8 @@ module Savio
 
       @selected = args[:selected] || false
 
+      @size = args[:size] || 20
+
       @shift = false
 
       @value = args[:value] || @displayName
@@ -96,6 +98,14 @@ module Savio
       @display.text = @value + "|"
     end
 
+    def selected=(bool)
+      if bool == true
+        select()
+      elsif bool == false
+        deselect()
+      end
+    end
+
     def select()
       @selected = true
 

data/lib/savio/Slider.rb

@@ -72,6 +72,10 @@ module Savio
       end
     end
 
+    def value=(value)
+      setValue(value)
+    end
+
     def setValue(value)
       if value.between?(@min, @max)
         to_max = @x + @length

data/lib/savio/io.rb

@@ -31,7 +31,16 @@ on :mouse do |event|
       Button.buttons.each do |button|
 
         if button.draggingEnabled
-          if event.x.between?(button.x-button.size,button.x+button.size) && event.y.between?(button.y-button.size,button.y+button.size)
+          check = Struct.new(:x,:y).new(false,false)
+          case button.style
+          when 'box'
+            check.y = event.y.between?(button.y,button.y+button.height)
+            check.x = event.x.between?(button.x,button.x+button.length)
+          when 'badge'
+            check.x = event.x.between?(button.x-button.size,button.x+button.size)
+            check.y = event.y.between?(button.y-button.size,button.y+button.size)
+          end
+          if check.x && check.y
             button.allowDrag = true
           end
           if button.allowDrag
@@ -45,7 +54,16 @@ on :mouse do |event|
       Button.buttons.each do |button|
 
         if button.shown && button.enabled
-          if event.x.between?(button.x-button.size,button.x+button.size) && event.y.between?(button.y-button.size,button.y+button.size)
+          check = Struct.new(:x,:y).new(false,false)
+          case button.style
+          when 'box'
+            check.y = event.y.between?(button.y,button.y+button.height)
+            check.x = event.x.between?(button.x,button.x+button.length)
+          when 'badge'
+            check.x = event.x.between?(button.x-button.size,button.x+button.size)
+            check.y = event.y.between?(button.y-button.size,button.y+button.size)
+          end
+          if check.x && check.y
             if button.buttonManager == nil
               button.toggle
             else

data/lib/savio/version.rb

@@ -1,3 +1,3 @@
 module Savio
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: savio
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - TheRealSavi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-12 00:00:00.000000000 Z
+date: 2020-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby2d