/usr/share/gtk-doc/html/libg3d/libg3d-vector.html is in libg3d-doc 0.0.8-17ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>vector</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libg3d Reference Manual">
<link rel="up" href="ch02.html" title="Plugin interface">
<link rel="prev" href="libg3d-matrix.html" title="matrix">
<link rel="next" href="libg3d-quat.html" title="quat">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libg3d-matrix.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libg3d Reference Manual</th>
<td><a accesskey="n" href="libg3d-quat.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libg3d-vector.synopsis" class="shortcut">Top</a>
|
<a href="#libg3d-vector.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libg3d-vector"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libg3d-vector.top_of_page"></a>vector</span></h2>
<p>vector — Vector manipulation and calculation</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libg3d-vector.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <g3d/vector.h>
typedef <a class="link" href="libg3d-vector.html#G3DVector" title="G3DVector">G3DVector</a>;
<span class="returnvalue">gboolean</span> <a class="link" href="libg3d-vector.html#g3d-vector-normal" title="g3d_vector_normal ()">g3d_vector_normal</a> (<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> ax</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> ay</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> az</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> bx</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> by</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> bz</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *nx</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *ny</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *nz</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libg3d-vector.html#g3d-vector-unify" title="g3d_vector_unify ()">g3d_vector_unify</a> (<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *nx</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *ny</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *nz</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libg3d-vector.html#g3d-vector-transform" title="g3d_vector_transform ()">g3d_vector_transform</a> (<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *x</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *y</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *z</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *matrix</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libg3d-vector.description"></a><h2>Description</h2>
<p>
A vector is a one-dimensional array of floating point data.
</p>
<p>
Declare it as statically as:
</p>
<p>
G3DVector vector[3];
</p>
<p>
or allocate it dynamically with:
</p>
<p>
G3DVector *vector = g3d_vector_new(3, 1);
</p>
</div>
<div class="refsect1">
<a name="libg3d-vector.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="G3DVector"></a><h3>G3DVector</h3>
<pre class="programlisting">typedef G3DFloat G3DVector;
</pre>
<p>
Vector element type.
</p>
</div>
<hr>
<div class="refsect2">
<a name="g3d-vector-normal"></a><h3>g3d_vector_normal ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g3d_vector_normal (<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> ax</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> ay</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> az</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> bx</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> by</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> bz</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *nx</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *ny</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *nz</code></em>);</pre>
<p>
calculate the normal from a plane defined by two vectors
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ax</code></em> :</span></p></td>
<td>x component first vector</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ay</code></em> :</span></p></td>
<td>y component first vector</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>az</code></em> :</span></p></td>
<td>z component first vector</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>bx</code></em> :</span></p></td>
<td>x component second vector</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>by</code></em> :</span></p></td>
<td>y component second vector</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>bz</code></em> :</span></p></td>
<td>z component second vector</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nx</code></em> :</span></p></td>
<td>x component resulting normal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ny</code></em> :</span></p></td>
<td>y component resulting normal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nz</code></em> :</span></p></td>
<td>z component resulting normal</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success, FALSE else</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-vector-unify"></a><h3>g3d_vector_unify ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g3d_vector_unify (<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *nx</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *ny</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *nz</code></em>);</pre>
<p>
Transforms the given vector to the unit vector.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>nx</code></em> :</span></p></td>
<td>x component of vector</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ny</code></em> :</span></p></td>
<td>y component of vector</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nz</code></em> :</span></p></td>
<td>z component of vector</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success, FALSE else</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-vector-transform"></a><h3>g3d_vector_transform ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g3d_vector_transform (<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *x</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *y</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> *z</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *matrix</code></em>);</pre>
<p>
Transforms the given vector corresponding to the given matrix
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>x component of vector</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>y component of vector</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>z</code></em> :</span></p></td>
<td>z component of vector</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>matrix</code></em> :</span></p></td>
<td>transformation matrix (4x4)</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success, FALSE else</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|