Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 4025

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csgeom/vector2.h Source File (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li><a href="classes.html"><span>Classes</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>csgeom/vector2.h</h1><a href="vector2_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">    Copyright (C) 2000 by Jorrit Tyberghein</span>
<a name="l00003"></a>00003 <span class="comment">    Largely rewritten by Ivan Avramovic &lt;ivan@avramovic.com&gt;</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00007"></a>00007 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00013"></a>00013 <span class="comment">    Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00016"></a>00016 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00017"></a>00017 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00018"></a>00018 <span class="comment">*/</span>
<a name="l00019"></a>00019 
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef __CS_VECTOR2_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_VECTOR2_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00023"></a>00023 <span class="preprocessor">#include "csextern.h"</span>
<a name="l00024"></a>00024 
<a name="l00032"></a>00032 <span class="keyword">class </span><a class="code" href="classcsString.html" title="Thin wrapper around csStringFast&amp;lt;&amp;gt; with its default buffer size.">csString</a>;
<a name="l00033"></a>00033 
<a name="l00037"></a><a class="code" href="classcsVector2.html">00037</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>
<a name="l00038"></a>00038 {
<a name="l00039"></a>00039 <span class="keyword">public</span>:
<a name="l00041"></a><a class="code" href="classcsVector2.html#cf4ee25489c98e6b7b7a460c4edd4ac6">00041</a>   <span class="keywordtype">float</span> x;
<a name="l00043"></a><a class="code" href="classcsVector2.html#f736730a67b9ee807f1455da3d2be188">00043</a>   <span class="keywordtype">float</span> y;
<a name="l00044"></a>00044 
<a name="l00046"></a><a class="code" href="classcsVector2.html#e5f1d7cd6195cda07ee9ddecbd6f7409">00046</a>   <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> () {}
<a name="l00047"></a>00047 
<a name="l00049"></a><a class="code" href="classcsVector2.html#b21c7982dca9bc951dba4b243ace171f">00049</a>   <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> (<span class="keywordtype">float</span> v) 
<a name="l00050"></a>00050     : x (v), y (v)
<a name="l00051"></a>00051   {}
<a name="l00052"></a>00052 
<a name="l00054"></a><a class="code" href="classcsVector2.html#e6a694e1ef368df9ae9e64536f9f2a32">00054</a>   <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> (<span class="keywordtype">float</span> x, <span class="keywordtype">float</span> y) 
<a name="l00055"></a>00055     : x (x), y (y) 
<a name="l00056"></a>00056   { }
<a name="l00057"></a>00057 
<a name="l00059"></a><a class="code" href="classcsVector2.html#55112000a51b8cc7b422adce88964e2f">00059</a>   <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> (<span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; o) 
<a name="l00060"></a>00060     : x (o.x), y (o.y)
<a name="l00061"></a>00061   {}
<a name="l00062"></a>00062 
<a name="l00064"></a>00064   <a class="code" href="classcsString.html" title="Thin wrapper around csStringFast&amp;lt;&amp;gt; with its default buffer size.">csString</a> Description() <span class="keyword">const</span>;
<a name="l00065"></a>00065 
<a name="l00067"></a><a class="code" href="classcsVector2.html#b7e0ea5b2b9b4b7e229990c383cf0b6f">00067</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> Set (<span class="keywordtype">float</span> ix, <span class="keywordtype">float</span> iy)
<a name="l00068"></a>00068   { x = ix; y = iy; }
<a name="l00069"></a>00069 
<a name="l00071"></a><a class="code" href="classcsVector2.html#adcdfae52235111cb24031206bd7fd6e">00071</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> Set (<a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> <span class="keyword">const</span>&amp; v)
<a name="l00072"></a>00072   { x = v.<a class="code" href="classcsVector2.html#cf4ee25489c98e6b7b7a460c4edd4ac6" title="X component of vector.">x</a>; y = v.<a class="code" href="classcsVector2.html#f736730a67b9ee807f1455da3d2be188" title="Y component of vector.">y</a>; }
<a name="l00073"></a>00073 
<a name="l00075"></a><a class="code" href="classcsVector2.html#101db2f85f0c3400e90399ef45111603">00075</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> Set (<span class="keywordtype">float</span> <span class="keyword">const</span>* v) { x = v[0]; y = v[1]; }
<a name="l00076"></a>00076 
<a name="l00078"></a><a class="code" href="classcsVector2.html#faad055f8fec2478a83800ac73cd28f3">00078</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> Set (<span class="keywordtype">float</span> v) { x = y = v; }
<a name="l00079"></a>00079 
<a name="l00081"></a><a class="code" href="classcsVector2.html#27559a7bee3f0fd1370811d4b1023827">00081</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> Get (<span class="keywordtype">float</span>* v) { v[0] = x; v[1] = y; }
<a name="l00082"></a>00082 
<a name="l00084"></a>00084   <span class="keyword">static</span> <span class="keywordtype">float</span> Norm (<a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> <span class="keyword">const</span>&amp; v);
<a name="l00085"></a>00085 
<a name="l00087"></a>00087   <span class="keywordtype">float</span> Norm () <span class="keyword">const</span>;
<a name="l00088"></a>00088 
<a name="l00090"></a><a class="code" href="classcsVector2.html#75d5837b69e0c167b22c3f9309ee5177">00090</a>   <span class="keyword">inline</span> <span class="keywordtype">float</span> SquaredNorm ()<span class="keyword"> const</span>
<a name="l00091"></a>00091 <span class="keyword">  </span>{ <span class="keywordflow">return</span> x * x + y * y; }
<a name="l00092"></a>00092 
<a name="l00094"></a>00094   <span class="keywordtype">void</span> Rotate (<span class="keywordtype">float</span> angle);
<a name="l00095"></a>00095 
<a name="l00100"></a><a class="code" href="classcsVector2.html#ccd1660dbfd74db06e899e7e319986ca">00100</a>   <span class="keyword">inline</span> <span class="keywordtype">float</span> IsLeft (<span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; p0, <span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; p1)
<a name="l00101"></a>00101   {
<a name="l00102"></a>00102     <span class="keywordflow">return</span> (p1.<a class="code" href="classcsVector2.html#cf4ee25489c98e6b7b7a460c4edd4ac6" title="X component of vector.">x</a> - p0.<a class="code" href="classcsVector2.html#cf4ee25489c98e6b7b7a460c4edd4ac6" title="X component of vector.">x</a>)*(y - p0.<a class="code" href="classcsVector2.html#f736730a67b9ee807f1455da3d2be188" title="Y component of vector.">y</a>) - (x - p0.<a class="code" href="classcsVector2.html#cf4ee25489c98e6b7b7a460c4edd4ac6" title="X component of vector.">x</a>)*(p1.<a class="code" href="classcsVector2.html#f736730a67b9ee807f1455da3d2be188" title="Y component of vector.">y</a> - p0.<a class="code" href="classcsVector2.html#f736730a67b9ee807f1455da3d2be188" title="Y component of vector.">y</a>);
<a name="l00103"></a>00103   }
<a name="l00104"></a>00104 
<a name="l00106"></a><a class="code" href="classcsVector2.html#bd3838c66b6a4611d3e44b19e93a4716">00106</a>   <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; operator+= (<span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; v)
<a name="l00107"></a>00107   { x += v.<a class="code" href="classcsVector2.html#cf4ee25489c98e6b7b7a460c4edd4ac6" title="X component of vector.">x</a>;  y += v.<a class="code" href="classcsVector2.html#f736730a67b9ee807f1455da3d2be188" title="Y component of vector.">y</a>;  <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
<a name="l00108"></a>00108 
<a name="l00110"></a><a class="code" href="classcsVector2.html#a828c447631e737db74799de8686f20a">00110</a>   <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; operator-= (<span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; v)
<a name="l00111"></a>00111   { x -= v.<a class="code" href="classcsVector2.html#cf4ee25489c98e6b7b7a460c4edd4ac6" title="X component of vector.">x</a>;  y -= v.<a class="code" href="classcsVector2.html#f736730a67b9ee807f1455da3d2be188" title="Y component of vector.">y</a>;  <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
<a name="l00112"></a>00112 
<a name="l00114"></a><a class="code" href="classcsVector2.html#6f7aac34ad42257e93a2cde5a0c14b01">00114</a>   <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; operator*= (<span class="keywordtype">float</span> f) { x *= f;  y *= f;  <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
<a name="l00115"></a>00115 
<a name="l00117"></a><a class="code" href="classcsVector2.html#19b26840e3ae012fbb777438e9833e40">00117</a>   <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; operator/= (<span class="keywordtype">float</span> f)
<a name="l00118"></a>00118   {
<a name="l00119"></a>00119     f = 1.0f / f;
<a name="l00120"></a>00120     x *= f;
<a name="l00121"></a>00121     y *= f;
<a name="l00122"></a>00122     <span class="keywordflow">return</span> *<span class="keyword">this</span>;
<a name="l00123"></a>00123   }
<a name="l00124"></a>00124 
<a name="l00126"></a><a class="code" href="classcsVector2.html#3ac1433944fc1bbed78144f4fc5ca03e">00126</a>   <span class="keyword">inline</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> <a class="code" href="cscolor_8h.html#4152cd06665dffa1b7bded50af1bbe34" title="Add two colors.">operator+ </a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
<a name="l00127"></a>00127 
<a name="l00129"></a><a class="code" href="classcsVector2.html#4077df99dacddd153b90bdc4d6e7b2c3">00129</a>   <span class="keyword">inline</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> <a class="code" href="cscolor_8h.html#55e738db674cbea902cb06597df8dacf" title="Subtract two colors.">operator- </a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>(-x,-y); }
<a name="l00130"></a>00130 
<a name="l00132"></a>00132   <span class="keyword">friend</span> CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> <a class="code" href="cscolor_8h.html#4152cd06665dffa1b7bded50af1bbe34" title="Add two colors.">operator+ </a>(<span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; v1, 
<a name="l00133"></a>00133     <span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; v2);
<a name="l00135"></a>00135   <span class="keyword">friend</span> CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> <a class="code" href="cscolor_8h.html#55e738db674cbea902cb06597df8dacf" title="Subtract two colors.">operator- </a>(<span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; v1, 
<a name="l00136"></a>00136     <span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; v2);
<a name="l00138"></a>00138   <span class="keyword">friend</span> CS_CRYSTALSPACE_EXPORT <span class="keywordtype">float</span> <a class="code" href="cscolor_8h.html#c99c344a2408f1e1928b247db5d64365" title="Multiply two colors.">operator* </a>(<span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; v1, 
<a name="l00139"></a>00139     <span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; v2);
<a name="l00141"></a>00141   <span class="keyword">friend</span> CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> <a class="code" href="cscolor_8h.html#c99c344a2408f1e1928b247db5d64365" title="Multiply two colors.">operator* </a>(<span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; v,
<a name="l00142"></a>00142         <span class="keywordtype">float</span> f);
<a name="l00144"></a>00144   <span class="keyword">friend</span> CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> <a class="code" href="cscolor_8h.html#c99c344a2408f1e1928b247db5d64365" title="Multiply two colors.">operator* </a>(<span class="keywordtype">float</span> f,
<a name="l00145"></a>00145         <span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; v);
<a name="l00147"></a>00147   <span class="keyword">friend</span> CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> <a class="code" href="cscolor_8h.html#a9b4d9b2f7603a763b65c580bf00eaad" title="Divide a color by a scalar.">operator/ </a>(<span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; v,
<a name="l00148"></a>00148         <span class="keywordtype">float</span> f);
<a name="l00150"></a>00150   <span class="keyword">friend</span> CS_CRYSTALSPACE_EXPORT <span class="keywordtype">bool</span> operator== (<span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; v1, 
<a name="l00151"></a>00151     <span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; v2);
<a name="l00153"></a>00153   <span class="keyword">friend</span> CS_CRYSTALSPACE_EXPORT <span class="keywordtype">bool</span> operator!= (<span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; v1, 
<a name="l00154"></a>00154     <span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; v2);
<a name="l00155"></a>00155 
<a name="l00157"></a><a class="code" href="classcsVector2.html#af6caaa84b6fe448c6d3b04825f48826">00157</a>   <span class="keyword">inline</span> <span class="keyword">friend</span> <span class="keywordtype">bool</span> operator&lt; (<span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; v, <span class="keywordtype">float</span> f)
<a name="l00158"></a>00158   { <span class="keywordflow">return</span> <a class="code" href="group__geom__utils.html#g996f7be338ccb40d1a2a5abc1ad61759">ABS</a>(v.<a class="code" href="classcsVector2.html#cf4ee25489c98e6b7b7a460c4edd4ac6" title="X component of vector.">x</a>)&lt;f &amp;&amp; <a class="code" href="group__geom__utils.html#g996f7be338ccb40d1a2a5abc1ad61759">ABS</a>(v.<a class="code" href="classcsVector2.html#f736730a67b9ee807f1455da3d2be188" title="Y component of vector.">y</a>)&lt;f; }
<a name="l00159"></a>00159 
<a name="l00161"></a><a class="code" href="classcsVector2.html#afb7e03f3b5661164327e97aa00ebf97">00161</a>   <span class="keyword">inline</span> <span class="keyword">friend</span> <span class="keywordtype">bool</span> operator&gt; (<span class="keywordtype">float</span> f, <span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>&amp; v)
<a name="l00162"></a>00162   { <span class="keywordflow">return</span> <a class="code" href="group__geom__utils.html#g996f7be338ccb40d1a2a5abc1ad61759">ABS</a>(v.<a class="code" href="classcsVector2.html#cf4ee25489c98e6b7b7a460c4edd4ac6" title="X component of vector.">x</a>)&lt;f &amp;&amp; <a class="code" href="group__geom__utils.html#g996f7be338ccb40d1a2a5abc1ad61759">ABS</a>(v.<a class="code" href="classcsVector2.html#f736730a67b9ee807f1455da3d2be188" title="Y component of vector.">y</a>)&lt;f; }
<a name="l00163"></a>00163 
<a name="l00164"></a>00164 
<a name="l00166"></a><a class="code" href="classcsVector2.html#2c420c308142180d3ddda8d62ef170fd">00166</a>   <span class="keyword">inline</span> <span class="keywordtype">float</span> operator[] (<span class="keywordtype">int</span> n)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> !n?x:y; }
<a name="l00168"></a><a class="code" href="classcsVector2.html#c5c18d5a94e08c55a3838997ae74f6cb">00168</a>   <span class="keyword">inline</span> <span class="keywordtype">float</span> &amp; operator[] (<span class="keywordtype">int</span> n) { <span class="keywordflow">return</span> !n?x:y; }
<a name="l00169"></a>00169 };
<a name="l00170"></a>00170 
<a name="l00173"></a>00173 <span class="preprocessor">#endif // __CS_VECTOR2_H__</span>
</pre></div><hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>