summaryrefslogtreecommitdiff
path: root/legacy/ephysics/src/lib/EPhysics.h
diff options
context:
space:
mode:
authorBruno Dilly <bdilly@profusion.mobi>2012-10-25 21:55:14 +0000
committerBruno Dilly <bdilly@profusion.mobi>2012-10-25 21:55:14 +0000
commit651b562ebd94d1d738dc1aed9534f4f6184cccaa (patch)
treec15edba932b3eaa586da05c49c9db9d82b7e273f /legacy/ephysics/src/lib/EPhysics.h
parent8ae0d9af745e4c1bf07121b73568e27a9ea07cb4 (diff)
ephysics: docs fixes (missing params / typos)
SVN revision: 78490
Diffstat (limited to '')
-rw-r--r--legacy/ephysics/src/lib/EPhysics.h26
1 files changed, 17 insertions, 9 deletions
diff --git a/legacy/ephysics/src/lib/EPhysics.h b/legacy/ephysics/src/lib/EPhysics.h
index bfb354c063..4c2f64fe9c 100644
--- a/legacy/ephysics/src/lib/EPhysics.h
+++ b/legacy/ephysics/src/lib/EPhysics.h
@@ -735,6 +735,9 @@ EAPI void ephysics_world_del(EPhysics_World *world);
735 * 735 *
736 * When a world is created it starts running. 736 * When a world is created it starts running.
737 * 737 *
738 * @param world The world to be played / paused.
739 * @param running If @c EINA_TRUE it will play, otherwise it will pause.
740 *
738 * @see ephysics_world_running_get() 741 * @see ephysics_world_running_get()
739 * 742 *
740 * @ingroup EPhysics_World 743 * @ingroup EPhysics_World
@@ -747,6 +750,10 @@ EAPI void ephysics_world_running_set(EPhysics_World *world, Eina_Bool running);
747 * 750 *
748 * By default a world starts running. 751 * By default a world starts running.
749 * 752 *
753 * @param world The physics world.
754 * @return @c EINA_TRUE if it's running, or @c EINA_FALSE if it's paused or on
755 * error.
756 *
750 * @see ephysics_world_running_set() for more details. 757 * @see ephysics_world_running_set() for more details.
751 * 758 *
752 * @ingroup EPhysics_World 759 * @ingroup EPhysics_World
@@ -1917,13 +1924,14 @@ EAPI int ephysics_body_soft_body_triangle_index_get(EPhysics_Body *body, Evas_Co
1917 * Set the soft body number of position iterations. 1924 * Set the soft body number of position iterations.
1918 * 1925 *
1919 * Both soft body and cloth can have its number of position iterations changed. 1926 * Both soft body and cloth can have its number of position iterations changed.
1920 * The number of position iterations will change how many time the physics engine 1927 * The number of position iterations will change how many time the physics
1928 * engine
1921 * will iterate the position solver, a greater value will change deformation 1929 * will iterate the position solver, a greater value will change deformation
1922 * behaves and how hard the soft body looks like. The greater position iterations 1930 * behaves and how hard the soft body looks like. The greater position
1923 * the harder the soft body will be. 1931 * iterations the harder the soft body will be.
1924 * 1932 *
1925 * @node For soft bodies the default value is set to 1, and for cloth it's set to 1933 * @note For soft bodies the default value is set to 1, and for cloth it's set
1926 * the number of rows / 5; 1934 * to the number of rows / 5;
1927 * 1935 *
1928 * @param body The body to be set. 1936 * @param body The body to be set.
1929 * @param iterations The number of iterations. 1937 * @param iterations The number of iterations.
@@ -2004,8 +2012,8 @@ EAPI EPhysics_Body *ephysics_body_circle_add(EPhysics_World *world);
2004 * Just like rotation, deformation will be applied on associated 2012 * Just like rotation, deformation will be applied on associated
2005 * evas object using evas map. 2013 * evas object using evas map.
2006 * 2014 *
2007 * @note When working with soft bodies it's importante to adjust the simulation's 2015 * @note When working with soft bodies it's importante to adjust the
2008 * fixed time step due its multi point nature. 2016 * simulation's fixed time step due its multi point nature.
2009 * 2017 *
2010 * For a rigid circle, check @ref ephysics_body_circle_add(). 2018 * For a rigid circle, check @ref ephysics_body_circle_add().
2011 * 2019 *
@@ -2049,8 +2057,8 @@ EAPI EPhysics_Body *ephysics_body_box_add(EPhysics_World *world);
2049 * Just like rotation, deformation will be applied on associated 2057 * Just like rotation, deformation will be applied on associated
2050 * evas object using evas map. 2058 * evas object using evas map.
2051 * 2059 *
2052 * @note When working with soft bodies it's importante to adjust the simulation's 2060 * @note When working with soft bodies it's importante to adjust the
2053 * fixed time step due its multi point nature. 2061 * simulation's fixed time step due its multi point nature.
2054 * 2062 *
2055 * For a rigid circle, check @ref ephysics_body_circle_add(). 2063 * For a rigid circle, check @ref ephysics_body_circle_add().
2056 * 2064 *