/usr/share/gtk-doc/html/libg3d/libg3d-model.html is in libg3d-doc 0.0.8-22.
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 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>model: libg3d Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.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-context.html" title="context">
<link rel="next" href="libg3d-object.html" title="object">
<meta name="generator" content="GTK-Doc V1.24 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libg3d-model.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libg3d-context.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libg3d-object.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libg3d-model"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libg3d-model.top_of_page"></a>model</span></h2>
<p>model — Model manipulation functions</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libg3d-model.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libg3d-model.html#G3D-MODEL-CENTER:CAPS" title="G3D_MODEL_CENTER">G3D_MODEL_CENTER</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libg3d-model.html#G3D-MODEL-NOCHECK:CAPS" title="G3D_MODEL_NOCHECK">G3D_MODEL_NOCHECK</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libg3d-model.html#G3D-MODEL-OPTIMIZE:CAPS" title="G3D_MODEL_OPTIMIZE">G3D_MODEL_OPTIMIZE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libg3d-model.html#G3D-MODEL-SCALE:CAPS" title="G3D_MODEL_SCALE">G3D_MODEL_SCALE</a></td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libg3d-model.html#G3DModel" title="G3DModel"><span class="returnvalue">G3DModel</span></a> *
</td>
<td class="function_name">
<a class="link" href="libg3d-model.html#g3d-model-new" title="g3d_model_new ()">g3d_model_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libg3d-model.html#G3DModel" title="G3DModel"><span class="returnvalue">G3DModel</span></a> *
</td>
<td class="function_name">
<a class="link" href="libg3d-model.html#g3d-model-load" title="g3d_model_load ()">g3d_model_load</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libg3d-model.html#G3DModel" title="G3DModel"><span class="returnvalue">G3DModel</span></a> *
</td>
<td class="function_name">
<a class="link" href="libg3d-model.html#g3d-model-load-full" title="g3d_model_load_full ()">g3d_model_load_full</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libg3d-model.html#g3d-model-check" title="g3d_model_check ()">g3d_model_check</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libg3d-model.html#g3d-model-center" title="g3d_model_center ()">g3d_model_center</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libg3d-model.html#g3d-model-transform" title="g3d_model_transform ()">g3d_model_transform</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libg3d-model.html#g3d-model-clear" title="g3d_model_clear ()">g3d_model_clear</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libg3d-model.html#g3d-model-free" title="g3d_model_free ()">g3d_model_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="returnvalue">G3DObject</span></a> *
</td>
<td class="function_name">
<a class="link" href="libg3d-model.html#g3d-model-get-object-by-name" title="g3d_model_get_object_by_name ()">g3d_model_get_object_by_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libg3d-model.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libg3d-model.html#G3DModel" title="G3DModel">G3DModel</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libg3d-model.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <g3d/g3d.h>
</pre>
</div>
<div class="refsect1">
<a name="libg3d-model.description"></a><h2>Description</h2>
<p>A model is a group of objects. All information loaded from a file by libg3d
is found in this model.</p>
</div>
<div class="refsect1">
<a name="libg3d-model.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="G3D-MODEL-CENTER:CAPS"></a><h3>G3D_MODEL_CENTER</h3>
<pre class="programlisting">#define G3D_MODEL_CENTER (1 << 1)
</pre>
<p>The model should be centered around the (0,0,0).</p>
</div>
<hr>
<div class="refsect2">
<a name="G3D-MODEL-NOCHECK:CAPS"></a><h3>G3D_MODEL_NOCHECK</h3>
<pre class="programlisting">#define G3D_MODEL_NOCHECK (1 << 3)
</pre>
<p>The common checks should be disabled. The checks include:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">faces have at least 3 indices</li>
<li class="listitem">face indices are <= number of vertices</li>
<li class="listitem">material of faces is not NULL</li>
</ul></div>
</div>
<hr>
<div class="refsect2">
<a name="G3D-MODEL-OPTIMIZE:CAPS"></a><h3>G3D_MODEL_OPTIMIZE</h3>
<pre class="programlisting">#define G3D_MODEL_OPTIMIZE (1 << 2)
</pre>
<p>The model material/object/face lists should be serialized to some private
arrays (deprecated).</p>
</div>
<hr>
<div class="refsect2">
<a name="G3D-MODEL-SCALE:CAPS"></a><h3>G3D_MODEL_SCALE</h3>
<pre class="programlisting">#define G3D_MODEL_SCALE (1 << 0)
</pre>
<p>The model should be scaled to a maximum extension of +/- 10.0.</p>
</div>
<hr>
<div class="refsect2">
<a name="g3d-model-new"></a><h3>g3d_model_new ()</h3>
<pre class="programlisting"><a class="link" href="libg3d-model.html#G3DModel" title="G3DModel"><span class="returnvalue">G3DModel</span></a> *
g3d_model_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>This functions allocates and initializes a new G3DModel.</p>
<div class="refsect3">
<a name="id-1.2.4.7.6.5"></a><h4>Returns</h4>
<p> a newly allocated G3DModel</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-model-load"></a><h3>g3d_model_load ()</h3>
<pre class="programlisting"><a class="link" href="libg3d-model.html#G3DModel" title="G3DModel"><span class="returnvalue">G3DModel</span></a> *
g3d_model_load (<em class="parameter"><code><a class="link" href="libg3d-context.html#G3DContext" title="G3DContext"><span class="type">G3DContext</span></a> *context</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
<p>Loads a model from a file. The model is checked, centered, resized,
optimized.</p>
<div class="refsect3">
<a name="id-1.2.4.7.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>a valid context</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>the file name of the model to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.4.7.7.6"></a><h4>Returns</h4>
<p> the loaded model or NULL in case of an error</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-model-load-full"></a><h3>g3d_model_load_full ()</h3>
<pre class="programlisting"><a class="link" href="libg3d-model.html#G3DModel" title="G3DModel"><span class="returnvalue">G3DModel</span></a> *
g3d_model_load_full (<em class="parameter"><code><a class="link" href="libg3d-context.html#G3DContext" title="G3DContext"><span class="type">G3DContext</span></a> *context</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
<em class="parameter"><code><span class="type">guint32</span> flags</code></em>);</pre>
<p>Loads a model from a file. Depending on <em class="parameter"><code>flags</code></em>
the model is checked,
centered, resized, optimized.</p>
<div class="refsect3">
<a name="id-1.2.4.7.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>a valid context</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>the file name of the model to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>object manipulation flags</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.4.7.8.6"></a><h4>Returns</h4>
<p> the loaded model or NULL in case of an error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-model-check"></a><h3>g3d_model_check ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
g3d_model_check (<em class="parameter"><code><a class="link" href="libg3d-model.html#G3DModel" title="G3DModel"><span class="type">G3DModel</span></a> *model</code></em>);</pre>
<p>Checks whether a model returned by plugin is valid.</p>
<div class="refsect3">
<a name="id-1.2.4.7.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>model</p></td>
<td class="parameter_description"><p>the model to check</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.4.7.9.6"></a><h4>Returns</h4>
<p> TRUE on success, FALSE on error</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-model-center"></a><h3>g3d_model_center ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
g3d_model_center (<em class="parameter"><code><a class="link" href="libg3d-model.html#G3DModel" title="G3DModel"><span class="type">G3DModel</span></a> *model</code></em>);</pre>
<p>Translates all object coordinates that the object center is at (0, 0, 0)</p>
<div class="refsect3">
<a name="id-1.2.4.7.10.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>model</p></td>
<td class="parameter_description"><p>the model to center</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.4.7.10.6"></a><h4>Returns</h4>
<p> TRUE on success, FALSE on error</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-model-transform"></a><h3>g3d_model_transform ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
g3d_model_transform (<em class="parameter"><code><a class="link" href="libg3d-model.html#G3DModel" title="G3DModel"><span class="type">G3DModel</span></a> *model</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>Transform all toplevel objects in model with matrix.</p>
<div class="refsect3">
<a name="id-1.2.4.7.11.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>model</p></td>
<td class="parameter_description"><p>the model</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>matrix</p></td>
<td class="parameter_description"><p>transformation matrix</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.4.7.11.6"></a><h4>Returns</h4>
<p> TRUE on success, FALSE else</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-model-clear"></a><h3>g3d_model_clear ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g3d_model_clear (<em class="parameter"><code><a class="link" href="libg3d-model.html#G3DModel" title="G3DModel"><span class="type">G3DModel</span></a> *model</code></em>);</pre>
<p>Removes all objects from a model.</p>
<div class="refsect3">
<a name="id-1.2.4.7.12.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>model</p></td>
<td class="parameter_description"><p>the model to clear</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-model-free"></a><h3>g3d_model_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g3d_model_free (<em class="parameter"><code><a class="link" href="libg3d-model.html#G3DModel" title="G3DModel"><span class="type">G3DModel</span></a> *model</code></em>);</pre>
<p>Frees all memory allocated for the model including all objects, materials
and textures.</p>
<div class="refsect3">
<a name="id-1.2.4.7.13.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>model</p></td>
<td class="parameter_description"><p>the model to free</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-model-get-object-by-name"></a><h3>g3d_model_get_object_by_name ()</h3>
<pre class="programlisting"><a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="returnvalue">G3DObject</span></a> *
g3d_model_get_object_by_name (<em class="parameter"><code><a class="link" href="libg3d-model.html#G3DModel" title="G3DModel"><span class="type">G3DModel</span></a> *model</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Searches the object tree for an object with the given name.</p>
<div class="refsect3">
<a name="id-1.2.4.7.14.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>model</p></td>
<td class="parameter_description"><p>the model containing all objects</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>the name of the requested object</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.4.7.14.6"></a><h4>Returns</h4>
<p> the requested object or NULL if non was found</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libg3d-model.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="G3DModel"></a><h3>G3DModel</h3>
<pre class="programlisting">typedef struct {
gchar *filename;
GSList *materials;
GSList *objects;
} G3DModel;
</pre>
<p>A 3D model.</p>
<div class="refsect3">
<a name="id-1.2.4.8.2.5"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><span class="type">gchar</span> *<em class="structfield"><code><a name="G3DModel.filename"></a>filename</code></em>;</p></td>
<td class="struct_member_description"><p>file name or URI of loaded model, may be set by application</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">GSList</span> *<em class="structfield"><code><a name="G3DModel.materials"></a>materials</code></em>;</p></td>
<td class="struct_member_description"><p>list of materials (<a class="link" href="libg3d-material.html#G3DMaterial" title="G3DMaterial"><span class="type">G3DMaterial</span></a>)</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">GSList</span> *<em class="structfield"><code><a name="G3DModel.objects"></a>objects</code></em>;</p></td>
<td class="struct_member_description"><p>list of objects (<a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a>)</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|