aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/libraries/ode-0.9/docs/group__drawstuff.html
diff options
context:
space:
mode:
Diffstat (limited to 'libraries/ode-0.9/docs/group__drawstuff.html')
-rw-r--r--libraries/ode-0.9/docs/group__drawstuff.html668
1 files changed, 668 insertions, 0 deletions
diff --git a/libraries/ode-0.9/docs/group__drawstuff.html b/libraries/ode-0.9/docs/group__drawstuff.html
new file mode 100644
index 0000000..6cf8650
--- /dev/null
+++ b/libraries/ode-0.9/docs/group__drawstuff.html
@@ -0,0 +1,668 @@
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>Open Dynamics Engine: DrawStuff</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.3 -->
8<div class="tabs">
9 <ul>
10 <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11 <li><a href="modules.html"><span>Modules</span></a></li>
12 <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
13 <li><a href="files.html"><span>Files</span></a></li>
14 </ul>
15</div>
16<h1>DrawStuff</h1><table border="0" cellpadding="0" cellspacing="0">
17<tr><td></td></tr>
18<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
19<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structds_functions.html">dsFunctions</a></td></tr>
20
21<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set of functions to be used as callbacks by the simulation loop. <a href="structds_functions.html#_details">More...</a><br></td></tr>
22<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
23<tr><td class="memItemLeft" nowrap align="right" valign="top">DS_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__drawstuff.html#g28560ea1b64c1d83095bcdfce9caf9dc">dsSimulationLoop</a> (int argc, char **argv, int window_width, int window_height, struct <a class="el" href="structds_functions.html">dsFunctions</a> *fn)</td></tr>
24
25<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Does the complete simulation. <a href="#g28560ea1b64c1d83095bcdfce9caf9dc"></a><br></td></tr>
26<tr><td class="memItemLeft" nowrap align="right" valign="top">DS_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__drawstuff.html#g7a2a69ac611d5dc6ffc8e43b0a743472">dsError</a> (char *msg,...)</td></tr>
27
28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">exit with error message. <a href="#g7a2a69ac611d5dc6ffc8e43b0a743472"></a><br></td></tr>
29<tr><td class="memItemLeft" nowrap align="right" valign="top">DS_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__drawstuff.html#ga84175b14c3c31daae08a9c88acc2b02">dsDebug</a> (char *msg,...)</td></tr>
30
31<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">exit with error message and core dump. <a href="#ga84175b14c3c31daae08a9c88acc2b02"></a><br></td></tr>
32<tr><td class="memItemLeft" nowrap align="right" valign="top">DS_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__drawstuff.html#gbca5fa4076aa9e45caa049f33e8cf168">dsPrint</a> (char *msg,...)</td></tr>
33
34<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">print log message <a href="#gbca5fa4076aa9e45caa049f33e8cf168"></a><br></td></tr>
35<tr><td class="memItemLeft" nowrap align="right" valign="top">DS_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__drawstuff.html#g8e4ea933c31d207ec57949fbb3a75815">dsSetViewpoint</a> (float xyz[3], float hpr[3])</td></tr>
36
37<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the viewpoint. <a href="#g8e4ea933c31d207ec57949fbb3a75815"></a><br></td></tr>
38<tr><td class="memItemLeft" nowrap align="right" valign="top">DS_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__drawstuff.html#gaa22f45ad00e0010a1440985ac51b18b">dsGetViewpoint</a> (float xyz[3], float hpr[3])</td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the viewpoint. <a href="#gaa22f45ad00e0010a1440985ac51b18b"></a><br></td></tr>
41<tr><td class="memItemLeft" nowrap align="right" valign="top">DS_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__drawstuff.html#g6c13a5a310b9e00c45150058e669ebad">dsStop</a> ()</td></tr>
42
43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stop the simulation loop. <a href="#g6c13a5a310b9e00c45150058e669ebad"></a><br></td></tr>
44<tr><td class="memItemLeft" nowrap align="right" valign="top">DS_API double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__drawstuff.html#g02f3f096703d49f5a9e497aec0b85f75">dsElapsedTime</a> ()</td></tr>
45
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the elapsed time (on wall-clock). <a href="#g02f3f096703d49f5a9e497aec0b85f75"></a><br></td></tr>
47<tr><td class="memItemLeft" nowrap align="right" valign="top">DS_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__drawstuff.html#g8a3d6f8fecc8c7d5a206bed35f17ba7a">dsSetTexture</a> (int texture_number)</td></tr>
48
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Toggle the rendering of textures. <a href="#g8a3d6f8fecc8c7d5a206bed35f17ba7a"></a><br></td></tr>
50<tr><td class="memItemLeft" nowrap align="right" valign="top">DS_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__drawstuff.html#g3221a0d1360621eaad7c54597671c092">dsSetColor</a> (float red, float green, float blue)</td></tr>
51
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the color with which geometry is drawn. <a href="#g3221a0d1360621eaad7c54597671c092"></a><br></td></tr>
53<tr><td class="memItemLeft" nowrap align="right" valign="top">DS_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__drawstuff.html#g440940cfaef61775e37c33b055b832af">dsSetColorAlpha</a> (float red, float green, float blue, float alpha)</td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the color and transparency with which geometry is drawn. <a href="#g440940cfaef61775e37c33b055b832af"></a><br></td></tr>
56<tr><td class="memItemLeft" nowrap align="right" valign="top">DS_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__drawstuff.html#gfba4fde6b0b74f6cd422036dedd08836">dsDrawBox</a> (const float pos[3], const float R[12], const float sides[3])</td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Draw a box. <a href="#gfba4fde6b0b74f6cd422036dedd08836"></a><br></td></tr>
59<tr><td class="memItemLeft" nowrap align="right" valign="top">DS_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__drawstuff.html#g0802e7641f8028182b69fabc729a6704">dsDrawSphere</a> (const float pos[3], const float R[12], float radius)</td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Draw a sphere. <a href="#g0802e7641f8028182b69fabc729a6704"></a><br></td></tr>
62<tr><td class="memItemLeft" nowrap align="right" valign="top">DS_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__drawstuff.html#gcfcbae15cee67eceb45cd96bf01484d4">dsDrawTriangle</a> (const float pos[3], const float R[12], const float *v0, const float *v1, const float *v2, int solid)</td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Draw a triangle. <a href="#gcfcbae15cee67eceb45cd96bf01484d4"></a><br></td></tr>
65<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g0b09b41f1f6500b293678aa1691f1537"></a><!-- doxytag: member="drawstuff::dsDrawCylinder" ref="g0b09b41f1f6500b293678aa1691f1537" args="(const float pos[3], const float R[12], float length, float radius)" -->
66DS_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__drawstuff.html#g0b09b41f1f6500b293678aa1691f1537">dsDrawCylinder</a> (const float pos[3], const float R[12], float length, float radius)</td></tr>
67
68<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Draw a z-aligned cylinder. <br></td></tr>
69<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gce8f6c8a9f2871dac2f5e7f159b96feb"></a><!-- doxytag: member="drawstuff::dsDrawCapsule" ref="gce8f6c8a9f2871dac2f5e7f159b96feb" args="(const float pos[3], const float R[12], float length, float radius)" -->
70DS_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__drawstuff.html#gce8f6c8a9f2871dac2f5e7f159b96feb">dsDrawCapsule</a> (const float pos[3], const float R[12], float length, float radius)</td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Draw a z-aligned capsule. <br></td></tr>
73<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g61b166a9b7c04063a27be982051f4af5"></a><!-- doxytag: member="drawstuff::dsDrawLine" ref="g61b166a9b7c04063a27be982051f4af5" args="(const float pos1[3], const float pos2[3])" -->
74DS_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__drawstuff.html#g61b166a9b7c04063a27be982051f4af5">dsDrawLine</a> (const float pos1[3], const float pos2[3])</td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Draw a line. <br></td></tr>
77<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g4b8754994a4cca9d51fce16445f0d612"></a><!-- doxytag: member="drawstuff::dsDrawConvex" ref="g4b8754994a4cca9d51fce16445f0d612" args="(const float pos[3], const float R[12], float *_planes, unsigned int _planecount, float *_points, unsigned int _pointcount, unsigned int *_polygons)" -->
78DS_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__drawstuff.html#g4b8754994a4cca9d51fce16445f0d612">dsDrawConvex</a> (const float pos[3], const float R[12], float *_planes, unsigned int _planecount, float *_points, unsigned int _pointcount, unsigned int *_polygons)</td></tr>
79
80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Draw a convex shape. <br></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top">DS_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__drawstuff.html#g211aa83d5c5d102cdda303cc7aeb2fd5">dsSetSphereQuality</a> (int n)</td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the quality with which curved objects are rendered. <a href="#g211aa83d5c5d102cdda303cc7aeb2fd5"></a><br></td></tr>
84</table>
85<hr><a name="_details"></a><h2>Detailed Description</h2>
86DrawStuff is a library for rendering simple 3D objects in a virtual environment, for the purposes of demonstrating the features of ODE. It is provided for demonstration purposes and is not intended for production use.<h2><a class="anchor" name="Notes">
87Notes</a></h2>
88In the virtual world, the z axis is "up" and z=0 is the floor.<p>
89The user is able to click+drag in the main window to move the camera: left button - pan and tilt. right button - forward and sideways. left + right button (or middle button) - sideways and up. <hr><h2>Function Documentation</h2>
90<a class="anchor" name="ga84175b14c3c31daae08a9c88acc2b02"></a><!-- doxytag: member="drawstuff.h::dsDebug" ref="ga84175b14c3c31daae08a9c88acc2b02" args="(char *msg,...)" -->
91<div class="memitem">
92<div class="memproto">
93 <table class="memname">
94 <tr>
95 <td class="memname">DS_API void dsDebug </td>
96 <td>(</td>
97 <td class="paramtype">char *&nbsp;</td>
98 <td class="paramname"> <em>msg</em>, </td>
99 </tr>
100 <tr>
101 <td class="paramkey"></td>
102 <td></td>
103 <td class="paramtype">&nbsp;</td>
104 <td class="paramname"> <em>...</em></td><td>&nbsp;</td>
105 </tr>
106 <tr>
107 <td></td>
108 <td>)</td>
109 <td></td><td></td><td width="100%"></td>
110 </tr>
111 </table>
112</div>
113<div class="memdoc">
114
115<p>
116exit with error message and core dump.
117<p>
118this functions tries to dump core or start the debugger. <dl compact><dt><b>Parameters:</b></dt><dd>
119 <table border="0" cellspacing="2" cellpadding="0">
120 <tr><td valign="top"></td><td valign="top"><em>msg</em>&nbsp;</td><td>format strin, like printf, without the newline character. </td></tr>
121 </table>
122</dl>
123
124</div>
125</div><p>
126<a class="anchor" name="gfba4fde6b0b74f6cd422036dedd08836"></a><!-- doxytag: member="drawstuff.h::dsDrawBox" ref="gfba4fde6b0b74f6cd422036dedd08836" args="(const float pos[3], const float R[12], const float sides[3])" -->
127<div class="memitem">
128<div class="memproto">
129 <table class="memname">
130 <tr>
131 <td class="memname">DS_API void dsDrawBox </td>
132 <td>(</td>
133 <td class="paramtype">const float&nbsp;</td>
134 <td class="paramname"> <em>pos</em>[3], </td>
135 </tr>
136 <tr>
137 <td class="paramkey"></td>
138 <td></td>
139 <td class="paramtype">const float&nbsp;</td>
140 <td class="paramname"> <em>R</em>[12], </td>
141 </tr>
142 <tr>
143 <td class="paramkey"></td>
144 <td></td>
145 <td class="paramtype">const float&nbsp;</td>
146 <td class="paramname"> <em>sides</em>[3]</td><td>&nbsp;</td>
147 </tr>
148 <tr>
149 <td></td>
150 <td>)</td>
151 <td></td><td></td><td width="100%"></td>
152 </tr>
153 </table>
154</div>
155<div class="memdoc">
156
157<p>
158Draw a box.
159<p>
160<dl compact><dt><b>Parameters:</b></dt><dd>
161 <table border="0" cellspacing="2" cellpadding="0">
162 <tr><td valign="top"></td><td valign="top"><em>pos</em>&nbsp;</td><td>is the x,y,z of the center of the object. </td></tr>
163 <tr><td valign="top"></td><td valign="top"><em>R</em>&nbsp;</td><td>is a 3x3 rotation matrix for the object, stored by row like this: [ R11 R12 R13 0 ] [ R21 R22 R23 0 ] [ R31 R32 R33 0 ] </td></tr>
164 <tr><td valign="top"></td><td valign="top"><em>sides[]</em>&nbsp;</td><td>is an array of x,y,z side lengths. </td></tr>
165 </table>
166</dl>
167
168</div>
169</div><p>
170<a class="anchor" name="g0802e7641f8028182b69fabc729a6704"></a><!-- doxytag: member="drawstuff.h::dsDrawSphere" ref="g0802e7641f8028182b69fabc729a6704" args="(const float pos[3], const float R[12], float radius)" -->
171<div class="memitem">
172<div class="memproto">
173 <table class="memname">
174 <tr>
175 <td class="memname">DS_API void dsDrawSphere </td>
176 <td>(</td>
177 <td class="paramtype">const float&nbsp;</td>
178 <td class="paramname"> <em>pos</em>[3], </td>
179 </tr>
180 <tr>
181 <td class="paramkey"></td>
182 <td></td>
183 <td class="paramtype">const float&nbsp;</td>
184 <td class="paramname"> <em>R</em>[12], </td>
185 </tr>
186 <tr>
187 <td class="paramkey"></td>
188 <td></td>
189 <td class="paramtype">float&nbsp;</td>
190 <td class="paramname"> <em>radius</em></td><td>&nbsp;</td>
191 </tr>
192 <tr>
193 <td></td>
194 <td>)</td>
195 <td></td><td></td><td width="100%"></td>
196 </tr>
197 </table>
198</div>
199<div class="memdoc">
200
201<p>
202Draw a sphere.
203<p>
204<dl compact><dt><b>Parameters:</b></dt><dd>
205 <table border="0" cellspacing="2" cellpadding="0">
206 <tr><td valign="top"></td><td valign="top"><em>pos</em>&nbsp;</td><td>Position of center. </td></tr>
207 <tr><td valign="top"></td><td valign="top"><em>R</em>&nbsp;</td><td>orientation. </td></tr>
208 <tr><td valign="top"></td><td valign="top"><em>radius</em>&nbsp;</td><td></td></tr>
209 </table>
210</dl>
211
212</div>
213</div><p>
214<a class="anchor" name="gcfcbae15cee67eceb45cd96bf01484d4"></a><!-- doxytag: member="drawstuff.h::dsDrawTriangle" ref="gcfcbae15cee67eceb45cd96bf01484d4" args="(const float pos[3], const float R[12], const float *v0, const float *v1, const float *v2, int solid)" -->
215<div class="memitem">
216<div class="memproto">
217 <table class="memname">
218 <tr>
219 <td class="memname">DS_API void dsDrawTriangle </td>
220 <td>(</td>
221 <td class="paramtype">const float&nbsp;</td>
222 <td class="paramname"> <em>pos</em>[3], </td>
223 </tr>
224 <tr>
225 <td class="paramkey"></td>
226 <td></td>
227 <td class="paramtype">const float&nbsp;</td>
228 <td class="paramname"> <em>R</em>[12], </td>
229 </tr>
230 <tr>
231 <td class="paramkey"></td>
232 <td></td>
233 <td class="paramtype">const float *&nbsp;</td>
234 <td class="paramname"> <em>v0</em>, </td>
235 </tr>
236 <tr>
237 <td class="paramkey"></td>
238 <td></td>
239 <td class="paramtype">const float *&nbsp;</td>
240 <td class="paramname"> <em>v1</em>, </td>
241 </tr>
242 <tr>
243 <td class="paramkey"></td>
244 <td></td>
245 <td class="paramtype">const float *&nbsp;</td>
246 <td class="paramname"> <em>v2</em>, </td>
247 </tr>
248 <tr>
249 <td class="paramkey"></td>
250 <td></td>
251 <td class="paramtype">int&nbsp;</td>
252 <td class="paramname"> <em>solid</em></td><td>&nbsp;</td>
253 </tr>
254 <tr>
255 <td></td>
256 <td>)</td>
257 <td></td><td></td><td width="100%"></td>
258 </tr>
259 </table>
260</div>
261<div class="memdoc">
262
263<p>
264Draw a triangle.
265<p>
266<dl compact><dt><b>Parameters:</b></dt><dd>
267 <table border="0" cellspacing="2" cellpadding="0">
268 <tr><td valign="top"></td><td valign="top"><em>pos</em>&nbsp;</td><td>Position of center </td></tr>
269 <tr><td valign="top"></td><td valign="top"><em>R</em>&nbsp;</td><td>orientation </td></tr>
270 <tr><td valign="top"></td><td valign="top"><em>v0</em>&nbsp;</td><td>first vertex </td></tr>
271 <tr><td valign="top"></td><td valign="top"><em>v1</em>&nbsp;</td><td>second </td></tr>
272 <tr><td valign="top"></td><td valign="top"><em>v2</em>&nbsp;</td><td>third vertex </td></tr>
273 <tr><td valign="top"></td><td valign="top"><em>solid</em>&nbsp;</td><td>set to 0 for wireframe </td></tr>
274 </table>
275</dl>
276
277</div>
278</div><p>
279<a class="anchor" name="g02f3f096703d49f5a9e497aec0b85f75"></a><!-- doxytag: member="drawstuff.h::dsElapsedTime" ref="g02f3f096703d49f5a9e497aec0b85f75" args="()" -->
280<div class="memitem">
281<div class="memproto">
282 <table class="memname">
283 <tr>
284 <td class="memname">DS_API double dsElapsedTime </td>
285 <td>(</td>
286 <td class="paramname"> </td>
287 <td>&nbsp;)&nbsp;</td>
288 <td width="100%"></td>
289 </tr>
290 </table>
291</div>
292<div class="memdoc">
293
294<p>
295Get the elapsed time (on wall-clock).
296<p>
297It returns the nr of seconds since the last call to this function.
298</div>
299</div><p>
300<a class="anchor" name="g7a2a69ac611d5dc6ffc8e43b0a743472"></a><!-- doxytag: member="drawstuff.h::dsError" ref="g7a2a69ac611d5dc6ffc8e43b0a743472" args="(char *msg,...)" -->
301<div class="memitem">
302<div class="memproto">
303 <table class="memname">
304 <tr>
305 <td class="memname">DS_API void dsError </td>
306 <td>(</td>
307 <td class="paramtype">char *&nbsp;</td>
308 <td class="paramname"> <em>msg</em>, </td>
309 </tr>
310 <tr>
311 <td class="paramkey"></td>
312 <td></td>
313 <td class="paramtype">&nbsp;</td>
314 <td class="paramname"> <em>...</em></td><td>&nbsp;</td>
315 </tr>
316 <tr>
317 <td></td>
318 <td>)</td>
319 <td></td><td></td><td width="100%"></td>
320 </tr>
321 </table>
322</div>
323<div class="memdoc">
324
325<p>
326exit with error message.
327<p>
328This function displays an error message then exit. <dl compact><dt><b>Parameters:</b></dt><dd>
329 <table border="0" cellspacing="2" cellpadding="0">
330 <tr><td valign="top"></td><td valign="top"><em>msg</em>&nbsp;</td><td>format strin, like printf, without the newline character. </td></tr>
331 </table>
332</dl>
333
334</div>
335</div><p>
336<a class="anchor" name="gaa22f45ad00e0010a1440985ac51b18b"></a><!-- doxytag: member="drawstuff.h::dsGetViewpoint" ref="gaa22f45ad00e0010a1440985ac51b18b" args="(float xyz[3], float hpr[3])" -->
337<div class="memitem">
338<div class="memproto">
339 <table class="memname">
340 <tr>
341 <td class="memname">DS_API void dsGetViewpoint </td>
342 <td>(</td>
343 <td class="paramtype">float&nbsp;</td>
344 <td class="paramname"> <em>xyz</em>[3], </td>
345 </tr>
346 <tr>
347 <td class="paramkey"></td>
348 <td></td>
349 <td class="paramtype">float&nbsp;</td>
350 <td class="paramname"> <em>hpr</em>[3]</td><td>&nbsp;</td>
351 </tr>
352 <tr>
353 <td></td>
354 <td>)</td>
355 <td></td><td></td><td width="100%"></td>
356 </tr>
357 </table>
358</div>
359<div class="memdoc">
360
361<p>
362Gets the viewpoint.
363<p>
364<dl compact><dt><b>Parameters:</b></dt><dd>
365 <table border="0" cellspacing="2" cellpadding="0">
366 <tr><td valign="top"></td><td valign="top"><em>xyz</em>&nbsp;</td><td>position </td></tr>
367 <tr><td valign="top"></td><td valign="top"><em>hpr</em>&nbsp;</td><td>heading,pitch,roll. </td></tr>
368 </table>
369</dl>
370
371</div>
372</div><p>
373<a class="anchor" name="gbca5fa4076aa9e45caa049f33e8cf168"></a><!-- doxytag: member="drawstuff.h::dsPrint" ref="gbca5fa4076aa9e45caa049f33e8cf168" args="(char *msg,...)" -->
374<div class="memitem">
375<div class="memproto">
376 <table class="memname">
377 <tr>
378 <td class="memname">DS_API void dsPrint </td>
379 <td>(</td>
380 <td class="paramtype">char *&nbsp;</td>
381 <td class="paramname"> <em>msg</em>, </td>
382 </tr>
383 <tr>
384 <td class="paramkey"></td>
385 <td></td>
386 <td class="paramtype">&nbsp;</td>
387 <td class="paramname"> <em>...</em></td><td>&nbsp;</td>
388 </tr>
389 <tr>
390 <td></td>
391 <td>)</td>
392 <td></td><td></td><td width="100%"></td>
393 </tr>
394 </table>
395</div>
396<div class="memdoc">
397
398<p>
399print log message
400<p>
401<dl compact><dt><b>Parameters:</b></dt><dd>
402 <table border="0" cellspacing="2" cellpadding="0">
403 <tr><td valign="top"></td><td valign="top"><em>msg</em>&nbsp;</td><td>format string, like printf, without the <br>
404. </td></tr>
405 </table>
406</dl>
407
408</div>
409</div><p>
410<a class="anchor" name="g3221a0d1360621eaad7c54597671c092"></a><!-- doxytag: member="drawstuff.h::dsSetColor" ref="g3221a0d1360621eaad7c54597671c092" args="(float red, float green, float blue)" -->
411<div class="memitem">
412<div class="memproto">
413 <table class="memname">
414 <tr>
415 <td class="memname">DS_API void dsSetColor </td>
416 <td>(</td>
417 <td class="paramtype">float&nbsp;</td>
418 <td class="paramname"> <em>red</em>, </td>
419 </tr>
420 <tr>
421 <td class="paramkey"></td>
422 <td></td>
423 <td class="paramtype">float&nbsp;</td>
424 <td class="paramname"> <em>green</em>, </td>
425 </tr>
426 <tr>
427 <td class="paramkey"></td>
428 <td></td>
429 <td class="paramtype">float&nbsp;</td>
430 <td class="paramname"> <em>blue</em></td><td>&nbsp;</td>
431 </tr>
432 <tr>
433 <td></td>
434 <td>)</td>
435 <td></td><td></td><td width="100%"></td>
436 </tr>
437 </table>
438</div>
439<div class="memdoc">
440
441<p>
442Set the color with which geometry is drawn.
443<p>
444<dl compact><dt><b>Parameters:</b></dt><dd>
445 <table border="0" cellspacing="2" cellpadding="0">
446 <tr><td valign="top"></td><td valign="top"><em>red</em>&nbsp;</td><td>Red component from 0 to 1 </td></tr>
447 <tr><td valign="top"></td><td valign="top"><em>green</em>&nbsp;</td><td>Green component from 0 to 1 </td></tr>
448 <tr><td valign="top"></td><td valign="top"><em>blue</em>&nbsp;</td><td>Blue component from 0 to 1 </td></tr>
449 </table>
450</dl>
451
452</div>
453</div><p>
454<a class="anchor" name="g440940cfaef61775e37c33b055b832af"></a><!-- doxytag: member="drawstuff.h::dsSetColorAlpha" ref="g440940cfaef61775e37c33b055b832af" args="(float red, float green, float blue, float alpha)" -->
455<div class="memitem">
456<div class="memproto">
457 <table class="memname">
458 <tr>
459 <td class="memname">DS_API void dsSetColorAlpha </td>
460 <td>(</td>
461 <td class="paramtype">float&nbsp;</td>
462 <td class="paramname"> <em>red</em>, </td>
463 </tr>
464 <tr>
465 <td class="paramkey"></td>
466 <td></td>
467 <td class="paramtype">float&nbsp;</td>
468 <td class="paramname"> <em>green</em>, </td>
469 </tr>
470 <tr>
471 <td class="paramkey"></td>
472 <td></td>
473 <td class="paramtype">float&nbsp;</td>
474 <td class="paramname"> <em>blue</em>, </td>
475 </tr>
476 <tr>
477 <td class="paramkey"></td>
478 <td></td>
479 <td class="paramtype">float&nbsp;</td>
480 <td class="paramname"> <em>alpha</em></td><td>&nbsp;</td>
481 </tr>
482 <tr>
483 <td></td>
484 <td>)</td>
485 <td></td><td></td><td width="100%"></td>
486 </tr>
487 </table>
488</div>
489<div class="memdoc">
490
491<p>
492Set the color and transparency with which geometry is drawn.
493<p>
494<dl compact><dt><b>Parameters:</b></dt><dd>
495 <table border="0" cellspacing="2" cellpadding="0">
496 <tr><td valign="top"></td><td valign="top"><em>alpha</em>&nbsp;</td><td>Note that alpha transparency is a misnomer: it is alpha opacity. 1.0 means fully opaque, and 0.0 means fully transparent. </td></tr>
497 </table>
498</dl>
499
500</div>
501</div><p>
502<a class="anchor" name="g211aa83d5c5d102cdda303cc7aeb2fd5"></a><!-- doxytag: member="drawstuff.h::dsSetSphereQuality" ref="g211aa83d5c5d102cdda303cc7aeb2fd5" args="(int n)" -->
503<div class="memitem">
504<div class="memproto">
505 <table class="memname">
506 <tr>
507 <td class="memname">DS_API void dsSetSphereQuality </td>
508 <td>(</td>
509 <td class="paramtype">int&nbsp;</td>
510 <td class="paramname"> <em>n</em> </td>
511 <td>&nbsp;)&nbsp;</td>
512 <td width="100%"></td>
513 </tr>
514 </table>
515</div>
516<div class="memdoc">
517
518<p>
519Set the quality with which curved objects are rendered.
520<p>
521Higher numbers are higher quality, but slower to draw. This must be set before the first objects are drawn to be effective. Default sphere quality is 1, default capsule quality is 3.
522</div>
523</div><p>
524<a class="anchor" name="g8a3d6f8fecc8c7d5a206bed35f17ba7a"></a><!-- doxytag: member="drawstuff.h::dsSetTexture" ref="g8a3d6f8fecc8c7d5a206bed35f17ba7a" args="(int texture_number)" -->
525<div class="memitem">
526<div class="memproto">
527 <table class="memname">
528 <tr>
529 <td class="memname">DS_API void dsSetTexture </td>
530 <td>(</td>
531 <td class="paramtype">int&nbsp;</td>
532 <td class="paramname"> <em>texture_number</em> </td>
533 <td>&nbsp;)&nbsp;</td>
534 <td width="100%"></td>
535 </tr>
536 </table>
537</div>
538<div class="memdoc">
539
540<p>
541Toggle the rendering of textures.
542<p>
543It changes the way objects are drawn. these changes will apply to all further dsDrawXXX() functions. <dl compact><dt><b>Parameters:</b></dt><dd>
544 <table border="0" cellspacing="2" cellpadding="0">
545 <tr><td valign="top"></td><td valign="top"><em>the</em>&nbsp;</td><td>texture number must be a DS_xxx texture constant. The current texture is colored according to the current color. At the start of each frame, the texture is reset to none and the color is reset to white. </td></tr>
546 </table>
547</dl>
548
549</div>
550</div><p>
551<a class="anchor" name="g8e4ea933c31d207ec57949fbb3a75815"></a><!-- doxytag: member="drawstuff.h::dsSetViewpoint" ref="g8e4ea933c31d207ec57949fbb3a75815" args="(float xyz[3], float hpr[3])" -->
552<div class="memitem">
553<div class="memproto">
554 <table class="memname">
555 <tr>
556 <td class="memname">DS_API void dsSetViewpoint </td>
557 <td>(</td>
558 <td class="paramtype">float&nbsp;</td>
559 <td class="paramname"> <em>xyz</em>[3], </td>
560 </tr>
561 <tr>
562 <td class="paramkey"></td>
563 <td></td>
564 <td class="paramtype">float&nbsp;</td>
565 <td class="paramname"> <em>hpr</em>[3]</td><td>&nbsp;</td>
566 </tr>
567 <tr>
568 <td></td>
569 <td>)</td>
570 <td></td><td></td><td width="100%"></td>
571 </tr>
572 </table>
573</div>
574<div class="memdoc">
575
576<p>
577Sets the viewpoint.
578<p>
579<dl compact><dt><b>Parameters:</b></dt><dd>
580 <table border="0" cellspacing="2" cellpadding="0">
581 <tr><td valign="top"></td><td valign="top"><em>xyz</em>&nbsp;</td><td>camera position. </td></tr>
582 <tr><td valign="top"></td><td valign="top"><em>hpr</em>&nbsp;</td><td>contains heading, pitch and roll numbers in degrees. heading=0 points along the x axis, pitch=0 is looking towards the horizon, and roll 0 is "unrotated". </td></tr>
583 </table>
584</dl>
585
586</div>
587</div><p>
588<a class="anchor" name="g28560ea1b64c1d83095bcdfce9caf9dc"></a><!-- doxytag: member="drawstuff.h::dsSimulationLoop" ref="g28560ea1b64c1d83095bcdfce9caf9dc" args="(int argc, char **argv, int window_width, int window_height, struct dsFunctions *fn)" -->
589<div class="memitem">
590<div class="memproto">
591 <table class="memname">
592 <tr>
593 <td class="memname">DS_API void dsSimulationLoop </td>
594 <td>(</td>
595 <td class="paramtype">int&nbsp;</td>
596 <td class="paramname"> <em>argc</em>, </td>
597 </tr>
598 <tr>
599 <td class="paramkey"></td>
600 <td></td>
601 <td class="paramtype">char **&nbsp;</td>
602 <td class="paramname"> <em>argv</em>, </td>
603 </tr>
604 <tr>
605 <td class="paramkey"></td>
606 <td></td>
607 <td class="paramtype">int&nbsp;</td>
608 <td class="paramname"> <em>window_width</em>, </td>
609 </tr>
610 <tr>
611 <td class="paramkey"></td>
612 <td></td>
613 <td class="paramtype">int&nbsp;</td>
614 <td class="paramname"> <em>window_height</em>, </td>
615 </tr>
616 <tr>
617 <td class="paramkey"></td>
618 <td></td>
619 <td class="paramtype">struct <a class="el" href="structds_functions.html">dsFunctions</a> *&nbsp;</td>
620 <td class="paramname"> <em>fn</em></td><td>&nbsp;</td>
621 </tr>
622 <tr>
623 <td></td>
624 <td>)</td>
625 <td></td><td></td><td width="100%"></td>
626 </tr>
627 </table>
628</div>
629<div class="memdoc">
630
631<p>
632Does the complete simulation.
633<p>
634This function starts running the simulation, and only exits when the simulation is done. Function pointers should be provided for the callbacks. <dl compact><dt><b>Parameters:</b></dt><dd>
635 <table border="0" cellspacing="2" cellpadding="0">
636 <tr><td valign="top"></td><td valign="top"><em>argv</em>&nbsp;</td><td>supports flags like '-notex' '-noshadow' '-pause' </td></tr>
637 <tr><td valign="top"></td><td valign="top"><em>fn</em>&nbsp;</td><td>Callback functions. </td></tr>
638 </table>
639</dl>
640
641</div>
642</div><p>
643<a class="anchor" name="g6c13a5a310b9e00c45150058e669ebad"></a><!-- doxytag: member="drawstuff.h::dsStop" ref="g6c13a5a310b9e00c45150058e669ebad" args="()" -->
644<div class="memitem">
645<div class="memproto">
646 <table class="memname">
647 <tr>
648 <td class="memname">DS_API void dsStop </td>
649 <td>(</td>
650 <td class="paramname"> </td>
651 <td>&nbsp;)&nbsp;</td>
652 <td width="100%"></td>
653 </tr>
654 </table>
655</div>
656<div class="memdoc">
657
658<p>
659Stop the simulation loop.
660<p>
661Calling this from within <a class="el" href="group__drawstuff.html#g28560ea1b64c1d83095bcdfce9caf9dc" title="Does the complete simulation.">dsSimulationLoop()</a> will cause it to exit and return to the caller. it is the same as if the user used the exit command. using this outside the loop will have no effect.
662</div>
663</div><p>
664<hr size="1"><address style="text-align: right;"><small>Generated on Fri Oct 12 08:36:52 2007 for Open Dynamics Engine by&nbsp;
665<a href="http://www.doxygen.org/index.html">
666<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
667</body>
668</html>
generated by cgit v1.1 at 2024-11-11 05:24:32 +0000