User Macro Document - write_maya, write_maya_multi, write_maya_GD, write_maya_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">P0062</th> <th nowrap width="98%">WriteMaya</th> <th nowrap width="1%">20th February 2004</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_maya/</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 - WriteMayaCore"></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_maya, write_maya_multi, write_maya_GD, write_maya_ARR"></a> <a href="source/data_io/wr_maya/wr_maya.tar.gz"> <img src="../../../../img/targz.gif" border="0" width="52" height="30" alt="Archive - wr_maya.tar.gz"></a> <a href="source/data_io/wr_maya/wr_maya.tar.Z"> <img src="../../../../img/tarz.gif" border="0" width="52" height="30" alt="Archive - wr_maya.tar.Z"></a> <a href="source/data_io/wr_maya/wr_maya.zip"> <img src="../../../../img/zip.gif" border="0" width="52" height="30" alt="Archive - wr_maya.zip"></a> </td> </tr> </table> <br> </td> </tr> <tr> <td>  <h1>write_maya, write_maya_multi, write_maya_GD, write_maya_ARR</h1> <h3>Synopsis</h3> <p> Writes the contents of a field, an array of fields, a Graphic Display object (red renderable port) or a group of Graphic Display objects to a Maya OBJ file. </p> <p> <h4>Input Ports</h4> <table class="parameters" summary="Input Ports used by write_maya, write_maya_multi, write_maya_GD, write_maya_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_maya</td> <td width="100"><i>in_fld</i></td> <td width="75">Field</td> <td width="425">single set of field data</td> </tr> <tr> <td width="75">write_maya_multi</td> <td width="100"><i>in_flds[]</i></td> <td width="75">Field</td> <td width="425">array of field data</td> </tr> <tr> <td width="75">write_maya_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_maya_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 Maya OBJ format files. The exact purpose of each of these three macros is described below: </p> <ul> <li> <b><i>write_maya:</i></b> This macro writes a single set of field data to a Maya file. All of the other user macros are derived from this macro. </li> <li> <b><i>write_maya_multi:</i></b> This macro writes an array of field data structures to a Maya file. Separate field are delimited by comments in the output file. </li> <li> <b><i>write_maya_GD:</i></b> This macro writes a single Graphic Display object (red renderable port) to a Maya file. </li> <li> <b><i>write_maya_ARR:</i></b> This macro writes a GroupObject (red renderable port) to a Maya file. GroupObjects are generated by the ARR library modules and represent an array of separate fields. They are delimited by comments in the output file. </li> </ul> <p> These macros parse the appropriate input and then create an ASCII Maya OBJ output file containing the Cell_Sets of certain 3D 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 Maya file. </p> <p> The format output is the original Wavefront OBJ file format. This format can store several 3D geometric objects in the scene. These are separated by comment lines. The module is able to pass normals through if they exist on the input mesh. Colors and scalar numerical values at nodes can also be passed through using UV texture coordinates. </p> <center><a href="http://www.aw.sgi.com" target="_top"> <img SRC="source/data_io/wr_maya/maya.gif" ALT="Alias/Wavefront Maya logo"></a></center> <p> The MAYA system is an advanced animation and visualization system developed by Alias/Wavefront. Other packages, such as SoftImage and Lightwave3D can also read the Maya OBJ format. More information about the Maya system can be found on the <a href="http://www.aw.sgi.com" target="_top">Alias/Wavefront</a> web-site. A full description of the file format structure with examples, can be found at: </p> <p> <a href="http://cica.cica.indiana.edu/graphics/object_specs/OBJ.format.txt"> http://cica.cica.indiana.edu/graphics/object_specs/OBJ.format.txt</a> </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_maya</i> </p> <p> Reference to a set of field data that should be written to the Maya file. The field data should consist of a Mesh containing a Cell_Set, and Node data. </p> <p> <b><i>in_flds[]</i></b> - <i>write_maya_multi</i> </p> <p> Reference to an array of Fields that should be written to the Maya file. The field data should consist of a Mesh containing a Cell_Set, and Node data. The data in each field is written into the Maya file and separated by comments. </p> <p> <b><i>obj</i></b> - <i>write_maya_GD</i> </p> <p> Reference to a Graphic Display object (red renderable port) that should be written to the Maya 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_maya_ARR</i> </p> <p> Reference to a GroupObject (red renderable port) that should be written to the Maya file. The GroupObject should contain a number of child Graphic Display objects. These are separated by comments in the output Maya file. GroupObjects are generated by ARR library modules. They can also be created manually. </p> <h3>Utility Modules</h3> <p> The User Macro write_maya uses the low-level module WriteMayaCore and the UI macro WriteMayaUI. As all of the other User Macros are derived from the write_maya macro they also make use of these components. </p> <h3>Example</h3> <p> Three example applications are provided. WriteMayaEg demonstrates the use of the write_maya user macro by generating an isosurface and writing that isosurface to a file. WriteMayaMultiEg demonstrates the use of the write_maya_multi user macro by generating several sets of Field data and writing them all to a single file. WriteMayaArrEg demonstrates the use of the write_maya_ARR 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_maya/wrmymacs.v</i> contains the V definitions of the write_maya, write_maya_multi, write_maya_GD and write_maya_ARR User Macros, the WriteMayaUI UI Macro, and the example applications WriteMayaEg, WriteMayaMultiEg and WriteMayaArrEg. </p> <h3>Other Notes</h3> <p> The WriteMayaMacs 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">WriteMayaCore</a>, WriteMayaUI, WriteMayaEg, WriteMayaMultiEg, WriteMayaArrEg, Write VGF, Write STL, Write POV </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:  20th February 2004 </td> </tr> </table>