Home       Trees       Indices       Help   
Blender
Module Object :: Class Object
[frames] | no frames]

Class Object

The Object object

This object gives access to generic data from all objects in Blender.

Note: When dealing with properties and functions such as LocX/RotY/getLocation(), getSize() and getEuler(), keep in mind that these transformation properties are relative to the object itself, ignoring any other transformations.

To get these values in worldspace (taking into account vertex parents, constraints, etc.) pass the argument 'worldspace' to these functions.

Instance Methods
 
getParticleSystems()
Return a list of particle systems linked to this object (see Blender.Particle).
 
newParticleSystem(name=None)
Link a particle system (see Blender.Particle).
 
addVertexGroupsFromArmature(object)
Add vertex groups from armature using the bone heat method This method can be only used with an Object of the type Mesh when NOT in edit mode.
 
buildParts()
Recomputes the particle system.
 
insertShapeKey()
Insert a Shape Key in the current object.
Pose object
getPose()
Gets the current Pose of the object.
 
evaluatePose(framenumber)
Evaluates the Pose based on its currently bound action at a certain frame.
 
clearIpo()
Unlinks the ipo from this object.
 
clrParent(mode=0, fast=0)
Clears parent object.
specific Object type or string
getData(name_only=False, mesh=False)
Returns the Datablock object (Mesh, Lamp, Camera, etc.) linked to this Object.
A vector triple
getDeltaLocation()
Returns the object's delta location in a list (x, y, z)
Integer
getDrawMode()
Returns the object draw mode.
Integer
getDrawType()
Returns the object draw type
Py_Euler
getEuler(space)
Returns: A python Euler.
Py_Matrix
getInverseMatrix()
Returns the object's inverse matrix.
Ipo
getIpo()
Returns the Ipo associated to this object or None if there's no linked ipo.
Boolean
isSelected()
Returns the objects selection state in the current scene as a boolean value True or False.
 
getLocation(space)
Returns: (x, y, z)
Py_Action
getAction()
Returns an action if one is associated with this object (only useful for armature types).
list of Material Objects
getMaterials(what=0)
Returns a list of materials assigned to the object.
Py_Matrix (WRAPPED DATA)
getMatrix(space='worldspace')
Returns the object matrix.
 
getName()
Returns the name of the object
Object
getParent()
Returns the object's parent object.
 
getSize(space)
Returns: (SizeX, SizeY, SizeZ)
String
getParentBoneName()
Returns the object's parent object's sub name, or None.
 
getTimeOffset()
Returns the time offset of the object's animation.
Object
getTracked()
Returns the object's tracked object.
String
getType()
Returns the type of the object in 'Armature', 'Camera', 'Curve', 'Lamp', 'Lattice', 'Mball', 'Mesh', 'Surf', 'Empty', 'Wave' (deprecated) or 'unknown' in exceptional cases.
 
insertIpoKey(keytype)
Inserts keytype values in object ipo at curframe.
 
link(datablock)
Links Object with ObData datablock provided in the argument.
 
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.
 
join(objects)
Uses the object as a base for all of the objects in the provided list to join into.
 
makeParentDeform(objects, noninverse=0, fast=0)
Makes the object the deformation parent of the objects provided in the argument which must be a list of valid Objects.
 
makeParentVertex(objects, indices, noninverse=0, fast=0)
Makes the object the vertex parent of the objects provided in the argument which must be a list of valid Objects.
 
makeParentBone(objects, bonename, noninverse=0, fast=0)
Makes one of the object's bones the parent of the objects provided in the argument which must be a list of valid objects.
 
setDeltaLocation(delta_location)
Sets the object's delta location which must be a vector triple.
 
setDrawMode(drawmode)
Sets the object's drawing mode.
 
setDrawType(drawtype)
Sets the object's drawing type.
 
setEuler(euler)
Sets the object's localspace rotation according to the specified Euler angles.
 
setIpo(ipo)
Links an ipo to this object.
 
setLocation(x, y, z)
Sets the object's location relative to the parent object (if any).
 
setMaterials(materials)
Sets the materials.
 
setMatrix(matrix)
Sets the object's matrix and updates its transformation.
 
setName(name)
Sets the name of the object.
 
setSize(x, y, z)
Sets the object's size, relative to the parent object (if any), clamped
 
setTimeOffset(timeOffset)
Sets the time offset of the object's animation.
 
shareFrom(object)
Link data of a specified argument with this object.
 
select(boolean)
Sets the object's selection state in the current scene.
list of 8 (x,y,z) float coordinate vectors (WRAPPED DATA)
getBoundBox(worldspace=1)
Returns the worldspace bounding box of this object.
 
makeDisplayList()
Forces an update to the objects display data.
list
getScriptLinks(event)
Get a list with this Object's script links of type 'event'.
 
clearScriptLinks(links=None)
Delete script links from this Object.
 
addScriptLink(text, event)
Add a new script link to this Object.
 
makeTrack(tracked, fast=0)
Make this Object track another.
 
clearTrack(mode=0, fast=0)
Make this Object not track another anymore.
PyList
getAllProperties()
Return a list of all game properties from this object.
Property object
getProperty(name)
Return a game property from this object matching the name argument.
 
addProperty(name_or_property, data, type)
Add or create a game property for an object.
 
removeProperty(property)
Remove a game property from an object.
 
removeAllProperties()
Removes all game properties from an object.
 
copyAllPropertiesTo(object)
Copies all game properties from one object to another.
float
getPIStregth()
Get the Object's Particle Interaction Strength.
None
setPIStrength(strength)
Set the Object's Particle Interaction Strength.
float
getPIFalloff()
Get the Object's Particle Interaction falloff.
None
setPIFalloff(falloff)
Set the Object's Particle Interaction falloff.
float
getPIMaxDist()
Get the Object's Particle Interaction MaxDist.
None
setPIMaxDist(MaxDist)
Set the Object's Particle Interaction MaxDist.
int
getPIType()
Get the Object's Particle Interaction Type.
None
setPIType(type)
Set the Object's Particle Interaction type.
int
getPIUseMaxDist()
Get the Object's Particle Interaction if using MaxDist.
None
setPIUseMaxDist(status)
Set the Object's Particle Interaction MaxDist.
int
getPIDeflection()
Get the Object's Particle Interaction Deflection Setting.
None
setPIDeflection(status)
Set the Object's Particle Interaction Deflection Setting.
float
getPIPermf()
Get the Object's Particle Interaction Permeability.
None
setPIPerm(perm)
Set the Object's Particle Interaction Permeability.
float
getPIRandomDamp()
Get the Object's Particle Interaction RandomDamp.
None
setPIRandomDamp(damp)
Set the Object's Particle Interaction RandomDamp.
float
getPISurfaceDamp()
Get the Object's Particle Interaction SurfaceDamp.
None
setPISurfaceDamp(damp)
Set the Object's Particle Interaction SurfaceDamp.
float
getSBMass()
Get the Object's SoftBody Mass.
None
setSBMass(mass)
Set the Object's SoftBody Mass.
float
getSBGravity()
Get the Object's SoftBody Gravity.
None
setSBGravity(grav)
Set the Object's SoftBody Gravity.
float
getSBFriction()
Get the Object's SoftBody Friction.
None
setSBFriction(frict)
Set the Object's SoftBody Friction.
float
getSBErrorLimit()
Get the Object's SoftBody ErrorLimit.
None
setSBErrorLimit(err)
Set the Object's SoftBody ErrorLimit.
float
getSBGoalSpring()
Get the Object's SoftBody GoalSpring.
None
setSBGoalSpring(gs)
Set the Object's SoftBody GoalSpring.
float
getSBGoalFriction()
Get the Object's SoftBody GoalFriction.
None
setSBGoalFriction(gf)
Set the Object's SoftBody GoalFriction.
float
getSBMinGoal()
Get the Object's SoftBody MinGoal.
None
setSBMinGoal(mg)
Set the Object's SoftBody MinGoal.
float
getSBMaxGoal()
Get the Object's SoftBody MaxGoal.
None
setSBMaxGoal(mg)
Set the Object's SoftBody MaxGoal.
float
getSBInnerSpring()
Get the Object's SoftBody InnerSpring.
None
setSBInnerSpring(sprr)
Set the Object's SoftBody InnerSpring.
float
getSBInnerSpringFriction()
Get the Object's SoftBody InnerSpringFriction.
None
setSBInnerSpringFriction(sprf)
Set the Object's SoftBody InnerSpringFriction.
float
getSBDefaultGoal()
Get the Object's SoftBody DefaultGoal.
None
setSBDefaultGoal(goal)
Set the Object's SoftBody DefaultGoal.
boolean
isSB()
Returns the Object's SoftBody enabled state.
int
getSBPostDef()
get SoftBodies PostDef option
None
setSBPostDef(switch)
Enable / Disable SoftBodies PostDef option 1: on 0: off
int
getSBUseGoal()
get SoftBodies UseGoal option
None
setSBUseGoal(switch)
Enable / Disable SoftBodies UseGoal option 1: on 0: off
int
getSBUseEdges()
get SoftBodies UseEdges option
None
setSBUseEdges(switch)
Enable / Disable SoftBodies UseEdges option 1: on 0: off
int
getSBStiffQuads()
get SoftBodies StiffQuads option
None
setSBStiffQuads(switch)
Enable / Disable SoftBodies StiffQuads option 1: on 0: off
Instance Variables
int DupEnd
The DupliFrame end frame.
Group or None DupGroup
The DupliGroup Animation Property.
list of tuples containing (object, matrix) DupObjects
The Dupli object instances.
int DupOff
The DupliFrame removal of every Nth frame for this object.
int DupOn
The DupliFrames in succession between DupOff frames.
int DupSta
The DupliFrame starting frame.
integer (bitmask) Layers
The object layers (also check the newer attribute layers).
float LocX
The X location coordinate of the object.
float LocY
The Y location coordinate of the object.
float LocZ
The Z location coordinate of the object.
float RotX
The X rotation angle (in radians) of the object.
float RotY
The Y rotation angle (in radians) of the object.
float RotZ
The Z rotation angle (in radians) of the object.
float SBDefaultGoal
Default softbody goal value, when no vertex group used.
float SBErrorLimit
Softbody Runge-Kutta ODE solver error limit (low values give more precision).
float SBFriction
General media friction for softbody point movements.
float SBGoalFriction
Softbody goal (vertex target position) friction.
float SBGoalSpring
Softbody goal (vertex target position) spring stiffness.
float SBGrav
Apply gravitation to softbody point movement.
float SBInnerSpring
Softbody edge spring stiffness.
float SBInnerSpringFrict
Softbody edge spring friction.
float SBMass
Softbody point mass (heavier is slower).
float SBMaxGoal
Softbody goal maximum (vertex group weights scaled to match this range).
float SBMinGoal
Softbody goal minimum (vertex group weights scaled to match this range).
float SBSpeed
Tweak timing for physics to control softbody frequency and speed.
boolean SBStiffQuads
Softbody adds diagonal springs on 4-gons enabled.
boolean SBUseEdges
Softbody use edges as springs enabled.
boolean SBUseGoal
Softbody forces for vertices to stick to animated position enabled.
float SizeX
The X size of the object.
float SizeY
The Y size of the object.
float SizeZ
The Z size of the object.
Action or None action
The action associated with this object (if defined).
BPy_ActionStrips actionStrips
a sequence of action strips for the object.
int activeMaterial
The active material index for this object.
int activeShape
The active shape key index for this object.
boolean axis
Enable display of active object's center and axis.
list of 8 3D vectors boundingBox
The bounding box of this object.
  colbits
The Material usage mask.
tuple of 4 floats between 0 and 1 color
Object color used by the game engine and optionally for materials, 4 floats for RGBA object color.
Constraint Sequence constraints
a sequence of constraints for the object.
float dLocX
The delta X location coordinate of the object.
float dLocY
The delta Y location coordinate of the object.
float dLocZ
The delta Z location coordinate of the object.
float dRotX
The delta X rotation angle (in radians) of the object.
float dRotY
The delta Y rotation angle (in radians) of the object.
float dRotZ
The delta Z rotation angle (in radians) of the object.
float dSizeX
The delta X size of the object.
float dSizeY
The delta Y size of the object.
float dSizeZ
The delta Z size of the object.
varies data
The Datablock object linked to this object.
tuple of 3 floats dloc
The delta (X,Y,Z) location coordinates of the object (vector).
int drawMode
The object's drawing mode bitfield.
float drawSize
The size to display the Empty.
int drawType
The object's drawing type.
tuple of 3 floats drot
The delta (X,Y,Z) rotation angles (in radians) of the object.
tuple of 3 floats dsize
The delta (X,Y,Z) size of the object.
float dupFacesScaleFac
Scale factor for dupliface instance, 1.0 by default.
list of Effect objects effects
The list of particle effects associated with the object.
  emptyShape
The empty drawing shape.
boolean enableDupFaces
The DupliFaces status of the object.
boolean enableDupFacesScale
The DupliFacesScale status of the object.
boolean enableDupFrames
The DupliFrames status of the object.
boolean enableDupGroup
The DupliGroup status of the object.
boolean enableDupNoSpeed
The DupliNoSpeed status of the object.
boolean enableDupRot
The DupliRot status of the object.
boolean enableDupVerts
The DupliVerts status of the object.
boolean enableNLAOverride
Whether the object uses NLA or active Action for animation.
bool fakeUser
When set to True, this datablock wont be removed, even if nothing is using it.
list of Properties. game_properties
The object's properties.
Ipo ipo
Contains the Ipo if one is assigned to the object, None otherwise.
boolean isSoftBody
True if object is a soft body.
list of integers layers
The layers this object is visible in (also check the older attribute Layers).
string or None lib
path to the blend file this datablock is stored in (readonly).
tuple of 3 floats loc
The (X,Y,Z) location coordinates of the object.
Matrix mat
The matrix of the object in world space (absolute, takes vertex parents, tracking and Ipos into account).
Matrix matrix
Same as mat.
Matrix matrixLocal
The matrix of the object relative to its parent; if there is no parent, returns the world matrix (matrixWorld).
Matrix matrixOldWorld
Old-type worldspace matrix (prior to Blender 2.34).
Matrix matrixParentInverse
The inverse if the parents local matrix, set when the objects parent is set (wrapped).
Matrix matrixWorld
Same as mat.
Modifier Sequence modifiers
The modifiers associated with the object.
string name
unique name within each blend file.
boolean nameMode
Enable display of active object's name.
tuple of 2 floats oopsLoc
Object's (X,Y) OOPs location.
boolean oopsSel
Object OOPs selection flag.
Object or None parent
The parent object of the object (if defined).
int parentType
The object's parent type.
list parentVertexIndex
A list of vertex parent indicies, with a length of 0, 1 or 3.
string or None parentbonename
The string name of the parent bone (if defined).
int passIndex
Index # for the IndexOB render pass.
float piFalloff
The particle interaction falloff power.
float piMaxDist
Max distance for the particle interaction field to work.
float piPermeability
Probability that a particle will pass through the mesh.
float piRandomDamp
Random variation of particle interaction damping.
float piSoftbodyDamp
Damping factor for softbody deflection.
float piSoftbodyIThick
Inner face thickness for softbody deflection.
float piSoftbodyOThick
Outer face thickness for softbody deflection.
float piStrength
Particle interaction force field strength.
float piSurfaceDamp
Amount of damping during particle collision.
int piType
Type of particle interaction.
boolean piUseMaxDist
Use a maximum distance for the field to work.
bool pinShape
If True, only the activeShape will be displayed.
IDGroup properties
Returns an IDGroup reference to this datablocks's ID Properties.
int protectFlags
The "transform locking" bitfield flags for the object.
int rbFlags
Rigid body bitfield.
float rbMass
Rigid body mass.
float rbRadius
Rigid body bounding sphere size.
int rbShapeBoundType
Rigid body shape bound type.
bool restrictDisplay
Don't display this object in the 3D view: disabled by default, use the outliner to toggle.
bool restrictRender
Don't render this object: disabled by default, use the outliner to toggle.
bool restrictSelect
Don't select this object in the 3D view: disabled by default, use the outliner to toggle.
euler (Py_WRAPPED) rot
The (X,Y,Z) rotation angles (in radians) of the object.
boolean sel
The selection state of the object in the current scene.
tuple of 3 floats size
The (X,Y,Z) size of the object.
bool tag
A temporary tag that to flag data as being used within a loop.
boolean texSpace
Enable display of active object's texture space.
float timeOffset
The time offset of the object's animation.
Object or None track
The object's tracked object.
string trackAxis
Track axis.
boolean transp
Enable transparent materials for the active object (mesh only).
string type
The object's type.
string upAxis
Up axis.
int users
The number of users this datablock has.
boolean wireMode
Enable the active object's wireframe over solid drawing.
boolean xRay
Enable drawing the active object in front of others.
Method Details

newParticleSystem(name=None)

 

Link a particle system (see Blender.Particle). If no name is given, a new particle system is created. If a name is given and a particle system with that name exists, it is linked to the object.

Parameters:
  • name (string) - The name of the requested Particle system (optional).
Returns:
The particle system linked.

addVertexGroupsFromArmature(object)

 

Add vertex groups from armature using the bone heat method This method can be only used with an Object of the type Mesh when NOT in edit mode.

Parameters:
  • object (a bpy armature)

buildParts()

 

Recomputes the particle system. This method only applies to an Object of the type Effect. (depricated, does nothing now, use makeDisplayList instead to update the modifier stack)

insertShapeKey()

 

Insert a Shape Key in the current object. It applies to Objects of the type Mesh, Lattice, or Curve.

getPose()

 

Gets the current Pose of the object.

Returns: Pose object
the current pose object

evaluatePose(framenumber)

 

Evaluates the Pose based on its currently bound action at a certain frame.

Parameters:
  • framenumber (Int) - The frame number to evaluate to.

clearIpo()

 

Unlinks the ipo from this object.

Returns:
True if there was an ipo linked or False otherwise.

clrParent(mode=0, fast=0)

 

Clears parent object.

Parameters:
  • mode (Integer) - 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.
  • fast (Integer) - 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.

getData(name_only=False, mesh=False)

 

Returns the Datablock object (Mesh, Lamp, Camera, etc.) linked to this Object. If the keyword parameter name_only is True, only the Datablock name is returned as a string. It the object is of type Mesh, then the mesh keyword can also be used; the data return is a Mesh object if True, otherwise it is an NMesh object (the default). The mesh keyword is ignored for non-mesh objects.

Parameters:
  • name_only (bool) - This is a keyword parameter. If True (or nonzero), only the name of the data object is returned.
  • mesh (bool) - This is a keyword parameter. If True (or nonzero), a Mesh data object is returned.
Returns: specific Object type or string
Depends on the type of Datablock linked to the Object. If name_only is True, it returns a string.
Notes:
  • Mesh is faster than NMesh because Mesh is a thin wrapper.
  • This function is different from NMesh.GetRaw and Mesh.Get because it keeps a link to the original mesh, which is needed if you are dealing with Mesh weight groups.
  • Make sure the object you are getting the data from isn't in EditMode before calling this function; otherwise you'll get the data before entering EditMode. See Window.EditMode.

getDeltaLocation()

 

Returns the object's delta location in a list (x, y, z)

Returns: A vector triple
(x, y, z)

getDrawMode()

 

Returns the object draw mode.

Returns: Integer
a sum of the following:
  • 2 - axis
  • 4 - texspace
  • 8 - drawname
  • 16 - drawimage
  • 32 - drawwire
  • 64 - xray

getDrawType()

 

Returns the object draw type

Returns: Integer
One of the following:
  • 1 - Bounding box
  • 2 - Wire
  • 3 - Solid
  • 4 - Shaded
  • 5 - Textured

getEuler(space)

 
Parameters:
  • space (string) - The desired space for the size:
    • localspace: (default) location without other transformations
    • worldspace: location taking vertex parents, tracking and Ipos into account

    Returns the object's localspace rotation as Euler rotation vector (rotX, rotY, rotZ). Angles are in radians.

Returns: Py_Euler
A python Euler. Data is wrapped when euler is present.

getInverseMatrix()

 

Returns the object's inverse matrix.

Returns: Py_Matrix
A python matrix 4x4

getIpo()

 

Returns the Ipo associated to this object or None if there's no linked ipo.

Returns: Ipo
the wrapped ipo or None.

isSelected()

 

Returns the objects selection state in the current scene as a boolean value True or False.

Returns: Boolean
Selection state as True or False

getLocation(space)

 
Parameters:
  • space (string) - The desired space for the location:
    • localspace: (default) location without other transformations
    • worldspace: location taking vertex parents, tracking and Ipos into account

    Returns the object's location (x, y, z).

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

       sce = Blender.Scene.GetCurrent()

       for ob in sce.objects:
               print obj.name
               print obj.loc

Note: the worldspace location is the same as ob.matrixWorld[3][0:3]

getAction()

 

Returns an action if one is associated with this object (only useful for armature types).

Returns: Py_Action
a python action.

getMaterials(what=0)

 

Returns a list of materials assigned to the object.

Parameters:
  • what (int) - if nonzero, empty slots will be returned as None's instead of being ignored (default way). See NMesh.NMesh.getMaterials.
Returns: list of Material Objects
list of Material Objects assigned to the object. @warn. Not used much. To get a list of the materials assigned to the object, use mat=ob.getData(mesh=1).materials instead

getMatrix(space='worldspace')

 

Returns the object matrix.

Parameters:
  • space (string) - The desired matrix:
    • worldspace (default): absolute, taking vertex parents, tracking and Ipo's into account;
    • localspace: relative to the object's parent (returns worldspace matrix if the object doesn't have a 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.

Returns: Py_Matrix (WRAPPED DATA)
a python 4x4 matrix object. Data is wrapped for 'worldspace'

getName()

 

Returns the name of the object

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

       sce= Blender.Scene.GetCurrent()

       for ob in sce.objects:
               print ob.getName()

getParent()

 

Returns the object's parent object.

Returns: Object
The parent object of the object. If not available, None will be returned.

getSize(space)

 
Parameters:
  • space (string) - The desired space for the size:
    • localspace: (default) location without other transformations
    • worldspace: location taking vertex parents, tracking and Ipos into account

    Returns the object's size.

Returns:
(SizeX, SizeY, SizeZ)

Note: the worldspace size will not return negative (flipped) scale values.

getParentBoneName()

 

Returns the object's parent object's sub name, or None. For objects parented to bones, this is the name of the bone.

Returns: String
The parent object sub-name of the object. If not available, None will be returned.

getTimeOffset()

 

Returns the time offset of the object's animation.

Returns:
TimeOffset

getTracked()

 

Returns the object's tracked object.

Returns: Object
The tracked object of the object. If not available, None will be returned.

getType()

 

Returns the type of the object in 'Armature', 'Camera', 'Curve', 'Lamp', 'Lattice', 'Mball', 'Mesh', 'Surf', 'Empty', 'Wave' (deprecated) or 'unknown' in exceptional cases.

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 opposite side of the X axis. Note that the number 'pi' in the example is an approximation of the true number 'pi'. A better, less error-prone value of pi is math.pi from the python math module.:

       import Blender

       sce = Blender.Scene.GetCurrent()

       for obj in sce.objects:
               if obj.type == 'Camera':
                       obj.LocY = -obj.LocY
                       obj.RotZ = 3.141592 - obj.RotZ

       Blender.Redraw()
Returns: String
The type of object.

insertIpoKey(keytype)

 

Inserts keytype values in object ipo at curframe.

Parameters:
Returns:
None

link(datablock)

 

Links Object with ObData datablock provided in the argument. The data must match the Object's type, so you cannot link a Lamp to a Mesh type object.

Parameters:
  • datablock (Blender ObData datablock) - A Blender datablock matching the objects type.

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.

Parameters:
  • objects (Sequence of Blender Object) - The children of the parent
  • noninverse (Integer) - 0 - make parent with inverse 1 - make parent without inverse
  • fast (Integer) - 0 - update scene hierarchy automatically 1 - don't update scene hierarchy (faster). In this case, you must explicitely update the Scene hierarchy.

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.

join(objects)

 

Uses the object as a base for all of the objects in the provided list to join into.

Parameters:
  • objects (Sequence of Blender Object) - A list of objects matching the object's type.
Notes:
  • Objects in the list will not be removed from the scene. To avoid overlapping data you may want to remove them manually after joining.
  • Join modifies the base object's data in place so that other objects are joined into it. No new object or data is created.
  • Join will only work for object types Mesh, Armature, Curve and Surface; an excption will be raised if the object is not of these types.
  • Objects in the list will be ignored if they to not match the base object.
  • The base object must be in the current scene to be joined.
  • This function will not work in background mode (no user interface).
  • An error in the function input will raise a TypeError or AttributeError, otherwise an error in the data input will raise a RuntimeError. For situations where you don't have tight control on the data that is being joined, you should handle the RuntimeError error, letting the user know the data can't be joined.

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

 

Makes the object the deformation parent of the objects provided in the argument which must be a list of valid Objects. The parent object must be a Curve or Armature.

Parameters:
  • objects (Sequence of Blender Object) - The children of the parent
  • noninverse (Integer) - 0 - make parent with inverse 1 - make parent without inverse
  • fast (Integer) - 0 - update scene hierarchy automatically 1 - don't update scene hierarchy (faster). In this case, you must explicitely update the Scene hierarchy.
Warnings:
  • 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.
  • child objects must be of mesh type to deform correctly. Other object types will fall back to normal parenting silently.

makeParentVertex(objects, indices, noninverse=0, fast=0)

 

Makes the object the vertex parent of the objects provided in the argument which must be a list of valid Objects. The parent object must be a Mesh, Curve or Surface.

Parameters:
  • objects (Sequence of Blender Object) - The children of the parent
  • indices (Tuple of Integers) - The indices of the vertices you want to parent to (1 or 3 values)
  • noninverse (Integer) - 0 - make parent with inverse 1 - make parent without inverse
  • fast (Integer) - 0 - update scene hierarchy automatically 1 - don't update scene hierarchy (faster). In this case, you must explicitely update the Scene hierarchy.

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.

makeParentBone(objects, bonename, noninverse=0, fast=0)

 

Makes one of the object's bones the parent of the objects provided in the argument which must be a list of valid objects. The parent object must be an Armature.

Parameters:
  • objects (Sequence of Blender Object) - The children of the parent
  • bonename (string) - a valid bone name from the armature
  • noninverse (integer) - 0 - make parent with inverse 1 - make parent without inverse
  • fast (integer) - 0 - update scene hierarchy automatically 1 - don't update scene hierarchy (faster). In this case, you must explicitly update the Scene hierarchy.

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

setDeltaLocation(delta_location)

 

Sets the object's delta location which must be a vector triple.

Parameters:
  • delta_location (A vector triple) - A vector triple (x, y, z) specifying the new location.

setDrawMode(drawmode)

 

Sets the object's drawing mode. The drawing mode can be a mix of modes. To enable these, add up the values.

Parameters:
  • drawmode (Integer) - A sum of the following:
    • 2 - axis
    • 4 - texspace
    • 8 - drawname
    • 16 - drawimage
    • 32 - drawwire
    • 64 - xray

setDrawType(drawtype)

 

Sets the object's drawing type.

Parameters:
  • drawtype (Integer) - One of the following:
    • 1 - Bounding box
    • 2 - Wire
    • 3 - Solid
    • 4 - Shaded
    • 5 - Textured

setEuler(euler)

 

Sets the object's localspace rotation according to the specified Euler angles.

Parameters:
  • euler (Py_Euler or a list of floats) - a python Euler or x,y,z rotations as floats

setIpo(ipo)

 

Links an ipo to this object.

Parameters:
  • ipo (Blender Ipo) - an object type ipo.

setLocation(x, y, z)

 

Sets the object's location relative to the parent object (if any).

Parameters:
  • x (float) - The X coordinate of the new location.
  • y (float) - The Y coordinate of the new location.
  • z (float) - The Z coordinate of the new location.

setMaterials(materials)

 

Sets the materials. The argument must be a list 16 items or less. Each list element is either a Material or None. Also see colbits.

Parameters:
  • materials (Materials list) - A list of Blender material objects.

Note: Materials are assigned to the object's data by default. Unless you know the material is applied to the object or are changing the object's colbits, you need to look at the object data's materials.

setMatrix(matrix)

 

Sets the object's matrix and updates its transformation. If the object has a parent, the matrix transform is relative to the parent.

Parameters:
  • matrix (Py_Matrix 3x3 or 4x4) - a 3x3 or 4x4 Python matrix. If a 3x3 matrix is given, it is extended to a 4x4 matrix.

Note: This method is "bad": when called it changes the location, rotation and size attributes of the object (since Blender uses these values to calculate the object's transformation matrix). Ton is not happy having a method which "pretends" to do a matrix operation. In the future, this method may be replaced with other methods which make it easier for the user to determine the correct loc/rot/size values for necessary for the object.

setName(name)

 

Sets the name of the object. A string longer than 20 characters will be shortened.

Parameters:
  • name (String) - The new name for the object.

setSize(x, y, z)

 

Sets the object's size, relative to the parent object (if any), clamped

Parameters:
  • x (float) - The X size multiplier.
  • y (float) - The Y size multiplier.
  • z (float) - The Z size multiplier.

setTimeOffset(timeOffset)

 

Sets the time offset of the object's animation.

Parameters:
  • timeOffset (float) - The new time offset for the object's animation.

shareFrom(object)

 

Link data of a specified argument with this object. This works only if both objects are of the same type.

Parameters:
  • object (Blender Object) - A Blender Object of the same type.

Note: This function is faster than using getData() and setData() because it skips making a Python object from the object's data.

select(boolean)

 

Sets the object's selection state in the current scene. setting the selection will make this object the active object of this scene.

Parameters:
  • boolean (Integer) -
    • 0 - unselected
    • 1 - selected

getBoundBox(worldspace=1)

 

Returns the worldspace bounding box of this object. This works for meshes (out of edit mode) and curves.

Parameters:
  • worldspace (int) - An optional argument. When zero, the bounding values will be localspace.
Returns: list of 8 (x,y,z) float coordinate vectors (WRAPPED DATA)
The coordinates of the 8 corners of the bounding box. Data is wrapped when bounding box is present.

makeDisplayList()

 

Forces an update to the objects display data. If the object isn't modified, there's no need to recalculate this data. This method is here for the *few cases* where it is needed.

Example:

       import Blender

       scn = Blender.Scene.GetCurrent()
       object = scn.objects.active
       object.modifiers.append(Blender.Modifier.Type.SUBSURF)
       object.makeDisplayList()
       Blender.Window.RedrawAll()

If you try this example without the line to update the display list, the object will disappear from the screen until you press "SubSurf".

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.

getScriptLinks(event)

 

Get a list with this Object's script links of type 'event'.

Parameters:
  • event (string) - "FrameChanged", "Redraw" or "Render".
Returns: list
a list with Blender Text names (the script links of the given 'event' type) or None if there are no script links at all.

clearScriptLinks(links=None)

 

Delete script links from this Object. If no list is specified, all script links are deleted.

Parameters:
  • links (list of strings) - None (default) or a list of Blender Text names.

addScriptLink(text, event)

 

Add a new script link to this Object.

Parameters:
  • text (string) - the name of an existing Blender Text.
  • event (string) - "FrameChanged", "Redraw" or "Render".

makeTrack(tracked, fast=0)

 

Make this Object track another.

Parameters:
  • tracked (Blender Object) - the object to be tracked.
  • fast (int (bool)) - 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).

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

clearTrack(mode=0, fast=0)

 

Make this Object not track another anymore.

Parameters:
  • mode (int (bool)) - if nonzero the matrix transformation used for tracking is kept.
  • fast (int (bool)) - 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).

getAllProperties()

 

Return a list of all game properties from this object.

Returns: PyList
List of Property objects.

getProperty(name)

 

Return a game property from this object matching the name argument.

Parameters:
  • name (string) - the name of the property to get.
Returns: Property object
The first property that matches name.

addProperty(name_or_property, data, type)

 

Add or create a game property for an object. If called with only a property object, the property is assigned to the object. If called with a property name string and data object, a new property is created and added to the object.

Parameters:
  • name_or_property (string or Property object) - the property name, or a property object.
  • data (string, int or float) - Only valid when name_or_property is a string. Value depends on what is passed in:
    • string: string type property
    • int: integer type property
    • float: float type property
  • type (string (optional)) - Only valid when name_or_property is a string. Can be the following:
    • 'BOOL'
    • 'INT'
    • 'FLOAT'
    • 'TIME'
    • 'STRING'
Warnings:
  • 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.
  • A property object can be added only once to an object; you must remove the property from an object to add it elsewhere.

removeProperty(property)

 

Remove a game property from an object.

Parameters:
  • property (Property object or string) - Property object or property name to be removed.

copyAllPropertiesTo(object)

 

Copies all game properties from one object to another.

Parameters:
  • object (Object object) - Object that will receive the properties.

setPIStrength(strength)

 

Set the Object's Particle Interaction Strength. Values between -1000.0 to 1000.0

Parameters:
  • strength (float) - the Object's Particle Interaction New Strength.
Returns: None

setPIFalloff(falloff)

 

Set the Object's Particle Interaction falloff. Values between 0 to 10.0

Parameters:
  • falloff (float) - the Object's Particle Interaction New falloff.
Returns: None

setPIMaxDist(MaxDist)

 

Set the Object's Particle Interaction MaxDist. Values between 0 to 1000.0

Parameters:
  • MaxDist (float) - the Object's Particle Interaction New MaxDist.
Returns: None

setPIType(type)

 

Set the Object's Particle Interaction type. Use Module Constants

  • NONE
  • WIND
  • FORCE
  • VORTEX
  • MAGNET
Parameters:
  • type (int) - the Object's Particle Interaction Type.
Returns: None

setPIUseMaxDist(status)

 

Set the Object's Particle Interaction MaxDist. 0 = Off, 1 = on

Parameters:
  • status (int) - the new status
Returns: None

setPIDeflection(status)

 

Set the Object's Particle Interaction Deflection Setting. 0 = Off, 1 = on

Parameters:
  • status (int) - the new status
Returns: None

setPIPerm(perm)

 

Set the Object's Particle Interaction Permeability. Values between 0 to 10.0

Parameters:
  • perm (float) - the Object's Particle Interaction New Permeability.
Returns: None

setPIRandomDamp(damp)

 

Set the Object's Particle Interaction RandomDamp. Values between 0 to 10.0

Parameters:
  • damp (float) - the Object's Particle Interaction New RandomDamp.
Returns: None

setPISurfaceDamp(damp)

 

Set the Object's Particle Interaction SurfaceDamp. Values between 0 to 10.0

Parameters:
  • damp (float) - the Object's Particle Interaction New SurfaceDamp.
Returns: None

setSBMass(mass)

 

Set the Object's SoftBody Mass. Values between 0 to 50.0

Parameters:
  • mass (float) - the Object's SoftBody New mass.
Returns: None

setSBGravity(grav)

 

Set the Object's SoftBody Gravity. Values between 0 to 10.0

Parameters:
  • grav (float) - the Object's SoftBody New Gravity.
Returns: None

setSBFriction(frict)

 

Set the Object's SoftBody Friction. Values between 0 to 10.0

Parameters:
  • frict (float) - the Object's SoftBody New Friction.
Returns: None

setSBErrorLimit(err)

 

Set the Object's SoftBody ErrorLimit. Values between 0 to 1.0

Parameters:
  • err (float) - the Object's SoftBody New ErrorLimit.
Returns: None

setSBGoalSpring(gs)

 

Set the Object's SoftBody GoalSpring. Values between 0 to 0.999

Parameters:
  • gs (float) - the Object's SoftBody New GoalSpring.
Returns: None

setSBGoalFriction(gf)

 

Set the Object's SoftBody GoalFriction. Values between 0 to 10.0

Parameters:
  • gf (float) - the Object's SoftBody New GoalFriction.
Returns: None

setSBMinGoal(mg)

 

Set the Object's SoftBody MinGoal. Values between 0 to 1.0

Parameters:
  • mg (float) - the Object's SoftBody New MinGoal.
Returns: None

setSBMaxGoal(mg)

 

Set the Object's SoftBody MaxGoal. Values between 0 to 1.0

Parameters:
  • mg (float) - the Object's SoftBody New MaxGoal.
Returns: None

setSBInnerSpring(sprr)

 

Set the Object's SoftBody InnerSpring. Values between 0 to 0.999

Parameters:
  • sprr (float) - the Object's SoftBody New InnerSpring.
Returns: None

setSBInnerSpringFriction(sprf)

 

Set the Object's SoftBody InnerSpringFriction. Values between 0 to 10.0

Parameters:
  • sprf (float) - the Object's SoftBody New InnerSpringFriction.
Returns: None

setSBDefaultGoal(goal)

 

Set the Object's SoftBody DefaultGoal. Values between 0 to 1.0

Parameters:
  • goal (float) - the Object's SoftBody New DefaultGoal.
Returns: None

setSBPostDef(switch)

 

Enable / Disable SoftBodies PostDef option 1: on 0: off

Parameters:
  • switch (int) - the Object's SoftBody New PostDef Value.
Returns: None

setSBUseGoal(switch)

 

Enable / Disable SoftBodies UseGoal option 1: on 0: off

Parameters:
  • switch (int) - the Object's SoftBody New UseGoal Value.
Returns: None

setSBUseEdges(switch)

 

Enable / Disable SoftBodies UseEdges option 1: on 0: off

Parameters:
  • switch (int) - the Object's SoftBody New UseEdges Value.
Returns: None

setSBStiffQuads(switch)

 

Enable / Disable SoftBodies StiffQuads option 1: on 0: off

Parameters:
  • switch (int) - the Object's SoftBody New StiffQuads Value.
Returns: None

Instance Variable Details

DupEnd

The DupliFrame end frame. Use with enableDupFrames. Value clamped to [1,32767].
Type:
int

DupGroup

The DupliGroup Animation Property. Assign a group to DupGroup to make this object an instance of that group. This does not enable or disable the DupliGroup option, for that use enableDupGroup. The attribute returns None when this object does not have a dupliGroup, and setting the attrbute to None deletes the object from the group.
Type:
Group or None

DupObjects

The Dupli object instances. Read-only. Returns of list of tuples for object duplicated by dupliframe, dupliverts dupligroups and other animation properties. The first tuple item is the original object that is duplicated, the second is the 4x4 worldspace dupli-matrix. Example: 
       import Blender
       from Blender import Object, Scene, Mathutils

       ob= Object.Get('Cube')
       dupe_obs= ob.DupObjects
       scn= Scene.GetCurrent()
       for dupe_ob, dupe_matrix in dupe_obs:
               print dupe_ob.name
               empty_ob = scn.objects.new('Empty')
               empty_ob.setMatrix(dupe_matrix)
       Blender.Redraw()
Type:
list of tuples containing (object, matrix)

DupOff

The DupliFrame removal of every Nth frame for this object. Use with enableDupFrames. Value is clamped to [0,1500].
Type:
int

DupOn

The DupliFrames in succession between DupOff frames. Value is clamped to [1,1500]. Use with enableDupFrames and DupOff > 0.
Type:
int

DupSta

The DupliFrame starting frame. Use with enableDupFrames. Value clamped to [1,32767].
Type:
int

Layers

The object layers (also check the newer attribute layers). This value is a bitmask with at least one position set for 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.

Type:
integer (bitmask)

SBDefaultGoal

Default softbody goal value, when no vertex group used. Value clamped to [0.0,1.0].
Type:
float

SBErrorLimit

Softbody Runge-Kutta ODE solver error limit (low values give more precision). Value clamped to [0.01,1.0].
Type:
float

SBFriction

General media friction for softbody point movements. Value clamped to [0.0,10.0].
Type:
float

SBGoalFriction

Softbody goal (vertex target position) friction. Value clamped to [0.0,10.0].
Type:
float

SBGoalSpring

Softbody goal (vertex target position) spring stiffness. Value clamped to [0.0,0.999].
Type:
float

SBGrav

Apply gravitation to softbody point movement. Value clamped to [0.0,10.0].
Type:
float

SBInnerSpring

Softbody edge spring stiffness. Value clamped to [0.0,0.999].
Type:
float

SBInnerSpringFrict

Softbody edge spring friction. Value clamped to [0.0,10.0].
Type:
float

SBMass

Softbody point mass (heavier is slower). Value clamped to [0.001,50.0].
Type:
float

SBMaxGoal

Softbody goal maximum (vertex group weights scaled to match this range). Value clamped to [0.0,1.0].
Type:
float

SBMinGoal

Softbody goal minimum (vertex group weights scaled to match this range). Value clamped to [0.0,1.0].
Type:
float

SBSpeed

Tweak timing for physics to control softbody frequency and speed. Value clamped to [0.0,10.0].
Type:
float

actionStrips

a sequence of action strips for the object. Read-only.
Type:
BPy_ActionStrips

activeMaterial

The active material index for this object.

The active index is used to select the material to edit in the material buttons, new data created will also use the active material.

Value is clamped to [1,len(ob.materials)]. - [0,0] when there is no materials applied to the object.

Type:
int

activeShape

The active shape key index for this object.

The active index is used to select the material to edit in the material buttons, new data created will also use the active material.

Value is clamped to [1,len(ob.data.key.blocks)]. - [0,0] when there are no keys.

Type:
int

axis

Enable display of active object's center and axis. Also see AXIS bit in drawMode attribute.
Type:
boolean

boundingBox

The bounding box of this object. Read-only.
Type:
list of 8 3D vectors

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. Example: 
       object.colbits = (1<<0) + (1<<5) # use mesh materials 0 (1<<0) and 5 (1<<5)
       # use object materials for all others

constraints

a sequence of constraints for the object. Read-only.
Type:
Constraint Sequence

dLocX

The delta X location coordinate of the object. This variable applies to IPO Objects only.
Type:
float

dLocY

The delta Y location coordinate of the object. This variable applies to IPO Objects only.
Type:
float

dLocZ

The delta Z location coordinate of the object. This variable applies to IPO Objects only.
Type:
float

dRotX

The delta X rotation angle (in radians) of the object. This variable applies to IPO Objects only.
Type:
float

dRotY

The delta Y rotation angle (in radians) of the object. This variable applies to IPO Objects only.
Type:
float

dRotZ

The delta Z rotation angle (in radians) of the object. This variable applies to IPO Objects only.
Type:
float

data

The Datablock object linked to this object. Read-only.
Type:
varies

dloc

The delta (X,Y,Z) location coordinates of the object (vector). This variable applies to IPO Objects only.
Type:
tuple of 3 floats

drawMode

The object's drawing mode bitfield. See DrawModes constant dict for values.
Type:
int

drawSize

The size to display the Empty. Value clamped to [0.01,10.0].
Type:
float

drawType

The object's drawing type. See DrawTypes constant dict for values.
Type:
int

drot

The delta (X,Y,Z) rotation angles (in radians) of the object. This variable applies to IPO Objects only.
Type:
tuple of 3 floats

effects

The list of particle effects associated with the object. (depricated, will always return an empty list) Read-only.
Type:
list of Effect objects

emptyShape

The empty drawing shape. See EmptyShapes constant dict for values.

enableDupFaces

The DupliFaces status of the object. Does not indicate that this object has any dupliFaces, (as returned by DupObjects) just that dupliFaces are enabled.
Type:
boolean

enableDupFrames

The DupliFrames status of the object. Does not indicate that this object has any dupliFrames, (as returned by DupObjects) just that dupliFrames are enabled.
Type:
boolean

enableDupGroup

The DupliGroup status of the object. Set True to make this object an instance of the object's DupGroup, and set DupGroup to a group for this to take effect, Use DupObjects to get the object data from this instance.
Type:
boolean

enableDupNoSpeed

The DupliNoSpeed status of the object. Use with enableDupFrames to ignore dupliFrame speed.
Type:
boolean

enableDupRot

The DupliRot status of the object. Use with enableDupVerts to rotate each instance by the vertex normal.
Type:
boolean

enableDupVerts

The DupliVerts status of the object. Does not indicate that this object has any dupliVerts, (as returned by DupObjects) just that dupliVerts are enabled.
Type:
boolean

enableNLAOverride

Whether the object uses NLA or active Action for animation. When True the NLA is used.
Type:
boolean

fakeUser

When set to True, this datablock wont be removed, even if nothing is using it. All data has this disabled by default except for Actions.
Type:
bool

game_properties

The object's properties. Read-only.
Type:
list of Properties.

ipo

Contains the Ipo if one is assigned to the object, None otherwise. Setting to None clears the current Ipo.
Type:
Ipo

isSoftBody

True if object is a soft body. Read-only.
Type:
boolean

layers

The layers this object is visible in (also check the older attribute Layers). This returns a list of integers in the range [1, 20], each number representing the respective layer. Setting is done by passing a list of ints or an empty list for no layers. Example: 
       ob.layers = []  # object won't be visible
       ob.layers = [1, 4] # object visible only in layers 1 and 4
       ls = o.layers
       ls.append(10)
       o.layers = ls
       print ob.layers # will print: [1, 4, 10]

Note: changes will only be visible after the screen (at least the 3d View and Buttons windows) is redrawn.

Type:
list of integers

lib

path to the blend file this datablock is stored in (readonly).

lib will be None unless you are using external blend files with (File, Append/Link)

Note: the path may be relative, to get the full path use Blender.sys.expandpath

Type:
string or None

mat

The matrix of the object in world space (absolute, takes vertex parents, tracking and Ipos into account). Read-only.
Type:
Matrix

matrix

Same as mat. Read-only.
Type:
Matrix

matrixOldWorld

Old-type worldspace matrix (prior to Blender 2.34). Read-only.
Type:
Matrix

matrixWorld

Same as mat. Read-only.
Type:
Matrix

modifiers

The modifiers associated with the object. Example: 
       # copy the active objects modifiers to all other visible selected objects
       from Blender import *
       scn = Scene.GetCurrent()
       ob_act = scn.objects.active
       for ob in scn.objects.context:
               # Cannot copy modifiers to an object of a different type
               if ob.type == ob_act.type:
                       ob.modifiers = ob_act.modifiers
Type:
Modifier Sequence

name

unique name within each blend file.

The name is case sensitive and 21 characters maximum length.

Note: a blend file may have naming collisions when external library data is used, be sure to check the value of lib.

Note: Setting a value longer then 21 characters will be shortened

Type:
string

nameMode

Enable display of active object's name. Also see NAME bit in drawMode attribute.
Type:
boolean

oopsLoc

Object's (X,Y) OOPs location. Returns None if object is not found in list.
Type:
tuple of 2 floats

parent

The parent object of the object (if defined). Read-only.
Type:
Object or None

parentType

The object's parent type. Read-only. See ParentTypes constant dict for values.
Type:
int

parentVertexIndex

A list of vertex parent indicies, with a length of 0, 1 or 3. When there are 1 or 3 vertex parents, the indicies can be assigned to a sequence of the same length.
Type:
list

parentbonename

The string name of the parent bone (if defined). This can be set to another bone in the armature if the object already has a bone parent.
Type:
string or None

passIndex

Index # for the IndexOB render pass. Value is clamped to [0,1000].
Type:
int

piFalloff

The particle interaction falloff power. Value clamped to [0.0,10.0].
Type:
float

piMaxDist

Max distance for the particle interaction field to work. Value clamped to [0.0,1000.0].
Type:
float

piPermeability

Probability that a particle will pass through the mesh. Value clamped to [0.0,1.0].
Type:
float

piRandomDamp

Random variation of particle interaction damping. Value clamped to [0.0,1.0].
Type:
float

piSoftbodyDamp

Damping factor for softbody deflection. Value clamped to [0.0,1.0].
Type:
float

piSoftbodyIThick

Inner face thickness for softbody deflection. Value clamped to [0.001,1.0].
Type:
float

piSoftbodyOThick

Outer face thickness for softbody deflection. Value clamped to [0.001,1.0].
Type:
float

piStrength

Particle interaction force field strength. Value clamped to [0.0,1000.0].
Type:
float

piSurfaceDamp

Amount of damping during particle collision. Value clamped to [0.0,1.0].
Type:
float

piType

Type of particle interaction. See PITypes constant dict for values.
Type:
int

protectFlags

The "transform locking" bitfield flags for the object. See ProtectFlags const dict for values.
Type:
int

rbFlags

Rigid body bitfield. See RBFlags for valid values.
Type:
int

rbMass

Rigid body mass. Must be a positive value.
Type:
float

rbRadius

Rigid body bounding sphere size. Must be a positive value.
Type:
float

rbShapeBoundType

Rigid body shape bound type. See RBShapes const dict for values.
Type:
int

sel

The selection state of the object in the current scene. True is selected, False is unselected. Setting makes the object active.
Type:
boolean

tag

A temporary tag that to flag data as being used within a loop. always set all tags to True or False before using since blender uses this flag for its own internal operations.
Type:
bool

texSpace

Enable display of active object's texture space. Also see TEXSPACE bit in drawMode attribute.
Type:
boolean

timeOffset

The time offset of the object's animation. Value clamped to [-300000.0,300000.0].
Type:
float

track

The object's tracked object. None is returned if no object is tracked. Also, assigning None clear the tracked object.
Type:
Object or None

trackAxis

Track axis. Return string 'X' | 'Y' | 'Z' | '-X' | '-Y' | '-Z' (readonly)
Type:
string

transp

Enable transparent materials for the active object (mesh only). Also see TRANSP bit in drawMode attribute.
Type:
boolean

type

The object's type. Read-only.
Type:
string

upAxis

Up axis. Return string 'Y' | 'Y' | 'Z' (readonly)
Type:
string

users

The number of users this datablock has. (readonly) Zero user datablocks are de-allocated after reloading and saving.
Type:
int

wireMode

Enable the active object's wireframe over solid drawing. Also see WIRE bit in drawMode attribute.
Type:
boolean

xRay

Enable drawing the active object in front of others. Also see XRAY bit in drawMode attribute.
Type:
boolean

   Home       Trees       Indices       Help   
Blender
Generated by Epydoc 3.0 on Mon Aug 31 23:12:24 2009 http://epydoc.sourceforge.net