- Armature documentation update

This commit is contained in:
Joseph Gilbert 2004-04-06 01:01:34 +00:00
parent 2410de683f
commit 3c28f2f917

@ -93,6 +93,7 @@ class Bone:
@cvar quat: This Bone's quaternion. @cvar quat: This Bone's quaternion.
@cvar parent: The parent Bone. @cvar parent: The parent Bone.
@cvar children: The children bones. @cvar children: The children bones.
@cvar weight: The bone's weight.
""" """
def getName(): def getName():
@ -136,7 +137,7 @@ class Bone:
def getQuat(): def getQuat():
""" """
Get this Bone's quaternion. Get this Bone's quaternion.
@rtype: list of four floats. @rtype: Quaternion object.
""" """
def hasParent(): def hasParent():
@ -151,6 +152,12 @@ class Bone:
@rtype: Blender Bone @rtype: Blender Bone
""" """
def getWeight():
"""
Get the bone's weight.
@rtype: float
"""
def getChildren(): def getChildren():
""" """
Get this Bone's children Bones, if available. Get this Bone's children Bones, if available.
@ -217,17 +224,11 @@ class Bone:
@param z: The new z value. @param z: The new z value.
""" """
def setQuat(real,imag_i,imag_j,imag_k): def setQuat(quat):
""" """
Set the new quaternion orientation for this Bone. Set the new quaternion for this Bone.
@type real: float @type quat: Quaternion object or PyList of floats
@type imag_i: float @param quat: Can be a Quaternion or PyList of 4 floats.
@type imag_j: float
@type imag_k: float
@param real: The new quat[0] value.
@param imag_i: The new quat[1] value.
@param imag_j: The new quat[2] value.
@param imag_k: The new quat[3] value.
""" """
def setParent(bone): def setParent(bone):
@ -236,3 +237,10 @@ class Bone:
@type bone: PyBone @type bone: PyBone
@param bone: The Python bone that is the parent to this bone. @param bone: The Python bone that is the parent to this bone.
""" """
def setWeight(weight):
"""
Set the bones's weight.
@type weight: float
@param weight: set the the bone's weight.
"""