document scan(s)map

csound · Jan 7, 2022 · 952d511 · 952d511
1 parent b6c2161
commit 952d511
Show file tree

Hide file tree

Showing 6 changed files with 165 additions and 0 deletions.
diff --git a/manual.xml b/manual.xml
@@ -1225,7 +1225,9 @@
 <!ENTITY opcodesscale2 SYSTEM "opcodes/scale2.xml">
 <!ENTITY opcodesscalearray SYSTEM "opcodes/scalearray.xml">
 <!ENTITY opcodesscanhammer SYSTEM "opcodes/scanhammer.xml">
+<!ENTITY opcodesscanmap SYSTEM "opcodes/scanmap.xml">
 <!ENTITY opcodesscans SYSTEM "opcodes/scans.xml">
+<!ENTITY opcodesscansmap SYSTEM "opcodes/scansmap.xml">
 <!ENTITY opcodesscantable SYSTEM "opcodes/scantable.xml">
 <!ENTITY opcodesscanu SYSTEM "opcodes/scanu.xml">
 <!ENTITY opcodesscanu2 SYSTEM "opcodes/scanu2.xml">

diff --git a/misc/examples.xml b/misc/examples.xml
@@ -281,6 +281,7 @@
 </formalpara>
 <formalpara><title>Signal Generators:Scanned Synthesis</title><simpara />
 <para><ulink url="examples/scanhammer.csd"><citetitle>scanhammer.csd</citetitle></ulink></para><simpara />
+<para><ulink url="examples/scanmap.csd"><citetitle>scanmap.csd</citetitle></ulink></para><simpara />
 <para><ulink url="examples/scans.csd"><citetitle>scans.csd</citetitle></ulink></para><simpara />
 <para><ulink url="examples/scans-2.csd"><citetitle>scans-2.csd</citetitle></ulink></para><simpara />
 <para><ulink url="examples/scantable.csd"><citetitle>scantable.csd</citetitle></ulink></para><simpara />

diff --git a/misc/quickref.xml b/misc/quickref.xml
@@ -391,7 +391,9 @@
 <para>
 <para/>
 <synopsis><link linkend="scanhammer">scanhammer</link> isrc, idst, ipos, imult</synopsis><para/>
+<synopsis>kpos, kvel <link linkend="scanmap">scanmap</link> iscan, kamp, kvamp [, iwhich]</synopsis><para/>
 <synopsis>ares <link linkend="scans">scans</link> kamp, kfreq, ifn, id [, iorder]</synopsis><para/>
+<synopsis><link linkend="scansmap">scansmap</link> kpos, kvel, iscan, kamp, kvamp [, iwhich]</synopsis><para/>
 <synopsis>aout <link linkend="scantable">scantable</link> kamp, kpch, ipos, imass, istiff, idamp, ivel</synopsis><para/>
 <synopsis><link linkend="scanu">scanu</link> init, irate, ifndisplace,
     ifnmass, ifnmatrix, ifncentr, ifndamp, kmass, kmtrxstiff, kcentr,

diff --git a/opcodes/scanmap.xml b/opcodes/scanmap.xml
@@ -0,0 +1,82 @@
+
+<refentry id="scanmap">
+<indexterm id="IndexScanmap"><primary>scanmap</primary></indexterm>
+  <refentryinfo><title>Signal Generators:Scanned Synthesis</title></refentryinfo>
+  <refmeta>
+    <refentrytitle>scanmap</refentrytitle>
+  </refmeta>
+
+
+
+  <refnamediv>
+    <refname>scanmap</refname>
+    <refpurpose>
+      Allows the position and velocity of a node in a scanned process to be read.
+          </refpurpose>
+  </refnamediv>
+
+  <refsect1>
+    <title>Description</title>
+    <para>Plugin opcode in scansyn.</para>
+    <para>
+      Allows the position and velocity of a node in a scanned process to be read.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>Syntax</title>
+    <synopsis>kpos, kvel <command>scanmap</command> iscan, kamp, kvamp [, iwhich]</synopsis>
+  </refsect1>
+
+  <refsect1>
+    <title>Initialization</title>
+    <para>
+      <emphasis>iscan</emphasis> -- which scan process to read
+    </para>
+
+    <para>
+      <emphasis>iwhich</emphasis> (optional) -- which node to sense. The default is 0.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>Performance</title>
+    <para>
+      <emphasis>kamp</emphasis> -- amount to amplify the <emphasis>kpos</emphasis> value.
+    </para>
+
+    <para>
+      <emphasis>kvamp</emphasis> -- amount to amplify the <emphasis>kvel</emphasis> value.
+    </para>
+
+    <para>
+      The internal state of a node is read. This includes its position and velocity. They are amplified by the <emphasis>kamp</emphasis> and <emphasis>kvamp</emphasis> values.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>Examples</title>
+    <para>
+      Here is an example of the scanmap opcode. It uses the file <ulink url="examples/scanmap.csd"><citetitle>scanmap.csd</citetitle></ulink>.
+      <example>
+        <title>Example of the scanmap opcode.</title>
+        <para>See the sections <link linkend="UsingRealTime"><citetitle>Real-time Audio</citetitle></link> and <link linkend="CommandFlags"><citetitle>Command Line Flags</citetitle></link> for more information on using command line flags.</para>
+          <xi:include href="examples-xml/scanmap.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+      </example>
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+        <para>
+More information on Scanned Synthesis (as well as several other matrices) is available on the <ulink url="http://www.csounds.com/scanned/"><citetitle>Scanned Synthesis page</citetitle></ulink> at cSounds.com.
+    </para>
+        <para> Also an article on these opcodes: <ulink url="http://www.csounds.com/stevenyi/scanned/yi_scannedSynthesis.html"><citetitle>http://www.csounds.com/stevenyi/scanned/yi_scannedSynthesis.html</citetitle></ulink>  , written by Steven Yi </para>
+  </refsect1>
+
+  <refsect1>
+    <title>Credits</title>
+    <para>Author: &namejohn;</para>
+    <para>New in version 4.20</para>
+  </refsect1>
+</refentry>
diff --git a/opcodes/scansmap.xml b/opcodes/scansmap.xml
@@ -0,0 +1,76 @@
+
+<refentry id="scansmap">
+<indexterm id="IndexScansmap"><primary>scansmap</primary></indexterm>
+  <refentryinfo><title>Signal Generators:Scanned Synthesis</title></refentryinfo>
+  <refmeta>
+    <refentrytitle>scansmap</refentrytitle>
+  </refmeta>
+
+  <refnamediv>
+    <refname>scansmap</refname>
+    <refpurpose>
+      Allows the position and velocity of a node in a scanned process to be read.
+    </refpurpose>
+  </refnamediv>
+
+  <refsect1>
+    <title>Description</title>
+    <para>Plugin opcode in scansyn.</para>
+    <para>
+      Allows the position and velocity of a node in a scanned process to be read.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>Syntax</title>
+    <synopsis><command>scansmap</command> kpos, kvel, iscan, kamp, kvamp [, iwhich]</synopsis>
+  </refsect1>
+
+  <refsect1>
+    <title>Initialization</title>
+    <para>
+      <emphasis>iscan</emphasis> -- which scan process to read
+    </para>
+
+    <para>
+      <emphasis>iwhich</emphasis> (optional) -- which node to sense. The default is 0.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>Performance</title>
+    <para>
+      <emphasis>kpos</emphasis> -- the node's position.
+    </para>
+
+    <para>
+      <emphasis>kvel</emphasis> -- the node's velocity.
+    </para>
+
+    <para>
+      <emphasis>kamp</emphasis> -- amount to amplify the <emphasis>kpos</emphasis> value.
+    </para>
+
+    <para>
+      <emphasis>kvamp</emphasis> -- amount to amplify the <emphasis>kvel</emphasis> value.
+    </para>
+
+    <para>
+      The internal state of a node is read. This includes its position and velocity. They are amplified by the <emphasis>kamp</emphasis> and <emphasis>kvamp</emphasis> values.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+        <para>
+More information on Scanned Synthesis (as well as several other matrices) is available on the <ulink url="http://www.csounds.com/scanned/"><citetitle>Scanned Synthesis page</citetitle></ulink> at cSounds.com.
+    </para>
+        <para> Also an article on these opcodes: <ulink url="http://www.csounds.com/stevenyi/scanned/yi_scannedSynthesis.html"><citetitle>http://www.csounds.com/stevenyi/scanned/yi_scannedSynthesis.html</citetitle></ulink>  , written by Steven Yi </para>
+  </refsect1>
+
+  <refsect1>
+    <title>Credits</title>
+    <para>New in version 4.21</para>
+    <para>November 2002. Thanks to &namerasmus; for pointing this opcode out.</para>
+  </refsect1>
+</refentry>
diff --git a/opcodes/top.xml b/opcodes/top.xml
@@ -978,7 +978,9 @@
   &opcodesscale2;
   &opcodesscalearray;
   &opcodesscanhammer;
+  &opcodesscanmap;
   &opcodesscans;
+  &opcodesscansmap;
   &opcodesscantable;
   &opcodesscanu;
   &opcodesscanu2;