summaryrefslogtreecommitdiff
path: root/doc/html/Vector3_8hpp-source.htm
blob: 899ef44b5717af1745e7143f04e7b3337bcf9d21 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
    <head>
        <title>SFML - Simple and Fast Multimedia Library</title>
        <meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
        <link href="doxygen.css" rel="stylesheet" type="text/css" />
        <link href="tabs.css" rel="stylesheet" type="text/css" />
    </head>
    <body>
        <div id="logo">
            <img src="./logo.jpg" width="770" height="200" title="SFML home" alt="SFML logo" />
        </div>
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
  <ul>
    <li><a href="index.htm"><span>Main&nbsp;Page</span></a></li>
    <li><a href="namespaces.htm"><span>Namespaces</span></a></li>
    <li><a href="classes.htm"><span>Classes</span></a></li>
    <li class="current"><a href="files.htm"><span>Files</span></a></li>
  </ul>
</div>
<h1>Vector3.hpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 
<a name="l00002"></a>00002 <span class="comment">//</span>
<a name="l00003"></a>00003 <span class="comment">// SFML - Simple and Fast Multimedia Library</span>
<a name="l00004"></a>00004 <span class="comment">// Copyright (C) 2007-2008 Laurent Gomila (laurent.gom@gmail.com)</span>
<a name="l00005"></a>00005 <span class="comment">//</span>
<a name="l00006"></a>00006 <span class="comment">// This software is provided 'as-is', without any express or implied warranty.</span>
<a name="l00007"></a>00007 <span class="comment">// In no event will the authors be held liable for any damages arising from the use of this software.</span>
<a name="l00008"></a>00008 <span class="comment">//</span>
<a name="l00009"></a>00009 <span class="comment">// Permission is granted to anyone to use this software for any purpose,</span>
<a name="l00010"></a>00010 <span class="comment">// including commercial applications, and to alter it and redistribute it freely,</span>
<a name="l00011"></a>00011 <span class="comment">// subject to the following restrictions:</span>
<a name="l00012"></a>00012 <span class="comment">//</span>
<a name="l00013"></a>00013 <span class="comment">// 1. The origin of this software must not be misrepresented;</span>
<a name="l00014"></a>00014 <span class="comment">//    you must not claim that you wrote the original software.</span>
<a name="l00015"></a>00015 <span class="comment">//    If you use this software in a product, an acknowledgment</span>
<a name="l00016"></a>00016 <span class="comment">//    in the product documentation would be appreciated but is not required.</span>
<a name="l00017"></a>00017 <span class="comment">//</span>
<a name="l00018"></a>00018 <span class="comment">// 2. Altered source versions must be plainly marked as such,</span>
<a name="l00019"></a>00019 <span class="comment">//    and must not be misrepresented as being the original software.</span>
<a name="l00020"></a>00020 <span class="comment">//</span>
<a name="l00021"></a>00021 <span class="comment">// 3. This notice may not be removed or altered from any source distribution.</span>
<a name="l00022"></a>00022 <span class="comment">//</span>
<a name="l00024"></a>00024 <span class="comment"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#ifndef SFML_VECTOR3_HPP</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define SFML_VECTOR3_HPP</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span>
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 <span class="keyword">namespace </span>sf
<a name="l00030"></a>00030 {
<a name="l00036"></a>00036 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00037"></a><a class="code" href="classsf_1_1Vector3.htm">00037</a> <span class="keyword">class </span><a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3</a>
<a name="l00038"></a>00038 {
<a name="l00039"></a>00039 <span class="keyword">public</span> :
<a name="l00040"></a>00040 
<a name="l00045"></a>00045     <a class="code" href="classsf_1_1Vector3.htm#ee8be1985c6e45e381ad4071265636f9" title="Default constructor.">Vector3</a>();
<a name="l00046"></a>00046 
<a name="l00055"></a>00055     <a class="code" href="classsf_1_1Vector3.htm#ee8be1985c6e45e381ad4071265636f9" title="Default constructor.">Vector3</a>(T X, T Y, T Z);
<a name="l00056"></a>00056 
<a name="l00058"></a>00058     <span class="comment">// Member data</span>
<a name="l00060"></a><a class="code" href="classsf_1_1Vector3.htm#3cb0c769390bc37c346bb1a69e510d16">00060</a> <span class="comment"></span>    T <a class="code" href="classsf_1_1Vector3.htm#3cb0c769390bc37c346bb1a69e510d16" title="X coordinate of the vector.">x</a>; 
<a name="l00061"></a><a class="code" href="classsf_1_1Vector3.htm#6590d50ccb862c5efc5512e974e9b794">00061</a>     T <a class="code" href="classsf_1_1Vector3.htm#6590d50ccb862c5efc5512e974e9b794" title="Y coordinate of the vector.">y</a>; 
<a name="l00062"></a><a class="code" href="classsf_1_1Vector3.htm#2f36ab4b552c028e3a9734c1ad4df7d1">00062</a>     T <a class="code" href="classsf_1_1Vector3.htm#2f36ab4b552c028e3a9734c1ad4df7d1" title="Z coordinate of the vector.">z</a>; 
<a name="l00063"></a>00063 };
<a name="l00064"></a>00064 
<a name="l00073"></a>00073 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00074"></a>00074 <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a> <a class="code" href="namespacesf.htm#29068b8765da7da08c8d14ee7ea172ba" title="Operator - overload ; returns the opposite of a vector.">operator -</a>(<span class="keyword">const</span> <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a>&amp; V);
<a name="l00075"></a>00075 
<a name="l00085"></a>00085 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00086"></a>00086 <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a>&amp; <a class="code" href="namespacesf.htm#71e0dfa420275963771644b8f6b44796" title="Operator += overload ; add two vectors and assign to the first op.">operator +=</a>(<a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a>&amp; V1, <span class="keyword">const</span> <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a>&amp; V2);
<a name="l00087"></a>00087 
<a name="l00097"></a>00097 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00098"></a>00098 <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a>&amp; <a class="code" href="namespacesf.htm#78dfec22ce1dcce6407d11a83bf57734" title="Operator -= overload ; subtract two vectors and assign to the first op.">operator -=</a>(<a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a>&amp; V1, <span class="keyword">const</span> <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a>&amp; V2);
<a name="l00099"></a>00099 
<a name="l00109"></a>00109 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00110"></a>00110 <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a> <a class="code" href="namespacesf.htm#50ca5b482d1bed9710ecedfab8f3aa71" title="Operator + overload to add two colors.">operator +</a>(<span class="keyword">const</span> <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a>&amp; V1, <span class="keyword">const</span> <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a>&amp; V2);
<a name="l00111"></a>00111 
<a name="l00121"></a>00121 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00122"></a>00122 <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a> <a class="code" href="namespacesf.htm#29068b8765da7da08c8d14ee7ea172ba" title="Operator - overload ; returns the opposite of a vector.">operator -</a>(<span class="keyword">const</span> <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a>&amp; V1, <span class="keyword">const</span> <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a>&amp; V2);
<a name="l00123"></a>00123 
<a name="l00133"></a>00133 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00134"></a>00134 <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a> <a class="code" href="namespacesf.htm#22072379b0571262018fd6f4c86d4e97" title="Operator * overload to modulate two colors.">operator *</a>(<span class="keyword">const</span> <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a>&amp; V, T X);
<a name="l00135"></a>00135 
<a name="l00145"></a>00145 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00146"></a>00146 <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a> <a class="code" href="namespacesf.htm#22072379b0571262018fd6f4c86d4e97" title="Operator * overload to modulate two colors.">operator *</a>(T X, <span class="keyword">const</span> <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a>&amp; V);
<a name="l00147"></a>00147 
<a name="l00157"></a>00157 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00158"></a>00158 <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a>&amp; <a class="code" href="namespacesf.htm#da51460bf4cef8c1c958cae5c0eeb76f" title="Operator *= overload ; multiply-assign a vector by a scalar value.">operator *=</a>(<a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a>&amp; V, T X);
<a name="l00159"></a>00159 
<a name="l00169"></a>00169 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00170"></a>00170 <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a> <a class="code" href="namespacesf.htm#4d79f25d6c4b1601438becfff7256627" title="Operator / overload ; divide a vector by a scalar value.">operator /</a>(<span class="keyword">const</span> <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a>&amp; V, T X);
<a name="l00171"></a>00171 
<a name="l00181"></a>00181 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00182"></a>00182 <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a>&amp; <a class="code" href="namespacesf.htm#7d5a1bbf217894f98676c8cd4c57a8d1" title="Operator /= overload ; divide-assign a vector by a scalar value.">operator /=</a>(<a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a>&amp; V, T X);
<a name="l00183"></a>00183 
<a name="l00193"></a>00193 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00194"></a>00194 <span class="keywordtype">bool</span> <a class="code" href="namespacesf.htm#eb2e9506aa20c13b065592724eafa1d7" title="Operator == overload ; compares the equality of two vectors.">operator ==</a>(<span class="keyword">const</span> <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a>&amp; V1, <span class="keyword">const</span> <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a>&amp; V2);
<a name="l00195"></a>00195 
<a name="l00205"></a>00205 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00206"></a>00206 <span class="keywordtype">bool</span> <a class="code" href="namespacesf.htm#d34adb0b3cd1ff8176cd14eab6ffd7db" title="Operator != overload ; compares the difference of two vectors.">operator !=</a>(<span class="keyword">const</span> <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a>&amp; V1, <span class="keyword">const</span> <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;T&gt;</a>&amp; V2);
<a name="l00207"></a>00207 
<a name="l00208"></a>00208 <span class="preprocessor">#include &lt;SFML/System/Vector3.inl&gt;</span>
<a name="l00209"></a>00209 
<a name="l00210"></a>00210 <span class="comment">// Define the most common types</span>
<a name="l00211"></a><a class="code" href="namespacesf.htm#d066a8774efaf7b623df8909ba219dc7">00211</a> <span class="keyword">typedef</span> <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;int&gt;</a>   <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3i</a>;
<a name="l00212"></a><a class="code" href="namespacesf.htm#f97357d7d32e7d6a700d03be2f3b4811">00212</a> <span class="keyword">typedef</span> <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3&lt;float&gt;</a> <a class="code" href="classsf_1_1Vector3.htm" title="Vector3 is an utility class for manipulating 3 dimensional vectors.">Vector3f</a>;
<a name="l00213"></a>00213 
<a name="l00214"></a>00214 } <span class="comment">// namespace sf</span>
<a name="l00215"></a>00215 
<a name="l00216"></a>00216 
<a name="l00217"></a>00217 <span class="preprocessor">#endif // SFML_VECTOR3_HPP</span>
</pre></div>
        <p id="footer">
            &nbsp;::&nbsp; Copyright &copy; 2007-2008 Laurent Gomila, all rights reserved &nbsp;::&nbsp;
            Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.5.2</a> &nbsp;::&nbsp;
        </p>

    </body>
</html>