blob: 9d9498fb033428ec1b4b7acb9aa63f65bd65412b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
<refentry id="xscanmap">
<indexterm id="IndexXscanmap"><primary>xscanmap</primary></indexterm>
<refentryinfo><title>Signal Generators:Scanned Synthesis</title></refentryinfo>
<refmeta>
<refentrytitle>xscanmap</refentrytitle>
</refmeta>
<refnamediv>
<refname>xscanmap</refname>
<refpurpose>
Allows the position and velocity of a node in a scanned process to be read.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<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>xscanmap</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>Credits</title>
<para>Author: &namejohn;</para>
<para>New in version 4.20</para>
</refsect1>
</refentry>
|