Merge branch 'develop' of github.com:mapmapteam/mapmap into develop

AboutDialog.cpp

@@ -69,6 +69,8 @@ AboutDialog::AboutDialog(QWidget *parent) : QDialog(parent)
   createContributorsTab();
   // License
   createLicenseTab();
+
+  createOscTab();
 }
 
 void AboutDialog::createAboutTab()
@@ -160,4 +162,16 @@ void AboutDialog::createLicenseTab()
   _tabWidget->addTab(_licenseTextBrowser, tr("License"));
 }
 
+void AboutDialog::createOscTab()
+{
+
+  QTextBrowser *
+  oscBrowser = new QTextBrowser;
+  oscBrowser->setOpenExternalLinks(true);
+  QFile oscFile(":/osc_html");
+  oscFile.open(QIODevice::ReadOnly | QIODevice::Text);
+  oscBrowser->setText(QTextCodec::codecForName("UTF-8")->toUnicode(oscFile.readAll()));
+  _tabWidget->addTab(oscBrowser, tr("OSC"));
+}
+
 }

AboutDialog.h

@@ -46,6 +46,7 @@ private:
   void createLibrariesTab();
   void createContributorsTab();
   void createLicenseTab();
+  void createOscTab();
 
   QGridLayout *_mainLayout;
   QLabel *_iconLabel;

HACKING

@@ -37,6 +37,7 @@ Files
 * TODO: You can put things to do there, or use https://github.com/mapmapteam/mapmap, or https://www.pivotaltracker.com/s/projects/954570/
 * images/: Images part of the GUI.
 * prototypes/ : Contains prototypes. Please ask the project maintainer before removing some of these.
+* docs/informations/*.md Markdown files to generate the About dialog
 
 Code management with Git
 ------------------------
@@ -59,6 +60,7 @@ Make a release
   * PROJECT_NUMBER in Doxyfile
 * Edit NEWS - update with the news for the release you are about to make
 * Run ./scripts/update-changelog.sh and commit the changes
+* Maybe update the docs/informations/osc.md file and run scripts/update-osc.sh and commit the changes
 * Maybe update the docs/informations/CONTRIBUTORS.md file and run scripts/update-contributors.sh and commit the changes
 * run make
 * run ./sh_build_doc.sh

docs/documentation.qrc

@@ -5,5 +5,6 @@
         <file alias="license-short">informations/LICENSE_SHORT.txt</file>
         <file alias="projection-mapping">informations/MAPPING</file>
         <file alias="contributors">informations/CONTRIBUTORS.html</file>
+        <file alias="osc_html">informations/osc.html</file>
     </qresource>
 </RCC>

docs/informations/osc.html

@@ -0,0 +1,60 @@
+<h1>Currently supported commands</h1>
+
+<h2>Paints</h2>
+
+<p>Paint ids are numbered from 1 to N.</p>
+
+<ul>
+<li>/mapmap/paint/name ,is <id> <name>        Change name of paint.</li>
+<li>/mapmap/paint/opacity ,if <id> <opacity>  Change opacity of paint. Range: [0,1]</li>
+</ul>
+
+<h3>Color paint</h3>
+
+<ul>
+<li>/mapmap/paint/color ,is <id> <color>      Change color of paint. (eg. "#ff0000")</li>
+</ul>
+
+<h3>Image/Video paint</h3>
+
+<ul>
+<li>/mapmap/paint/rate ,if <id> <rate>        Change rate (speed) of paint Range: [0,1]</li>
+<li>/mapmap/paint/uri ,is <id> <uri>          Change URI of paint. (eg. file:///home/example/example.mov)</li>
+<li>/mapmap/paint/volume ,if <id> <volume>    Change audio volume of paint. Range: [0,1]</li>
+<li>/mapmap/paint/rewind ,i <id>              Rewind paint</li>
+</ul>
+
+<h2>Mappings</h2>
+
+<p>Mappings are numbered from 1 to N.</p>
+
+<ul>
+<li>/mapmap/mapping/depth ,ii <id> <depth>      Change depth of mapping. (layer order)</li>
+<li>/mapmap/mapping/locked ,ii <id> <locked>    Change lock status of mapping (0 or 1)</li>
+<li>/mapmap/mapping/name ,is <id> <name>        Change name of mapping</li>
+<li>/mapmap/mapping/opacity ,if <id> <opacity>  Change opacity of mapping. Range: [0,1]</li>
+<li>/mapmap/mapping/solo ,ii <id> <solo>        Change solo status of mapping (0 or 1)</li>
+<li>/mapmap/mapping/visible ,ii <id> <visible>  Change visibility status of mapping (0 or 1)</li>
+</ul>
+
+<h2>Regular expressions</h2>
+
+<p>Alternatively to ids, one can use a string pattern describing a regexp over the paint or mapping names. The regular expression follows a <a href="http://doc.qt.io/qt-5/qregexp.html#wildcard-matching">simple "file globbing" / wildcard syntax</a>. It is case-sensitive.</p>
+
+<p>Examples:</p>
+
+<ul>
+<li>/mapmap/paint/opacity ,sf movie.mov 0.1   Change opacity of paint named "movie.mov" to 0.1 (10%)</li>
+<li>/mapmap/paint/opacity ,sf "movie<em>*" 0.5   Change opacity of all paints whose name begins by "movie</em>" to 0.5 (50%)</li>
+<li>/mapmap/paint/rewind ,s "*.mov"           Rewind all .mov paints</li>
+<li>/mapmap/mapping/solo ,s "mesh<em>[0-9]" 1    Sets all mappings that begin with "mesh</em>" followed by a single digit to solo mode</li>
+</ul>
+
+<h2>Playback</h2>
+
+<ul>
+<li>/mapmap/pause                 Stop playback</li>
+<li>/mapmap/play                  Start playback</li>
+<li>/mapmap/quit                  Quit MapMap</li>
+<li>/mapmap/rewind                Rewind/reset</li>
+</ul>

docs/informations/osc.md

@@ -0,0 +1,45 @@
+# Currently supported commands
+
+## Paints
+Paint ids are numbered from 1 to N.
+
+- /mapmap/paint/name ,is <id> <name>        Change name of paint.
+- /mapmap/paint/opacity ,if <id> <opacity>  Change opacity of paint. Range: [0,1]
+
+### Color paint
+
+- /mapmap/paint/color ,is <id> <color>      Change color of paint. (eg. "#ff0000")
+
+### Image/Video paint
+
+- /mapmap/paint/rate ,if <id> <rate>        Change rate (speed) of paint Range: [0,1]
+- /mapmap/paint/uri ,is <id> <uri>          Change URI of paint. (eg. file:///home/example/example.mov)
+- /mapmap/paint/volume ,if <id> <volume>    Change audio volume of paint. Range: [0,1]
+- /mapmap/paint/rewind ,i <id>              Rewind paint
+
+## Mappings
+Mappings are numbered from 1 to N.
+
+- /mapmap/mapping/depth ,ii <id> <depth>      Change depth of mapping. (layer order)
+- /mapmap/mapping/locked ,ii <id> <locked>    Change lock status of mapping (0 or 1)
+- /mapmap/mapping/name ,is <id> <name>        Change name of mapping
+- /mapmap/mapping/opacity ,if <id> <opacity>  Change opacity of mapping. Range: [0,1]
+- /mapmap/mapping/solo ,ii <id> <solo>        Change solo status of mapping (0 or 1)
+- /mapmap/mapping/visible ,ii <id> <visible>  Change visibility status of mapping (0 or 1)
+
+## Regular expressions
+Alternatively to ids, one can use a string pattern describing a regexp over the paint or mapping names. The regular expression follows a [simple "file globbing" / wildcard syntax](http://doc.qt.io/qt-5/qregexp.html#wildcard-matching). It is case-sensitive.
+
+Examples:
+
+- /mapmap/paint/opacity ,sf movie.mov 0.1   Change opacity of paint named "movie.mov" to 0.1 (10%)
+- /mapmap/paint/opacity ,sf "movie_*" 0.5   Change opacity of all paints whose name begins by "movie_" to 0.5 (50%)
+- /mapmap/paint/rewind ,s "*.mov"           Rewind all .mov paints
+- /mapmap/mapping/solo ,s "mesh_[0-9]" 1    Sets all mappings that begin with "mesh_" followed by a single digit to solo mode
+
+## Playback
+
+- /mapmap/pause                 Stop playback
+- /mapmap/play                  Start playback
+- /mapmap/quit                  Quit MapMap
+- /mapmap/rewind                Rewind/reset

scripts/update-osc.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+set -o verbose
+# Convert markdown file to html
+markdown docs/informations/osc.md > docs/informations/osc.html