aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/mimesh/libg3d-0.0.8/doc/api/xml/primitive.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/others/mimesh/libg3d-0.0.8/doc/api/xml/primitive.xml')
-rw-r--r--src/others/mimesh/libg3d-0.0.8/doc/api/xml/primitive.xml302
1 files changed, 302 insertions, 0 deletions
diff --git a/src/others/mimesh/libg3d-0.0.8/doc/api/xml/primitive.xml b/src/others/mimesh/libg3d-0.0.8/doc/api/xml/primitive.xml
new file mode 100644
index 0000000..bb2f8c8
--- /dev/null
+++ b/src/others/mimesh/libg3d-0.0.8/doc/api/xml/primitive.xml
@@ -0,0 +1,302 @@
1<?xml version="1.0"?>
2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4<refentry id="libg3d-primitive">
5<refmeta>
6<refentrytitle role="top_of_page" id="libg3d-primitive.top_of_page">primitive</refentrytitle>
7<manvolnum>3</manvolnum>
8<refmiscinfo>LIBG3D Library</refmiscinfo>
9</refmeta>
10
11<refnamediv>
12<refname>primitive</refname>
13<refpurpose>3D primitive generation functions</refpurpose>
14<!--[<xref linkend="desc" endterm="desc.title"/>]-->
15</refnamediv>
16
17<refsynopsisdiv id="libg3d-primitive.synopsis" role="synopsis">
18<title role="synopsis.title">Synopsis</title>
19
20<synopsis>
21
22#include &lt;g3d/primitive.h&gt;
23
24<link linkend="G3DObject">G3DObject</link>* <link linkend="g3d-primitive-cube">g3d_primitive_cube</link> (<link linkend="G3DFloat">G3DFloat</link> width,
25 <link linkend="G3DFloat">G3DFloat</link> height,
26 <link linkend="G3DFloat">G3DFloat</link> depth,
27 <link linkend="G3DMaterial">G3DMaterial</link> *material);
28<link linkend="G3DObject">G3DObject</link>* <link linkend="g3d-primitive-box">g3d_primitive_box</link> (<link linkend="G3DFloat">G3DFloat</link> width,
29 <link linkend="G3DFloat">G3DFloat</link> height,
30 <link linkend="G3DFloat">G3DFloat</link> depth,
31 <link linkend="G3DMaterial">G3DMaterial</link> *material);
32<link linkend="G3DObject">G3DObject</link>* <link linkend="g3d-primitive-box-strip-2d">g3d_primitive_box_strip_2d</link> (<link linkend="guint32">guint32</link> vcnt,
33 <link linkend="gdouble">gdouble</link> *vdata,
34 <link linkend="gdouble">gdouble</link> height,
35 <link linkend="gdouble">gdouble</link> width,
36 <link linkend="G3DMaterial">G3DMaterial</link> *material);
37<link linkend="G3DObject">G3DObject</link>* <link linkend="g3d-primitive-mesh">g3d_primitive_mesh</link> (<link linkend="guint32">guint32</link> m,
38 <link linkend="guint32">guint32</link> n,
39 <link linkend="gboolean">gboolean</link> wrap_m,
40 <link linkend="gboolean">gboolean</link> wrap_n,
41 <link linkend="G3DMaterial">G3DMaterial</link> *material);
42<link linkend="G3DObject">G3DObject</link>* <link linkend="g3d-primitive-cylinder">g3d_primitive_cylinder</link> (<link linkend="G3DFloat">G3DFloat</link> radius,
43 <link linkend="G3DFloat">G3DFloat</link> height,
44 <link linkend="guint32">guint32</link> sides,
45 <link linkend="gboolean">gboolean</link> top,
46 <link linkend="gboolean">gboolean</link> bottom,
47 <link linkend="G3DMaterial">G3DMaterial</link> *material);
48<link linkend="G3DObject">G3DObject</link>* <link linkend="g3d-primitive-tube">g3d_primitive_tube</link> (<link linkend="G3DFloat">G3DFloat</link> r_in,
49 <link linkend="G3DFloat">G3DFloat</link> r_out,
50 <link linkend="G3DFloat">G3DFloat</link> height,
51 <link linkend="guint32">guint32</link> sides,
52 <link linkend="gboolean">gboolean</link> top,
53 <link linkend="gboolean">gboolean</link> bottom,
54 <link linkend="G3DMaterial">G3DMaterial</link> *material);
55<link linkend="G3DObject">G3DObject</link>* <link linkend="g3d-primitive-sphere">g3d_primitive_sphere</link> (<link linkend="G3DFloat">G3DFloat</link> radius,
56 <link linkend="guint32">guint32</link> vseg,
57 <link linkend="guint32">guint32</link> hseg,
58 <link linkend="G3DMaterial">G3DMaterial</link> *material);
59</synopsis>
60</refsynopsisdiv>
61
62
63
64
65
66
67
68
69
70<refsect1 id="libg3d-primitive.description" role="desc">
71<title role="desc.title">Description</title>
72<para>
73Primitives are objects containing basic 3D geometrical structures. A
74variety of them can be created using these functions.</para>
75<para>
76
77</para>
78</refsect1>
79
80<refsect1 id="libg3d-primitive.details" role="details">
81<title role="details.title">Details</title>
82<refsect2 id="g3d-primitive-cube" role="function">
83<title>g3d_primitive_cube ()</title>
84<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,
85 <link linkend="G3DFloat">G3DFloat</link> height,
86 <link linkend="G3DFloat">G3DFloat</link> depth,
87 <link linkend="G3DMaterial">G3DMaterial</link> *material);</programlisting>
88<para>
89Generates an object containing a box. It is deprecated and now a wrapper for
90<link linkend="g3d-primitive-box"><function>g3d_primitive_box()</function></link>.</para>
91<para>
92
93</para><variablelist role="params">
94<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
95<listitem><simpara> the width of the box
96</simpara></listitem></varlistentry>
97<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
98<listitem><simpara> the height of the box
99</simpara></listitem></varlistentry>
100<varlistentry><term><parameter>depth</parameter>&nbsp;:</term>
101<listitem><simpara> the depth of the box
102</simpara></listitem></varlistentry>
103<varlistentry><term><parameter>material</parameter>&nbsp;:</term>
104<listitem><simpara> the material to use for all faces
105</simpara></listitem></varlistentry>
106<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the box object
107</simpara></listitem></varlistentry>
108</variablelist></refsect2>
109<refsect2 id="g3d-primitive-box" role="function">
110<title>g3d_primitive_box ()</title>
111<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,
112 <link linkend="G3DFloat">G3DFloat</link> height,
113 <link linkend="G3DFloat">G3DFloat</link> depth,
114 <link linkend="G3DMaterial">G3DMaterial</link> *material);</programlisting>
115<para>
116Generates an object containing a box.</para>
117<para>
118
119</para><variablelist role="params">
120<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
121<listitem><simpara> the width of the box
122</simpara></listitem></varlistentry>
123<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
124<listitem><simpara> the height of the box
125</simpara></listitem></varlistentry>
126<varlistentry><term><parameter>depth</parameter>&nbsp;:</term>
127<listitem><simpara> the depth of the box
128</simpara></listitem></varlistentry>
129<varlistentry><term><parameter>material</parameter>&nbsp;:</term>
130<listitem><simpara> the material to use for all faces
131</simpara></listitem></varlistentry>
132<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the box object
133</simpara></listitem></varlistentry>
134</variablelist></refsect2>
135<refsect2 id="g3d-primitive-box-strip-2d" role="function">
136<title>g3d_primitive_box_strip_2d ()</title>
137<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,
138 <link linkend="gdouble">gdouble</link> *vdata,
139 <link linkend="gdouble">gdouble</link> height,
140 <link linkend="gdouble">gdouble</link> width,
141 <link linkend="G3DMaterial">G3DMaterial</link> *material);</programlisting>
142<para>
143Generates a strip of box segments defined by corner center points
144using two-dimensional data (x/z plane).</para>
145<para>
146
147</para><variablelist role="params">
148<varlistentry><term><parameter>vcnt</parameter>&nbsp;:</term>
149<listitem><simpara> number of control points
150</simpara></listitem></varlistentry>
151<varlistentry><term><parameter>vdata</parameter>&nbsp;:</term>
152<listitem><simpara> 2-dimensional control point data (2 * vcnt * gdouble)
153</simpara></listitem></varlistentry>
154<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
155<listitem><simpara> height of resulting strip (y component)
156</simpara></listitem></varlistentry>
157<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
158<listitem><simpara> width of strip (corner diameter)
159</simpara></listitem></varlistentry>
160<varlistentry><term><parameter>material</parameter>&nbsp;:</term>
161<listitem><simpara> material to use for faces
162</simpara></listitem></varlistentry>
163<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> strip object
164</simpara></listitem></varlistentry>
165</variablelist></refsect2>
166<refsect2 id="g3d-primitive-mesh" role="function">
167<title>g3d_primitive_mesh ()</title>
168<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,
169 <link linkend="guint32">guint32</link> n,
170 <link linkend="gboolean">gboolean</link> wrap_m,
171 <link linkend="gboolean">gboolean</link> wrap_n,
172 <link linkend="G3DMaterial">G3DMaterial</link> *material);</programlisting>
173<para>
174Generate a mesh consisting of m * n vertices. The vertex data is
175initialized with (0.0, 0.0, 0.0) and has to be set to something
176useful.</para>
177<para>
178
179</para><variablelist role="params">
180<varlistentry><term><parameter>m</parameter>&nbsp;:</term>
181<listitem><simpara> number of vertices in m direction
182</simpara></listitem></varlistentry>
183<varlistentry><term><parameter>n</parameter>&nbsp;:</term>
184<listitem><simpara> number of vertices in n direction
185</simpara></listitem></varlistentry>
186<varlistentry><term><parameter>wrap_m</parameter>&nbsp;:</term>
187<listitem><simpara> wrap around in m direction
188</simpara></listitem></varlistentry>
189<varlistentry><term><parameter>wrap_n</parameter>&nbsp;:</term>
190<listitem><simpara> wrap around in n direction
191</simpara></listitem></varlistentry>
192<varlistentry><term><parameter>material</parameter>&nbsp;:</term>
193<listitem><simpara> material to use for faces
194</simpara></listitem></varlistentry>
195<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> mesh object
196</simpara></listitem></varlistentry>
197</variablelist></refsect2>
198<refsect2 id="g3d-primitive-cylinder" role="function">
199<title>g3d_primitive_cylinder ()</title>
200<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,
201 <link linkend="G3DFloat">G3DFloat</link> height,
202 <link linkend="guint32">guint32</link> sides,
203 <link linkend="gboolean">gboolean</link> top,
204 <link linkend="gboolean">gboolean</link> bottom,
205 <link linkend="G3DMaterial">G3DMaterial</link> *material);</programlisting>
206<para>
207Generates an object containing a cylinder.</para>
208<para>
209
210</para><variablelist role="params">
211<varlistentry><term><parameter>radius</parameter>&nbsp;:</term>
212<listitem><simpara> the radius of the cylinder
213</simpara></listitem></varlistentry>
214<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
215<listitem><simpara> the height of the side faces
216</simpara></listitem></varlistentry>
217<varlistentry><term><parameter>sides</parameter>&nbsp;:</term>
218<listitem><simpara> number of side faces (number of circle segments)
219</simpara></listitem></varlistentry>
220<varlistentry><term><parameter>top</parameter>&nbsp;:</term>
221<listitem><simpara> add top faces
222</simpara></listitem></varlistentry>
223<varlistentry><term><parameter>bottom</parameter>&nbsp;:</term>
224<listitem><simpara> add bottom faces
225</simpara></listitem></varlistentry>
226<varlistentry><term><parameter>material</parameter>&nbsp;:</term>
227<listitem><simpara> material to use for faces
228</simpara></listitem></varlistentry>
229<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> cylinder object
230</simpara></listitem></varlistentry>
231</variablelist></refsect2>
232<refsect2 id="g3d-primitive-tube" role="function">
233<title>g3d_primitive_tube ()</title>
234<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,
235 <link linkend="G3DFloat">G3DFloat</link> r_out,
236 <link linkend="G3DFloat">G3DFloat</link> height,
237 <link linkend="guint32">guint32</link> sides,
238 <link linkend="gboolean">gboolean</link> top,
239 <link linkend="gboolean">gboolean</link> bottom,
240 <link linkend="G3DMaterial">G3DMaterial</link> *material);</programlisting>
241<para>
242Generates an object containing a tube (a cylinder with a hole).</para>
243<para>
244
245</para><variablelist role="params">
246<varlistentry><term><parameter>r_in</parameter>&nbsp;:</term>
247<listitem><simpara> inner radius
248</simpara></listitem></varlistentry>
249<varlistentry><term><parameter>r_out</parameter>&nbsp;:</term>
250<listitem><simpara> outer radius
251</simpara></listitem></varlistentry>
252<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
253<listitem><simpara> the height of the side faces
254</simpara></listitem></varlistentry>
255<varlistentry><term><parameter>sides</parameter>&nbsp;:</term>
256<listitem><simpara> number of side faces (number of circle segments)
257</simpara></listitem></varlistentry>
258<varlistentry><term><parameter>top</parameter>&nbsp;:</term>
259<listitem><simpara> add top faces
260</simpara></listitem></varlistentry>
261<varlistentry><term><parameter>bottom</parameter>&nbsp;:</term>
262<listitem><simpara> add bottom faces
263</simpara></listitem></varlistentry>
264<varlistentry><term><parameter>material</parameter>&nbsp;:</term>
265<listitem><simpara> material to use for faces
266</simpara></listitem></varlistentry>
267<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> tube object
268</simpara></listitem></varlistentry>
269</variablelist></refsect2>
270<refsect2 id="g3d-primitive-sphere" role="function">
271<title>g3d_primitive_sphere ()</title>
272<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,
273 <link linkend="guint32">guint32</link> vseg,
274 <link linkend="guint32">guint32</link> hseg,
275 <link linkend="G3DMaterial">G3DMaterial</link> *material);</programlisting>
276<para>
277Generates an object containing a sphere.</para>
278<para>
279
280</para><variablelist role="params">
281<varlistentry><term><parameter>radius</parameter>&nbsp;:</term>
282<listitem><simpara> radius
283</simpara></listitem></varlistentry>
284<varlistentry><term><parameter>vseg</parameter>&nbsp;:</term>
285<listitem><simpara> number of vertical segments
286</simpara></listitem></varlistentry>
287<varlistentry><term><parameter>hseg</parameter>&nbsp;:</term>
288<listitem><simpara> number of horizontal segments
289</simpara></listitem></varlistentry>
290<varlistentry><term><parameter>material</parameter>&nbsp;:</term>
291<listitem><simpara> material to use for faces
292</simpara></listitem></varlistentry>
293<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> sphere object
294</simpara></listitem></varlistentry>
295</variablelist></refsect2>
296
297</refsect1>
298
299
300
301
302</refentry>
generated by cgit v1.1 at 2024-05-22 02:49:51 +0000