Revision: 62173
http://sourceforge.net/p/brlcad/code/62173
Author: carlmoore
Date: 2014-08-15 16:33:32 +0000 (Fri, 15 Aug 2014)
Log Message:
-----------
increase use of <command>, but switch to underscore if I am referring to an
argument name
Modified Paths:
--------------
brlcad/trunk/doc/docbook/system/man1/en/anim_script.xml
brlcad/trunk/doc/docbook/system/man1/en/anim_sort.xml
brlcad/trunk/doc/docbook/system/man1/en/anim_time.xml
brlcad/trunk/doc/docbook/system/man1/en/anim_track.xml
brlcad/trunk/doc/docbook/system/man1/en/anim_turn.xml
Modified: brlcad/trunk/doc/docbook/system/man1/en/anim_script.xml
===================================================================
--- brlcad/trunk/doc/docbook/system/man1/en/anim_script.xml 2014-08-15
15:43:31 UTC (rev 62172)
+++ brlcad/trunk/doc/docbook/system/man1/en/anim_script.xml 2014-08-15
16:33:32 UTC (rev 62173)
@@ -32,28 +32,28 @@
<refsect1 xml:id='description'><title>DESCRIPTION</title>
-<para><emphasis remap='I'>Anim_script</emphasis>
+<para><command>anim_script</command>
is designed to produce an animation script for the
animation of the virtual camera or one
<emphasis remap='I'>brlcad</emphasis>
object at a time. It is
complementary to
-<emphasis remap='I'>tabsub</emphasis>
+<command>tabsub</command>
in that it performs a similar
function, but with a different philosophy.</para>
<para>Both
<command>anim_script</command>
and
-<emphasis remap='I'>tabsub</emphasis>
+<command>tabsub</command>
use one row of an animation table to
produce one frame of an animation script. With
-<emphasis remap='I'>tabsub,</emphasis>
+<command>tabsub</command>,
the user supplies
a template file which controls the form of the animation frames. This
allows the maximum user control, but also requires a good understanding
of the script format. With
-<emphasis remap='I'>anim_script,</emphasis>
+<command>anim_script</command>,
the user supplies all the necessary
information on the command line. The range of possible output scripts is
limited, but the user does not have to deal directly with the details.
@@ -69,7 +69,7 @@
"hatch1"
is a member of "turret" which is a member of "tank" which is one of the
objects specified on the command line of the call to
-<emphasis remap='I'>rt,</emphasis>
+<command>rt</command>,
then the objectname "tank/turret/hatch1" or simply "turret/hatch1" would be
used to
animate the hatch. The tank itself would be referred to by the name,
"/tank". Note that top-level objects should be preceded by a slash.
@@ -130,16 +130,16 @@
<para>Permuted orientation. This option indicates that transformations defined
by
the quaternions should be applied to an object which has first been placed
in
-<emphasis remap='I'>rt</emphasis>'s
+<command>rt</command>'s
default eye orientation. Thus, the identity quaternion represents yawing the
object 90 degrees to the left and then pitching it 90 degrees downward.
The quaternions produced by
-<emphasis remap='I'>mged</emphasis>'s
+<command>mged</command>'s
saveview command and used by
-<emphasis remap='I'>rt</emphasis>'s
+<command>rt</command>'s
orientation command
are quaternions of this type. See
-<emphasis remap='I'>anim_orient</emphasis>
+<command>anim_orient</command>
for more information.</para>
</listitem>
</varlistentry>
Modified: brlcad/trunk/doc/docbook/system/man1/en/anim_sort.xml
===================================================================
--- brlcad/trunk/doc/docbook/system/man1/en/anim_sort.xml 2014-08-15
15:43:31 UTC (rev 62172)
+++ brlcad/trunk/doc/docbook/system/man1/en/anim_sort.xml 2014-08-15
16:33:32 UTC (rev 62173)
@@ -29,13 +29,13 @@
<para>Note:
<command>anim_sort</command>
has been preempted in release 5.0 by
-<emphasis remap='I'>scriptsort</emphasis>,
+<command>scriptsort</command>,
which sorts scripts much faster.</para>
-<para><emphasis remap='I'>Anim_sort</emphasis>
+<para><command>anim_sort</command>
allows the user to combine several animation scripts
into a single script suitable for input to
-<emphasis remap='I'>rt</emphasis>.
+<command>rt</command>.
A convenient way to
prepare a complicated animation script is to develop each part
separately and then use
@@ -68,13 +68,13 @@
<para>Each of the input files to be concatenated is expected to be a
viable
-<emphasis remap='I'>rt</emphasis>
+<command>rt</command>
animation script, containing a series of frames of the
following form:</para>
<literallayout remap='.nf'>
start framenumber;
-any number of semi-colon terminated commands for rt;
+any number of semi-colon terminated commands for <command>rt</command>;
end;
any number of post-raytracing commands
</literallayout> <!-- .fi -->
Modified: brlcad/trunk/doc/docbook/system/man1/en/anim_time.xml
===================================================================
--- brlcad/trunk/doc/docbook/system/man1/en/anim_time.xml 2014-08-15
15:43:31 UTC (rev 62172)
+++ brlcad/trunk/doc/docbook/system/man1/en/anim_time.xml 2014-08-15
16:33:32 UTC (rev 62173)
@@ -43,7 +43,7 @@
control the assumptions on the object's initial and final speeds, and the
form of the output.</para>
-<para><emphasis remap='I'>Anim_time</emphasis>
+<para><command>anim_time</command>
is intended to be used in situations where the user knows what key points
an object should pass through and how long the entire motion should take,
but doesn't care exactly when the object
Modified: brlcad/trunk/doc/docbook/system/man1/en/anim_track.xml
===================================================================
--- brlcad/trunk/doc/docbook/system/man1/en/anim_track.xml 2014-08-15
15:43:31 UTC (rev 62172)
+++ brlcad/trunk/doc/docbook/system/man1/en/anim_track.xml 2014-08-15
16:33:32 UTC (rev 62173)
@@ -38,8 +38,8 @@
first and last wheels, any extra track length is taken up in a hanging
catenary arc.</para>
-<para>anim_track requires two input files. The first, referred to above as
-<emphasis remap='B'>wheelfile</emphasis>,
+<para><command>anim_track</command> requires two input files. The first,
referred to above as
+<emphasis remap='I'>wheelfile</emphasis>,
is a table which
defines the initial track geometry by describing the wheels around which
the track is to be wrapped. The first three columns of the table give
@@ -58,7 +58,7 @@
variation; that is, the wheels can be in front of, behind, above, and
below each other, but may not be to the left or right of each other. If
the wheel positions specified in
-<emphasis remap='B'>wheelfile</emphasis>
+<emphasis remap='I'>wheelfile</emphasis>
do not lie in such a plane, then the first wheel defines the plane into
which all of the other wheels are projected.</para>
@@ -67,9 +67,9 @@
segment between the first and last wheels. If there is any extra track
length, it is taken up in a catenary arc which hangs down between the
first and last wheels. Thus if the first wheel in
-<emphasis remap='B'>wheelfile</emphasis>
+<emphasis remap='I'>wheelfile</emphasis>
should be the top front wheel of the vehicle, and the last wheel in
-<emphasis remap='B'>wheelfile</emphasis>
+<emphasis remap='I'>wheelfile</emphasis>
should be the top back wheel of the vehicle. Depending on the track
length mode specified with the
<option>-l</option>
@@ -78,7 +78,7 @@
<para>The second input file required by
<command>anim_track</command>,
referred to above as
-<emphasis remap='B'>in.table</emphasis>,
+<emphasis remap='I'>in.table</emphasis>,
describes the state of the track in every frame of the animation. The
format of this second file can vary greatly according to the command-line
options. The first column of the file is ignored, but is expected to
@@ -158,7 +158,7 @@
<para>Animate the track wheels. This option takes one argument: a
slash-separated path to the wheel basename. The number of wheels is
obtained from the number of lines in the
-<emphasis remap='B'>wheelfile</emphasis>.
+<emphasis remap='I'>wheelfile</emphasis>.
If there is, for example, a combination named "rwheels" containing 4
wheels named wheel_0, wheel_1, wheel_2, and wheel_3, then the correct
argument is:</para>
@@ -205,14 +205,14 @@
should contain the position and orientation of the vehicle in every
frame. The distance that the track should be rolled around the wheels is
automatically calculated in every frame. If
-<emphasis remap='I'>anim_script</emphasis>
+<command>anim_script</command>
is being used with the same table to create the animation script for the
vehicle itself, the
<option>-b</option>
and
<option>-d</option>
options to
-<emphasis remap='I'>anim_script</emphasis>
+<command>anim_script</command>
and
<command>anim_track</command>
should be the same.</para>
@@ -229,14 +229,14 @@
calculated in every frame, based on the assumption that the vehicle is
always steered to face the direction of motion.
If
-<emphasis remap='I'>anim_script</emphasis>
+<command>anim_script</command>
is being used with the same table to create the animation script for the
vehicle itself, the
<option>-b</option>
and
<option>-d</option>
options to
-<emphasis remap='I'>anim_script</emphasis>
+<command>anim_script</command>
and
<command>anim_track</command>
should be the same.</para>
@@ -348,7 +348,7 @@
<listitem>
<para>Specify the common radius of all the wheels. In this case, the fourth
column
should be omitted from the
-<emphasis remap='B'>wheelfile</emphasis>.</para>
+<emphasis remap='I'>wheelfile</emphasis>.</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -369,7 +369,7 @@
<para>Specify the animation matrix command to apply to the pads. The default
value is "rarc", meaning that the matrix between the pad and its parent
is replaced by a new matrix. See the
-<emphasis remap='I'>anim_script</emphasis>
+<command>anim_script</command>
man page for more information.</para>
</listitem>
</varlistentry>
@@ -379,7 +379,7 @@
<para>Specify the animation matrix command to apply to the wheels. The default
value is "lmul", meaning that the new matrix is multiplied onto the left
of the old matrix between the pad and its parent combination. See the
-<emphasis remap='I'>anim_script</emphasis>
+<command>anim_script</command>
man page for more information.</para>
</listitem>
@@ -396,7 +396,7 @@
the tank and its orientation at each time. You also need to obtain the
position of the each wheel relative to the vehicle center at each time.
All of this information is placed in
-<emphasis remap='B'>in.table</emphasis>
+<emphasis remap='I'>in.table</emphasis>
. The model of the tank is stored in
model.g as a combination named "tank". Its centroid is at the
point (0,0,1005) and it faces the y-axis. An animation script for the
@@ -422,7 +422,7 @@
through "rpad.95", and grouped together in a combination called
"rtrack".</para>
<para>Now, a file called
-<emphasis remap='B'>rwheelfile</emphasis>
+<emphasis remap='I'>rwheelfile</emphasis>
is created, describing the positions and radii of the four wheels in the
right track:</para>
Modified: brlcad/trunk/doc/docbook/system/man1/en/anim_turn.xml
===================================================================
--- brlcad/trunk/doc/docbook/system/man1/en/anim_turn.xml 2014-08-15
15:43:31 UTC (rev 62172)
+++ brlcad/trunk/doc/docbook/system/man1/en/anim_turn.xml 2014-08-15
16:33:32 UTC (rev 62173)
@@ -76,7 +76,7 @@
table would contain four columns: time, swivel-angle, roll, and a zero
channel. These represent the orientation of the front wheels, in terms
of yaw, pitch, and roll, and the table can be piped directly to
-<emphasis remap='I'>anim_script</emphasis>.</para>
+<command>anim_script</command>.</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -85,7 +85,7 @@
<para>Specify a factor to be used to animate a steering wheel. If this option
is selected, the output table will contain four columns: time, swivel,
and two zero columns. This table can be used directly by
-<emphasis remap='I'>anim_script</emphasis>
+<command>anim_script</command>
to make an animation script for a steering wheel. The argument to the
option should be the factor by which to exaggerate the swiveling of
the wheels. For
@@ -106,7 +106,7 @@
with a high number of input rows and reduce the output with the
<option>-p#</option>
option. For example, if
-<emphasis remap='B'>in.table</emphasis>
+<emphasis remap='I'>in.table</emphasis>
contains 30 rows for each second of the
animation, then the command</para>
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
_______________________________________________
BRL-CAD Source Commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-commits
