Module Object :: Class Object

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's parent (if any).

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

Method Summary
	`addProperty(name_or_property, data, type)` Add or create a game property for an object.
	`addScriptLink(text, event)` Add a new script link to this Object.
	`buildParts()` Recomputes the particle system.
	`clearIpo()` Unlinks the ipo from this object.
	`clearScriptLinks(links)` Delete script links from this Object.
	`clearTrack(mode, fast)` Make this Object not track another anymore.
	`clrParent(mode, fast)` Clears parent object.
	`copyAllPropertiesTo(object)` Copies all game properties from one object to another.
	`evaluatePose(framenumber)` Evaluates the Pose based on its currently bound action at a certain frame.
Py_Action	`getAction()` Returns an action if one is associated with this object (only useful for armature types).
PyList	`getAllProperties()` Return a list of all game properties from this object.
list of 8 (x,y,z) float coordinate vectors (WRAPPED DATA)	`getBoundBox()` Returns the worldspace bounding box of this object.
specific Object type or string	`getData(name_only, mesh)` 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)` Return 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.
	`getLocation(space)` Return (x, y, z)
list of Material Objects	`getMaterials(what)` Returns a list of materials assigned to the object.
Py_Matrix (WRAPPED DATA)	`getMatrix(space)` Returns the object matrix.
	`getName()` Returns the name of the object
Object	`getParent()` Returns the object's parent object.
String	`getParentBoneName()` Returns the object's parent object's sub name, or None.
int	`getPIDeflection()` Get the Object's Particle Interaction Deflection Setting.
float	`getPIFalloff()` Get the Object's Particle Interaction falloff.
float	`getPIMaxDist()` Get the Object's Particle Interaction MaxDist.
float	`getPIPermf()` Get the Object's Particle Interaction Permeability.
float	`getPIRandomDamp()` Get the Object's Particle Interaction RandomDamp.
float	`getPIStregth()` Get the Object's Particle Interaction Strength.
float	`getPISurfaceDamp()` Get the Object's Particle Interaction SurfaceDamp.
int	`getPIType()` Get the Object's Particle Interaction Type.
int	`getPIUseMaxDist()` Get the Object's Particle Interaction if using MaxDist.
Pose object	`getPose()` Gets the current Pose of the object.
Property object	`getProperty(name)` Return a game property from this object matching the name argument.
float	`getSBDefaultGoal()` Get the Object's SoftBody DefaultGoal.
float	`getSBErrorLimit()` Get the Object's SoftBody ErrorLimit.
float	`getSBFriction()` Get the Object's SoftBody Friction.
float	`getSBGoalFriction()` Get the Object's SoftBody GoalFriction.
float	`getSBGoalSpring()` Get the Object's SoftBody GoalSpring.
float	`getSBGravity()` Get the Object's SoftBody Gravity.
float	`getSBInnerSpring()` Get the Object's SoftBody InnerSpring.
float	`getSBInnerSpringFriction()` Get the Object's SoftBody InnerSpringFriction.
float	`getSBMass()` Get the Object's SoftBody Mass.
float	`getSBMaxGoal()` Get the Object's SoftBody MaxGoal.
float	`getSBMinGoal()` Get the Object's SoftBody MinGoal.
int	`getSBPostDef()` get SoftBodies PostDef option
int	`getSBStiffQuads()` get SoftBodies StiffQuads option
int	`getSBUseEdges()` get SoftBodies UseEdges option
int	`getSBUseGoal()` get SoftBodies UseGoal option
list	`getScriptLinks(event)` Get a list with this Object's script links of type 'event'.
	`getSize(space)` Return (SizeX, SizeY, SizeZ)
	`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.
	`insertShapeKey()` Insert a Shape Key in the current object.
boolean	`isSB()` Returns the Object's SoftBody enabled state.
Boolean	`isSelected()` Returns the objects selection state in the current scene as a boolean value True or False.
	`join(objects)` Uses the object as a base for all of the objects in the provided list to join into.
	`link(datablock)` Links Object with ObData datablock provided in the argument.
	`makeDisplayList()` Updates this object's display list.
	`makeParent(objects, noninverse, fast)` Makes the object the parent of the objects provided in the argument which must be a list of valid Objects.
	`makeParentBone(objects, bonename, noninverse, fast)` Makes one of the object's bones the parent of the objects provided in the argument which must be a list of valid objects.
	`makeParentDeform(objects, noninverse, fast)` 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, fast)` Makes the object the vertex parent of the objects provided in the argument which must be a list of valid Objects.
	`makeTrack(tracked, fast)` Make this Object track another.
	`removeAllProperties()` Removes all game properties from an object.
	`removeProperty(property)` Remove a game property from an object.
	`select(boolean)` Sets the object's selection state in the current scene.
	`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.
None	`setPIDeflection(status)` Set the Object's Particle Interaction Deflection Setting.
None	`setPIFalloff(falloff)` Set the Object's Particle Interaction falloff.
None	`setPIMaxDist(MaxDist)` Set the Object's Particle Interaction MaxDist.
None	`setPIPerm(perm)` Set the Object's Particle Interaction Permeability.
None	`setPIRandomDamp(damp)` Set the Object's Particle Interaction RandomDamp.
None	`setPIStrength(strength)` Set the Object's Particle Interaction Strength.
None	`setPISurfaceDamp(damp)` Set the Object's Particle Interaction SurfaceDamp.
None	`setPIType(type)` Set the Object's Particle Interaction type.
None	`setPIUseMaxDist(status)` Set the Object's Particle Interaction MaxDist.
None	`setSBDefaultGoal(goal)` Set the Object's SoftBody DefaultGoal.
None	`setSBErrorLimit(err)` Set the Object's SoftBody ErrorLimit.
None	`setSBFriction(frict)` Set the Object's SoftBody Friction.
None	`setSBGoalFriction(gf)` Set the Object's SoftBody GoalFriction.
None	`setSBGoalSpring(gs)` Set the Object's SoftBody GoalSpring.
None	`setSBGravity(grav)` Set the Object's SoftBody Gravity.
None	`setSBInnerSpring(sprr)` Set the Object's SoftBody InnerSpring.
None	`setSBInnerSpringFriction(sprf)` Set the Object's SoftBody InnerSpringFriction.
None	`setSBMass(mass)` Set the Object's SoftBody Mass.
None	`setSBMaxGoal(mg)` Set the Object's SoftBody MaxGoal.
None	`setSBMinGoal(mg)` Set the Object's SoftBody MinGoal.
None	`setSBPostDef(switch)` Enable / Disable SoftBodies PostDef option 1: on 0: off
None	`setSBStiffQuads(switch)` Enable / Disable SoftBodies StiffQuads option 1: on 0: off
None	`setSBUseEdges(switch)` Enable / Disable SoftBodies UseEdges option 1: on 0: off
None	`setSBUseGoal(switch)` Enable / Disable SoftBodies UseGoal option 1: on 0: off
	`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.

Instance Variable Summary
`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.
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.
Constraint Sequence	`constraints`: a `sequence` of `constraints` for 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).
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.
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.
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.
tuple of 3 floats	`dsize`: The delta (X,Y,Z) size 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.
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.
list of Effect objects	`effects`: The list of particle effects associated with the object.
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`: The fake user status.
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`).
integer (bitmask)	`Layers`: The object layers (also check the newer attribute `layers`).
tuple of 3 floats	`loc`: The (X,Y,Z) location coordinates of the object.
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.
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	`matrixWorld`: Same as `mat`.
`Modifier Sequence`	`modifiers`: The modifiers associated with the object.
string	`name`: Object data name.
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).
string or None	`parentbonename`: The string name of the parent bone (if defined).
int	`parentType`: The object's parent type.
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.
`IDGroup`	`properties`: Returns an `IDGroup` reference to this object'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.
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.
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.
float	`SizeX`: The X size of the object.
float	`SizeY`: The Y size of the object.
float	`SizeZ`: The Z size of the object.
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.
boolean	`transp`: Enable transparent materials for the active object (mesh only).
string	`type`: The object's type.
int	`users`: The number of users of the object.
boolean	`wireMode`: Enable the active object's wireframe over solid drawing.
boolean	`xRay`: Enable drawing the active object in front of others.

Method Details

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 - the property name, or a property object.
(type=string or Property object)

data - 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, int or float)

type - Only valid when name_or_property is a string. Can be the following:

'BOOL'
'INT'
'FLOAT'
'TIME'
'STRING'

(type=string (optional))

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.

addScriptLink(text, event)

Add a new script link to this Object.

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

buildParts()

Recomputes the particle system. This method only applies to an Object of the type Effect.

clearIpo()

Unlinks the ipo from this object.

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

clearScriptLinks(links=None)

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

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

clearTrack(mode=0, fast=0)

Make this Object not track another anymore.

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)

Clears parent object.

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)

Copies all game properties from one object to another.

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

evaluatePose(framenumber)

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

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

getAction()

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

Returns:: a python action.
(type=Py_Action)

getAllProperties()

Return a list of all game properties from this object.

Returns:: List of Property objects.
(type=PyList)

getBoundBox()

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

Returns:: The coordinates of the 8 corners of the bounding box. Data is wrapped when bounding box is present.
(type=list of 8 (x,y,z) float coordinate vectors (WRAPPED DATA))

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 - This is a keyword parameter. If True (or nonzero), only the name of the data object is returned.
(type=bool); mesh - This is a keyword parameter. If True (or nonzero), a Mesh data object is returned.
(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)

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:: (x, y, z)
(type=A vector triple)

getDrawMode()

Returns the object draw mode.

Returns:

a sum of the following:

2 - axis
4 - texspace
8 - drawname
16 - drawimage
32 - drawwire
64 - xray

(type=Integer)

getDrawType()

Returns the object draw type

Returns:

One of the following:

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

(type=Integer)

getEuler(space)

Parameters:

space - The desired space for the size:

localspace: (default) relative to the object's parent;
worldspace: absolute, taking vertex parents, tracking and Ipo's into account;

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

Returns:: A python Euler. Data is wrapped when euler is present.
(type=Py_Euler)

getInverseMatrix()

Returns the object's inverse matrix.

Returns:: A python matrix 4x4
(type=Py_Matrix)

getIpo()

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

Returns:: the wrapped ipo or None.
(type=Ipo)

getLocation(space)

Parameters:

space - The desired space for the location:

localspace: (default) relative to the object's parent;
worldspace: absolute, taking vertex parents, tracking and Ipo's into account;

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

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

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

getMaterials(what=0)

Returns a list of materials assigned to the object.

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

Returns the object matrix.

Parameters:

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

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

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

 scn= Blender.Scene.GetCurrent()
 objects = scn.getChildren()

 for obj in objects:
     print obj.getName()

getParent()

Returns the object's parent object.

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

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:: The parent object sub-name of the object. If not available, None will be returned.
(type=String)

getPIDeflection()

Get the Object's Particle Interaction Deflection Setting.

Returns:: int

getPIFalloff()

Get the Object's Particle Interaction falloff.

Returns:: float

getPIMaxDist()

Get the Object's Particle Interaction MaxDist.

Returns:: float

getPIPermf()

Get the Object's Particle Interaction Permeability.

Returns:: float

getPIRandomDamp()

Get the Object's Particle Interaction RandomDamp.

Returns:: float

getPIStregth()

Get the Object's Particle Interaction Strength.

Returns:: float

getPISurfaceDamp()

Get the Object's Particle Interaction SurfaceDamp.

Returns:: float

getPIType()

Get the Object's Particle Interaction Type.

Returns:: int

getPIUseMaxDist()

Get the Object's Particle Interaction if using MaxDist.

Returns:: int

getPose()

Gets the current Pose of the object.

Returns:: the current pose object
(type=Pose object)

getProperty(name)

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

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

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

getSBDefaultGoal()

Get the Object's SoftBody DefaultGoal.

Returns:: float

getSBErrorLimit()

Get the Object's SoftBody ErrorLimit.

Returns:: float

getSBFriction()

Get the Object's SoftBody Friction.

Returns:: float

getSBGoalFriction()

Get the Object's SoftBody GoalFriction.

Returns:: float

getSBGoalSpring()

Get the Object's SoftBody GoalSpring.

Returns:: float

getSBGravity()

Get the Object's SoftBody Gravity.

Returns:: float

getSBInnerSpring()

Get the Object's SoftBody InnerSpring.

Returns:: float

getSBInnerSpringFriction()

Get the Object's SoftBody InnerSpringFriction.

Returns:: float

getSBMass()

Get the Object's SoftBody Mass.

Returns:: float

getSBMaxGoal()

Get the Object's SoftBody MaxGoal.

Returns:: float

getSBMinGoal()

Get the Object's SoftBody MinGoal.

Returns:: float

getSBPostDef()

get SoftBodies PostDef option

Returns:: int

getSBStiffQuads()

get SoftBodies StiffQuads option

Returns:: int

getSBUseEdges()

get SoftBodies UseEdges option

Returns:: int

getSBUseGoal()

get SoftBodies UseGoal option

Returns:: int

getScriptLinks(event)

Get a list with this Object's script links of type '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(space)

Parameters:

space - The desired space for the size:

localspace: (default) relative to the object's parent;
worldspace: absolute, taking vertex parents, tracking and Ipo's into account;

Returns the object's size.
(type=string)

Returns:: (SizeX, SizeY, SizeZ)

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

getTimeOffset()

Returns the time offset of the object's animation.

Returns:: TimeOffset

getTracked()

Returns the object's tracked object.

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

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

   objects = Blender.Object.Get()

   for obj in objects:
       if obj.getType() == 'Camera':
           obj.LocY = -obj.LocY
           obj.RotZ = 3.141592 - obj.RotZ

   Blender.Redraw()

Returns:: The type of object.
(type=String)

insertIpoKey(keytype)

Inserts keytype values in object ipo at curframe. Uses module constants.

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

Returns:: None

insertShapeKey()

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

isSB()

Returns the Object's SoftBody enabled state.

Returns:: boolean

isSelected()

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

Returns:: Selection state as True or False
(type=Boolean)

join(objects)

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

Parameters:: objects - A list of objects matching the object's type.
(type=Sequence of Blender Object)

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.

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 - A Blender datablock matching the objects type.
(type=Blender ObData datablock)

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:

 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.

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 - The children of the parent
(type=Sequence of 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.

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 - The children of the parent
(type=Sequence of Blender Object); bonename - a valid bone name from the armature
(type=string); 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 explicitly 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 method for an unlinked object will result in an exception.

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 - The children of the parent
(type=Sequence of 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)

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 - The children of the parent
(type=Sequence of Blender Object); indices - The indices of the vertices you want to parent to (1 or 3 values)
(type=Tuple of Integers); 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)

Make this Object track another.

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

Removes all game properties from an object.

removeProperty(property)

Remove a game property from an object.

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

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 -

0 - unselected
1 - selected

(type=Integer)

setDeltaLocation(delta_location)

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

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

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 - A sum of the following:

2 - axis
4 - texspace
8 - drawname
16 - drawimage
32 - drawwire
64 - xray

(type=Integer)

setDrawType(drawtype)

Sets the object's drawing type.

Parameters:

drawtype - One of the following:

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

(type=Integer)

setEuler(euler)

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

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

setIpo(ipo)

Links an ipo to this object.

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

setLocation(x, y, z)

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

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)

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 - A list of Blender material objects.
(type=Materials list)

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 - a 3x3 or 4x4 Python matrix. If a 3x3 matrix is given, it is extended to a 4x4 matrix.
(type=Py_Matrix 3x3 or 4x4)

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 - The new name for the object.
(type=String)

setPIDeflection(status)

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

Parameters:: status - the new status
(type=int)

Returns:: None

setPIFalloff(falloff)

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

Parameters:: falloff - the Object's Particle Interaction New falloff.
(type=float)

Returns:: None

setPIMaxDist(MaxDist)

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

Parameters:: MaxDist - the Object's Particle Interaction New MaxDist.
(type=float)

Returns:: None

setPIPerm(perm)

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

Parameters:: perm - the Object's Particle Interaction New Permeability.
(type=float)

Returns:: None

setPIRandomDamp(damp)

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

Parameters:: damp - the Object's Particle Interaction New RandomDamp.
(type=float)

Returns:: None

setPIStrength(strength)

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

Parameters:: strength - the Object's Particle Interaction New Strength.
(type=float)

Returns:: None

setPISurfaceDamp(damp)

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

Parameters:: damp - the Object's Particle Interaction New SurfaceDamp.
(type=float)

Returns:: None

setPIType(type)

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

NONE
WIND
FORCE
VORTEX
MAGNET

Parameters:: type - the Object's Particle Interaction Type.
(type=int)

Returns:: None