summaryrefslogtreecommitdiff
path: root/legacy/ephysics/doc
diff options
context:
space:
mode:
authorRicardo de Almeida Gonzaga <ricardo@profusion.mobi>2012-09-14 22:05:18 +0000
committerBruno Dilly <bdilly@profusion.mobi>2012-09-14 22:05:18 +0000
commite3822da595c5392d1267b9f23d765d32379872f9 (patch)
tree201c8a927eb2df00cf5422d2bc61e513c46d5f65 /legacy/ephysics/doc
parent4be55425e736e9d4ab452fa56e100ca0d472145d (diff)
ephysics: add a new example doc: Sleeping Threshold -
test_sleeping_threshold.c Patch by: Ricardo de Almeida Gonzaga <ricardo@profusion.mobi> SVN revision: 76697
Diffstat (limited to 'legacy/ephysics/doc')
-rw-r--r--legacy/ephysics/doc/examples.dox86
1 files changed, 86 insertions, 0 deletions
diff --git a/legacy/ephysics/doc/examples.dox b/legacy/ephysics/doc/examples.dox
index bb0222b74e..3463451de2 100644
--- a/legacy/ephysics/doc/examples.dox
+++ b/legacy/ephysics/doc/examples.dox
@@ -11,6 +11,7 @@
11 * @li @ref tutorial_ephysics_constraint 11 * @li @ref tutorial_ephysics_constraint
12 * @li @ref tutorial_ephysics_gravity 12 * @li @ref tutorial_ephysics_gravity
13 * @li @ref tutorial_ephysics_velocity 13 * @li @ref tutorial_ephysics_velocity
14 * @li @ref tutorial_ephysics_sleeping_threshold
14 */ 15 */
15 16
16/** 17/**
@@ -783,3 +784,88 @@
783 * 784 *
784 * @example test_velocity.c 785 * @example test_velocity.c
785 */ 786 */
787
788 /**
789 * @page tutorial_ephysics_sleeping_threshold EPhysics - Sleeping Threshold
790 *
791 * The purpose of this example is to demonstrate the EPhysics Sleeping
792 * Threshold usage - The code apply sleeping threshold in two cubes.
793 *
794 * For this example we'll have an EPhysics_World, and two basic EPhysics_Bodys.
795 *
796 * The basic concepts like - defining an EPhysics_World, render geometry,
797 * physics limiting boundaries, add an EPhysics_Body, associate it to evas
798 * objects, change restitution, friction and impulse properties, were
799 * already covered in
800 * @ref tutorial_ephysics_bouncing_ball
801 *
802 * Concept of velocity were already covered in
803 * @ref tutorial_ephysics_velocity
804 *
805 * @section add-maxsleeping Adding Max Sleeping Time
806 * @dontinclude test_sleeping_threshold.c
807 *
808 * Setting the max sleeping time determines how long(in seconds) a rigid body
809 * under the linear and angular threshold is supposed to be marked as sleeping.
810 *
811 * @skipline ephysics_world_max_sleeping_time_set
812 *
813 * @section add-sleeping Adding a Sleeping Threshold
814 * @dontinclude test_sleeping_threshold.c
815 *
816 * Here we set EPhysics_Bodys linear and angular sleeping threshold. These
817 * factors are used to determine whenever a rigid body is supposed to
818 * increment the sleeping time.
819 *
820 * After every tick the sleeping time is incremented. After reaching the max
821 * sleeping time the body is market to sleep, that means the rigid body is to
822 * be deactivated.
823 *
824 * @skipline ephysics_body_sleeping_threshold_set(sphere_body1
825 *
826 * @skipline ephysics_body_sleeping_threshold_set(sphere_body2
827 *
828 * We can get the EPhysics_Bodys linear and angular sleeping threshold as well.
829 *
830 * @skipline ephysics_body_sleeping_threshold_get(sphere_body1
831 *
832 * @skipline ephysics_body_sleeping_threshold_get(sphere_body2
833 *
834 * @section add-damping Adding a Damping
835 * @dontinclude test_sleeping_threshold.c
836 *
837 * Here we set EPhysics_Bodys linear and angular damping values.The damping is
838 * a force synchronous with the velocity of the object but in opposite
839 * direction - like air resistence.
840 *
841 * @skipline ephysics_body_damping_set(sphere_body1
842 *
843 * @skipline ephysics_body_damping_set(sphere_body2
844 *
845 * Here we finish the example. The full source code can be found at
846 * @ref test_sleeping_threshold_c.
847 *
848 */
849
850 /**
851 * @page test_sleeping_threshold_c test_sleeping_threshold.c
852 *
853 * @section ephysics-test-h ephysics_test.h
854 * @include ephysics_test.h
855 *
856 * @section test-sleeping-threshold-c test_sleeping_threshold.c
857 * @dontinclude test.c
858 *
859 * @skip test_clean
860 * @until }
861 *
862 * @skip test_data_new
863 * @until }
864 *
865 * @skip test_win_add
866 * @until }
867 *
868 * @include test_sleeping_threshold.c
869 *
870 * @example test_sleeping_threshold.c
871 */