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:
authorThomas Szepe <HG1_public@gmx.net>2015-05-20 19:49:18 +0300
committerThomas Szepe <HG1_public@gmx.net>2015-05-20 19:49:18 +0300
commit093d11df351d84936903bf8601309aca02092f81 (patch)
treee452297b0fea3c9738cffe1c95a4f2f6b766cda7 /doc
parent2c5d5a9febf1b8faea7ddb4b68f6aec31ef6c2cd (diff)
BGE: Some changes for the constraint document
* Change the constraint type alignment to vertical. * Changed PHY_CONE_TWIST_CONSTRAINT to the correct value. * Some minor changes.
Diffstat (limited to 'doc')
-rw-r--r--doc/python_api/rst/bge.constraints.rst50
-rw-r--r--doc/python_api/rst/bge_types/bge.types.KX_ConstraintWrapper.rst18
2 files changed, 35 insertions, 33 deletions
diff --git a/doc/python_api/rst/bge.constraints.rst b/doc/python_api/rst/bge.constraints.rst
index eaaf806a4a9..14ebc61dbf5 100644
--- a/doc/python_api/rst/bge.constraints.rst
+++ b/doc/python_api/rst/bge.constraints.rst
@@ -15,41 +15,43 @@ Physics Constraints (bge.constraints)
Creates a constraint.
- :arg physicsid_1: the physics id of the first object in constraint
- :type physicsid: int
-
- :arg physicsid_2: the physics id of the second object in constraint
- :type physicsid2: int
-
- :arg constrainttype: the type of the constraint. The constraint types are:
- :type constrainttype: int
+ Constraints types:
- :class:`POINTTOPOINT_CONSTRAINT`
- :class:`LINEHINGE_CONSTRAINT`
- :class:`ANGULAR_CONSTRAINT`
- :class:`CONETWIST_CONSTRAINT`
- :class:`VEHICLE_CONSTRAINT`
- - :class:`GENERIC_6DOF_CONSTRAINT`
-
- :arg pivot_X: pivot X position
- :type pivot_X: float (optional)
+ - :class:`GENERIC_6DOF_CONSTRAINT`
+
+ :arg physicsid_1: the physics id of the first object in constraint.
+ :type physicsid_1: int
+
+ :arg physicsid_2: the physics id of the second object in constraint.
+ :type physicsid_2: int
+
+ :arg constrainttype: the type of the constraint.
+ :type constrainttype: int
+
+ :arg pivot_X: pivot X position (optional).
+ :type pivot_X: float
- :arg pivot_Y: pivot Y position
- :type pivot_Y: float (optional)
+ :arg pivot_Y: pivot Y position (optional).
+ :type pivot_Y: float
- :arg pivot_Z: pivot Z position
- :type pivot_Z: float (optional)
+ :arg pivot_Z: pivot Z position (optional).
+ :type pivot_Z: float
- :arg axis_X: X axis angle in degrees
- :type axis_X: float (optional)
+ :arg axis_X: X axis angle in degrees (optional).
+ :type axis_X: float
- :arg axis_Y: Y axis angle in degrees
- :type axis_Y: float (optional)
+ :arg axis_Y: Y axis angle in degrees (optional).
+ :type axis_Y: float
- :arg axis_Z: Z axis angle in degrees
- :type axis_Z: float (optional)
+ :arg axis_Z: Z axis angle in degrees (optional).
+ :type axis_Z: float
- :arg flag: 128 to disable collision between linked bodies
- :type flag: int (optional)
+ :arg flag: 128 to disable collision between linked bodies (optional).
+ :type flag: int
:return: a constraint wrapper.
:rtype: :class:`bge.types.KX_ConstraintWrapper`
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 588f568cbb0..59bd836d90e 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
@@ -28,7 +28,7 @@ base class --- :class:`PyObjectPlus`
* Lowerlimit > Upperlimit -> axis is free
* Lowerlimit < Upperlimit -> axis it limited in that range
- PHY_LINEHINGE_CONSTRAINT = 2 or PHY_ANGULAR_CONSTRAINT = 3:
+ For PHY_LINEHINGE_CONSTRAINT = 2 or PHY_ANGULAR_CONSTRAINT = 3:
axis = 3 is a constraint limit, with low/high limit value
* 3: X axis angle
@@ -38,7 +38,7 @@ base class --- :class:`PyObjectPlus`
:arg value1 (max): Set the maximum limit of the axis
:type value1: float
- PHY_CONE_TWIST_CONSTRAINT = 3:
+ For PHY_CONE_TWIST_CONSTRAINT = 4:
axis = 3..5 are constraint limits, high limit values
* 3: X axis angle
@@ -50,7 +50,7 @@ base class --- :class:`PyObjectPlus`
:arg value1 (max): Set the maximum limit of the axis
:type value1: float
- PHY_GENERIC_6DOF_CONSTRAINT = 12:
+ For PHY_GENERIC_6DOF_CONSTRAINT = 12:
axis = 0..2 are constraint limits, with low/high limit value
* 0: X axis position
@@ -133,10 +133,10 @@ base class --- :class:`PyObjectPlus`
Returns the contraint type (read only)
:type: integer
- - 1 = :class:`~bge.constraints.POINTTOPOINT_CONSTRAINT`
- - 2 = :class:`~bge.constraints.LINEHINGE_CONSTRAINT`
- - 3 = :class:`~bge.constraints.ANGULAR_CONSTRAINT`
- - 4 = :class:`~bge.constraints.CONETWIST_CONSTRAINT`
- - 11 = :class:`~bge.constraints.VEHICLE_CONSTRAINT`
- - 12 = :class:`~bge.constraints.GENERIC_6DOF_CONSTRAINT`
+ - 1 = :class:`~bge.constraints.POINTTOPOINT_CONSTRAINT`
+ - 2 = :class:`~bge.constraints.LINEHINGE_CONSTRAINT`
+ - 3 = :class:`~bge.constraints.ANGULAR_CONSTRAINT`
+ - 4 = :class:`~bge.constraints.CONETWIST_CONSTRAINT`
+ - 11 = :class:`~bge.constraints.VEHICLE_CONSTRAINT`
+ - 12 = :class:`~bge.constraints.GENERIC_6DOF_CONSTRAINT`