1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
|
# Blender.Object module and the Object PyType object
"""
The Blender.Object submodule
B{New}: L{Object.makeTrack}, scriptLink methods: L{Object.getScriptLinks}, ...
Object
======
This module provides access to the B{Objects} in Blender.
Example::
import Blender
scene = Blender.Scene.getCurrent () # get the current scene
ob = Blender.Object.New ('Camera') # make camera object
cam = Blender.Camera.New ('ortho') # make ortho camera data object
ob.link (cam) # link camera data with the object
scene.link (ob) # link the object into the scene
ob.setLocation (0.0, -5.0, 1.0) # position the object in the scene
Blender.Redraw() # redraw the scene to show the updates.
"""
def New (type, name='type'):
"""
Creates a new Object.
@type type: string
@param type: The Object type: 'Armature', 'Camera', 'Curve', 'Lamp', 'Mesh'
or 'Empty'.
@type name: string
@param name: The name of the object. By default, the name will be the same
as the object type.
@return: The created Object.
I{B{Example:}}
The example below creates a new Lamp object and puts it at the default
location (0, 0, 0) in the current scene::
import Blender
object = Blender.Object.New ('Lamp')
lamp = Blender.Lamp.New ('Spot')
object.link (lamp)
scene = Blender.Scene.getCurrent ()
scene.link (object)
Blender.Redraw()
"""
def Get (name = None):
"""
Get the Object from Blender.
@type name: string
@param name: The name of the requested Object.
@return: It depends on the 'name' parameter:
- (name): The Object with the given name;
- (): A list with all Objects in the current scene.
I{B{Example 1:}}
The example below works on the default scene. The script returns the plane
object and prints the location of the plane::
import Blender
object = Blender.Object.Get ('plane')
print object.getLocation()
I{B{Example 2:}}
The example below works on the default scene. The script returns all objects
in the scene and prints the list of object names::
import Blender
objects = Blender.Object.Get ()
print objects
"""
def GetSelected ():
"""
Get the selected objects from Blender. If no objects are selected, an empty
list will be returned.
@return: A list of all selected Objects in the current scene.
I{B{Example:}}
The example below works on the default scene. Select one or more objects and
the script will print the selected objects::
import Blender
objects = Blender.Object.GetSelected ()
print objects
"""
class Object:
"""
The Object object
=================
This object gives access to generic data from all objects in Blender.
@cvar LocX: The X location coordinate of the object.
@cvar LocY: The Y location coordinate of the object.
@cvar LocZ: The Z location coordinate of the object.
@cvar loc: The (X,Y,Z) location coordinates of the object (vector).
@cvar dLocX: The delta X location coordinate of the object.
This variable applies to IPO Objects only.
@cvar dLocY: The delta Y location coordinate of the object.
This variable applies to IPO Objects only.
@cvar dLocZ: The delta Z location coordinate of the object.
This variable applies to IPO Objects only.
@cvar dloc: The delta (X,Y,Z) location coordinates of the object (vector).
This variable applies to IPO Objects only.
@cvar RotX: The X rotation angle (in radians) of the object.
@cvar RotY: The Y rotation angle (in radians) of the object.
@cvar RotZ: The Z rotation angle (in radians) of the object.
@cvar rot: The (X,Y,Z) rotation angles (in radians) of the object (vector).
@cvar dRotX: The delta X rotation angle (in radians) of the object.
This variable applies to IPO Objects only.
@cvar dRotY: The delta Y rotation angle (in radians) of the object.
This variable applies to IPO Objects only.
@cvar dRotZ: The delta Z rotation angle (in radians) of the object.
This variable applies to IPO Objects only.
@cvar drot: The delta (X,Y,Z) rotation angles (in radians) of the object
(vector).
This variable applies to IPO Objects only.
@cvar SizeX: The X size of the object.
@cvar SizeY: The Y size of the object.
@cvar SizeZ: The Z size of the object.
@cvar size: The (X,Y,Z) size of the object (vector).
@cvar dSizeX: The delta X size of the object.
@cvar dSizeY: The delta Y size of the object.
@cvar dSizeZ: The delta Z size of the object.
@cvar dsize: The delta (X,Y,Z) size of the object.
@cvar EffX: The X effector coordinate of the object. Only applies to IKA.
@cvar EffY: The Y effector coordinate of the object. Only applies to IKA.
@cvar EffZ: The Z effector coordinate of the object. Only applies to IKA.
@cvar Layer: The object layer. This value is a bitmask with one position
set for each of the 20 possible layers starting from the low order bit.
The easiest way to deal with these values in in hexadecimal notation.
Example::
ob.Layer = 0x04 # sets layer 3 ( bit pattern 0100 )
After setting the Layer value, call Blender.Redraw( -1 ) to update
the interface.
@cvar parent: The parent object of the object. (Read-only)
@cvar track: The object tracking this object. (Read-only)
@cvar data: The data of the object. (Read-only)
@cvar ipo: The ipo data associated with the object. (Read-only)
@cvar mat: The matrix of the object relative to its parent. (Read-only)
@cvar matrix: The matrix of the object relative to its parent. (Read-only)
@cvar matrixLocal: The matrix of the object relative to its parent. (Read-only)
@cvar matrixWorld: The matrix of the object in world space. (Read-only)
@cvar colbits: The Material usage mask. A set bit #n means: the Material
#n in the Object's material list is used. Otherwise, the Material #n
of the Objects Data material list is displayed.
@cvar drawType: The object's drawing type used. 1 - Bounding box,
2 - wire, 3 - Solid, 4- Shaded, 5 - Textured.
@cvar drawMode: The object's drawing mode used. The value can be a sum
of: 2 - axis, 4 - texspace, 8 - drawname, 16 - drawimage,
32 - drawwire.
@cvar name: The name of the object.
@cvar sel: The selection state of the object, 1/0.
"""
def buildParts():
"""
Recomputes the particle system. This method only applies to an Object of
the type Effect.
"""
def clearIpo():
"""
Unlinks the ipo from this object.
@return: True if there was an ipo linked or False otherwise.
"""
def clrParent(mode = 0, fast = 0):
"""
Clears parent object.
@type mode: Integer
@type fast: Integer
@param mode: A mode flag. If mode flag is 2, then the object transform will
be kept. Any other value, or no value at all will update the object
transform.
@param fast: If the value is 0, the scene hierarchy will not be updated. Any
other value, or no value at all will update the scene hierarchy.
"""
def getData():
"""
Returns the Datablock object containing the object's data. For example the
Mesh, Lamp or the Camera.
@rtype: Object type specific
@return: Depending on the type of the Object, it returns a specific object
for the data requested.
"""
def getDeltaLocation():
"""
Returns the object's delta location in a list (x, y, z)
@rtype: A vector triple
@return: (x, y, z)
"""
def getDrawMode():
"""
Returns the object draw mode.
@rtype: Integer
@return: a sum of the following:
- 2 - axis
- 4 - texspace
- 8 - drawname
- 16 - drawimage
- 32 - drawwire
"""
def getDrawType():
"""
Returns the object draw type
@rtype: Integer
@return: One of the following:
- 1 - Bounding box
- 2 - Wire
- 3 - Solid
- 4 - Shaded
- 5 - Textured
"""
def getEuler():
"""
Returns the object's rotation as Euler rotation vector (rotX, rotY, rotZ). Angles are in radians.
@rtype: Py_Euler
@return: A python euler
"""
def getInverseMatrix():
"""
Returns the object's inverse matrix.
@rtype: Py_Matrix
@return: A python matrix 4x4
"""
def getIpo():
"""
Returns the Ipo associated to this object or None if there's no linked ipo.
@rtype: Ipo
@return: the wrapped ipo or None.
"""
def isSelected():
"""
Returns the objects selection state as a boolean value True or False.
@rtype: Boolean
@return: Selection state as True or False
"""
def getLocation():
"""
Returns the object's location (x, y, z).
@return: (x, y, z)
I{B{Example:}}
The example below works on the default scene. It retrieves all objects in
the scene and prints the name and location of each object::
import Blender
objects = Blender.Object.Get()
for obj in objects:
print obj.getName()
print obj.getLocation()
"""
def getAction():
"""
Returns an action if one is associated with this object (only useful for armature types).
@rtype: Py_Action
@return: a python action.
"""
def getMaterials(what = 0):
"""
Returns a list of materials assigned to the object.
@type what: int
@param what: if nonzero, empty slots will be returned as None's instead
of being ignored (default way). See L{NMesh.NMesh.getMaterials}.
@rtype: list of Material Objects
@return: list of Material Objects assigned to the object.
"""
def getMatrix(space = 'localspace'):
"""
Returns the object matrix.
Use getMatrix() or getMatrix('localspace') to get the matrix relative to the objects parent.
Somtimes the absolute matrix of the object is required (taking into account vertex parents, tracking and ipo's)
in this case use getMatrix('worldspace')
@type space: string. Values are:
@param space: possible values are:
- localspace (default)
- worldspace
Returns the object matrix.
@rtype: Py_Matrix
@return: a python matrix 4x4
"""
def getName():
"""
Returns the name of the object
@return: The name of the object
I{B{Example:}}
The example below works on the default scene. It retrieves all objects in
the scene and prints the name of each object::
import Blender
objects = Blender.Object.Get()
for obj in objects:
print obj.getName()
"""
def getParent():
"""
Returns the object's parent object.
@rtype: Object
@return: The parent object of the object. If not available, None will be
returned.
"""
def getSize():
"""
Returns the object's size.
@return: (SizeX, SizeY, SizeZ)
"""
def getTimeOffset():
"""
Returns the time offset of the object's animation.
@return: TimeOffset
"""
def getTracked():
"""
Returns the object's tracked object.
@rtype: Object
@return: The tracked object of the object. If not available, None will be
returned.
"""
def getType():
"""
Returns the type of the object.
@return: The type of object.
I{B{Example:}}
The example below works on the default scene. It retrieves all objects in
the scene and updates the location and rotation of the camera. When run,
the camera will rotate 180 degrees and moved to the oposite side of the X
axis. Note that the number 'pi' in the example is an approximation of the
true number 'pi'::
import Blender
objects = Blender.Object.Get()
for obj in objects:
if obj.getType() == 'Camera':
obj.LocY = -obj.LocY
obj.RotZ = 3.141592 - obj.RotZ
Blender.Redraw()
"""
def link(object):
"""
Links Object with data provided in the argument. The data must match the
Object's type, so you cannot link a Lamp to a Mesh type object.
@type object: Blender Object
@param object: A Blender Object.
"""
def makeParent(objects, noninverse = 0, fast = 0):
"""
Makes the object the parent of the objects provided in the argument which
must be a list of valid Objects.
@type objects: Blender Object
@param objects: A Blender Object.
@type noninverse: Integer
@param noninverse:
0 - make parent with inverse
1 - make parent without inverse
@type fast: Integer
@param fast:
0 - update scene hierarchy automatically
1 - don't update scene hierarchy (faster). In this case, you must
explicitely update the Scene hierarchy.
"""
def setDeltaLocation(delta_location):
"""
Sets the object's delta location which must be a vector triple.
@type delta_location: A vector triple
@param delta_location: A vector triple (x, y, z) specifying the new
location.
"""
def setDrawMode(drawmode):
"""
Sets the object's drawing mode. The drawing mode can be a mix of modes. To
enable these, add up the values.
@type drawmode: Integer
@param drawmode: A sum of the following:
- 2 - axis
- 4 - texspace
- 8 - drawname
- 16 - drawimage
- 32 - drawwire
"""
def setDrawType(drawtype):
"""
Sets the object's drawing type.
@type drawtype: Integer
@param drawtype: One of the following:
- 1 - Bounding box
- 2 - Wire
- 3 - Solid
- 4 - Shaded
- 5 - Textured
"""
def setEuler(euler):
"""
Sets the object's rotation according to the specified Euler angles.
@type euler: Py_Euler or a list of floats
@param euler: a python euler or x,y,z rotations as floats
"""
def setIpo(ipo):
"""
Links an ipo to this object.
@type ipo: Blender Ipo
@param ipo: an object type ipo.
"""
def setLocation(x, y, z):
"""
Sets the object's location.
@type x: float
@param x: The X coordinate of the new location.
@type y: float
@param y: The Y coordinate of the new location.
@type z: float
@param z: The Z coordinate of the new location.
"""
def setMaterials(materials):
"""
Sets the materials. The argument must be a list of valid material objects.
@type materials: Materials list
@param materials: A list of Blender material objects.
"""
def setMatrix(matrix):
"""
Sets the object's matrix and updates it's tranformation.
@type matrix: Py_Matrix 4x4
@param matrix: a python matrix 4x4.
"""
def setName(name):
"""
Sets the name of the object.
@type name: String
@param name: The new name for the object.
"""
def setSize(x, y, z):
"""
Sets the object's size.
@type x: float
@param x: The X size multiplier.
@type y: float
@param y: The Y size multiplier.
@type z: float
@param z: The Z size multiplier.
"""
def setTimeOffset(timeOffset):
"""
Sets the time offset of the object's animation.
@type timeOffset: float
@param timeOffset: The new time offset for the object's animation.
"""
def shareFrom(object):
"""
Link data of object specified in the argument with self. This works only
if self and the object specified are of the same type.
@type object: Blender Object
@param object: A Blender Object of the same type.
"""
def select(boolean):
"""
Sets the object's selection state.
@type boolean: Integer
@param boolean:
- 0 - unselected
- 1 - selected
"""
def getBoundBox():
"""
Returns the bounding box of this object. This works for meshes (out of
edit mode) and curves.
@rtype: list of 8 (x,y,z) float coordinate vectors
@return: The coordinates of the 8 corners of the bounding box.
"""
def makeDisplayList():
"""
Updates this object's display list. Blender uses display lists to store
already transformed data (like a mesh with its vertices already modified
by coordinate transformations and armature deformation). If the object
isn't modified, there's no need to recalculate this data. This method is
here for the *few cases* where a script may need it, like when toggling
the "SubSurf" mode for a mesh:
Example::
object = Blender.Object.Get("Sphere")
nmesh = object.getData()
nmesh.setMode("SubSurf")
nmesh.update() # don't forget to update!
object.makeDisplayList()
Blender.Window.Redraw()
If you try this example without the line to update the display list, the
object will disappear from the screen until you press "SubSurf".
@warn: If after running your script objects disappear from the screen or
are not displayed correctly, try this method function. But if the script
works properly without it, there's no reason to use it.
"""
def getScriptLinks (event):
"""
Get a list with this Object's script links of type 'event'.
@type event: string
@param event: "FrameChanged" or "Redraw".
@rtype: list
@return: a list with Blender L{Text} names (the script links of the given
'event' type) or None if there are no script links at all.
"""
def clearScriptLinks ():
"""
Delete all this Object's script links.
@rtype: bool
@return: 0 if some internal problem occurred or 1 if successful.
"""
def addScriptLink (text, event):
"""
Add a new script link to this Object.
@type text: string
@param text: the name of an existing Blender L{Text}.
@type event: string
@param event: "FrameChanged" or "Redraw".
"""
def makeTrack (tracked, fast = 0):
"""
Make this Object track another.
@type tracked: Blender Object
@param tracked: the object to be tracked.
@type fast: int (bool)
@param fast: if zero, the scene hierarchy is updated automatically. If
you set 'fast' to a nonzero value, don't forget to update the scene
yourself (see L{Scene.Scene.update}).
@note: you also need to clear the rotation (L{setEuler}) of this object
if it was not (0,0,0) already.
"""
def clearTrack (mode = 0, fast = 0):
"""
Make this Object not track another anymore.
@type mode: int (bool)
@param mode: if nonzero the matrix transformation used for tracking is kept.
@type fast: int (bool)
@param fast: if zero, the scene hierarchy is updated automatically. If
you set 'fast' to a nonzero value, don't forget to update the scene
yourself (see L{Scene.Scene.update}).
"""
def getAllProperties ():
"""
Return a list of properties from this object.
@rtype: PyList
@return: List of Property objects.
"""
def getProperty (name):
"""
Return a properties from this object based on name.
@type name: string
@param name: the name of the property to get.
@rtype: Property object
@return: The first property that matches name.
"""
def addProperty (name, data, type):
"""
Add a property to object.
@type name: string
@param name: the property name.
@type data: string, int or float
@param data: depends on what is passed in:
- string: string type property
- int: integer type property
- float: float type property
@type type: string (optional)
@param type: can be the following:
- 'BOOL'
- 'INT'
- 'FLOAT'
- 'TIME'
- 'STRING'
@warn: If a type is not declared string data will
become string type, int data will become int type
and float data will become float type. Override type
to declare bool type, and time type.
"""
def addProperty (property):
"""
Add a property to object.
@type property: Property object
@param property: property object to add to object.
@warn: A property object can be added only once to an object'
you must remove the property from an object to add it elsewhere.
"""
def removeProperty (name):
"""
Remove a property from an object by name.
@type property: Property object
@param property: property to remove by name.
"""
def removeProperty (property):
"""
Remove a property from an object.
@type property: Property object
@param property: property object to remove.
"""
def removeAllProperties():
"""
Removes all properties from an object.
"""
def copyAllPropertiesTo (object):
"""
Copies all properties from one object to another.
@type object: Object object
@param object: Object that will recieve the properties.
"""
class Property:
"""
The Property object
===================
This property gives access to object property data in Blender.
@cvar name: The property name.
@cvar data: Data for this property. Depends on property type.
@cvar type: The property type.
@warn: Comparisons between properties will only be true when
both the name and data pairs are the same.
"""
def getName ():
"""
Get the name of this property.
@rtype: string
@return: The property name.
"""
def setName (name):
"""
Set the name of this property.
@type name: string
@param name: The new name of the property
"""
def getData ():
"""
Get the data for this property.
@rtype: string, int, or float
"""
def setData (data):
"""
Set the data for this property.
@type data: string, int, or float
@param data: The data to set for this property.
@warn: See object.setProperty(). Changing data
which is of a different type then the property is
set to (i.e. setting an int value to a float type'
property) will change the type of the property
automatically.
"""
def getType ():
"""
Get the type for this property.
@rtype: string
"""
|