Functional Macro Document - read_movie_animate

<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_animate</h1> <h3>Synopsis</h3> <p> Reads in a numbers of offset files and animates the display by iterating through them. </p> <p> <h4>Input Ports</h4> <table class="parameters" summary="Input Ports used by read_movie_animate"> <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>in</i></td> <td width="80">Mesh+Node_Data</td> <td width="425">field data representing the input BYU model.</td> </tr> <tr> <td width="100"><i>scale</i></td> <td width="80">float</td> <td width="425">scale factor for the offset vectors.</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h4>Parameters</h4> <p> This macro does not use any specialised parameter blocks, instead it uses the common parameters blocks <a href="../common/doc_io.shtml" target="_top">IndexedFileParams</a> and <a href="../common/doc_ui.shtml" target="_top">VideoLoopParams</a>, and their associated macros CreateIndexedFilename and AnimFilename. </p> <p> The CreateIndexedFilename macro creates a filename from a number of sub-strings and an index. Documentation can be found in the <a href="../common/doc_io.shtml" target="_top">IOWidgets</a> library. The important details of the parameters used are shown below. </p> <table class="parameters" summary="Parameters used by read_movie_animate from IndexedFileParams"> <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>dir</i></td> <td width="75">string</td> <td width="300">file directory (e.g. <tt>iac_proj/rdmovbyu/</tt>)</td> <td width="125">Directory Text Box</td> </tr> <tr> <td width="100"><i>filename_stub</i></td> <td width="75">string</td> <td width="300">filename without index (e.g. <tt>cube</tt>)</td> <td width="125">Filename Stub Text Box</td> </tr> <tr> <td width="100"><i>extension</i></td> <td width="75">string</td> <td width="300">file extension without leading "." (e.g. <tt>off</tt>)</td> <td width="125">Extension Text Box</td> </tr> <tr> <td width="100"><i>index_width</i></td> <td width="75">int</td> <td width="300">width of index number in characters</td> <td width="125">Index Width Edit Box</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <p> The AnimFilename macro uses the CreateIndexedFilename macro to generate a sequence of numbered filenames. Documentation can be found in the <a href="../common/doc_io.shtml" target="_top">IOWidgets</a> library. The important details of the parameters used are shown below. </p> <table class="parameters" summary="Parameters used by read_movie_animate from VideoLoopParams"> <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>reset</i></td> <td width="75">int</td> <td width="300">resets loop to start value</td> <td width="125">VideoControl</td> </tr> <tr> <td width="100"><i>reset_back</i></td> <td width="75">int</td> <td width="300">resets loop to end value</td> <td width="125">VideoControl</td> </tr> <tr> <td width="100"><i>run</i></td> <td width="75">int</td> <td width="300">runs the animation loop from start</td> <td width="125">VideoControl</td> </tr> <tr> <td width="100"><i>run_back</i></td> <td width="75">int</td> <td width="300">runs the animation loop from end</td> <td width="125">VideoControl</td> </tr> <tr> <td width="100"><i>step</i></td> <td width="75">int</td> <td width="300">steps the animation forward 1 frame</td> <td width="125">VideoControl</td> </tr> <tr> <td width="100"><i>step_back</i></td> <td width="75">int</td> <td width="300">steps the animation backward 1 frame</td> <td width="125">VideoControl</td> </tr> <tr> <td width="100"><i>cycle</i></td> <td width="75">int</td> <td width="300">when set the animation loops continously</td> <td width="125">Cycle toggle box</td> </tr> <tr> <td width="100"><i>start_value</i></td> <td width="75">double</td> <td width="300">initial value of loop</td> <td width="125">Start Value edit box</td> </tr> <tr> <td width="100"><i>end_value</i></td> <td width="75">double</td> <td width="300">final value of loop</td> <td width="125">End Value edit box</td> </tr> <tr> <td width="100"><i>incr</i></td> <td width="75">double</td> <td width="300">loop increment</td> <td width="125">Increment edit box</td> </tr> <tr> <td width="100"><i>count</i></td> <td width="75">double</td> <td width="300">current value of loop</td> <td width="125">Frame number slider</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h4>Output Ports</h4> <table class="parameters" summary="Output Ports used by read_movie_animate"> <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+Node_Data</td> <td width="425">field data representing the offset BYU model.</td> </tr> <tr> <td width="100"><i>obj</i></td> <td width="80">DataObject</td> <td width="425">directly renderable offset output object.</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h3>Description</h3> <p> When instructed the read_movie_animate repeatadly reads in offset files and applies the offset data to the input file data, thereby performing animation of the BYU model data. The base filename and the number of offset files can be specified through the user interface. The animation is also started through the user interface. The offset filenames should typically be of the form 'nameXXX' where XXX is the index number of the offset file. The index numbering begins with 001, therefore the first example file is cube001. </p> <p> More details on the offset file format can be found in the <a href="rdoffmac.shtml" target="_top">read_movie_apply_offset</a> and <a href="rdmovoff.shtml" target="_top">ReadMovieOffsetFile</a> documentation. </p> <h3>Input Ports</h3> <p> <i><b>in</b></i> </p> <p> The field data that the offset is to be applied to. The type of this field is Mesh+Node_Data </p> <p> <i><b>scale</b></i> </p> <p> The factor by which the offsets from the offset file are scaled by. The type of this field is float. It should be noted that only the offset vectors are scaled, the original data is not scaled by this parameter. </p> <h3>Output Ports</h3> <p> <i><b>out</b></i> </p> <p> The most primitive output field of the read_movie_animate macro. This contains the model read from the BYU file represented as field data, offset by the amount specified in the current offset file. </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 from the input field data, after being offset by the amount specified in the current offset file. </p> <h3>Utility Macros</h3> <p> This user macro uses the general user macro, read_movie_offsets and adds the functionality required for the macro to act as a section in the visualization pipeline. The read_movie_offsets macro in turn makes use of the functional macro ReadMovieOffset and the UI macros CreateIndexedFilenameUI and AnimFilenameUI. The ReadMovieOffsets macro uses the specialised low level modules <a href="rdmovoff.shtml" target="_top">ReadMovieOffsetFile</a> and ReadMovieBYUApplyOffset, and the common module AnimFilename. </p> <h3>Example</h3> <p> An example application ReadMovieBYUEg is provided, which uses the <a href="rdbyumac.shtml" target="_top">read_movie_byu</a> 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_animate and read_movie_offsets User Macros, the ReadMovieOffsets Functional Macro and the example application ReadMovieBYUEg V definitions. The file also contains several other macro definitions. </p> <h3>Prerequisites</h3> <p>This project relies on the successful installation of the following components. Without them it will not function correctly.</p> <ul> <li><a href="../common/doc_io.shtml" target="_top">Common</a> Project</li> </ul> <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 ReadMovieOffsetFile 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> ReadMovieOffsets, ReadMovieBYUApplyOffset, <a href="rdmovoff.shtml" target="_top">ReadMovieOffsetFile</a>, <a href="../common/doc_io.shtml" target="_top">CreateIndexedFilename</a>, <a href="../common/doc_ui.shtml" target="_top">VideoLoop</a> and <a href="../common/doc_io.shtml" target="_top">AnimFilename</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>