sparkle_motion 0.1.0

data/lib/sparkle_motion/launch_pad/color.rb

@@ -0,0 +1,41 @@
+module SparkleMotion
+  module LaunchPad
+    # Color classes for the Novation Launchpad Mk 2, which supports 4 bits per
+    # color element in RGB mode.
+    class Color
+      attr_reader :r, :g, :b
+      def initialize(r, g, b)
+        @r = clamp_elem(r)
+        @g = clamp_elem(g)
+        @b = clamp_elem(b)
+      end
+
+      def to_h
+        { r: r,
+          g: g,
+          b: b }
+      end
+
+    protected
+
+      def clamp_elem(elem)
+        return 0x00 if elem < 0x00
+        return 0x3F if elem > 0x3F # 63
+        elem
+      end
+    end
+
+    #
+    class Color
+      BLACK       = new(0x00, 0x00, 0x00).freeze
+      DARK_GRAY   = new(0x07, 0x07, 0x07).freeze
+      LIGHT_GRAY  = new(0x27, 0x27, 0x27).freeze
+      WHITE       = new(0x3F, 0x3F, 0x3F).freeze
+      RED         = new(0x3F, 0x00, 0x00).freeze
+      DARK_GREEN  = new(0x00, 0x07, 0x00).freeze
+      GREEN       = new(0x00, 0x3F, 0x00).freeze
+      LIGHT_GREEN = new(0x10, 0x4F, 0x10).freeze
+      BLUE        = new(0x00, 0x00, 0x3F).freeze
+    end
+  end
+end

data/lib/sparkle_motion/launch_pad/widget.rb

@@ -0,0 +1,187 @@
+module SparkleMotion
+  module LaunchPad
+    # Base class for Launchpad UI widgets.
+    class Widget
+      attr_reader :value, :x, :y, :width, :height
+      attr_accessor :on, :off, :down
+
+      # TODO: Use `Vector2` for position/size...
+      def initialize(launchpad:, x: nil, y: nil, position: nil, width:, height:, on:, off:, down:,
+                     value:)
+        @x          = x
+        @y          = y
+        @position   = position
+        @width      = width
+        @height     = height
+        @launchpad  = launchpad
+        @value      = value
+        @pressed    = {}
+        set_colors!(on, off, down)
+        attach_handler!
+      end
+
+      def update(value, render_now = true)
+        @value = value
+        @value = max_v if max_v && @value && @value > max_v
+        render if render_now
+      end
+
+      def render
+        @pressed.map do |idx, state|
+          next unless state
+          if @x
+            xx, yy = coords_for(idx: idx)
+            change_grid(x: xx, y: yy, color: down)
+          else
+            change_command(position: @position, color: down)
+          end
+        end
+      end
+
+      def blank
+        black = SparkleMotion::LaunchPad::Color::BLACK.to_h
+        if @x
+          (0..max_x).each do |xx|
+            (0..max_y).each do |yy|
+              change_grid(x: xx, y: yy, color: black)
+            end
+          end
+        else
+          change_command(position: @position, color: black)
+        end
+      end
+
+      def max_v
+        if @x
+          @max_v ||= (height * width) - 1
+        else
+          1
+        end
+      end
+
+    protected
+
+      attr_reader :launchpad
+
+      def tag
+        @tag ||= begin
+          pos = @x ? "#{@x},#{@y}" : @position
+          "#{self.class.name}(#{pos})"
+        end
+      end
+
+      def pressed!(x: nil, y: nil, position: nil)
+        idx = x ? index_for(x: x, y: y) : position
+        @pressed[idx] = true
+      end
+
+      def released!(x: nil, y: nil, position: nil)
+        idx = x ? index_for(x: x, y: y) : position
+        @pressed.delete(idx) if @pressed.key?(idx)
+      end
+
+      def handle_grid_response(action)
+        guard_call(tag) do
+          xx  = action[:x] - @x
+          yy  = action[:y] - @y
+          if action[:state] == :down
+            pressed!(x: xx, y: yy)
+            on_down(x: xx, y: yy)
+          else
+            released!(x: xx, y: yy)
+            on_up(x: xx, y: yy)
+          end
+        end
+      end
+
+      def handle_command_response(action)
+        guard_call(tag) do
+          if action[:state] == :down
+            pressed!(position: @position)
+            on_down(position: @position)
+          else
+            released!(position: @position)
+            on_up(position: @position)
+          end
+        end
+      end
+
+      def index_for(x:, y:); (y * width) + x; end
+      def coords_for(idx:); [idx / width, idx % width]; end
+
+      # Defaults that you may want to override:
+      def on_down(x: nil, y: nil, position: nil)
+        if @x
+          change_grid(x: x, y: y, color: down)
+        else
+          change_command(position: position, color: down)
+        end
+      end
+
+      # rubocop:disable Lint/UnusedMethodArgument
+      def on_up(x: nil, y: nil, position: nil); render; end
+      # rubocop:enable Lint/UnusedMethodArgument
+
+      # Internal utilities for you to use:
+      def change_grid(x:, y:, color:)
+        return if (x > max_x) || (x < 0)
+        return if (y > max_y) || (y < 0)
+        col = effective_color(x: x, y: y, color: color)
+        grid_apply_color(x, y, col)
+      end
+
+      def effective_color(x:, y:, color:)
+        color.is_a?(Array) ? color[index_for(x: x, y: y)] : color
+      end
+
+      def change_command(position:, color:)
+        return unless launchpad
+        launchpad.device.change_command(position, color[:r], color[:g], color[:b])
+      end
+
+      def grid_apply_color(x, y, color)
+        return unless launchpad
+        launchpad.device.change_grid(x + @x, y + @y, color[:r], color[:g], color[:b])
+      end
+
+      def max_y; @max_y ||= height - 1; end
+      def max_x; @max_x ||= width - 1; end
+
+    private
+
+      def set_colors!(on, off, down)
+        @on   = normalize_color!(on)
+        @off  = normalize_color!(off)
+        @down = normalize_color!(down)
+      end
+
+      def normalize_color!(color)
+        black = SparkleMotion::LaunchPad::Color::BLACK.to_h
+        color.is_a?(Array) ? color.map { |oo| black.merge(oo) } : black.merge(color)
+      end
+
+      def attach_handler!
+        attach_grid_handler!
+        attach_position_handler!
+      end
+
+      def attach_grid_handler!
+        return unless @x
+        return unless launchpad
+        xx = @x..(@x + max_x)
+        yy = @y..(@y + max_y)
+        launchpad.response_to(:grid, :both, x: xx, y: yy) do |_inter, action|
+          handle_grid_response(action)
+        end
+      end
+
+      def attach_position_handler!
+        return if @x
+        return unless launchpad
+        launchpad.response_to(@position, :both) do |_inter, action|
+          handle_command_response(action)
+        end
+      end
+    end
+  end
+end

data/lib/sparkle_motion/launch_pad/widgets/button.rb

@@ -0,0 +1,29 @@
+require_relative "./toggle"
+
+module SparkleMotion
+  module LaunchPad
+    module Widgets
+      # Class to represent a single stateless button.
+      class Button < Toggle
+        def initialize(launchpad:,
+                       position: nil,
+                       x: nil,
+                       y: nil,
+                       color:,
+                       down:,
+                       on_press: nil,
+                       value: 0)
+          super(launchpad: launchpad,
+                position:  position,
+                x:         x,
+                y:         y,
+                on:        color,
+                off:       color,
+                down:      down,
+                value:     value,
+                on_press:  on_press)
+        end
+      end
+    end
+  end
+end

data/lib/sparkle_motion/launch_pad/widgets/horizontal_slider.rb

@@ -0,0 +1,43 @@
+module SparkleMotion
+  module LaunchPad
+    module Widgets
+      # Class to represent a slider-style control on a Novation Launchpad.
+      class HorizontalSlider < Widget
+        attr_accessor :on_change
+
+        def initialize(launchpad:, x:, y:, size:, on:, off:, down:, on_change: nil, value: 0)
+          super(launchpad: launchpad,
+                x:         x,
+                y:         y,
+                width:     size,
+                height:    1,
+                on:        on,
+                off:       off,
+                down:      down,
+                value:     value)
+          @on_change = on_change
+        end
+
+        def render
+          (0..max_v).each do |xx|
+            change_grid(x: xx, y: 0, color: (value && value >= xx) ? on : off)
+          end
+          super
+        end
+
+        def update(*args)
+          super(*args)
+          on_change.call(value) if on_change
+        end
+
+      protected
+
+        def on_down(x:, y:)
+          @value = x
+          super(x: x, y: y)
+          on_change.call(value) if on_change
+        end
+      end
+    end
+  end
+end

data/lib/sparkle_motion/launch_pad/widgets/radio_group.rb

@@ -0,0 +1,53 @@
+module SparkleMotion
+  module LaunchPad
+    module Widgets
+      # Class to represent a radio-button group control on a Novation Launchpad.
+      class RadioGroup < Widget
+        attr_accessor :on_select, :on_deselect
+
+        def initialize(launchpad:, x:, y:, size:, on:, off:, down:, on_select: nil, on_deselect:,
+                       value: nil)
+          super(launchpad: launchpad,
+                x:         x,
+                y:         y,
+                width:     size[0],
+                height:    size[1],
+                on:        on,
+                off:       off,
+                down:      down,
+                value:     value)
+          @on_select    = on_select
+          @on_deselect  = on_deselect
+        end
+
+        def render
+          (0..max_x).each do |xx|
+            (0..max_y).each do |yy|
+              col = (value == index_for(x: xx, y: yy)) ? on : off
+
+              change_grid(x: xx, y: yy, color: col)
+            end
+          end
+        end
+
+        def update(*args)
+          super(*args)
+          on_select.call(value) if on_select && value
+          on_deselect.call(value) if on_deselect && !value
+        end
+
+      protected
+
+        def on_down(x:, y:)
+          vv = index_for(x: x, y: y)
+          vv = nil if value == vv
+          @value = vv
+          super(x: x, y: y)
+
+          handler = value ? on_select : on_deselect
+          handler.call(value) if handler
+        end
+      end
+    end
+  end
+end

data/lib/sparkle_motion/launch_pad/widgets/toggle.rb

@@ -0,0 +1,48 @@
+module SparkleMotion
+  module LaunchPad
+    module Widgets
+      # Class to represent a single toggle button.
+      class Toggle < Widget
+        attr_accessor :on_press
+
+        def initialize(launchpad:, position: nil, x: nil, y: nil, on:, off:, down:,
+                       on_press: nil, value: 0)
+          super(launchpad: launchpad,
+                position:  position,
+                x:         x,
+                y:         y,
+                width:     1,
+                height:    1,
+                on:        on,
+                off:       off,
+                down:      down,
+                value:     value)
+          @on_press = on_press
+        end
+
+        def render
+          val = (value != 0) ? on : off
+          if @x
+            change_grid(x: 0, y: 0, color: val)
+          else
+            change_command(position: @position, color: val)
+          end
+          super
+        end
+
+        def update(new_val)
+          @value = new_val ? 1 : 0
+          render
+        end
+
+      protected
+
+        def on_down(x: nil, y: :nil, position: nil)
+          @value = (@value == 0) ? 1 : 0
+          super(x: x, y: y, position: position)
+          on_press.call(value) if on_press
+        end
+      end
+    end
+  end
+end

data/lib/sparkle_motion/launch_pad/widgets/vertical_slider.rb

@@ -0,0 +1,43 @@
+module SparkleMotion
+  module LaunchPad
+    module Widgets
+      # Class to represent a slider-style control on a Novation Launchpad.
+      class VerticalSlider < Widget
+        attr_accessor :on_change
+
+        def initialize(launchpad:, x:, y:, size:, on:, off:, down:, on_change: nil, value: 0)
+          super(launchpad: launchpad,
+                x:         x,
+                y:         y,
+                width:     1,
+                height:    size,
+                on:        on,
+                off:       off,
+                down:      down,
+                value:     value)
+          @on_change = on_change
+        end
+
+        def render
+          (0..max_v).each do |yy|
+            change_grid(x: 0, y: yy, color: (value && value >= yy) ? on : off)
+          end
+          super
+        end
+
+        def update(*args)
+          super(*args)
+          on_change.call(value) if on_change
+        end
+
+      protected
+
+        def on_down(x:, y:)
+          @value = y
+          super(x: x, y: y)
+          on_change.call(value) if on_change
+        end
+      end
+    end
+  end
+end