<![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">P0004</th>
<th nowrap width="98%">Tube</th>
<th nowrap width="1%">21st July 1999</th>
</tr>
<tr>
<td align="left" colspan="3">
<p><b>Authors:</b> Jeremy Maccelari and Andrew Dodd
<b>Version:</b> 1.1
<b>Path:</b> iac_proj/tube/</p>
<a href="../../mappers.shtml" target="_top"><img src="../../../../img/mapper.gif" width="58" height="30" border="0" alt="Mapper"></a>
<a href="tube.shtml" target="_top">
<img src="../../../../img/doc_mod.gif" border="0"
width="30" height="30"
alt="Module Document - Tube"></a>
<a href="source/mappers/tube/tube.tar.gz">
<img src="../../../../img/targz.gif"
border="0" width="52" height="30"
alt="Archive - tube.tar.gz"></a>
<a href="source/mappers/tube/tube.tar.Z">
<img src="../../../../img/tarz.gif"
border="0" width="52" height="30"
alt="Archive - tube.tar.Z"></a>
<a href="source/mappers/tube/tube.zip">
<img src="../../../../img/zip.gif"
border="0" width="52" height="30"
alt="Archive - tube.zip"></a>
<a href="image_tube.shtml" target="_top">
<img src="../../../../img/image.gif"
border="0" width="42" height="30"
alt="Example Image"></a>
</td>
</tr>
</table>
<br>
</td>
</tr>
<tr>
<td>
<!-- BEGIN CONTENT PAGE -->
<h1>tube</h1>
<h3>Synopsis</h3>
<p>Converts line and polyline cell_sets to tubes.</p>
<p>
<hr>
<pre>
module tube <build_dir="iac_proj/tube",
src_file="tube.cxx",
out_src_file="gen.cxx",
out_hdr_file="gen.hxx",
libdeps="FLD",
cxx_hdr_files="fld/Xfld.h",
process="express">
{
cxxmethod+req upd(
.in+notify+read+req,
.axis+notify+read+req,
.xform+notify+read+req,
.zscale+notify+read+req,
.resolution+notify+read+req,
.normalise+read+notify+req,
.scale+read+notify+req,
.node_cell+read+notify+req,
.node_data_comp+read+notify+req,
.cell_data_comp+read+notify+req,
.col_data_comp+notify+read+req,
.out+write,
.err+write,
.err_str+write
);
VISmesh+IPort2 &in<export=2>;
int+IPort2 axis<export=2>;
int+IPort2 xform<export=2>;
float+IPort2 zscale<export=2>;
int+IPort2 resolution<export=2>;
int+IPort2 normalise<export=2>;
float+IPort2 scale<export=2>;
int+IPort2 node_cell<export=2>;
int+IPort2 node_data_comp<export=2>;
int+IPort2 cell_data_comp<export=2>;
int+IPort2 col_data_comp<export=2>;
Field+OPort2 out<export=2>;
int+OPort2 err<export=2>;
string+OPort2 err_str<export=2>;
};
</pre>
<hr>
</p>
<h3>Description</h3>
<p>This module takes a field with line or polyline cell_sets, and
generates tubes for the lines, which may be coloured using
another dataset. Each line cell is turned into a tube. All other
cell types are ignored.</p>
<p>The radii are controlled by the data. The radii may be cell-
or node-based. Cell-based radii (i.e. from the cell_data[])
ensure each tube has a constant radius. Node-based (i.e. from the
node_data[]) allows the radius of the tube to vary across the
cell. If there is no data, normalise is set and the scale value
used.</p>
<p>Similarly, the colours are based on cell- or node-data. Colour
data is optional.</p>
<p>The 2D mode is designed for use with output from modules like
isoline. I calculate the tubes on the XY plane (by default) and
then use the input field's xform to xform the tubes to the
correct orientation in 3D space.</p>
<p>All data must be scalar!</p>
<p>Limitations:</p>
<p>
<ul>
<li>Does not handle NULL data</li>
<li>Data must be scalar</li>
<li>Data is type cast to float</li>
</ul>
</p>
<h3>Inputs</h3>
<p><b>in</b>: Mesh 3D/2D with either line or polyline cell_sets.
May have node and/or cell data to define radii and colours.</p>
<p><b>axis</b>: axis to project 2D data (like the output from
isoline) perpendicular to (default is 2 = Z).</p>
<p><b>xform</b>: toggle whether to copy in xform to out or not.
This is useful for 2D datasets like isoline which are calculated
on the XY plane and then use the xform to transform them to the
correct position in 3D space.</p>
<p><b>zscale</b>: some 2D modules (like slice_plane) don't scale
Z with X and Y. This allows the user to scale Z manually</p>
<p><b>resolution</b>: number of facets for each tube.</p>
<p><b>normalise</b>: toggle for normalising: 0 - no normalising -
uses data for radii; 1 - all radii set to scale - does not use
data. If data is invalid (either not there or vector), this flag
is automatically set.</p>
<p><b>scale</b>: scale factor for radii.</p>
<p><b>node_cell</b>: toggle for selecting whether to use cell or
node data: 0 - use node data defined by node_data_comp; 1 - use
cell data defined by cell_data_comp</p>
<p><b>node_data_comp</b>: the data to use if node_cell == 0</p>
<p><b>cell_data_comp</b>: the data to use if node_cell == 1</p>
<p><b>col_data_comp</b>: the node data to use for colouring. If
node_cell == 0, we use node data, else we use cell_data.</p>
<h3>Outputs</h3>
<p><b>out</b>: Field 3D Quad cell set</p>
<p><b>err</b>: error toggle</p>
<p><b>err_str</b>: error string</p>
<h3>Utility Macros</h3>
<p>Parameter Group: TubeParams</p>
<p>Functional Macro: Tube</p>
<p>UI Macro: TubeUI</p>
<p>User Macro: tube</p>
<h3>Example</h3>
<p>TubeEg1 and TubeEg2</p>
<h3>Files</h3>
<p><i>iac_proj/tube/tube.v</i>, <i>
iac_proj/tube/tubemods.v</i>, <i>
iac_proj/tube/tubemacs.v</i></p>
<h3>Other Notes</h3>
<p>Revisions:</p>
<p>
<ul>
<li>added 2D support, 26/08/97, JM</li>
<li>added multiple cell_set support, 26/08/97, JM</li>
<li>added xform for 2D, 26/08/97, JM</li>
<li>fixed up checks for invalid cell and node data, 26/08/97,
JM</li>
<li>fixed up data limits, 26/07/97, JM</li>
<li>changed from (OMobj_id) to .obj_id(), 19/07/99, AWD</li>
</ul>
</p>
<h3>Author</h3>
<p>
<pre>
Jeremy Maccelari
<a href="mailto:visuals@solo.pipex.co.za">visuals@solo.pipex.co.za</a>
</pre>
</p>
<h3>Modifications</h3>
<p>
<pre>
Andrew Dodd
</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>
<!-- 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" -->
26th November 2002
<!-- #EndEditable --></td>
</tr>
</table>
]]>