Files
qwt/doc/html/class_qwt_vector_field_sample.html
2023-10-31 09:22:42 +01:00

321 lines
16 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Qwt User&#39;s Guide: QwtVectorFieldSample 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>
<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">Qwt User&#39;s Guide
&#160;<span id="projectnumber">6.2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_qwt_vector_field_sample.html',''); initResizable(); });
/* @license-end */
</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="#pub-attribs">Public Attributes</a> &#124;
<a href="class_qwt_vector_field_sample-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">QwtVectorFieldSample Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Sample used in vector fields.
<a href="class_qwt_vector_field_sample.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="qwt__samples_8h_source.html">qwt_samples.h</a>&gt;</code></p>
<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:a42baed10f078f291bb888c30fdb5340f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_vector_field_sample.html#a42baed10f078f291bb888c30fdb5340f">QwtVectorFieldSample</a> (double <a class="el" href="class_qwt_vector_field_sample.html#ac5fb73df88676e3469f0113db40b8935">x</a>=0.0, double <a class="el" href="class_qwt_vector_field_sample.html#a0e60522aea7d65d8340d691f797ddeb9">y</a>=0.0, double <a class="el" href="class_qwt_vector_field_sample.html#aabefe04201a2d6b1d55228dee122771a">vx</a>=0.0, double <a class="el" href="class_qwt_vector_field_sample.html#af219932e3a663f55b9a3a785f58cf86c">vy</a>=0.0)</td></tr>
<tr class="memdesc:a42baed10f078f291bb888c30fdb5340f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="class_qwt_vector_field_sample.html#a42baed10f078f291bb888c30fdb5340f">More...</a><br /></td></tr>
<tr class="separator:a42baed10f078f291bb888c30fdb5340f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afed31ff0b99fd6baa4cba286ec8a259f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_vector_field_sample.html#afed31ff0b99fd6baa4cba286ec8a259f">QwtVectorFieldSample</a> (const QPointF &amp;<a class="el" href="class_qwt_vector_field_sample.html#a5bb3f6e351f1019b9ea330a0a90c0395">pos</a>, double <a class="el" href="class_qwt_vector_field_sample.html#aabefe04201a2d6b1d55228dee122771a">vx</a>=0.0, double <a class="el" href="class_qwt_vector_field_sample.html#af219932e3a663f55b9a3a785f58cf86c">vy</a>=0.0)</td></tr>
<tr class="memdesc:afed31ff0b99fd6baa4cba286ec8a259f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="class_qwt_vector_field_sample.html#afed31ff0b99fd6baa4cba286ec8a259f">More...</a><br /></td></tr>
<tr class="separator:afed31ff0b99fd6baa4cba286ec8a259f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5bb3f6e351f1019b9ea330a0a90c0395"><td class="memItemLeft" align="right" valign="top">QPointF&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_vector_field_sample.html#a5bb3f6e351f1019b9ea330a0a90c0395">pos</a> () const</td></tr>
<tr class="separator:a5bb3f6e351f1019b9ea330a0a90c0395"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8414f5ce56525413f83bb689a1bb1c79"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_vector_field_sample.html#a8414f5ce56525413f83bb689a1bb1c79">isNull</a> () const</td></tr>
<tr class="separator:a8414f5ce56525413f83bb689a1bb1c79"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ac5fb73df88676e3469f0113db40b8935"><td class="memItemLeft" align="right" valign="top"><a id="ac5fb73df88676e3469f0113db40b8935"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_vector_field_sample.html#ac5fb73df88676e3469f0113db40b8935">x</a></td></tr>
<tr class="memdesc:ac5fb73df88676e3469f0113db40b8935"><td class="mdescLeft">&#160;</td><td class="mdescRight">x coordinate of the position <br /></td></tr>
<tr class="separator:ac5fb73df88676e3469f0113db40b8935"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e60522aea7d65d8340d691f797ddeb9"><td class="memItemLeft" align="right" valign="top"><a id="a0e60522aea7d65d8340d691f797ddeb9"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_vector_field_sample.html#a0e60522aea7d65d8340d691f797ddeb9">y</a></td></tr>
<tr class="memdesc:a0e60522aea7d65d8340d691f797ddeb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">y coordinate of the position <br /></td></tr>
<tr class="separator:a0e60522aea7d65d8340d691f797ddeb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aabefe04201a2d6b1d55228dee122771a"><td class="memItemLeft" align="right" valign="top"><a id="aabefe04201a2d6b1d55228dee122771a"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_vector_field_sample.html#aabefe04201a2d6b1d55228dee122771a">vx</a></td></tr>
<tr class="memdesc:aabefe04201a2d6b1d55228dee122771a"><td class="mdescLeft">&#160;</td><td class="mdescRight">x coordinate of the vector <br /></td></tr>
<tr class="separator:aabefe04201a2d6b1d55228dee122771a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af219932e3a663f55b9a3a785f58cf86c"><td class="memItemLeft" align="right" valign="top"><a id="af219932e3a663f55b9a3a785f58cf86c"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_vector_field_sample.html#af219932e3a663f55b9a3a785f58cf86c">vy</a></td></tr>
<tr class="memdesc:af219932e3a663f55b9a3a785f58cf86c"><td class="mdescLeft">&#160;</td><td class="mdescRight">y coordinate of the vector <br /></td></tr>
<tr class="separator:af219932e3a663f55b9a3a785f58cf86c"><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>Sample used in vector fields. </p>
<p>A vector field sample is a position and a vector - usually representing some direction and magnitude - attached to this position.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_qwt_vector_field_data.html" title="Interface for iterating over an array of vector field samples.">QwtVectorFieldData</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="qwt__samples_8h_source.html#l00243">243</a> of file <a class="el" href="qwt__samples_8h_source.html">qwt_samples.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a42baed10f078f291bb888c30fdb5340f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42baed10f078f291bb888c30fdb5340f">&#9670;&nbsp;</a></span>QwtVectorFieldSample() <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">QwtVectorFieldSample::QwtVectorFieldSample </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>posX</em> = <code>0.0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>posY</em> = <code>0.0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>vectorX</em> = <code>0.0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>vectorY</em> = <code>0.0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">posX</td><td>x coordinate of the position </td></tr>
<tr><td class="paramname">posY</td><td>y coordinate of the position </td></tr>
<tr><td class="paramname">vectorX</td><td>x coordinate of the vector </td></tr>
<tr><td class="paramname">vectorY</td><td>y coordinate of the vector </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="qwt__samples_8h_source.html#l00277">277</a> of file <a class="el" href="qwt__samples_8h_source.html">qwt_samples.h</a>.</p>
</div>
</div>
<a id="afed31ff0b99fd6baa4cba286ec8a259f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afed31ff0b99fd6baa4cba286ec8a259f">&#9670;&nbsp;</a></span>QwtVectorFieldSample() <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">QwtVectorFieldSample::QwtVectorFieldSample </td>
<td>(</td>
<td class="paramtype">const QPointF &amp;&#160;</td>
<td class="paramname"><em>pos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>vectorX</em> = <code>0.0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>vectorY</em> = <code>0.0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pos</td><td>Position </td></tr>
<tr><td class="paramname">vectorX</td><td>x coordinate of the vector </td></tr>
<tr><td class="paramname">vectorY</td><td>y coordinate of the vector </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="qwt__samples_8h_source.html#l00293">293</a> of file <a class="el" href="qwt__samples_8h_source.html">qwt_samples.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8414f5ce56525413f83bb689a1bb1c79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8414f5ce56525413f83bb689a1bb1c79">&#9670;&nbsp;</a></span>isNull()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool QwtVectorFieldSample::isNull </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>true, if vx and vy are 0 </dd></dl>
<p class="definition">Definition at line <a class="el" href="qwt__samples_8h_source.html#l00309">309</a> of file <a class="el" href="qwt__samples_8h_source.html">qwt_samples.h</a>.</p>
</div>
</div>
<a id="a5bb3f6e351f1019b9ea330a0a90c0395"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5bb3f6e351f1019b9ea330a0a90c0395">&#9670;&nbsp;</a></span>pos()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QPointF QwtVectorFieldSample::pos </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>x/y coordinates as QPointF </dd></dl>
<p class="definition">Definition at line <a class="el" href="qwt__samples_8h_source.html#l00303">303</a> of file <a class="el" href="qwt__samples_8h_source.html">qwt_samples.h</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_vector_field_sample.html">QwtVectorFieldSample</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>