diff options
Diffstat (limited to 'doc/python_api/rst/bge_types/bge.types.KX_ArmatureSensor.rst')
| -rw-r--r-- | doc/python_api/rst/bge_types/bge.types.KX_ArmatureSensor.rst | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/doc/python_api/rst/bge_types/bge.types.KX_ArmatureSensor.rst b/doc/python_api/rst/bge_types/bge.types.KX_ArmatureSensor.rst new file mode 100644 index 00000000000..a7123eb5c9d --- /dev/null +++ b/doc/python_api/rst/bge_types/bge.types.KX_ArmatureSensor.rst @@ -0,0 +1,36 @@ +KX_ArmatureSensor(SCA_ISensor) +============================== + +.. module:: bge.types + +base class --- :class:`SCA_ISensor` + +.. class:: KX_ArmatureSensor(SCA_ISensor) + + Armature sensor detect conditions on armatures. + + .. attribute:: type + + The type of measurement that the sensor make when it is active. + + Can be one of :ref:`these constants <armaturesensor-type>` + + :type: integer. + + .. attribute:: constraint + + The constraint object this sensor is watching. + + :type: :class:`BL_ArmatureConstraint` + + .. attribute:: value + + The threshold used in the comparison with the constraint error + The linear error is only updated on CopyPose/Distance IK constraint with iTaSC solver + The rotation error is only updated on CopyPose+rotation IK constraint with iTaSC solver + The linear error on CopyPose is always >= 0: it is the norm of the distance between the target and the bone + The rotation error on CopyPose is always >= 0: it is the norm of the equivalent rotation vector between the bone and the target orientations + The linear error on Distance can be positive if the distance between the bone and the target is greater than the desired distance, and negative if the distance is smaller. + + :type: float + |