User Macro Document - DashGauge

<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">P0190</th> <th nowrap width="98%">DashGauge</th> <th nowrap width="1%">19th April 2002</th> </tr> <tr> <td align="left" colspan="3"> <p><b>Authors:</b> Ian Curington, AVS Inc.; MA YingLiang, MVC; Tobias Schiebeck, IAC <b>Version:</b> 1.0 <b>Path:</b> iac_proj/dh_gauge/</p> <a href="../../misc.shtml" target="_top"><img src="../../../../img/misc.gif" width="42" height="30" border="0" alt="Miscellaneous"></a> <a href="DhGauge.shtml" target="_top"> <img src="../../../../img/doc_umac.gif" border="0" width="30" height="30" alt="User Macro Document - DashGauge"></a> <a href="source/misc/dh_gauge/dh_gauge.tar.gz"> <img src="../../../../img/targz.gif" border="0" width="52" height="30" alt="Archive - dh_gauge.tar.gz"></a> <a href="source/misc/dh_gauge/dh_gauge.tar.Z"> <img src="../../../../img/tarz.gif" border="0" width="52" height="30" alt="Archive - dh_gauge.tar.Z"></a> <a href="source/misc/dh_gauge/dh_gauge.zip"> <img src="../../../../img/zip.gif" border="0" width="52" height="30" alt="Archive - dh_gauge.zip"></a> <a href="image_gauge.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>  <h1>DashGauge</h1> <h3>Synopsis</h3> <p> A colorful User Interface gauge module to output a float value. </p> <h4>Parameters</h4> <table class="parameters"> <tr> <td width="100"><b>Name</b></td> <td width="75"><b>Type</b></td> <td width="300"><b>Description</b></td> </tr> <tr> <td colspan="4"><hr></td> </tr> <tr> <td width="100"><i>visible</i></td> <td width="75">int</td> <td width="300">Toggles the visibility of the DashGauge UIpanel.</td> </tr> <tr> <td width="100"><i>parent</i></td> <td width="75">UIconnection</td> <td width="300">The User interface parent object.</td> </tr> <tr> <td width="100"><i>step_value</i></td> <td width="75">float</td> <td width="300">The float value data to be shown by DashGauge.</td> </tr> <tr> <td width="100"><i>title</i></td> <td width="75">string</td> <td width="300">The title of the DashGauge in the UI.</td> </tr> <tr> <td colspan="4"><hr></td> </tr> </table> <h3>Description</h3> <p>This provides three colorful User Interface modules to display float values. These modules display a changing float value like a traditional gauge. It shows the needle, dial and text in a 2D viewer (dash_camera). The needle and text display is implemented using the "mk_needle" and "mk_dashtext" modules similar to the ones released with the GlyphLibrary. GlyphLibrary. </p><p> This modules only provide the User Interface modules. They do not contain a UImod_panel.</p> <center> <IMG src="source/misc/dh_gauge/gauge.jpg" alt="DashGauge UI element"> </center> <h4>Parameters</h4> <p> <i><b>visible</b></i> </p> <p> This integer value swiches the DashGauge User Interface element on or off. The elements themself are not disabled. They are just hidden with the UIpanel. </p> <p> <i><b>parent</b></i> </p> <p> This UIconnection value contains the User Interface element which provides the parent frame or panel for the DashGauge element. </p> <p> <i><b>step_value</b></i> </p> <p> This parameter contains the float value which is to be shown by the gauge. This value is not constrained. If this value is in the range between 0 and 100, the needle will move in a range from 0 to 180 degrees. </p> <p> <i><b>title</b></i> </p> <p> The title string is displayed at the bottom of the DashGauge User Interface element. It is by default the name of the Module in the Network editor. </p> <h3>Utility Modules</h3> <p> The DashGauge project provides three modules DashGaugeA, DashGaugeB and DashGaugeC. These modules use the common utility modules dash_camera, mk_dashtext, mk_needle, transform_needle, arc_grid and arc_solid. </p><p> dash_camera defines a very simple camera system to display the 2D dashboard widget. This camera does not contain picking functions. </p><p> mk_needle and transform_needle provide the fuctionality to draw and rotate the needle to show the value given by step_value. </p><p> mk_dashtext, arc_grid and arc_solid provide the functionality to draw the DashGauge backgrounds. </p> <h3>Example</h3> <p> An example application DashGaugeArrayEg is provided, which demonstrates displaying output values in the different ways. </p> <h3>Files</h3> <p><i>iac_proj/dh_gauge/dhg_macs.v</i> contains the V definitions of the low level macros dash_camera, mk_dashtext, mk_needle, transform_needle, arc_grid and arc_solid as well as the User Interface Macros DashGaugeA, DashGaugeB and DashGaugeC. </p> <p><i>iac_proj/dh_gauge/dhg_apps.v</i> contains the V definition of the example application DashGaugeArrayEg.</p> <h3>Author</h3> <p> <pre> Ian Curington Advanced Visual Systems, Inc. </pre> </p> <h3>Modifications</h3> <p> <pre> MA YingLiang Manchester Visualization Centre Tobias Schiebeck International AVS Centre </pre> </p> <h3>Contact</h3> <p> <pre> International AVS Centre Manchester Computing University of Manchester Oxford Road Manchester United Kingdom M13 9PL </pre> </p> <h3>See Also</h3> <p> GlyphLibrary, DashDial </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>