source: flair-dev/trunk/doc/Flair/classflair_1_1core_1_1_vector2_d.html@ 14

Last change on this file since 14 was 14, checked in by Sanahuja Guillaume, 8 years ago

doc
File size: 23.2 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.7"/>
7<title>Flair: flair::core::Vector2D Class Reference</title>
8<link href="tabs.css" rel="stylesheet" type="text/css"/>
9<script type="text/javascript" src="jquery.js"></script>
10<script type="text/javascript" src="dynsections.js"></script>
11<link href="navtree.css" rel="stylesheet" type="text/css"/>
12<script type="text/javascript" src="resize.js"></script>
13<script type="text/javascript" src="navtree.js"></script>
14<script type="text/javascript">
15 $(document).ready(initResizable);
16 $(window).load(resizeHeight);
17</script>
18<link href="search/search.css" rel="stylesheet" type="text/css"/>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/javascript">
21 $(document).ready(function() { searchBox.OnSelectItem(0); });
22</script>
23<link href="doxygen.css" rel="stylesheet" type="text/css" />
24</head>
25<body>
26<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
27<div id="titlearea">
28<table cellspacing="0" cellpadding="0">
29 <tbody>
30 <tr style="height: 56px;">
31 <td id="projectlogo"><img alt="Logo" src="logo_hds.png"/></td>
32 <td style="padding-left: 0.5em;">
33 <div id="projectname">Flair
34 </div>
35 <div id="projectbrief">Framework Libre Air</div>
36 </td>
37 </tr>
38 </tbody>
39</table>
40</div>
41<!-- end header part -->
42<!-- Generated by Doxygen 1.8.7 -->
43<script type="text/javascript">
44var searchBox = new SearchBox("searchBox", "search",false,'Search');
45</script>
46 <div id="navrow1" class="tabs">
47 <ul class="tablist">
48 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
49 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
50 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
51 <li><a href="files.html"><span>Files</span></a></li>
52 <li>
53 <div id="MSearchBox" class="MSearchBoxInactive">
54 <span class="left">
55 <img id="MSearchSelect" src="search/mag_sel.png"
56 onmouseover="return searchBox.OnSearchSelectShow()"
57 onmouseout="return searchBox.OnSearchSelectHide()"
58 alt=""/>
59 <input type="text" id="MSearchField" value="Search" accesskey="S"
60 onfocus="searchBox.OnSearchFieldFocus(true)"
61 onblur="searchBox.OnSearchFieldFocus(false)"
62 onkeyup="searchBox.OnSearchFieldChange(event)"/>
63 </span><span class="right">
64 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
65 </span>
66 </div>
67 </li>
68 </ul>
69 </div>
70 <div id="navrow2" class="tabs2">
71 <ul class="tablist">
72 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
73 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
74 <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
75 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
76 </ul>
77 </div>
78</div><!-- top -->
79<div id="side-nav" class="ui-resizable side-nav-resizable">
80 <div id="nav-tree">
81 <div id="nav-tree-contents">
82 <div id="nav-sync" class="sync"></div>
83 </div>
84 </div>
85 <div id="splitbar" style="-moz-user-select:none;"
86 class="ui-resizable-handle">
87 </div>
88</div>
89<script type="text/javascript">
90$(document).ready(function(){initNavTree('classflair_1_1core_1_1_vector2_d.html','');});
91</script>
92<div id="doc-content">
93<!-- window showing the filter options -->
94<div id="MSearchSelectWindow"
95 onmouseover="return searchBox.OnSearchSelectShow()"
96 onmouseout="return searchBox.OnSearchSelectHide()"
97 onkeydown="return searchBox.OnSearchSelectKey(event)">
98<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Properties</a></div>
99
100<!-- iframe showing the search results (closed by default) -->
101<div id="MSearchResultsWindow">
102<iframe src="javascript:void(0)" frameborder="0"
103 name="MSearchResults" id="MSearchResults">
104</iframe>
105</div>
106
107<div class="header">
108 <div class="summary">
109<a href="#pub-methods">Public Member Functions</a> &#124;
110<a href="#pub-attribs">Public Attributes</a> &#124;
111<a href="classflair_1_1core_1_1_vector2_d-members.html">List of all members</a> </div>
112 <div class="headertitle">
113<div class="title">flair::core::Vector2D Class Reference</div> </div>
114</div><!--header-->
115<div class="contents">
116
117<p>Class defining a 2D vector.
118 <a href="classflair_1_1core_1_1_vector2_d.html#details">More...</a></p>
119
120<p><code>#include &lt;<a class="el" href="_vector2_d_8h_source.html">Vector2D.h</a>&gt;</code></p>
121<table class="memberdecls">
122<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
123Public Member Functions</h2></td></tr>
124<tr class="memitem:a6d04dae020f8f71b144a9585f10c72c8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_vector2_d.html#a6d04dae020f8f71b144a9585f10c72c8">Vector2D</a> (float <a class="el" href="classflair_1_1core_1_1_vector2_d.html#a4c496c0f75c9e7ea1eb6fe24756c841b">x</a>=0, float <a class="el" href="classflair_1_1core_1_1_vector2_d.html#ade6bd3b2086bd23384ad48d6d342b275">y</a>=0)</td></tr>
125<tr class="memdesc:a6d04dae020f8f71b144a9585f10c72c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a6d04dae020f8f71b144a9585f10c72c8">More...</a><br /></td></tr>
126<tr class="separator:a6d04dae020f8f71b144a9585f10c72c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
127<tr class="memitem:a78515224e96adcca8c23b0f4bf092fed"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_vector2_d.html#a78515224e96adcca8c23b0f4bf092fed">~Vector2D</a> ()</td></tr>
128<tr class="memdesc:a78515224e96adcca8c23b0f4bf092fed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#a78515224e96adcca8c23b0f4bf092fed">More...</a><br /></td></tr>
129<tr class="separator:a78515224e96adcca8c23b0f4bf092fed"><td class="memSeparator" colspan="2">&#160;</td></tr>
130<tr class="memitem:a246911712ac7ad79a533a5e226e8a6bd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_vector2_d.html#a246911712ac7ad79a533a5e226e8a6bd">Rotate</a> (float value)</td></tr>
131<tr class="memdesc:a246911712ac7ad79a533a5e226e8a6bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rotation. <a href="#a246911712ac7ad79a533a5e226e8a6bd">More...</a><br /></td></tr>
132<tr class="separator:a246911712ac7ad79a533a5e226e8a6bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
133<tr class="memitem:a80ed74448580adf222bbdcfa5d35d26d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_vector2_d.html#a80ed74448580adf222bbdcfa5d35d26d">RotateDeg</a> (float value)</td></tr>
134<tr class="memdesc:a80ed74448580adf222bbdcfa5d35d26d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rotation. <a href="#a80ed74448580adf222bbdcfa5d35d26d">More...</a><br /></td></tr>
135<tr class="separator:a80ed74448580adf222bbdcfa5d35d26d"><td class="memSeparator" colspan="2">&#160;</td></tr>
136<tr class="memitem:a889d84730619570fe59de98ffe589722"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_vector2_d.html#a889d84730619570fe59de98ffe589722">GetNorm</a> (void) const </td></tr>
137<tr class="memdesc:a889d84730619570fe59de98ffe589722"><td class="mdescLeft">&#160;</td><td class="mdescRight">Norm. <a href="#a889d84730619570fe59de98ffe589722">More...</a><br /></td></tr>
138<tr class="separator:a889d84730619570fe59de98ffe589722"><td class="memSeparator" colspan="2">&#160;</td></tr>
139<tr class="memitem:afe22b1f414ccc721a65b014a57cb0fdf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_vector2_d.html#afe22b1f414ccc721a65b014a57cb0fdf">Normalize</a> (void)</td></tr>
140<tr class="memdesc:afe22b1f414ccc721a65b014a57cb0fdf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Normalize. <a href="#afe22b1f414ccc721a65b014a57cb0fdf">More...</a><br /></td></tr>
141<tr class="separator:afe22b1f414ccc721a65b014a57cb0fdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
142<tr class="memitem:a90c2504d93b1feb260613955f98e9a1d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_vector2_d.html#a90c2504d93b1feb260613955f98e9a1d">Saturate</a> (<a class="el" href="classflair_1_1core_1_1_vector2_d.html">Vector2D</a> min, <a class="el" href="classflair_1_1core_1_1_vector2_d.html">Vector2D</a> max)</td></tr>
143<tr class="memdesc:a90c2504d93b1feb260613955f98e9a1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saturate. <a href="#a90c2504d93b1feb260613955f98e9a1d">More...</a><br /></td></tr>
144<tr class="separator:a90c2504d93b1feb260613955f98e9a1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
145<tr class="memitem:adae894806c051710f80cc83de69e92f7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_vector2_d.html#adae894806c051710f80cc83de69e92f7">Saturate</a> (float min, float max)</td></tr>
146<tr class="memdesc:adae894806c051710f80cc83de69e92f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saturate. <a href="#adae894806c051710f80cc83de69e92f7">More...</a><br /></td></tr>
147<tr class="separator:adae894806c051710f80cc83de69e92f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
148<tr class="memitem:ac13fcde85cf0576201e47272ab6036be"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_vector2_d.html#ac13fcde85cf0576201e47272ab6036be">Saturate</a> (const <a class="el" href="classflair_1_1core_1_1_vector2_d.html">Vector2D</a> &amp;value)</td></tr>
149<tr class="memdesc:ac13fcde85cf0576201e47272ab6036be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saturate. <a href="#ac13fcde85cf0576201e47272ab6036be">More...</a><br /></td></tr>
150<tr class="separator:ac13fcde85cf0576201e47272ab6036be"><td class="memSeparator" colspan="2">&#160;</td></tr>
151<tr class="memitem:a498a2466751630d0d6e2d40efc2b008e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_vector2_d.html#a498a2466751630d0d6e2d40efc2b008e">Saturate</a> (float value)</td></tr>
152<tr class="memdesc:a498a2466751630d0d6e2d40efc2b008e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saturate. <a href="#a498a2466751630d0d6e2d40efc2b008e">More...</a><br /></td></tr>
153<tr class="separator:a498a2466751630d0d6e2d40efc2b008e"><td class="memSeparator" colspan="2">&#160;</td></tr>
154<tr class="memitem:ae1885f660e2f9b21e3f814bb72efa589"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1885f660e2f9b21e3f814bb72efa589"></a>
155<a class="el" href="classflair_1_1core_1_1_vector2_d.html">Vector2D</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classflair_1_1core_1_1_vector2_d.html">Vector2D</a> &amp;vector)</td></tr>
156<tr class="separator:ae1885f660e2f9b21e3f814bb72efa589"><td class="memSeparator" colspan="2">&#160;</td></tr>
157</table><table class="memberdecls">
158<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
159Public Attributes</h2></td></tr>
160<tr class="memitem:a4c496c0f75c9e7ea1eb6fe24756c841b"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_vector2_d.html#a4c496c0f75c9e7ea1eb6fe24756c841b">x</a></td></tr>
161<tr class="memdesc:a4c496c0f75c9e7ea1eb6fe24756c841b"><td class="mdescLeft">&#160;</td><td class="mdescRight">x <a href="#a4c496c0f75c9e7ea1eb6fe24756c841b">More...</a><br /></td></tr>
162<tr class="separator:a4c496c0f75c9e7ea1eb6fe24756c841b"><td class="memSeparator" colspan="2">&#160;</td></tr>
163<tr class="memitem:ade6bd3b2086bd23384ad48d6d342b275"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_vector2_d.html#ade6bd3b2086bd23384ad48d6d342b275">y</a></td></tr>
164<tr class="memdesc:ade6bd3b2086bd23384ad48d6d342b275"><td class="mdescLeft">&#160;</td><td class="mdescRight">y <a href="#ade6bd3b2086bd23384ad48d6d342b275">More...</a><br /></td></tr>
165<tr class="separator:ade6bd3b2086bd23384ad48d6d342b275"><td class="memSeparator" colspan="2">&#160;</td></tr>
166</table>
167<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
168<div class="textblock"><p>Class defining a 2D vector. </p>
169</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
170<a class="anchor" id="a6d04dae020f8f71b144a9585f10c72c8"></a>
171<div class="memitem">
172<div class="memproto">
173 <table class="memname">
174 <tr>
175 <td class="memname">flair::core::Vector2D::Vector2D </td>
176 <td>(</td>
177 <td class="paramtype">float&#160;</td>
178 <td class="paramname"><em>x</em> = <code>0</code>, </td>
179 </tr>
180 <tr>
181 <td class="paramkey"></td>
182 <td></td>
183 <td class="paramtype">float&#160;</td>
184 <td class="paramname"><em>y</em> = <code>0</code>&#160;</td>
185 </tr>
186 <tr>
187 <td></td>
188 <td>)</td>
189 <td></td><td></td>
190 </tr>
191 </table>
192</div><div class="memdoc">
193
194<p>Constructor. </p>
195<p>Construct a <a class="el" href="classflair_1_1core_1_1_vector2_d.html" title="Class defining a 2D vector. ">Vector2D</a> using specified values.</p>
196<dl class="params"><dt>Parameters</dt><dd>
197 <table class="params">
198 <tr><td class="paramname">x</td><td></td></tr>
199 <tr><td class="paramname">y</td><td></td></tr>
200 </table>
201 </dd>
202</dl>
203
204</div>
205</div>
206<a class="anchor" id="a78515224e96adcca8c23b0f4bf092fed"></a>
207<div class="memitem">
208<div class="memproto">
209 <table class="memname">
210 <tr>
211 <td class="memname">flair::core::Vector2D::~Vector2D </td>
212 <td>(</td>
213 <td class="paramname"></td><td>)</td>
214 <td></td>
215 </tr>
216 </table>
217</div><div class="memdoc">
218
219<p>Destructor. </p>
220
221</div>
222</div>
223<h2 class="groupheader">Member Function Documentation</h2>
224<a class="anchor" id="a246911712ac7ad79a533a5e226e8a6bd"></a>
225<div class="memitem">
226<div class="memproto">
227 <table class="memname">
228 <tr>
229 <td class="memname">void flair::core::Vector2D::Rotate </td>
230 <td>(</td>
231 <td class="paramtype">float&#160;</td>
232 <td class="paramname"><em>value</em></td><td>)</td>
233 <td></td>
234 </tr>
235 </table>
236</div><div class="memdoc">
237
238<p>Rotation. </p>
239<dl class="params"><dt>Parameters</dt><dd>
240 <table class="params">
241 <tr><td class="paramname">value</td><td>rotation value in radians </td></tr>
242 </table>
243 </dd>
244</dl>
245
246</div>
247</div>
248<a class="anchor" id="a80ed74448580adf222bbdcfa5d35d26d"></a>
249<div class="memitem">
250<div class="memproto">
251 <table class="memname">
252 <tr>
253 <td class="memname">void flair::core::Vector2D::RotateDeg </td>
254 <td>(</td>
255 <td class="paramtype">float&#160;</td>
256 <td class="paramname"><em>value</em></td><td>)</td>
257 <td></td>
258 </tr>
259 </table>
260</div><div class="memdoc">
261
262<p>Rotation. </p>
263<dl class="params"><dt>Parameters</dt><dd>
264 <table class="params">
265 <tr><td class="paramname">value</td><td>rotation value in degrees </td></tr>
266 </table>
267 </dd>
268</dl>
269
270</div>
271</div>
272<a class="anchor" id="a889d84730619570fe59de98ffe589722"></a>
273<div class="memitem">
274<div class="memproto">
275 <table class="memname">
276 <tr>
277 <td class="memname">float flair::core::Vector2D::GetNorm </td>
278 <td>(</td>
279 <td class="paramtype">void&#160;</td>
280 <td class="paramname"></td><td>)</td>
281 <td> const</td>
282 </tr>
283 </table>
284</div><div class="memdoc">
285
286<p>Norm. </p>
287<dl class="section return"><dt>Returns</dt><dd>value </dd></dl>
288
289</div>
290</div>
291<a class="anchor" id="afe22b1f414ccc721a65b014a57cb0fdf"></a>
292<div class="memitem">
293<div class="memproto">
294 <table class="memname">
295 <tr>
296 <td class="memname">void flair::core::Vector2D::Normalize </td>
297 <td>(</td>
298 <td class="paramtype">void&#160;</td>
299 <td class="paramname"></td><td>)</td>
300 <td></td>
301 </tr>
302 </table>
303</div><div class="memdoc">
304
305<p>Normalize. </p>
306
307</div>
308</div>
309<a class="anchor" id="a90c2504d93b1feb260613955f98e9a1d"></a>
310<div class="memitem">
311<div class="memproto">
312 <table class="memname">
313 <tr>
314 <td class="memname">void flair::core::Vector2D::Saturate </td>
315 <td>(</td>
316 <td class="paramtype"><a class="el" href="classflair_1_1core_1_1_vector2_d.html">Vector2D</a>&#160;</td>
317 <td class="paramname"><em>min</em>, </td>
318 </tr>
319 <tr>
320 <td class="paramkey"></td>
321 <td></td>
322 <td class="paramtype"><a class="el" href="classflair_1_1core_1_1_vector2_d.html">Vector2D</a>&#160;</td>
323 <td class="paramname"><em>max</em>&#160;</td>
324 </tr>
325 <tr>
326 <td></td>
327 <td>)</td>
328 <td></td><td></td>
329 </tr>
330 </table>
331</div><div class="memdoc">
332
333<p>Saturate. </p>
334<p>Saturate between min and max</p>
335<dl class="params"><dt>Parameters</dt><dd>
336 <table class="params">
337 <tr><td class="paramname">min</td><td>minimum <a class="el" href="classflair_1_1core_1_1_vector2_d.html" title="Class defining a 2D vector. ">Vector2D</a> value </td></tr>
338 <tr><td class="paramname">max</td><td>maximum <a class="el" href="classflair_1_1core_1_1_vector2_d.html" title="Class defining a 2D vector. ">Vector2D</a> value </td></tr>
339 </table>
340 </dd>
341</dl>
342
343</div>
344</div>
345<a class="anchor" id="adae894806c051710f80cc83de69e92f7"></a>
346<div class="memitem">
347<div class="memproto">
348 <table class="memname">
349 <tr>
350 <td class="memname">void flair::core::Vector2D::Saturate </td>
351 <td>(</td>
352 <td class="paramtype">float&#160;</td>
353 <td class="paramname"><em>min</em>, </td>
354 </tr>
355 <tr>
356 <td class="paramkey"></td>
357 <td></td>
358 <td class="paramtype">float&#160;</td>
359 <td class="paramname"><em>max</em>&#160;</td>
360 </tr>
361 <tr>
362 <td></td>
363 <td>)</td>
364 <td></td><td></td>
365 </tr>
366 </table>
367</div><div class="memdoc">
368
369<p>Saturate. </p>
370<p>Saturate between min and max</p>
371<dl class="params"><dt>Parameters</dt><dd>
372 <table class="params">
373 <tr><td class="paramname">min</td><td>minimum Vector2D(min,min) value </td></tr>
374 <tr><td class="paramname">max</td><td>maximum Vector2D(max,max) value </td></tr>
375 </table>
376 </dd>
377</dl>
378
379</div>
380</div>
381<a class="anchor" id="ac13fcde85cf0576201e47272ab6036be"></a>
382<div class="memitem">
383<div class="memproto">
384 <table class="memname">
385 <tr>
386 <td class="memname">void flair::core::Vector2D::Saturate </td>
387 <td>(</td>
388 <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_vector2_d.html">Vector2D</a> &amp;&#160;</td>
389 <td class="paramname"><em>value</em></td><td>)</td>
390 <td></td>
391 </tr>
392 </table>
393</div><div class="memdoc">
394
395<p>Saturate. </p>
396<p>Saturate between -abs(value) and abs(value)</p>
397<dl class="params"><dt>Parameters</dt><dd>
398 <table class="params">
399 <tr><td class="paramname">value</td><td>saturation <a class="el" href="classflair_1_1core_1_1_vector2_d.html" title="Class defining a 2D vector. ">Vector2D</a> value </td></tr>
400 </table>
401 </dd>
402</dl>
403
404</div>
405</div>
406<a class="anchor" id="a498a2466751630d0d6e2d40efc2b008e"></a>
407<div class="memitem">
408<div class="memproto">
409 <table class="memname">
410 <tr>
411 <td class="memname">void flair::core::Vector2D::Saturate </td>
412 <td>(</td>
413 <td class="paramtype">float&#160;</td>
414 <td class="paramname"><em>value</em></td><td>)</td>
415 <td></td>
416 </tr>
417 </table>
418</div><div class="memdoc">
419
420<p>Saturate. </p>
421<p>Saturate between -abs(Vector2D(value,value)) and abs(Vector2D(value,value))</p>
422<dl class="params"><dt>Parameters</dt><dd>
423 <table class="params">
424 <tr><td class="paramname">value</td><td>saturation Vector2D(value,value) </td></tr>
425 </table>
426 </dd>
427</dl>
428
429</div>
430</div>
431<h2 class="groupheader">Member Data Documentation</h2>
432<a class="anchor" id="a4c496c0f75c9e7ea1eb6fe24756c841b"></a>
433<div class="memitem">
434<div class="memproto">
435 <table class="memname">
436 <tr>
437 <td class="memname">float flair::core::Vector2D::x</td>
438 </tr>
439 </table>
440</div><div class="memdoc">
441
442<p>x </p>
443
444</div>
445</div>
446<a class="anchor" id="ade6bd3b2086bd23384ad48d6d342b275"></a>
447<div class="memitem">
448<div class="memproto">
449 <table class="memname">
450 <tr>
451 <td class="memname">float flair::core::Vector2D::y</td>
452 </tr>
453 </table>
454</div><div class="memdoc">
455
456<p>y </p>
457
458</div>
459</div>
460</div><!-- contents -->
461</div><!-- doc-content -->
462<!-- start footer part -->
463<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
464 <ul>
465 <li class="navelem"><a class="el" href="namespaceflair.html">flair</a></li><li class="navelem"><a class="el" href="namespaceflair_1_1core.html">core</a></li><li class="navelem"><a class="el" href="classflair_1_1core_1_1_vector2_d.html">Vector2D</a></li>
466 <li class="footer">Generated on Mon Apr 18 2016 17:27:09 for Flair by
467 <a href="http://www.doxygen.org/index.html">
468 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
469 </ul>
470</div>
471</body>
472</html>
Note: See TracBrowser for help on using the repository browser.