svn merge -r 15392:15551 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[blender.git] / source / gameengine / PyDoc / KX_GameObject.py
index ec7496daa75e05081502fa917b3746154a4168a7..37c188b7f2249cdfa2ae8ded824f592b92d942de 100644 (file)
@@ -90,15 +90,26 @@ class KX_GameObject:
                                        - 1: Y axis
                                        - 2: Z axis (default) 
                """
+       def getAxisVect(vect):
+               """
+               Returns the axis vector rotates by the objects worldspace orientation.
+               This is the equivalent if multiplying the vector by the orientation matrix.
+               
+               @type vect: 3d vector.
+               @param vect: a vector to align the axis.
+               @rtype: 3d vector.
+               @return: The vector in relation to the objects rotation.
+
+               """
        def getOrientation():
                """
                Gets the game object's orientation.
                
-               @rtype: 3x3 inverted rotation matrix
+               @rtype: 3x3 rotation matrix
                @return: The game object's rotation matrix
                @note: When using this matrix with Blender.Mathutils.Matrix() types, it will need to be transposed.
                """
-       def getLinearVelocity(local):
+       def getLinearVelocity(local = 0):
                """
                Gets the game object's linear velocity.
                
@@ -106,11 +117,24 @@ class KX_GameObject:
                ie no angular velocity component.
                
                @type local: boolean
-               @param local: - False: you get the "global" velocity ie: relative to world orientation.
+               @param local: - False: you get the "global" velocity ie: relative to world orientation (default).
                              - True: you get the "local" velocity ie: relative to object orientation.
                @rtype: list [vx, vy, vz]
                @return: the object's linear velocity.
                """
+       def setLinearVelocity(velocity, local = 0):
+               """
+               Sets the game object's linear velocity.
+               
+               This method sets game object's velocity through it's centre of mass,
+               ie no angular velocity component.
+               
+               @type velocity: 3d vector.
+               @param velocity: linear velocity vector.
+               @type local: boolean
+               @param local: - False: you get the "global" velocity ie: relative to world orientation (default).
+                             - True: you get the "local" velocity ie: relative to object orientation.
+               """
        def getVelocity(point):
                """
                Gets the game object's velocity at the specified point.
@@ -158,16 +182,19 @@ class KX_GameObject:
        def restoreDynamics():
                """
                Resumes physics for this object.
+               @Note: The objects linear velocity will be applied from when the dynamics were suspended.
                """
        def enableRigidBody():
                """
                Enables rigid body physics for this object.
                
                Rigid body physics allows the object to roll on collisions.
+               @Note: This is not working with bullet physics yet.
                """
        def disableRigidBody():
                """
                Disables rigid body physics for this object.
+               @Note: This is not working with bullet physics yet. The angular is removed but rigid body physics can still rotate it later.
                """
        def getParent():
                """