forked from bartvdbraak/blender
- documentation for armature/bone methods update
This commit is contained in:
parent
136b66c19f
commit
381605be7d
@ -46,7 +46,7 @@ class Armature:
|
|||||||
===================
|
===================
|
||||||
This object gives access to Armature-specific data in Blender.
|
This object gives access to Armature-specific data in Blender.
|
||||||
@cvar name: The Armature name.
|
@cvar name: The Armature name.
|
||||||
@cvar bones: The Armature root bones (cannot be set yet).
|
@cvar bones: A List of Bones that make up this armature.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def getName():
|
def getName():
|
||||||
@ -64,15 +64,19 @@ class Armature:
|
|||||||
|
|
||||||
def getBones():
|
def getBones():
|
||||||
"""
|
"""
|
||||||
Get the Armature root bones.
|
Get all the Armature bones.
|
||||||
@rtype: list of Blender Bones
|
@rtype: PyList
|
||||||
@return: a list of Armature bones.
|
@return: a list of PyBone objects that make up the armature.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def setBones(bones):
|
def addBone(bone):
|
||||||
"""
|
"""
|
||||||
Set the Armature root bones (still unimplemented).
|
Add a bone to the armature.
|
||||||
@warn: This method wasn't implemented yet.
|
@type bone: PyBone
|
||||||
|
@param bone: The Python Bone to add to the armature.
|
||||||
|
@warn: If a bone is added to the armature with no parent
|
||||||
|
if will not be parented. You should set the parent of the bone
|
||||||
|
before adding to the armature.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
class Bone:
|
class Bone:
|
||||||
@ -101,6 +105,8 @@ class Bone:
|
|||||||
"""
|
"""
|
||||||
Get the roll value.
|
Get the roll value.
|
||||||
@rtype: float
|
@rtype: float
|
||||||
|
@warn: Roll values are local to parent's objectspace when
|
||||||
|
bones are parented.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def getHead():
|
def getHead():
|
||||||
@ -163,6 +169,8 @@ class Bone:
|
|||||||
Set the roll value.
|
Set the roll value.
|
||||||
@type roll: float
|
@type roll: float
|
||||||
@param roll: The new value.
|
@param roll: The new value.
|
||||||
|
@warn: Roll values are local to parent's objectspace when
|
||||||
|
bones are parented.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def setHead(x,y,z):
|
def setHead(x,y,z):
|
||||||
@ -221,3 +229,10 @@ class Bone:
|
|||||||
@param imag_j: The new quat[2] value.
|
@param imag_j: The new quat[2] value.
|
||||||
@param imag_k: The new quat[3] value.
|
@param imag_k: The new quat[3] value.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
def setParent(bone):
|
||||||
|
"""
|
||||||
|
Set the bones's parent in the armature.
|
||||||
|
@type bone: PyBone
|
||||||
|
@param bone: The Python bone that is the parent to this bone.
|
||||||
|
"""
|
||||||
|
Loading…
Reference in New Issue
Block a user