This file is indexed.

/usr/share/gtk-doc/html/libg3d/libg3d-model.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
<!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</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-context.html" title="context">
<link rel="next" href="libg3d-object.html" title="object">
<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-context.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-object.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-model.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libg3d-model.description" class="shortcut">Description</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 valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libg3d-model.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;g3d/g3d.h&gt;

#define             <a class="link" href="libg3d-model.html#G3D-MODEL-CENTER:CAPS" title="G3D_MODEL_CENTER">G3D_MODEL_CENTER</a>
#define             <a class="link" href="libg3d-model.html#G3D-MODEL-NOCHECK:CAPS" title="G3D_MODEL_NOCHECK">G3D_MODEL_NOCHECK</a>
#define             <a class="link" href="libg3d-model.html#G3D-MODEL-OPTIMIZE:CAPS" title="G3D_MODEL_OPTIMIZE">G3D_MODEL_OPTIMIZE</a>
#define             <a class="link" href="libg3d-model.html#G3D-MODEL-SCALE:CAPS" title="G3D_MODEL_SCALE">G3D_MODEL_SCALE</a>
                    <a class="link" href="libg3d-model.html#G3DModel" title="G3DModel">G3DModel</a>;
<a class="link" href="libg3d-model.html#G3DModel" title="G3DModel"><span class="returnvalue">G3DModel</span></a> *          <a class="link" href="libg3d-model.html#g3d-model-new" title="g3d_model_new ()">g3d_model_new</a>                       (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="libg3d-model.html#G3DModel" title="G3DModel"><span class="returnvalue">G3DModel</span></a> *          <a class="link" href="libg3d-model.html#g3d-model-load" title="g3d_model_load ()">g3d_model_load</a>                      (<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>);
<a class="link" href="libg3d-model.html#G3DModel" title="G3DModel"><span class="returnvalue">G3DModel</span></a> *          <a class="link" href="libg3d-model.html#g3d-model-load-full" title="g3d_model_load_full ()">g3d_model_load_full</a>                 (<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>);
<span class="returnvalue">gboolean</span>            <a class="link" href="libg3d-model.html#g3d-model-check" title="g3d_model_check ()">g3d_model_check</a>                     (<em class="parameter"><code><a class="link" href="libg3d-model.html#G3DModel" title="G3DModel"><span class="type">G3DModel</span></a> *model</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="libg3d-model.html#g3d-model-center" title="g3d_model_center ()">g3d_model_center</a>                    (<em class="parameter"><code><a class="link" href="libg3d-model.html#G3DModel" title="G3DModel"><span class="type">G3DModel</span></a> *model</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="libg3d-model.html#g3d-model-transform" title="g3d_model_transform ()">g3d_model_transform</a>                 (<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>);
<span class="returnvalue">void</span>                <a class="link" href="libg3d-model.html#g3d-model-clear" title="g3d_model_clear ()">g3d_model_clear</a>                     (<em class="parameter"><code><a class="link" href="libg3d-model.html#G3DModel" title="G3DModel"><span class="type">G3DModel</span></a> *model</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libg3d-model.html#g3d-model-free" title="g3d_model_free ()">g3d_model_free</a>                      (<em class="parameter"><code><a class="link" href="libg3d-model.html#G3DModel" title="G3DModel"><span class="type">G3DModel</span></a> *model</code></em>);
<a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="returnvalue">G3DObject</span></a> *         <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>        (<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>
</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.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="G3D-MODEL-CENTER:CAPS"></a><h3>G3D_MODEL_CENTER</h3>
<pre class="programlisting">#define G3D_MODEL_CENTER          (1 &lt;&lt; 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 &lt;&lt; 3)
</pre>
<p>
The common checks should be disabled. The checks include:
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">faces have at least 3 indices</li>
<li class="listitem">face indices are &lt;= number of vertices</li>
<li class="listitem">material of faces is not NULL</li>
</ul></div>
<p>
</p>
</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 &lt;&lt; 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 &lt;&lt; 0)
</pre>
<p>
The model should be scaled to a maximum extension of +/- 10.0.
</p>
</div>
<hr>
<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="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="G3DModel.filename"></a>filename</code></em>;</span></p></td>
<td>file name or URI of loaded model, may be set by application</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">GSList</span> *<em class="structfield"><code><a name="G3DModel.materials"></a>materials</code></em>;</span></p></td>
<td>list of materials (<a class="link" href="libg3d-material.html#G3DMaterial" title="G3DMaterial"><span class="type">G3DMaterial</span></a>)</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">GSList</span> *<em class="structfield"><code><a name="G3DModel.objects"></a>objects</code></em>;</span></p></td>
<td>list of objects (<a class="link" href="libg3d-object.html#G3DObject" title="G3DObject"><span class="type">G3DObject</span></a>)</td>
</tr>
</tbody>
</table></div>
</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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly allocated G3DModel</td>
</tr></tbody>
</table></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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>a valid context</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>the file name of the model to load</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the loaded model or NULL in case of an error</td>
</tr>
</tbody>
</table></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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>a valid context</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>the file name of the model to load</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>object manipulation flags</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the loaded model or NULL in case of an error.</td>
</tr>
</tbody>
</table></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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
<td>the model to check</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success, FALSE on error</td>
</tr>
</tbody>
</table></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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
<td>the model to center</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success, FALSE on error</td>
</tr>
</tbody>
</table></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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
<td>the model</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>matrix</code></em> :</span></p></td>
<td>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-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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
<td>the model to clear</td>
</tr></tbody>
</table></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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
<td>the model to free</td>
</tr></tbody>
</table></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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
<td>the model containing all objects</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the name of the requested object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the requested object or NULL if non was found</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>