User Macro Document - cylinder_cut

<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">P0216</th> <th nowrap width="98%">CutPolylines</th> <th nowrap width="1%">28th April 2008</th> </tr> <tr> <td align="left" colspan="3"> <p><b>Authors:</b> Joanna Leng, Tobias Schiebeck <b>Version:</b> 1.0 <b>Path:</b> iac_proj/polycut/</p> <a href="../../mappers.shtml" target="_top"><img src="../../../../img/mapper.gif" width="58" height="30" border="0" alt="Mapper"></a> <a href="polycut.shtml" target="_top"> <img src="../../../../img/doc_umac.gif" border="0" width="30" height="30" alt="User Macro Document - CutPolylines"></a> <a href="source/mappers/polycut/polycut.tar.gz"> <img src="../../../../img/targz.gif" border="0" width="52" height="30" alt="Archive - polycut.tar.gz"></a> <a href="source/mappers/polycut/polycut.tar.Z"> <img src="../../../../img/tarz.gif" border="0" width="52" height="30" alt="Archive - polycut.tar.Z"></a> <a href="source/mappers/polycut/polycut.zip"> <img src="../../../../img/zip.gif" border="0" width="52" height="30" alt="Archive - polycut.zip"></a> <a href="image_polycut.shtml" target="_top"> <img src="../../../../img/image.gif" border="0" width="42" height="30" alt="Example Image"></a> <img src="../../../../img/7.1.gif" alt="Tested for AVS/Express Version 7.1" border="0" height="30" width="47"> <img src="../../../../img/64bit.gif" alt="Tested for 64 Bit" border="0" height="30" width="53"> </td> </tr> </table> <br> </td> </tr> <tr> <td>  <h1>CutPolylines</h1> <h3>Synopsis</h3> <p> A mapper module that cuts a 3D polyline mesh on an imported cut-plane. This allows one to cut a bounding box of an object with the object inside. </p> <p> <h4>Input Ports</h4> <table class="parameters" summary="Input Ports of the CutPolylines macro"> <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_cut</i></td> <td width="75">&cut_plane</td> <td width="425">reference to a cut_plane module. This cut plane module provides the location of the cuting plane.</td> </tr> <tr> <td width="100"><i>in_polyline</i></td> <td width="75">Mesh+Data</td> <td width="425">polyline Mesh that is to be cut on the plane provieded by in_cut.</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> </p> <p> <h4>Output Ports</h4> <table class="parameters" summary="Ouput Ports of cylinder_cut macro"> <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</i></td> <td width="75">Mesh+Data</td> <td width="425">output field after cutting</td> </tr> <tr> <td width="100"><i>obj</i></td> <td width="75">DataObject</td> <td width="425">directly renderable output object</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> </p> <h3>Description</h3> <p> The CutPolylines macro crops a 3D polyline mesh according to the parameters of another cut_plane module. The module itself does not provide a user interface as all necessary parameters are taken from the provided cut_plane. This aligns the cut of ie. a bounding box of a given object with the cut of the object itself. The CutPolylines macro needs a reference to the cut_plane module itself as input rather than one of its outputs. This allows the use of additional internal parameters such as the distance to the cutting plane for cutting the polyline mesh. A simple network to use the module could look: </p> <center> <table> <tr><td> <img src="source/mappers/polycut/pc_network.png" alt="Network for CutPolylines"></img> </td> </tr> </table> </center> </p> <h4>Inputs</h4> <p> <i><b>in_cut</b></i> </p> <p> Reference to the field input that is to be cropped. The field should contain at least a Mesh component. If Node_Data or Cell_Data components are present then the user interface can be used to specify which of these should be copied across to the output. </p> <p> <i><b>in_polyline</b></i> </p> <p> Reference to the polyline field input that is to be cropped. </p> <h4>Outputs</h4> <p> <i><b>out</b></i> </p> <p> The most primitive output field of the CutPolylines macro. This contains the new 3D polyline mesh model generated from the model present on the input, cropped using the plane specified by the module connected to in_cut. </p> <p> <i><b>obj</b></i> </p> <p> The directly renderable output field of the CutPolylines macro. This contains a DataObject object that can be rendered by the standard data viewers. The Data Object is generated directly from the field data created from the input model. </p> <h3>Utility Modules</h3> <p> The User Macro CutPolylines makes use of the CutPolylinesCore module. </p> <h3>Example</h3> <p> An example application CutPolylinesEg is provided, which loads an Example field file and and cuts the bounding box on the same plane as the isosurface of the object. </p> <h3>Files</h3> <p><i>iac_proj/polycut/polycut.v</i> Creates the IAC_PROJ.CutPolylines library.</p> <p><i>iac_proj/polycut/pc_mods.v</i> Creates the CutPolylinesMods library containing the low-level module CutPolylinesCore and CutPolylinesTest.</p> <p><i>iac_proj/polycut/pc_macs.v</i> Creates the CutPolylinesMacs library containing the high-level macro CutPolylines.</p> <p><i>iac_proj/polycut/pc_apps.v</i> Creates the CutPolylinesApps library containing the example applications CutPolylinesEg.</p> <h3>Authors</h3> <p> </p><pre>Dr Joanna Leng Manchester Visualization Centre </pre> <p></p> <h3>Modifications</h3> <p> </p><pre>Tobias Schiebeck Manchester Visualization Centre </pre> <p></p> <h3>Contact</h3> <p> </p><pre>International AVS Centre Manchester Visualization Centre Kilburn Building University of Manchester Oxford Road Manchester United Kingdom M13 9PL </pre>  </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:  28th April 2008 </td> </tr> </table>