Functional Macro Document - read_movie_byu

<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">P0034</th> <th nowrap width="98%">ReadMovieBYU</th> <th nowrap width="1%">30th November 1998</th> </tr> <tr> <td align="left" colspan="3"> <p><b>Authors:</b> Ian Curington, Paul G. Lever, Andrew Dodd <b>Version:</b> 1.0 <b>Path:</b> iac_proj/rdmovbyu/</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="rdmovbyu.shtml" target="_top"> <img src="../../../../img/doc_mod.gif" border="0" width="30" height="30" alt="Module Document - ReadMovieBYUFile"></a> <a href="rdmovoff.shtml" target="_top"> <img src="../../../../img/doc_mod.gif" border="0" width="30" height="30" alt="Module Document - ReadMovieOffsetFile"></a> <a href="rdanimac.shtml" target="_top"> <img src="../../../../img/doc_fmac.gif" border="0" width="30" height="30" alt="Functional Macro Document - read_movie_animate"></a> <a href="rdbyumac.shtml" target="_top"> <img src="../../../../img/doc_fmac.gif" border="0" width="30" height="30" alt="Functional Macro Document - read_movie_byu"></a> <a href="rdoffmac.shtml" target="_top"> <img src="../../../../img/doc_fmac.gif" border="0" width="30" height="30" alt="Functional Macro Document - read_movie_apply_offset"></a> <a href="source/data_io/rdmovbyu/rdmovbyu.tar.gz"> <img src="../../../../img/targz.gif" border="0" width="52" height="30" alt="Archive - rdmovbyu.tar.gz"></a> <a href="source/data_io/rdmovbyu/rdmovbyu.tar.Z"> <img src="../../../../img/tarz.gif" border="0" width="52" height="30" alt="Archive - rdmovbyu.tar.Z"></a> <a href="source/data_io/rdmovbyu/rdmovbyu.zip"> <img src="../../../../img/zip.gif" border="0" width="52" height="30" alt="Archive - rdmovbyu.zip"></a> <a href="../common/doc_mod.shtml" target="_top"> <img src="../../../../img/prereq.gif" width="30" border="0" height="30" alt="Pre-requisite - Miscellaneous - Common"></a> </td> </tr> </table> <br> </td> </tr> <tr> <td>  <h1>read_movie_byu</h1> <h3>Synopsis</h3> <p> Reads in a BYU file and constructs field data from it. </p> <p> <h4>Parameters</h4> <p> The following lists all of the parameters found in the parameter block ReadMovieBYUParams, which are accessed by the module ReadMovieBYUFile and the UI Macro ReadMovieBYUUI. </p> <p> <table class="parameters"> <tr> <td width="100"><b>Name</b></td> <td width="75"><b>Type</b></td> <td width="300"><b>Description</b></td> <td width="150"><b>UI Control</b></td> </tr> <tr> <td colspan="4"><hr></td> </tr> <tr> <td width="100"><i>filename</i></td> <td width="75">string</td> <td width="300">BYU file to be read</td> <td width="150">'Read MOVIE-BYU File Name'</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> </p> <h4>Output Ports</h4> <p> <table class="parameters"> <tr> <td width="100"><b>Name</b></td> <td width="80"><b>Type</b></td> <td width="425"><b>Description</b></td> </tr> <tr> <td colspan="4"><hr></td> </tr> <tr> <td width="100"><i>out</i></td> <td width="80">Mesh+Cell_Data+Node_Data</td> <td width="425">field data representing the BYU model.</td> </tr> <tr> <td width="100"><i>obj</i></td> <td width="80">DataObject</td> <td width="425">directly renderable output object.</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> </p> <h3>Description</h3> <p> read_movie_byu reads in a BYU data file and generates both field data and renderable Data Objects from the information contained in the file. The BYU file format was created by the Brigham Young University and contains the information necessary for reconstructing one or more surfaces consisting of 3-D polygons. The BYU file to read can be specified through a simple user interface. </p> <h3>Parameters</h3> <p> <i><b>filename</b></i> </p> <p> A member of the ReadMovieBYUParams parameter block group, this string value is used to specify the name of the BYU file that should be loaded. </p> <h3>Output Ports</h3> <p> <i><b>out</b></i> </p> <p> The most primitive output field of the read_movie_byu macro. This contains the model read from the BYU file represented as field data. </p> <p> <i><b>obj</b></i> </p> <p> The directly renderable output field of the read_movie_byu macro. This contains a DataObject object that can be rendered by the standard data viewers. The Data Object is generated directly from the field data created from the BYU file. </p> <h3>Utility Macros</h3> <p> The low-level ReadMovieBYUFile module is used in this User Macro read_movie_byu. </p> <h3>Example</h3> <p> An example application ReadMovieBYUEg is provided, which uses the read_movie_byu macro to load a BYU file that is then animated by the read_movie_animate macro. </p> <h3>Files</h3> <p> <i>iac_proj/rdmovbyu/rdmbmacs.v</i> contains the read_movie_byu User Macro, the ReadMovieBYU Functional Macro, the ReadMovieBYUUI UI Macro, and the example application ReadMovieBYUEg V definitions. The file also contains several other macro definitions. </p> <h3>Other Notes</h3> <p> The ReadMovieBYUMacs library inherits its process. As this library contains no procedural code, the process is not important. The low-level ReadMovieBYUFile module, executes under the process specified in its library, not the process defined in the high-level library. </p> <h3>Authors</h3> <p> <pre> Ian Curington Paul G. Lever Andrew Dodd </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> <h3>See Also</h3> <p> ReadMovieBYUParams, ReadMovieBYUUI, ReadMovieBYU and <a href="rdmovbyu.shtml" target="_top" name="ReadMovieBYUFile">ReadMovieBYUFile</a>. </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>