mirror of
https://github.com/mcneel/opennurbs.git
synced 2026-03-30 07:26:53 +08:00
997 lines
55 KiB
HTML
997 lines
55 KiB
HTML
<!-- HTML header for doxygen 1.8.13-->
|
|
<!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.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>openNURBS SDK Help: ON_LengthValue Class Reference</title>
|
|
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
|
|
<!-- <script type="text/javascript" src="../../jquery.js"></script> -->
|
|
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
|
|
<script type="text/javascript" src="../../dynsections.js"></script>
|
|
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="../../customdoxygen.css" rel="stylesheet" type="text/css"/>
|
|
<!-- bootstrap -->
|
|
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
|
|
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
|
|
<!-- smartmenus -->
|
|
<link href="../../jquery.smartmenus.bootstrap.css" rel="stylesheet">
|
|
<script type="text/javascript" src="../../jquery.smartmenus.js"></script>
|
|
<script type="text/javascript" src="../../jquery.smartmenus.bootstrap.js"></script>
|
|
</head>
|
|
<body>
|
|
<!-- <div class="version-banner">
|
|
Go back to the <a href="/">main site</a>...
|
|
</div> -->
|
|
<div class="container">
|
|
<!-- navbar -->
|
|
<nav class="navbar navbar-default">
|
|
<div class="container-fluid">
|
|
<a class="navbar-brand" href="#">openNURBS SDK Help</a>
|
|
<div class="navbar-collapse collapse" id="main-nav-placeholder">
|
|
<!-- <p class="navbar-text navbar-right">v6.0</p> -->
|
|
<ul class="nav navbar-nav navbar-right">
|
|
<li class="dropdown">
|
|
<a class="dropdown-toggle" href="#">v6.0 <span class="caret"></span></a>
|
|
<ul class="dropdown-menu">
|
|
<li><a href="#">Latest (6.x)</a></li>
|
|
<li class="disabled"><a href="#">WIP (7.x)</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div class="page-content">
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript" src="../../menudata.js"></script>
|
|
<script type="text/javascript" src="../../menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('../../',false,false,'search.php','Search');
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="#pub-static-attribs">Static Public Attributes</a> |
|
|
<a href="../../d2/d00/class_o_n___length_value-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">ON_LengthValue Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="../../d4/ddf/opennurbs__string__value_8h_source.html">opennurbs_string_value.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:ae6ffd4bc4f67c82b2081b49ca138170c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#ae6ffd4bc4f67c82b2081b49ca138170c">StringFormat</a> : unsigned char { <br />
|
|
  <a class="el" href="../../dc/d39/class_o_n___length_value.html#ae6ffd4bc4f67c82b2081b49ca138170ca99ec4b2cce408e50ed2c69737c07e588">StringFormat::ExactDecimal</a> = 0,
|
|
<a class="el" href="../../dc/d39/class_o_n___length_value.html#ae6ffd4bc4f67c82b2081b49ca138170cac67056f962e7c2a68ca9e1539e81f00a">StringFormat::ExactProperFraction</a> = 1,
|
|
<a class="el" href="../../dc/d39/class_o_n___length_value.html#ae6ffd4bc4f67c82b2081b49ca138170ca2443c1a956f7b565f66751cd6fbc2984">StringFormat::ExactImproperFraction</a> = 2,
|
|
<a class="el" href="../../dc/d39/class_o_n___length_value.html#ae6ffd4bc4f67c82b2081b49ca138170caa816afb2cc234c2298c013a663febbd5">StringFormat::CleanDecimal</a> = 3,
|
|
<br />
|
|
  <a class="el" href="../../dc/d39/class_o_n___length_value.html#ae6ffd4bc4f67c82b2081b49ca138170ca00c3183f3025881f146a6e4d4506412f">StringFormat::CleanProperFraction</a> = 4,
|
|
<a class="el" href="../../dc/d39/class_o_n___length_value.html#ae6ffd4bc4f67c82b2081b49ca138170caaab6a8cd17a458edc215dd82118d0613">StringFormat::CleanImproperFraction</a> = 5
|
|
<br />
|
|
}<tr class="memdesc:ae6ffd4bc4f67c82b2081b49ca138170c"><td class="mdescLeft"> </td><td class="mdescRight">Formatting to apply when creating a length value from a double. <a href="../../dc/d39/class_o_n___length_value.html#ae6ffd4bc4f67c82b2081b49ca138170c">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ae6ffd4bc4f67c82b2081b49ca138170c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:af2906852d32c386789ad4dce5ba115d8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#af2906852d32c386789ad4dce5ba115d8">ON_LengthValue</a> ()=default</td></tr>
|
|
<tr class="separator:af2906852d32c386789ad4dce5ba115d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1313320a4097bb3c1ccf65bca619d908"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#a1313320a4097bb3c1ccf65bca619d908">ON_LengthValue</a> (const <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> &)=default</td></tr>
|
|
<tr class="separator:a1313320a4097bb3c1ccf65bca619d908"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa68e76eaee1ae2ecc1425979a5b86781"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#aa68e76eaee1ae2ecc1425979a5b86781">~ON_LengthValue</a> ()=default</td></tr>
|
|
<tr class="separator:aa68e76eaee1ae2ecc1425979a5b86781"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2687913e1d960a2726fb03228d7825d7"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#a2687913e1d960a2726fb03228d7825d7">ChangeLength</a> (double length_value) const</td></tr>
|
|
<tr class="separator:a2687913e1d960a2726fb03228d7825d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af7020504c14adb679f6e2d5b6fe00702"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="../../dd/ddf/class_o_n___s_h_a1___hash.html">ON_SHA1_Hash</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#af7020504c14adb679f6e2d5b6fe00702">ContentHash</a> () const</td></tr>
|
|
<tr class="separator:af7020504c14adb679f6e2d5b6fe00702"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6e07123b241f5aef7be566ff068d1e5d"><td class="memItemLeft" align="right" valign="top">ON::AngleUnitSystem </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#a6e07123b241f5aef7be566ff068d1e5d">ContextAngleUnitSystem</a> () const</td></tr>
|
|
<tr class="separator:a6e07123b241f5aef7be566ff068d1e5d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2ffc621ebe9328bbfc427b5c616a2b35"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#a2ffc621ebe9328bbfc427b5c616a2b35">ContextLocaleId</a> () const</td></tr>
|
|
<tr class="separator:a2ffc621ebe9328bbfc427b5c616a2b35"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad30245437d6f723a3f508d58eb6636e6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#ad30245437d6f723a3f508d58eb6636e6">IsSet</a> () const</td></tr>
|
|
<tr class="separator:ad30245437d6f723a3f508d58eb6636e6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae8d6da268c36768ce98e9b48a4303eac"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#ae8d6da268c36768ce98e9b48a4303eac">IsUnset</a> () const</td></tr>
|
|
<tr class="separator:ae8d6da268c36768ce98e9b48a4303eac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af4d8ac79774a1fb9ad087aa126f2671d"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#af4d8ac79774a1fb9ad087aa126f2671d">Length</a> (const class <a class="el" href="../../d4/d1c/class_o_n___unit_system.html">ON_UnitSystem</a> &context_unit_system) const</td></tr>
|
|
<tr class="separator:af4d8ac79774a1fb9ad087aa126f2671d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad7559f42f0865cfcc575d5a80644c59f"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#ad7559f42f0865cfcc575d5a80644c59f">Length</a> (ON::LengthUnitSystem context_unit_system) const</td></tr>
|
|
<tr class="separator:ad7559f42f0865cfcc575d5a80644c59f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afbd45406d8a87ebbb1f7363ddde26a33"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#afbd45406d8a87ebbb1f7363ddde26a33">LengthAsString</a> () const</td></tr>
|
|
<tr class="separator:afbd45406d8a87ebbb1f7363ddde26a33"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab162100e6fbb5c671fc36fc02a9b6c5b"><td class="memItemLeft" align="right" valign="top">const wchar_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#ab162100e6fbb5c671fc36fc02a9b6c5b">LengthAsStringPointer</a> () const</td></tr>
|
|
<tr class="separator:ab162100e6fbb5c671fc36fc02a9b6c5b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a562ffc8dcb6f954b4fa8865cbc11234e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../dc/d39/class_o_n___length_value.html#ae6ffd4bc4f67c82b2081b49ca138170c">ON_LengthValue::StringFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#a562ffc8dcb6f954b4fa8865cbc11234e">LengthStringFormat</a> () const</td></tr>
|
|
<tr class="separator:a562ffc8dcb6f954b4fa8865cbc11234e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b19057e6f67bc5397362e3b11585293"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="../../d6/d60/class_o_n___parse_settings.html">ON_ParseSettings</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#a4b19057e6f67bc5397362e3b11585293">LengthStringParseSettings</a> () const</td></tr>
|
|
<tr class="separator:a4b19057e6f67bc5397362e3b11585293"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a62a557b79d8de54f408ecf1fc12a5e3c"><td class="memItemLeft" align="right" valign="top">const class <a class="el" href="../../d4/d1c/class_o_n___unit_system.html">ON_UnitSystem</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#a62a557b79d8de54f408ecf1fc12a5e3c">LengthUnitSystem</a> () const</td></tr>
|
|
<tr class="separator:a62a557b79d8de54f408ecf1fc12a5e3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a476737e2544f4a93cf6b42fcd833327c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#a476737e2544f4a93cf6b42fcd833327c">operator=</a> (const <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> &)=default</td></tr>
|
|
<tr class="separator:a476737e2544f4a93cf6b42fcd833327c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a70210dac7b8edeebd861de62c6363449"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#a70210dac7b8edeebd861de62c6363449">Read</a> (class <a class="el" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a> &archive)</td></tr>
|
|
<tr class="separator:a70210dac7b8edeebd861de62c6363449"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad9d9a60be2ce373016e0b655e3cc1250"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#ad9d9a60be2ce373016e0b655e3cc1250">RemoveUnitSystem</a> () const</td></tr>
|
|
<tr class="separator:ad9d9a60be2ce373016e0b655e3cc1250"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8d08d1e2123fda2e8d0e62b1777d744f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#a8d08d1e2123fda2e8d0e62b1777d744f">Write</a> (class <a class="el" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a> &archive) const</td></tr>
|
|
<tr class="separator:a8d08d1e2123fda2e8d0e62b1777d744f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:ad2552eb9e09d2c0eafe2bff86de20425"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#ad2552eb9e09d2c0eafe2bff86de20425">Compare</a> (const <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> &lhs, const <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> &rhs)</td></tr>
|
|
<tr class="separator:ad2552eb9e09d2c0eafe2bff86de20425"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa665b517fac1a5ad7a69db44961fe9a5"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#aa665b517fac1a5ad7a69db44961fe9a5">Create</a> (double length_value, const class <a class="el" href="../../d4/d1c/class_o_n___unit_system.html">ON_UnitSystem</a> &length_unit_system, unsigned int locale_id, <a class="el" href="../../dc/d39/class_o_n___length_value.html#ae6ffd4bc4f67c82b2081b49ca138170c">ON_LengthValue::StringFormat</a> string_format)</td></tr>
|
|
<tr class="separator:aa665b517fac1a5ad7a69db44961fe9a5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1a035cc582be62e7bbd3b63460824417"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#a1a035cc582be62e7bbd3b63460824417">Create</a> (double length_value, const ON::LengthUnitSystem length_unit_system, unsigned int locale_id, <a class="el" href="../../dc/d39/class_o_n___length_value.html#ae6ffd4bc4f67c82b2081b49ca138170c">ON_LengthValue::StringFormat</a> string_format)</td></tr>
|
|
<tr class="separator:a1a035cc582be62e7bbd3b63460824417"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a809b8a9df3bd9c26e8a262c97ef49a39"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#a809b8a9df3bd9c26e8a262c97ef49a39">Create</a> (double length_value, const class <a class="el" href="../../db/da1/class_o_n___length_unit_name.html">ON_LengthUnitName</a> &length_unit_system, <a class="el" href="../../dc/d39/class_o_n___length_value.html#ae6ffd4bc4f67c82b2081b49ca138170c">ON_LengthValue::StringFormat</a> string_format)</td></tr>
|
|
<tr class="separator:a809b8a9df3bd9c26e8a262c97ef49a39"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa78395036bad41b309d0d3e1509c4e21"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#aa78395036bad41b309d0d3e1509c4e21">CreateFromString</a> (<a class="el" href="../../d6/d60/class_o_n___parse_settings.html">ON_ParseSettings</a> parse_settings, const wchar_t *string)</td></tr>
|
|
<tr class="memdesc:aa78395036bad41b309d0d3e1509c4e21"><td class="mdescLeft"> </td><td class="mdescRight">Create an <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> by parsing a string. <a href="#aa78395036bad41b309d0d3e1509c4e21">More...</a><br /></td></tr>
|
|
<tr class="separator:aa78395036bad41b309d0d3e1509c4e21"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae1cb03ea30a20d69a03948c423948304"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#ae1cb03ea30a20d69a03948c423948304">CreateFromSubString</a> (<a class="el" href="../../d6/d60/class_o_n___parse_settings.html">ON_ParseSettings</a> parse_settings, const wchar_t *string, int string_count, const wchar_t **string_end)</td></tr>
|
|
<tr class="memdesc:ae1cb03ea30a20d69a03948c423948304"><td class="mdescLeft"> </td><td class="mdescRight">Create an <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> by parsing a string. <a href="#ae1cb03ea30a20d69a03948c423948304">More...</a><br /></td></tr>
|
|
<tr class="separator:ae1cb03ea30a20d69a03948c423948304"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a20f51084f7e8b9e0b13886e9228b4f95"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../dc/d39/class_o_n___length_value.html#ae6ffd4bc4f67c82b2081b49ca138170c">ON_LengthValue::StringFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#a20f51084f7e8b9e0b13886e9228b4f95">LengthStringFormatFromUnsigned</a> (unsigned int string_format_as_unsigned)</td></tr>
|
|
<tr class="separator:a20f51084f7e8b9e0b13886e9228b4f95"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
|
|
Static Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a224be66420350e567f9cb645181558f8"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#a224be66420350e567f9cb645181558f8">Unset</a></td></tr>
|
|
<tr class="separator:a224be66420350e567f9cb645181558f8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acd05b8c17c08a7c0d57c325437f91a7b"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/d39/class_o_n___length_value.html#acd05b8c17c08a7c0d57c325437f91a7b">Zero</a></td></tr>
|
|
<tr class="separator:acd05b8c17c08a7c0d57c325437f91a7b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Member Enumeration Documentation</h2>
|
|
<a id="ae6ffd4bc4f67c82b2081b49ca138170c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae6ffd4bc4f67c82b2081b49ca138170c">◆ </a></span>StringFormat</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="../../dc/d39/class_o_n___length_value.html#ae6ffd4bc4f67c82b2081b49ca138170c">ON_LengthValue::StringFormat</a> : unsigned char</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Formatting to apply when creating a length value from a double. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ae6ffd4bc4f67c82b2081b49ca138170ca99ec4b2cce408e50ed2c69737c07e588"></a>ExactDecimal </td><td class="fielddoc"><p>Use exact decimal string.</p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ae6ffd4bc4f67c82b2081b49ca138170cac67056f962e7c2a68ca9e1539e81f00a"></a>ExactProperFraction </td><td class="fielddoc"><p>If possible, use exact integer-fraction format (1.125 becomes 1-1/8).</p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ae6ffd4bc4f67c82b2081b49ca138170ca2443c1a956f7b565f66751cd6fbc2984"></a>ExactImproperFraction </td><td class="fielddoc"><p>If possible, use exact fraction format (1.125 becomes 9/8).</p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ae6ffd4bc4f67c82b2081b49ca138170caa816afb2cc234c2298c013a663febbd5"></a>CleanDecimal </td><td class="fielddoc"><p>The value may be adjusted slightly to improve clarity (1.124999... becomes 1.125).</p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ae6ffd4bc4f67c82b2081b49ca138170ca00c3183f3025881f146a6e4d4506412f"></a>CleanProperFraction </td><td class="fielddoc"><p>The value may be adjusted slightly to improve clarity (1.124999... becomes 1-1/8).</p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ae6ffd4bc4f67c82b2081b49ca138170caaab6a8cd17a458edc215dd82118d0613"></a>CleanImproperFraction </td><td class="fielddoc"><p>The value may be adjusted slightly to improve clarity (1.124999... becomes 9/8).</p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="af2906852d32c386789ad4dce5ba115d8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af2906852d32c386789ad4dce5ba115d8">◆ </a></span>ON_LengthValue() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ON_LengthValue::ON_LengthValue </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa68e76eaee1ae2ecc1425979a5b86781"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa68e76eaee1ae2ecc1425979a5b86781">◆ </a></span>~ON_LengthValue()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ON_LengthValue::~ON_LengthValue </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1313320a4097bb3c1ccf65bca619d908"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1313320a4097bb3c1ccf65bca619d908">◆ </a></span>ON_LengthValue() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ON_LengthValue::ON_LengthValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> & </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a2687913e1d960a2726fb03228d7825d7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2687913e1d960a2726fb03228d7825d7">◆ </a></span>ChangeLength()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> ON_LengthValue::ChangeLength </td>
|
|
<td>(</td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>length_value</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">length_value</td><td>[in] New length.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> with the new length and other settings copied from this. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad2552eb9e09d2c0eafe2bff86de20425"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad2552eb9e09d2c0eafe2bff86de20425">◆ </a></span>Compare()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static int ON_LengthValue::Compare </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> & </td>
|
|
<td class="paramname"><em>lhs</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> & </td>
|
|
<td class="paramname"><em>rhs</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af7020504c14adb679f6e2d5b6fe00702"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af7020504c14adb679f6e2d5b6fe00702">◆ </a></span>ContentHash()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="../../dd/ddf/class_o_n___s_h_a1___hash.html">ON_SHA1_Hash</a> ON_LengthValue::ContentHash </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6e07123b241f5aef7be566ff068d1e5d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6e07123b241f5aef7be566ff068d1e5d">◆ </a></span>ContextAngleUnitSystem()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ON::AngleUnitSystem ON_LengthValue::ContextAngleUnitSystem </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>Angle unit system used to parse input strings. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2ffc621ebe9328bbfc427b5c616a2b35"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2ffc621ebe9328bbfc427b5c616a2b35">◆ </a></span>ContextLocaleId()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int ON_LengthValue::ContextLocaleId </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>Locale used to parse input strings and create unit names. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa665b517fac1a5ad7a69db44961fe9a5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa665b517fac1a5ad7a69db44961fe9a5">◆ </a></span>Create() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> ON_LengthValue::Create </td>
|
|
<td>(</td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>length_value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const class <a class="el" href="../../d4/d1c/class_o_n___unit_system.html">ON_UnitSystem</a> & </td>
|
|
<td class="paramname"><em>length_unit_system</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>locale_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="../../dc/d39/class_o_n___length_value.html#ae6ffd4bc4f67c82b2081b49ca138170c">ON_LengthValue::StringFormat</a> </td>
|
|
<td class="paramname"><em>string_format</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">length_value</td><td>[in]</td></tr>
|
|
<tr><td class="paramname">length_unit_system</td><td>[in]</td></tr>
|
|
<tr><td class="paramname">bUseFractionsInString</td><td>[in] If bUseFractions is true and length_value can be represented as a common fraction, then the string form will contain a fraction rather than a decimal.</td></tr>
|
|
<tr><td class="paramname">locale_id</td><td>[in] locale id for the string length unit system 0 will select <a class="el" href="../../d8/dd4/class_o_n___locale.html#aa08f2914ddad52ab4f608072c6f8320e">ON_Locale::CurrentCulture</a>.</td></tr>
|
|
<tr><td class="paramname">string_format</td><td>[in] Determines the format of the string representation</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Length in the specified length unit system </dd></dl>
|
|
<p>If you don't like the automatically created string value, then format the string yourself and use <a class="el" href="../../dc/d39/class_o_n___length_value.html#aa78395036bad41b309d0d3e1509c4e21" title="Create an ON_LengthValue by parsing a string. ">ON_LengthValue::CreateFromString()</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1a035cc582be62e7bbd3b63460824417"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1a035cc582be62e7bbd3b63460824417">◆ </a></span>Create() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> ON_LengthValue::Create </td>
|
|
<td>(</td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>length_value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const ON::LengthUnitSystem </td>
|
|
<td class="paramname"><em>length_unit_system</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>locale_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="../../dc/d39/class_o_n___length_value.html#ae6ffd4bc4f67c82b2081b49ca138170c">ON_LengthValue::StringFormat</a> </td>
|
|
<td class="paramname"><em>string_format</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">length_value</td><td>[in]</td></tr>
|
|
<tr><td class="paramname">length_unit_system</td><td>[in]</td></tr>
|
|
<tr><td class="paramname">bUseFractionsInString</td><td>[in] If bUseFractions is true and length_value can be represented as a common fraction, then the string form will contain a fraction rather than a decimal.</td></tr>
|
|
<tr><td class="paramname">locale_id</td><td>[in] locale id for the string length unit system bool</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Length in the specified length unit system </dd></dl>
|
|
<p>If you don't like the automatically created string value, then format the string yourself and use <a class="el" href="../../dc/d39/class_o_n___length_value.html#aa78395036bad41b309d0d3e1509c4e21" title="Create an ON_LengthValue by parsing a string. ">ON_LengthValue::CreateFromString()</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a809b8a9df3bd9c26e8a262c97ef49a39"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a809b8a9df3bd9c26e8a262c97ef49a39">◆ </a></span>Create() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> ON_LengthValue::Create </td>
|
|
<td>(</td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>length_value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const class <a class="el" href="../../db/da1/class_o_n___length_unit_name.html">ON_LengthUnitName</a> & </td>
|
|
<td class="paramname"><em>length_unit_system</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="../../dc/d39/class_o_n___length_value.html#ae6ffd4bc4f67c82b2081b49ca138170c">ON_LengthValue::StringFormat</a> </td>
|
|
<td class="paramname"><em>string_format</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa78395036bad41b309d0d3e1509c4e21"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa78395036bad41b309d0d3e1509c4e21">◆ </a></span>CreateFromString()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> ON_LengthValue::CreateFromString </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="../../d6/d60/class_o_n___parse_settings.html">ON_ParseSettings</a> </td>
|
|
<td class="paramname"><em>parse_settings</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const wchar_t * </td>
|
|
<td class="paramname"><em>string</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create an <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> by parsing a string. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">parse_settings</td><td>[in] Pass <a class="el" href="../../d6/d60/class_o_n___parse_settings.html">ON_ParseSettings(context_length_unit_system,context_angle_unit_system,context_locale_id)</a></td></tr>
|
|
<tr><td class="paramname">string</td><td>[in] null terminated string to parse.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>If the string is valid, the exact length value is returned. If the string is not valid or parsing ends before the string's null terminator, the <a class="el" href="../../dc/d39/class_o_n___length_value.html#a224be66420350e567f9cb645181558f8">ON_LengthValue::Unset</a> is returned. </dd></dl>
|
|
<p>If the entire string is not parsed, that is an error condition. Use <a class="el" href="../../dc/d39/class_o_n___length_value.html#ae1cb03ea30a20d69a03948c423948304" title="Create an ON_LengthValue by parsing a string. ">CreateFromSubString()</a> to permit parsing a portion of the string. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae1cb03ea30a20d69a03948c423948304"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae1cb03ea30a20d69a03948c423948304">◆ </a></span>CreateFromSubString()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> ON_LengthValue::CreateFromSubString </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="../../d6/d60/class_o_n___parse_settings.html">ON_ParseSettings</a> </td>
|
|
<td class="paramname"><em>parse_settings</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const wchar_t * </td>
|
|
<td class="paramname"><em>string</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>string_count</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const wchar_t ** </td>
|
|
<td class="paramname"><em>string_end</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create an <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> by parsing a string. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">parse_settings</td><td>[in] Pass <a class="el" href="../../d6/d60/class_o_n___parse_settings.html">ON_ParseSettings(context_length_unit_system,context_angle_unit_system,context_locale_id)</a></td></tr>
|
|
<tr><td class="paramname">string</td><td>[in] null terminated string to parse.</td></tr>
|
|
<tr><td class="paramname">string_count</td><td>[in] string[] and string_count specify the string to parse. If string_count >= 0, it specifies the maximum number of elements in string[] that may be parsed. If string_count = -1, then the string must contain a character that terminates length parsing.</td></tr>
|
|
<tr><td class="paramname">string_end</td><td>[out] If string_end is not nullptr, then *string_end points to the first element in the string that was not parsed.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>If the string is valid, the exact length value is returned. If the string is not valid or parsing ends before the string's null terminator, the <a class="el" href="../../dc/d39/class_o_n___length_value.html#a224be66420350e567f9cb645181558f8">ON_LengthValue::Unset</a> is returned. </dd></dl>
|
|
<p>If the entire string is not parsed, that is an error condition. Use <a class="el" href="../../dc/d39/class_o_n___length_value.html#ae1cb03ea30a20d69a03948c423948304" title="Create an ON_LengthValue by parsing a string. ">CreateFromSubString()</a> to permit parsing a portion of the string. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad30245437d6f723a3f508d58eb6636e6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad30245437d6f723a3f508d58eb6636e6">◆ </a></span>IsSet()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_LengthValue::IsSet </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae8d6da268c36768ce98e9b48a4303eac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae8d6da268c36768ce98e9b48a4303eac">◆ </a></span>IsUnset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_LengthValue::IsUnset </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af4d8ac79774a1fb9ad087aa126f2671d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af4d8ac79774a1fb9ad087aa126f2671d">◆ </a></span>Length() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double ON_LengthValue::Length </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const class <a class="el" href="../../d4/d1c/class_o_n___unit_system.html">ON_UnitSystem</a> & </td>
|
|
<td class="paramname"><em>context_unit_system</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context_unit_system</td><td>[in] length unit system for the returned value. Pass <a class="el" href="../../d4/d1c/class_o_n___unit_system.html#af361b3ba4bac783bf72350aa6ed7e98f" title="unit system = ON::LengthUnitSystem::None. Scale to or from any valid unit = 1 ">ON_UnitSystem::None</a> to ignore the length unit system and get the value save in this class.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Length in the specified length unit system </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad7559f42f0865cfcc575d5a80644c59f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad7559f42f0865cfcc575d5a80644c59f">◆ </a></span>Length() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double ON_LengthValue::Length </td>
|
|
<td>(</td>
|
|
<td class="paramtype">ON::LengthUnitSystem </td>
|
|
<td class="paramname"><em>context_unit_system</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context_unit_system</td><td>[in] length unit system for the returned value. Pass ON::LengthUnitSystem::None to ignore the length unit system and get the value save in this class.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Length in the specified length unit system </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afbd45406d8a87ebbb1f7363ddde26a33"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afbd45406d8a87ebbb1f7363ddde26a33">◆ </a></span>LengthAsString()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a>& ON_LengthValue::LengthAsString </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>The length as a string. </dd></dl>
|
|
<p>If <a class="el" href="../../dc/d39/class_o_n___length_value.html#aa78395036bad41b309d0d3e1509c4e21" title="Create an ON_LengthValue by parsing a string. ">ON_LengthValue::CreateFromString()</a> or <a class="el" href="../../dc/d39/class_o_n___length_value.html#ae1cb03ea30a20d69a03948c423948304" title="Create an ON_LengthValue by parsing a string. ">ON_LengthValue::CreateFromSubString()</a> were used to create this <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a>, a copy of that string is returned. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab162100e6fbb5c671fc36fc02a9b6c5b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab162100e6fbb5c671fc36fc02a9b6c5b">◆ </a></span>LengthAsStringPointer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const wchar_t* ON_LengthValue::LengthAsStringPointer </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a562ffc8dcb6f954b4fa8865cbc11234e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a562ffc8dcb6f954b4fa8865cbc11234e">◆ </a></span>LengthStringFormat()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="../../dc/d39/class_o_n___length_value.html#ae6ffd4bc4f67c82b2081b49ca138170c">ON_LengthValue::StringFormat</a> ON_LengthValue::LengthStringFormat </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>Format processing applied to input values. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a20f51084f7e8b9e0b13886e9228b4f95"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a20f51084f7e8b9e0b13886e9228b4f95">◆ </a></span>LengthStringFormatFromUnsigned()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="../../dc/d39/class_o_n___length_value.html#ae6ffd4bc4f67c82b2081b49ca138170c">ON_LengthValue::StringFormat</a> ON_LengthValue::LengthStringFormatFromUnsigned </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>string_format_as_unsigned</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4b19057e6f67bc5397362e3b11585293"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4b19057e6f67bc5397362e3b11585293">◆ </a></span>LengthStringParseSettings()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="../../d6/d60/class_o_n___parse_settings.html">ON_ParseSettings</a> ON_LengthValue::LengthStringParseSettings </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a62a557b79d8de54f408ecf1fc12a5e3c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a62a557b79d8de54f408ecf1fc12a5e3c">◆ </a></span>LengthUnitSystem()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const class <a class="el" href="../../d4/d1c/class_o_n___unit_system.html">ON_UnitSystem</a>& ON_LengthValue::LengthUnitSystem </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>Length unit system for this class. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a476737e2544f4a93cf6b42fcd833327c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a476737e2544f4a93cf6b42fcd833327c">◆ </a></span>operator=()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a>& ON_LengthValue::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> & </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a70210dac7b8edeebd861de62c6363449"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a70210dac7b8edeebd861de62c6363449">◆ </a></span>Read()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_LengthValue::Read </td>
|
|
<td>(</td>
|
|
<td class="paramtype">class <a class="el" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a> & </td>
|
|
<td class="paramname"><em>archive</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad9d9a60be2ce373016e0b655e3cc1250"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad9d9a60be2ce373016e0b655e3cc1250">◆ </a></span>RemoveUnitSystem()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> ON_LengthValue::RemoveUnitSystem </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> with the same length value and unit system = None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8d08d1e2123fda2e8d0e62b1777d744f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8d08d1e2123fda2e8d0e62b1777d744f">◆ </a></span>Write()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_LengthValue::Write </td>
|
|
<td>(</td>
|
|
<td class="paramtype">class <a class="el" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a> & </td>
|
|
<td class="paramname"><em>archive</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a224be66420350e567f9cb645181558f8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a224be66420350e567f9cb645181558f8">◆ </a></span>Unset</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> ON_LengthValue::Unset</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acd05b8c17c08a7c0d57c325437f91a7b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acd05b8c17c08a7c0d57c325437f91a7b">◆ </a></span>Zero</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> ON_LengthValue::Zero</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- HTML footer for doxygen 1.8.13-->
|
|
<!-- start footer part -->
|
|
</div> <!-- page-content -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sat Feb 3 2018 11:08:31 for openNURBS SDK Help by <a href="http://www.doxygen.org/index.html">
|
|
<!-- <img class="footer" src="../../doxygen.png" alt="doxygen"/> -->
|
|
Doxygen
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</div> <!-- container -->
|
|
<!-- doxy-boot -->
|
|
<script type="text/javascript" src="../../doxy-boot.js"></script>
|
|
</body>
|
|
</html>
|