Changeset 11638 for code/branches/ScriptableController_HS17/src/orxonox/scriptablecontroller/scriptable_controller_api.h

Timestamp:

Dec 4, 2017, 4:17:59 PM (6 years ago)

Author:

kohlia

Message:

Position/velocity setting works now, relative script paths not, added test script

File:

• code/branches/ScriptableController_HS17/src/orxonox/scriptablecontroller/scriptable_controller_api.h (modified) (2 diffs)

code/branches/ScriptableController_HS17/src/orxonox/scriptablecontroller/scriptable_controller_api.h

@@ -39 +39 @@
     ~ScriptableControllerAPI();
 
-    // --- API ----------------------------------
+// ### API ####################################################################
 
     /**
@@ -139 +139 @@
     void killPawn(std::string id);
 
-    // ------------------------------------------
+    /**
+     * @brief Set the position of an object
+     * @param id The ID of the object
+     * @param x The position on the x-axis
+     * @param y The position on the y-axis
+     * @param z The position on the z-axis
+     */
+    void setPosition(std::string id, double x, double y, double z);
+
+    /**
+     * @brief Set the orientation of an object
+     * @param id The ID of the object
+     * @param x The x component of the axis vector
+     * @param y The y component of the axis vector
+     * @param z The z component of the axis vector
+     * @param angle The angle around the axis
+     *
+     * To set the orientation, you have to specify the direction that the
+     * object should be facing with the vector (x, y, z) and the rotation
+     * of the object around this axis with 'angle', which has to be given
+     * in degrees, NOT radian. The vector does not have to be normalized.
+     */
+    void setOrientation(std::string id, double x, double y, double z, double angle);
+
+    /**
+     * @brief Set the velocity of an object
+     * @param id The ID of the object
+     * @param x The velocity in x-direction
+     * @param y The velocity in y-direction
+     * @param z The velocity in z-direction
+     *
+     * The velocity is in units per second.
+     */
+    void setVelocity(std::string id, double x, double y, double z);
+
+    /**
+     * @brief Set the angular velocity of an object
+     * @param id The ID of the object
+     * @param x The rotation velocity around the x-axis
+     * @param y The rotation velocity around the y-axis
+     * @param z The rotation velocity around the z-axis
+     */
+    void setAngularVelocity(std::string id, double x, double y, double z);
+
+// ### API END ################################################################
 
     /**