aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/mimesh/libg3d-0.0.8/doc/api/html/libg3d-vector.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/others/mimesh/libg3d-0.0.8/doc/api/html/libg3d-vector.html')
-rw-r--r--src/others/mimesh/libg3d-0.0.8/doc/api/html/libg3d-vector.html266
1 files changed, 266 insertions, 0 deletions
diff --git a/src/others/mimesh/libg3d-0.0.8/doc/api/html/libg3d-vector.html b/src/others/mimesh/libg3d-0.0.8/doc/api/html/libg3d-vector.html
new file mode 100644
index 0000000..7c2ed8f
--- /dev/null
+++ b/src/others/mimesh/libg3d-0.0.8/doc/api/html/libg3d-vector.html
@@ -0,0 +1,266 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5<title>vector</title>
6<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7<link rel="start" href="index.html" title="libg3d Reference Manual">
8<link rel="up" href="ch02.html" title="Plugin interface">
9<link rel="prev" href="libg3d-matrix.html" title="matrix">
10<link rel="next" href="libg3d-quat.html" title="quat">
11<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
12<link rel="stylesheet" href="style.css" type="text/css">
13<link rel="chapter" href="ch01.html" title="Application interface">
14<link rel="chapter" href="ch02.html" title="Plugin interface">
15</head>
16<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
17<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
18<tr valign="middle">
19<td><a accesskey="p" href="libg3d-matrix.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
20<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
21<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
22<th width="100%" align="center">libg3d Reference Manual</th>
23<td><a accesskey="n" href="libg3d-quat.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
24</tr>
25<tr><td colspan="5" class="shortcuts"><nobr><a href="#libg3d-vector.synopsis" class="shortcut">Top</a>
26  | 
27 <a href="#libg3d-vector.description" class="shortcut">Description</a></nobr></td></tr>
28</table>
29<div class="refentry" lang="en">
30<a name="libg3d-vector"></a><div class="titlepage"></div>
31<div class="refnamediv"><table width="100%"><tr>
32<td valign="top">
33<h2><span class="refentrytitle"><a name="libg3d-vector.top_of_page"></a>vector</span></h2>
34<p>vector — Vector manipulation and calculation</p>
35</td>
36<td valign="top" align="right"></td>
37</tr></table></div>
38<div class="refsynopsisdiv">
39<a name="libg3d-vector.synopsis"></a><h2>Synopsis</h2>
40<pre class="synopsis">
41
42#include &lt;g3d/vector.h&gt;
43
44typedef <a class="link" href="libg3d-vector.html#G3DVector" title="G3DVector">G3DVector</a>;
45<a
46href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
47>gboolean</a> <a class="link" href="libg3d-vector.html#g3d-vector-normal" title="g3d_vector_normal ()">g3d_vector_normal</a> (<a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> ax,
48 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> ay,
49 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> az,
50 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> bx,
51 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> by,
52 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> bz,
53 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *nx,
54 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *ny,
55 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *nz);
56<a
57href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
58>gboolean</a> <a class="link" href="libg3d-vector.html#g3d-vector-unify" title="g3d_vector_unify ()">g3d_vector_unify</a> (<a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *nx,
59 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *ny,
60 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *nz);
61<a
62href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
63>gboolean</a> <a class="link" href="libg3d-vector.html#g3d-vector-transform" title="g3d_vector_transform ()">g3d_vector_transform</a> (<a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *x,
64 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *y,
65 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *z,
66 <a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix">G3DMatrix</a> *matrix);
67</pre>
68</div>
69<div class="refsect1" lang="en">
70<a name="libg3d-vector.description"></a><h2>Description</h2>
71<p>
72A vector is a one-dimensional array of floating point data.
73</p>
74<p>
75Declare it as statically as:
76</p>
77<p>
78G3DVector vector[3];
79</p>
80<p>
81or allocate it dynamically with:
82</p>
83<p>
84G3DVector *vector = g3d_vector_new(3, 1);</p>
85<p>
86
87</p>
88</div>
89<div class="refsect1" lang="en">
90<a name="libg3d-vector.details"></a><h2>Details</h2>
91<div class="refsect2" lang="en">
92<a name="G3DVector"></a><h3>G3DVector</h3>
93<pre class="programlisting">typedef G3DFloat G3DVector;
94</pre>
95<p>
96Vector element type.</p>
97<p>
98
99</p>
100</div>
101<hr>
102<div class="refsect2" lang="en">
103<a name="g3d-vector-normal"></a><h3>g3d_vector_normal ()</h3>
104<pre class="programlisting"><a
105href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
106>gboolean</a> g3d_vector_normal (<a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> ax,
107 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> ay,
108 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> az,
109 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> bx,
110 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> by,
111 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> bz,
112 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *nx,
113 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *ny,
114 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *nz);</pre>
115<p>
116calculate the normal from a plane defined by two vectors</p>
117<p>
118
119</p>
120<div class="variablelist"><table border="0">
121<col align="left" valign="top">
122<tbody>
123<tr>
124<td><p><span class="term"><em class="parameter"><code>ax</code></em> :</span></p></td>
125<td> x component first vector
126</td>
127</tr>
128<tr>
129<td><p><span class="term"><em class="parameter"><code>ay</code></em> :</span></p></td>
130<td> y component first vector
131</td>
132</tr>
133<tr>
134<td><p><span class="term"><em class="parameter"><code>az</code></em> :</span></p></td>
135<td> z component first vector
136</td>
137</tr>
138<tr>
139<td><p><span class="term"><em class="parameter"><code>bx</code></em> :</span></p></td>
140<td> x component second vector
141</td>
142</tr>
143<tr>
144<td><p><span class="term"><em class="parameter"><code>by</code></em> :</span></p></td>
145<td> y component second vector
146</td>
147</tr>
148<tr>
149<td><p><span class="term"><em class="parameter"><code>bz</code></em> :</span></p></td>
150<td> z component second vector
151</td>
152</tr>
153<tr>
154<td><p><span class="term"><em class="parameter"><code>nx</code></em> :</span></p></td>
155<td> x component resulting normal
156</td>
157</tr>
158<tr>
159<td><p><span class="term"><em class="parameter"><code>ny</code></em> :</span></p></td>
160<td> y component resulting normal
161</td>
162</tr>
163<tr>
164<td><p><span class="term"><em class="parameter"><code>nz</code></em> :</span></p></td>
165<td> z component resulting normal
166</td>
167</tr>
168<tr>
169<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
170<td> TRUE on success, FALSE else
171</td>
172</tr>
173</tbody>
174</table></div>
175</div>
176<hr>
177<div class="refsect2" lang="en">
178<a name="g3d-vector-unify"></a><h3>g3d_vector_unify ()</h3>
179<pre class="programlisting"><a
180href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
181>gboolean</a> g3d_vector_unify (<a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *nx,
182 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *ny,
183 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *nz);</pre>
184<p>
185Transforms the given vector to the unit vector.</p>
186<p>
187
188</p>
189<div class="variablelist"><table border="0">
190<col align="left" valign="top">
191<tbody>
192<tr>
193<td><p><span class="term"><em class="parameter"><code>nx</code></em> :</span></p></td>
194<td> x component of vector
195</td>
196</tr>
197<tr>
198<td><p><span class="term"><em class="parameter"><code>ny</code></em> :</span></p></td>
199<td> y component of vector
200</td>
201</tr>
202<tr>
203<td><p><span class="term"><em class="parameter"><code>nz</code></em> :</span></p></td>
204<td> z component of vector
205</td>
206</tr>
207<tr>
208<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
209<td> TRUE on success, FALSE else
210</td>
211</tr>
212</tbody>
213</table></div>
214</div>
215<hr>
216<div class="refsect2" lang="en">
217<a name="g3d-vector-transform"></a><h3>g3d_vector_transform ()</h3>
218<pre class="programlisting"><a
219href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
220>gboolean</a> g3d_vector_transform (<a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *x,
221 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *y,
222 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *z,
223 <a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix">G3DMatrix</a> *matrix);</pre>
224<p>
225Transforms the given vector corresponding to the given matrix</p>
226<p>
227
228</p>
229<div class="variablelist"><table border="0">
230<col align="left" valign="top">
231<tbody>
232<tr>
233<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
234<td> x component of vector
235</td>
236</tr>
237<tr>
238<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
239<td> y component of vector
240</td>
241</tr>
242<tr>
243<td><p><span class="term"><em class="parameter"><code>z</code></em> :</span></p></td>
244<td> z component of vector
245</td>
246</tr>
247<tr>
248<td><p><span class="term"><em class="parameter"><code>matrix</code></em> :</span></p></td>
249<td> transformation matrix (4x4)
250</td>
251</tr>
252<tr>
253<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
254<td> TRUE on success, FALSE else
255</td>
256</tr>
257</tbody>
258</table></div>
259</div>
260</div>
261</div>
262<div class="footer">
263<hr>
264 Generated by GTK-Doc V1.10</div>
265</body>
266</html>
generated by cgit v1.1 at 2024-05-21 09:20:06 +0000