EPhysics: sleeping threshold and max sleep time

This patch introduces calls for setting the body's linear and angular
sleeping thresholds and to set the world's max sleeping time.


Patch by: Leandro Dorileo <dorileo@profusion.mobi>



SVN revision: 74498

legacy/ephysics/src/bin/Makefile.am

@@ -26,7 +26,8 @@ test_falling_letters.c \
 test_jumping_balls.c \
 test_no_gravity.c \
 test_rotate.c \
-test_velocity.c
+test_velocity.c \
+test_sleeping_threshold.c
 
 ephysics_logo_SOURCES = \
 ephysics_logo.c

legacy/ephysics/src/bin/test.c

@@ -20,6 +20,7 @@ void test_jumping_balls(void *data, Evas_Object *obj, void *event_info);
 void test_no_gravity(void *data, Evas_Object *obj, void *event_info);
 void test_rotate(void *data, Evas_Object *obj, void *event_info);
 void test_velocity(void *data, Evas_Object *obj, void *event_info);
+void test_sleeping(void *data, Evas_Object *obj, void *event_info);
 
 static void
 _win_del(void *data __UNUSED__, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
@@ -159,6 +160,7 @@ _main_win_add(char *autorun __UNUSED__, Eina_Bool test_win_only __UNUSED__)
    ADD_TEST("NO GRAVITY", test_no_gravity);
    ADD_TEST("ROTATE", test_rotate);
    ADD_TEST("VELOCITY", test_velocity);
+   ADD_TEST("SLEEPING THRESHOLD", test_sleeping);
 
    elm_list_go(list);
 }

legacy/ephysics/src/bin/test_no_gravity.c

@@ -40,10 +40,10 @@ _world_populate(Test_Data *test_data)
    ephysics_body_evas_object_set(box_body1, box1, EINA_TRUE);
    ephysics_body_event_callback_add(box_body1, EPHYSICS_CALLBACK_BODY_UPDATE,
                                     update_object_cb, sh1);
-   ephysics_body_restitution_set(box_body1, 1);
+   ephysics_body_restitution_set(box_body1, 0.7);
    ephysics_body_friction_set(box_body1, 0);
    ephysics_body_linear_velocity_set(box_body1, -30, -40);
-   ephysics_body_damping_set(box_body1, 0.1, 0.1);
+   ephysics_body_sleeping_threshold_set(box_body1, 0.1, 0.1);
    test_data->bodies = eina_list_append(test_data->bodies, box_body1);
 
    sh2 = elm_layout_add(test_data->win);
@@ -66,11 +66,11 @@ _world_populate(Test_Data *test_data)
    ephysics_body_evas_object_set(box_body2, box2, EINA_TRUE);
    ephysics_body_event_callback_add(box_body2, EPHYSICS_CALLBACK_BODY_UPDATE,
                                     update_object_cb, sh2);
-   ephysics_body_restitution_set(box_body2, 1);
+   ephysics_body_restitution_set(box_body2, 0.7);
    ephysics_body_friction_set(box_body2, 0);
    ephysics_body_linear_velocity_set(box_body2, 40, 30);
    ephysics_body_angular_velocity_set(box_body2, 36);
-   ephysics_body_damping_set(box_body2, 0.05, 0.1);
+   ephysics_body_sleeping_threshold_set(box_body2, 0.1, 0.1);
    test_data->bodies = eina_list_append(test_data->bodies, box_body2);
    test_data->data = box_body2;
 }

legacy/ephysics/src/bin/test_sleeping_threshold.c

@@ -0,0 +1,153 @@
+#ifdef HAVE_CONFIG_H
+# include <config.h>
+#endif
+
+#include "ephysics_test.h"
+
+typedef struct _Sleeping_Data Sleeping_Data;
+
+struct _Sleeping_Data {
+     Test_Data base;
+     EPhysics_Body *sphere;
+     EPhysics_Body *sphere2;
+};
+
+static void
+_world_populate(Sleeping_Data *sleeping_data)
+{
+   Evas_Object *sphere1, *sphere2, *sh1, *sh2;
+   EPhysics_Body *sphere_body1, *sphere_body2;
+
+   sh1 = elm_layout_add(sleeping_data->base.win);
+   elm_layout_file_set(
+      sh1, PACKAGE_DATA_DIR "/" EPHYSICS_TEST_THEME ".edj", "shadow-ball");
+   evas_object_move(sh1, WIDTH / 2, FLOOR_Y);
+   evas_object_resize(sh1, 70, 3);
+   evas_object_show(sh1);
+   sleeping_data->base.evas_objs = eina_list_append(
+      sleeping_data->base.evas_objs, sh1);
+
+   sphere1 = elm_image_add(sleeping_data->base.win);
+   elm_image_file_set(
+      sphere1, PACKAGE_DATA_DIR "/" EPHYSICS_TEST_THEME ".edj",
+      "big-blue-ball");
+   evas_object_move(sphere1, 20, FLOOR_Y - 70 + 1);
+   evas_object_resize(sphere1, 70, 70);
+   evas_object_show(sphere1);
+   sleeping_data->base.evas_objs = eina_list_append(
+      sleeping_data->base.evas_objs, sphere1);
+
+   evas_object_name_set(sphere1, "sphere1");
+
+   sphere_body1 = ephysics_body_circle_add(sleeping_data->base.world);
+   ephysics_body_evas_object_set(sphere_body1, sphere1, EINA_TRUE);
+   ephysics_body_event_callback_add(sphere_body1,
+                                    EPHYSICS_CALLBACK_BODY_UPDATE,
+                                    update_object_cb, sh1);
+   ephysics_body_restitution_set(sphere_body1, 0.8);
+   ephysics_body_friction_set(sphere_body1, 0.4);
+   ephysics_body_sleeping_threshold_set(sphere_body1, 200, 328);
+   ephysics_body_linear_velocity_set(sphere_body1, 1, 0);
+   ephysics_body_damping_set(sphere_body1, 0.5, 0.5);
+
+   sleeping_data->base.bodies = eina_list_append(
+      sleeping_data->base.bodies, sphere_body1);
+   sleeping_data->sphere = sphere_body1;
+
+   sh2 = elm_layout_add(sleeping_data->base.win);
+   elm_layout_file_set(
+      sh2, PACKAGE_DATA_DIR "/" EPHYSICS_TEST_THEME ".edj", "shadow-ball");
+   evas_object_move(sh2, WIDTH / 8, FLOOR_Y);
+   evas_object_resize(sh2, 70, 3);
+   evas_object_show(sh2);
+   sleeping_data->base.evas_objs = eina_list_append(
+      sleeping_data->base.evas_objs, sh2);
+
+   sphere2 = elm_image_add(sleeping_data->base.win);
+   elm_image_file_set(
+      sphere2, PACKAGE_DATA_DIR "/" EPHYSICS_TEST_THEME ".edj",
+      "big-red-ball");
+   evas_object_move(sphere2, WIDTH - 100, FLOOR_Y - 70 + 1);
+   evas_object_resize(sphere2, 70, 70);
+   evas_object_show(sphere2);
+   sleeping_data->base.evas_objs = eina_list_append(
+      sleeping_data->base.evas_objs, sphere2);
+
+   sphere_body2 = ephysics_body_circle_add(sleeping_data->base.world);
+   ephysics_body_evas_object_set(sphere_body2, sphere2, EINA_TRUE);
+   ephysics_body_event_callback_add(sphere_body2,
+                                    EPHYSICS_CALLBACK_BODY_UPDATE,
+                                    update_object_cb, sh2);
+   ephysics_body_restitution_set(sphere_body2, 1);
+   ephysics_body_friction_set(sphere_body2, 0.4);
+   ephysics_body_sleeping_threshold_set(sphere_body2, 0, 0);
+   ephysics_body_linear_velocity_set(sphere_body2, -1, 0);
+   ephysics_body_damping_set(sphere_body2, 0.5, 0.5);
+   sleeping_data->sphere2 = sphere_body2;
+   sleeping_data->base.bodies = eina_list_append(
+      sleeping_data->base.bodies, sphere_body2);
+}
+
+static void
+_restart(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
+{
+   Sleeping_Data *sleeping_data = data;
+
+   DBG("Restart pressed");
+   test_clean((Test_Data *)sleeping_data);
+   _world_populate(sleeping_data);
+}
+
+static void
+_win_del(void *data, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
+{
+   Sleeping_Data *sleeping_data = data;
+
+   test_clean((Test_Data *)sleeping_data);
+   evas_object_del(sleeping_data->base.layout);
+   ephysics_world_del(sleeping_data->base.world);
+   free(sleeping_data);
+   ephysics_shutdown();
+}
+
+void
+test_sleeping(void *data __UNUSED__, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
+{
+   Sleeping_Data *sleeping_data;
+   EPhysics_Body *boundary;
+   EPhysics_World *world;
+
+   if (!ephysics_init())
+     return;
+
+   sleeping_data = calloc(1, sizeof(Sleeping_Data));
+   if (!sleeping_data)
+     {
+        ERR("Failed to create test data");
+        ephysics_shutdown();
+        return;
+     }
+
+   test_win_add((Test_Data *)sleeping_data, "Sleeping Threshold", EINA_FALSE);
+   evas_object_smart_callback_add(sleeping_data->base.win,
+                                  "delete,request", _win_del, sleeping_data);
+   elm_layout_signal_callback_add(sleeping_data->base.layout, "restart",
+                                  "test-theme", _restart, sleeping_data);
+
+   world = ephysics_world_new();
+   ephysics_world_render_geometry_set(world, 50, 40, WIDTH - 100, FLOOR_Y - 40);
+   sleeping_data->base.world = world;
+   ephysics_world_max_sleeping_time_set(world, 0.5);
+
+   boundary = ephysics_body_bottom_boundary_add(sleeping_data->base.world);
+   ephysics_body_restitution_set(boundary, 0);
+   ephysics_body_friction_set(boundary, 20);
+
+   boundary = ephysics_body_right_boundary_add(sleeping_data->base.world);
+   ephysics_body_restitution_set(boundary, 0.8);
+
+   ephysics_body_left_boundary_add(sleeping_data->base.world);
+   ephysics_body_top_boundary_add(sleeping_data->base.world);
+
+   _world_populate(sleeping_data);
+}

legacy/ephysics/src/lib/EPhysics.h

@@ -437,6 +437,35 @@ EAPI void ephysics_world_running_set(EPhysics_World *world, Eina_Bool running);
  */
 EAPI Eina_Bool ephysics_world_running_get(const EPhysics_World *world);
 
+/**
+ * @brief
+ * Set the max sleeping time value.
+ *
+ * This value determines how long(in seconds) a rigid body under the linear and
+ * angular threshold is supposed to be marked as sleeping. Default value is set
+ * to 2.0.
+ *
+ * @param world The world to set the max sleeping time.
+ * @param sleeping_time The max sleeping time to set to @p world.
+ *
+ * @see ephysics_world_max_sleeping_time_get()
+ * @see ephysics_body_sleeping_threshold_set() for sleeping thresholds details.
+ * @ingroup EPhysics_World
+ */
+EAPI void ephysics_world_max_sleeping_time_set(EPhysics_World *world, double sleeping_time);
+
+/**
+ * @brief
+ * Get the max sleeping time value for @p world.
+ *
+ * @param world The world to get the max sleeping time from.
+ * @return The max sleeping time from @p world.
+ *
+ * @see ephysics_world_max_sleeping_time_set()
+ * @ingroup EPhysics_World
+ */
+EAPI double ephysics_world_max_sleeping_time_get(const EPhysics_World *world);
+
 /**
  * @brief
  * Set world gravity in 2 axises (x, y).
@@ -1273,6 +1302,67 @@ EAPI void ephysics_body_angular_velocity_set(EPhysics_Body *body, double z);
  */
 EAPI double ephysics_body_angular_velocity_get(const EPhysics_Body *body);
 
+/**
+ * @brief
+ * Set the linear and angular sleeping threshold.
+ *
+ * These factors are used to determine whenever a rigid body is supposed to
+ * increment the sleeping time.
+ *
+ * After every tick the sleeping time is incremented, if the body's linear and
+ * angular velocity is less than the respective thresholds the sleeping time is
+ * incremented by the current time step(delta time).
+ *
+ * After reaching the max sleeping time the body is marked to sleep, that means
+ * the rigid body is to be deactivated.
+ *
+ * @note The expected linear velocity to be informed as @p linear_threshold is
+ * the sum of X and Y linear velocity, that's the total velocity. The velocity
+ * is measured in Evas coordinates per second.
+ *
+ * @note The expected angular velocity to be informed as @p angular_threshold
+ * is measured in degrees per second.
+ *
+ * @param body The body to be set.
+ * @param linear_threshold The linear sleeping threshold factor.
+ * @param angular_threshold The angular sleeping threshold factor.
+ *
+ * @see ephysics_body_linear_sleeping_threshold_get()
+ * @see ephysics_body_angular_sleeping_threshold_get()
+ * @see ephysics_world_max_sleeping_time_set() for sleeping time details.
+ * @ingroup EPhysics_Body
+ */
+EAPI void ephysics_body_sleeping_threshold_set(EPhysics_Body *body, double linear_threshold, double angular_threshold);
+
+/**
+ * @brief
+ * Get the linear sleeping threshold.
+ *
+ * @note The linear sleeping threshold is measured in Evas coordinates per
+ * second.
+ *
+ * @param body The body to get the linear sleeping threshold from.
+ * @return The linear sleeping threshold from @p body.
+ *
+ * @see ephysics_body_sleeping_threshold_set()
+ * @ingroup EPhysics_Body
+ */
+EAPI double ephysics_body_linear_sleeping_threshold_get(const EPhysics_Body *body);
+
+/**
+ * @brief
+ * Get the angular sleeping threshold.
+ *
+ * @note The angular sleeping threshold is measured in degrees.
+ *
+ * @param body The body to get the angular sleeping threshold from.
+ * @return The angular sleeping threshold from @p body.
+ *
+ * @see ephysics_body_sleeping_threshold_set()
+ * @ingroup EPhysics_Body
+ */
+EAPI double ephysics_body_angular_sleeping_threshold_get(const EPhysics_Body *body);
+
 /**
  * @brief
  * Stop angular and linear body movement.

legacy/ephysics/src/lib/ephysics_body.cpp

@@ -635,6 +635,49 @@ ephysics_body_angular_velocity_get(const EPhysics_Body *body)
    return -body->rigid_body->getAngularVelocity().getZ() * RAD_TO_DEG;
 }
 
+EAPI void
+ephysics_body_sleeping_threshold_set(EPhysics_Body *body, double linear_threshold, double angular_threshold)
+{
+   double rate;
+
+   if (!body)
+     {
+        ERR("Can't set sleeping thresholds, body is null.");
+        return;
+     }
+
+   rate = ephysics_world_rate_get(body->world);
+   body->rigid_body->setSleepingThresholds(linear_threshold / rate,
+                                           angular_threshold / RAD_TO_DEG);
+}
+
+EAPI double
+ephysics_body_linear_sleeping_threshold_get(const EPhysics_Body *body)
+{
+   double rate;
+
+   if (!body)
+     {
+        ERR("Can't get linear sleeping threshold, body is null.");
+        return 0;
+     }
+
+   rate = ephysics_world_rate_get(body->world);
+   return body->rigid_body->getLinearSleepingThreshold() * rate;
+}
+
+EAPI double
+ephysics_body_angular_sleeping_threshold_get(const EPhysics_Body *body)
+{
+   if (!body)
+     {
+        ERR("Can't get angular sleeping threshold, body is null.");
+        return 0;
+     }
+
+   return body->rigid_body->getAngularSleepingThreshold() * RAD_TO_DEG;
+}
+
 EAPI void
 ephysics_body_stop(EPhysics_Body *body)
 {

legacy/ephysics/src/lib/ephysics_world.cpp

@@ -40,6 +40,7 @@ struct _EPhysics_World {
      Eina_Bool outside_bottom:1;
      Eina_Bool outside_left:1;
      Eina_Bool outside_right:1;
+     double max_sleeping_time;
 };
 
 static int _ephysics_world_init_count = 0;
@@ -103,6 +104,7 @@ _simulate_worlds(void *data)
         delta = time_now - world->last_update;
         world->last_update = time_now;
 
+        gDeactivationTime = world->max_sleeping_time;
         world->dynamics_world->stepSimulation(delta, 1, 1/40.f);
      }
 
@@ -297,6 +299,7 @@ ephysics_world_new(void)
    world->dynamics_world->setInternalTickCallback(_ephysics_world_tick_cb,
                                                   (void *) world);
 
+   world->max_sleeping_time = 2.0;
    world->running = EINA_TRUE;
    world->last_update = ecore_time_get();
    _worlds_running++;
@@ -459,6 +462,30 @@ ephysics_world_running_get(const EPhysics_World *world)
    return world->running;
 }
 
+EAPI void
+ephysics_world_max_sleeping_time_set(EPhysics_World *world, double sleeping_time)
+{
+   if (!world)
+     {
+	ERR("Can't set the world's max sleeping time, world is null.");
+	return;
+     }
+
+   world->max_sleeping_time = sleeping_time;
+}
+
+EAPI double
+ephysics_world_max_sleeping_time_get(const EPhysics_World *world)
+{
+   if (!world)
+     {
+	ERR("Can't get the world's max sleeping time, world is null.");
+	return 0;
+     }
+
+   return world->max_sleeping_time;
+}
+
 EAPI void
 ephysics_world_gravity_set(EPhysics_World *world, double gx, double gy)
 {