== Transformation Constraint ==
[blender.git] / source / blender / python / api2_2x / doc / Constraint.py
1 # Blender.Constraint module and the Constraint PyType object
2
3 """
4 The Blender.Constraint submodule
5
6 B{New}: 
7         -  provides access to Blender's constraint stack
8
9 This module provides access to the Constraint Data in Blender.
10
11 Examples::
12         from Blender import *
13
14         ob = Object.Get('Cube')
15         if len(ob.constraints) > 0:
16                 const = ob.constraints[0]
17                 if const.type == Constraint.Type.FLOOR:
18                         offs = const[Constraint.Settings.OFFSET]
19         
20 Or to print all the constraints attached to each bone in a pose::
21         from Blender import *
22         
23         ob = Object.Get('Armature')
24         pose = ob.getPose()
25         for bonename in pose.bones.keys():
26                 bone = pose.bones[bonename]
27                 for const in bone.constraints:
28                         print bone.name,'=>',const
29
30 @type Type: readonly dictionary
31 @var Type: Constant Constraint dict used by L{Constraints.append()} and 
32         for comparison with L{Constraint.type}.  Values are
33         TRACKTO, IKSOLVER, FOLLOWPATH, COPYROT, COPYLOC, COPYSIZE, ACTION,
34         LOCKTRACK, STRETCHTO, FLOOR, LIMITLOC, LIMITROT, LIMITSIZE, CLAMPTO, 
35         PYTHON, CHILDOF, TRANSFORM, NULL
36
37 @type Settings: readonly dictionary
38 @var Settings: Constant dict used for changing constraint settings.
39         - Used for all constraints
40                 - TARGET (Object) (Note: not used by Limit Location (LIMITLOC), 
41                         Limit Rotation (LIMITROT), Limit Scale (LIMITSIZE))
42                 - BONE (string): name of Bone sub-target (for armature targets) (Note: not
43                         used by Stretch To (STRETCHTO), Limit Location (LIMITLOC), Limit Rotation 
44                         (LIMITROT), Limit Scale (LIMITSIZE), Follow Path (FOLLOWPATH), Clamp To (CLAMPTO))
45         - Used by IK Solver (IKSOLVER) constraint:
46                 - TOLERANCE (float): clamped to [0.0001:1.0]
47                 - ITERATIONS (int): clamped to [1,10000]
48                 - CHAINLEN (int): clamped to [0,255]
49                 - POSWEIGHT (float): clamped to [0.01,1.0]
50                 - ROTWEIGHT (float): clamped to [0.01,1.0]
51                 - ROTATE (bool)
52                 - USETIP (bool)
53         - Used by Action (ACTION) constraint:
54                 - ACTION (Action Object)
55                 - START (int): clamped to [1,maxframe]
56                 - END (int): clamped to [1,maxframe]
57                 - MIN (float): clamped to [-1000.0,1000.0] for Location, [-180.0,180.0] for Rotation, [0.0001,1000.0] for Scaling
58                 - MAX (float): clamped to [-1000.0,1000.0] for Location, [-180.0,180.0] for Rotation, [0.0001,1000.0] for Scaling
59                 - KEYON (int): values are XLOC, YLOC, ZLOC, XROT, YROT, ZROT, XSIZE, YSIZE, ZSIZE
60         - Used by Track To (TRACKTO) constraint:
61                 - TRACK (int): values are TRACKX, TRACKY, TRACKZ, TRACKNEGX,
62                         TRACKNEGY, TRACKNEGZ
63                 - UP (int): values are UPX, UPY, UPZ
64         - Used by Stretch To (STRETCHTO) constraint:
65                 - RESTLENGTH (float): clamped to [0.0:100.0]
66                 - VOLVARIATION (float): clamped to [0.0:100.0]
67                 - VOLUMEMODE (int): values are VOLUMEXZ, VOLUMEX, VOLUMEZ,
68                         VOLUMENONE
69                 - PLANE (int): values are PLANEX, PLANEZ
70         - Used by Follow Path (FOLLOWPATH) constraint:
71                 - FOLLOW (bool)
72                 - OFFSET (float): clamped to [-maxframe:maxframe]
73                 - FORWARD (int): values are TRACKX, TRACKY, TRACKZ, TRACKNEGX,
74                         TRACKNEGY, TRACKNEGZ
75                 - UP (int): values are UPX, UPY, UPZ
76         - Used by Lock Track (FOLLOWPATH) constraint:
77                 - TRACK (int): values are TRACKX, TRACKY, TRACKZ, TRACKNEGX,
78                         TRACKNEGY, TRACKNEGZ
79                 - LOCK (int): values are LOCKX, LOCKY, LOCKZ
80         - Used by Clamp To (CLAMPTO) constraint:
81                 - CLAMP (int): values are CLAMPAUTO, CLAMPX, CLAMPY, CLAMPZ
82         - Used by Floor (FLOOR) constraint:
83                 - MINMAX (int): values are MINX, MINY, MINZ, MAXX, MAXY, MAXZ
84                 - OFFSET (float): clamped to [-100.0,100.0]
85                 - STICKY (bool)
86         - Used by Copy Location (COPYLOC) and Copy Rotation (COPYROT)
87                 - COPY (bitfield): any combination of COPYX, COPYY and COPYZ with possible addition of COPYXINVERT, COPYYINVERT and COPYZINVERT to invert that particular input (if on).
88         - Used by Copy Size (COPYSIZE) constraint:
89                 - COPY (bitfield): any combination of COPYX, COPYY and COPYZ
90         - Used by Limit Location (LIMITLOC) constraint:
91                 - LIMIT (bitfield): any combination of LIMIT_XMIN, LIMIT_XMAX,
92                         LIMIT_YMIN, LIMIT_YMAX, LIMIT_ZMIN, LIMIT_ZMAX
93                 - XMIN (float): clamped to [-1000.0,1000.0]
94                 - XMAX (float): clamped to [-1000.0,1000.0]
95                 - YMIN (float): clamped to [-1000.0,1000.0]
96                 - YMAX (float): clamped to [-1000.0,1000.0]
97                 - ZMIN (float): clamped to [-1000.0,1000.0]
98                 - ZMAX (float): clamped to [-1000.0,1000.0]
99         - Used by Limit Rotation (LIMITROT) constraint:
100                 - LIMIT (bitfield): any combination of LIMIT_XROT, LIMIT_YROT, 
101                         LIMIT_ZROT
102                 - XMIN (float): clamped to [-360.0,360.0]
103                 - XMAX (float): clamped to [-360.0,360.0]
104                 - YMIN (float): clamped to [-360.0,360.0]
105                 - YMAX (float): clamped to [-360.0,360.0]
106                 - ZMIN (float): clamped to [-360.0,360.0]
107                 - ZMAX (float): clamped to [-360.0,360.0]
108         - Used by Limit Scale (LIMITSIZE) constraint:
109                 - LIMIT (bitfield): any combination of LIMIT_XMIN, LIMIT_XMAX,
110                         LIMIT_YMIN, LIMIT_YMAX, LIMIT_ZMIN, LIMIT_ZMAX
111                 - XMIN (float): clamped to [0.0001,1000.0]
112                 - XMAX (float): clamped to [0.0001,1000.0]
113                 - YMIN (float): clamped to [0.0001,1000.0]
114                 - YMAX (float): clamped to [0.0001,1000.0]
115                 - ZMIN (float): clamped to [0.0001,1000.0]
116                 - ZMAX (float): clamped to [0.0001,1000.0]
117         - Used by Python Script (PYTHON) constraint:
118                 - SCRIPT (Text): script to use
119                 - PROPERTIES (IDProperties): ID-Properties of constraint
120         - Used by Child Of (CHILDOF) constraint:
121                 - COPY (bitfield): any combination of PARLOCX, PARLOCY, PARLOCZ, 
122                         PARROTX, PARROTY, PARROTZ, PARSIZEX, PARSIZEY, PARSIZEZ.
123         - Used by Transformation (TRANSFORM) constraint:
124                 - FROM (int): values are LOC, ROT, SCALE
125                 - TO (int): values are LOC, ROT, SCALE
126                 - MAPX, MAPY, MAPZ (int): values are LOC, ROT, SCALE
127                 - EXTRAPOLATE (bool)
128                 - FROM_MINX, FROM_MINY, FROM_MINZ, FROM_MAXX, 
129                   FROM_MAXY, FROM_MAXZ (float):
130                   If FROM==LOC, then is clamped to [-1000.0, 1000.0]
131                   If FROM==ROT, then is clamped to [-360.0, 360.0]
132                   If FROM==SCALE, then is clamped to [0.0001, 1000.0]
133                 - TO_MINX, TO_MINY, TO_MINZ, TO_MAXX, TO_MAXY, TO_MAXZ (float):
134                   If TO==LOC, then is clamped to [-1000.0, 1000.0]
135                   If TO==ROT, then is clamped to [-360.0, 360.0]
136                   If TO==SCALE, then is clamped to [0.0001, 1000.0]
137
138 """
139
140 class Constraints:
141         """
142         The Constraints object
143         ======================
144         This object provides access to sequence of
145         L{constraints<Constraint.Constraint>} for a particular object.
146         They can be accessed from L{Object.constraints<Object.Object.constraints>}.
147         or L{PoseBone.constraints<Pose.PoseBone.constraints>}.
148         """
149
150         def __getitem__(index):
151                 """
152                 This operator returns one of the constraints in the stack.
153                 @type index: int
154                 @return: an Constraint object
155                 @rtype: Constraint
156                 @raise KeyError: index was out of range
157                 """
158
159         def __len__():
160                 """
161                 Returns the number of constraints in the constraint stack.
162                 @return: number of Constraints
163                 @rtype: int
164                 """
165
166         def append(type):
167                 """
168                 Appends a new constraint to the end of the constraint stack.
169                 @param type: a constant specifying the type of constraint to create. as from L{Type}
170                 @type type: int constant
171                 @rtype: Constraint
172                 @return: the new Constraint
173                 """
174
175         def remove(con):
176                 """
177                 Remove a constraint from this objects constraint sequence.
178                 @param con: a constraint from this sequence to remove.
179                 @type con: Constraint
180                 @note: Accessing attributes of the constraint after it is removed will 
181                 throw an exception.
182                 """
183
184         def moveUp(con):
185                 """
186                 Moves the constraint up in the object's constraint stack.
187                 @param con: a constraint from this sequence to remove.
188                 @type con: Constraint
189                 @rtype: None
190                 """
191
192         def moveDown(con):
193                 """
194                 Moves the constraint down in the object's constraint stack.
195                 @param con: a constraint from this sequence to remove.
196                 @type con: Constraint
197                 @rtype: None
198                 """
199
200 class Constraint:
201         """
202         The Constraint object
203         =====================
204         This object provides access to a constraint for a particular object
205         accessed from L{Constraints}.
206         @ivar name: The name of this constraint. 29 chars max.
207         @type name: string
208         @ivar type: The type of this constraint. Read-only.  The returned value
209         matches the types in L{Type}.
210         @type type: int
211         @ivar influence: The influence value of the constraint.  Valid values
212         are in the range [0.0,1.0].
213         @type influence: float
214         """
215
216         def __getitem__(key):
217                 """
218                 This operator returns one of the constraint's data attributes.
219                 @param key: value from constraint's L{Constraint.Settings} constant
220                 @type key: int constant
221                 @return: the requested data
222                 @rtype: varies
223                 @raise KeyError: the key does not exist for the constraint
224                 """
225
226         def __setitem__(key):
227                 """
228                 This operator changes one of the constraint's data attributes.
229                 @param key: value from constraint's L{Constraint.Settings} constant
230                 @type key: int constant
231                 @raise KeyError: the key does not exist for the constraint
232                 """
233
234         def insertKey(frame):
235                 """
236                 Adds an influence keyframe for the constraint Ipo.  
237                 @rtype: None
238                 @param frame: the frame number at which to insert the key.
239                 @type frame: float
240                 """