mirror of
https://github.com/mcneel/opennurbs.git
synced 2026-03-30 15:36:52 +08:00
784 lines
50 KiB
HTML
784 lines
50 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.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>openNURBS SDK Help: ON_ScaleValue 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="../../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
|
|
 <span id="projectnumber">6.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="../../menudata.js"></script>
|
|
<script type="text/javascript" src="../../menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('../../',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</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><!-- 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="../../d1/db0/class_o_n___scale_value-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">ON_ScaleValue 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:af737cbb998530cb6d59503d10b64d89a"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/df7/class_o_n___scale_value.html#af737cbb998530cb6d59503d10b64d89a">ScaleStringFormat</a> : unsigned char { <br />
|
|
  <a class="el" href="../../d8/df7/class_o_n___scale_value.html#af737cbb998530cb6d59503d10b64d89aa6adf97f83acf6453d4a6a4b1070f3754">ScaleStringFormat::None</a> = 0,
|
|
<a class="el" href="../../d8/df7/class_o_n___scale_value.html#af737cbb998530cb6d59503d10b64d89aa972cbb5c0a271f4e68486969316b83f9">ScaleStringFormat::RatioFormat</a> = 1,
|
|
<a class="el" href="../../d8/df7/class_o_n___scale_value.html#af737cbb998530cb6d59503d10b64d89aaf7db6bdc5b388a7d6e2271a65dd71740">ScaleStringFormat::EquationFormat</a> = 2,
|
|
<a class="el" href="../../d8/df7/class_o_n___scale_value.html#af737cbb998530cb6d59503d10b64d89aada473a330a771f9980854e7c191eb4b8">ScaleStringFormat::FractionFormat</a> = 3,
|
|
<br />
|
|
  <a class="el" href="../../d8/df7/class_o_n___scale_value.html#af737cbb998530cb6d59503d10b64d89aac9f88e098f6fe4e4e112eeb05ccb9671">ScaleStringFormat::Unset</a> = 0xFF
|
|
<br />
|
|
}<tr class="memdesc:af737cbb998530cb6d59503d10b64d89a"><td class="mdescLeft"> </td><td class="mdescRight">Specifies prefered formats for automatically created string descriptions of a scale value. <a href="../../d8/df7/class_o_n___scale_value.html#af737cbb998530cb6d59503d10b64d89a">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:af737cbb998530cb6d59503d10b64d89a"><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:a32014ead979d51127bf7ef59d2f2f572"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/df7/class_o_n___scale_value.html#a32014ead979d51127bf7ef59d2f2f572">ON_ScaleValue</a> ()=default</td></tr>
|
|
<tr class="separator:a32014ead979d51127bf7ef59d2f2f572"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:accb629ecce5420abe0031dc51508a4a8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/df7/class_o_n___scale_value.html#accb629ecce5420abe0031dc51508a4a8">ON_ScaleValue</a> (const <a class="el" href="../../d8/df7/class_o_n___scale_value.html">ON_ScaleValue</a> &)=default</td></tr>
|
|
<tr class="separator:accb629ecce5420abe0031dc51508a4a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a84d515fe2af5b433fa79873cb13e1691"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/df7/class_o_n___scale_value.html#a84d515fe2af5b433fa79873cb13e1691">~ON_ScaleValue</a> ()=default</td></tr>
|
|
<tr class="separator:a84d515fe2af5b433fa79873cb13e1691"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad80da5184796c38cf3992b499acba105"><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="../../d8/df7/class_o_n___scale_value.html#ad80da5184796c38cf3992b499acba105">ContentHash</a> () const</td></tr>
|
|
<tr class="separator:ad80da5184796c38cf3992b499acba105"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6fea6aebb2b40821682dbb9d930e55ed"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6fea6aebb2b40821682dbb9d930e55ed">IsSet</a> () const</td></tr>
|
|
<tr class="separator:a6fea6aebb2b40821682dbb9d930e55ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab2a22521340c91be2ffa7058730d1259"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/df7/class_o_n___scale_value.html#ab2a22521340c91be2ffa7058730d1259">IsUnset</a> () const</td></tr>
|
|
<tr class="separator:ab2a22521340c91be2ffa7058730d1259"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a519759993c04bbf0968378551c76fd03"><td class="memItemLeft" align="right" valign="top">const class <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="../../d8/df7/class_o_n___scale_value.html#a519759993c04bbf0968378551c76fd03">LeftLengthValue</a> () const</td></tr>
|
|
<tr class="separator:a519759993c04bbf0968378551c76fd03"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6674570f9ae1b8cf9c47c8355fb7c466"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale</a> () const</td></tr>
|
|
<tr class="separator:a6674570f9ae1b8cf9c47c8355fb7c466"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad67c2fd61329b2176cb85e0bf9a0323d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d8/df7/class_o_n___scale_value.html">ON_ScaleValue</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/df7/class_o_n___scale_value.html#ad67c2fd61329b2176cb85e0bf9a0323d">operator=</a> (const <a class="el" href="../../d8/df7/class_o_n___scale_value.html">ON_ScaleValue</a> &)=default</td></tr>
|
|
<tr class="separator:ad67c2fd61329b2176cb85e0bf9a0323d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8d501ecdf31f34beac95264c477cca69"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/df7/class_o_n___scale_value.html#a8d501ecdf31f34beac95264c477cca69">Read</a> (class <a class="el" href="../../db/d16/class_o_n___binary_archive.html">ON_BinaryArchive</a> &archive)</td></tr>
|
|
<tr class="separator:a8d501ecdf31f34beac95264c477cca69"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3d1b0573a17a40003da385d183804fc3"><td class="memItemLeft" align="right" valign="top">const class <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="../../d8/df7/class_o_n___scale_value.html#a3d1b0573a17a40003da385d183804fc3">RightLengthValue</a> () const</td></tr>
|
|
<tr class="separator:a3d1b0573a17a40003da385d183804fc3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5830dd975eb0aca04f18b4bec33d93dd"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale</a> () const</td></tr>
|
|
<tr class="separator:a5830dd975eb0aca04f18b4bec33d93dd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4468ee4ee113e5d06fa94ac81b769b1c"><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="../../d8/df7/class_o_n___scale_value.html#a4468ee4ee113e5d06fa94ac81b769b1c">ScaleAsString</a> () const</td></tr>
|
|
<tr class="separator:a4468ee4ee113e5d06fa94ac81b769b1c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6ec2ca0e008c9d0a5232d44064565253"><td class="memItemLeft" align="right" valign="top">const wchar_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6ec2ca0e008c9d0a5232d44064565253">ScaleAsStringPointer</a> () const</td></tr>
|
|
<tr class="separator:a6ec2ca0e008c9d0a5232d44064565253"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab43e3e464f587670644a935753d5b800"><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="../../d8/df7/class_o_n___scale_value.html#ab43e3e464f587670644a935753d5b800">ScaleStringParseSettings</a> () const</td></tr>
|
|
<tr class="separator:ab43e3e464f587670644a935753d5b800"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a43db36692d171c0ece320bab3fa231fb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/df7/class_o_n___scale_value.html#a43db36692d171c0ece320bab3fa231fb">SwapLeftAndRight</a> ()</td></tr>
|
|
<tr class="separator:a43db36692d171c0ece320bab3fa231fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4fcb1abdf4a6db826d6bdb92ecf8a7c5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/df7/class_o_n___scale_value.html#a4fcb1abdf4a6db826d6bdb92ecf8a7c5">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:a4fcb1abdf4a6db826d6bdb92ecf8a7c5"><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:a4d5d9fd951bf97354018fd6ca7ae66d4"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/df7/class_o_n___scale_value.html#a4d5d9fd951bf97354018fd6ca7ae66d4">Compare</a> (const <a class="el" href="../../d8/df7/class_o_n___scale_value.html">ON_ScaleValue</a> &lhs, const <a class="el" href="../../d8/df7/class_o_n___scale_value.html">ON_ScaleValue</a> &rhs)</td></tr>
|
|
<tr class="separator:a4d5d9fd951bf97354018fd6ca7ae66d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1a040d64e9f4cc238c83758cee5481ef"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d8/df7/class_o_n___scale_value.html">ON_ScaleValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/df7/class_o_n___scale_value.html#a1a040d64e9f4cc238c83758cee5481ef">Create</a> (const class <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> &left_side_length, const class <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> &right_side_length, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#af737cbb998530cb6d59503d10b64d89a">ON_ScaleValue::ScaleStringFormat</a> string_format_preference)</td></tr>
|
|
<tr class="separator:a1a040d64e9f4cc238c83758cee5481ef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b85b0da479d36f3444a2cc5527f3841"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d8/df7/class_o_n___scale_value.html">ON_ScaleValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/df7/class_o_n___scale_value.html#a9b85b0da479d36f3444a2cc5527f3841">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="separator:a9b85b0da479d36f3444a2cc5527f3841"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaf9f51eb9f21e118ef61619b2dc7c08b"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d8/df7/class_o_n___scale_value.html">ON_ScaleValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/df7/class_o_n___scale_value.html#aaf9f51eb9f21e118ef61619b2dc7c08b">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="separator:aaf9f51eb9f21e118ef61619b2dc7c08b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a97fb2d6207199507c61e047e99a36475"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d8/df7/class_o_n___scale_value.html#af737cbb998530cb6d59503d10b64d89a">ON_ScaleValue::ScaleStringFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/df7/class_o_n___scale_value.html#a97fb2d6207199507c61e047e99a36475">ScaleStringFormatFromUnsigned</a> (unsigned int scale_string_format_as_unsigned)</td></tr>
|
|
<tr class="separator:a97fb2d6207199507c61e047e99a36475"><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:a755c8ef829c96061566e1321c86c9984"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="../../d8/df7/class_o_n___scale_value.html">ON_ScaleValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/df7/class_o_n___scale_value.html#a755c8ef829c96061566e1321c86c9984">OneToOne</a></td></tr>
|
|
<tr class="separator:a755c8ef829c96061566e1321c86c9984"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a727aa550f37d53a143ae71fb75847012"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="../../d8/df7/class_o_n___scale_value.html">ON_ScaleValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/df7/class_o_n___scale_value.html#a727aa550f37d53a143ae71fb75847012">Unset</a></td></tr>
|
|
<tr class="separator:a727aa550f37d53a143ae71fb75847012"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Member Enumeration Documentation</h2>
|
|
<a id="af737cbb998530cb6d59503d10b64d89a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af737cbb998530cb6d59503d10b64d89a">◆ </a></span>ScaleStringFormat</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="../../d8/df7/class_o_n___scale_value.html#af737cbb998530cb6d59503d10b64d89a">ON_ScaleValue::ScaleStringFormat</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>Specifies prefered formats for automatically created string descriptions of a scale value. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="af737cbb998530cb6d59503d10b64d89aa6adf97f83acf6453d4a6a4b1070f3754"></a>None </td><td class="fielddoc"><p>No preference for automatically created string descriptions of a scale value. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="af737cbb998530cb6d59503d10b64d89aa972cbb5c0a271f4e68486969316b83f9"></a>RatioFormat </td><td class="fielddoc"><p>Prefer the ratio format using a colon, like "1:4" or "4:1". </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="af737cbb998530cb6d59503d10b64d89aaf7db6bdc5b388a7d6e2271a65dd71740"></a>EquationFormat </td><td class="fielddoc"><p>Prefer the equation format using an equal sign, like "1 = 4" or "4 = 1". </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="af737cbb998530cb6d59503d10b64d89aada473a330a771f9980854e7c191eb4b8"></a>FractionFormat </td><td class="fielddoc"><p>Prefer the fraction format using a slash, like "1/4" or "4/1". </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="af737cbb998530cb6d59503d10b64d89aac9f88e098f6fe4e4e112eeb05ccb9671"></a>Unset </td><td class="fielddoc"><p><a class="el" href="../../d8/df7/class_o_n___scale_value.html#af737cbb998530cb6d59503d10b64d89aac9f88e098f6fe4e4e112eeb05ccb9671" title="ON_ScaleValue::ScaleStringFormat::Unset is used to indicate no preference is set. This condition is d...">ON_ScaleValue::ScaleStringFormat::Unset</a> is used to indicate no preference is set. This condition is different from <a class="el" href="../../d8/df7/class_o_n___scale_value.html#af737cbb998530cb6d59503d10b64d89aa6adf97f83acf6453d4a6a4b1070f3754" title="No preference for automatically created string descriptions of a scale value. ">ON_ScaleValue::ScaleStringFormat::None</a>. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a32014ead979d51127bf7ef59d2f2f572"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a32014ead979d51127bf7ef59d2f2f572">◆ </a></span>ON_ScaleValue() <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_ScaleValue::ON_ScaleValue </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="a84d515fe2af5b433fa79873cb13e1691"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a84d515fe2af5b433fa79873cb13e1691">◆ </a></span>~ON_ScaleValue()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ON_ScaleValue::~ON_ScaleValue </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="accb629ecce5420abe0031dc51508a4a8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#accb629ecce5420abe0031dc51508a4a8">◆ </a></span>ON_ScaleValue() <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_ScaleValue::ON_ScaleValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="../../d8/df7/class_o_n___scale_value.html">ON_ScaleValue</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="a4d5d9fd951bf97354018fd6ca7ae66d4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4d5d9fd951bf97354018fd6ca7ae66d4">◆ </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_ScaleValue::Compare </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="../../d8/df7/class_o_n___scale_value.html">ON_ScaleValue</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="../../d8/df7/class_o_n___scale_value.html">ON_ScaleValue</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="ad80da5184796c38cf3992b499acba105"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad80da5184796c38cf3992b499acba105">◆ </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_ScaleValue::ContentHash </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1a040d64e9f4cc238c83758cee5481ef"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1a040d64e9f4cc238c83758cee5481ef">◆ </a></span>Create()</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="../../d8/df7/class_o_n___scale_value.html">ON_ScaleValue</a> ON_ScaleValue::Create </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const class <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> & </td>
|
|
<td class="paramname"><em>left_side_length</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const class <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a> & </td>
|
|
<td class="paramname"><em>right_side_length</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="../../d8/df7/class_o_n___scale_value.html#af737cbb998530cb6d59503d10b64d89a">ON_ScaleValue::ScaleStringFormat</a> </td>
|
|
<td class="paramname"><em>string_format_preference</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>Parameters: left_length - [in] right_length - [in] Returns: A scale value for converting a distance from source_length to destination_length. Remarks: If you don't like the automatically created string value, then format the string yourself and use <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a9b85b0da479d36f3444a2cc5527f3841">ON_ScaleValue::CreateFromString()</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9b85b0da479d36f3444a2cc5527f3841"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9b85b0da479d36f3444a2cc5527f3841">◆ </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="../../d8/df7/class_o_n___scale_value.html">ON_ScaleValue</a> ON_ScaleValue::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>Description: Create an <a class="el" href="../../d8/df7/class_o_n___scale_value.html">ON_ScaleValue</a> by parsing a string. Parameters: parse_settings - [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> string - [in] null terminated string to parse. Returns: If the string is valid, the exact scale value is returned. If the string is not valid or parsing ends before the string's null terminator, the <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a727aa550f37d53a143ae71fb75847012">ON_ScaleValue::Unset</a> is returned. Remarks: If the entire string is not parsed, that is an error condition. Use <a class="el" href="../../d8/df7/class_o_n___scale_value.html#aaf9f51eb9f21e118ef61619b2dc7c08b">CreateFromSubString()</a> to permit parsing a portion of the string. Examples: "1:4", "1=4", "1/4", "0.25" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 4, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 0.25</p>
|
|
<p>"4:1", "4=1", "4/1", "4" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 0.25, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 4</p>
|
|
<p>"100:1", "100=1", "1 meter = 1 centimeter" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 0.01, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 100</p>
|
|
<p>"1:100", "1=100", "1 centimeter = 1 meter" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 100, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 0.01</p>
|
|
<p>"12:1", "12=1", "12/1", "12", "1 foot = 1 inch" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 0.08333..., <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 12</p>
|
|
<p>"1:12", "1=12", "1/12", "1 inch = 1 foot" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 12, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 0.08333...</p>
|
|
<p>"1:48", "1 = 48", "1/4 inch = 1 foot" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 48, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 0.0208333... </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaf9f51eb9f21e118ef61619b2dc7c08b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaf9f51eb9f21e118ef61619b2dc7c08b">◆ </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="../../d8/df7/class_o_n___scale_value.html">ON_ScaleValue</a> ON_ScaleValue::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>Description: Create an <a class="el" href="../../d8/df7/class_o_n___scale_value.html">ON_ScaleValue</a> by parsing a string. Parameters: parse_settings - [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> string - [in] null terminated string to parse. string_count - [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 scale parsing. string_end - [out] If string_end is not nullptr, then *string_end points to the first element in the string that was not parsed. Returns: If the string is valid, the exact scale value is returned. If the string is not valid or parsing ends before the string's null terminator, the <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a727aa550f37d53a143ae71fb75847012">ON_ScaleValue::Unset</a> is returned. Remarks: If the entire string is not parsed, that is an error condition. Use <a class="el" href="../../d8/df7/class_o_n___scale_value.html#aaf9f51eb9f21e118ef61619b2dc7c08b">CreateFromSubString()</a> to permit parsing a portion of the string.</p>
|
|
<p>Examples: "1:4", "1=4", "1/4", "0.25" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 4, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 0.25</p>
|
|
<p>"4:1", "4=1", "4/1", "4" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 0.25, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 4</p>
|
|
<p>"100:1", "100=1", "1 meter = 1 centimeter" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 0.01, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 100</p>
|
|
<p>"1:100", "1=100", "1 centimeter = 1 meter" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 100, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 0.01</p>
|
|
<p>"12:1", "12=1", "12/1", "12", "1 foot = 1 inch" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 0.08333..., <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 12</p>
|
|
<p>"1:12", "1=12", "1/12", "1 inch = 1 foot" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 12, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 0.08333...</p>
|
|
<p>"1:48", "1 = 48", "1/4 inch = 1 foot" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 48, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 0.0208333... </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6fea6aebb2b40821682dbb9d930e55ed"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6fea6aebb2b40821682dbb9d930e55ed">◆ </a></span>IsSet()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_ScaleValue::IsSet </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab2a22521340c91be2ffa7058730d1259"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab2a22521340c91be2ffa7058730d1259">◆ </a></span>IsUnset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_ScaleValue::IsUnset </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a519759993c04bbf0968378551c76fd03"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a519759993c04bbf0968378551c76fd03">◆ </a></span>LeftLengthValue()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const class <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a>& ON_ScaleValue::LeftLengthValue </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6674570f9ae1b8cf9c47c8355fb7c466"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6674570f9ae1b8cf9c47c8355fb7c466">◆ </a></span>LeftToRightScale()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double ON_ScaleValue::LeftToRightScale </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns: A dimensionless scale factor. The word "dimensionless" is critical. Differneces in left and right side unit systems are accounted for in the returned value. Remarks: <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 1.0/RightToLeftScale() Examples: "1:4", "1=4", "1/4", "0.25" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 4, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 0.25</p>
|
|
<p>"4:1", "4=1", "4/1", "4" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 0.25, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 4</p>
|
|
<p>"100:1", "100=1", "1 meter = 1 centimeter" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 0.01, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 100</p>
|
|
<p>"1:100", "1=100", "1 centimeter = 1 meter" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 100, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 0.01</p>
|
|
<p>"12:1", "12=1", "12/1", "12", "1 foot = 1 inch" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 0.08333..., <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 12</p>
|
|
<p>"1:12", "1=12", "1/12", "1 inch = 1 foot" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 12, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 0.08333...</p>
|
|
<p>"1:48", "1 = 48", "1/4 inch = 1 foot" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 48, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 0.0208333... </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad67c2fd61329b2176cb85e0bf9a0323d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad67c2fd61329b2176cb85e0bf9a0323d">◆ </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="../../d8/df7/class_o_n___scale_value.html">ON_ScaleValue</a>& ON_ScaleValue::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="../../d8/df7/class_o_n___scale_value.html">ON_ScaleValue</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="a8d501ecdf31f34beac95264c477cca69"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8d501ecdf31f34beac95264c477cca69">◆ </a></span>Read()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_ScaleValue::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="a3d1b0573a17a40003da385d183804fc3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3d1b0573a17a40003da385d183804fc3">◆ </a></span>RightLengthValue()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const class <a class="el" href="../../dc/d39/class_o_n___length_value.html">ON_LengthValue</a>& ON_ScaleValue::RightLengthValue </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5830dd975eb0aca04f18b4bec33d93dd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5830dd975eb0aca04f18b4bec33d93dd">◆ </a></span>RightToLeftScale()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double ON_ScaleValue::RightToLeftScale </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns: A dimensionless scale factor. The word "dimensionless" is critical. Differneces in left and right side unit systems are accounted for in the returned value. Remarks: <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 1.0/LeftToRightScale() Examples: "1:4", "1=4", "1/4", "0.25" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 4, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 0.25</p>
|
|
<p>"4:1", "4=1", "4/1", "4" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 0.25, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 4</p>
|
|
<p>"100:1", "100=1", "1 meter = 1 centimeter" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 0.01, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 100</p>
|
|
<p>"1:100", "1=100", "1 centimeter = 1 meter" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 100, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 0.01</p>
|
|
<p>"12:1", "12=1", "12/1", "12", "1 foot = 1 inch" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 0.08333..., <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 12</p>
|
|
<p>"1:12", "1=12", "1/12", "1 inch = 1 foot" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 12, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 0.08333...</p>
|
|
<p>"1:48", "1 = 48", "1/4 inch = 1 foot" will set <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a6674570f9ae1b8cf9c47c8355fb7c466">LeftToRightScale()</a> = 48, <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a5830dd975eb0aca04f18b4bec33d93dd">RightToLeftScale()</a> = 0.0208333... </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4468ee4ee113e5d06fa94ac81b769b1c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4468ee4ee113e5d06fa94ac81b769b1c">◆ </a></span>ScaleAsString()</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_ScaleValue::ScaleAsString </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns: The scale as a string. Remarks: If <a class="el" href="../../d8/df7/class_o_n___scale_value.html#a9b85b0da479d36f3444a2cc5527f3841">ON_ScaleValue::CreateFromString()</a> or <a class="el" href="../../d8/df7/class_o_n___scale_value.html#aaf9f51eb9f21e118ef61619b2dc7c08b">ON_ScaleValue::CreateFromSubString()</a> were used to create this <a class="el" href="../../d8/df7/class_o_n___scale_value.html">ON_ScaleValue</a>, a copy of that string is returned. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6ec2ca0e008c9d0a5232d44064565253"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6ec2ca0e008c9d0a5232d44064565253">◆ </a></span>ScaleAsStringPointer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const wchar_t* ON_ScaleValue::ScaleAsStringPointer </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a97fb2d6207199507c61e047e99a36475"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a97fb2d6207199507c61e047e99a36475">◆ </a></span>ScaleStringFormatFromUnsigned()</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="../../d8/df7/class_o_n___scale_value.html#af737cbb998530cb6d59503d10b64d89a">ON_ScaleValue::ScaleStringFormat</a> ON_ScaleValue::ScaleStringFormatFromUnsigned </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>scale_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="ab43e3e464f587670644a935753d5b800"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab43e3e464f587670644a935753d5b800">◆ </a></span>ScaleStringParseSettings()</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_ScaleValue::ScaleStringParseSettings </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a43db36692d171c0ece320bab3fa231fb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a43db36692d171c0ece320bab3fa231fb">◆ </a></span>SwapLeftAndRight()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ON_ScaleValue::SwapLeftAndRight </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Description Exchange the left and right lengths. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4fcb1abdf4a6db826d6bdb92ecf8a7c5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4fcb1abdf4a6db826d6bdb92ecf8a7c5">◆ </a></span>Write()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ON_ScaleValue::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="a755c8ef829c96061566e1321c86c9984"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a755c8ef829c96061566e1321c86c9984">◆ </a></span>OneToOne</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="../../d8/df7/class_o_n___scale_value.html">ON_ScaleValue</a> ON_ScaleValue::OneToOne</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="a727aa550f37d53a143ae71fb75847012"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a727aa550f37d53a143ae71fb75847012">◆ </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="../../d8/df7/class_o_n___scale_value.html">ON_ScaleValue</a> ON_ScaleValue::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>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Wed Jan 31 2018 14:30:16 for openNURBS SDK Help by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|