ephysics: support multiple evas objects associated to

 body




SVN revision: 79041

1 files changed, 252 insertions, 0 deletions

diff --git a/legacy/ephysics/src/lib/EPhysics.h b/legacy/ephysics/src/lib/EPhysics.h
index 72a52ddba0..710df3a656 100644
--- a/legacy/ephysics/src/lib/EPhysics.h
+++ b/legacy/ephysics/src/lib/EPhysics.h
@@ -1842,6 +1842,66 @@ typedef enum _EPhysics_Body_Cloth_Anchor_Side
 } EPhysics_Body_Cloth_Anchor_Side;
 
 /**
+ * @enum _EPhysics_Body_Box_Face
+ * @typedef EPhysics_Body_Box_Face
+ *
+ * Define in wich box's face the evas object should be set.
+ *
+ * @see ephysics_body_box_face_evas_object_set()
+ *
+ * @ingroup EPhysics_Body
+ */
+typedef enum _EPhysics_Body_Box_Face
+{
+  EPHYSICS_BODY_BOX_FACE_MIDDLE_FRONT,
+  EPHYSICS_BODY_BOX_FACE_MIDDLE_BACK,
+  EPHYSICS_BODY_BOX_FACE_FRONT,
+  EPHYSICS_BODY_BOX_FACE_BACK,
+  EPHYSICS_BODY_BOX_FACE_LEFT,
+  EPHYSICS_BODY_BOX_FACE_RIGHT,
+  EPHYSICS_BODY_BOX_FACE_TOP,
+  EPHYSICS_BODY_BOX_FACE_BOTTOM,
+  EPHYSICS_BODY_BOX_FACE_LAST,
+} EPhysics_Body_Box_Face;
+
+/**
+ * @enum _EPhysics_Body_Cylinder_Face
+ * @typedef EPhysics_Body_Cylinder_Face
+ *
+ * Define in wich cylinder's face the evas object should be set.
+ *
+ * @see ephysics_body_cylinder_face_evas_object_set()
+ *
+ * @ingroup EPhysics_Body
+ */
+typedef enum _EPhysics_Body_Cylinder_Face
+{
+  EPHYSICS_BODY_CYLINDER_FACE_MIDDLE_FRONT,
+  EPHYSICS_BODY_CYLINDER_FACE_MIDDLE_BACK,
+  EPHYSICS_BODY_CYLINDER_FACE_FRONT,
+  EPHYSICS_BODY_CYLINDER_FACE_BACK,
+  EPHYSICS_BODY_CYLINDER_FACE_CURVED,
+  EPHYSICS_BODY_CYLINDER_FACE_LAST,
+} EPhysics_Body_Cylinder_Face;
+
+/**
+ * @enum _EPhysics_Body_Cloth_Face
+ * @typedef EPhysics_Body_Cloth_Face
+ *
+ * Define in wich cloth's face the evas object should be set.
+ *
+ * @see ephysics_body_cloth_face_evas_object_set()
+ *
+ * @ingroup EPhysics_Body
+ */
+typedef enum _EPhysics_Body_Cloth_Face
+{
+  EPHYSICS_BODY_CLOTH_FACE_FRONT,
+  EPHYSICS_BODY_CLOTH_FACE_BACK,
+  EPHYSICS_BODY_CLOTH_FACE_LAST,
+} EPhysics_Body_Cloth_Face;
+
+/**
  * @typedef EPhysics_Body_Collision
  *
  * Body collision wraps collision informations.
@@ -2084,6 +2144,8 @@ EAPI void ephysics_body_soft_body_triangle_move(EPhysics_Body *body, int idx, Ev
  * @return a new body or @c NULL, on errors.
  *
  * @see ephysics_body_del().
+ * @see ephysics_body_evas_object_set().
+ * @see ephysics_body_cylinder_face_evas_object_set().
  *
  * @ingroup EPhysics_Body
  */
@@ -2113,6 +2175,8 @@ EAPI EPhysics_Body *ephysics_body_circle_add(EPhysics_World *world);
  * @return a new body or @c NULL, on errors.
  *
  * @see ephysics_body_del().
+ * @see ephysics_body_evas_object_set().
+ * @see ephysics_body_cylinder_face_evas_object_set().
  * @see ephysics_world_simulation_set().
  *
  * @ingroup EPhysics_Body
@@ -2134,6 +2198,7 @@ EAPI EPhysics_Body *ephysics_body_soft_circle_add(EPhysics_World *world);
  *
  * @see ephysics_body_del().
  * @see ephysics_body_evas_object_set().
+ * @see ephysics_body_box_face_evas_object_set().
  *
  * @ingroup EPhysics_Body
  */
@@ -2159,6 +2224,7 @@ EAPI EPhysics_Body *ephysics_body_box_add(EPhysics_World *world);
  *
  * @see ephysics_body_del().
  * @see ephysics_body_evas_object_set().
+ * @see ephysics_body_box_face_evas_object_set().
  * @see ephysics_world_simulation_set().
  *
  * @ingroup EPhysics_Body
@@ -2188,6 +2254,7 @@ EAPI EPhysics_Body *ephysics_body_soft_box_add(EPhysics_World *world);
  *
  * @see ephysics_body_del().
  * @see ephysics_body_evas_object_set().
+ * @see ephysics_body_cloth_face_evas_object_set().
  * @see ephysics_world_simulation_set().
  * @see ephysics_body_cloth_anchor_add().
  * @see ephysics_body_cloth_anchor_full_add().
@@ -2429,6 +2496,12 @@ EAPI EPhysics_World *ephysics_body_world_get(const EPhysics_Body *body);
  * updates of associated evas objects, or complement updates, like changing
  * evas objects properties under certain conditions of position or rotation.
  *
+ * If it's required to associate evas object to specific faces of the body,
+ * the following functions could be used, depending on the body's shape:
+ * @li @ref ephysics_body_box_face_evas_object_set();
+ * @li @ref ephysics_body_cylinder_face_evas_object_set();
+ * @li @ref ephysics_body_cloth_face_evas_object_set().
+ *
  * @param body The body to associate to an evas object.
  * @param evas_obj The evas object that will be associated to this @p body.
  * @param use_obj_pos If @c EINA_TRUE it will set the physics body position
@@ -2475,6 +2548,185 @@ EAPI Evas_Object *ephysics_body_evas_object_get(const EPhysics_Body *body);
 
 /**
  * @brief
+ * Set an evas object to a physics box body face.
+ *
+ * It will create a direct association between a specific face of the physics
+ * body and an evas object.
+ * With that EPhysics will be able to update evas object
+ * position and rotation automatically.
+ *
+ * If it's required to associate only one evas object to this body, a more
+ * generic function @see ephysics_body_evas_object_set() can be used.
+ *
+ * @param body The body to associate to an evas object.
+ * @param face The specific face of @p body where the evas object will be
+ * placed.
+ * @param evas_obj The evas object that will be associated to this @p body.
+ * @param use_obj_pos If @c EINA_TRUE it will set the physics body position
+ * to match evas object position taking world rate on consideration.
+ *
+ * @see ephysics_body_box_face_evas_object_unset().
+ * @see ephysics_body_box_face_evas_object_get().
+ * @see ephysics_body_box_add().
+ * @see ephysics_body_soft_box_add().
+ * @see ephysics_body_evas_object_set().
+ * @see ephysics_world_rate_set().
+ *
+ * @ingroup EPhysics_Body
+ */
+EAPI void ephysics_body_box_face_evas_object_set(EPhysics_Body *body, EPhysics_Body_Box_Face face, Evas_Object *evas_obj, Eina_Bool use_obj_pos);
+
+/**
+ * @brief
+ * Get the evas object associated to a physics box body face.
+ *
+ * @param body The body to get an evas object from.
+ * @param face The specific face of @p body where the evas object was placed.
+ * @return The associated evas object, or @c NULL if no object is associated
+ * or on error.
+ *
+ * @see ephysics_body_box_face_evas_object_set() for more details.
+ *
+ * @ingroup EPhysics_Body
+ */
+EAPI Evas_Object *ephysics_body_box_face_evas_object_get(const EPhysics_Body *body, EPhysics_Body_Box_Face face);
+
+/**
+ * @brief
+ * Unset the evas object associated to a physics box body face.
+ *
+ * @param body The body to unset an evas object from.
+ * @param face The specific face of @p body where the evas object was placed.
+ * @return The associated evas object, or @c NULL if no object is associated
+ * or on error.
+ *
+ * @see ephysics_body_box_face_evas_object_set() for more details.
+ *
+ * @ingroup EPhysics_Body
+ */
+EAPI Evas_Object *ephysics_body_box_face_evas_object_unset(EPhysics_Body *body, EPhysics_Body_Box_Face face);
+
+/**
+ * @brief
+ * Set an evas object to a physics cylinder body face.
+ *
+ * It will create a direct association between a specific face of the physics
+ * body and an evas object.
+ * With that EPhysics will be able to update evas object
+ * position and rotation automatically.
+ *
+ * If it's required to associate only one evas object to this body, a more
+ * generic function @see ephysics_body_evas_object_set() can be used.
+ *
+ * @param body The body to associate to an evas object.
+ * @param face The specific face of @p body where the evas object will be
+ * placed.
+ * @param evas_obj The evas object that will be associated to this @p body.
+ * @param use_obj_pos If @c EINA_TRUE it will set the physics body position
+ * to match evas object position taking world rate on consideration.
+ *
+ * @see ephysics_body_cylinder_face_evas_object_unset().
+ * @see ephysics_body_cylinder_face_evas_object_get().
+ * @see ephysics_body_circle_add().
+ * @see ephysics_body_soft_circle_add().
+ * @see ephysics_body_evas_object_set().
+ * @see ephysics_world_rate_set().
+ *
+ * @ingroup EPhysics_Body
+ */
+EAPI void ephysics_body_cylinder_face_evas_object_set(EPhysics_Body *body, EPhysics_Body_Cylinder_Face face, Evas_Object *evas_obj, Eina_Bool use_obj_pos);
+
+/**
+ * @brief
+ * Get the evas object associated to a physics cylinder body face.
+ *
+ * @param body The body to get an evas object from.
+ * @param face The specific face of @p body where the evas object was placed.
+ * @return The associated evas object, or @c NULL if no object is associated
+ * or on error.
+ *
+ * @see ephysics_body_cylinder_face_evas_object_set() for more details.
+ *
+ * @ingroup EPhysics_Body
+ */
+EAPI Evas_Object *ephysics_body_cylinder_face_evas_object_get(const EPhysics_Body *body, EPhysics_Body_Cylinder_Face face);
+
+/**
+ * @brief
+ * Unset the evas object associated to a physics cylinder body face.
+ *
+ * @param body The body to unset an evas object from.
+ * @param face The specific face of @p body where the evas object was placed.
+ * @return The associated evas object, or @c NULL if no object is associated
+ * or on error.
+ *
+ * @see ephysics_body_cylinder_face_evas_object_set() for more details.
+ *
+ * @ingroup EPhysics_Body
+ */
+EAPI Evas_Object *ephysics_body_cylinder_face_evas_object_unset(EPhysics_Body *body, EPhysics_Body_Cylinder_Face face);
+
+/**
+ * @brief
+ * Set an evas object to a physics cloth body face.
+ *
+ * It will create a direct association between a specific face of the physics
+ * body and an evas object.
+ * With that EPhysics will be able to update evas object
+ * position and rotation automatically.
+ *
+ * If it's required to associate only one evas object to this body, a more
+ * generic function @see ephysics_body_evas_object_set() can be used.
+ *
+ * @param body The body to associate to an evas object.
+ * @param face The specific face of @p body where the evas object will be
+ * placed.
+ * @param evas_obj The evas object that will be associated to this @p body.
+ * @param use_obj_pos If @c EINA_TRUE it will set the physics body position
+ * to match evas object position taking world rate on consideration.
+ *
+ * @see ephysics_body_cloth_face_evas_object_unset().
+ * @see ephysics_body_cloth_face_evas_object_get().
+ * @see ephysics_body_cloth_add().
+ * @see ephysics_body_evas_object_set().
+ * @see ephysics_world_rate_set().
+ *
+ * @ingroup EPhysics_Body
+ */
+EAPI void ephysics_body_cloth_face_evas_object_set(EPhysics_Body *body, EPhysics_Body_Cloth_Face face, Evas_Object *evas_obj, Eina_Bool use_obj_pos);
+
+/**
+ * @brief
+ * Get the evas object associated to a physics cloth body face.
+ *
+ * @param body The body to get an evas object from.
+ * @param face The specific face of @p body where the evas object was placed.
+ * @return The associated evas object, or @c NULL if no object is associated
+ * or on error.
+ *
+ * @see ephysics_body_cloth_face_evas_object_set() for more details.
+ *
+ * @ingroup EPhysics_Body
+ */
+EAPI Evas_Object *ephysics_body_cloth_face_evas_object_get(const EPhysics_Body *body, EPhysics_Body_Cloth_Face face);
+
+/**
+ * @brief
+ * Unset the evas object associated to a physics cloth body face.
+ *
+ * @param body The body to unset an evas object from.
+ * @param face The specific face of @p body where the evas object was placed.
+ * @return The associated evas object, or @c NULL if no object is associated
+ * or on error.
+ *
+ * @see ephysics_body_cloth_face_evas_object_set() for more details.
+ *
+ * @ingroup EPhysics_Body
+ */
+EAPI Evas_Object *ephysics_body_cloth_face_evas_object_unset(EPhysics_Body *body, EPhysics_Body_Cloth_Face face);
+
+/**
+ * @brief
  * Set physics body size.
  *
  * By default circles have diameter equal to 1 meter * rate, boxes have