Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorInes Almeida <britalmeida@gmail.com>2014-07-18 10:46:48 +0400
committerInes Almeida <britalmeida@gmail.com>2014-07-18 10:46:48 +0400
commita26e8f6562d2ab4064206f9da88e5dea45c189f1 (patch)
tree9b6b612236c491a81e2aa343f3f257333b18ab69 /doc
parent18841038d95f417d8cd4cee91630d077a3d8de3b (diff)
parent73079730638f1f21c04b075839d87377315e8f86 (diff)
Merge remote-tracking branch 'origin/master' into soc-2014-bge
Diffstat (limited to 'doc')
-rw-r--r--doc/python_api/rst/bge.constraints.rst10
-rw-r--r--doc/python_api/rst/bge_types/bge.types.KX_ConstraintWrapper.rst127
-rw-r--r--doc/python_api/rst/bge_types/bge.types.KX_MouseFocusSensor.rst17
3 files changed, 151 insertions, 3 deletions
diff --git a/doc/python_api/rst/bge.constraints.rst b/doc/python_api/rst/bge.constraints.rst
index 4d3e4ce880f..018be96fd14 100644
--- a/doc/python_api/rst/bge.constraints.rst
+++ b/doc/python_api/rst/bge.constraints.rst
@@ -28,6 +28,7 @@ Physics Constraints (bge.constraints)
- :class:`ANGULAR_CONSTRAINT`
- :class:`CONETWIST_CONSTRAINT`
- :class:`VEHICLE_CONSTRAINT`
+ - :class:`GENERIC_6DOF_CONSTRAINT`
:type constrainttype: int
@@ -49,7 +50,7 @@ Physics Constraints (bge.constraints)
:arg axisZ: Z axis
:type axisZ: float
- :arg flag: .. to do
+ :arg flag: 128 to disable collision between linked bodies
:type flag: int
.. attribute:: error
@@ -368,3 +369,10 @@ Physics Constraints (bge.constraints)
Constraint type to be used with function :class:`createConstraint`
.. to do
+
+.. data:: GENERIC_6DOF_CONSTRAINT
+
+ .. note::
+ Constraint type to be used with function :class:`createConstraint`
+
+ .. to do
diff --git a/doc/python_api/rst/bge_types/bge.types.KX_ConstraintWrapper.rst b/doc/python_api/rst/bge_types/bge.types.KX_ConstraintWrapper.rst
index c26675147ac..f513f50ec9c 100644
--- a/doc/python_api/rst/bge_types/bge.types.KX_ConstraintWrapper.rst
+++ b/doc/python_api/rst/bge_types/bge.types.KX_ConstraintWrapper.rst
@@ -11,8 +11,131 @@ base class --- :class:`PyObjectPlus`
.. method:: getConstraintId(val)
- Returns the contraint's ID
+ Returns the contraint ID
- :return: the constraint's ID
+ :return: the constraint ID
:rtype: integer
+ .. method:: setParam(axis, value0, value1)
+
+ Set the contraint limits
+
+ :arg axis:
+ :type axis: integer
+
+ .. note::
+ For each axis:
+ * Lowerlimit == Upperlimit -> axis is locked
+ * Lowerlimit > Upperlimit -> axis is free
+ * Lowerlimit < Upperlimit -> axis it limited in that range
+
+ PHY_LINEHINGE_CONSTRAINT = 2 or PHY_ANGULAR_CONSTRAINT = 3:
+ axis = 3 is a constraint limit, with low/high limit value
+
+ * 3: X axis angle
+
+ :arg value0 (min): Set the minimum limit of the axis
+ :type value0: float
+ :arg value1 (max): Set the maximum limit of the axis
+ :type value1: float
+
+ PHY_CONE_TWIST_CONSTRAINT = 3:
+ axis = 3..5 are constraint limits, high limit values
+ * 3: X axis angle
+ * 4: Y axis angle
+ * 5: Z axis angle
+
+ :arg value0 (min): Set the minimum limit of the axis
+ :type value0: float
+ :arg value1 (max): Set the maximum limit of the axis
+ :type value1: float
+
+ PHY_GENERIC_6DOF_CONSTRAINT = 12:
+ axis = 0..2 are constraint limits, with low/high limit value
+ * 0: X axis position
+ * 1: Y axis position
+ * 2: Z axis position
+
+ axis = 3..5 are relative constraint (Euler) angles in degrees
+ * 3: X axis angle
+ * 4: Y axis angle
+ * 5: Z axis angle
+
+ :arg value0 (min): Set the minimum limit of the axis
+ :type value0: float
+ :arg value1 (max): Set the maximum limit of the axis
+ :type value1: float
+
+ axis = 6..8 are translational motors, with value0=target velocity, value1 = max motor force
+ * 6: X axis position
+ * 7: Y axis position
+ * 8: Z axis position
+
+ axis = 9..11 are rotational motors, with value0=target velocity, value1 = max motor force
+ * 9: X axis angle
+ * 10: Y axis angle
+ * 11: Z axis angle
+
+ :arg value0 (speed): Set the linear velocity of the axis
+ :type value0: float Range: -10,000.00 to 10,000.00
+ :arg value1 (force): Set the maximum force limit of the axis
+ :type value1: float Range: -10,000.00 to 10,000.00
+
+ axis = 12..14 are for linear springs on each of the position of freedom
+ * 12: X axis position
+ * 13: Y axis position
+ * 14: Z axis position
+
+ axis = 15..17 are for angular springs on each of the degrees of freedom
+ * 15: X axis angle
+ * 16: Y axis angle
+ * 17: Z axis angle
+
+ :arg value0 (stiffness): Set the stiffness of the spring
+ :type value0: float
+ :arg value1 (damping): Tendency of the spring to return to it's original position
+ :type value1: float
+ 1.0 = springs back to original position (no damping)
+ 0.0 = don't springs back
+
+ .. method:: getParam(axis)
+
+ Get the contraint position or euler angle of a generic 6DOF constraint
+
+ :arg axis:
+ :type axis: integer
+
+ axis = 0..2 are linear constraint values
+ * 0: X axis position
+ * 1: Y axis position
+ * 2: Z axis position
+
+ :return: position
+ :rtype: float
+
+ axis = 3..5 are relative constraint (Euler) angles in degrees
+ * 3: X axis angle
+ * 4: Y axis angle
+ * 5: Z axis angle
+
+ :return: angle
+ :rtype: float
+
+ .. attribute:: constraint_id
+
+ Returns the contraint ID (read only)
+
+ :type: integer
+
+ .. attribute:: constraint_type
+
+ Returns the contraint type (read only)
+
+ :type: integer
+
+ * 1 = POINTTOPOINT_CONSTRAINT
+ * 2 = LINEHINGE_CONSTRAINT
+ * 3 = ANGULAR_CONSTRAINT (aka LINEHINGE_CONSTRAINT)
+ * 4 = CONETWIST_CONSTRAINT
+ * 11 = VEHICLE_CONSTRAINT
+ * 12 = GENERIC_6DOF_CONSTRAINT
diff --git a/doc/python_api/rst/bge_types/bge.types.KX_MouseFocusSensor.rst b/doc/python_api/rst/bge_types/bge.types.KX_MouseFocusSensor.rst
index dda73eadb52..0600a4b5aae 100644
--- a/doc/python_api/rst/bge_types/bge.types.KX_MouseFocusSensor.rst
+++ b/doc/python_api/rst/bge_types/bge.types.KX_MouseFocusSensor.rst
@@ -64,3 +64,20 @@ base class --- :class:`SCA_MouseSensor`
:type: boolean
+ .. attribute:: useXRay
+
+ If enabled it allows the sensor to see through game objects that don't have the selected property or material.
+
+ :type: boolean
+
+ .. attribute:: propName
+
+ The property or material the sensor is looking for.
+
+ :type: string
+
+ .. attribute:: useMaterial
+
+ Determines if the sensor is looking for a property or material. KX_True = Find material; KX_False = Find property.
+
+ :type: boolean