:orphan:

Key Plane
=========

*Example script* (scamp_extensions): `examples/Interactivity & visualization/Keyboard input/key_plane_example.py <https://github.com/MarcTheSpark/scamp_extensions/blob/main/examples/Interactivity%20%26%20visualization/Keyboard%20input/key_plane_example.py>`__

*Download:* :download:`key_plane_example.py <downloads/interactivity_visualization_keyboard_input_key_plane_example/key_plane_example.py>`

**Requires the** ``scamp_extensions`` **package** (``pip install scamp_extensions``).

Maps the computer keyboard onto a 2D grid of pitches with scamp_extensions' KeyPlane; each key press starts a flute note whose pitch and volume come from its row and column.

*Topics:* :doc:`Interactivity & visualization › Keyboard input <interactivity_visualization>`

.. raw:: html

   <iframe src="https://www.youtube-nocookie.com/embed/XLG8ooIxS2A" style="width:100%;max-width:640px;aspect-ratio:16/9;border:0;display:block;margin:0.6em 0" allowfullscreen></iframe>

.. code-block:: python

   from scamp_extensions.interaction import KeyPlane
   from scamp_extensions.utilities import remap
   from scamp import *

   s = Session()

   flute = s.new_part("flute")

   notes = {}


   def callback(coordinates, press_or_release, modifiers):
       if press_or_release == "press":
           print("Press at:", coordinates, "with modifiers", modifiers)
           notes[coordinates] = flute.start_note(remap(coordinates[0], 60, 96, 0, 1), remap(coordinates[1], 0.3, 1, 0, 1))
       else:
           print("Release at:", coordinates, "with modifiers", modifiers)
           if notes[coordinates]:
               notes[coordinates].end()


   KeyPlane(callback, normalize_coordinates=True).start(blocking=True, suppress=True)