[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [22993] branches/itasc/source/gameengine/ PyDoc/GameTypes.py: fix PyDoc syntax
Benoit Bolsee
benoit.bolsee at online.be
Fri Sep 4 16:14:39 CEST 2009
Revision: 22993
http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=22993
Author: ben2610
Date: 2009-09-04 16:14:39 +0200 (Fri, 04 Sep 2009)
Log Message:
-----------
fix PyDoc syntax
Modified Paths:
--------------
branches/itasc/source/gameengine/PyDoc/GameTypes.py
Modified: branches/itasc/source/gameengine/PyDoc/GameTypes.py
===================================================================
--- branches/itasc/source/gameengine/PyDoc/GameTypes.py 2009-09-04 12:56:30 UTC (rev 22992)
+++ branches/itasc/source/gameengine/PyDoc/GameTypes.py 2009-09-04 14:14:39 UTC (rev 22993)
@@ -5711,14 +5711,24 @@
"""
Armature Actuators change constraint condition on armatures.
- @group Constant: KX_ACT_ARMATURE_RUN, KX_ACT_ARMATURE_ENABLE, KX_ACT_ARMATURE_DISABLE, KX_ACT_ARMATURE_SETTARGET, KX_ACT_ARMATURE_SETWEIGHT
- @ivar type: The type of action that the actuator executes when it is active.
- KX_ACT_ARMATURE_RUN: just make sure the armature will be updated on the next graphic frame
- This is the only persistent mode of the actuator: it executes automatically once per frame until stopped by a controller
- KX_ACT_ARMATURE_ENABLE: enable the constraint.
- KX_ACT_ARMATURE_DISABLE: disable the constraint (runtime constraint values are not updated).
- KX_ACT_ARMATURE_SETTARGET: change target and subtarget of constraint
- KX_ACT_ARMATURE_SETWEIGHT: change weight of (only for IK constraint)
+ @group Constants: KX_ACT_ARMATURE_RUN, KX_ACT_ARMATURE_ENABLE, KX_ACT_ARMATURE_DISABLE, KX_ACT_ARMATURE_SETTARGET, KX_ACT_ARMATURE_SETWEIGHT
+ @ivar KX_ACT_ARMATURE_RUN: see type
+ @ivar KX_ACT_ARMATURE_ENABLE: see type
+ @ivar KX_ACT_ARMATURE_DISABLE: see type
+ @ivar KX_ACT_ARMATURE_SETTARGET: see type
+ @ivar KX_ACT_ARMATURE_SETWEIGHT: see type
+ @ivar type: The type of action that the actuator executes when it is active.
+
+ KX_ACT_ARMATURE_RUN(0): just make sure the armature will be updated on the next graphic frame
+ This is the only persistent mode of the actuator: it executes automatically once per frame until stopped by a controller
+
+ KX_ACT_ARMATURE_ENABLE(1): enable the constraint.
+
+ KX_ACT_ARMATURE_DISABLE(2): disable the constraint (runtime constraint values are not updated).
+
+ KX_ACT_ARMATURE_SETTARGET(3): change target and subtarget of constraint
+
+ KX_ACT_ARMATURE_SETWEIGHT(4): change weight of (only for IK constraint)
@type type: integer
@ivar constraint: The constraint object this actuator is controlling.
@type constraint: L{BL_ArmatureConstraint}
@@ -5737,13 +5747,23 @@
"""
Armature sensor detect conditions on armatures.
- @group Constant: KX_ARMSENSOR_STATE_CHANGED(0), KX_ARMSENSOR_LIN_ERROR_BELOW(1), KX_ARMSENSOR_LIN_ERROR_ABOVE(2), KX_ARMSENSOR_ROT_ERROR_BELOW(3), KX_ARMSENSOR_ROT_ERROR_ABOVE(4)
+ @group Constants: KX_ARMSENSOR_STATE_CHANGED, KX_ARMSENSOR_LIN_ERROR_BELOW, KX_ARMSENSOR_LIN_ERROR_ABOVE, KX_ARMSENSOR_ROT_ERROR_BELOW, KX_ARMSENSOR_ROT_ERROR_ABOVE
+ @ivar KX_ARMSENSOR_STATE_CHANGED: see type
+ @ivar KX_ARMSENSOR_LIN_ERROR_BELOW: see type
+ @ivar KX_ARMSENSOR_LIN_ERROR_ABOVE: see type
+ @ivar KX_ARMSENSOR_ROT_ERROR_BELOW: see type
+ @ivar KX_ARMSENSOR_ROT_ERROR_ABOVE: see type
@ivar type: The type of measurement that the sensor make when it is active.
- KX_ARMSENSOR_STATE_CHANGED: detect that the constraint is changing state (active/inactive)
- KX_ARMSENSOR_LIN_ERROR_BELOW: detect that the constraint linear error is above a threshold
- KX_ARMSENSOR_LIN_ERROR_ABOVE: detect that the constraint linear error is below a threshold
- KX_ARMSENSOR_ROT_ERROR_BELOW: detect that the constraint rotation error is above a threshold
- KX_ARMSENSOR_ROT_ERROR_ABOVE: detect that the constraint rotation error is below a threshold
+
+ KX_ARMSENSOR_STATE_CHANGED(0): detect that the constraint is changing state (active/inactive)
+
+ KX_ARMSENSOR_LIN_ERROR_BELOW(1): detect that the constraint linear error is above a threshold
+
+ KX_ARMSENSOR_LIN_ERROR_ABOVE(2): detect that the constraint linear error is below a threshold
+
+ KX_ARMSENSOR_ROT_ERROR_BELOW(3): detect that the constraint rotation error is above a threshold
+
+ KX_ARMSENSOR_ROT_ERROR_ABOVE(4): detect that the constraint rotation error is below a threshold
@type type: integer
@ivar constraint: The constraint object this sensor is watching.
@type constraint: L{BL_ArmatureConstraint}
@@ -5752,7 +5772,7 @@
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
+ 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 value: float
"""
@@ -5761,55 +5781,81 @@
Proxy to Armature Constraint. Allows to change constraint on the fly.
Not all armature constraint are supported in the GE.
- @group Constant: CONSTRAINT_TYPE_TRACKTO, CONSTRAINT_TYPE_KINEMATIC, CONSTRAINT_TYPE_ROTLIKE, CONSTRAINT_TYPE_LOCLIKE, CONSTRAINT_TYPE_MINMAX, CONSTRAINT_TYPE_SIZELIKE, CONSTRAINT_TYPE_LOCKTRACK, CONSTRAINT_TYPE_STRETCHTO, CONSTRAINT_TYPE_CLAMPTO, CONSTRAINT_TYPE_TRANSFORM, CONSTRAINT_TYPE_DISTLIMIT,
- CONSTRAINT_IK_COPYPOSE(0), CONSTRAINT_IK_DISTANCE(1),
- CONSTRAINT_IK_MODE_INSIDE(0), CONSTRAINT_IK_MODE_OUTSIDE(1), CONSTRAINT_IK_MODE_ONSURFACE(2),
- CONSTRAINT_IK_FLAG_TIP(1), CONSTRAINT_IK_FLAG_ROT(2), CONSTRAINT_IK_FLAG_STRETCH(16), CONSTRAINT_IK_FLAG_POS(32)
+ @group Constants: CONSTRAINT_TYPE_TRACKTO, CONSTRAINT_TYPE_KINEMATIC, CONSTRAINT_TYPE_ROTLIKE, CONSTRAINT_TYPE_LOCLIKE, CONSTRAINT_TYPE_MINMAX, CONSTRAINT_TYPE_SIZELIKE, CONSTRAINT_TYPE_LOCKTRACK, CONSTRAINT_TYPE_STRETCHTO, CONSTRAINT_TYPE_CLAMPTO, CONSTRAINT_TYPE_TRANSFORM, CONSTRAINT_TYPE_DISTLIMIT,CONSTRAINT_IK_COPYPOSE, CONSTRAINT_IK_DISTANCE,CONSTRAINT_IK_MODE_INSIDE, CONSTRAINT_IK_MODE_OUTSIDE,CONSTRAINT_IK_MODE_ONSURFACE,CONSTRAINT_IK_FLAG_TIP,CONSTRAINT_IK_FLAG_ROT, CONSTRAINT_IK_FLAG_STRETCH, CONSTRAINT_IK_FLAG_POS
+ @ivar CONSTRAINT_TYPE_TRACKTO: see type
+ @ivar CONSTRAINT_TYPE_KINEMATIC: see type
+ @ivar CONSTRAINT_TYPE_ROTLIKE: see type
+ @ivar CONSTRAINT_TYPE_LOCLIKE: see type
+ @ivar CONSTRAINT_TYPE_MINMAX: see type
+ @ivar CONSTRAINT_TYPE_SIZELIKE: see type
+ @ivar CONSTRAINT_TYPE_LOCKTRACK: see type
+ @ivar CONSTRAINT_TYPE_STRETCHTO: see type
+ @ivar CONSTRAINT_TYPE_CLAMPTO: see type
+ @ivar CONSTRAINT_TYPE_TRANSFORM: see type
+ @ivar CONSTRAINT_TYPE_DISTLIMIT: see type
+ @ivar CONSTRAINT_IK_COPYPOSE: see ik_type
+ @ivar CONSTRAINT_IK_DISTANCE: see ik_type
+ @ivar CONSTRAINT_IK_MODE_INSIDE: see ik_mode
+ @ivar CONSTRAINT_IK_MODE_OUTSIDE: see ik_mode
+ @ivar CONSTRAINT_IK_MODE_ONSURFACE: see ik_mode
+ @ivar CONSTRAINT_IK_FLAG_TIP: see ik_flag
+ @ivar CONSTRAINT_IK_FLAG_ROT: see ik_flag
+ @ivar CONSTRAINT_IK_FLAG_STRETCH: see ik_flag
+ @ivar CONSTRAINT_IK_FLAG_POS: see ik_flag
@ivar type: Type of constraint, read-only
- @itype type: integer, one of CONSTRAINT_TYPE_ constant
+ @type type: integer, one of CONSTRAINT_TYPE_ constant
@ivar name: Name of constraint constructed as <bone_name>:<constraint_name>
This name is also the key subscript on L{BL_ArmatureObject}.constraints list
- @itype name: string
+ @type name: string
@ivar enforce: fraction of constraint effect that is enforced. Between 0 and 1.
- @itype enforce: float
+ @type enforce: float
@ivar headtail: position of target between head and tail of the target bone: 0=head, 1=tail
Only used if the target is a bone (i.e target object is an armature)
- @itype headtail: float
+ @type headtail: float
@ivar lin_error: runtime linear error (in Blender unit) on constraint at the current frame.
This is a runtime value updated on each frame by the IK solver. Only available on IK constraint and iTaSC solver.
- @itype lin_error: float
+ @type lin_error: float
@ivar rot_error: runtime rotation error (in radiant) on constraint at the current frame.
This is a runtime value updated on each frame by the IK solver. Only available on IK constraint and iTaSC solver.
It is only set if the constraint has a rotation part, for example, a CopyPose+Rotation IK constraint.
- @itype rot_error: float
+ @type rot_error: float
@ivar target: Primary target object for the constraint. The position of this object in the GE will be used as target for the constraint.
- @itype target: L{KX_GameObject}
+ @type target: L{KX_GameObject}
@ivar subtarget: Secondary target object for the constraint. The position of this object in the GE will be used as secondary target for the constraint.
Currently this is only used for pole target on IK constraint.
- @itype subtarget: L{KX_GameObject}
+ @type subtarget: L{KX_GameObject}
@ivar active: True if the constraint is active.
Note: an inactive constraint does not update lin_error and rot_error.
- @itype active: boolean
+ @type active: boolean
@ivar ik_weight: Weight of the IK constraint between 0 and 1.
Only defined for IK constraint.
- @itype ik_weight: float
+ @type ik_weight: float
@ivar ik_type: Type of IK constraint, read-only
- CONSTRAINT_IK_COPYPOSE: constraint is trying to match the position and eventually the rotation of the target.
- CONSTRAINT_IK_DISTANCE: constraint is maintaining a certain distance to target subject to ik_mode
- @itype ik_type: integer
+
+ CONSTRAINT_IK_COPYPOSE(0): constraint is trying to match the position and eventually the rotation of the target.
+
+ CONSTRAINT_IK_DISTANCE(1): constraint is maintaining a certain distance to target subject to ik_mode
+ @type ik_type: integer
@ivar ik_flag: Combination of IK constraint option flags, read-only
- CONSTRAINT_IK_FLAG_TIP : set when the constraint operates on the head of the bone and not the tail
- CONSTRAINT_IK_FLAG_ROT : set when the constraint tries to match the orientation of the target
- CONSTRAINT_IK_FLAG_STRETCH : set when the armature is allowed to stretch (only the bones with stretch factor > 0.0)
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list