User Macro Document - read_6DOF ####PAGE_TITLE#### sequence_6DOF

<table cellspacing="0" cellpadding="0"> <tr height="150"> <td align="left"><img src="../../../../img/logo.gif" alt="IAC logo"></img></td> <td width="100%" rowspan="2" align="left" valign="center"> <table cellspacing="0" cellpadding="0"> <tr> <td> <table class="navigate_doc" width="100%" border="0" align="center"> <tr bgcolor="c6c6e0" align="center"> <th nowrap width="1%" height="32">P0101</th> <th nowrap width="98%">Read6DOF</th> <th nowrap width="1%">21st June 2000</th> </tr> <tr> <td align="left" colspan="3"> <p><b>Authors:</b> Leigh Grundy, Ian Curington, AVS Inc.; Andrew Dodd, IAC <b>Version:</b> 1.0 <b>Path:</b> iac_proj/rd_6dof/</p> <a href="../../data_io.shtml" target="_top"><img src="../../../../img/data_io.gif" width="60" height="30" border="0" alt="Data IO"></a> <a href="rd_6dof.shtml" target="_top"> <img src="../../../../img/doc_umac.gif" border="0" width="30" height="30" alt="User Macro Document - read_6DOF & sequence_6DOF"></a> <a href="source/data_io/rd_6dof/rd_6dof.tar.gz"> <img src="../../../../img/targz.gif" border="0" width="52" height="30" alt="Archive - rd_6dof.tar.gz"></a> <a href="source/data_io/rd_6dof/rd_6dof.tar.Z"> <img src="../../../../img/tarz.gif" border="0" width="52" height="30" alt="Archive - rd_6dof.tar.Z"></a> <a href="source/data_io/rd_6dof/rd_6dof.zip"> <img src="../../../../img/zip.gif" border="0" width="52" height="30" alt="Archive - rd_6dof.zip"></a> </td> </tr> </table> <br> </td> </tr> <tr> <td>  <h1>read_6DOF, sequence_6DOF</h1> <h3>Synopsis</h3> <p>read_6DOF reads a 6-degree-of-freedom (6DOF) trajectory file and outputs 6 arrays of data. sequence_6DOF animates the motion of an object along the path represented by that data.</p> <p> <h4>Input Ports</h4> <table class="parameters" summary="Input Ports used by read_6dof & sequence_6dof"> <tr> <td width="100"><b>Name</b></td> <td width="75"><b>Type</b></td> <td width="350"><b>Description</b></td> <td width="100"><b>Module</b></td> </tr> <tr> <td colspan="4"><hr></td> </tr> <tr> <td width="100"><i>in_xform</i></td> <td width="75">Xform</td> <td width="350">Transformation that is to be altered.</td> <td width="100">sequence_6DOF</td> </tr> <tr> <td width="100"><i>filename</i></td> <td width="75">string</td> <td width="350">Name of 6DOF file to read.</td> <td width="100">both</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h4>Parameters</h4> <p>The sequence_6DOF macro uses the loop module internally. Please see the AVS/Express documentation for a full description of the parameters of the loop module. The read_6DOF macro does not use any parameters.</p> <p> <table class="parameters" summary="Parameters used by sequence_6DOF"> <tr> <td width="100"><b>Name</b></td> <td width="75"><b>Type</b></td> <td width="300"><b>Description</b></td> <td width="100"><b>Module</b></td> </tr> <tr> <td colspan="4"><hr></td> </tr> <tr> <td width="100"><i>scale</i></td> <td width="75">float</td> <td width="300">Specifies the transform scaling factor.</td> <td width="100">sequence_6DOF</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h4>Output Ports</h4> <table class="parameters" summary="Output Ports used by read_6DOF"> <tr> <td width="100"><b>Name</b></td> <td width="75"><b>Type</b></td> <td width="350"><b>Description</b></td> <td width="100"><b>Module</b></td> </tr> <tr> <td colspan="4"><hr></td> </tr> <tr> <td width="100"><i>x_comp</i></td> <td width="75">float[]</td> <td width="350">X component of the trajectory translation.</td> <td width="100">read_6dof</td> </tr> <tr> <td width="100"><i>y_comp</i></td> <td width="75">float[]</td> <td width="350">Y component of the trajectory translation.</td> <td width="100">read_6dof</td> </tr> <tr> <td width="100"><i>z_comp</i></td> <td width="75">float[]</td> <td width="350">Z component of the trajectory translation.</td> <td width="100">read_6dof</td> </tr> <tr> <td width="100"><i>pitch</i></td> <td width="75">float[]</td> <td width="350">pitch component of the trajectory rotation.</td> <td width="100">read_6dof</td> </tr> <tr> <td width="100"><i>roll</i></td> <td width="75">float[]</td> <td width="350">roll component of the trajectory rotation.</td> <td width="100">read_6dof</td> </tr> <tr> <td width="100"><i>yaw</i></td> <td width="75">float[]</td> <td width="350">yaw component of the trajectory rotation.</td> <td width="100">read_6dof</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> </p> <h3>Description</h3> <p>The two user macros in the Read6DOF project are used to read a trajectory data file and animate an object along that trajectory.</p> <p>The <b>read_6DOF</b> macro is used to read a 6-channel ASCII file that contains position and rotation values for an object over a number of time steps. The format of the ASCII file is straightforward. It contains 6 columns of data which are separated by tab characters. The columns of data represent:</p> <ol> <li>X translation</li> <li>Y translation</li> <li>Z translation</li> <li>Pitch</li> <li>Roll</li> <li>Yaw</li> </ol> <p>The <b>sequence_6DOF</b> macro extends the functionality of the read_6DOF of macro by modifying a transform matrix that is being used to control an object. It also allows the time steps contained in the trajectory data to be looped through. The macro does this by using the read_6DOF macro, the GD_xform_edit module and the loop module. The read_6DOF macro reads in a trajectory data file. The GD_xform_edit module generates a transform matrix from a single time step of the trajectory data and the loop module cycles through the time steps contained in the data.</p> <p>The transform matrix that is modified of the sequence_6DOF macro can be found by exporting the Xform block from any standard module (i.e. Read_Geom) or DataObject. The example application shows how this can be done.</p> <h3>Inputs</h3> <p><b><i>in_xform</i></b></p> <p>The transform matrix that is to be modified by the sequence_6DOF macro.</p> <p><b><i>filename</i></b></p> <p>This string input specifies the name of the file containing the 6DOF data. Standard AVS/Express environment variables can be used. Both of the user macros provide this input.</p> <h3>Parameters</h3> <p><b><i>scale</i></b></p> <p>Floating point parameter that specifies the scaling factor that is to be applied to the modified transformation.</p> <p><b><i>Loop Controls</i></b></p> <p>The sequence_6DOF macro uses the standard loop module to cycle through the trajectory data. Please see the AVS/Express documentation for a full description of the parameters of the loop module.</p> <h3>Outputs</h3> <p><b><i>x_comp[] y_comp[] z_comp[]</i></b></p> <p>Floating point arrays that contain the X, Y and Z translations for each time step in the trajectory data. These can be directly input into the GD_xform_edit module to generate a standard Xform block that can be used to transform field data or geometry.</p> <p><b><i>pitch[] roll[] yaw[]</i></b></p> <p>Floating point arrays that contain the pitch, roll and yaw rotations for each time step in the trajectory data. These can be directly input into the GD_xform_edit module to generate a standard Xform block that can be used to transform field data or geometry.</p> <h3>Utility Macros</h3> <p>The read_6DOF macro uses the Read_6DOF_UI user interface macro. The sequence_6DOF macro uses the read_6DOF macro.</p> <h3>Example</h3> <p>The Read_6DOF_Eg example application reads in the standard Teapot geometry and animates it through a flight path specified by the trajectory contained in the "6dof.dat" data file.</p> <h3>Files</h3> <p><i>iac_proj/rd_6dof/6dofmacs.v</i> contains the V definitions of the Read_6DOF_UI UI macro, the read_6DOF and sequence_6DOF user macros and the Read_6DOF_Eg example application.</p> <h3>Other Notes</h3> <p>This reader does not use external C or C++ code. It uses the FILE object to read the data file directly from V code. The cache() function is used so that data persists in memory and does not have to be reloaded. This project provides a good example that could be used for developing other FILE object based readers.</p> <h3>Authors</h3> <p> <pre> Leigh Grundy, Ian Curington Advanced Visual Systems, Inc. </pre> </p> <h3>Modifications</h3> <p> <pre> Andrew Dodd International AVS Centre </pre> </p> <h3>Contact</h3> <p> <pre> International AVS Centre Manchester Visualization Centre Manchester Computing University of Manchester Oxford Road Manchester United Kingdom M13 9PL </pre> </p>  </td> </tr> </table> </td> </tr> <tr height="100%"> <td class="sideLink" width="25%" align="left" valign="top" nowrap="nowrap"> <p><a href="../../../../general/index.shtml" target="_top">General Information</a></p> <p><a href="../../../../repository/index.shtml" target="_top">Repositories</a></p> <p class="sideLinkLevel2"><a href="../../../new/index.shtml" target="_top">  New Releases</a></p> <p class="sideLinkLevel2"><a href="../../../download/index.shtml" target="_top">  Download</a></p> <p class="sideLinkLevel2"><a href="../../../submit/index.shtml" target="_top">  Submit</a></p> <p class="sideLinkLevel2"><a href="../../../pfiles/index.shtml" target="_top">  Project Files</a></p> <p class="sideLinkLevel2"><a href="../../../avs5/index.shtml" target="_top">  AVS5</a></p> <p class="sideLinkLevel2"><a href="../../../express/index.shtml" target="_top">  AVS/Express</a></p> <p class="sideLinkLevel3"><a href="../../atoz.shtml" target="_top">    A to Z</a></p> <p class="sideLinkLevel3"><a href="../../number.shtml" target="_top">    Project #</a></p> <p></p> <p class="sideLinkLevel3"><a href="../../data_io.shtml" target="_top">    Data IO</a></p> <p class="sideLinkLevel3"><a href="../../filters.shtml" target="_top">    Filters</a></p> <p class="sideLinkLevel3"><a href="../../mappers.shtml" target="_top">    Mappers</a></p> <p class="sideLinkLevel3"><a href="../../misc.shtml" target="_top">    Miscellaneous</a></p> <p class="sideLinkLevel3"><a href="../../special.shtml" target="_top">    Special Projects</a></p> <p class="sideLinkLevel2"><a href="../../../pog/index.shtml" target="_top">  Project Guidelines</a></p> <p><a href="../../../../usergroup/index.shtml" target="_top">User Group</a></p> <p><a href="../../../../training/index.shtml" target="_top">Training Materials</a></p> </td> </tr> </table> <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="c6c6e0"> <tr> <td><img src="../../../../img/foot1.gif" alt="IAC" width="155" height="25"></td> <td width="100%"> Last Updated:  26th November 2002 </td> </tr> </table>