1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" />
7    <style type="text/css"><!--
8      span.static_style
9      {
10        font-size			: 8pt;
11        color				: white;
12        font-weight			: bold;
13        background			: #44f;
14        border-left			: solid 1px #aaf;
15        border-top			: solid 1px #aaf;
16        border-right		: solid 1px #00c;
17        border-bottom		: solid 1px #00c;
18        padding-left		: 2px;
19        padding-right		: 2px;
20      }
21
22      span.virtual_style
23      {
24        font-size			 : 8pt;
25        color				 : white;
26        font-weight			: bold;
27        background			: #0a0;
28        border-left			: solid 1px #0f0;
29        border-top			: solid 1px #0f0;
30        border-right		: solid 1px #060;
31        border-bottom		: solid 1px #060;
32        padding-left		: 2px;
33        padding-right		: 2px;
34      }
35
36      span.protected_style
37      {
38        font-size			 : 8pt;
39        color				 : white;
40        font-weight			: bold;
41        background			: #444;
42        border-left			: solid 1px #ccc;
43        border-top			: solid 1px #ccc;
44        border-right		: solid 1px #222;
45        border-bottom		: solid 1px #222;
46        padding-left		: 2px;
47        padding-right		: 2px;
48      }
49        --></style>
50<title>nn::math::VEC3</title>
51  </head>
52  <body>
53<h1><CODE>nn::math::VEC3</CODE> Structure</h1>
54<h2>Syntax</h2>
55    <div class="section">
56      <pre class="definition">struct VEC3 : public nn::math::VEC3_</pre>
57    </div>
58<h2>Description</h2>
59    <div class="section">
60<p>A three-dimensional vector class.</p><!-- write here --></div>
61    <a name="typedef" id="typedef">
62<h2><CODE>typedef</CODE> Definitions</h2>
63      <div class="section">
64        <table class="members">
65          <tr>
66            <td width="100" />
67            <th>
68<a href="../../../nn/math/VEC3/self_type.html"><CODE>self_type</CODE></a>
69            </th>
70<td>This class's type.</td>
71          </tr>
72          <tr>
73            <td width="100" />
74            <th>
75<a href="../../../nn/math/VEC3/value_type.html"><CODE>value_type</CODE></a>
76            </th>
77<td>The type of this class's elements.</td>
78          </tr> </table>
79      </div>
80    </a> <a name="constant" id="constant">
81<h2>Member Constants</h2>
82      <div class="section">
83        <table class="members">
84          <tr>
85            <td width="100">
86<span class="static_style" title="static">S</span>
87            </td>
88            <th>
89<span class="argument"><a href="../../../nn/math/VEC3/DIMENSION.html"><CODE>DIMENSION</CODE></a></span>
90            </th>
91<td>Number of dimensions.</td>
92          </tr> </table>
93      </div>
94    </a> <a name="function" id="function">
95<h2>Member Functions</h2>
96      <div class="section">
97        <table class="members">
98          <tr>
99<th class="category" colspan="3">Creation</th>
100          </tr>
101          <tr>
102            <td width="100">  </td>
103            <th>
104<a href="../../../nn/math/VEC3/VEC3.html"><CODE>VEC3</CODE></a>
105            </th>
106<td>Constructor.</td>
107          </tr>
108          <tr>
109<th class="category" colspan="3">Conversions</th>
110          </tr>
111          <tr>
112            <td width="100">  </td>
113            <th>
114<a href="../../../nn/math/VEC3/operator f32 -2a.html"><CODE>operator f32 *</CODE></a>
115            </th>
116<td>Casts to an <CODE>f32</CODE>-type value.</td>
117          </tr>
118          <tr>
119            <td width="100">  </td>
120            <th>
121<a href="../../../nn/math/VEC3/operator const f32 -2a.html"><CODE>operator const f32 *</CODE></a>
122            </th>
123<td>Casts to an <CODE>f32</CODE>-type value.</td>
124          </tr>
125          <tr>
126<th class="category" colspan="3">Operators</th>
127          </tr>
128          <tr>
129            <td width="100">  </td>
130            <th>
131<a href="../../../nn/math/VEC3/Lerp.html"><CODE>Lerp</CODE></a>
132            </th>
133<td>Linearly interpolates between two vectors and sets the result.</td>
134          </tr>
135          <tr>
136            <td width="100">  </td>
137            <th>
138<a href="../../../nn/math/VEC3/Dot.html"><CODE>Dot</CODE></a>
139            </th>
140<td>Calculates the dot product with the specified vector.</td>
141          </tr>
142          <tr>
143            <td width="100">  </td>
144            <th>
145<a href="../../../nn/math/VEC3/LenSq.html"><CODE>LenSq</CODE></a>
146            </th>
147<td>Calculates the square of a vector length. Use of this function is not recommended because it may be removed in the future. We recommend that you use <CODE>LengthSquare</CODE> instead.</td>
148          </tr>
149          <tr>
150            <td width="100">  </td>
151            <th>
152<a href="../../../nn/math/VEC3/LengthSquare.html"><CODE>LengthSquare</CODE></a>
153            </th>
154<td>Calculates the square of a vector length.</td>
155          </tr>
156          <tr>
157            <td width="100">  </td>
158            <th>
159<a href="../../../nn/math/VEC3/Length.html"><CODE>Length</CODE></a>
160            </th>
161<td>Calculates the vector length.</td>
162          </tr>
163          <tr>
164            <td width="100">  </td>
165            <th>
166<a href="../../../nn/math/VEC3/Normalize.html"><CODE>Normalize</CODE></a>
167            </th>
168<td>Normalizes a vector.</td>
169          </tr>
170          <tr>
171            <td width="100">  </td>
172            <th>
173<a href="../../../nn/math/VEC3/SafeNormalize.html"><CODE>SafeNormalize</CODE></a>
174            </th>
175<td>Normalizes a vector. If normalization fails, sets the specified vector.</td>
176          </tr>
177          <tr>
178            <td width="100">  </td>
179            <th>
180<a href="../../../nn/math/VEC3/DistanceSquare.html"><CODE>DistanceSquare</CODE></a>
181            </th>
182<td>Calculates the squared distance to the specified vector.</td>
183          </tr>
184          <tr>
185            <td width="100">  </td>
186            <th>
187<a href="../../../nn/math/VEC3/Maximize.html"><CODE>Maximize</CODE></a>
188            </th>
189<td>Creates the vector formed by the larger of each component of two input vectors.</td>
190          </tr>
191          <tr>
192            <td width="100">  </td>
193            <th>
194<a href="../../../nn/math/VEC3/Minimize.html"><CODE>Minimize</CODE></a>
195            </th>
196<td>Creates the vector formed by the smaller of each component of two input vectors.</td>
197          </tr>
198          <tr>
199            <td width="100">  </td>
200            <th>
201<a href="../../../nn/math/VEC3/Cross.html"><CODE>Cross</CODE></a>
202            </th>
203<td>Calculates the cross product of two vectors and sets the result.</td>
204          </tr>
205          <tr>
206<th class="category" colspan="3">Settings</th>
207          </tr>
208          <tr>
209            <td width="100">  </td>
210            <th>
211<a href="../../../nn/math/VEC3/Set.html"><CODE>Set</CODE></a>
212            </th>
213<td>Sets values individually.</td>
214          </tr>
215          <tr>
216<th class="category" colspan="3">Comparisons</th>
217          </tr>
218          <tr>
219            <td width="100">  </td>
220            <th>
221<a href="../../../nn/math/VEC3/operator==.html"><CODE>operator==</CODE></a>
222            </th>
223<td>Returns <CODE>true</CODE> if the values are equal.</td>
224          </tr>
225          <tr>
226            <td width="100">  </td>
227            <th>
228<a href="../../../nn/math/VEC3/operator!=.html"><CODE>operator!=</CODE></a>
229            </th>
230<td>Returns <CODE>true</CODE> if the values are not equal.</td>
231          </tr>
232          <tr>
233            <td width="100">  </td>
234            <th>
235<a href="../../../nn/math/VEC3/IsZero.html"><CODE>IsZero</CODE></a>
236            </th>
237<td>Returns <CODE>true</CODE> if this is a zero vector.</td>
238          </tr>
239          <tr>
240<th class="category" colspan="3">Other</th>
241          </tr>
242          <tr>
243            <td width="100">  </td>
244            <th>
245<a href="../../../nn/math/VEC3/Report.html"><CODE>Report</CODE></a>
246            </th>
247<td>Outputs the state.</td>
248          </tr> </table>
249      </div>
250    </a>
251<h2>Inheritance Hierarchy</h2>
252    <div class="section">
253<p class="hierarchy"><span>nn::math::VEC3_</span><br />  <b>nn::math::VEC3</b>
254      </p>
255    </div>
256<h2>Revision History</h2>
257    <div class="section">
258      <dl class="history">
259        <dt>2010/02/09</dt>
260<dd>Initial version.<br />
261        </dd>
262      </dl>
263    </div>
264  <hr><p>CONFIDENTIAL</p></body>
265</html>