/usr/share/sitplus/doc/manual.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="AsciiDoc 8.5.2" />
<title>SITPLUS Manual</title>
<style type="text/css">
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
/*
  border: 1px solid red;
*/
}

body {
  margin: 1em 5% 1em 5%;
}

a {
  color: blue;
  text-decoration: underline;
}
a:visited {
  color: fuchsia;
}

em {
  font-style: italic;
  color: navy;
}

strong {
  font-weight: bold;
  color: #083194;
}

tt {
  color: navy;
}

h1, h2, h3, h4, h5, h6 {
  color: #527bbd;
  font-family: sans-serif;
  margin-top: 1.2em;
  margin-bottom: 0.5em;
  line-height: 1.3;
}

h1, h2, h3 {
  border-bottom: 2px solid silver;
}
h2 {
  padding-top: 0.5em;
}
h3 {
  float: left;
}
h3 + * {
  clear: left;
}

div.sectionbody {
  font-family: serif;
  margin-left: 0;
}

hr {
  border: 1px solid silver;
}

p {
  margin-top: 0.5em;
  margin-bottom: 0.5em;
}

ul, ol, li > p {
  margin-top: 0;
}

pre {
  padding: 0;
  margin: 0;
}

span#author {
  color: #527bbd;
  font-family: sans-serif;
  font-weight: bold;
  font-size: 1.1em;
}
span#email {
}
span#revnumber, span#revdate, span#revremark {
  font-family: sans-serif;
}

div#footer {
  font-family: sans-serif;
  font-size: small;
  border-top: 2px solid silver;
  padding-top: 0.5em;
  margin-top: 4.0em;
}
div#footer-text {
  float: left;
  padding-bottom: 0.5em;
}
div#footer-badges {
  float: right;
  padding-bottom: 0.5em;
}

div#preamble {
  margin-top: 1.5em;
  margin-bottom: 1.5em;
}
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
  margin-top: 1.0em;
  margin-bottom: 1.5em;
}
div.admonitionblock {
  margin-top: 2.0em;
  margin-bottom: 2.0em;
  margin-right: 10%;
  color: #606060;
}

div.content { /* Block element content. */
  padding: 0;
}

/* Block element titles. */
div.title, caption.title {
  color: #527bbd;
  font-family: sans-serif;
  font-weight: bold;
  text-align: left;
  margin-top: 1.0em;
  margin-bottom: 0.5em;
}
div.title + * {
  margin-top: 0;
}

td div.title:first-child {
  margin-top: 0.0em;
}
div.content div.title:first-child {
  margin-top: 0.0em;
}
div.content + div.title {
  margin-top: 0.0em;
}

div.sidebarblock > div.content {
  background: #ffffee;
  border: 1px solid silver;
  padding: 0.5em;
}

div.listingblock > div.content {
  border: 1px solid silver;
  background: #f4f4f4;
  padding: 0.5em;
}

div.quoteblock, div.verseblock {
  padding-left: 1.0em;
  margin-left: 1.0em;
  margin-right: 10%;
  border-left: 5px solid #dddddd;
  color: #777777;
}

div.quoteblock > div.attribution {
  padding-top: 0.5em;
  text-align: right;
}

div.verseblock > div.content {
  white-space: pre;
}
div.verseblock > div.attribution {
  padding-top: 0.75em;
  text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
  text-align: left;
}

div.admonitionblock .icon {
  vertical-align: top;
  font-size: 1.1em;
  font-weight: bold;
  text-decoration: underline;
  color: #527bbd;
  padding-right: 0.5em;
}
div.admonitionblock td.content {
  padding-left: 0.5em;
  border-left: 3px solid #dddddd;
}

div.exampleblock > div.content {
  border-left: 3px solid #dddddd;
  padding-left: 0.5em;
}

div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; }
a.image:visited { color: white; }

dl {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
}
dt {
  margin-top: 0.5em;
  margin-bottom: 0;
  font-style: normal;
  color: navy;
}
dd > *:first-child {
  margin-top: 0.1em;
}

ul, ol {
    list-style-position: outside;
}
ol.arabic {
  list-style-type: decimal;
}
ol.loweralpha {
  list-style-type: lower-alpha;
}
ol.upperalpha {
  list-style-type: upper-alpha;
}
ol.lowerroman {
  list-style-type: lower-roman;
}
ol.upperroman {
  list-style-type: upper-roman;
}

div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
  margin-top: 0.1em;
  margin-bottom: 0.1em;
}

div.tableblock > table {
  border: 3px solid #527bbd;
}
thead, p.table.header {
  font-family: sans-serif;
  font-weight: bold;
}
tfoot {
  font-weight: bold;
}
td > div.verse {
  white-space: pre;
}
p.table {
  margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
  border-style: none;
}
div.tableblock > table[frame="hsides"] {
  border-left-style: none;
  border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
  border-top-style: none;
  border-bottom-style: none;
}


div.hdlist {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
}
div.hdlist tr {
  padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
  font-weight: bold;
}
td.hdlist1 {
  vertical-align: top;
  font-style: normal;
  padding-right: 0.8em;
  color: navy;
}
td.hdlist2 {
  vertical-align: top;
}
div.hdlist.compact tr {
  margin: 0;
  padding-bottom: 0;
}

.comment {
  background: yellow;
}

.footnote, .footnoteref {
  font-size: 0.8em;
}

span.footnote, span.footnoteref {
  vertical-align: super;
}

#footnotes {
  margin: 20px 0 20px 0;
  padding: 7px 0 0 0;
}

#footnotes div.footnote {
  margin: 0 0 5px 0;
}

#footnotes hr {
  border: none;
  border-top: 1px solid silver;
  height: 1px;
  text-align: left;
  margin-left: 0;
  width: 20%;
  min-width: 100px;
}


@media print {
  div#footer-badges { display: none; }
}

div#toc {
  margin-bottom: 2.5em;
}

div#toctitle {
  color: #527bbd;
  font-family: sans-serif;
  font-size: 1.1em;
  font-weight: bold;
  margin-top: 1.0em;
  margin-bottom: 0.1em;
}

div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
  margin-top: 0;
  margin-bottom: 0;
}
div.toclevel2 {
  margin-left: 2em;
  font-size: 0.9em;
}
div.toclevel3 {
  margin-left: 4em;
  font-size: 0.9em;
}
div.toclevel4 {
  margin-left: 6em;
  font-size: 0.9em;
}
/* Workarounds for IE6's broken and incomplete CSS2. */

div.sidebar-content {
  background: #ffffee;
  border: 1px solid silver;
  padding: 0.5em;
}
div.sidebar-title, div.image-title {
  color: #527bbd;
  font-family: sans-serif;
  font-weight: bold;
  margin-top: 0.0em;
  margin-bottom: 0.5em;
}

div.listingblock div.content {
  border: 1px solid silver;
  background: #f4f4f4;
  padding: 0.5em;
}

div.quoteblock-attribution {
  padding-top: 0.5em;
  text-align: right;
}

div.verseblock-content {
  white-space: pre;
}
div.verseblock-attribution {
  padding-top: 0.75em;
  text-align: left;
}

div.exampleblock-content {
  border-left: 3px solid #dddddd;
  padding-left: 0.5em;
}

/* IE6 sets dynamically generated links as visited. */
div#toc a:visited { color: blue; }
</style>
<script type="text/javascript">
/*<![CDATA[*/
window.onload = function(){asciidoc.footnotes(); asciidoc.toc(2);}
var asciidoc = {  // Namespace.

/////////////////////////////////////////////////////////////////////
// Table Of Contents generator
/////////////////////////////////////////////////////////////////////

/* Author: Mihai Bazon, September 2002
 * http://students.infoiasi.ro/~mishoo
 *
 * Table Of Content generator
 * Version: 0.4
 *
 * Feel free to use this script under the terms of the GNU General Public
 * License, as long as you do not remove or alter this notice.
 */

 /* modified by Troy D. Hanson, September 2006. License: GPL */
 /* modified by Stuart Rackham, 2006, 2009. License: GPL */

// toclevels = 1..4.
toc: function (toclevels) {

  function getText(el) {
    var text = "";
    for (var i = el.firstChild; i != null; i = i.nextSibling) {
      if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
        text += i.data;
      else if (i.firstChild != null)
        text += getText(i);
    }
    return text;
  }

  function TocEntry(el, text, toclevel) {
    this.element = el;
    this.text = text;
    this.toclevel = toclevel;
  }

  function tocEntries(el, toclevels) {
    var result = new Array;
    var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
    // Function that scans the DOM tree for header elements (the DOM2
    // nodeIterator API would be a better technique but not supported by all
    // browsers).
    var iterate = function (el) {
      for (var i = el.firstChild; i != null; i = i.nextSibling) {
        if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
          var mo = re.exec(i.tagName);
          if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
            result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
          }
          iterate(i);
        }
      }
    }
    iterate(el);
    return result;
  }

  var toc = document.getElementById("toc");
  var entries = tocEntries(document.getElementById("content"), toclevels);
  for (var i = 0; i < entries.length; ++i) {
    var entry = entries[i];
    if (entry.element.id == "")
      entry.element.id = "_toc_" + i;
    var a = document.createElement("a");
    a.href = "#" + entry.element.id;
    a.appendChild(document.createTextNode(entry.text));
    var div = document.createElement("div");
    div.appendChild(a);
    div.className = "toclevel" + entry.toclevel;
    toc.appendChild(div);
  }
  if (entries.length == 0)
    toc.parentNode.removeChild(toc);
},


/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////

/* Based on footnote generation code from:
 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 */

footnotes: function () {
  var cont = document.getElementById("content");
  var noteholder = document.getElementById("footnotes");
  var spans = cont.getElementsByTagName("span");
  var refs = {};
  var n = 0;
  for (i=0; i<spans.length; i++) {
    if (spans[i].className == "footnote") {
      n++;
      // Use [\s\S] in place of . so multi-line matches work.
      // Because JavaScript has no s (dotall) regex flag.
      note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
      noteholder.innerHTML +=
        "<div class='footnote' id='_footnote_" + n + "'>" +
        "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
        n + "</a>. " + note + "</div>";
      spans[i].innerHTML =
        "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
        "' title='View footnote' class='footnote'>" + n + "</a>]";
      var id =spans[i].getAttribute("id");
      if (id != null) refs["#"+id] = n;
    }
  }
  if (n == 0)
    noteholder.parentNode.removeChild(noteholder);
  else {
    // Process footnoterefs.
    for (i=0; i<spans.length; i++) {
      if (spans[i].className == "footnoteref") {
        var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
        href = href.match(/#.*/)[0];  // Because IE return full URL.
        n = refs[href];
        spans[i].innerHTML =
          "[<a href='#_footnote_" + n +
          "' title='View footnote' class='footnote'>" + n + "</a>]";
      }
    }
  }
}

}
/*]]>*/
</script>
</head>
<body>
<div id="header">
<h1>SITPLUS Manual</h1>
<div id="toc">
  <div id="toctitle">Table of Contents</div>
  <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
</div>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="imageblock">
<div class="content">
<img src="images/sitplus_logo_120x120.png" alt="images/sitplus_logo_120x120.png" />
</div>
</div>
<div class="imageblock">
<div class="content">
<img src="images/sitpluslogo_med.png" alt="SITPLUS Logo" />
</div>
</div>
</div>
</div>
<h2 id="_introduction">1. Introduction</h2>
<div class="sectionbody">
<div class="paragraph"><p>SITPLUS is a free software framework whose main goal is to provide
ludic-therapeutic activities for people with multiple disabilities. It offers
new forms of interaction based on computer vision, voice and other peripherals
to produce a result in the form of image and sound. Inspired by the cause and
effect applications, SITPLUS provides a tool for continuous and remote
interaction, attainable to the majority of people with multiple disabilities.</p></div>
</div>
<h2 id="_how_to_install">2. How to install</h2>
<div class="sectionbody">
<h3 id="_requirements">2.1. Requirements</h3><div style="clear:left"></div>
<div class="ulist"><ul>
<li>
<p>
Dual core processor running at 1.5Ghz or higher.
</p>
</li>
<li>
<p>
Sound card and speakers.
</p>
</li>
<li>
<p>
Microphone (optional, for voice based interaction).
</p>
</li>
<li>
<p>
Web camera (high quality webcam recommended).
</p>
</li>
<li>
<p>
Wii Remote + Bluetooth adapter (optional, for Wii Remote based interaction).
</p>
</li>
<li>
<p>
(Optional but recommended.) Good quality sound system and secondary display
or projector.
</p>
</li>
<li>
<p>
Pure Data (pd) extendend version (pd-extended)
</p>
</li>
<li>
<p>
Supported operating systems:
</p>
<div class="ulist"><ul>
<li>
<p>
Microsoft Windows XP SP3/Vista/7
</p>
</li>
<li>
<p>
GNU/Linux
</p>
</li>
</ul></div>
</li>
</ul></div>
<h3 id="_installation_process">2.2. Installation process</h3><div style="clear:left"></div>
<div class="paragraph"><p>You can download the latest SITPLUS version from
<a href="http://sitplus.appctarragona.org">SITPLUS website</a>. A Windows installation
package is provided. For GNU/Linux you might need to fetch the sources and
compile them.</p></div>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
Before installing SITPLUS first uninstall any previous version.
</p>
</li>
<li>
<p>
Install Pure Data (pd).
</p>
<div class="ulist"><ul>
<li>
<p>
<strong>Windows.</strong> Download and install <strong>with the default options</strong>
<a href="http://downloads.sourceforge.net/pure-data/Pd-0.41.4-extended.exe">Pd-extended</a>
</p>
</li>
<li>
<p>
<strong>GNU/Linux.</strong> Major distributions provide pre-compiled pd packages.
Unfortunately, most pd packages do not provide all required components
(externals in pd jargon) which are required by SITPLUS and thus voice based
activities are currently unsupported.
</p>
</li>
</ul></div>
</li>
<li>
<p>
Install SITPLUS.
</p>
</li>
</ol></div>
</div>
<h2 id="_running_sitplus">3. Running SITPLUS</h2>
<div class="sectionbody">
<div class="paragraph"><p>Before running SITPLUS make sure that the required devices such as sound input
(i.e. a microphone) and output, web camera, Wii Remote, etc. are already
installed and work properly. Set also the system sound volume (both for
recording and playback) accordingly.</p></div>
<div class="paragraph"><p>Once started check the configuration options under the <em>'<em>Configuration</em>'</em>
menu. To use a Wii Remote you must pair it with the computer, check
<a href="#wii-remote-configuration">Wii Remote Configuration</a> for further details.
Check also how to configure Pure Data. <a href="#pd-config">Pure Data Configuration</a>.</p></div>
<div class="paragraph"><p>Currently, activities can be started either by choosing <em>'<em>Start&#8230;</em>'</em> or
<em>'<em>Load file&#8230;</em>'</em> under the <em>'<em>Activity</em>'</em> menu. The former option allows to
select which input channels to use (camera, voice and/or Wii Remote) before
starting one of the built-in the activities. The later option allows to load a
.sp file (some .sp files are provided under sp/ folder).</p></div>
<h3 id="built-in-activities">3.1. Built-in activities</h3><div style="clear:left"></div>
<div class="paragraph"><p>Although SITPLUS is conceived as a framework which allows for several ways
of customization, it currently provides some built-in activities which combine
different input methods (camera tracker, voice input and Wii Remote based
motion sensing) with real-time MIDI sound generation and a graphical collage.</p></div>
<div class="imageblock">
<div class="content">
<img src="images/activity.png" alt="Activity screenshot" />
</div>
<div class="image-title">Figure 1: Activity screenshot</div>
</div>
<div class="paragraph"><p>The screenshot depicts an activity which combines the use of the three input
channels is shown. Using this activity the user can play a MIDI musical score
though the motion picked up using the camera and/or a wiimote.
Motion is also use to make the graphical collage evolve. At the same time,
the user&#8217;s voice is also picked up, processed using the chosen effects and
played it back to the loudspeakers. Moreover, user&#8217;s voice also makes the
collage evolve.</p></div>
<div class="paragraph"><p>The window is organized in three main areas:</p></div>
<div class="ulist"><ul>
<li>
<p>
The left area holds input channel options organized in a notebook.
</p>
</li>
<li>
<p>
The central area shows the MIDI sequencer.
</p>
</li>
<li>
<p>
The right area holds the graphical output controls.
</p>
</li>
</ul></div>
</div>
<h2 id="_configuration">4. Configuration</h2>
<div class="sectionbody">
<h3 id="midi-configuration">4.1. MIDI Output Configuration</h3><div style="clear:left"></div>
<div class="paragraph"><p>To set up the MIDI output to use, select <em>'Configuration</em>' and then <em>'MIDI
Out&#8230;</em>'. The configuration dialogue allows to choose and test a MIDI device.</p></div>
<div class="paragraph"><p>If you do not have an external MIDI module attached to your computer or a
similar device (which is the most common scenario), you need a software
synthesizer in order to play MIDI sounds.</p></div>
<div class="paragraph"><p><strong>Windows</strong> ships a software synthesizer called "Microsoft GS Wavetable Synth".
TIP: to reduce the latency of this synthesizer take a look
<a href="http://ocremix.org/forums/showthread.php?t=23223">here</a>.</p></div>
<div class="paragraph"><p>On <strong>GNU/Linux</strong> most distributions provide binary packages for an high quality
MIDI synthesizer called TiMidity++.</p></div>
<div class="paragraph"><p>To install TiMidity++ on Debian/Ubuntu run:</p></div>
<div class="literalblock">
<div class="content">
<pre><tt>sudo apt-get install timidity freepats</tt></pre>
</div></div>
<div class="paragraph"><p>TODO: <a href="http://ubuntuforums.org/showthread.php?t=789578">http://ubuntuforums.org/showthread.php?t=789578</a>
<a href="http://www.pulseaudio.org/wiki/PerfectSetup">http://www.pulseaudio.org/wiki/PerfectSetup</a></p></div>
<h3 id="wii-remote-configuration">4.2. Wii Remote Configuration</h3><div style="clear:left"></div>
<div class="paragraph"><p>To be able to connect a Wii Remote device (aka wiimote) - currently the
standard Wii Remote (also with Motion Plus) and the Balance Board are
supported - you need a bluetooth adapter. The configuration of such device is
beyond the scope of this manual.</p></div>
<div class="paragraph"><p>On Windows you first need to pair you wiimote with the computer, see
<a href="#pairing-wiimote">Pairing the wiimote</a>.</p></div>
<div class="paragraph"><p>To check if the wiimote is properly detected access Configuration &#8594; Wii
Remotes and press the &#8220;Reconnect&#8221; button (on GNU/Linux you might need to
simultaneously press buttons &#8220;1&#8221; and &#8220;2&#8221; on the wiimote before
reconnecting). Once connected the wiimote will rumble and the dialogue will
be updated.</p></div>
<div class="imageblock">
<div class="content">
<img src="images/wiimotesconfig.png" alt="Wii remote screenshot" />
</div>
<div class="image-title">Figure 2: Wii remotes configuration screenshot</div>
</div>
<h4 id="pairing-wiimote">4.2.1. Pairing the wiimote (Windows only)</h4>
<div class="paragraph"><p>The basic steps are:</p></div>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
Open the Bluetooth Device configuration. Depending on your Windows version
you will find the Bluetooth icon in the Windows control panel or in the task
bar. A list containing the currently paired devices will appear.
</p>
</li>
<li>
<p>
Remove any previously paired device.
</p>
</li>
<li>
<p>
Select &#8220;Add new device&#8221; to start searching for available Bluetooth
devices nearby.
</p>
</li>
<li>
<p>
Simultaneously press buttons &#8220;1&#8221; and &#8220;2&#8221; on the wiimote (LEDs will
start flashing, the number of flashing LEDs also tells you the state of
the batteries).
</p>
</li>
<li>
<p>
Select the newly detected device and pair it without using codes.
</p>
</li>
</ol></div>
<div class="paragraph"><p>If the process succeeded, LEDs will keep flashing. Note that after a system
reboot you need to repeat this process again.</p></div>
<div class="paragraph"><p>Sometimes (if the wiimote was not properly shut down) you might need to reset
it by removing the batteries and pressing &#8220;1&#8221; and &#8220;2&#8221; before putting them
into again.</p></div>
<h3 id="pd-config">4.3. Pure Data Configuration</h3><div style="clear:left"></div>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
Open the audio configuration dialogue (Configuration &#8594; Pure Data).
</p>
</li>
<li>
<p>
Once opened you should hear a continuous sound. If no sound is present
make sure you have previously closed other applications dealing with sound
(e.g. media players, web browsers, etc.) and that system sound settings are
properly set. <strong>NOTE:</strong> on Windows Vista/7 it is advised to <strong>not to use</strong> ASIO
drivers on Pure Data, otherwise MIDI sound won&#8217;t work. For further information
about Pure Data check <a href="http://crca.ucsd.edu/~msp/Pd_documentation/">Pd
documentation</a>.
</p>
</li>
<li>
<p>
Set &#8220;Delay&#8221; to the minimum possible value before you get sound defects.
You can also check if the microphone works properly by selecting
&#8220;Microphone&#8221;.
</p>
</li>
</ol></div>
<div class="imageblock">
<div class="content">
<img src="images/pdconfig.png" alt="PD configuration dialogue" />
</div>
<div class="image-title">Figure 3: PD configuration dialogue screenshot</div>
</div>
</div>
<h2 id="_customization">5. Customization</h2>
<div class="sectionbody">
<div class="paragraph"><p>SITPLUS allows different ways of customization ranging from creating new
musical scores or graphical collages to developing your own components.</p></div>
<div class="paragraph"><p>What can be customized?</p></div>
<div class="ulist"><ul>
<li>
<p>
<strong>Musical scores.</strong> The <tt>scores/</tt> directory contains musical scores that the
currently provided activities use. To add new scores simply copy the file
containing the new score to this directory. The score file format is quite
simple. It consist on a text file where each line contains up to 4 notes
(each note is represented by its MIDI number). Optionally the first line might
contain the word <tt>percussion</tt> to select the percussion kit.
</p>
</li>
<li>
<p>
<strong>Graphical collages.</strong> The <tt>graphics/mod_collage_xml/</tt> directory contains a
collection of collage definition files. These are XML files which describe the
behaviour and contents of the graphical collages. See
<a href="mod_collage_xml_help.html">Structure of XML file for mod_collage</a> for
a detailed description.  Under <tt>graphics/mod_collage_xml/</tt>
there are two folders:
</p>
<div class="ulist"><ul>
<li>
<p>
<tt>activities/</tt>: it holds the activities which will be draw in the
foreground.
</p>
</li>
<li>
<p>
<tt>backgrounds/</tt>: contains the background definitions.
</p>
</li>
</ul></div>
</li>
<li>
<p>
<strong>Activities.</strong> The activity definitions can be found under the <tt>sp/</tt>
directory. It contains scripts whose format is specified in <a href="activities.html">SITPLUS script syntax</a>.
</p>
</li>
</ul></div>
</div>
<h2 id="_information_for_developers">6. Information for developers</h2>
<div class="sectionbody">
<div class="paragraph"><p>SITPLUS is built around a core C++ library (spcore) which provides basic
services such as module loading, component instantiation, basic types and
internalization among others, and base classes to develop new components.</p></div>
<div class="paragraph"><p>The basic building block is the component (IComponent interface). A component
is a processing unit which provides input and/or output pins and an optional
UI panel. Components can be arranged in a composite and its pins can be
connected to build data-flow oriented applications.</p></div>
<div class="paragraph"><p>Along with with the core, two helper libraries are also provided:</p></div>
<div class="ulist"><ul>
<li>
<p>
sphost: provides some helper functions and classes to develop final
applications. It provides, for instance, a script parser to ease the creation
of component composites.
</p>
</li>
<li>
<p>
widgets_base: provides UI base classes
</p>
</li>
</ul></div>
<div class="paragraph"><p>Finally, several modules are also provided:</p></div>
<div class="ulist"><ul>
<li>
<p>
mod_camera: components and types to deal with camera capture.
</p>
</li>
<li>
<p>
mod_io: components for file I/O.
</p>
</li>
<li>
<p>
mod_midi: components and types for MIDI output.
</p>
</li>
<li>
<p>
mod_sdl: components and types to draw on SDL surfaces.
</p>
</li>
<li>
<p>
mod_vision: components for computer vision.
</p>
</li>
<li>
<p>
mod_widgets: UI components such as buttons, combo boxes, etc.
</p>
</li>
<li>
<p>
mod_wiimotes: components and types to use Wii remotes
</p>
</li>
</ul></div>
<div class="paragraph"><p>One of the goals of SITPLUS is to become GUI toolkit agnostic. Currently
it uses wxWidgets and most modules provide UI panels based on this toolkit,
but the core itself has not an strong dependency (component&#8217;s method GetGUI
expects wxWindows types though this is easily changeable by just defining a
neutral window type, the core itself provides methods such as InitGUISupport,
RunMessageLoop and CleanupGUISupport which are based on wx).</p></div>
<div class="paragraph"><p>(This section is a draft and needs to be extended).</p></div>
</div>
<h2 id="_project_origin">7. Project origin</h2>
<div class="sectionbody">
<div class="paragraph"><p>SITPLUS was born as a research project in the Cerebral Palsy Centre
<a href="http://www.appctarragona.org/">APPC</a> of Tarragona (Spain) in collaboration
with <a href="http://www.crea-si.com">CREA Software Systems</a> and others.
SITPLUS is the result of more than three years of research,
development and direct intervention with people with cerebral palsy in
the APPC. Inspired by the cause and effect applications, SITPLUS
provides a tool for continuous and remote interaction, attainable to the
 majority of people with multiple disabilities. It was conceived in the
APPC in late 2007 to try to provide a tool to the group of people whose
combination of motor, cognitive and even sensory limitations prevented
them from accessing other commonly used tools. Experimental sessions,
conducted in the laboratory that the APPC has devoted to this project,
show that this tool not only promotes participation, engagement and play
for many people with moderate to severe impairments, but is also very
motivating for users with mild impairments.</p></div>
<div class="imageblock">
<div class="content">
<img src="images/sitpluslab.jpg" alt="SITPLUS laboratory in the APPC" />
</div>
</div>
<div class="paragraph"><p>Although SITPLUS focuses on people with cerebral palsy, we believe
that it could benefit other people with cognitive disabilities.
Moreover, it can also be useful as a platform for game or interactive
music and visual arts research. Indeed, SITPLUS is conceived as an
application framework in which several activities using resources run.
We call resources things like input sound analysis, computer vision
based motion tracking, drawing and sound generation algorithms, and so
on. We call activities these pieces of software that employ resources to
do something useful (e.g. let someone interact in some way). The idea
behind this model is to allow reusing those components to provide rich
interactive scenarios whilst keeping simple its further development and
usage.</p></div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2011-10-14 21:24:16 CEST
</div>
</div>
</body>
</html>
sitplus-data 1.0.3-5.1 / usr / share / sitplus / doc / manual.html
