[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [52467] trunk/blender/doc/python_api/rst: BGE Docs: Moving the BL_ArmatureChannel. rotation_mode constant docs from bge.types.rst to bge.logic. rst where the rest of the constants docs are.
Mitchell Stokes
mogurijin at gmail.com
Thu Nov 22 09:16:33 CET 2012
Revision: 52467
http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=52467
Author: moguri
Date: 2012-11-22 08:16:30 +0000 (Thu, 22 Nov 2012)
Log Message:
-----------
BGE Docs: Moving the BL_ArmatureChannel.rotation_mode constant docs from bge.types.rst to bge.logic.rst where the rest of the constants docs are.
Modified Paths:
--------------
trunk/blender/doc/python_api/rst/bge.logic.rst
trunk/blender/doc/python_api/rst/bge.types.rst
Modified: trunk/blender/doc/python_api/rst/bge.logic.rst
===================================================================
--- trunk/blender/doc/python_api/rst/bge.logic.rst 2012-11-22 08:07:13 UTC (rev 52466)
+++ trunk/blender/doc/python_api/rst/bge.logic.rst 2012-11-22 08:16:30 UTC (rev 52467)
@@ -993,6 +993,59 @@
.. data:: BL_ZERO
----------------
+Armature Channel
+----------------
+.. _armaturechannel-constants-rotation-mode:
+
+ See :class:`bge.types.BL_ArmatureChannel.rotation_mode`
+
+ .. note:
+ euler mode are named as in Blender UI but the actual axis order is reversed
+
+ .. data:: ROT_QUAT
+
+ Use quaternion in rotation attribute to update bone rotation.
+
+ :value: 0
+
+ .. data:: ROT_XYZ
+
+ Use euler_rotation and apply angles on bone's Z, Y, X axis successively.
+
+ :value: 1
+
+ .. data:: ROT_XZY
+
+ Use euler_rotation and apply angles on bone's Y, Z, X axis successively.
+
+ :value: 2
+
+ .. data:: ROT_YXZ
+
+ Use euler_rotation and apply angles on bone's Z, X, Y axis successively.
+
+ :value: 3
+
+ .. data:: ROT_YZX
+
+ Use euler_rotation and apply angles on bone's X, Z, Y axis successively.
+
+ :value: 4
+
+ .. data:: ROT_ZXY
+
+ Use euler_rotation and apply angles on bone's Y, X, Z axis successively.
+
+ :value: 5
+
+ .. data:: ROT_ZYX
+
+ Use euler_rotation and apply angles on bone's X, Y, Z axis successively.
+
+ :value: 6
+
+
+----------------
Armature Constraint
----------------
.. _armatureconstraint-constants-type:
Modified: trunk/blender/doc/python_api/rst/bge.types.rst
===================================================================
--- trunk/blender/doc/python_api/rst/bge.types.rst 2012-11-22 08:07:13 UTC (rev 52466)
+++ trunk/blender/doc/python_api/rst/bge.types.rst 2012-11-22 08:16:30 UTC (rev 52467)
@@ -4812,16 +4812,6 @@
Proxy to armature pose channel. Allows to read and set armature pose.
The attributes are identical to RNA attributes, but mostly in read-only mode.
- See :data:`rotation_mode`
-
- .. data:: PCHAN_ROT_QUAT
- .. data:: PCHAN_ROT_XYZ
- .. data:: PCHAN_ROT_XZY
- .. data:: PCHAN_ROT_YXZ
- .. data:: PCHAN_ROT_YZX
- .. data:: PCHAN_ROT_ZXY
- .. data:: PCHAN_ROT_ZYX
-
.. attribute:: name
channel name (=bone name), read-only.
@@ -4955,18 +4945,8 @@
Method of updating the bone rotation, read-write.
- :type: integer
+ :type: integer (one of :ref:`these constants <armaturechannel-constants-rotation-mode>`)
- Use the following constants (euler mode are named as in Blender UI but the actual axis order is reversed).
-
- * PCHAN_ROT_QUAT(0) : use quaternioin in rotation attribute to update bone rotation
- * PCHAN_ROT_XYZ(1) : use euler_rotation and apply angles on bone's Z, Y, X axis successively
- * PCHAN_ROT_XZY(2) : use euler_rotation and apply angles on bone's Y, Z, X axis successively
- * PCHAN_ROT_YXZ(3) : use euler_rotation and apply angles on bone's Z, X, Y axis successively
- * PCHAN_ROT_YZX(4) : use euler_rotation and apply angles on bone's X, Z, Y axis successively
- * PCHAN_ROT_ZXY(5) : use euler_rotation and apply angles on bone's Y, X, Z axis successively
- * PCHAN_ROT_ZYX(6) : use euler_rotation and apply angles on bone's X, Y, Z axis successively
-
.. attribute:: channel_matrix
pose matrix in bone space (deformation of the bone due to action, constraint, etc), Read-only.
More information about the Bf-blender-cvs
mailing list