/usr/share/gtk-doc/html/libg3d/libg3d-object.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 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>object</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="ch01.html" title="Application interface">
<link rel="prev" href="libg3d-model.html" title="model">
<link rel="next" href="libg3d-face.html" title="face">
<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-model.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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-face.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-object.synopsis" class="shortcut">Top</a>
|
<a href="#libg3d-object.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libg3d-object"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libg3d-object.top_of_page"></a>object</span></h2>
<p>object — Object manipulation</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libg3d-object.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <g3d/object.h>
<a class="link" href="libg3d-object.html#G3DObject" title="G3DObject">G3DObject</a>;
<a class="link" href="libg3d-object.html#G3DTransformation" title="G3DTransformation">G3DTransformation</a>;
<span class="returnvalue">void</span> <a class="link" href="libg3d-object.html#g3d-object-free" title="g3d_object_free ()">g3d_object_free</a> (<em class="parameter"><code><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a> *object</code></em>);
<span class="returnvalue">gdouble</span> <a class="link" href="libg3d-object.html#g3d-object-radius" title="g3d_object_radius ()">g3d_object_radius</a> (<em class="parameter"><code><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a> *object</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libg3d-object.html#g3d-object-scale" title="g3d_object_scale ()">g3d_object_scale</a> (<em class="parameter"><code><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a> *object</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> scale</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libg3d-object.html#g3d-object-transform" title="g3d_object_transform ()">g3d_object_transform</a> (<em class="parameter"><code><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a> *object</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>);
<span class="returnvalue">gboolean</span> <a class="link" href="libg3d-object.html#g3d-object-transform-normals" title="g3d_object_transform_normals ()">g3d_object_transform_normals</a> (<em class="parameter"><code><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a> *object</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>);
<a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="returnvalue">G3DObject</span></a> * <a class="link" href="libg3d-object.html#g3d-object-duplicate" title="g3d_object_duplicate ()">g3d_object_duplicate</a> (<em class="parameter"><code><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a> *object</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libg3d-object.html#g3d-object-optimize" title="g3d_object_optimize ()">g3d_object_optimize</a> (<em class="parameter"><code><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a> *object</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libg3d-object.html#g3d-object-smooth" title="g3d_object_smooth ()">g3d_object_smooth</a> (<em class="parameter"><code><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a> *object</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libg3d-object.html#g3d-object-merge" title="g3d_object_merge ()">g3d_object_merge</a> (<em class="parameter"><code><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a> *o1</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a> *o2</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libg3d-object.description"></a><h2>Description</h2>
<p>
Objects are parts of a model. In most file formats vertices and faces are
grouped in some way into objects. Objects can be hierarchical, so what a
model contains is basically an object tree.
</p>
</div>
<div class="refsect1">
<a name="libg3d-object.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="G3DObject"></a><h3>G3DObject</h3>
<pre class="programlisting">typedef struct {
gchar *name;
GSList *materials;
GSList *faces;
GSList *objects;
/* transformation, may be NULL */
G3DTransformation *transformation;
/* don't render this object */
gboolean hide;
/* vertices */
guint32 vertex_count;
G3DVector *vertex_data;
} G3DObject;
</pre>
<p>
A three-dimensional object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="G3DObject.name"></a>name</code></em>;</span></p></td>
<td>name of object</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">GSList</span> *<em class="structfield"><code><a name="G3DObject.materials"></a>materials</code></em>;</span></p></td>
<td>list of materials</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">GSList</span> *<em class="structfield"><code><a name="G3DObject.faces"></a>faces</code></em>;</span></p></td>
<td>list of faces</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">GSList</span> *<em class="structfield"><code><a name="G3DObject.objects"></a>objects</code></em>;</span></p></td>
<td>list of sub-objects</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libg3d-object.html#G3DTransformation" title="G3DTransformation"><span class="type">G3DTransformation</span></a> *<em class="structfield"><code><a name="G3DObject.transformation"></a>transformation</code></em>;</span></p></td>
<td>optional transformation</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">gboolean</span> <em class="structfield"><code><a name="G3DObject.hide"></a>hide</code></em>;</span></p></td>
<td>flag to disable object rendering</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">guint32</span> <em class="structfield"><code><a name="G3DObject.vertex-count"></a>vertex_count</code></em>;</span></p></td>
<td>number of vertices</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libg3d-vector.html#G3DVector" title="G3DVector"><span class="type">G3DVector</span></a> *<em class="structfield"><code><a name="G3DObject.vertex-data"></a>vertex_data</code></em>;</span></p></td>
<td>vertex vector data</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="G3DTransformation"></a><h3>G3DTransformation</h3>
<pre class="programlisting">typedef struct {
G3DMatrix matrix[16];
guint32 flags;
} G3DTransformation;
</pre>
<p>
A three-dimensional matrix transformation object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> <em class="structfield"><code><a name="G3DTransformation.matrix"></a>matrix</code></em>[16];</span></p></td>
<td>the transformation matrix</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">guint32</span> <em class="structfield"><code><a name="G3DTransformation.flags"></a>flags</code></em>;</span></p></td>
<td>flags</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-object-free"></a><h3>g3d_object_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> g3d_object_free (<em class="parameter"><code><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a> *object</code></em>);</pre>
<p>
Frees all memory allocated for that object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>the object to free</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-object-radius"></a><h3>g3d_object_radius ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span> g3d_object_radius (<em class="parameter"><code><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a> *object</code></em>);</pre>
<p>
Calculates the radius of the object. This is the maximum from the
center to a vertex.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>the object to measure</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the radius of the given object</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-object-scale"></a><h3>g3d_object_scale ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g3d_object_scale (<em class="parameter"><code><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a> *object</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> scale</code></em>);</pre>
<p>
Resizes the object by the factor <em class="parameter"><code>scale</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>the object to scale</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>scale</code></em> :</span></p></td>
<td>scale factor</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-object-transform"></a><h3>g3d_object_transform ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g3d_object_transform (<em class="parameter"><code><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a> *object</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>
Multiplies all vertices of the object with the transformation matrix.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>the object to transform</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>matrix</code></em> :</span></p></td>
<td>the transformation matrix</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-object-transform-normals"></a><h3>g3d_object_transform_normals ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g3d_object_transform_normals (<em class="parameter"><code><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a> *object</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>
Multiplies all normals of the object with the transformation matrix.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>the object to transform</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>matrix</code></em> :</span></p></td>
<td>the transformation matrix</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-object-duplicate"></a><h3>g3d_object_duplicate ()</h3>
<pre class="programlisting"><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="returnvalue">G3DObject</span></a> * g3d_object_duplicate (<em class="parameter"><code><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a> *object</code></em>);</pre>
<p>
Duplicates an object with all vertices, faces and materials.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>the object to duplicate</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new clone object</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-object-optimize"></a><h3>g3d_object_optimize ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g3d_object_optimize (<em class="parameter"><code><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a> *object</code></em>);</pre>
<p>
Puts all vertex and face information into special arrays for faster
rendering. It is deprecated and should not be used.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>the object to optimize</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-object-smooth"></a><h3>g3d_object_smooth ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g3d_object_smooth (<em class="parameter"><code><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a> *object</code></em>);</pre>
<p>
FIXME: unimplemented.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>the object to smooth</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-object-merge"></a><h3>g3d_object_merge ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g3d_object_merge (<em class="parameter"><code><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a> *o1</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a> *o2</code></em>);</pre>
<p>
Merges both objects into <em class="parameter"><code>o1</code></em>.
FIXME: needs cleanup
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>o1</code></em> :</span></p></td>
<td>first and target object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>o2</code></em> :</span></p></td>
<td>second object</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>
|