grrr-rb

Grid controller UI toolkit for Ruby.

Description

This is a less maintained port of the Grrr-sc SuperCollider library. Please report bugs.

The grrr-rb library provides high level UI abstractions for grid based controllers such as monome 40h, 64, 128 and 256 devices. Widgets, ie. buttons and toggles, are placed on controllers. Widgets can be nested in containers which allows for modes and paging. The library adheres to principles of the standard GUI class library in SuperCollider.

Usage

Grrr can be used as a framework for building full featured apps or in live coding.

Requiring require 'grrr' includes the Grrr module containing the classes described below.

If Grrr is run in JRuby require 'grrr/screengrid' will make a virtual grid available for use.

Examples

Building a UI in IRB

This assumes a monome grid is connected to the computer.

$ cd /path/to/grrr-rb
$ rake irb

  irb(main)> monome=Grrr::Monome.new
  SerialOSC Devices:
    x y z
  irb(main)> steps=Grrr::StepView.new(monome, Grrr::Point.new(0, 0), monome.num_cols, 1)
  irb(main)> Thread.new do
  irb(main)>   i = 0
  irb(main)>   while true
  irb(main)>     steps.playhead = i
  irb(main)>     puts (steps.step_value(i) ? "ho!" : "hey" )
  irb(main)>     sleep 0.5
  irb(main)>     i = (i + 1) % monome.num_cols
  irb(main)>   end
  irb(main)> end

Hello World

$ cat example1.rb

  require 'grrr'
  
  a=Grrr::Monome.new # creates a monome
  b=Grrr::Button.new(a, Grrr::Point.new(0, 0)) # places a 1x1 button at top left key
  b.action = lambda { |button, value| puts "#{value ? "Hello" : "Goodbye"} World" }
  
  # pressing the top left grid button of the grid will change led state and output to the Post Window
  
  gets # wait for enter to quit

$ ruby -I/path/to/grrr-rb/lib -I/path/to/serialoscclient-rb/lib example1.rb

A Simple Step Sequencer

$ cat example2.rb

  require 'grrr'
  
  a=Grrr::Monome.new # creates a monome
  b=Grrr::StepView.new(a, Grrr::Point.new(0, 7), a.num_cols, 1) # the step view defines when to play notes 
  c=Grrr::MultiToggleView.new(a, Grrr::Point.new(0, 0), a.num_cols, 7) # toggles representing note pitch
  c.values_are_inverted=true
  
  # sequence that posts a degree for steps that are lit
  Thread.new do
    i = 0
    while true
      b.playhead = i
      if b.step_value(i)
        puts "degree: #{c.toggle_value(b.playhead)}"
      end
      sleep 0.15
      i = (i + 1) % a.num_cols
    end
  end
  
  # randomize pattern
  b.num_cols.times do |index|
  	c.set_toggle_value(index, rand(c.num_rows))
  	b.set_step_value(index, [true, false].sample)
  end
  
  gets # wait for enter to quit

$ ruby -I/path/to/grrr-rb/lib -I/path/to/serialoscclient-rb/lib example2.rb

Requirements

This library requires serialoscclient-rb. The library has been developed and tested in Ruby 2.3.3 and JRuby 9.1.6.0. Grrr::ScreenGrid only works for JRuby due to its reliance on Java GUI.

Installation

Download and install dependency serialoscclient-rb.

Download grrr-rb. Add the lib folder of grrr-rb to the Ruby load path.

Documentation

No Ruby specific documentation is available. Schelp documentation available for the Grrr-sc SuperCollider library is applicable to this version of the library. Be aware, however, that in contrast to Grrr-sc methods in grrr-rb are snake_case.

Tests

An automated test suite is included.

Make sure serialoscclient-rb is installed in a folder adjacent to the grrr-rb folder and execute:

$ cd /path/to/grrr-rb
$ rake

Implementation

This is a Ruby port of the Grrr-sc SuperCollider library.

The SuperCollider and Ruby classes are generated using the rsclass-rb class generator based on meta data defined in the grrr-meta-rb repository.

For low latency real-time Grid controller performance working with Grrr-sc and SuperCollider is recommended.

Code readability has been favored over optimizations.

If you intend to use this library beware of monkey patching (lib/core_extensions/*) due to port of a collection of required SuperCollider extensions to Ruby.

Classes

Classes in this library reside in the Grrr module.

View - Abstract superclass. Represents a 2D grid of backlit buttons.
- ContainerView - Abstract class for views that may contain other views.
  - TopView - This is the topmost view in a view tree and typically the view to which controllers attach. The view cannot be added as a child to any other view.
- Button - A button that may span over several rows and columns.
- AbstractToggle - Abstract class for toggles.
  - Toggle - A toggle.
    - VToggle - Vertical toggle.
    - HToggle - Horizontal toggle.
- MultiButtonView - A grid of buttons of the same size.
- MultiToggleView - An array of vertical or horizontal toggles of the same size.
- StepView - A grid of buttons of the same size indexed as steps with possibility to indicate playing step. Suitable for step sequencing.
- Keyboard - A virtual keyboard.
Controller - Abstract superclass. Represents a device that may attach to and control part of or an entire view.
- Monome - Generic monome controller.
  - Monome64 - 8x8 monome.
  - MonomeV128 - 8x16 monome.
  - MonomeH128 - 16x8 monome.
  - Monome256 - 16x16 monome.
- ScreenGrid - An on-screen controller of user definable size. Button events may be triggered with mouse and keyboard. Only available for JRuby since it depends on Java GUI. Use require 'grrr/screengrid'

Extending Grrr

Section "Extending Grrr" in the Schelp documentation available for the Grrr-sc is applicable to this version of the library. In contrast to Grrr-sc methods in grrr-rb are snake_case.

antonhornquist/grrr-rb