aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/mimesh/libg3d-0.0.8/doc/api/html/libg3d-quat.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/others/mimesh/libg3d-0.0.8/doc/api/html/libg3d-quat.html')
-rw-r--r--src/others/mimesh/libg3d-0.0.8/doc/api/html/libg3d-quat.html346
1 files changed, 346 insertions, 0 deletions
diff --git a/src/others/mimesh/libg3d-0.0.8/doc/api/html/libg3d-quat.html b/src/others/mimesh/libg3d-0.0.8/doc/api/html/libg3d-quat.html
new file mode 100644
index 0000000..af4e6aa
--- /dev/null
+++ b/src/others/mimesh/libg3d-0.0.8/doc/api/html/libg3d-quat.html
@@ -0,0 +1,346 @@
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>quat</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-vector.html" title="vector">
10<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
11<link rel="stylesheet" href="style.css" type="text/css">
12<link rel="chapter" href="ch01.html" title="Application interface">
13<link rel="chapter" href="ch02.html" title="Plugin interface">
14</head>
15<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
16<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17<tr valign="middle">
18<td><a accesskey="p" href="libg3d-vector.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
19<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
20<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
21<th width="100%" align="center">libg3d Reference Manual</th>
22<td> </td>
23</tr>
24<tr><td colspan="5" class="shortcuts"><nobr><a href="#libg3d-quat.synopsis" class="shortcut">Top</a>
25  | 
26 <a href="#libg3d-quat.description" class="shortcut">Description</a></nobr></td></tr>
27</table>
28<div class="refentry" lang="en">
29<a name="libg3d-quat"></a><div class="titlepage"></div>
30<div class="refnamediv"><table width="100%"><tr>
31<td valign="top">
32<h2><span class="refentrytitle"><a name="libg3d-quat.top_of_page"></a>quat</span></h2>
33<p>quat — quaternion helpers</p>
34</td>
35<td valign="top" align="right"></td>
36</tr></table></div>
37<div class="refsynopsisdiv">
38<a name="libg3d-quat.synopsis"></a><h2>Synopsis</h2>
39<pre class="synopsis">
40
41#include &lt;g3d/quat.h&gt;
42
43typedef <a class="link" href="libg3d-quat.html#G3DQuat" title="G3DQuat">G3DQuat</a>;
44<a
45href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
46>gboolean</a> <a class="link" href="libg3d-quat.html#g3d-quat-add" title="g3d_quat_add ()">g3d_quat_add</a> (<a class="link" href="libg3d-quat.html#G3DQuat" title="G3DQuat">G3DQuat</a> *qr,
47 <a class="link" href="libg3d-quat.html#G3DQuat" title="G3DQuat">G3DQuat</a> *q1,
48 <a class="link" href="libg3d-quat.html#G3DQuat" title="G3DQuat">G3DQuat</a> *q2);
49<a
50href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
51>gboolean</a> <a class="link" href="libg3d-quat.html#g3d-quat-normalize" title="g3d_quat_normalize ()">g3d_quat_normalize</a> (<a class="link" href="libg3d-quat.html#G3DQuat" title="G3DQuat">G3DQuat</a> *q);
52<a
53href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
54>gboolean</a> <a class="link" href="libg3d-quat.html#g3d-quat-rotate" title="g3d_quat_rotate ()">g3d_quat_rotate</a> (<a class="link" href="libg3d-quat.html#G3DQuat" title="G3DQuat">G3DQuat</a> *q,
55 <a class="link" href="libg3d-vector.html#G3DVector" title="G3DVector">G3DVector</a> *axis,
56 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> angle);
57<a
58href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
59>gboolean</a> <a class="link" href="libg3d-quat.html#g3d-quat-to-matrix" title="g3d_quat_to_matrix ()">g3d_quat_to_matrix</a> (<a class="link" href="libg3d-quat.html#G3DQuat" title="G3DQuat">G3DQuat</a> *q,
60 <a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix">G3DMatrix</a> *matrix);
61<a
62href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
63>gboolean</a> <a class="link" href="libg3d-quat.html#g3d-quat-to-rotation-xyz" title="g3d_quat_to_rotation_xyz ()">g3d_quat_to_rotation_xyz</a> (<a class="link" href="libg3d-quat.html#G3DQuat" title="G3DQuat">G3DQuat</a> *q,
64 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *rx,
65 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *ry,
66 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *rz);
67<a
68href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
69>gboolean</a> <a class="link" href="libg3d-quat.html#g3d-quat-trackball" title="g3d_quat_trackball ()">g3d_quat_trackball</a> (<a class="link" href="libg3d-quat.html#G3DQuat" title="G3DQuat">G3DQuat</a> *q,
70 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> x1,
71 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> y1,
72 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> x2,
73 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> y2,
74 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> r);
75</pre>
76</div>
77<div class="refsect1" lang="en">
78<a name="libg3d-quat.description"></a><h2>Description</h2>
79<p>
80</p>
81<p>
82
83</p>
84</div>
85<div class="refsect1" lang="en">
86<a name="libg3d-quat.details"></a><h2>Details</h2>
87<div class="refsect2" lang="en">
88<a name="G3DQuat"></a><h3>G3DQuat</h3>
89<pre class="programlisting">typedef G3DFloat G3DQuat;
90</pre>
91<p>
92Quaternion element type.</p>
93<p>
94
95</p>
96</div>
97<hr>
98<div class="refsect2" lang="en">
99<a name="g3d-quat-add"></a><h3>g3d_quat_add ()</h3>
100<pre class="programlisting"><a
101href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
102>gboolean</a> g3d_quat_add (<a class="link" href="libg3d-quat.html#G3DQuat" title="G3DQuat">G3DQuat</a> *qr,
103 <a class="link" href="libg3d-quat.html#G3DQuat" title="G3DQuat">G3DQuat</a> *q1,
104 <a class="link" href="libg3d-quat.html#G3DQuat" title="G3DQuat">G3DQuat</a> *q2);</pre>
105<p>
106Add two quats.</p>
107<p>
108
109</p>
110<div class="variablelist"><table border="0">
111<col align="left" valign="top">
112<tbody>
113<tr>
114<td><p><span class="term"><em class="parameter"><code>qr</code></em> :</span></p></td>
115<td> result quat
116</td>
117</tr>
118<tr>
119<td><p><span class="term"><em class="parameter"><code>q1</code></em> :</span></p></td>
120<td> first quat
121</td>
122</tr>
123<tr>
124<td><p><span class="term"><em class="parameter"><code>q2</code></em> :</span></p></td>
125<td> second quat
126</td>
127</tr>
128<tr>
129<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
130<td> TRUE on success, FALSE else
131</td>
132</tr>
133</tbody>
134</table></div>
135</div>
136<hr>
137<div class="refsect2" lang="en">
138<a name="g3d-quat-normalize"></a><h3>g3d_quat_normalize ()</h3>
139<pre class="programlisting"><a
140href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
141>gboolean</a> g3d_quat_normalize (<a class="link" href="libg3d-quat.html#G3DQuat" title="G3DQuat">G3DQuat</a> *q);</pre>
142<p>
143normalize the quaternion to a length of 1.0.</p>
144<p>
145
146</p>
147<div class="variablelist"><table border="0">
148<col align="left" valign="top">
149<tbody>
150<tr>
151<td><p><span class="term"><em class="parameter"><code>q</code></em> :</span></p></td>
152<td> a quaternion
153</td>
154</tr>
155<tr>
156<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
157<td> TRUE on success, FALSE else
158</td>
159</tr>
160</tbody>
161</table></div>
162</div>
163<hr>
164<div class="refsect2" lang="en">
165<a name="g3d-quat-rotate"></a><h3>g3d_quat_rotate ()</h3>
166<pre class="programlisting"><a
167href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
168>gboolean</a> g3d_quat_rotate (<a class="link" href="libg3d-quat.html#G3DQuat" title="G3DQuat">G3DQuat</a> *q,
169 <a class="link" href="libg3d-vector.html#G3DVector" title="G3DVector">G3DVector</a> *axis,
170 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> angle);</pre>
171<p>
172Encode a rotation around an axis into quaternion.</p>
173<p>
174
175</p>
176<div class="variablelist"><table border="0">
177<col align="left" valign="top">
178<tbody>
179<tr>
180<td><p><span class="term"><em class="parameter"><code>q</code></em> :</span></p></td>
181<td> resulting quat
182</td>
183</tr>
184<tr>
185<td><p><span class="term"><em class="parameter"><code>axis</code></em> :</span></p></td>
186<td> rotation axis
187</td>
188</tr>
189<tr>
190<td><p><span class="term"><em class="parameter"><code>angle</code></em> :</span></p></td>
191<td> rotation angle
192</td>
193</tr>
194<tr>
195<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
196<td> TRUE on success, FALSE else
197</td>
198</tr>
199</tbody>
200</table></div>
201</div>
202<hr>
203<div class="refsect2" lang="en">
204<a name="g3d-quat-to-matrix"></a><h3>g3d_quat_to_matrix ()</h3>
205<pre class="programlisting"><a
206href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
207>gboolean</a> g3d_quat_to_matrix (<a class="link" href="libg3d-quat.html#G3DQuat" title="G3DQuat">G3DQuat</a> *q,
208 <a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix">G3DMatrix</a> *matrix);</pre>
209<p>
210Convert a quaternion to a transformation matrix.</p>
211<p>
212
213</p>
214<div class="variablelist"><table border="0">
215<col align="left" valign="top">
216<tbody>
217<tr>
218<td><p><span class="term"><em class="parameter"><code>q</code></em> :</span></p></td>
219<td> source quat
220</td>
221</tr>
222<tr>
223<td><p><span class="term"><em class="parameter"><code>matrix</code></em> :</span></p></td>
224<td> resulting matrix
225</td>
226</tr>
227<tr>
228<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
229<td> TRUE on success, FALSE else
230</td>
231</tr>
232</tbody>
233</table></div>
234</div>
235<hr>
236<div class="refsect2" lang="en">
237<a name="g3d-quat-to-rotation-xyz"></a><h3>g3d_quat_to_rotation_xyz ()</h3>
238<pre class="programlisting"><a
239href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
240>gboolean</a> g3d_quat_to_rotation_xyz (<a class="link" href="libg3d-quat.html#G3DQuat" title="G3DQuat">G3DQuat</a> *q,
241 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *rx,
242 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *ry,
243 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> *rz);</pre>
244<p>
245Calculate the rotation around the three coordinate axes from a given
246quaternion.</p>
247<p>
248
249</p>
250<div class="variablelist"><table border="0">
251<col align="left" valign="top">
252<tbody>
253<tr>
254<td><p><span class="term"><em class="parameter"><code>q</code></em> :</span></p></td>
255<td> a quaternion
256</td>
257</tr>
258<tr>
259<td><p><span class="term"><em class="parameter"><code>rx</code></em> :</span></p></td>
260<td> rotation around x axis
261</td>
262</tr>
263<tr>
264<td><p><span class="term"><em class="parameter"><code>ry</code></em> :</span></p></td>
265<td> rotation around y axis
266</td>
267</tr>
268<tr>
269<td><p><span class="term"><em class="parameter"><code>rz</code></em> :</span></p></td>
270<td> rotation around z axis
271</td>
272</tr>
273<tr>
274<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
275<td> TRUE on success, FALSE else
276</td>
277</tr>
278</tbody>
279</table></div>
280</div>
281<hr>
282<div class="refsect2" lang="en">
283<a name="g3d-quat-trackball"></a><h3>g3d_quat_trackball ()</h3>
284<pre class="programlisting"><a
285href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
286>gboolean</a> g3d_quat_trackball (<a class="link" href="libg3d-quat.html#G3DQuat" title="G3DQuat">G3DQuat</a> *q,
287 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> x1,
288 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> y1,
289 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> x2,
290 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> y2,
291 <a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat">G3DFloat</a> r);</pre>
292<p>
293Emulate a virtual trackball movement and return rotation as quaternion.
294The x and y values of the starting and end point of the movement have
295to be in the range -1.0 .. 1.0.</p>
296<p>
297
298</p>
299<div class="variablelist"><table border="0">
300<col align="left" valign="top">
301<tbody>
302<tr>
303<td><p><span class="term"><em class="parameter"><code>q</code></em> :</span></p></td>
304<td> resulting quaternion
305</td>
306</tr>
307<tr>
308<td><p><span class="term"><em class="parameter"><code>x1</code></em> :</span></p></td>
309<td> x value of first point
310</td>
311</tr>
312<tr>
313<td><p><span class="term"><em class="parameter"><code>y1</code></em> :</span></p></td>
314<td> y value of first point
315</td>
316</tr>
317<tr>
318<td><p><span class="term"><em class="parameter"><code>x2</code></em> :</span></p></td>
319<td> x value of second point
320</td>
321</tr>
322<tr>
323<td><p><span class="term"><em class="parameter"><code>y2</code></em> :</span></p></td>
324<td> y value of second point
325</td>
326</tr>
327<tr>
328<td><p><span class="term"><em class="parameter"><code>r</code></em> :</span></p></td>
329<td> radius of virtual trackball, usually 0.8
330</td>
331</tr>
332<tr>
333<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
334<td> TRUE on success, FALSE else
335</td>
336</tr>
337</tbody>
338</table></div>
339</div>
340</div>
341</div>
342<div class="footer">
343<hr>
344 Generated by GTK-Doc V1.10</div>
345</body>
346</html>
generated by cgit v1.1 at 2024-05-21 09:24:42 +0000