Files
opennurbs/6/opennurbs__dimensionformat_8h_source.html
Bozo 2d5c650ea1 Publish!
Generated from TESTING
2018-01-26 12:35:52 +00:00

95 lines
21 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>openNURBS SDK Help: /Users/will/dev/github/mcneel/rhino/src4/bin/opennurbs_public/opennurbs_dimensionformat.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">openNURBS SDK Help
&#160;<span id="projectnumber">6.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_2ea30aa2956a8db99dd22aa5e597f384.html">bin</a></li><li class="navelem"><a class="el" href="dir_7a6cfee8d318bd47c162fe536aecd3a7.html">opennurbs_public</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">opennurbs_dimensionformat.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">/* $NoKeywords: $ */</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// Copyright (c) 1993-2012 Robert McNeel &amp; Associates. All rights reserved.</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// OpenNURBS, Rhinoceros, and Rhino3D are registered trademarks of Robert</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// McNeel &amp; Associates.</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// THIS SOFTWARE IS PROVIDED &quot;AS IS&quot; WITHOUT EXPRESS OR IMPLIED WARRANTY.</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// ALL IMPLIED WARRANTIES OF FITNESS FOR ANY PARTICULAR PURPOSE AND OF</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// MERCHANTABILITY ARE HEREBY DISCLAIMED.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// For complete openNURBS copyright information see &lt;http://www.opennurbs.org&gt;.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">//</span><span class="comment"></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">////////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"></span>*/</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">// ON_Table class</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#ifndef OPENNURBS_NUMBERFORMAT_H_INCLUDED</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define OPENNURBS_NUMBERFORMAT_H_INCLUDED</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="class_o_n___number_formatter.html"> 22</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_o_n___number_formatter.html">ON_NumberFormatter</a></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;{</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <a class="code" href="class_o_n___number_formatter.html">ON_NumberFormatter</a>();</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="class_o_n___number_formatter.html#a482f8723cbe84ff427ad2cb29491e384"> 26</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_o_n___number_formatter.html#a482f8723cbe84ff427ad2cb29491e384">bFormatIsAccurate</a>;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_o_n___number_formatter.html#a07a106c692ee8eb209d1beda2f2b2ee4">Fraction</a>(</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordtype">double</span> value,</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordtype">int</span>&amp; wholenumber,</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordtype">int</span>&amp; numerator,</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordtype">int</span>&amp; denominator,</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordtype">int</span> precision);</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">static</span> <span class="keywordtype">double</span> <a class="code" href="class_o_n___number_formatter.html#a7cbba60cc0ac057c858d8961292c6bc0">RoundOff</a>(</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordtype">double</span> number,</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordtype">double</span> round_off);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_o_n___number_formatter.html#a1e6c07448fe45f2ef9c58756c4811d1f">SuppressZeros</a>(</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="class_o_n__w_string.html">ON_wString</a>&amp; dist,</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <a class="code" href="class_o_n___dim_style.html#a837e18d965995041e841cf510e83cd44">ON_DimStyle::suppress_zero</a> sz);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="comment">// When FormatNumber() or FormatLength() is called with </span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="comment">// output_lengthformat == ON_DimStyle::OBSOLETE_length_format::FeetInches</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="comment">// distance must be in decimal feet units to get the right answer.</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_o_n___number_formatter.html#a71c6c78b444dae70b622895136c3232c">FormatNumber</a>(</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordtype">double</span> distance,</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <a class="code" href="class_o_n___dim_style.html#aeece0b5c27a6d625454cdeb931352840">ON_DimStyle::OBSOLETE_length_format</a> output_lengthformat, <span class="comment">// dec, frac, ft-in</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordtype">double</span> round_off,</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordtype">int</span> resolution,</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <a class="code" href="class_o_n___dim_style.html#a837e18d965995041e841cf510e83cd44">ON_DimStyle::suppress_zero</a> zero_suppress,</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">bool</span> bracket_fractions,</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <a class="code" href="class_o_n__w_string.html">ON_wString</a>&amp; output);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="comment">// When FormatNumber() or FormatLength() is called with </span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="comment">// output_lengthformat == ON_DimStyle::LengthDisplay::FeetAndInches</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="comment">// distance must be in decimal feet units to get the right answer.</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_o_n___number_formatter.html#a914656f8164b26486cfc030b583c2c28">FormatLength</a>(</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordtype">double</span> distance,</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <a class="code" href="class_o_n___dim_style.html#af27da5e20982ca9c8efeb3a4fab055c4">ON_DimStyle::LengthDisplay</a> output_lengthdisplay,</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordtype">double</span> round_off,</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordtype">int</span> resolution,</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <a class="code" href="class_o_n___dim_style.html#a837e18d965995041e841cf510e83cd44">ON_DimStyle::suppress_zero</a> zero_suppress,</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordtype">bool</span> bracket_fractions,</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <a class="code" href="class_o_n__w_string.html">ON_wString</a>&amp; output);</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_o_n___number_formatter.html#ab212e31502d9012f6fb36471798d1657">FormatAngleStringDMS</a>(</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordtype">double</span> angle_degrees,</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <a class="code" href="class_o_n__w_string.html">ON_wString</a>&amp; formatted_string);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_o_n___number_formatter.html#a88e293a7393b159ee52681f1faf3f089">FormatAngleStringDecimal</a>(</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keywordtype">double</span> angle_radians,</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordtype">int</span> resolution,</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordtype">double</span> roundoff,</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <a class="code" href="class_o_n___dim_style.html#a837e18d965995041e841cf510e83cd44">ON_DimStyle::suppress_zero</a> zero_suppression,</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <a class="code" href="class_o_n__w_string.html">ON_wString</a>&amp; formatted_string);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;};</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div><div class="ttc" id="class_o_n___number_formatter_html_a914656f8164b26486cfc030b583c2c28"><div class="ttname"><a href="class_o_n___number_formatter.html#a914656f8164b26486cfc030b583c2c28">ON_NumberFormatter::FormatLength</a></div><div class="ttdeci">static bool FormatLength(double distance, ON_DimStyle::LengthDisplay output_lengthdisplay, double round_off, int resolution, ON_DimStyle::suppress_zero zero_suppress, bool bracket_fractions, ON_wString &amp;output)</div></div>
<div class="ttc" id="class_o_n___number_formatter_html_a1e6c07448fe45f2ef9c58756c4811d1f"><div class="ttname"><a href="class_o_n___number_formatter.html#a1e6c07448fe45f2ef9c58756c4811d1f">ON_NumberFormatter::SuppressZeros</a></div><div class="ttdeci">static void SuppressZeros(ON_wString &amp;dist, ON_DimStyle::suppress_zero sz)</div></div>
<div class="ttc" id="class_o_n___dim_style_html_a837e18d965995041e841cf510e83cd44"><div class="ttname"><a href="class_o_n___dim_style.html#a837e18d965995041e841cf510e83cd44">ON_DimStyle::suppress_zero</a></div><div class="ttdeci">suppress_zero</div><div class="ttdoc">Marks leading and trailing zeros for removal. </div><div class="ttdef"><b>Definition:</b> opennurbs_dimensionstyle.h:973</div></div>
<div class="ttc" id="class_o_n___number_formatter_html_a07a106c692ee8eb209d1beda2f2b2ee4"><div class="ttname"><a href="class_o_n___number_formatter.html#a07a106c692ee8eb209d1beda2f2b2ee4">ON_NumberFormatter::Fraction</a></div><div class="ttdeci">static void Fraction(double value, int &amp;wholenumber, int &amp;numerator, int &amp;denominator, int precision)</div></div>
<div class="ttc" id="class_o_n___number_formatter_html_a7cbba60cc0ac057c858d8961292c6bc0"><div class="ttname"><a href="class_o_n___number_formatter.html#a7cbba60cc0ac057c858d8961292c6bc0">ON_NumberFormatter::RoundOff</a></div><div class="ttdeci">static double RoundOff(double number, double round_off)</div></div>
<div class="ttc" id="class_o_n___number_formatter_html_a71c6c78b444dae70b622895136c3232c"><div class="ttname"><a href="class_o_n___number_formatter.html#a71c6c78b444dae70b622895136c3232c">ON_NumberFormatter::FormatNumber</a></div><div class="ttdeci">static bool FormatNumber(double distance, ON_DimStyle::OBSOLETE_length_format output_lengthformat, double round_off, int resolution, ON_DimStyle::suppress_zero zero_suppress, bool bracket_fractions, ON_wString &amp;output)</div></div>
<div class="ttc" id="class_o_n___dim_style_html_af27da5e20982ca9c8efeb3a4fab055c4"><div class="ttname"><a href="class_o_n___dim_style.html#af27da5e20982ca9c8efeb3a4fab055c4">ON_DimStyle::LengthDisplay</a></div><div class="ttdeci">LengthDisplay</div><div class="ttdoc">Interface. </div><div class="ttdef"><b>Definition:</b> opennurbs_dimensionstyle.h:445</div></div>
<div class="ttc" id="class_o_n__w_string_html"><div class="ttname"><a href="class_o_n__w_string.html">ON_wString</a></div><div class="ttdef"><b>Definition:</b> opennurbs_string.h:2089</div></div>
<div class="ttc" id="class_o_n___number_formatter_html_ab212e31502d9012f6fb36471798d1657"><div class="ttname"><a href="class_o_n___number_formatter.html#ab212e31502d9012f6fb36471798d1657">ON_NumberFormatter::FormatAngleStringDMS</a></div><div class="ttdeci">static bool FormatAngleStringDMS(double angle_degrees, ON_wString &amp;formatted_string)</div></div>
<div class="ttc" id="class_o_n___number_formatter_html"><div class="ttname"><a href="class_o_n___number_formatter.html">ON_NumberFormatter</a></div><div class="ttdoc">ON_Table class. </div><div class="ttdef"><b>Definition:</b> opennurbs_dimensionformat.h:22</div></div>
<div class="ttc" id="class_o_n___number_formatter_html_a482f8723cbe84ff427ad2cb29491e384"><div class="ttname"><a href="class_o_n___number_formatter.html#a482f8723cbe84ff427ad2cb29491e384">ON_NumberFormatter::bFormatIsAccurate</a></div><div class="ttdeci">static bool bFormatIsAccurate</div><div class="ttdef"><b>Definition:</b> opennurbs_dimensionformat.h:26</div></div>
<div class="ttc" id="class_o_n___dim_style_html_aeece0b5c27a6d625454cdeb931352840"><div class="ttname"><a href="class_o_n___dim_style.html#aeece0b5c27a6d625454cdeb931352840">ON_DimStyle::OBSOLETE_length_format</a></div><div class="ttdeci">OBSOLETE_length_format</div><div class="ttdoc">Obsolete format for length display - use ON_DimStyle::DimensionLengthDisplay instead ...</div><div class="ttdef"><b>Definition:</b> opennurbs_dimensionstyle.h:901</div></div>
<div class="ttc" id="class_o_n___number_formatter_html_a88e293a7393b159ee52681f1faf3f089"><div class="ttname"><a href="class_o_n___number_formatter.html#a88e293a7393b159ee52681f1faf3f089">ON_NumberFormatter::FormatAngleStringDecimal</a></div><div class="ttdeci">static bool FormatAngleStringDecimal(double angle_radians, int resolution, double roundoff, ON_DimStyle::suppress_zero zero_suppression, ON_wString &amp;formatted_string)</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 25 2018 17:01:08 for openNURBS SDK Help by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>