diff options
author | Joseph Gilbert <ascotan@gmail.com> | 2006-01-11 23:48:46 +0300 |
---|---|---|
committer | Joseph Gilbert <ascotan@gmail.com> | 2006-01-11 23:48:46 +0300 |
commit | f41c1f1c73c125840e5675b4a59f0c2594091046 (patch) | |
tree | 10a2250586b51e273618093c493e17cf9448200f /source/blender/python/api2_2x | |
parent | 31518a374b7d8449f3325e071b224e8b13bfd908 (diff) |
Forgot the pose file.... :p
Diffstat (limited to 'source/blender/python/api2_2x')
-rw-r--r-- | source/blender/python/api2_2x/doc/Pose.py | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/source/blender/python/api2_2x/doc/Pose.py b/source/blender/python/api2_2x/doc/Pose.py new file mode 100644 index 00000000000..8b03c29cc47 --- /dev/null +++ b/source/blender/python/api2_2x/doc/Pose.py @@ -0,0 +1,100 @@ +# Blender.Object.Pose module + +""" +The Blender.Object.Pose submodule. + +Pose +==== + +This module provides access to B{Pose} objects in Blender. These Pose is the +current object-level (as opposed to armature-data level) transformation. + +Example:: + + +@var ROT: +@type ROT: Constant +@var LOC: +@type LOC: Constant +@var SIZE: +@type SIZE: Constant +""" + +class Pose: + """ + The Pose object + =============== + This object gives access to Pose-specific data in Blender. + @ivar bones: A Dictionary of PosePoseBones (PoseDict) that make up this Pose. + @type bones: PoseDict Object + """ + + def update(): + """ + Save all changes and update the Pose. + @rtype: None + """ + +class PoseBonesDict: + """ + The PoseBonesDict object + ======================== + This object gives gives dictionary like access to the PoseBones in a Pose. + It is internal to blender but is called as 'Pose.bones' + """ + + def items(): + """ + Retun the key, value pairs in this dictionary + @rtype: string, PosePoseBone + @return: All strings, and PosePoseBones in the Pose (in that order) + """ + + def keys(): + """ + Retun the keys in this dictionary + @rtype: string + @return: All strings representing the PosePoseBone names + """ + + def values(): + """ + Retun the values in this dictionary + @rtype: BPy_PoseBone + @return: All PosePoseBones in this dictionary + """ + +class PoseBone: + """ + The PoseBone object + =================== + This object gives access to PoseBone-specific data in Blender. + @ivar name: The name of this PoseBone. + @type name: String + @ivar loc: The change in location for this PoseBone. + @type loc: Vector object + @ivar size: The change in size for this PoseBone (no chane is 1,1,1) + @type size: Vector object + @ivar quat: The change in rotation for this PoseBone. + @type quat: Quaternion object + @ivar localMatrix: The matrix combination of rot/quat/loc. + @type localMatrix: Matrix object + @ivar poseMatrix: The total transformation of this PoseBone including constraints. (not settable) + @type poseMatrix: Matrix object + """ + + def insertKey(parentObject, frameNumber, type): + """ + Insert a pose key for this PoseBone at a frame. + @type parentObject: Object object + @param parentObject: The object the pose came from. + @type frameNumber: integer + @param frameNumber: The frame number to insert the pose key on. + @type type: Constant object + @param type: Can be any combination of 3 Module constants: + - Pose.LOC + - Pose.ROT + - Pose.QUAT + @rtype: None + """ + |