Home       Trees       Indices       Help   
Blender
Module Constraint

Module Constraint

source code

The Blender.Constraint submodule

New:

This module provides access to the Constraint Data in Blender.

Examples: 
       from Blender import *

       ob = Object.Get('Cube')
       if len(ob.constraints) > 0:
               const = ob.constraints[0]
               if const.type == Constraint.Type.FLOOR:
                       offs = const[Constraint.Settings.OFFSET]
Or to print all the constraints attached to each bone in a pose: 
       from Blender import *
       
       ob = Object.Get('Armature')
       pose = ob.getPose()
       for bonename in pose.bones.keys():
               bone = pose.bones[bonename]
               for const in bone.constraints:
                       print bone.name,'=>',const


Classes
  Constraints
This object provides access to sequence of constraints for a particular object.
  Constraint
This object provides access to a constraint for a particular object accessed from Constraints.
Variables
readonly dictionary Settings
Constant dict used for changing constraint settings.
readonly dictionary Type
Constant Constraint dict used by Constraints.append() and for comparison with Constraint.type.
Variables Details

Settings

Constant dict used for changing constraint settings.
  • Used for all single-target constraints (TRACKTO, FOLLOWPATH, COPYROT, COPYLOC, COPYSIZE, ACTION, LOCKTRACK, STRETCHTO, FLOOR, CLAMPTO, CHILDOF, TRANSFORM, LIMITDIST)
  • TARGET (Object): target object
  • BONE (string): name of Bone sub-target (for Armature targets), or name of Vertex Group sub-target (for Geometry targets)
  • Used for all multiple-target constraints (PYTHON)
    • TARGET (list of Objects): list of target objects, with one list slot = one target slot
    • BONE (list of strings): list of names of Bone sub-target (for Armature targets) or name of Vertex Group sub-targets (for Geometry targets)
  • Used by some constraints:
    • OWNERSPACE (int): for TRACKTO, COPYLOC, COPYROT, COPYSIZE, LIMITLOC, LIMITROT, LIMITSIZE, PYTHON, TRANSFORM If the owner is an object, values are SPACE_WORLD, SPACE_LOCAL If the owner is a bone, values are SPACE_WORLD, SPACE_POSE, SPACE_PARLOCAL, SPACE_LOCAL
    • TARGETSPACE (list of ints): for TRACKTO, COPYLOC, COPYROT, COPYSIZE, PYTHON, TRANSFORM, ACTION For every target that the Constraint can have, the target space can be set If the target is an object, values are SPACE_WORLD, SPACE_LOCAL If the target is a bone, values are SPACE_WORLD, SPACE_POSE, SPACE_PARLOCAL, SPACE_LOCAL
  • Used by IK Solver (IKSOLVER) constraint:
    • TOLERANCE (float): clamped to [0.0001:1.0]
    • ITERATIONS (int): clamped to [1,10000]
    • CHAINLEN (int): clamped to [0,255]
    • POSWEIGHT (float): clamped to [0.01,1.0]
    • ROTWEIGHT (float): clamped to [0.01,1.0]
    • ROTATE (bool)
    • USETIP (bool)
  • Used by Action (ACTION) constraint:
    • ACTION (Action Object)
    • START (int): clamped to [1,maxframe]
    • END (int): clamped to [1,maxframe]
    • MIN (float): clamped to [-1000.0,1000.0] for Location, [-180.0,180.0] for Rotation, [0.0001,1000.0] for Scaling
    • MAX (float): clamped to [-1000.0,1000.0] for Location, [-180.0,180.0] for Rotation, [0.0001,1000.0] for Scaling
    • KEYON (int): values are XLOC, YLOC, ZLOC, XROT, YROT, ZROT, XSIZE, YSIZE, ZSIZE
  • Used by Track To (TRACKTO) constraint:
    • TRACK (int): values are TRACKX, TRACKY, TRACKZ, TRACKNEGX, TRACKNEGY, TRACKNEGZ
    • UP (int): values are UPX, UPY, UPZ
  • Used by Stretch To (STRETCHTO) constraint:
    • RESTLENGTH (float): clamped to [0.0:100.0]
    • VOLVARIATION (float): clamped to [0.0:100.0]
    • VOLUMEMODE (int): values are VOLUMEXZ, VOLUMEX, VOLUMEZ, VOLUMENONE
    • PLANE (int): values are PLANEX, PLANEZ
  • Used by Follow Path (FOLLOWPATH) constraint:
    • FOLLOW (bool)
    • OFFSET (float): clamped to [-maxframe:maxframe]
    • FORWARD (int): values are TRACKX, TRACKY, TRACKZ, TRACKNEGX, TRACKNEGY, TRACKNEGZ
    • UP (int): values are UPX, UPY, UPZ
  • Used by Lock Track (FOLLOWPATH) constraint:
    • TRACK (int): values are TRACKX, TRACKY, TRACKZ, TRACKNEGX, TRACKNEGY, TRACKNEGZ
    • LOCK (int): values are LOCKX, LOCKY, LOCKZ
  • Used by Clamp To (CLAMPTO) constraint:
    • CLAMP (int): values are CLAMPAUTO, CLAMPX, CLAMPY, CLAMPZ
    • CLAMPCYCLIC (bool)
  • Used by Floor (FLOOR) constraint:
    • MINMAX (int): values are MINX, MINY, MINZ, MAXX, MAXY, MAXZ
    • OFFSET (float): clamped to [-100.0,100.0]
    • STICKY (bool)
  • Used by Copy Location (COPYLOC) and Copy Rotation (COPYROT)
    • COPY (bitfield): any combination of COPYX, COPYY and COPYZ with possible addition of COPYXINVERT, COPYYINVERT and COPYZINVERT to invert that particular input (if on).
  • Used by Copy Size (COPYSIZE) constraint:
    • COPY (bitfield): any combination of COPYX, COPYY and COPYZ
  • Used by Limit Location (LIMITLOC) constraint:
    • LIMIT (bitfield): any combination of LIMIT_XMIN, LIMIT_XMAX, LIMIT_YMIN, LIMIT_YMAX, LIMIT_ZMIN, LIMIT_ZMAX
    • XMIN (float): clamped to [-1000.0,1000.0]
    • XMAX (float): clamped to [-1000.0,1000.0]
    • YMIN (float): clamped to [-1000.0,1000.0]
    • YMAX (float): clamped to [-1000.0,1000.0]
    • ZMIN (float): clamped to [-1000.0,1000.0]
    • ZMAX (float): clamped to [-1000.0,1000.0]
  • Used by Limit Rotation (LIMITROT) constraint:
    • LIMIT (bitfield): any combination of LIMIT_XROT, LIMIT_YROT, LIMIT_ZROT
    • XMIN (float): clamped to [-360.0,360.0]
    • XMAX (float): clamped to [-360.0,360.0]
    • YMIN (float): clamped to [-360.0,360.0]
    • YMAX (float): clamped to [-360.0,360.0]
    • ZMIN (float): clamped to [-360.0,360.0]
    • ZMAX (float): clamped to [-360.0,360.0]
  • Used by Limit Scale (LIMITSIZE) constraint:
    • LIMIT (bitfield): any combination of LIMIT_XMIN, LIMIT_XMAX, LIMIT_YMIN, LIMIT_YMAX, LIMIT_ZMIN, LIMIT_ZMAX
    • XMIN (float): clamped to [0.0001,1000.0]
    • XMAX (float): clamped to [0.0001,1000.0]
    • YMIN (float): clamped to [0.0001,1000.0]
    • YMAX (float): clamped to [0.0001,1000.0]
    • ZMIN (float): clamped to [0.0001,1000.0]
    • ZMAX (float): clamped to [0.0001,1000.0]
  • Used by Limit Distance (LIMITDIST) constraint:
    • LIMITMODE (int): any one of LIMIT_INSIDE, LIMIT_OUTSIDE, LIMIT_ONSURFACE
  • Used by Python Script (PYTHON) constraint:
    • SCRIPT (Text): script to use
    • PROPERTIES (IDProperties): ID-Properties of constraint
  • Used by Child Of (CHILDOF) constraint:
    • COPY (bitfield): any combination of PARLOCX, PARLOCY, PARLOCZ, PARROTX, PARROTY, PARROTZ, PARSIZEX, PARSIZEY, PARSIZEZ.
  • Used by Transformation (TRANSFORM) constraint:
    • FROM (int): values are LOC, ROT, SCALE
    • TO (int): values are LOC, ROT, SCALE
    • MAPX, MAPY, MAPZ (int): values are LOC, ROT, SCALE
    • EXTRAPOLATE (bool)
    • FROM_MINX, FROM_MINY, FROM_MINZ, FROM_MAXX, FROM_MAXY, FROM_MAXZ (float): If FROM==LOC, then is clamped to [-1000.0, 1000.0] If FROM==ROT, then is clamped to [-360.0, 360.0] If FROM==SCALE, then is clamped to [0.0001, 1000.0]
    • TO_MINX, TO_MINY, TO_MINZ, TO_MAXX, TO_MAXY, TO_MAXZ (float): If TO==LOC, then is clamped to [-1000.0, 1000.0] If TO==ROT, then is clamped to [-360.0, 360.0] If TO==SCALE, then is clamped to [0.0001, 1000.0]
Type:
readonly dictionary

Type

Constant Constraint dict used by Constraints.append() and for comparison with Constraint.type. Values are TRACKTO, IKSOLVER, FOLLOWPATH, COPYROT, COPYLOC, COPYSIZE, ACTION, LOCKTRACK, STRETCHTO, FLOOR, LIMITLOC, LIMITROT, LIMITSIZE, LIMITDIST, CLAMPTO, PYTHON, CHILDOF, TRANSFORM, NULL
Type:
readonly dictionary

   Home       Trees       Indices       Help   
Blender
Generated by Epydoc 3.0beta1 on Mon May 19 15:32:19 2008 http://epydoc.sourceforge.net