User Macro Document - Profile

<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">P0178</th> <th nowrap width="98%">Profile</th> <th nowrap width="1%">5th December 2001</th> </tr> <tr> <td align="left" colspan="3"> <p><b>Authors:</b> Ian Curington, AVS Inc.; Simone Herrmann, MVC <b>Version:</b> 1.0 <b>Path:</b> iac_proj/profile/</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="profile.shtml" target="_top"> <img src="../../../../img/doc_umac.gif" border="0" width="30" height="30" alt="User Macro Document - Profile"></a> <a href="source/data_io/profile/profile.tar.gz"> <img src="../../../../img/targz.gif" border="0" width="52" height="30" alt="Archive - profile.tar.gz"></a> <a href="source/data_io/profile/profile.tar.Z"> <img src="../../../../img/tarz.gif" border="0" width="52" height="30" alt="Archive - profile.tar.Z"></a> <a href="source/data_io/profile/profile.zip"> <img src="../../../../img/zip.gif" border="0" width="52" height="30" alt="Archive - profile.zip"></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>Profile</h1> <h3>Synopsis</h3> <p> Interactive profile editor. A dedicated area in the User Interface is used as a conceptual touchpad to draw an outline in the Scene Window. </p> <h4>Parameters</h4> <h5>ProfileParams</h5> <table class="parameters" summary="Parameters used by Profile"> <tr> <td width="100"><b>Name</b></td> <td width="200"><b>Type</b></td> <td width="300"><b>Description</b></td> <td width="125"><b>UI Control</b></td> </tr> <tr> <td colspan="4"><hr></td> </tr> <tr> <td width="100"><i>nx</i></td> <td width="200">int</td> <td width="425">number of pixels in a line</td> </tr> <tr> <td width="100"><i>ny</i></td> <td width="200">int</td> <td width="425">number of pixels in column</td> </tr> <tr> <td width="100"><i>x</i></td> <td width="200">int</td> <td width="425">x-coordinate of the mouse position</td> <td width="425">UIframe</td> </tr> <tr> <td width="100"><i>y</i></td> <td width="200">int</td> <td width="425">y-coordinate of the mouse position</td> <td width="425">UIframe</td> </tr> <tr valign=top> <td width="100"><i>state</i></td> <td width="200">int</td> <td width="425">current state of the left mouse button </td> <td width="425">UIframe</td> </tr> <tr valign=top> <td width="100"><i>mode</i></td> <td width="200">int</td> <td width="425">current mode of drawing image 0 = constant colour on the right side of line<br> 1 = colour on the right side of the line depends on drawing speed<br> 2 = colour on the left side of the line depends on drawing speed </td> <td width="425">UIslider</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h4>Output Ports</h4> <table class="parameters" summary="Output Ports used by Profile"> <tr> <td width="100"><b>Name</b></td> <td width="200"><b>Type</b></td> <td width="425"><b>Description</b></td> </tr> <tr> <td colspan="3"><hr></td> </tr> <tr> <td width="100"><i>line_out</i></td> <td width="200">mesh</td> <td width="425">data of the point mesh representing the points on the drawn lines</td> </tr> <tr> <td width="100"><i>line_obj</i></td> <td width="200">data object</td> <td width="425">directly renderable object</td> </tr> <tr> <td width="100"><i>img_out</i></td> <td width="200">uniform field</td> <td width="425">represents the image generated with by the drawn lines</td> </tr> <tr> <td width="100"><i>img_obj</i></td> <td width="200">data object</td> <td width="425">directly renderable object</td> </tr> <tr> <td colspan="3"><hr></td> </tr> </table> <h3>Description</h3> <p> The Parameters the module needs are given by the user by drawing with the mouse in the UIframe. Whenever there is a mouse event the profile update function is called. The functoin ignores the mouse event button up.<br> <br> If the mouse position is outside the UIframe the current local position (<i>local_x, local_y</i>) is set to the border of the frame (clipping).<br> <br> When the left mouse button is down the previuos position (<i>local_px, local_py</i>) is initialized by the local position before the local position is set to the new mouse position.<br> <br> The module sets the pixel of the image between the old and the new mouse position in the <i>map_array</i> to a certain value corresponding to the mode parameter given by the user. Moreover it sets the x-values for each y coordinate in the <i>line_arr</i>. </p> <h3>Parameters</h3> <p><b><i>nx, ny</i></b></p> <p>The Maximums of pixels in the x- and y-direction are given by the random size of the UIframe. The UIframe is quadratic. That is why <i>nx</i> equals <i>ny</i>.</p> <p><b><i>x, y</i></b></p> <p><b><i>state</i></b></p> <p>The current state of the left mouse button can be button down, running or button has been released</p> <p><b><i>mode</i></b></p> <p>The current mode of drawing image can have the following values:<br> 0 = constant colour on the right side of line<br> 1 = colour on the right side of the line depends on drawing speed<br> 2 = colour on the left side of the line depends on drawing speed</p> <h4>Outputs</h4> <p><b><i>line_out</i></b></p> <p>Contains point coordinates which x-values are taken from the <i>line_arr</i> mentioned in Descriptions</p> <p><b><i>line_obj</i></b></p> <p><b><i>img_out</i></b></p> <p>Uses the data from the <i>map_arr</i> which is described in Descriptions</p> <p><b><i>img_obj</i></b></p> <h3>Example</h3> <p> There are two example applications. <i>ProfileEg_line</i> views the line object and <i>ProfileEg_img</i> views the image with the help of a <i>Uviewer2D</i>. </p> <h3>Files</h3> <p><i>iac_proj/profile/profile.v</i> Creates the IAC_PROJ.Profile library</p> <p><i>iac_proj/profile/profmods.v</i> Creates the ProfileMods library containing the low-level module ProfileCore and the parameter block ProfileParams.</p> <p><i>iac_proj/profile/profmacs.v</i> Creates the ProfileMacs library containing the high-level functional macro ProfileFunc, user interface macro ProfileUI and the user macro Profile.macro definition</p> <p><i>iac_proj/profile/profapps.v</i> Creates the ProfileApps library containing the example applications ProfileEg_line and ProfileEg_img.</p> <h3>Author</h3> <p> <pre> Ian Curington, Advanced Visual Systems Inc. </pre> </p> <h3>Modifications</h3> <p> <pre> Simone Herrmann Manchester Visualization Centre </pre> </p> <h3>Contact</h3> <p> <pre> International AVS Centre Manchester Visualization Centre Kilburn Building University of Manchester Oxford Road Manchester United Kingdom M13 9PL </pre> </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:  22nd January 2008 </td> </tr> </table>