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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libg3d-primitive">
<refmeta>
<refentrytitle role="top_of_page" id="libg3d-primitive.top_of_page">primitive</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBG3D Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>primitive</refname>
<refpurpose>3D primitive generation functions</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="libg3d-primitive.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <g3d/primitive.h>
<link linkend="G3DObject">G3DObject</link>* <link linkend="g3d-primitive-cube">g3d_primitive_cube</link> (<link linkend="G3DFloat">G3DFloat</link> width,
<link linkend="G3DFloat">G3DFloat</link> height,
<link linkend="G3DFloat">G3DFloat</link> depth,
<link linkend="G3DMaterial">G3DMaterial</link> *material);
<link linkend="G3DObject">G3DObject</link>* <link linkend="g3d-primitive-box">g3d_primitive_box</link> (<link linkend="G3DFloat">G3DFloat</link> width,
<link linkend="G3DFloat">G3DFloat</link> height,
<link linkend="G3DFloat">G3DFloat</link> depth,
<link linkend="G3DMaterial">G3DMaterial</link> *material);
<link linkend="G3DObject">G3DObject</link>* <link linkend="g3d-primitive-box-strip-2d">g3d_primitive_box_strip_2d</link> (<link linkend="guint32">guint32</link> vcnt,
<link linkend="gdouble">gdouble</link> *vdata,
<link linkend="gdouble">gdouble</link> height,
<link linkend="gdouble">gdouble</link> width,
<link linkend="G3DMaterial">G3DMaterial</link> *material);
<link linkend="G3DObject">G3DObject</link>* <link linkend="g3d-primitive-mesh">g3d_primitive_mesh</link> (<link linkend="guint32">guint32</link> m,
<link linkend="guint32">guint32</link> n,
<link linkend="gboolean">gboolean</link> wrap_m,
<link linkend="gboolean">gboolean</link> wrap_n,
<link linkend="G3DMaterial">G3DMaterial</link> *material);
<link linkend="G3DObject">G3DObject</link>* <link linkend="g3d-primitive-cylinder">g3d_primitive_cylinder</link> (<link linkend="G3DFloat">G3DFloat</link> radius,
<link linkend="G3DFloat">G3DFloat</link> height,
<link linkend="guint32">guint32</link> sides,
<link linkend="gboolean">gboolean</link> top,
<link linkend="gboolean">gboolean</link> bottom,
<link linkend="G3DMaterial">G3DMaterial</link> *material);
<link linkend="G3DObject">G3DObject</link>* <link linkend="g3d-primitive-tube">g3d_primitive_tube</link> (<link linkend="G3DFloat">G3DFloat</link> r_in,
<link linkend="G3DFloat">G3DFloat</link> r_out,
<link linkend="G3DFloat">G3DFloat</link> height,
<link linkend="guint32">guint32</link> sides,
<link linkend="gboolean">gboolean</link> top,
<link linkend="gboolean">gboolean</link> bottom,
<link linkend="G3DMaterial">G3DMaterial</link> *material);
<link linkend="G3DObject">G3DObject</link>* <link linkend="g3d-primitive-sphere">g3d_primitive_sphere</link> (<link linkend="G3DFloat">G3DFloat</link> radius,
<link linkend="guint32">guint32</link> vseg,
<link linkend="guint32">guint32</link> hseg,
<link linkend="G3DMaterial">G3DMaterial</link> *material);
</synopsis>
</refsynopsisdiv>
<refsect1 id="libg3d-primitive.description" role="desc">
<title role="desc.title">Description</title>
<para>
Primitives are objects containing basic 3D geometrical structures. A
variety of them can be created using these functions.</para>
<para>
</para>
</refsect1>
<refsect1 id="libg3d-primitive.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="g3d-primitive-cube" role="function">
<title>g3d_primitive_cube ()</title>
<indexterm zone="g3d-primitive-cube"><primary>g3d_primitive_cube</primary></indexterm><programlisting><link linkend="G3DObject">G3DObject</link>* g3d_primitive_cube (<link linkend="G3DFloat">G3DFloat</link> width,
<link linkend="G3DFloat">G3DFloat</link> height,
<link linkend="G3DFloat">G3DFloat</link> depth,
<link linkend="G3DMaterial">G3DMaterial</link> *material);</programlisting>
<para>
Generates an object containing a box. It is deprecated and now a wrapper for
<link linkend="g3d-primitive-box"><function>g3d_primitive_box()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>width</parameter> :</term>
<listitem><simpara> the width of the box
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter> :</term>
<listitem><simpara> the height of the box
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>depth</parameter> :</term>
<listitem><simpara> the depth of the box
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>material</parameter> :</term>
<listitem><simpara> the material to use for all faces
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the box object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g3d-primitive-box" role="function">
<title>g3d_primitive_box ()</title>
<indexterm zone="g3d-primitive-box"><primary>g3d_primitive_box</primary></indexterm><programlisting><link linkend="G3DObject">G3DObject</link>* g3d_primitive_box (<link linkend="G3DFloat">G3DFloat</link> width,
<link linkend="G3DFloat">G3DFloat</link> height,
<link linkend="G3DFloat">G3DFloat</link> depth,
<link linkend="G3DMaterial">G3DMaterial</link> *material);</programlisting>
<para>
Generates an object containing a box.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>width</parameter> :</term>
<listitem><simpara> the width of the box
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter> :</term>
<listitem><simpara> the height of the box
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>depth</parameter> :</term>
<listitem><simpara> the depth of the box
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>material</parameter> :</term>
<listitem><simpara> the material to use for all faces
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the box object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g3d-primitive-box-strip-2d" role="function">
<title>g3d_primitive_box_strip_2d ()</title>
<indexterm zone="g3d-primitive-box-strip-2d"><primary>g3d_primitive_box_strip_2d</primary></indexterm><programlisting><link linkend="G3DObject">G3DObject</link>* g3d_primitive_box_strip_2d (<link linkend="guint32">guint32</link> vcnt,
<link linkend="gdouble">gdouble</link> *vdata,
<link linkend="gdouble">gdouble</link> height,
<link linkend="gdouble">gdouble</link> width,
<link linkend="G3DMaterial">G3DMaterial</link> *material);</programlisting>
<para>
Generates a strip of box segments defined by corner center points
using two-dimensional data (x/z plane).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>vcnt</parameter> :</term>
<listitem><simpara> number of control points
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>vdata</parameter> :</term>
<listitem><simpara> 2-dimensional control point data (2 * vcnt * gdouble)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter> :</term>
<listitem><simpara> height of resulting strip (y component)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter> :</term>
<listitem><simpara> width of strip (corner diameter)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>material</parameter> :</term>
<listitem><simpara> material to use for faces
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> strip object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g3d-primitive-mesh" role="function">
<title>g3d_primitive_mesh ()</title>
<indexterm zone="g3d-primitive-mesh"><primary>g3d_primitive_mesh</primary></indexterm><programlisting><link linkend="G3DObject">G3DObject</link>* g3d_primitive_mesh (<link linkend="guint32">guint32</link> m,
<link linkend="guint32">guint32</link> n,
<link linkend="gboolean">gboolean</link> wrap_m,
<link linkend="gboolean">gboolean</link> wrap_n,
<link linkend="G3DMaterial">G3DMaterial</link> *material);</programlisting>
<para>
Generate a mesh consisting of m * n vertices. The vertex data is
initialized with (0.0, 0.0, 0.0) and has to be set to something
useful.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>m</parameter> :</term>
<listitem><simpara> number of vertices in m direction
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>n</parameter> :</term>
<listitem><simpara> number of vertices in n direction
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>wrap_m</parameter> :</term>
<listitem><simpara> wrap around in m direction
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>wrap_n</parameter> :</term>
<listitem><simpara> wrap around in n direction
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>material</parameter> :</term>
<listitem><simpara> material to use for faces
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> mesh object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g3d-primitive-cylinder" role="function">
<title>g3d_primitive_cylinder ()</title>
<indexterm zone="g3d-primitive-cylinder"><primary>g3d_primitive_cylinder</primary></indexterm><programlisting><link linkend="G3DObject">G3DObject</link>* g3d_primitive_cylinder (<link linkend="G3DFloat">G3DFloat</link> radius,
<link linkend="G3DFloat">G3DFloat</link> height,
<link linkend="guint32">guint32</link> sides,
<link linkend="gboolean">gboolean</link> top,
<link linkend="gboolean">gboolean</link> bottom,
<link linkend="G3DMaterial">G3DMaterial</link> *material);</programlisting>
<para>
Generates an object containing a cylinder.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>radius</parameter> :</term>
<listitem><simpara> the radius of the cylinder
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter> :</term>
<listitem><simpara> the height of the side faces
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>sides</parameter> :</term>
<listitem><simpara> number of side faces (number of circle segments)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>top</parameter> :</term>
<listitem><simpara> add top faces
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>bottom</parameter> :</term>
<listitem><simpara> add bottom faces
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>material</parameter> :</term>
<listitem><simpara> material to use for faces
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> cylinder object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g3d-primitive-tube" role="function">
<title>g3d_primitive_tube ()</title>
<indexterm zone="g3d-primitive-tube"><primary>g3d_primitive_tube</primary></indexterm><programlisting><link linkend="G3DObject">G3DObject</link>* g3d_primitive_tube (<link linkend="G3DFloat">G3DFloat</link> r_in,
<link linkend="G3DFloat">G3DFloat</link> r_out,
<link linkend="G3DFloat">G3DFloat</link> height,
<link linkend="guint32">guint32</link> sides,
<link linkend="gboolean">gboolean</link> top,
<link linkend="gboolean">gboolean</link> bottom,
<link linkend="G3DMaterial">G3DMaterial</link> *material);</programlisting>
<para>
Generates an object containing a tube (a cylinder with a hole).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>r_in</parameter> :</term>
<listitem><simpara> inner radius
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>r_out</parameter> :</term>
<listitem><simpara> outer radius
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter> :</term>
<listitem><simpara> the height of the side faces
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>sides</parameter> :</term>
<listitem><simpara> number of side faces (number of circle segments)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>top</parameter> :</term>
<listitem><simpara> add top faces
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>bottom</parameter> :</term>
<listitem><simpara> add bottom faces
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>material</parameter> :</term>
<listitem><simpara> material to use for faces
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> tube object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g3d-primitive-sphere" role="function">
<title>g3d_primitive_sphere ()</title>
<indexterm zone="g3d-primitive-sphere"><primary>g3d_primitive_sphere</primary></indexterm><programlisting><link linkend="G3DObject">G3DObject</link>* g3d_primitive_sphere (<link linkend="G3DFloat">G3DFloat</link> radius,
<link linkend="guint32">guint32</link> vseg,
<link linkend="guint32">guint32</link> hseg,
<link linkend="G3DMaterial">G3DMaterial</link> *material);</programlisting>
<para>
Generates an object containing a sphere.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>radius</parameter> :</term>
<listitem><simpara> radius
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>vseg</parameter> :</term>
<listitem><simpara> number of vertical segments
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>hseg</parameter> :</term>
<listitem><simpara> number of horizontal segments
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>material</parameter> :</term>
<listitem><simpara> material to use for faces
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> sphere object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
