summaryrefslogtreecommitdiff
path: root/legacy/ephysics/doc
diff options
context:
space:
mode:
authorRicardo de Almeida Gonzaga <ricardo@profusion.mobi>2012-09-14 22:01:43 +0000
committerBruno Dilly <bdilly@profusion.mobi>2012-09-14 22:01:43 +0000
commit886d35fc6dad932425602f281c1138fee160c8f5 (patch)
tree3b4ce42c457fc7cb2431546b6dc9bb34ce37855f /legacy/ephysics/doc
parent49366a7a843b9c4aa02f2c711eb6429b56817868 (diff)
ephysics: add a new example doc: Constraint -
test_constrant.c Patch by: Ricardo de Almeida Gonzaga <ricardo@profusion.mobi> SVN revision: 76691
Diffstat (limited to 'legacy/ephysics/doc')
-rw-r--r--legacy/ephysics/doc/examples.dox61
1 files changed, 61 insertions, 0 deletions
diff --git a/legacy/ephysics/doc/examples.dox b/legacy/ephysics/doc/examples.dox
index b182bad3b5..10f63b92b2 100644
--- a/legacy/ephysics/doc/examples.dox
+++ b/legacy/ephysics/doc/examples.dox
@@ -5,6 +5,7 @@
5 * 5 *
6 * @li @ref tutorial_ephysics_bouncing_ball 6 * @li @ref tutorial_ephysics_bouncing_ball
7 * @li @ref tutorial_ephysics_delete_body 7 * @li @ref tutorial_ephysics_delete_body
8 * @li @ref tutorial_ephysics_constraint
8 */ 9 */
9 10
10/** 11/**
@@ -290,3 +291,63 @@
290 * 291 *
291 * @example test_delete.c 292 * @example test_delete.c
292 */ 293 */
294
295 /**
296 * @page tutorial_ephysics_constraint EPhysics - Constraint
297 *
298 * The purpose of this example is to demonstrate the EPhysics Constraint usage -
299 * The code apply a constraint between two cubes.
300 *
301 * For this example we'll have an EPhysics_World, and two basic EPhysics_Bodys.
302 *
303 * The basic concepts like - defining an EPhysics_World, render geometry,
304 * physics limiting boundaries, add an EPhysics_Body, associate it to evas
305 * objects, change restitution, friction and impulse properties, were
306 * already covered in
307 * @ref tutorial_ephysics_bouncing_ball
308 *
309 * @section add-constraint Adding a constraint
310 * @dontinclude test_constraint.c
311 *
312 * Constraint is a specific type of variable in EPhysics.
313 *
314 * @skipline EPhysics_Constraint
315 *
316 * Here we're working with a point-to-point constraint, its purpose is to join
317 * two bodies limiting their movements based on specified anchors.
318 *
319 * After we create our 2 EPhysics_Bodys, now we'll add a constraint between
320 * them and setting an anchor to first body's Y using a p2p constraint
321 * (point to point).
322 *
323 * @skip constraint = ephysics_constraint_p2p
324 * @until );
325 *
326 * Here we finish the example. The full source code can be found at
327 * @ref test_constraint_c.
328 *
329 */
330
331 /**
332 * @page test_constraint_c test_constraint.c
333 *
334 * @section ephysics-test-h ephysics_test.h
335 * @include ephysics_test.h
336 *
337 * @section test-constraint-c test_constraint.c
338 * @dontinclude test.c
339 *
340 * @skip test_clean
341 * @until }
342 *
343 * @skip test_data_new
344 * @until }
345 *
346 * @skip test_win_add
347 * @until }
348 *
349 * @include test_constraint.c
350 *
351 * @example test_constraint.c
352 */
353