<![CDATA[
<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>
<!-- BEGIN CONTENT PAGE -->
<h1>WriteMayaCore</h1>
<h3>Synopsis</h3>
<p>
Writes the contents of a field or array of fields to a Alias/Wavefront MAYA
"OBJ" file.
</p>
<p>
<hr>
<pre>
module WriteMayaCore <src_file="wr_maya.cxx",
cxx_hdr_files="fld/Xfld.h"> {
cxxmethod+req update <status=1>(
filename+read+notify+req,
in+read,
top_name+read,
nobjs+read,
.err+write,
.err_str+write
);
string filename<export=2,NEportLevels={2,0}>;
Mesh+Node_Data &in<export=2,NEportLevels={2,0}>[];
string top_name<export=2,NEportLevels={2,0}> = "default_avs_field";
int nobjs<export=2,NEportLevels={2,0}>;
int err<export=2,NEportLevels={0,2}> = 0;
string err_str<export=2,NEportLevels={0,2}> = "";
};
</pre>
<hr></p>
<h3>Description</h3>
<p>
This module parses the arrays of meshes <tt>in</tt> and then creates 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 3D geometric objects in the scene. 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>
<p>
The cell-set hierarchy is preserved in the file format, delimited by
comments in the output file. As the module takes an array of meshes as its input
it is able to output an array of objects. This is used by the user macros
write_maya_multi and write_maya_ARR to output either an array of fields or a
GroupObject containing a number of Graphic Display objects. This can, for
example, be used to output bounds, isosurface and a slice plane objects to a
single Maya file.
</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>
<b><i>&in[]</i></b>
</p>
<p>
Reference to an array of Fields which are to be written to the Maya file. Each
Field should consist of a Mesh containing a Cell_Set, and Node data.
</p>
<p>
<b><i>filename</i></b>
</p>
<p>
The name of the file that should be written to. The parameter is of type string.
The filename should specify the full path name of the file.
</p>
<p>
<b><i>top_name</i></b>
</p>
<p>
The name of the object being written to the file. The parameter is of type
string. The Maya file format stores the names of the objects in the file. This
parameter allows these names to be specified. The supplied user macros use the
standard AVS object names.
</p>
<p>
<b><i>nobjs</i></b>
</p>
<p>
The number of objects to be written to the file. The parameter is of type int.
The user macro write_maya_ARR uses the GroupObject parameters to set this
parameter.
</p>
<h3>Outputs</h3>
<p>
<b><i>err</i></b>
</p>
<p>
This flag is used to indicate whether an error has occurred. The parameter is of
type int. If this parameter is set to 1 then an error has occurred within the
module and the user should be informed. This can be done by using the parameter
to control the visibility of an <tt>err_str</tt> label.
</p>
<p>
<b><i>err_str</i></b>
</p>
<p>
The description of the current error condition. The parameter is of type string.
This parameter is used to store a user readable description of the current
error. If no error has occurred the parameter has a value of "".
</p>
<h3>Utility Modules</h3>
<p>
The low-level WriteMayaCore module is used in the User Macros
write_maya, write_maya_multi, write_maya_GD and write_maya_ARR.
</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/wrmymods.v</i> contains the WriteMayaCore module V definition.
</p>
<h3>Other Notes</h3>
<p>
The low-level WriteMayaMods library containing the module WriteMayaCore does not
specify a process. By default the <TT>express</TT> process will be used.
</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_umac.shtml" target="_top">write_maya</a>,
<a href="doc_umac.shtml" target="_top">write_maya_multi</a>,
<a href="doc_umac.shtml" target="_top">write_maya_GD</a>,
<a href="doc_umac.shtml" target="_top">write_maya_ARR</a>, WriteMayaUI, WriteMayaEg,
WriteMayaMultiEg, WriteMayaArrEg, Write STL, Write VGF, Write POV
</p>
<!-- END CONTENT PAGE -->
</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:
<!-- #BeginEditable "date-stamp" -->
20th February 2004
<!-- #EndEditable --></td>
</tr>
</table>
]]>