Class Arcify
Arcify class.
Create a new instance to support Arc devices
Info:
- Release: v1.0.0
- Author: Mimetaur (https://github.com/mimetaur)
Methods
| Arcify:new (arc_obj, update_self, update_rate) | Create a new Arcify object. |
| Arcify:add_params () | Add Arcify assignment params to the Norns PARAMS screen. |
| Arcify:register (name_, scale_, is_rounded_) | Register a param to be available to Arcify. |
| Arcify:map_encoder (position, param_name, is_shift) | Map an encoder to a param. |
| Arcify:clear_encoder_mapping (position, is_shift) | Clear an encoder mapping. |
| Arcify:clear_all_encoder_mappings () | Clear all encoder mappings |
| Arcify:update (num, delta) | Callback when an encoder is updated. |
| Arcify:param_id_at_encoder (enc_num) | Get the param ID value for a particular encoder. |
| Arcify:param_name_at_encoder (enc_num) | Get the param Name value for a particular encoder. |
| Arcify:redraw () | Redraw Arc rings. |
| Arcify:handle_shift (key_pressed, key_state) | Call this from inside the key() function |
Methods
- Arcify:new (arc_obj, update_self, update_rate)
-
Create a new Arcify object.
Parameters:
- arc_obj Arc object (optional, creates its own)
- update_self bool By default, update its rings itself. False to update manually. (optional)
- update_rate int By default, 25 fps (optional)
Returns:
-
Arcify
Instance of Arcify.
- Arcify:add_params ()
- Add Arcify assignment params to the Norns PARAMS screen.
- Arcify:register (name_, scale_, is_rounded_)
-
Register a param to be available to Arcify.
Parameters:
- name_ string ID of param
- scale_ number Multiplier to manage Arc sensitivity (optional)
- is_rounded_ bool Get rid of floating point values (optional)
- Arcify:map_encoder (position, param_name, is_shift)
-
Map an encoder to a param.
Parameters:
- position int which encoder to map
- param_name string which param ID to map it to
- is_shift bool if mapping an encoder in shift mode
- Arcify:clear_encoder_mapping (position, is_shift)
-
Clear an encoder mapping.
Parameters:
- position int which encoder to clear
- is_shift bool if mapping an encoder in shift mode
- Arcify:clear_all_encoder_mappings ()
- Clear all encoder mappings
- Arcify:update (num, delta)
-
Callback when an encoder is updated.
Parameters:
- num int which arc encoder is updated
- delta number how much it is updated
- Arcify:param_id_at_encoder (enc_num)
-
Get the param ID value for a particular encoder.
Parameters:
- enc_num int which arc encoder to get Param ID for
- Arcify:param_name_at_encoder (enc_num)
-
Get the param Name value for a particular encoder.
Parameters:
- enc_num int which arc encoder to get Param Name for
- Arcify:redraw ()
- Redraw Arc rings. You can call this manually instead of letting Arcify refresh itself.
- Arcify:handle_shift (key_pressed, key_state)
-
Call this from inside the key() function
Parameters:
- key_pressed int is which key was pressed
- key_state int is whether it is up or down