User Macro Document - plane_project ####PAGE_TITLE#### plane_project_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">P0090</th> <th nowrap width="98%">PlaneProject</th> <th nowrap width="1%">8th November 2002</th> </tr> <tr> <td align="left" colspan="3"> <p><b>Author:</b> Ian Curington, AVS Inc. <b>Version:</b> 1.2 <b>Path:</b> iac_proj/planep/</p> <a href="../../mappers.shtml" target="_top"><img src="../../../../img/mapper.gif" width="58" height="30" border="0" alt="Mapper"></a> <a href="doc_mod.shtml" target="_top"> <img src="../../../../img/doc_mod.gif" border="0" width="30" height="30" alt="Module Document - plane_proj"></a> <a href="doc_umac.shtml" target="_top"> <img src="../../../../img/doc_umac.gif" border="0" width="30" height="30" alt="User Macro Document - plane_project & plane_project_ARR"></a> <img src="../../../../img/label51.gif" width="42" height="30" align="absmiddle"> <a href="source/mappers/planep/planep51.tar.gz"> <img src="../../../../img/targz.gif" border="0" width="52" height="30" alt="Archive - planep.tar.gz - for AVS/Express Versions 5.1 and before"></a> <a href="source/mappers/planep/planep51.tar.Z"> <img src="../../../../img/tarz.gif" border="0" width="52" height="30" alt="Archive - planep.tar.Z - for AVS/Express Versions 5.1 and before"></a> <a href="source/mappers/planep/planep51.zip"> <img src="../../../../img/zip.gif" border="0" width="52" height="30" alt="Archive - planep.zip - for AVS/Express Versions 5.1 and before"></a> <img src="../../../../img/label60.gif" width="42" height="30" align="absmiddle"> <a href="source/mappers/planep/planep.tar.gz"> <img src="../../../../img/targz.gif" border="0" width="52" height="30" alt="Archive - planep.tar.gz - for AVS/Express Version 6.0"></a> <a href="source/mappers/planep/planep.tar.Z"> <img src="../../../../img/tarz.gif" border="0" width="52" height="30" alt="Archive - planep.tar.Z - for AVS/Express Version 6.0"></a> <a href="source/mappers/planep/planep.zip"> <img src="../../../../img/zip.gif" border="0" width="52" height="30" alt="Archive - planep.zip - for AVS/Express Version 6.0"></a> <img src="../../../../img/note.gif" width="15" height="30" alt="Developer Edition Only"> </td> </tr> </table> <br> </td> </tr> <tr> <td>  <h1>plane_project & plane_project_ARR</h1> <h3>Synopsis</h3> <p>A mapper module that slices an unstructured or irregular 3D model with a plane, producing a secondary 2D slice projected flat down the normal of the slice plane, for projection into secondary 2D view window.</p> <h4>Input Ports</h4> <table class="parameters" summary="Input Ports used by plane_project & plane_project_ARR"> <tr> <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="100"><i>in_field</i></td> <td width="75">Field</td> <td width="425">Data to be sliced and projected by module.</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h4>Parameters</h4> <p>These macros use the same parameters as the standard AVS <tt>slice_plane</tt> module.</p> <h4>Output Ports</h4> <table class="parameters" summary="Output Ports used by plane_project & plane_project_ARR"> <tr> <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="100"><i>out_fld</i></td> <td width="75">Field</td> <td width="425">3D data slice.</td> </tr> <tr> <td width="100"><i>out_plane</i></td> <td width="75">Mesh</td> <td width="425">plane used to generate data slice.</td> </tr> <tr> <td width="100"><i>out_obj_slice</i></td> <td width="75">GDobject</td> <td width="425">directly renderable slice object.</td> </tr> <tr> <td width="100"><i>out_obj_plane</i></td> <td width="75">GDobject</td> <td width="425">directly renderable plane object.</td> </tr> <tr> <td width="100"><i>out_obj_2d</i></td> <td width="75">GDobject</td> <td width="425">secondary 2D slice projection.</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h3>Description</h3> <p><tt>plane_project</tt> and <tt>plane_project_ARR</tt> are mapper macros that slice a 3D model and return both slices as both a 3D slice from the original model and a 2D plane projected flat along the normal of the slice plane. This 2D plane can be used for projection into an ancillary 2D view. The <tt>plane_project</tt> and <tt>plane_project_ARR</tt> macros functionally very similar except that the <tt>plane_project_ARR</tt> macro operates on arrays of field data. Except where noted all information applies equally to both macros. Please see the AVS/Express documentation for more information on working with arrays of fields.</p> <p>These user macros are variations on the standard slice_plane module, which slices a 3D model by using a simple plane tool. The macros extend this basic functionality by generating a transformed version of the slice plane with Z=0. This 2D slice plane is output as a DataObject that can be directly displayed in a 2D viewer. Hence provided a useful ancillary 2D view of the main visualization.</p> <p>As well as the C code in low-level module implementation this project also makes use of several other low-level DV modules and base classes. Unfortunately because of this the project can only be used with the AVS/Express Developer's edition.</p> <h3>Inputs</h3> <p><b><i>in_field</i></b></p> <p> Input data that is to be sliced by the module. The <tt>plane_project</tt> macro takes a single field as input whilst the the <tt>plane_project_ARR</tt> macro takes an array of fields as input. Each field of input data should consist of a 2D or 3D mesh. This mesh can have any structure. Optionally the data can also contain node data or cell data. </p> <h3>Parameters</h3> <p> The parameters used by these macros are the same as those used by the <tt>slice_plane</tt> module. Please refer to the AVS/Express documentation for parameter and user interface information. </p> <h3>Outputs</h3> <p><b><i>out_fld</i></b></p> <p> Output data representing the slice generated by the macro. The <tt>plane_project</tt> macro outputs a single field whilst the the <tt>plane_project_ARR</tt> macro outputs an array of fields. Each output field will consist of a new mesh representing the slice of data. If node data or cell data is present on the input the output will also contain new data sets. </p> <p><b><i>out_plane</i></b></p> <p> A 2d mesh that represents the plane used to slice the input data. </p> <p><b><i>out_obj_slice</i></b></p> <p> Directly renderable output object generated from the out_fld output that represents the new slice of data. </p> <p><b><i>out_obj_plane</i></b></p> <p> Directly renderable output object generated from the out_plane output that represents the plane used slice the input data. If this object is connected to a viewer and transformed, the transforms made will be reflected in the slices taken of the input data. </p> <p><b><i>out_obj_2d</i></b></p> <p> Directly renderable output object containing a 2d version of the data slice. This is generated by projecting the 3D slice flat along the normal of the slice plane. No field output is provided for this data as the 2d slice is only intended to be used to display an ancillary 2D view. </p> <h3>Utility Modules</h3> <p>The low-level <tt>plane_proj</tt> module is used in the <tt>plane_proj2</tt> functional macro. This macro is in turned used by the user macros <tt>plane_project</tt> and <tt>plane_project_ARR</tt>. These user macros also use the <tt>PlaneProjectUI</tt> user interface macro.</p> <h3>Example</h3> <p>Two example applications are provided with this project. PlaneProjectEg demonstrates the use of the standard user macro by reading in a set of data and using the plane_project macro to slice the data and generate a 2D projection of that slice. PlaneProjectArrEg demonstrates the use of the array based user macro in a similar way.</p> <h3>Files</h3> <p><i>iac_proj/planep/plp_macs.v</i> contains the V definitions of the PlaneProjectUI UI macro, the plane_project and plane_project_ARR user macros and the PlaneProjectEg and PlaneProjectArrEg example applications.</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>AVS/Express Developer's Edition</li> </ul> <h3>Other Notes</h3> <p>The user macros provided with this project are derived from the standard AVS module "Slice Plane". These macros are based on the same underlying system, but substitute the slice plane processing module and adds a new 2D output port. Please refer to the documentation for that module for further information on the use of the macros.</p> <p>The PlaneProjectMacs library inherits its process. As this library contains no procedural code, the process is not important. The low-level plane_proj module, executes under the process specified in its library, not the process defined in the high-level library.</p> <h3>Author</h3> <p> <pre> Ian Curington Advanced Visual Systems, Ltd. Hanworth Lane, Chertsey Surrey, UK KT16 9JX ianc@avs.com </pre> </p> <h3>Modifications</h3> <p> <pre> Andrew Dodd International AVS Centre </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>Standard AVS slice_plane module</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>