From dde0746fcbd34d6c380f656167c38c45abb3cb74 Mon Sep 17 00:00:00 2001 From: Bruno Dilly Date: Tue, 21 Aug 2012 17:47:24 +0000 Subject: [PATCH] EPhysics: improve bodies group description documentation SVN revision: 75509 --- legacy/ephysics/src/lib/EPhysics.h | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/legacy/ephysics/src/lib/EPhysics.h b/legacy/ephysics/src/lib/EPhysics.h index 381e970f1a..4494881de4 100644 --- a/legacy/ephysics/src/lib/EPhysics.h +++ b/legacy/ephysics/src/lib/EPhysics.h @@ -108,7 +108,7 @@ EAPI int ephysics_init(void); * Shutdown Bullet physics engine. If init count reaches 0, all the existing * worlds will be deleted, and consequently all the bodies. * - * @return Ephysics' init counter value. + * @return EPhysics' init counter value. * * @see ephysics_init(). * @@ -1184,15 +1184,33 @@ EAPI void ephysics_world_simulation_get(const EPhysics_World *world, double *fix * @ref ephysics_body_resize(); * @ref ephysics_body_geometry_set(). * + * Their rotation can be set directly with @ref ephysics_body_rotation_set(). + * * Also, they can have an associated evas object, done with * @ref ephysics_body_evas_object_set() function, being responsible for * updating its position and rotation, or letting a user callback be set * for this task with @ref ephysics_body_event_callback_add(). * - * Also, bodies can have impulses applied over them, and will be affected - * by gravity. Impulses can be applied with: + * Bodies can have velocity set with @ref ephysics_body_linear_velocity_set() + * and @ref ephysics_body_angular_velocity_set(). + * + * Also, bodies can have forces and impulses applied over them, and they will + * be affected by gravity. + * + * Forces will be acting while they're set, changing bodies velocity over time. + * Impulses are applied only once, modifying bodies velocity imediatelly to the + * new value. + * + * Forces can be managed with: + * @li @ref ephysics_body_central_force_apply(); + * @li @ref ephysics_body_torque_apply(). + * @li @ref ephysics_body_force_apply(); + * @li @ref ephysics_body_forces_clear(); + * + * Impulses can be applied with: * @li @ref ephysics_body_central_impulse_apply(); * @li @ref ephysics_body_torque_impulse_apply(). + * @li @ref ephysics_body_impulse_apply(); * * Bodies can be removed from the world being directly deleted with * @ref ephysics_body_del() or when the world is deleted, case when all the