Skip to content

Commit 952d511

Browse files
jpffitchjpffitch
committed
document scan(s)map
1 parent b6c2161 commit 952d511

File tree

6 files changed

+165
-0
lines changed

6 files changed

+165
-0
lines changed

‎manual.xml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1225,7 +1225,9 @@
12251225
<!ENTITY opcodesscale2 SYSTEM "opcodes/scale2.xml">
12261226
<!ENTITY opcodesscalearray SYSTEM "opcodes/scalearray.xml">
12271227
<!ENTITY opcodesscanhammer SYSTEM "opcodes/scanhammer.xml">
1228+
<!ENTITY opcodesscanmap SYSTEM "opcodes/scanmap.xml">
12281229
<!ENTITY opcodesscans SYSTEM "opcodes/scans.xml">
1230+
<!ENTITY opcodesscansmap SYSTEM "opcodes/scansmap.xml">
12291231
<!ENTITY opcodesscantable SYSTEM "opcodes/scantable.xml">
12301232
<!ENTITY opcodesscanu SYSTEM "opcodes/scanu.xml">
12311233
<!ENTITY opcodesscanu2 SYSTEM "opcodes/scanu2.xml">

‎misc/examples.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -281,6 +281,7 @@
281281
</formalpara>
282282
<formalpara><title>Signal Generators:Scanned Synthesis</title><simpara />
283283
<para><ulink url="examples/scanhammer.csd"><citetitle>scanhammer.csd</citetitle></ulink></para><simpara />
284+
<para><ulink url="examples/scanmap.csd"><citetitle>scanmap.csd</citetitle></ulink></para><simpara />
284285
<para><ulink url="examples/scans.csd"><citetitle>scans.csd</citetitle></ulink></para><simpara />
285286
<para><ulink url="examples/scans-2.csd"><citetitle>scans-2.csd</citetitle></ulink></para><simpara />
286287
<para><ulink url="examples/scantable.csd"><citetitle>scantable.csd</citetitle></ulink></para><simpara />

‎misc/quickref.xml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -391,7 +391,9 @@
391391
<para>
392392
<para/>
393393
<synopsis><link linkend="scanhammer">scanhammer</link> isrc, idst, ipos, imult</synopsis><para/>
394+
<synopsis>kpos, kvel <link linkend="scanmap">scanmap</link> iscan, kamp, kvamp [, iwhich]</synopsis><para/>
394395
<synopsis>ares <link linkend="scans">scans</link> kamp, kfreq, ifn, id [, iorder]</synopsis><para/>
396+
<synopsis><link linkend="scansmap">scansmap</link> kpos, kvel, iscan, kamp, kvamp [, iwhich]</synopsis><para/>
395397
<synopsis>aout <link linkend="scantable">scantable</link> kamp, kpch, ipos, imass, istiff, idamp, ivel</synopsis><para/>
396398
<synopsis><link linkend="scanu">scanu</link> init, irate, ifndisplace,
397399
ifnmass, ifnmatrix, ifncentr, ifndamp, kmass, kmtrxstiff, kcentr,

‎opcodes/scanmap.xml‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
2+
<refentry id="scanmap">
3+
<indexterm id="IndexScanmap"><primary>scanmap</primary></indexterm>
4+
<refentryinfo><title>Signal Generators:Scanned Synthesis</title></refentryinfo>
5+
<refmeta>
6+
<refentrytitle>scanmap</refentrytitle>
7+
</refmeta>
8+
9+
10+
11+
<refnamediv>
12+
<refname>scanmap</refname>
13+
<refpurpose>
14+
Allows the position and velocity of a node in a scanned process to be read.
15+
</refpurpose>
16+
</refnamediv>
17+
18+
<refsect1>
19+
<title>Description</title>
20+
<para>Plugin opcode in scansyn.</para>
21+
<para>
22+
Allows the position and velocity of a node in a scanned process to be read.
23+
</para>
24+
</refsect1>
25+
26+
<refsect1>
27+
<title>Syntax</title>
28+
<synopsis>kpos, kvel <command>scanmap</command> iscan, kamp, kvamp [, iwhich]</synopsis>
29+
</refsect1>
30+
31+
<refsect1>
32+
<title>Initialization</title>
33+
<para>
34+
<emphasis>iscan</emphasis> -- which scan process to read
35+
</para>
36+
37+
<para>
38+
<emphasis>iwhich</emphasis> (optional) -- which node to sense. The default is 0.
39+
</para>
40+
</refsect1>
41+
42+
<refsect1>
43+
<title>Performance</title>
44+
<para>
45+
<emphasis>kamp</emphasis> -- amount to amplify the <emphasis>kpos</emphasis> value.
46+
</para>
47+
48+
<para>
49+
<emphasis>kvamp</emphasis> -- amount to amplify the <emphasis>kvel</emphasis> value.
50+
</para>
51+
52+
<para>
53+
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.
54+
</para>
55+
</refsect1>
56+
57+
<refsect1>
58+
<title>Examples</title>
59+
<para>
60+
Here is an example of the scanmap opcode. It uses the file <ulink url="examples/scanmap.csd"><citetitle>scanmap.csd</citetitle></ulink>.
61+
<example>
62+
<title>Example of the scanmap opcode.</title>
63+
<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>
64+
<xi:include href="examples-xml/scanmap.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
65+
</example>
66+
</para>
67+
</refsect1>
68+
69+
<refsect1>
70+
<title>See Also</title>
71+
<para>
72+
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.
73+
</para>
74+
<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>
75+
</refsect1>
76+
77+
<refsect1>
78+
<title>Credits</title>
79+
<para>Author: &namejohn;</para>
80+
<para>New in version 4.20</para>
81+
</refsect1>
82+
</refentry>

‎opcodes/scansmap.xml‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
2+
<refentry id="scansmap">
3+
<indexterm id="IndexScansmap"><primary>scansmap</primary></indexterm>
4+
<refentryinfo><title>Signal Generators:Scanned Synthesis</title></refentryinfo>
5+
<refmeta>
6+
<refentrytitle>scansmap</refentrytitle>
7+
</refmeta>
8+
9+
<refnamediv>
10+
<refname>scansmap</refname>
11+
<refpurpose>
12+
Allows the position and velocity of a node in a scanned process to be read.
13+
</refpurpose>
14+
</refnamediv>
15+
16+
<refsect1>
17+
<title>Description</title>
18+
<para>Plugin opcode in scansyn.</para>
19+
<para>
20+
Allows the position and velocity of a node in a scanned process to be read.
21+
</para>
22+
</refsect1>
23+
24+
<refsect1>
25+
<title>Syntax</title>
26+
<synopsis><command>scansmap</command> kpos, kvel, iscan, kamp, kvamp [, iwhich]</synopsis>
27+
</refsect1>
28+
29+
<refsect1>
30+
<title>Initialization</title>
31+
<para>
32+
<emphasis>iscan</emphasis> -- which scan process to read
33+
</para>
34+
35+
<para>
36+
<emphasis>iwhich</emphasis> (optional) -- which node to sense. The default is 0.
37+
</para>
38+
</refsect1>
39+
40+
<refsect1>
41+
<title>Performance</title>
42+
<para>
43+
<emphasis>kpos</emphasis> -- the node's position.
44+
</para>
45+
46+
<para>
47+
<emphasis>kvel</emphasis> -- the node's velocity.
48+
</para>
49+
50+
<para>
51+
<emphasis>kamp</emphasis> -- amount to amplify the <emphasis>kpos</emphasis> value.
52+
</para>
53+
54+
<para>
55+
<emphasis>kvamp</emphasis> -- amount to amplify the <emphasis>kvel</emphasis> value.
56+
</para>
57+
58+
<para>
59+
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.
60+
</para>
61+
</refsect1>
62+
63+
<refsect1>
64+
<title>See Also</title>
65+
<para>
66+
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.
67+
</para>
68+
<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>
69+
</refsect1>
70+
71+
<refsect1>
72+
<title>Credits</title>
73+
<para>New in version 4.21</para>
74+
<para>November 2002. Thanks to &namerasmus; for pointing this opcode out.</para>
75+
</refsect1>
76+
</refentry>

‎opcodes/top.xml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -978,7 +978,9 @@
978978
&opcodesscale2;
979979
&opcodesscalearray;
980980
&opcodesscanhammer;
981+
&opcodesscanmap;
981982
&opcodesscans;
983+
&opcodesscansmap;
982984
&opcodesscantable;
983985
&opcodesscanu;
984986
&opcodesscanu2;

0 commit comments

Comments
 (0)