[brlcad-commits] SF.net SVN: brlcad:[33076] brlcad/trunk/doc/docbook/system/man1/en
Open Source Solid Modeling CAD
Brought to you by:
brlcad
From: <sta...@us...> - 2008-10-27 16:29:54
|
Revision: 33076 http://brlcad.svn.sourceforge.net/brlcad/?rev=33076&view=rev Author: starseeker Date: 2008-10-27 16:29:47 +0000 (Mon, 27 Oct 2008) Log Message: ----------- Man pages for anim_lookat and anim_offset in docbook, worked on by Janine and Cliff Modified Paths: -------------- brlcad/trunk/doc/docbook/system/man1/en/Makefile.am Added Paths: ----------- brlcad/trunk/doc/docbook/system/man1/en/anim_lookat.xml brlcad/trunk/doc/docbook/system/man1/en/anim_offset.xml Modified: brlcad/trunk/doc/docbook/system/man1/en/Makefile.am =================================================================== --- brlcad/trunk/doc/docbook/system/man1/en/Makefile.am 2008-10-27 15:48:53 UTC (rev 33075) +++ brlcad/trunk/doc/docbook/system/man1/en/Makefile.am 2008-10-27 16:29:47 UTC (rev 33076) @@ -27,6 +27,8 @@ anim_fly.xml \ anim_hardtrack.xml \ anim_keyread.xml \ + anim_lookat.xml \ + anim_offset.xml \ bwscale.xml \ g_qa.xml \ mged.xml \ Added: brlcad/trunk/doc/docbook/system/man1/en/anim_lookat.xml =================================================================== --- brlcad/trunk/doc/docbook/system/man1/en/anim_lookat.xml (rev 0) +++ brlcad/trunk/doc/docbook/system/man1/en/anim_lookat.xml 2008-10-27 16:29:47 UTC (rev 33076) @@ -0,0 +1,156 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "../../../resources/standard/dtd/docbookx.dtd"> + +<!-- Copyright (c) 2005-2008 United States Government as represented by --> +<!-- the U.S. Army Research Laboratory. --> +<!-- --> +<!-- Redistribution and use in source (Docbook format) and 'compiled' --> +<!-- forms (PDF, PostScript, HTML, RTF, etc), with or without --> +<!-- modification, are permitted provided that the following conditions --> +<!-- are met: --> +<!-- --> +<!-- 1. Redistributions of source code (Docbook format) must retain the --> +<!-- above copyright notice, this list of conditions and the following --> +<!-- disclaimer. --> +<!-- --> +<!-- 2. Redistributions in compiled form (transformed to other DTDs, --> +<!-- converted to PDF, PostScript, HTML, RTF, and other formats) must --> +<!-- reproduce the above copyright notice, this list of conditions and --> +<!-- the following disclaimer in the documentation and/or other --> +<!-- materials provided with the distribution. --> +<!-- --> +<!-- 3. The name of the author may not be used to endorse or promote --> +<!-- products derived from this documentation without specific prior --> +<!-- written permission. --> +<!-- --> +<!-- THIS DOCUMENTATION IS PROVIDED BY THE AUTHOR "AS IS" AND ANY --> +<!-- EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE --> +<!-- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR --> +<!-- PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR --> +<!-- ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR --> +<!-- CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT --> +<!-- OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR --> +<!-- BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF --> +<!-- LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT --> +<!-- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE --> +<!-- USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF --> +<!-- SUCH DAMAGE. --> + +<refentry id='anim_lookat1'> + <refmeta> + <refentrytitle>ANIM_LOOKAT</refentrytitle> + <manvolnum>1</manvolnum> + <refmiscinfo class='source'>BRL-CAD</refmiscinfo> + <refmiscinfo class='manual'>BRL-CAD User Commands</refmiscinfo> + </refmeta> + + <refnamediv id='name'> + <refname>anim_lookat</refname> + <refpurpose> + create a view animation script or table which looks from + an eye point to a specified point. + </refpurpose> + </refnamediv> + + <!-- body begins here --> + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>anim_lookat</command> + <arg choice='opt'>-f <replaceable>#</replaceable></arg> + <arg choice='opt'>-v </arg> + <arg choice='plain'><replaceable>in.table</replaceable></arg> + <arg choice='plain'><replaceable>out.script</replaceable></arg> + </cmdsynopsis> + <cmdsynopsis> + <command>anim_lookat</command> + <arg choice='plain'>- </arg> + <group choice='opt'> + <arg choice='plain'><replaceable>y</replaceable></arg> + <arg choice='plain'><replaceable>q</replaceable></arg> + </group> + <arg choice='opt'>-v </arg> + <arg choice='plain'><replaceable>in.table</replaceable></arg> + <arg choice='plain'><replaceable>out.table</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + This program takes as input a seven-column animation table + consisting of time, an eye point, and a "look-at point," and prints a + view animation script to control the virtual camera. + The camera always remains "right-side up"; that is, it yaws and pitches but + doesn't roll. In cases where the camera looks vertically up or down, the + yaw from the previous frame is retained. This avoids sudden jumps as much + as possible. + </para> + + </refsect1> + + <refsect1 id='options'><title>OPTIONS</title> + <variablelist remap='TP'> + <varlistentry> + <term><option>-f#</option></term> + <listitem> + <para>Specify an integer with which to begin + numbering frames. The default is 0.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>-y</option></term> + <listitem> + <para> + The output will be an animation table rather + than a view animation script. The output table has 7 columns: + a time column, three columns representing position, and three + columns representing yaw, pitch, and roll. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>-q</option></term> + <listitem> + <para> + The output will be an animation table rather than a view animation script. + The output table has eight columns: a time column, three position columns, and four columns + representing the x,y,z, and w coordinates of an orientation quaternion. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>-v</option></term> + <listitem> + <para> + Include the viewsize in the output script or table. The viewsize is + calculated in every frame as twice the distance from the eye point to + the lookat point. If the output is a table, then the viewsize is printed + in the second column. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1 id='author'> + <title>AUTHOR</title> + <para>Carl J. Nuzman</para> + </refsect1> + + <refsect1 id='copyright'><title>COPYRIGHT</title> + <para> + This software is Copyright (c) 1993-2008 by the United States + Government as represented by U.S. Army Research Laboratory. + </para> + </refsect1> + + <refsect1 id='bug_reports'><title>BUG REPORTS</title> + <para> + Reports of bugs or problems should be submitted via electronic + mail to <de...@br...>. + </para> + </refsect1> +</refentry> + Property changes on: brlcad/trunk/doc/docbook/system/man1/en/anim_lookat.xml ___________________________________________________________________ Added: svn:mime-type + text/xml Added: svn:eol-style + native Added: brlcad/trunk/doc/docbook/system/man1/en/anim_offset.xml =================================================================== --- brlcad/trunk/doc/docbook/system/man1/en/anim_offset.xml (rev 0) +++ brlcad/trunk/doc/docbook/system/man1/en/anim_offset.xml 2008-10-27 16:29:47 UTC (rev 33076) @@ -0,0 +1,175 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "../../../resources/standard/dtd/docbookx.dtd"> + +<!-- Copyright (c) 2005-2008 United States Government as represented by --> +<!-- the U.S. Army Research Laboratory. --> +<!-- --> +<!-- Redistribution and use in source (Docbook format) and 'compiled' --> +<!-- forms (PDF, PostScript, HTML, RTF, etc), with or without --> +<!-- modification, are permitted provided that the following conditions --> +<!-- are met: --> +<!-- --> +<!-- 1. Redistributions of source code (Docbook format) must retain the --> +<!-- above copyright notice, this list of conditions and the following --> +<!-- disclaimer. --> +<!-- --> +<!-- 2. Redistributions in compiled form (transformed to other DTDs, --> +<!-- converted to PDF, PostScript, HTML, RTF, and other formats) must --> +<!-- reproduce the above copyright notice, this list of conditions and --> +<!-- the following disclaimer in the documentation and/or other --> +<!-- materials provided with the distribution. --> +<!-- --> +<!-- 3. The name of the author may not be used to endorse or promote --> +<!-- products derived from this documentation without specific prior --> +<!-- written permission. --> +<!-- --> +<!-- THIS DOCUMENTATION IS PROVIDED BY THE AUTHOR "AS IS" AND ANY --> +<!-- EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE --> +<!-- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR --> +<!-- PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR --> +<!-- ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR --> +<!-- CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT --> +<!-- OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR --> +<!-- BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF --> +<!-- LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT --> +<!-- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE --> +<!-- USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF --> +<!-- SUCH DAMAGE. --> + +<refentry id='anim_offset1'> + <refmeta> + <refentrytitle>ANIM_OFFSET</refentrytitle> + <manvolnum>1</manvolnum> + <refmiscinfo class='source'>BRL-CAD</refmiscinfo> + <refmiscinfo class='manual'>BRL-CAD User Commands</refmiscinfo> + </refmeta> + <refnamediv id='name'> + <refname>anim_offset</refname> + <refpurpose>create an animation table for an object rigidly attached to another object.</refpurpose> + </refnamediv> + + <!-- body begins here --> + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>anim_offset</command> + <arg choice='plain'>-o <replaceable>#</replaceable> <replaceable>#</replaceable> <replaceable>#</replaceable></arg> + <arg choice='opt'>-r </arg> + <arg choice='plain'><replaceable>in.table</replaceable></arg> + <arg choice='plain'><replaceable>out.table</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + + <refsect1 id='description'> + <title>DESCRIPTION</title> + <para> + This filter operates on animation tables of the type used by <emphasis remap='I'>tabsub</emphasis> + and <emphasis remap='I'>anim_script.</emphasis> Given a table specifying the position and + orientation of one object at every applicable time, <command>anim_offset</command> + calculates the position of another object which is rigidly attached to it. + </para> + + <para> + The columns of the input table should be time, three columns of + position, followed by yaw, pitch, and roll. The output will + normally be a four-column file specifying time and position. If the + <option>-r</option> option is used, the output is a seven-column file in which the last + three columns are copies of the orientation information from the input + file. + </para> + + <para> + The position of the object relative to the rigid body should be + given on the command line in the order x, y, z, with the + <option>-o # # #</option> option. These offset values + should be as measured from the centroid of the rigid body. + </para> + </refsect1> + + <refsect1 id='examples'> + <title>EXAMPLES</title> + <para> + This filter could be used, for example, to do an animation where + the camera is placed inside a moving vehicle. + </para> + + <para> + Suppose that truck.table contains the desired position of the + center of the front axle of the truck as well as its orientation at each + time. One row of the table might look like this: + </para> + <literallayout remap='.nf'> + +35.2 12450 -140 600 90.0 0.0 0.0 + + </literallayout> <!-- .fi --> + <para> + Thus 35.2 seconds into the animation, the center of the front axle will + be at (12450, -140, 600), and the truck will be pointed in the positive + y direction. (yaw = 90). + </para> + + <para> + Now, suppose we want the camera to ride along in the cab, above + and behind the front axle and somewhat to the left. To specify this + offset, we use the coordinate frame of the truck, with the origin at the + center of the front axle, the x-axis to the front, y to the left, and z + pointing up. Let the exact offset from the axle to the desired camera + position in this case be (-600, 900, 1200), in units of mm. Now we use + the routine: + </para> + <literallayout remap='.nf'> + +anim_offset -o -600 900 1200 < truck.table > camera.table + + </literallayout> <!-- .fi --> + <para> + The result is a four-column table giving the desired position of the + virtual camera at each time. The row corresponding to the sample row + above would be: + </para> + <literallayout remap='.nf'> + +35.2 11550 -740 1800 + + </literallayout> <!-- .fi --> + + <para> + With the <option>-r</option> option, the output would have been: + </para> + <literallayout remap='.nf'> + +35.2 11550 -740 1800 90.0 0.0 0.0 + + </literallayout> <!-- .fi --> + + <para> + Now <emphasis remap='I'>tabsub</emphasis> and/or <emphasis remap='I'>anim_script</emphasis> + can be used to process these two animation tables into an animation script. + </para> + </refsect1> + + <refsect1 id='bugs'> + <title>BUGS</title> + <para> + The program will only use orientations specified as yaw, pitch, and roll. You can get around this using + <emphasis remap='I'>anim_orient</emphasis>, which converts between different orientation representations. + </para> + </refsect1> + + <refsect1 id='author'><title>AUTHOR</title> + <para>Carl J. Nuzman</para> + </refsect1> + + <refsect1 id='copyright'><title>COPYRIGHT</title> + <para> This software is Copyright (c) 1993-2008 by the United States + Government as represented by U.S. Army Research Laboratory.</para> + </refsect1> + + <refsect1 id='bug_reports'><title>BUG REPORTS</title> + <para>Reports of bugs or problems should be submitted via electronic + mail to <de...@br...>.</para> + </refsect1> +</refentry> + Property changes on: brlcad/trunk/doc/docbook/system/man1/en/anim_offset.xml ___________________________________________________________________ Added: svn:mime-type + text/xml Added: svn:eol-style + native This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |