summaryrefslogtreecommitdiff
path: root/legacy/ephysics
diff options
context:
space:
mode:
authorBruno Dilly <bdilly@profusion.mobi>2012-09-14 22:05:29 +0000
committerBruno Dilly <bdilly@profusion.mobi>2012-09-14 22:05:29 +0000
commit70c3dd925b43b3cf4685917d90dff1b731fbbd5f (patch)
treed8a0a381977be2c6af757b286878786698a0c159 /legacy/ephysics
parente3822da595c5392d1267b9f23d765d32379872f9 (diff)
ephysics: small fixes on docs
Spotted by gastal SVN revision: 76698
Diffstat (limited to 'legacy/ephysics')
-rw-r--r--legacy/ephysics/TODO2
-rw-r--r--legacy/ephysics/doc/examples.dox4
-rw-r--r--legacy/ephysics/src/lib/EPhysics.h41
3 files changed, 24 insertions, 23 deletions
diff --git a/legacy/ephysics/TODO b/legacy/ephysics/TODO
index 8d1dc506d6..0e961edb1b 100644
--- a/legacy/ephysics/TODO
+++ b/legacy/ephysics/TODO
@@ -7,7 +7,7 @@
7* deform objects 7* deform objects
8* improve docs 8* improve docs
9* run simulation on other thread 9* run simulation on other thread
10* support linear moves on Z axis and rotation on X and Y axises. 10* support linear moves on Z axis and rotation on X and Y axes.
11 11
12FAR FAR FUTURE: 12FAR FAR FUTURE:
13* support Box2d backend 13* support Box2d backend
diff --git a/legacy/ephysics/doc/examples.dox b/legacy/ephysics/doc/examples.dox
index 3463451de2..b3a704caab 100644
--- a/legacy/ephysics/doc/examples.dox
+++ b/legacy/ephysics/doc/examples.dox
@@ -250,7 +250,7 @@
250 * @section text-binding Binding 250 * @section text-binding Binding
251 * @dontinclude test_bouncing_text.c 251 * @dontinclude test_bouncing_text.c
252 * 252 *
253 * After create the body and the text, now we need to bind them. 253 * After creating the body and the text, now we need to bind them.
254 * 254 *
255 * We set the last parameter as EINA_FALSE because in this example we don't 255 * We set the last parameter as EINA_FALSE because in this example we don't
256 * want to set the physics body position to match evas object position. 256 * want to set the physics body position to match evas object position.
@@ -623,7 +623,7 @@
623 * @section add-gravity Setting Gravity 623 * @section add-gravity Setting Gravity
624 * @dontinclude test_no_gravity.c 624 * @dontinclude test_no_gravity.c
625 * 625 *
626 * Here we set EPhysics_worlds gravity in 2 axises (x, y) to (0, 0). Gravity 626 * Here we set EPhysics_worlds gravity in 2 axes (x, y) to (0, 0). Gravity
627 * will act over bodies with mass over all the time. 627 * will act over bodies with mass over all the time.
628 * 628 *
629 * @skipline ephysics_world_gravity_set 629 * @skipline ephysics_world_gravity_set
diff --git a/legacy/ephysics/src/lib/EPhysics.h b/legacy/ephysics/src/lib/EPhysics.h
index fa034690e4..59e13d8ad9 100644
--- a/legacy/ephysics/src/lib/EPhysics.h
+++ b/legacy/ephysics/src/lib/EPhysics.h
@@ -137,7 +137,7 @@ EAPI int ephysics_shutdown(void);
137 * create many bodies. When done, it's required to delete the shape 137 * create many bodies. When done, it's required to delete the shape
138 * with @ref ephysics_shape_del(). 138 * with @ref ephysics_shape_del().
139 * 139 *
140 * A shape can be load from a file describing it with 140 * A shape can be loaded from a file describing it with
141 * @ref ephysics_shape_load(), and can be saved to a file with 141 * @ref ephysics_shape_load(), and can be saved to a file with
142 * @ref ephysics_shape_save(). With that shapes can be done or visualized 142 * @ref ephysics_shape_save(). With that shapes can be done or visualized
143 * on design applications. 143 * on design applications.
@@ -310,14 +310,14 @@ typedef struct _EPhysics_Body EPhysics_Body;
310 * A camera defines the region of the physics world that will be rendered 310 * A camera defines the region of the physics world that will be rendered
311 * on the canvas. It sets the point of view. 311 * on the canvas. It sets the point of view.
312 * 312 *
313 * Every world has a camera, that can be get with 313 * Every world has a camera, that can be gotten with
314 * @ref ephysics_world_camera_get(). 314 * @ref ephysics_world_camera_get().
315 * Its position can be set with @ref ephysics_camera_position_set() or 315 * Its position can be set with @ref ephysics_camera_position_set() or
316 * can be set to track a body, with @ref ephysics_camera_body_track(); 316 * can be set to track a body, with @ref ephysics_camera_body_track();
317 * 317 *
318 */ 318 */
319 319
320typedef struct _EPhysics_Camera EPhysics_Camera; /**< Camera handle, used to change the position of the frame to be rendered. Every world have a camera that can be get with @ref ephysics_world_camera_get(). */ 320typedef struct _EPhysics_Camera EPhysics_Camera; /**< Camera handle, used to change the position of the frame to be rendered. Every world have a camera that can be gotten with @ref ephysics_world_camera_get(). */
321 321
322/** 322/**
323 * @brief 323 * @brief
@@ -665,7 +665,7 @@ EAPI double ephysics_world_max_sleeping_time_get(const EPhysics_World *world);
665 665
666/** 666/**
667 * @brief 667 * @brief
668 * Set world gravity in 2 axises (x, y). 668 * Set world gravity in 2 axes (x, y).
669 * 669 *
670 * Gravity will act over bodies with mass over all the time. 670 * Gravity will act over bodies with mass over all the time.
671 * 671 *
@@ -1379,7 +1379,7 @@ EAPI EPhysics_Body *ephysics_body_soft_circle_add(EPhysics_World *world);
1379 * @brief 1379 * @brief
1380 * Create a new box physics body. 1380 * Create a new box physics body.
1381 * 1381 *
1382 * Its collision shape will be a box of dimensions 1 on all the axises. 1382 * Its collision shape will be a box of dimensions 1 on all the axes.
1383 * To change it's size @ref ephysics_body_geometry_set() should be used. 1383 * To change it's size @ref ephysics_body_geometry_set() should be used.
1384 * 1384 *
1385 * If a box that could have its shape deformed is required, use 1385 * If a box that could have its shape deformed is required, use
@@ -1399,7 +1399,7 @@ EAPI EPhysics_Body *ephysics_body_box_add(EPhysics_World *world);
1399 * @brief 1399 * @brief
1400 * Create a new deformable box physics body. 1400 * Create a new deformable box physics body.
1401 * 1401 *
1402 * Its collision shape will be a box of dimensions 1 on all the axises. 1402 * Its collision shape will be a box of dimensions 1 on all the axes.
1403 * To change it's size @ref ephysics_body_geometry_set() should be used. 1403 * To change it's size @ref ephysics_body_geometry_set() should be used.
1404 * 1404 *
1405 * Just like rotation, deformation will be applied on associated 1405 * Just like rotation, deformation will be applied on associated
@@ -1426,7 +1426,7 @@ EAPI EPhysics_Body *ephysics_body_soft_box_add(EPhysics_World *world);
1426 * @ref ephysics_shape_new(). 1426 * @ref ephysics_shape_new().
1427 * 1427 *
1428 * To change it's size @ref ephysics_body_geometry_set() should be used, 1428 * To change it's size @ref ephysics_body_geometry_set() should be used,
1429 * so it can be deformed on x and y axises. 1429 * so it can be deformed on x and y axes.
1430 * 1430 *
1431 * The center of mass of this body can be get with 1431 * The center of mass of this body can be get with
1432 * @ref ephysics_body_center_mass_get(). 1432 * @ref ephysics_body_center_mass_get().
@@ -1602,7 +1602,7 @@ EAPI Evas_Object *ephysics_body_evas_object_get(const EPhysics_Body *body);
1602 * 1602 *
1603 * All the physics bodies are and with canonical dimensions. 1603 * All the physics bodies are and with canonical dimensions.
1604 * Circles have diameter 1, boxes have dimensions 1 1604 * Circles have diameter 1, boxes have dimensions 1
1605 * on all the axises. 1605 * on all the axes.
1606 * 1606 *
1607 * There are three direct ways of modifying it's size: 1607 * There are three direct ways of modifying it's size:
1608 * @li With @ref ephysics_body_resize(); 1608 * @li With @ref ephysics_body_resize();
@@ -1659,7 +1659,7 @@ EAPI void ephysics_body_move(EPhysics_Body *body, Evas_Coord x, Evas_Coord y);
1659 * 1659 *
1660 * All the physics bodies are created centered on origin (0, 0) and with 1660 * All the physics bodies are created centered on origin (0, 0) and with
1661 * canonical dimensions. Circles have diameter 1, boxes have dimensions 1 1661 * canonical dimensions. Circles have diameter 1, boxes have dimensions 1
1662 * on all the axises. 1662 * on all the axes.
1663 * 1663 *
1664 * There are four direct ways of modifying this geometry: 1664 * There are four direct ways of modifying this geometry:
1665 * @li With @ref ephysics_body_geometry_set(); 1665 * @li With @ref ephysics_body_geometry_set();
@@ -2278,7 +2278,7 @@ EAPI void ephysics_body_central_impulse_apply(EPhysics_Body *body, double x, dou
2278 * 2278 *
2279 * @param body The physics body that will receive the impulse. 2279 * @param body The physics body that will receive the impulse.
2280 * @param roll Impulse to rotate body around Z axis (rotate on x - y plane). 2280 * @param roll Impulse to rotate body around Z axis (rotate on x - y plane).
2281 * Negative values will impulse body on anti clock rotation. 2281 * Negative values will impulse body on counter clockwise rotation.
2282 * 2282 *
2283 * @see ephysics_body_central_impulse_apply(). 2283 * @see ephysics_body_central_impulse_apply().
2284 * @see ephysics_body_impulse_apply(). 2284 * @see ephysics_body_impulse_apply().
@@ -2355,9 +2355,9 @@ EAPI Eina_Bool ephysics_body_rotation_on_z_axis_enable_get(const EPhysics_Body *
2355 2355
2356/** 2356/**
2357 * @brief 2357 * @brief
2358 * Enable or disable body's movement on x and y axises. 2358 * Enable or disable body's movement on x and y axes.
2359 * 2359 *
2360 * Enabled by default on both axises. 2360 * Enabled by default on both axes.
2361 * 2361 *
2362 * @param body The physics body. 2362 * @param body The physics body.
2363 * @param enable_x If @c EINA_TRUE allow movement on x axis, if @c EINA_FALSE 2363 * @param enable_x If @c EINA_TRUE allow movement on x axis, if @c EINA_FALSE
@@ -2374,7 +2374,7 @@ EAPI void ephysics_body_linear_movement_enable_set(EPhysics_Body *body, Eina_Boo
2374 2374
2375/** 2375/**
2376 * @brief 2376 * @brief
2377 * Get body's movement on x and y axises behavior. 2377 * Get body's movement on x and y axes behavior.
2378 * 2378 *
2379 * @param body The physics body. 2379 * @param body The physics body.
2380 * @param enable_x @c EINA_TRUE if movement on x axis is allowed, or 2380 * @param enable_x @c EINA_TRUE if movement on x axis is allowed, or
@@ -2411,7 +2411,7 @@ EAPI double ephysics_body_rotation_get(const EPhysics_Body *body);
2411 * Set body's rotation on z axis. 2411 * Set body's rotation on z axis.
2412 * 2412 *
2413 * By default rotation is 0 degrees. 2413 * By default rotation is 0 degrees.
2414 * Negative values indicates rotation on counterclockwise direction. 2414 * Negative values indicates rotation on counter clockwise direction.
2415 * 2415 *
2416 * @note The unit used for rotation is degrees. 2416 * @note The unit used for rotation is degrees.
2417 * 2417 *
@@ -2512,7 +2512,7 @@ EAPI void ephysics_body_central_force_apply(EPhysics_Body *body, double x, doubl
2512 * @param body The physics body that will receive the torque. 2512 * @param body The physics body that will receive the torque.
2513 * @param torque Torque to change angular acceleration of the body around Z 2513 * @param torque Torque to change angular acceleration of the body around Z
2514 * axis (rotate on x - y plane). 2514 * axis (rotate on x - y plane).
2515 * Negative values will accelerate it on anti clock rotation. 2515 * Negative values will accelerate it on counter clockwise rotation.
2516 * 2516 *
2517 * @see ephysics_body_central_force_apply(). 2517 * @see ephysics_body_central_force_apply().
2518 * @see ephysics_body_force_apply(). 2518 * @see ephysics_body_force_apply().
@@ -2733,12 +2733,12 @@ EAPI void ephysics_constraint_slider_linear_limit_get(const EPhysics_Constraint
2733 * Set the angular moving limits of a slider @p constraint. 2733 * Set the angular moving limits of a slider @p constraint.
2734 * 2734 *
2735 * The angular moving limits is defined in degrees and will limit the moving on 2735 * The angular moving limits is defined in degrees and will limit the moving on
2736 * Z axis - counter clock and clock wise directions. 2736 * Z axis - counter clockwise and clockwise directions.
2737 * 2737 *
2738 * @param constraint The constraint to be set. 2738 * @param constraint The constraint to be set.
2739 * @param counter_clock_z Amount of degrees from 0.0 to 360.0 to limit 2739 * @param counter_clock_z Amount of degrees from 0.0 to 360.0 to limit
2740 * counter clock rotation. 2740 * counter clockwise rotation.
2741 * @param clock_wise_z Amount of degrees from 0.0 to 360.0 to limit clock wise 2741 * @param clock_wise_z Amount of degrees from 0.0 to 360.0 to limit clockwise
2742 * rotation. 2742 * rotation.
2743 * 2743 *
2744 * @see ephysics_constraint_slider_angular_limit_get() 2744 * @see ephysics_constraint_slider_angular_limit_get()
@@ -2751,8 +2751,9 @@ EAPI void ephysics_constraint_slider_angular_limit_set(EPhysics_Constraint *cons
2751 * Get the angular moving limits of a slider @p constraint. 2751 * Get the angular moving limits of a slider @p constraint.
2752 * 2752 *
2753 * @param constraint The constraint to get the angular limits from. 2753 * @param constraint The constraint to get the angular limits from.
2754 * @param counter_clock_z Pointer to set with the counter clock limit degrees. 2754 * @param counter_clock_z Pointer to set with the counter clockwise limit
2755 * @param clock_wise_z Pointer to set with the clock wise limit degrees. 2755 * degrees.
2756 * @param clock_wise_z Pointer to set with the clockwise limit degrees.
2756 * 2757 *
2757 * @see ephysics_constraint_slider_angular_limit_set() 2758 * @see ephysics_constraint_slider_angular_limit_set()
2758 * @ingroup EPhysics_Constraint 2759 * @ingroup EPhysics_Constraint