qwt-cmake/doc/html/class_qwt_transform.html
2018-08-02 11:01:31 -04:00

282 lines
14 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.11"/>
<title>Qwt User&#39;s Guide: QwtTransform 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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">Qwt User&#39;s Guide
&#160;<span id="projectnumber">6.1.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_qwt_transform.html','');});
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_qwt_transform-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">QwtTransform Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>A transformation between coordinate systems.
<a href="class_qwt_transform.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="qwt__transform_8h_source.html">qwt_transform.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for QwtTransform:</div>
<div class="dyncontent">
<div class="center"><img src="class_qwt_transform__inherit__graph.png" border="0" usemap="#_qwt_transform_inherit__map" alt="Inheritance graph"/></div>
<map name="_qwt_transform_inherit__map" id="_qwt_transform_inherit__map">
<area shape="rect" id="node2" href="class_qwt_log_transform.html" title="Logarithmic transformation. " alt="" coords="5,80,136,107"/>
<area shape="rect" id="node3" href="class_qwt_null_transform.html" title="Null transformation. " alt="" coords="159,80,289,107"/>
<area shape="rect" id="node4" href="class_qwt_power_transform.html" title="A transformation using pow() " alt="" coords="313,80,460,107"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<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:aa1fa1ab21d0fc01e06d3a6e462008d0b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa1fa1ab21d0fc01e06d3a6e462008d0b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_transform.html#aa1fa1ab21d0fc01e06d3a6e462008d0b">QwtTransform</a> ()</td></tr>
<tr class="memdesc:aa1fa1ab21d0fc01e06d3a6e462008d0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:aa1fa1ab21d0fc01e06d3a6e462008d0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2653db3104e672464dc569592fc14ab"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa2653db3104e672464dc569592fc14ab"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_transform.html#aa2653db3104e672464dc569592fc14ab">~QwtTransform</a> ()</td></tr>
<tr class="memdesc:aa2653db3104e672464dc569592fc14ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:aa2653db3104e672464dc569592fc14ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2703fc5855720201f46ed9404271a527"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_transform.html#a2703fc5855720201f46ed9404271a527">bounded</a> (double value) const </td></tr>
<tr class="separator:a2703fc5855720201f46ed9404271a527"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ca5657c4722b4d39eb57bf5459c2fd0"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_transform.html#a7ca5657c4722b4d39eb57bf5459c2fd0">transform</a> (double value) const =0</td></tr>
<tr class="separator:a7ca5657c4722b4d39eb57bf5459c2fd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a078578d562a1f76555f7b3446d1724e0"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_transform.html#a078578d562a1f76555f7b3446d1724e0">invTransform</a> (double value) const =0</td></tr>
<tr class="separator:a078578d562a1f76555f7b3446d1724e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2736acb99a26c51eec090456910c145f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2736acb99a26c51eec090456910c145f"></a>
virtual <a class="el" href="class_qwt_transform.html">QwtTransform</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_transform.html#a2736acb99a26c51eec090456910c145f">copy</a> () const =0</td></tr>
<tr class="memdesc:a2736acb99a26c51eec090456910c145f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtualized copy operation. <br /></td></tr>
<tr class="separator:a2736acb99a26c51eec090456910c145f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A transformation between coordinate systems. </p>
<p><a class="el" href="class_qwt_transform.html" title="A transformation between coordinate systems. ">QwtTransform</a> manipulates values, when being mapped between the scale and the paint device coordinate system.</p>
<p>A transformation consists of 2 methods:</p>
<ul>
<li>transform</li>
<li>invTransform</li>
</ul>
<p>where one is is the inverse function of the other.</p>
<p>When p1, p2 are the boundaries of the paint device coordinates and s1, s2 the boundaries of the scale, <a class="el" href="class_qwt_scale_map.html" title="A scale map. ">QwtScaleMap</a> uses the following calculations:</p>
<ul>
<li>p = p1 + ( p2 - p1 ) * ( T( s ) - T( s1 ) / ( T( s2 ) - T( s1 ) );</li>
<li>s = invT ( T( s1 ) + ( T( s2 ) - T( s1 ) ) * ( p - p1 ) / ( p2 - p1 ) ); </li>
</ul>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a2703fc5855720201f46ed9404271a527"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double QwtTransform::bounded </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Modify value to be a valid value for the transformation. The default implementation does nothing.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>Value to be bounded </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>value unmodified </dd></dl>
<p>Reimplemented in <a class="el" href="class_qwt_log_transform.html#ab98c0508df005438dea8baa6c512b799">QwtLogTransform</a>.</p>
</div>
</div>
<a class="anchor" id="a078578d562a1f76555f7b3446d1724e0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double QwtTransform::invTransform </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Inverse transformation function</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>Value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Modified value</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_qwt_transform.html#a7ca5657c4722b4d39eb57bf5459c2fd0">transform()</a> </dd></dl>
<p>Implemented in <a class="el" href="class_qwt_power_transform.html#aae19e2002b08ab09ed177d8ff6753f82">QwtPowerTransform</a>, <a class="el" href="class_qwt_log_transform.html#a7c9e1e11e9708aecef2df4dac0c7d56b">QwtLogTransform</a>, and <a class="el" href="class_qwt_null_transform.html#aa52cc18dcd1d0cd37a950fb71ef68a1c">QwtNullTransform</a>.</p>
</div>
</div>
<a class="anchor" id="a7ca5657c4722b4d39eb57bf5459c2fd0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual double QwtTransform::transform </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Transformation function</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>Value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Modified value</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_qwt_transform.html#a078578d562a1f76555f7b3446d1724e0">invTransform()</a> </dd></dl>
<p>Implemented in <a class="el" href="class_qwt_power_transform.html#aad3892cb63f5981521184960e240a4f3">QwtPowerTransform</a>, <a class="el" href="class_qwt_log_transform.html#ae13d9e1c7a71fd50afe2e804d2a2fb15">QwtLogTransform</a>, and <a class="el" href="class_qwt_null_transform.html#abf4fa9a536049e6da78e71d5f8485b4e">QwtNullTransform</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_qwt_transform.html">QwtTransform</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
</ul>
</div>
</body>
</html>