User Macro Document - write_pov, write_pov_GD, write_pov_ARR

<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">P0059</th> <th nowrap width="98%">WritePov</th> <th nowrap width="1%">25th January 2002</th> </tr> <tr> <td align="left" colspan="3"> <p><b>Author:</b> Ian Curington <b>Version:</b> 1.1 <b>Path:</b> iac_proj/wr_pov/</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="doc_mod.shtml" target="_top"> <img src="../../../../img/doc_mod.gif" border="0" width="30" height="30" alt="Module Document - WritePovCore"></a> <a href="doc_umac.shtml" target="_top"> <img src="../../../../img/doc_umac.gif" border="0" width="30" height="30" alt="User Macro Document - write_pov, write_pov_GD, write_pov_ARR"></a> <img src="../../../../img/label51.gif" width="42" height="30" align="absmiddle"> <a href="source/data_io/wr_pov/wr_pov51.tar.gz"> <img src="../../../../img/targz.gif" border="0" width="52" height="30" alt="Archive - wr_pov.tar.gz - for AVS/Express Versions 5.1 and before"></a> <a href="source/data_io/wr_pov/wr_pov51.tar.Z"> <img src="../../../../img/tarz.gif" border="0" width="52" height="30" alt="Archive - wr_pov.tar.Z - for AVS/Express Versions 5.1 and before"></a> <a href="source/data_io/wr_pov/wr_pov51.zip"> <img src="../../../../img/zip.gif" border="0" width="52" height="30" alt="Archive - wr_pov.zip - for AVS/Express Versions 5.1 and before"></a> <img src="../../../../img/label60.gif" width="42" height="30" align="absmiddle"> <a href="source/data_io/wr_pov/wr_pov.tar.gz"> <img src="../../../../img/targz.gif" border="0" width="52" height="30" alt="Archive - wr_pov.tar.gz - for AVS/Express Version 6.0"></a> <a href="source/data_io/wr_pov/wr_pov.tar.Z"> <img src="../../../../img/tarz.gif" border="0" width="52" height="30" alt="Archive - wr_pov.tar.Z - for AVS/Express Version 6.0"></a> <a href="source/data_io/wr_pov/wr_pov.zip"> <img src="../../../../img/zip.gif" border="0" width="52" height="30" alt="Archive - wr_pov.zip - for AVS/Express Version 6.0"></a> </td> </tr> </table> <br> </td> </tr> <tr> <td>  <h1>write_pov, write_pov_GD, write_pov_ARR</h1> <h3>Synopsis</h3> <p> Writes the contents of a field, a Graphic Display object (red renderable port) or a group of Graphic Display objects to a POVray version 3.1 file. </p> <p> <h4>Input Ports</h4> <table class="parameters" summary="Input Ports used by write_pov, write_pov_GD, write_pov_ARR"> <tr> <td width="75"><b>User Macro</b></td> <td width="100"><b>Name</b></td> <td width="75"><b>Type</b></td> <td width="425"><b>Description</b></td> </tr> <tr> <td colspan="4"><hr></td> </tr> <tr> <td width="75">write_pov</td> <td width="100"><i>in_fld</i></td> <td width="75">Mesh+Cell_Set</td> <td width="425">single set of field data</td> </tr> <tr> <td width="75">write_pov_GD</td> <td width="100"><i>obj</i></td> <td width="75">GD Object</td> <td width="425">single Graphic Display Object</td> </tr> <tr> <td width="75">write_pov_ARR</td> <td width="100"><i>top_obj</i></td> <td width="75">GroupObject</td> <td width="425">group of Graphic Display Objects</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> </p> <h3>Description</h3> <p> These user macros all write data to POVray format files. The exact purpose of each of these three macros is described below: </p> <ul> <li> <b><i>write_pov:</i></b> This macro writes a single set of field data to a POV file. Both of the other user macros are derived from this macro. </li> <li> <b><i>write_pov_GD:</i></b> This macro writes a single Graphic Display object (red renderable port) to a POV file. </li> <li> <b><i>write_pov_ARR:</i></b> This macro writes a GroupObject (red renderable port) to a POV file. GroupObjects are generated by the ARR library modules and represent an array of separate fields. They are written to the POV file as separate union blocks. </li> </ul> <p> These macros parse the appropriate input and then create an ASCII POV output file containing the Cell_Sets of certain 2D elements. The current implementation outputs triangle, quad, line, polyline and polytristrip cell sets. The module takes cell mesh topology from the input field structure and writes this data out to the POV file in a format suitable for processing by the POVray ray tracing software package. </p> <p> The POVray software system is a ray-trace based rendering system for high quality image production and animation. The system is available on most common platforms. The POVray system is free, as long as the stated conditions are met. Full source code is also available for extension or ray tracing research. POVray software and further information can be obtained from: <a href="http://www.povray.org" target="_top">http://www.povray.org</a> </p> <p> The write_pov macro contains no source code from POVray, and does not need any of the POVray software available for module compilation or use. The POVray software is required for processing and rendering the output file. The files generated by this module are compatible with version 3.1 of POVray. They may also work with previous versions; however this has not been tested. </p> <p> It should be noted that the generated POV files will require a certain amount of manual editing before they can be correctly rendered. Data about camera and light positions is stored in View and Scene objects. The macros take field data as a direct or indirect input and therefore cannot access this data. Sample data is written to the output file. Before the POV file can be rendered the camera and light positions will have to be altered so that they are appropriate for the scene. </p> <p> The cell-set boundaries are preserved in the POV file format, and union blocks separate each field. Node data is ignored and only mesh geometry is passed to the file. This is done as the POVray system does not appear to allow per-node color values. Lines are defined as thin cylinders. </p> <h3>Inputs</h3> <p> Note that each of the user macros has a different input port. </p> <p> <b><i>in_fld</i></b> - <i>write_pov</i> </p> <p> Reference to a set of field data that should be written to the POV file. The field data should consist of Mesh and Cell_Set. Node data is not written to the output file. </p> <p> <b><i>obj</i></b> - <i>write_pov_GD</i> </p> <p> Reference to a Graphic Display object (red renderable port) that should be written to the POV file. The field data to be written is extracted from the supplied Graphic Display object. </p> <p> <b><i>top_obj</i></b> - <i>write_pov_ARR</i> </p> <p> Reference to a GroupObject (red renderable port) that should be written to the POV file. The GroupObject should contain a number of child Graphic Display objects. These are output as separate union blocks in the POV file. GroupObjects are generated by ARR library modules. They can also be created manually. </p> <h3>Outputs</h3> <p> <b><i>(none)</i></b> </p> <h3>Utility Modules</h3> <p> The User Macro write_pov uses the low-level module WritePovCore and the UI macro WritePovUI. As both of the other User Macros are derived from the write_pov macro they also make use of these components. </p> <h3>Example</h3> <p> Two example applications are provided. WritePovEg demonstrates the use of the write_pov user macro by generating an isosurface and writing that isosurface to a file. WritePovArrEg demonstrates the use of the write_pov_ARR user macro by loading a multiblock set of data and generating a series of visualizations. The isosurface can then be written to a file. If the resultant file is examined then it is apparent that the isosurface is written out in several chunks, one per block of data. </p> <h3>Files</h3> <p> <i>iac_proj/wr_pov/wpovmacs.v</i> contains the V definitions of the write_pov, write_pov_GD and write_pov_ARR User Macros, the WritePovUI UI Macro, and the example applications WritePovEg and WritePovArrEg. </p> <h3>Other Notes</h3> <p> The WritePovMacs library inherits its process. As this library contains no procedural code, the process is not important. </p> <h3>Author</h3> <p> <pre> Ian Curington Advanced Visual Systems, Ltd. Hanworth Lane, Chertsey Surrey, UK KT16 9JX </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> <a href="doc_mod.shtml" target="_top">WritePovCore</a>, WritePovUI, WritePovEg, WritePovArrEg, Write VGF, Write STL </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>