Home       Trees       Index       Help   

Blender

Module Pose :: Class PoseBone
[frames | no frames]

Class PoseBone

The PoseBone object

This object gives access to PoseBone-specific data in Blender.
Method Summary
None insertKey(parentObject, frameNumber, type, fast)
Insert a pose key for this PoseBone at a frame.

Instance Variable Summary
BPy_ConstraintSeq constraints: a sequence of constraints for the object
Object or None displayObject: The object to display in place of the bone.
bool hasIK: True if this pose bone is a part of an IK (readonly), when False, other IK related values have no affect.
Vector object head: The final head location for this PoseBone.
3-item sequence limitmax: The x,y,z maximum limits on rotation when part of an IK
3-item sequence limitmin: The x,y,z minimum limits on rotation when part of an IK
bool limitX: Limit rotation over X axis when part of an IK.
bool limitY: Limit rotation over Y axis when part of an IK.
bool limitZ: Limit rotation over Z axis when part of an IK.
Vector object loc: The change in location for this PoseBone.
Matrix object localMatrix: The matrix combination of rot/size/loc.
bool lockXRot: Disable X DoF when part of an IK.
bool lockYRot: Disable Y DoF when part of an IK.
bool lockZRot: Disable Z DoF when part of an IK.
String name: The name of this PoseBone.
posebone or None parent: The parent of this posebone (not settable)
Matrix object poseMatrix: The total transformation of this PoseBone including constraints.
Quaternion object quat: The change in rotation for this PoseBone.
Boolean sel: The selection state of this bone
Vector object size: The change in size for this PoseBone (no change is 1,1,1)
float stiffX: The x stiffness when part of an IK [0.0 - 0.990]
float stiffY: The x stiffness when part of an IK [0.0 - 0.990]
float stiffZ: The x stiffness when part of an IK [0.0 - 0.990]
float stretch: The amount to stretch to the ik target when part of an IK [0.0 - 1.0]
Vector object tail: The final tail location for this PoseBone.

Method Details

insertKey(parentObject, frameNumber, type='[Pose.LOC, Pose.ROT, Pose.SIZE]', fast=False)

Insert a pose key for this PoseBone at a frame.
Parameters:
parentObject - The object the pose came from.
           (type=Object object)
frameNumber - The frame number to insert the pose key on.
           (type=integer)
type - Optional argumentm. Can be any combination of 3 Module constants:
  • Pose.LOC
  • Pose.ROT (This adds keyframes to the quat ipo, since quaternions are used for pose bone rotation)
  • Pose.SIZE
If this argument is omitted all keys will be added.
           (type=Constant object)
fast - If enabled, the IPOs will not be recalculated, speeds up adding many keyframes at once.
           (type=Bool)
Returns:
None

Instance Variable Details

constraints

a sequence of constraints for the object
Type:
BPy_ConstraintSeq

displayObject

The object to display in place of the bone. (custom bones)
Type:
Object or None

hasIK

True if this pose bone is a part of an IK (readonly), when False, other IK related values have no affect.
Type:
bool

head

The final head location for this PoseBone. (not settable)
Type:
Vector object

limitmax

The x,y,z maximum limits on rotation when part of an IK
Type:
3-item sequence

limitmin

The x,y,z minimum limits on rotation when part of an IK
Type:
3-item sequence

limitX

Limit rotation over X axis when part of an IK.
Type:
bool

limitY

Limit rotation over Y axis when part of an IK.
Type:
bool

limitZ

Limit rotation over Z axis when part of an IK.
Type:
bool

loc

The change in location for this PoseBone. this is the equivilent of bone.getLoc() in the old 2.3x python api.
Type:
Vector object

localMatrix

The matrix combination of rot/size/loc.
Type:
Matrix object

lockXRot

Disable X DoF when part of an IK.
Type:
bool

lockYRot

Disable Y DoF when part of an IK.
Type:
bool

lockZRot

Disable Z DoF when part of an IK.
Type:
bool

name

The name of this PoseBone.
Type:
String

parent

The parent of this posebone (not settable)
Type:
posebone or None

poseMatrix

The total transformation of this PoseBone including constraints.

(not settable).

This matrix is in armature space, for the current worldspace location of this pose bone, multiply it with its objects worldspace matrix

eg. pose_bone.poseMatrix * object.matrixWorld
Type:
Matrix object

quat

The change in rotation for this PoseBone.
Type:
Quaternion object

sel

The selection state of this bone
Type:
Boolean

size

The change in size for this PoseBone (no change is 1,1,1)
Type:
Vector object

stiffX

The x stiffness when part of an IK [0.0 - 0.990]
Type:
float

stiffY

The x stiffness when part of an IK [0.0 - 0.990]
Type:
float

stiffZ

The x stiffness when part of an IK [0.0 - 0.990]
Type:
float

stretch

The amount to stretch to the ik target when part of an IK [0.0 - 1.0]
Type:
float

tail

The final tail location for this PoseBone. (not settable)
Type:
Vector object

   Home       Trees       Index       Help   

Blender

Generated by Epydoc 2.1 on Thu May 10 20:32:00 2007 http://epydoc.sf.net