jmod.mapper

Create and manage mappings of parameters

Table of Contents | Index of Modules | Credits | Donate | Jamoma.org

Configuration

Module Type: control
Algorithm Type: default

Interface Size: 300x140 pixels

Number of signal inlets: 0
Number of signal outlets: 0

Parameters

/name /type /range/bounds /range/clipmode /ramp/drive /ramp/function /dataspace /dataspace/unit /repetitions/filter /description
mapAlgorithm generic 0 1 none none linear none none 1 algorithm to use when mapping.
mapFrom boolean 0 1 none none linear none none 1 Turn on the listen function for values that you want to map from.
mapFromReturn generic 0 1 none none linear none none 1 Displays the currently active parameter
mapTo boolean 0 1 none none linear none none 1 Turn on the listen function for values that you want to map to.
mapToReturn generic 0 1 none none linear none none 1 Displays the currently active parameter
view/freeze boolean 0 1 none none linear none none 1 Turn off the updating of user interface elements when parameters change. This may be done to conserve CPU resources.
view/highlight string 0 1 none none linear none none 1 Highlight the module with a color tint such as red, green, or similar.

 

Messages

/name /type /range/bounds /range/clipmode /ramp/drive /ramp/function /dataspace /dataspace/unit /repetitions/filter /description
clear generic 0 1 none none linear none none 1 Reset by removing all existing mappings.
clear none 0 1 none none linear none none 1 Reset by removing all existing mappings.
create generic 0 1 none none linear none none 1 Create a new mapping. Arguments are: [mapping_name] [mapping_source (OSC)] [optionalorithm to apply][ ->][mapping_destination (OSC)].
documentation/generate generic 0 1 none none linear none none 1 Generate a html documentation page for this module and save it to disk. The argument 'tex' creates a Latex document.
init none 0 1 none none linear none none 1 Initialize a module completely to the original state.
loadMappings generic 0 1 none none linear none none 1 Load mappings from file.
NOTE: j.mappings will be watching the file and automatically update if the content of the file is changed. This way you can use an external editor to work on the cue script while Jamoma is running.
mapCreate generic 0 1 none none linear none none 1 Bang to create new mapping.
modify generic 0 1 none none linear none none 1 Remove an existing mapping. the required argument is the mapping_name.
preset/clear none 0 1 none none linear none none 1 Clears all presets, providing a blank slate for saving new presets.
preset/copy generic 0 1 none none linear none none 1 Create a new preset (2nd argument) by copying the contents of another preset (1st argument)
preset/default none 0 1 none none linear none none 1 Open the default preset file and recall the first preset in that file.
preset/dump none 0 1 none none linear none none 1 Dump all preset names.
preset/interpolate generic 0 1 none none linear none none 1 Interpolate between two named presets (argument 1 and 2) using a ratio (float in the range [0.0, 1.0]) specified as the third argument.
preset/mix generic 0 1 none none linear none none 1 Mix list of pairs of (preset name, mix value) using a ratio (float).
preset/post none 0 1 none none linear none none 1 Post all presets to the Max window.
preset/read generic 0 1 none none linear none none 1 Open an xml-preset file and recall the first preset in that file. An optional argument defines the file to open.
preset/recall generic 0 1 none none linear none none 1 Recall a preset by number - you can also choose presets from the module menu.
preset/store generic 0 1 none none linear none none 1 Store a preset by number in memory. All presets present in memory will be written to disk when you send a /preset/write message to the module.
preset/storecurrent none 0 1 none none linear none none 1 Store on the last recalled or stored preset
preset/storenext none 0 1 none none linear none none 1 Store a preset in the next preset slot. Handy so that you do not need to specify a preset number manually.
preset/write generic 0 1 none none linear none none 1 Write an xml-preset file to disk. An optional argument defines the file to open.
preset/writeagain none 0 1 none none linear none none 1 Write on same xml-preset file.
remove generic 0 1 none none linear none none 1 Remove an existing mapping. the required argument is the mapping_name.
saveMappings generic 0 1 none none linear none none 1 Save mappings to a file. An argument determines the file path and name. If no argument is given then a file dialog will be presented.
update none 0 1 none none linear none none 1 If you have made changes in the viewer (or an external text editor) then you will need to send this /update message in order for them to take effect. This done automatically when you open a fresh file.
view/color/border decimalArray 0 1 both none linear none none 1 The border color of the module in the format RGBA where values range.
view/color/contentBackground decimalArray 0 1 both none linear none none 1 The background color of the module in the format RGBA where values range.
view/color/toolbarBackground decimalArray 0 1 both none linear none none 1 The background color of the module's toolbar in the format RGBA where values range.
view/color/toolbarText decimalArray 0 1 both none linear none none 1 The color of the module's toolbar text in the format RGBA where values range.
view/internals none 0 1 none none linear none none 1 Attempts to open the internal algorithm for viewing. This works for most modules. Some modules may choose to cloak the algorithms - preventing this message from functioning.
view/refresh none 0 1 none none linear none none 1 Update displayed values for module to reflect current state.
view/script generic 0 1 none none linear none none 1 Low-level module hacking. Any arguments arguments to this message will be interpreted as patcher scripting for the top-level patcher of the module.
view/size generic 0 1 none none linear none none 1 The size of the module's UI: [Width Height]
view none 0 1 none none linear none none 1 View current mappings in a text window.

 

Return

/name /type /range/bounds /range/clipmode /ramp/drive /ramp/function /dataspace /dataspace/unit /repetitions/filter /enable /description

 

About Jamoma

Jamoma is a system for creating and exchanging structured Max patches. It consists of both a set of guidelines and an implementation of those guidelines. For more information please visit jamoma.org.