The Object object

addProperty(property)

Parameters:

property - property object to add to object.
           (type=Property object)

Warning: A property object can be added only once to an object' you must remove the property from an object to add it elsewhere.

addScriptLink(text, event)

Parameters:

text - the name of an existing Blender Text.
           (type=string)

event - "FrameChanged", "Redraw" or "Render".
           (type=string)

buildParts()

clearIpo()

Returns:

True if there was an ipo linked or False otherwise.

clearScriptLinks(links=None)

Parameters:

links - None (default) or a list of Blender Text names.
           (type=list of strings)

clearTrack(mode=0, fast=0)

Parameters:

mode - if nonzero the matrix transformation used for tracking is kept.
           (type=int (bool))

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 Scene.Scene.update).
           (type=int (bool))

clrParent(mode=0, fast=0)

Parameters:

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.
           (type=Integer)

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.
           (type=Integer)

copyAllPropertiesTo(object)

Parameters:

object - Object that will recieve the properties.
           (type=Object object)

getAction()

Returns:

a python action.
           (type=Py_Action)

getAllProperties()

Returns:

List of Property objects.
           (type=PyList)

getBoundBox()

Returns:

The coordinates of the 8 corners of the bounding box.
           (type=list of 8 (x,y,z) float coordinate vectors)

getData(name_only=False)

Parameters:

name_only - This is a keyword parameter. if True (or nonzero), only the name of the data object is returned. The default value is False.
           (type=bool)

Returns:

Depends on the type of Datablock linked to the Object. If name_only is True, it returns a string.
           (type=specific Object type or string)

getDeltaLocation()

Returns:

(x, y, z)
           (type=A vector triple)

getDrawMode()

Returns:

a sum of the following:

• 2 - axis
• 4 - texspace
• 8 - drawname
• 16 - drawimage
• 32 - drawwire

           (type=Integer)

getDrawType()

Returns:

One of the following:

• 1 - Bounding box
• 2 - Wire
• 3 - Solid
• 4 - Shaded
• 5 - Textured

           (type=Integer)

getDupliVerts()

Returns:

a boolean value.

getEuler()

Returns:

A python euler
           (type=Py_Euler)

getInverseMatrix()

Returns:

A python matrix 4x4
           (type=Py_Matrix)

getIpo()

Returns:

the wrapped ipo or None.
           (type=Ipo)

getLocation()

Returns:

(x, y, z)

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()

getMaterials(what=0)

Parameters:

what - if nonzero, empty slots will be returned as None's instead of being ignored (default way). See NMesh.NMesh.getMaterials.
           (type=int)

Returns:

list of Material Objects assigned to the object.
           (type=list of Material Objects)

getMatrix(space='worldspace')

Parameters:

space - The desired matrix:

• worldspace (default): absolute, taking vertex parents, tracking and ipo's into account;
• localspace: relative to the object's parent;
• old_worldspace: old behavior, prior to Blender 2.34, where eventual changes made by the script itself were not taken into account until a redraw happened, either called by the script or upon its exit.

Returns the object matrix.
           (type=string)

Returns:

a python 4x4 matrix object
           (type=Py_Matrix)

getName()

Returns:

The name of the object

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()

getParent()

Returns:

The parent object of the object. If not available, None will be returned.
           (type=Object)

getProperty(name)

Parameters:

name - the name of the property to get.
           (type=string)

Returns:

The first property that matches name.
           (type=Property object)

getScriptLinks(event)

Parameters:

event - "FrameChanged", "Redraw" or "Render".
           (type=string)

Returns:

a list with Blender Text names (the script links of the given 'event' type) or None if there are no script links at all.
           (type=list)

getSize()

Returns:

(SizeX, SizeY, SizeZ)

getTimeOffset()

Returns:

TimeOffset

getTracked()

Returns:

The tracked object of the object. If not available, None will be returned.
           (type=Object)

getType()

Returns:

The type of object.

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()

insertIpoKey(keytype)

Parameters:

keytype - -LOC -ROT -SIZE -LOCROT -LOCROTSIZE -PI_STRENGTH -PI_FALLOFF -PI_PERM -PI_SURFACEDAMP -PI_RANDOMDAMP
           (type=Integer)

Returns:

py_none

isSelected()

Returns:

Selection state as True or False
           (type=Boolean)

link(object)

Parameters:

object - A Blender Object.
           (type=Blender Object)

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:

object = Blender.Object.Get("Sphere")
nmesh = object.getData()
nmesh.setMode("SubSurf")
nmesh.update() # don't forget to update!
object.makeDisplayList()
Blender.Window.Redraw()

Warning: 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.

makeParent(objects, noninverse=0, fast=0)

Parameters:

objects - A Blender Object.
           (type=Blender Object)

noninverse - 0 - make parent with inverse 1 - make parent without inverse
           (type=Integer)

fast - 0 - update scene hierarchy automatically 1 - don't update scene hierarchy (faster). In this case, you must explicitely update the Scene hierarchy.
           (type=Integer)

Warning: objects must first be linked to a scene before they can become parents of other objects. Calling this makeParent method for an unlinked object will result in an error.

makeTrack(tracked, fast=0)

Parameters:

tracked - the object to be tracked.
           (type=Blender Object)

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 Scene.Scene.update).
           (type=int (bool))

Note: you also need to clear the rotation (setEuler) of this object if it was not (0,0,0) already.

removeAllProperties()

removeProperty(property)

Parameters:

property - property object to remove.
           (type=Property object)

select(boolean)

Parameters:

boolean -

• 0 - unselected
• 1 - selected

           (type=Integer)

setDeltaLocation(delta_location)

Parameters:

delta_location - A vector triple (x, y, z) specifying the new location.
           (type=A vector triple)

setDrawMode(drawmode)

Parameters:

drawmode - A sum of the following:

• 2 - axis
• 4 - texspace
• 8 - drawname
• 16 - drawimage
• 32 - drawwire

           (type=Integer)

setDrawType(drawtype)

Parameters:

drawtype - One of the following:

• 1 - Bounding box
• 2 - Wire
• 3 - Solid
• 4 - Shaded
• 5 - Textured

           (type=Integer)

setDupliVerts(data)

Parameters:

data - boolean value True, False, 0 or not 0.

setEuler(euler)

Parameters:

euler - a python euler or x,y,z rotations as floats
           (type=Py_Euler or a list of floats)

setIpo(ipo)

Parameters:

ipo - an object type ipo.
           (type=Blender Ipo)

setLocation(x, y, z)

Parameters:

x - The X coordinate of the new location.
           (type=float)

y - The Y coordinate of the new location.
           (type=float)

z - The Z coordinate of the new location.
           (type=float)

setMaterials(materials)

Parameters:

materials - A list of Blender material objects.
           (type=Materials list)

setMatrix(matrix)

Parameters:

matrix - a python matrix 4x4.
           (type=Py_Matrix 4x4)

setName(name)

Parameters:

name - The new name for the object.
           (type=String)

setSize(x, y, z)

Parameters:

x - The X size multiplier.
           (type=float)

y - The Y size multiplier.
           (type=float)

z - The Z size multiplier.
           (type=float)

setTimeOffset(timeOffset)

Parameters:

timeOffset - The new time offset for the object's animation.
           (type=float)

shareFrom(object)

Parameters:

object - A Blender Object of the same type.
           (type=Blender Object)