jmod.mapper.html from Jamoma at Krugle
Show jmod.mapper.html syntax highlighted
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="content-type" content="text/html;charset=ISO-8859-1">
<title> jmod.mapper </title>
<link href="../styles/jamoma.css" rel="stylesheet" type="text/css">
</head>
<body>
<div id="jmod_header">
<img src="../images/jmod.icon.mod.png" width="128" height="128">
<h1> jmod.mapper </h1>
<h2> Create and manage mappings of parameters </h2>
<h6><a href="../index.html">Table of Contents</a> | <a href="../modules/">Index of Modules</a> | <a href="http://jamoma.org/">Jamoma.org</a></h6>
</div>
<h3> Configuration </h3>
<p> Module Type: <code> control </code> <br>
Algorithm Type: <code> default </code> </p>
<p>Interface Size: <code> 2U-half </code> </p>
<p>Number of signal inlets: <code> 0 </ code> <br/>
Number of signal outlets: <code> 0 </code> </p>
<h3> Parameters </h3>
<table>
<tr class="tableHeading2">
<td> Name </td>
<td> Type </td>
<td> Range </td>
<td> Clipmode </td>
<td> Ramp Enabled </td>
<td> Repetitions </td>
<td> Description </td>
<tr>
<tr>
<td class="instructionName"> mapAlgorithm </td>
<td class ="instructionType"> msg_generic </td>
<td class ="instructionRange"> 0.000000 1.000000 </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> algorithm to use when mapping. </td>
<tr>
<tr>
<td class="instructionName"> mapFromReturn </td>
<td class ="instructionType"> msg_generic </td>
<td class ="instructionRange"> 0.000000 1.000000 </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Displays the currently active parameter </td>
<tr>
<tr>
<td class="instructionName"> mapFrom </td>
<td class ="instructionType"> msg_toggle </td>
<td class ="instructionRange"> 0 1 </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Turn on the listen function for values that you want to map from. </td>
<tr>
<tr>
<td class="instructionName"> mapToReturn </td>
<td class ="instructionType"> msg_generic </td>
<td class ="instructionRange"> 0.000000 1.000000 </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Displays the currently active parameter </td>
<tr>
<tr>
<td class="instructionName"> mapTo </td>
<td class ="instructionType"> msg_toggle </td>
<td class ="instructionRange"> 0 1 </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Turn on the listen function for values that you want to map to. </td>
<tr>
</table>
<p> </p>
<h3> Messages </h3>
<table>
<tr class="tableHeading2">
<td> Name </td>
<td> Type </td>
<td> Range </td>
<td> Clipmode </td>
<td> Ramp Enabled </td>
<td> Repetitions </td>
<td> Description </td>
<tr>
<tr>
<td class="instructionName"> clear </td>
<td class ="instructionType"> msg_generic </td>
<td class ="instructionRange"> 0.000000 1.000000 </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Reset by removing all existing mappings. </td>
<tr>
<tr>
<td class="instructionName"> clear </td>
<td class ="instructionType"> msg_generic </td>
<td class ="instructionRange"> 0.000000 1.000000 </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Reset by removing all existing mappings. </td>
<tr>
<tr>
<td class="instructionName"> create </td>
<td class ="instructionType"> msg_generic </td>
<td class ="instructionRange"> 0.000000 1.000000 </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Create a new mapping. Arguments are: [mapping_name] [mapping_source (OSC)] [optional.mxtorithm to apply][ ->][mapping_destination (OSC)]. </td>
<tr>
<tr>
<td class="instructionName"> documentation/help </td>
<td class ="instructionType"> msg_none </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Open the help patch for the module. </td>
<tr>
<tr>
<td class="instructionName"> documentation/html </td>
<td class ="instructionType"> msg_none </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Open the online html reference for this module. </td>
<tr>
<tr>
<td class="instructionName"> load_mappings </td>
<td class ="instructionType"> msg_generic </td>
<td class ="instructionRange"> 0.000000 1.000000 </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Load mappings from file. <br/>NOTE: jcom.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. </td>
<tr>
<tr>
<td class="instructionName"> mapCreate </td>
<td class ="instructionType"> msg_generic </td>
<td class ="instructionRange"> 0.000000 1.000000 </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Bang to create new mapping. </td>
<tr>
<tr>
<td class="instructionName"> modify </td>
<td class ="instructionType"> msg_generic </td>
<td class ="instructionRange"> 0.000000 1.000000 </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Remove an existing mapping. the required argument is the mapping_name. </td>
<tr>
<tr>
<td class="instructionName"> module/view_internals </td>
<td class ="instructionType"> msg_none </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> 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. </td>
<tr>
<tr>
<td class="instructionName"> preset/default </td>
<td class ="instructionType"> msg_none </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Open the default preset file and recall the first preset in that file. </td>
<tr>
<tr>
<td class="instructionName"> preset/load </td>
<td class ="instructionType"> msg_symbol </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Open an xml-preset file and recall the first preset in that file. An optional argument defines the file to open. </td>
<tr>
<tr>
<td class="instructionName"> preset/recall </td>
<td class ="instructionType"> msg_float </td>
<td class ="instructionRange"> 0.000000 1.000000 </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Recall a preset by number - you can also choose presets from the module menu. </td>
<tr>
<tr>
<td class="instructionName"> preset/save </td>
<td class ="instructionType"> msg_symbol </td>
<th class = "instructionRange"> N/A </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Write an xml-preset file to disk. An optional argument defines the file to open. </td>
<tr>
<tr>
<td class="instructionName"> preset/store </td>
<td class ="instructionType"> msg_int </td>
<td class ="instructionRange"> 0 1 </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Store a preset by number in memory. All presets present in memory will be written to disk when you send a save_settings message to the module. </td>
<tr>
<tr>
<td class="instructionName"> remove </td>
<td class ="instructionType"> msg_generic </td>
<td class ="instructionRange"> 0.000000 1.000000 </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> Remove an existing mapping. the required argument is the mapping_name. </td>
<tr>
<tr>
<td class="instructionName"> save_mappings </td>
<td class ="instructionType"> msg_generic </td>
<td class ="instructionRange"> 0.000000 1.000000 </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> 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. </td>
<tr>
<tr>
<td class="instructionName"> update </td>
<td class ="instructionType"> msg_generic </td>
<td class ="instructionRange"> 0.000000 1.000000 </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> 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. </td>
<tr>
<tr>
<td class="instructionName"> view </td>
<td class ="instructionType"> msg_generic </td>
<td class ="instructionRange"> 0.000000 1.000000 </td>
<td class ="instructionClipmode"> none </td>
<td class ="instructionRamp"> none </td>
<td class ="instructionRepetitions"> 1 </td>
<td class ="instructionDescription"> View current mappings in a text window. </td>
<tr>
</table>
<p> </p>
<h3> Return </h3>
<table>
<tr class="tableHeading2">
<td> Name </td>
<td> Type </td>
<td> Range </td>
<td> Clipmode </td>
<td> Ramp Enabled </td>
<td> Repetitions </td>
<td> Description </td>
<tr>
</table>
<p> </p>
<h3> About Jamoma </h3>
<p> 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 <a href="http://jamoma.org/">jamoma.org</a>. </p>
</body>
</html>
See more files for this project here