0% found this document useful (0 votes)

3K views1,518 pages

Blender 2.61.0 API Reference Guide

This document provides an overview of the Blender 2.61.0 API for Python scripting. It introduces key concepts for accessing Blender data from Python, including scenes, objects, and materials. It also describes how to define operators and panels by subclassing Blender types in Python classes. The summary provides examples of accessing object data and defining a simple operator and panel class.

Uploaded by

Matthew Bledsoe

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

3K views1,518 pages

Blender 2.61.0 API Reference Guide

Uploaded by

Matthew Bledsoe

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 1518

Blender Index

Release 2.61.0 - API

1.1.3 Key Concepts

Data Access
Accessing datablocks

Python accesses Blenders data in the same way as the animation system and user interface; this implies that any setting that can be changed via a button can also be changed from Python. Accessing data from the currently loaded blend le is done with the module bpy.data. This gives access to library data. For example:
>>> bpy.data.objects <bpy_collection[3], BlendDataObjects> >>> bpy.data.scenes <bpy_collection[1], BlendDataScenes> >>> bpy.data.materials <bpy_collection[1], BlendDataMaterials>

About Collections

Youll notice that an index as well as a string can be used to access members of the collection. Unlike Pythons dictionaries, both methods are acceptable; however, the index of a member may change while running Blender.
>>> list(bpy.data.objects) [bpy.data.objects["Cube"], bpy.data.objects["Plane"]] >>> bpy.data.objects[Cube] bpy.data.objects["Cube"] >>> bpy.data.objects[0] bpy.data.objects["Cube"]

Accessing attributes

Once you have a data block, such as a material, object, groups etc., its attributes can be accessed much like you would change a setting using the graphical interface. In fact, the tooltip for each button also displays the Python attribute which can help in nding what settings to change in a script.
>>> bpy.data.objects[0].name Camera

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

>>> bpy.data.scenes["Scene"] bpy.data.scenes[Scene] >>> bpy.data.materials.new("MyMaterial") bpy.data.materials[MyMaterial]

For testing what data to access its useful to use the Console, which is its own space type in Blender 2.5. This supports auto-complete, giving you a fast way to dig into different data in your le. Example of a data path that can be quickly found via the console:
>>> bpy.data.scenes[0].render.resolution_percentage 100 >>> bpy.data.scenes[0].objects["Torus"].data.vertices[0].co.x 1.0

Custom Properties

Python can access properties on any datablock that has an ID (data that can be linked in and accessed from bpy.data. When assigning a property, you can make up your own names, these will be created when needed or overwritten if they exist. This data is saved with the blend le and copied with objects. Example:
bpy.context.object["MyOwnProperty"] = 42 if "SomeProp" in bpy.context.object: print("Property found") # Use the get function like a python dictionary # which can have a fallback value. value = bpy.data.scenes["Scene"].get("test_prop", "fallback value") # dictionaries can be assigned as long as they only use basic types. group = bpy.data.groups.new("MyTestGroup") group["GameSettings"] = {"foo": 10, "bar": "spam", "baz": {}} del group["GameSettings"]

Note that these properties can only be assigned basic Python types. int, oat, string array of ints/oats dictionary (only string keys are supported, values must be basic types too) These properties are valid outside of Python. They can be animated by curves or used in driver paths. Context While its useful to be able to access data directly by name or as a list, its more common to operate on the users selection. The context is always available from bpy.context and can be used to get the active object, scene, tool settings along with many other attributes. Common-use cases:

1.1. Quickstart Introduction

Blender Index, Release 2.61.0 - API

>>> bpy.context.object >>> bpy.context.selected_objects >>> bpy.context.visible_bones

Note that the context is read-only. These values cannot be modied directly, though they may be changed by running API functions or by using the data API. So bpy.context.object = obj will raise an error. But bpy.context.scene.objects.active = obj will work as expected. The context attributes change depending on where they are accessed. The 3D view has different context members than the console, so take care when accessing context attributes that the user state is known. See bpy.context API reference Operators (Tools) Operators are tools generally accessed by the user from buttons, menu items or key shortcuts. From the user perspective they are a tool but Python can run these with its own settings through the bpy.ops module. Examples:
>>> bpy.ops.mesh.flip_normals() {FINISHED} >>> bpy.ops.mesh.hide(unselected=False) {FINISHED} >>> bpy.ops.object.scale_apply() {FINISHED}

Note: The menu item: Help -> Operator Cheat Sheet gives a list of all operators and their default values in Python syntax, along with the generated docs. This is a good way to get an overview of all blenders operators.

Operator Poll()

Many operators have a poll function which may check that the mouse is a valid area or that the object is in the correct mode (Edit Mode, Weight Paint etc). When an operators poll function fails within python, an exception is raised. For example, calling bpy.ops.view3d.render_border() from the console raises the following error:
RuntimeError: Operator bpy.ops.view3d.render_border.poll() failed, context is incorrect

In this case the context must be the 3d view with an active camera. To avoid using try/except clauses wherever operators are called you can call the operators own .poll() function to check if it can run in the current context.
if bpy.ops.view3d.render_border.poll(): bpy.ops.view3d.render_border()

1.1.4 Integration
Python scripts can integrate with Blender in the following ways: By dening a rendering engine.

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

By dening operators. By dening menus, headers and panels. By inserting new buttons into existing menus, headers and panels In Python, this is done by dening a class, which is a subclass of an existing type. Example Operator
import bpy

def main(context): for ob in context.scene.objects: print(ob)

class SimpleOperator(bpy.types.Operator): Tooltip bl_idname = "object.simple_operator" bl_label = "Simple Object Operator" @classmethod def poll(cls, context): return context.active_object is not None def execute(self, context): main(context) return {FINISHED}

def register(): bpy.utils.register_class(SimpleOperator)

def unregister(): bpy.utils.unregister_class(SimpleOperator)

if name == "main": register() # test call bpy.ops.object.simple_operator()

Once this script runs, SimpleOperator is registered with Blender and can be called from the operator search popup or added to the toolbar. To run the script: 1. Highlight the above code then press Ctrl+C to copy it. 2. Start Blender 3. Press Ctrl+Right twice to change to the Scripting layout. 4. Click the button labeled New and the conrmation pop up in order to create a new text block. 5. Press Ctrl+V to paste the code into the text panel (the upper left frame).

1.1. Quickstart Introduction

Blender Index, Release 2.61.0 - API

6. Click on the button Run Script. 7. Move youre mouse into the 3D view, press spacebar for the operator search menu, and type Simple. 8. Click on the Simple Operator item found in search. See Also: The class members with the bl_ prex are documented in the API reference bpy.types.Operator Note: The output from the main function is sent to the terminal; in order to see this, be sure to use the terminal.

Example Panel Panels register themselves as a class, like an operator. Notice the extra bl_ variables used to set the context they display in.
import bpy

class HelloWorldPanel(bpy.types.Panel): bl_label = "Hello World Panel" bl_idname = "OBJECT_PT_hello" bl_space_type = "PROPERTIES" bl_region_type = "WINDOW" bl_context = "object" def draw(self, context): layout = self.layout obj = context.object row = layout.row() row.label(text="Hello world!", icon=WORLD_DATA) row = layout.row() row.label(text="Active object is: " + obj.name) row = layout.row() row.prop(obj, "name")

def register(): bpy.utils.register_class(HelloWorldPanel)

def unregister(): bpy.utils.unregister_class(HelloWorldPanel)

if name == "main": register()

To run the script: 1. Highlight the above code then press Ctrl+C to copy it 2. Start Blender 3. Press Ctrl+Right twice to change to the Scripting layout 8 Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

4. Click the button labeled New and the conrmation pop up in order to create a new text block. 5. Press Ctrl+V to paste the code into the text panel (the upper left frame) 6. Click on the button Run Script. To view the results: 1. Select the the default cube. 2. Click on the Object properties icon in the buttons panel (far right; appears as a tiny cube). 3. Scroll down to see a panel named Hello World Panel. 4. Changing the object name also updates Hello World Panels Name: eld. Note the row distribution and the label and properties that are available through the code. See Also: bpy.types.Panel

1.1.5 Types
Blender denes a number of Python types but also uses Python native types. Blenders Python API can be split up into 3 categories. Native Types In simple cases returning a number or a string as a custom type would be cumbersome, so these are accessed as normal python types. blender oat/int/boolean -> oat/int/boolean blender enumerator -> string
>>> C.object.rotation_mode = AXIS_ANGLE

blender enumerator (multiple) -> set of strings

# setting multiple camera overlay guides bpy.context.scene.camera.data.show_guide = {GOLDEN, CENTER} # passing as an operator argument for report types self.report({WARNING, INFO}, "Some message!")

Internal Types Used for Blender datablocks and collections: bpy.types.bpy_struct For data that contains its own attributes groups/meshes/bones/scenes... etc. There are 2 main types that wrap Blenders data, one for datablocks (known internally as bpy_struct), another for properties.
>>> bpy.context.object bpy.data.objects[Cube] >>> C.scene.objects bpy.data.scenes[Scene].objects

1.1. Quickstart Introduction

Blender Index, Release 2.61.0 - API

Note that these types reference Blenders data so modifying them is immediately visible. Mathutils Types Used for vectors, quaternion, eulers, matrix and color types, accessible from mathutils Some attributes such as bpy.types.Object.location, bpy.types.PoseBone.rotation_euler and bpy.types.Scene.cursor_location can be accessed as special math types which can be used together and manipulated in various useful ways. Example of a matrix, vector multiplication:
bpy.context.object.matrix_world * bpy.context.object.data.verts[0].co

Note: mathutils types keep a reference to Blenders internal data so changes can be applied back. Example:
# modifies the Z axis in place. bpy.context.object.location.z += 2.0 # location variable holds a reference to the object too. location = bpy.context.object.location location *= 2.0 # Copying the value drops the reference so the value can be passed to # functions and modified without unwanted side effects. location = bpy.context.object.location.copy()

1.1.6 Animation
There are 2 ways to add keyframes through Python. The rst is through key properties directly, which is similar to inserting a keyframe from the button as a user. You can also manually create the curves and keyframe data, then set the path to the property. Here are examples of both methods. Both examples insert a keyframe on the active objects Z axis. Simple example:
obj = bpy.context.object obj.location[2] = 0.0 obj.keyframe_insert(data_path="location", frame=10.0, index=2) obj.location[2] = 1.0 obj.keyframe_insert(data_path="location", frame=20.0, index=2)

Using Low-Level Functions:

obj = bpy.context.object obj.animation_data_create() obj.animation_data.action = bpy.data.actions.new(name="MyAction") fcu_z = obj.animation_data.action.fcurves.new(data_path="location", index=2) fcu_z.keyframe_points.add(2) fcu_z.keyframe_points[0].co = 10.0, 0.0 fcu_z.keyframe_points[1].co = 20.0, 1.0

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

1.2 Python API Overview

This document is to give an understanding of how python and blender t together, covering some of the functionality that isnt obvious from reading the API reference and example scripts.

1.2.1 Python in Blender

Blender embeds a python interpreter which is started with blender and stays active. This interpreter runs scripts to draw the user interface and is used for some of Blenders internal tools too. This is a typical python environment so tutorials on how to write python scripts will work running the scripts in blender too. Blender provides the bpy module to the python interpreter. This module can be imported in a script and gives access to blender data, classes, and functions. Scripts that deal with blender data will need to import this module. Here is a simple example of moving a vertex of the object named Cube:
import bpy bpy.data.objects["Cube"].data.vertices[0].co.x += 1.0

This modies Blenders internal data directly. When you run this in the interactive console you will see the 3D viewport update.

1.2.2 The Default Environment

When developing your own scripts it may help to understand how blender sets up its python environment. Many python scripts come bundled with blender and can be used as a reference because they use the same API that script authors write tools in. Typical usage for scripts include: user interface, import/export, scene manipulation, automation, dening your own toolset and customization. On startup blender scans the scripts/startup/ directory for python modules and imports them. The exact location of this directory depends on your installation. See the directory layout docs

1.2.3 Script Loading

This may seem obvious but its important to note the difference between executing a script directly or importing it as a module. Scripts that extend blender - dene classes that exist beyond the scripts execution, this makes future access to these classes (to unregister for example) more difcult than importing as a module where class instance is kept in the module and can be accessed by importing that module later on. For this reason its preferable to only use directly execute scripts that dont extend blender by registering classes. Here are some ways to run scripts directly in blender. Loaded in the text editor and press Run Script. Typed or pasted into the interactive console. Execute a python le from the command line with blender, eg: blender --python /home/me/my_script.py To run as modules: The obvious way, import some_module command from the text window or interactive console. Open as a text block and tick Register option, this will load with the blend le. 1.2. Python API Overview 11

Blender Index, Release 2.61.0 - API

copy into one of the directories scripts/startup, where they will be automatically imported on startup. dene as an addon, enabling the addon will load it as a python module. Addons Some of blenders functionality is best kept optional, alongside scripts loaded at startup we have addons which are kept in their own directory scripts/addons, and only load on startup if selected from the user preferences. The only difference between addons and built-in python modules is that addons must contain a bl_info variable which blender uses to read metadata such as name, author, category and URL. The user preferences addon listing uses bl_info to display information about each addon. See Addons for details on the bl_info dictionary.

1.2.4 Integration through Classes

Running python scripts in the text editor is useful for testing but youll want to extend blender to make tools accessible like other built-in functionality. The blender python api allows integration for: bpy.types.Panel bpy.types.Menu bpy.types.Operator bpy.types.PropertyGroup bpy.types.KeyingSet bpy.types.RenderEngine This is intentionally limited. Currently, for more advanced features such as mesh modiers, object types, or shader nodes, C/C++ must be used. For python intergration Blender denes methods which are common to all types. This works by creating a python subclass of a Blender class which contains variables and functions specied by the parent class which are pre-dened to interface with Blender. For example:
import bpy class SimpleOperator(bpy.types.Operator): bl_idname = "object.simple_operator" bl_label = "Tool Name" def execute(self, context): print("Hello World") return {FINISHED} bpy.utils.register_class(SimpleOperator)

First note that we subclass a member of bpy.types, this is common for all classes which can be integrated with blender and used so we know if this is an Operator and not a Panel when registering. Both class properties start with a bl_ prex. This is a convention used to distinguish blender properties from those you add yourself.

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

Next see the execute function, which takes an instance of the operator and the current context. A common prex is not used for functions. Lastly the register function is called, this takes the class and loads it into blender. See Class Registration. Regarding inheritance, blender doesnt impose restrictions on the kinds of class inheritance used, the registration checks will use attributes and functions dened in parent classes. class mix-in example:
import bpy class BaseOperator: def execute(self, context): print("Hello World BaseClass") return {FINISHED} class SimpleOperator(bpy.types.Operator, BaseOperator): bl_idname = "object.simple_operator" bl_label = "Tool Name" bpy.utils.register_class(SimpleOperator)

Notice these classes dont dene an __init__(self) function. While __init__() and __del__() will be called if dened, the class instances lifetime only spans the execution. So a panel for example will have a new instance for every redraw, for this reason there is rarely a cause to store variables in the panel instance. Instead, persistent variables should be stored in Blenders data so that the state can be restored when blender is restarted. Note: Modal operators are an exception, keeping their instance variable as blender runs, see modal operator template. So once the class is registered with blender, instancing the class and calling the functions is left up to blender. In fact you cannot instance these classes from the script as you would expect with most python APIs. To run operators you can call them through the operator api, eg:
import bpy bpy.ops.object.simple_operator()

User interface classes are given a context in which to draw, buttons window, le header, toolbar etc, then they are drawn when that area is displayed so they are never called by python scripts directly.

1.2.5 Registration
Module Registration Blender modules loaded at startup require register() and unregister() functions. These are the only functions that blender calls from your code, which is otherwise a regular python module. A simple blender/python module can look like this:
import bpy class SimpleOperator(bpy.types.Operator): """ See example above """ def register(): bpy.utils.register_class(SimpleOperator) def unregister():

1.2. Python API Overview

Blender Index, Release 2.61.0 - API

bpy.utils.unregister_class(SimpleOperator) if name == "main": register()

These functions usually appear at the bottom of the script containing class registration sometimes adding menu items. You can also use them for internal purposes setting up data for your own tools but take care since register wont re-run when a new blend le is loaded. The register/unregister calls are used so its possible to toggle addons and reload scripts while blender runs. If the register calls were placed in the body of the script, registration would be called on import, meaning there would be no distinction between importing a module or loading its classes into blender. This becomes problematic when a script imports classes from another module making it difcult to manage which classes are being loaded and when. The last 2 lines are only for testing:
if __name__ == "__main__": register()

This allows the script to be run directly in the text editor to test changes. This register() call wont run when the script is imported as a module since __main__ is reserved for direct execution. Class Registration Registering a class with blender results in the class denition being loaded into blender, where it becomes available alongside existing functionality. Once this class is loaded you can access it from bpy.types, using the bl_idname rather than the classes original name. When loading a class, blender performs sanity checks making sure all required properties and functions are found, that properties have the correct type, and that functions have the right number of arguments. Mostly you will not need concern yourself with this but if there is a problem with the class denition it will be raised on registering: Using the function arguments def execute(self, context, spam), will raise an exception: ValueError: expected Operator, SimpleOperator class "execute" function to have 2 args, found 3 Using bl_idname = 1 will raise. TypeError: validating class error: type, not int
Multiple-Classes

Operator.bl_idname expected a string

Loading classes into blender is described above, for simple cases calling bpy.utils.register_class (SomeClass) is sufcient, but when there are many classes or a packages submodule has its own classes it can be tedious to list them all for registration. For more convenient loading/unloading bpy.utils.register_module bpy.utils.unregister_module (module) functions exist. A script which denes many of its own operators, panels menus etc. you only need to write: (module) and

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

def register(): bpy.utils.register_module(name) def unregister(): bpy.utils.unregister_module(name)

Internally blender collects subclasses on registrable types, storing them by the module in which they are dened. By passing the module name to bpy.utils.register_module blender can register all classes created by this module and its submodules.
Inter Classes Dependencies

When customizing blender you may want to group your own settings together, after all, they will likely have to co-exist with other scripts. To group these properties classes need to be dened, for groups within groups or collections within groups you can nd yourself having to deal with order of registration/unregistration. Custom properties groups are themselves classes which need to be registered. Say you want to store material settings for a custom engine.
# Create new property # bpy.data.materials[0].my_custom_props.my_float import bpy class MyMaterialProps(bpy.types.PropertyGroup): my_float = bpy.props.FloatProperty() def register(): bpy.utils.register_class(MyMaterialProps) bpy.types.Material.my_custom_props = bpy.props.PointerProperty(type=MyMaterialProps) def unregister(): del bpy.types.Material.my_custom_props bpy.utils.unregister_class(MyMaterialProps) if __name__ == "__main__": register()

Note: The class must be registered before being used in a property, failing to do so will raise an error: ValueError: bpy_struct "Material" registration error: not register
# Create new property group with a sub property # bpy.data.materials[0].my_custom_props.sub_group.my_float import bpy class MyMaterialSubProps(bpy.types.PropertyGroup): my_float = bpy.props.FloatProperty() class MyMaterialGroupProps(bpy.types.PropertyGroup): sub_group = bpy.props.PointerProperty(type=MyMaterialSubProps) def register(): bpy.utils.register_class(MyMaterialSubProps) bpy.utils.register_class(MyMaterialGroupProps)

my_custom_props could

1.2. Python API Overview

Blender Index, Release 2.61.0 - API

bpy.types.Material.my_custom_props = bpy.props.PointerProperty(type=MyMaterialGroupProps) def unregister(): del bpy.types.Material.my_custom_props bpy.utils.unregister_class(MyMaterialGroupProps) bpy.utils.unregister_class(MyMaterialSubProps) if __name__ == "__main__": register()

Note: The lower most class needs to be registered rst and that unregister() is a mirror of register()

Manipulating Classes

Properties can be added and removed as blender runs, normally happens on register or unregister but for some special cases it may be useful to modify types as the script runs. For example:
# add a new property to an existing type bpy.types.Object.my_float = bpy.props.FloatProperty() # remove del bpy.types.Object.my_float

This works just as well for PropertyGroup subclasses you dene yourself.
class MyPropGroup(bpy.types.PropertyGroup): pass MyPropGroup.my_float = bpy.props.FloatProperty()

...this is equivalent to:

class MyPropGroup(bpy.types.PropertyGroup): my_float = bpy.props.FloatProperty()

Dynamic Dened-Classes (Advanced)

In some cases the specier for data may not be in blender, renderman shader denitions for example and it may be useful to dene types and remove them on the y.
for i in range(10): idname = "object.operator_%d" % i def func(self, context): print("Hello World", self.bl_idname) return {FINISHED} opclass = type("DynOp%d" % i, (bpy.types.Operator, ), {"bl_idname": idname, "bl_label": "Test", "execute": func}, ) bpy.utils.register_class(opclass)

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

Note: Notice type() is called to dene the class. This is an alternative syntax for class creation in python, better suited to constructing classes dynamically. Calling these operators:
>>> bpy.ops.object.operator_1() Hello World OBJECT_OT_operator_1 {FINISHED} >>> bpy.ops.object.operator_2() Hello World OBJECT_OT_operator_2 {FINISHED}

1.3 Best Practice

When writing youre own scripts python is great for new developers to pick up and become productive, but you can also pick up odd habits or at least write scripts that are not easy for others to understand. For youre own work this is of course ne, but if you want to collaborate with others or have youre work included with blender there are practices we encourage.

1.3.1 Style Conventions

For Blender 2.5 we have chosen to follow python suggested style guide to avoid mixing styles amongst our own scripts and make it easier to use python scripts from other projects. Using our style guide for your own scripts makes it easier if you eventually want to contribute them to blender. This style guide is known as pep8 and can be found here A brief listing of pep8 criteria. camel caps for class names: MyClass all lower case underscore separated module names: my_module indentation of 4 spaces (no tabs) spaces around operators. 1 + 1, not 1+1 only use explicit imports, (no importing *) dont use single line: if val: body, separate onto 2 lines instead.

As well as pep8 we have other conventions used for blender python scripts. Use single quotes for enums, and double quotes for strings. Both are of course strings but in our internal API enums are unique items from a limited set. eg.
bpy.context.scene.render.image_settings.file_format = PNG bpy.context.scene.render.filepath = "//render_out"

pep8 also denes that lines should not exceed 79 characters, we felt this is too restrictive so this is optional per script. Periodically we run checks for pep8 compliance on blender scripts, for scripts to be included in this check add this line as a comment at the top of the script. # <pep8 compliant> 1.3. Best Practice 17

Blender Index, Release 2.61.0 - API

To enable line length checks use this instead. # <pep8-80 compliant>

1.3.2 User Interface Layout

TODO: Thomas

1.3.3 Script Efciency

List Manipulation (General Python Tips)
Searching for list items

In Python there are some handy list functions that save you having to search through the list. Even though youre not looping on the list data python is, so you need to be aware of functions that will slow down your script by searching the whole list.
my_list.count(list_item) my_list.index(list_item) my_list.remove(list_item) if list_item in my_list: ...

Modifying Lists

In python we can add and remove from a list, This is slower when the list length is modier, especially at the start of the list, since all the data after the index of modication needs to be moved up or down 1 place. The most simple way to add onto the end of the list is to use my_list.append(list_item) or my_list.extend(some_list) and the fastest way to remove an item is my_list.pop() or del my_list[-1]. To use an index you can use my_list.insert(index, list_item) or list.pop(index) for list removal, but these are slower. Sometimes its faster (but more memory hungry) to just rebuild the list. Say you want to remove all triangle faces in a list. Rather than...
faces = mesh.faces[:] f_idx = len(faces) while f_idx: f_idx -= 1 # make a list copy of the meshes faces # Loop backwards # while the value is not 0

if len(faces[f_idx].vertices) == 3: faces.pop(f_idx) # remove the triangle

Its faster to build a new list with list comprehension.

faces = [f for f in mesh.faces if len(f.vertices) != 3]

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

Adding List Items

If you have a list that you want to add onto another list, rather then...
for l in some_list: my_list.append(l)

Use...
my_list.extend([a, b, c...])

Note that insert can be used when needed, but it is slower than append especially when inserting at the start of a long list. This example shows a very sub-optimal way of making a reversed list.
reverse_list = [] for list_item in some_list: reverse_list.insert(0, list_item)

Removing List Items

Use my_list.pop(index) rather than my_list.remove(list_item) This requires you to have the index of the list item but is faster since remove() will search the list. Here is an example of how to remove items in 1 loop, removing the last items rst, which is faster (as explained above).
list_index = len(my_list) while list_index: list_index -= 1 if my_list[list_index].some_test_attribute == 1: my_list.pop(list_index)

This example shows a fast way of removing items, for use in cases were where you can alter the list order without breaking the scripts functionality. This works by swapping 2 list items, so the item you remove is always last.
pop_index = 5 # swap so the pop_index is last. my_list[-1], my_list[pop_index] = my_list[pop_index], my_list[-1] # remove last item (pop_index) my_list.pop()

When removing many items in a large list this can provide a good speedup.
Avoid Copying Lists

When passing a list/dictionary to a function, it is faster to have the function modify the list rather then returning a new list so python doesnt have to duplicate the list in memory. Functions that modify a list in-place are more efcient then functions that create new lists. This is generally slower so only use for functions when it makes sense not to modify the list in place.

1.3. Best Practice

Blender Index, Release 2.61.0 - API

>>> my_list = some_list_func(my_list)

This is generally faster since there is no re-assignment and no list duplication.

>>> some_list_func(vec)

Also note that passing a sliced list makes a copy of the list in python memory
>>> foobar(my_list[:])

If my_list was a large array containing 10000s of items, a copy could use a lot of extra memory. Writing Strings to a File (Python General) Here are 3 ways of joining multiple strings into 1 string for writing This really applies to any area of your code that involves a lot of string joining. Pythons string addition, dont use if you can help it, especially when writing data in a loop.
>>> file.write(str1 + " " + str2 + " " + str3 + "\n")

String formatting. Use this when youre writing string data from oats and ints
>>> file.write("%s %s %s\n" % (str1, str2, str3))

Pythons string joining function. To join a list of strings

>>> file.write(" ".join([str1, str2, str3, "\n"]))

join is fastest on many strings, string formatting is quite fast too (better for converting data types). String arithmetic is slowest. Parsing Strings (Import/Exporting) Since many le formats are ASCII, the way you parse/export strings can make a large difference in how fast your script runs. When importing strings to make into blender there are a few ways to parse the string.
Parsing Numbers

Use float(string) rather than eval(string), if you know the value will be an int then int(string), oat() will work for an int too but its faster to read ints with int().
Checking String Start/End

If your checking the start of a string for a keyword, rather than...

>>> if line[0:5] == "vert ": ...

Use...
>>> if line.startswith("vert "):

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

Using startswith() is slightly faster (approx 5%) and also avoids a possible error with the slice length not matching the string length. my_string.endswith(foo_bar) can be used for line endings too. if your unsure whether the text is upper or lower case use lower or upper string function.
>>> if line.lower().startswith("vert ")

Use try/except Sparingly The try statement useful to save time writing error checking code. However try is signicantly slower then an if since an exception has to be set each time, so avoid using try in areas of your code that execute in a loop and runs many times. There are cases where using try is faster than checking weather the condition will raise an error, so it is worth experimenting. Value Comparison Python has two ways to compare values a == b and a is b, The difference is that == may run the objects comparison function __cmp__() where as is compares identity, that both variables reference the same item in memory. In cases where you know you are checking for the same value which is referenced from multiple places, is is faster. Time Youre Code While developing a script its good to time it to be aware of any changes in performance, this can be done simply.
import time time_start = time.time() # do something... print("My Script Finished: %.4f sec" % time.time() - time_start)

1.4 Tips and Tricks

Here are various suggestions that you might nd useful when writing scripts. Some of these are just python features that scripters may not have thought to use with blender, others are blender specic.

1.4.1 Use The Terminal

When writing python scripts, its useful to have a terminal open, this is not the built-in python console but a terminal application which is used to start blender. There are 3 main uses for the terminal, these are: You can see the output of print() as youre script runs, which is useful to view debug info. The error trace-back is printed in full to the terminal which wont always generate an error popup in blenders user interface (depending on how the script is executed). 1.4. Tips and Tricks 21

Blender Index, Release 2.61.0 - API

If the script runs for too long or you accidentally enter an innite loop, Ctrl+C in the terminal (Ctrl+Break on Windows) will quit the script early. Note: For Linux and OSX users this means starting the terminal rst, then running blender from within it. On Windows the terminal can be enabled from the help menu.

1.4.2 Show All Operators

While blender logs operators in the Info space, this only reports operators with the REGISTER option enabeld so as not to ood the Info view with calls to bpy.ops.view3d.smoothview and bpy.ops.view3d.zoom. However, for testing it can be useful to see every operator called in a terminal, do this by enabling the debug option either by passing the --debug argument when starting blender or by setting bpy.app.debug to True while blender is running.

1.4.3 Use an External Editor

Blenders text editor is ne for small changes and writing tests but its not full featured, for larger projects youll probably want to use a standalone editor or python IDE. Editing a text le externally and having the same text open in blender does work but isnt that optimal so here are 2 ways you can easily use an external le from blender. Using the following examples youll still need textblock in blender to execute, but reference an external le rather then including it directly. Executing External Scripts This is the equivalent to running the script directly, referencing a scripts path from a 2 line textblock.
filename = "/full/path/to/myscript.py" exec(compile(open(filename).read(), filename, exec))

You might want to reference a script relative to the blend le.

import bpy import os filename = os.path.join(os.path.basename(bpy.data.filepath), "myscript.py") exec(compile(open(filename).read(), filename, exec))

Executing Modules This example shows loading a script in as a module and executing a module function.
import myscript import imp imp.reload(myscript) myscript.main()

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

Notice that the script is reloaded every time, this forces use of the modied version, otherwise the cached one in sys.modules would be used until blender was restarted. The important difference between this and executing the script directly is it has to call a function in the module, in this case main() but it can be any function, an advantage with this is you can pass arguments to the function from this small script which is often useful for testing different settings quickly. The other issue with this is the script has to be in pythons module search path. While this is not best practice - for testing you can extend the search path, this example adds the current blend les directory to the search path, then loads the script as a module.
import sys import os import bpy blend_dir = os.path.basename(bpy.data.filepath) if blend_dir not in sys.path: sys.path.append(blend_dir) import myscript import imp imp.reload(myscript) myscript.main()

1.4.4 Dont Use Blender!

While developing your own scripts blenders interface can get in the way, manually reloading, running the scripts, opening le import etc. adds overhead. For scripts that are not interactive it can end up being more efcient not to use blenders interface at all and instead execute the script on the command line.
blender --background --python myscript.py

You might want to run this with a blend le so the script has some data to operate on.
blender myscene.blend --background --python myscript.py

Note: Depending on your setup you might have to enter the full path to the blender executable. Once the script is running properly in background mode, youll want to check the output of the script, this depends completely on the task at hand however here are some suggestions. render the output to an image, use an image viewer and keep writing over the same image each time. save a new blend le, or export the le using one of blenders exporters. if the results can be displayed as text - print them or write them to a le. This can take a little time to setup, but it can be well worth the effort to reduce the time it takes to test changes you can even have blender running the script ever few seconds with a viewer updating the results, so no need to leave youre text editor to see changes.

1.4.5 Use External Tools

When there are no readily available python modules to perform specic tasks its worth keeping in mind you may be able to have python execute an external command on youre data and read the result back in. 1.4. Tips and Tricks 23

Blender Index, Release 2.61.0 - API

Using external programs adds an extra dependency and may limit who can use the script but to quickly setup youre own custom pipeline or writing one-off scripts this can be handy. Examples include: Run The Gimp in batch mode to execute custom scripts for advanced image processing. Write out 3D models to use external mesh manipulation tools and read back in the results. Convert les into recognizable formats before reading.

1.4.6 Bundled Python & Extensions

The Blender releases distributed from blender.org include a complete python installation on all platforms, this has the disadvantage that any extensions you have installed in youre systems python wont be found by blender. There are 2 ways around this: remove blender python sub-directory, blender will then fallback on the systems python and use that instead python version must match the one that blender comes with. copy the extensions into blenders python sub-directory so blender can access them, you could also copy the entire python installation into blenders sub-directory, replacing the one blender comes with. This works as long as the python versions match and the paths are created in the same relative locations. Doing this has the advantage that you can redistribute this bundle to others with blender and/or the game player, including any extensions you rely on.

1.4.7 Drop Into a Python Interpreter in Youre Script

In the middle of a script you may want to inspect some variables, run some function and generally dig about to see whats going on.
import code code.interact(local=locals())

If you want to access both global and local variables do this...

import code namespace = globals().copy() namespace.update(locals()) code.interact(local=namespace)

The next example is an equivalent single line version of the script above which is easier to paste into youre code:
__import__(code).interact(local={k: v for ns in (globals(), locals()) for k, v in ns.items()})

code.interact can be added at any line in the script and will pause the script an launch an interactive interpreter in the terminal, when youre done you can quit the interpreter and the script will continue execution. Admittedly this highlights the lack of any python debugging support built into blender, but its still handy to know. Note: This works in the game engine as well, it can be handy to inspect the state of a running game.

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

1.4.8 Advanced
Blender as a module From a python perspective its nicer to have everything as an extension which lets the python script combine many components. Advantages include: you can use external editors/IDEs with blenders python API and execute scripts within the IDE (step over code, inspect variables as the script runs). editors/IDEs can auto complete blender modules & variables. existing scripts can import blender APIs without having to run inside blender. This is marked advanced because to run blender as a python module requires a special build option. For instructions on building see Building blender as a python module Python Safety (Build Option) Since its possible to access data which has been removed (see Gotchas), this can be hard to track down the cause of crashes. To raise python exceptions on accessing freed data (rather then crashing), enable the CMake build option WITH_PYTHON_SAFETY. This enables data tracking which makes data access about 2x slower which is why the option is not enabled in release builds.

1.5 Gotchas
This document attempts to help you work with the Blender API in areas that can be troublesome and avoid practices that are known to give instability.

1.5.1 Using Operators

Blenders operators are tools for users to access, that python can access them too is very useful nevertheless operators have limitations that can make them cumbersome to script. Main limits are... Cant pass data such as objects, meshes or materials to operate on (operators use the context instead) The return value from calling an operator gives the success (if it nished or was canceled), in some cases it would be more logical from an API perspective to return the result of the operation. Operators poll function can fail where an API function would raise an exception giving details on exactly why. Why does an operators poll fail? When calling an operator gives an error like this:
>>> bpy.ops.action.clean(threshold=0.001) RuntimeError: Operator bpy.ops.action.clean.poll() failed, context is incorrect

1.5. Gotchas

Blender Index, Release 2.61.0 - API

Which raises the question as to what the correct context might be? Typically operators check for the active area type, a selection or active object they can operate on, but some operators are more picky about when they run. In most cases you can gure out what context an operator needs simply be seeing how its used in Blender and thinking about what it does. Unfortunately if youre still stuck - the only way to really know whats going on is to read the source code for the poll function and see what its checking. For python operators its not so hard to nd the source since its included with Blender and the source le/line is included in the operator reference docs. Downloading and searching the C code isnt so simple, especially if youre not familiar with the C language but by searching the operator name or description you should be able to nd the poll function with no knowledge of C. Note: Blender does have the functionality for poll functions to describe why they fail, but its currently not used much, if youre interested to help improve our API feel free to add calls to CTX_wm_operator_poll_msg_set where its not obvious why poll fails.
>>> bpy.ops.gpencil.draw() RuntimeError: Operator bpy.ops.gpencil.draw.poll() Failed to find Grease Pencil data to draw into

The operator still doesnt work! Certain operators in Blender are only intended for use in a specic context, some operators for example are only called from the properties window where they check the current material, modier or constraint. Examples of this are: bpy.ops.texture.slot_move bpy.ops.constraint.limitdistance_reset bpy.ops.object.modifier_copy bpy.ops.buttons.file_browse Another possibility is that you are the rst person to attempt to use this operator in a script and some modications need to be made to the operator to run in a different context, if the operator should logically be able to run but fails when accessed from a script it should be reported to the bug tracker.

1.5.2 Stale Data

No updates after setting values Sometimes you want to modify values from python and immediately access the updated values, eg: Once changing the objects bpy.types.Object.location you may want to access its transformation right after from bpy.types.Object.matrix_world, but this doesnt work as you might expect. Consider the calculations that might go into working out the objects nal transformation, this includes: animation function curves. drivers and their pythons expressions. constraints

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

parent objects and all of their f-curves, constraints etc. To avoid expensive recalculations every time a property is modied, Blender defers making the actual calculations until they are needed. However, while the script runs you may want to access the updated values. This can be done by calling bpy.types.Scene.update after modifying values which recalculates all data that is tagged to be updated. Can I redraw during the script? The ofcial answer to this is no, or... You dont want to do that. To give some background on the topic... While a script executes Blender waits for it to nish and is effectively locked until its done, while in this state Blender wont redraw or respond to user input. Normally this is not such a problem because scripts distributed with Blender tend not to run for an extended period of time, nevertheless scripts can take ages to execute and its nice to see whats going on in the view port. Tools that lock Blender in a loop and redraw are highly discouraged since they conict with Blenders ability to run multiple operators at once and update different parts of the interface as the tool runs. So the solution here is to write a modal operator, that is - an operator which denes a modal() function, See the modal operator template in the text editor. Modal operators execute on user input or setup their own timers to run frequently, they can handle the events or pass through to be handled by the keymap or other modal operators. Transform, Painting, Fly-Mode and File-Select are example of a modal operators. Writing modal operators takes more effort than a simple for loop that happens to redraw but is more exible and integrates better with Blenders design. Ok, Ok! I still want to draw from python If you insist - yes its possible, but scripts that use this hack wont be considered for inclusion in Blender and any issues with using it wont be considered bugs, this is also not guaranteed to work in future releases.
bpy.ops.wm.redraw_timer(type=DRAW_WIN_SWAP, iterations=1)

1.5.3 Matrix multiplication is wrong

Every so often users complain that Blenders matrix math is wrong, the confusion comes from mathutils matrices being column-major to match OpenGL and the rest of Blenders matrix operations and stored matrix data. This is different to numpy which is row-major which matches what you would expect when using conventional matrix math notation.

1.5.4 I cant edit the mesh in edit-mode!

Blenders EditMesh is an internal data structure (not saved and not exposed to python), this gives the main annoyance that you need to exit edit-mode to edit the mesh from python. The reason we have not made much attempt to x this yet is because we will likely move to BMesh mesh API eventually, so any work on the API now will be wasted effort.

1.5. Gotchas

Blender Index, Release 2.61.0 - API

With the BMesh API we may expose mesh data to python so we can write useful tools in python which are also fast to execute while in edit-mode. For the time being this limitation just has to be worked around but were aware its frustrating needs to be addressed.

1.5.5 EditBones, PoseBones, Bone... Bones

Armature Bones in Blender have three distinct data structures that contain them. If you are accessing the bones through one of them, you may not have access to the properties you really need. Note: In the following examples bpy.context.object is assumed to be an armature object.

Edit Bones bpy.context.object.data.edit_bones contains a editbones; to access them you must set the armature mode to edit mode rst (editbones do not exist in object or pose mode). Use these to create new bones, set their head/tail or roll, change their parenting relationships to other bones, etc. Example using bpy.types.EditBone in armature editmode: This is only possible in edit mode.
>>> bpy.context.object.data.edit_bones["Bone"].head = Vector((1.0, 2.0, 3.0))

This will be empty outside of editmode.

>>> mybones = bpy.context.selected_editable_bones

Returns an editbone only in edit mode.

>>> bpy.context.active_bone

Bones (Object Mode) bpy.context.object.data.bones contains bones. These live in object mode, and have various properties you can change, note that the head and tail properties are read-only. Example using bpy.types.Bone in object or pose mode: Returns a bone (not an editbone) outside of edit mode
>>> bpy.context.active_bone

This works, as with blender the setting can be edited in any mode
>>> bpy.context.object.data.bones["Bone"].use_deform = True

Accessible but read-only

>>> tail = myobj.data.bones["Bone"].tail

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

Pose Bones bpy.context.object.pose.bones contains pose bones. This is where animation data resides, i.e. animatable transformations are applied to pose bones, as are constraints and ik-settings. Examples using bpy.types.PoseBone in object or pose mode:
# Gets the name of the first constraint (if it exists) bpy.context.object.pose.bones["Bone"].constraints[0].name # Gets the last selected pose bone (pose mode only) bpy.context.active_pose_bone

Note: Notice the pose is accessed from the object rather than the object data, this is why blender can have 2 or more objects sharing the same armature in different poses.

Note: Strictly speaking PoseBones are not bones, they are just the state of the armature, stored in the bpy.types.Object rather than the bpy.types.Armature, the real bones are however accessible from the pose bones - bpy.types.PoseBone.bone

Armature Mode Switching While writing scripts that deal with armatures you may nd you have to switch between modes, when doing so take care when switching out of editmode not to keep references to the edit-bones or their head/tail vectors. Further access to these will crash blender so its important the script clearly separates sections of the code which operate in different modes. This is mainly an issue with editmode since pose data can be manipulated without having to be in pose mode, however for operator access you may still need to enter pose mode.

1.5.6 Data Names

Naming Limitations A common mistake is to assume newly created data is given the requested name. This can cause bugs when you add some data (normally imported) and then reference it later by name.
bpy.data.meshes.new(name=meshid) # normally some code, function calls... bpy.data.meshes[meshid]

Or with name assignment...

obj.name = objname # normally some code, function calls... obj = bpy.data.meshes[objname]

Data names may not match the assigned values if they exceed the maximum length, are already used or an empty string.

1.5. Gotchas

Blender Index, Release 2.61.0 - API

Its better practice not to reference objects by names at all, once created you can store the data in a list, dictionary, on a class etc, there is rarely a reason to have to keep searching for the same data by name. If you do need to use name references, its best to use a dictionary to maintain a mapping between the names of the imported assets and the newly created data, this way you dont run this risk of referencing existing data from the blend le, or worse modifying it.
# typically declared in the main body of the function. mesh_name_mapping = {} mesh = bpy.data.meshes.new(name=meshid) mesh_name_mapping[meshid] = mesh # normally some code, or function calls... # use own dictionary rather then bpy.data mesh = mesh_name_mapping[meshid]

Library Collisions Blender keeps data names unique - bpy.types.ID.name so you cant name two objects, meshes, scenes etc the same thing by accident. However when linking in library data from another blend le naming collisions can occur, so its best to avoid referencing data by name at all. This can be tricky at times and not even blender handles this correctly in some case (when selecting the modier object for eg you cant select between multiple objects with the same name), but its still good to try avoid problems in this area. If you need to select between local and library data, there is a feature in bpy.data members to allow for this.
# typical name lookup, could be local or library. obj = bpy.data.objects["my_obj"] # library object name look up using a pair # where the second argument is the library path matching bpy.types.Library.filepath obj = bpy.data.objects["my_obj", "//my_lib.blend"] # local object name look up using a pair # where the second argument excludes library data from being returned. obj = bpy.data.objects["my_obj", None] # both the examples above also works for get obj = bpy.data.objects.get(("my_obj", None))

1.5.7 Relative File Paths

Blenders relative le paths are not compatible with standard python modules such as sys and os. Built in python functions dont understand blenders // prex which denotes the blend le path. A common case where you would run into this problem is when exporting a material with associated image paths.
>>> bpy.path.abspath(image.filepath)

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

When using blender data from linked libraries there is an unfortunate complication since the path will be relative to the library rather then the open blend le. When the data block may be from an external blend le pass the library argument from the bpy.types.ID.
>>> bpy.path.abspath(image.filepath, library=image.library)

These returns the absolute path which can be used with native python modules.

1.5.8 Unicode Problems

Python supports many different encodings so there is nothing stopping you from writing a script in latin1 or iso-885915. See pep-0263 However this complicates things for the python api because blend les themselves dont have an encoding. To simplify the problem for python integration and script authors we have decided all strings in blend les must be UTF-8 or ASCII compatible. This means assigning strings with different encodings to an object names for instance will raise an error. Paths are an exception to this rule since we cannot ignore the existane of non-utf-8 paths on peoples lesystems. This means seemingly harmless expressions can raise errors, eg.

>>> print(bpy.data.filepath) UnicodeEncodeError: ascii codec cant encode characters in position 10-21: ordinal not in range(128 >>> bpy.context.object.name = bpy.data.filepath Traceback (most recent call last): File "<blender_console>", line 1, in <module> TypeError: bpy_struct: item.attr= val: Object.name expected a string type, not str

Here are 2 ways around lesystem encoding issues:

>>> print(repr(bpy.data.filepath)) >>> >>> >>> >>> import os filepath_bytes = os.fsencode(bpy.data.filepath) filepath_utf8 = filepath_bytes.decode(utf-8, "replace") bpy.context.object.name = filepath_utf8

Unicode encoding/decoding is a big topic with comprehensive python documentation, to avoid getting stuck too deep in encoding problems - here are some suggestions: Always use utf-8 encoiding or convert to utf-8 where the input is unknown. Avoid manipulating lepaths as strings directly, use os.path functions instead. Use os.fsencode() / os.fsdecode() rather then the built in string decoding functions when operating on paths. To print paths or to include them in the user interface use repr(path) rst or "%r" % path with string formatting. Possibly - use bytes instead of python strings, when reading some input its less trouble to read it as binary data though you will still need to decide how to treat any strings you want to use with Blender, some importers do this.

1.5. Gotchas

Blender Index, Release 2.61.0 - API

1.5.9 Strange errors using threading module

Python threading with Blender only works properly when the threads nish up before the script does. By using threading.join() for example. Heres an example of threading supported by Blender:
import threading import time def prod(): print(threading.current_thread().name, "Starting") # do something vaguely useful import bpy from mathutils import Vector from random import random prod_vec = Vector((random() - 0.5, random() - 0.5, random() - 0.5)) print("Prodding", prod_vec) bpy.data.objects["Cube"].location += prod_vec time.sleep(random() + 1.0) # finish print(threading.current_thread().name, "Exiting") threads = [threading.Thread(name="Prod %d" % i, target=prod) for i in range(10)]

print("Starting threads...") for t in threads: t.start() print("Waiting for threads to finish...") for t in threads: t.join()

This an example of a timer which runs many times a second and moves the default cube continuously while Blender runs (Unsupported).
def func(): print("Running...") import bpy bpy.data.objects[Cube].location.x += 0.05 def my_timer(): from threading import Timer t = Timer(0.1, my_timer) t.start() func() my_timer()

Use cases like the one above which leave the thread running once the script nishes may seem to work for a while but end up causing random crashes or errors in Blenders own drawing code. So far, no work has gone into making Blenders python integration thread safe, so until its properly supported, best not make use of this. 32 Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

Note: Pythons threads only allow co-currency and wont speed up your scripts on multi-processor systems, the subprocess and multiprocess modules can be used with blender and make use of multiple CPUs too.

1.5.10 Help! My script crashes Blender

Ideally it would be impossible to crash Blender from python however there are some problems with the API where it can be made to crash. Strictly speaking this is a bug in the API but xing it would mean adding memory verication on every access since most crashes are caused by the python objects referencing Blenders memory directly, whenever the memory is freed, further python access to it can crash the script. But xing this would make the scripts run very slow, or writing a very different kind of API which doesnt reference the memory directly. Here are some general hints to avoid running into these problems. Be aware of memory limits, especially when working with large lists since Blender can crash simply by running out of memory. Many hard to x crashes end up being because of referencing freed data, when removing data be sure not to hold any references to it. Modules or classes that remain active while Blender is used, should not hold references to data the user may remove, instead, fetch data from the context each time the script is activated. Crashes may not happen every time, they may happen more on some congurations/operating-systems. Undo/Redo Undo invalidates all bpy.types.ID instances (Object, Scene, Mesh etc). This example shows how you can tell undo changes the memory locations.
>>> hash(bpy.context.object) -9223372036849950810 >>> hash(bpy.context.object) -9223372036849950810

# ... move the active object, then undo

>>> hash(bpy.context.object) -9223372036849951740

As suggested above, simply not holding references to data when Blender is used interactively by the user is the only way to ensure the script doesnt become unstable. Edit Mode / Memory Access Switching edit-mode bpy.ops.object.mode_set(mode=EDIT) / bpy.ops.object.mode_set(mode=OBJECT) will re-allocate objects data, any references to a meshes vertices/faces/uvs, armatures bones, curves points etc cannot be accessed after switching edit-mode. Only the reference to the data its self can be re-accessed, the following example will crash.

1.5. Gotchas

Blender Index, Release 2.61.0 - API

mesh = bpy.context.active_object.data faces = mesh.faces bpy.ops.object.mode_set(mode=EDIT) bpy.ops.object.mode_set(mode=OBJECT) # this will crash print(faces)

So after switching edit-mode you need to re-access any object data variables, the following example shows how to avoid the crash above.
mesh = bpy.context.active_object.data faces = mesh.faces bpy.ops.object.mode_set(mode=EDIT) bpy.ops.object.mode_set(mode=OBJECT) # faces have been re-allocated faces = mesh.faces print(faces)

These kinds of problems can happen for any functions which re-allocate the object data but are most common when switching edit-mode. Array Re-Allocation When adding new points to a curve or verticess/edges/faces to a mesh, internally the array which stores this data is re-allocated.
bpy.ops.curve.primitive_bezier_curve_add() point = bpy.context.object.data.splines[0].bezier_points[0] bpy.context.object.data.splines[0].bezier_points.add() # this will crash! point.co = 1.0, 2.0, 3.0

This can be avoided by re-assigning the point variables after adding the new one or by storing indicess to the points rather then the points themselves. The best way is to sidestep the problem altogether add all the points to the curve at once. This means you dont have to worry about array re-allocation and its faster too since reallocating the entire array for every point added is inefcient. Removing Data Any data that you remove shouldnt be modied or accessed afterwards, this includes f-curves, drivers, render layers, timeline markers, modiers, constraints along with objects, scenes, groups, bones.. etc. This is a problem in the API at the moment that we should eventually solve.

1.5.11 sys.exit
Some python modules will call sys.exit() themselves when an error occurs, while not common behavior this is something to watch out for because it may seem as if blender is crashing since sys.exit() will quit blender immediately. For example, the optparse module will print an error and exit if the arguments are invalid.

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

An ugly way of troubleshooting this is to set sys.exit = None and see what line of python code is quitting, you could of course replace sys.exit/ with your own function but manipulating python in this way is bad practice.

1.5. Gotchas

Blender Index, Release 2.61.0 - API

Chapter 1. Blender/Python Documentation

CHAPTER

TWO

APPLICATION MODULES
2.1 Context Access (bpy.context)
The context members available depend on the area of blender which is currently being accessed. Note that all context values are readonly, but may be modied through the data api or by running operators

2.1.1 Screen Context

bpy.context.scene Type bpy.types.Scene bpy.context.visible_objects Type sequence of bpy.types.Object bpy.context.visible_bases Type sequence of bpy.types.ObjectBase bpy.context.selectable_objects Type sequence of bpy.types.Object bpy.context.selectable_bases Type sequence of bpy.types.ObjectBase bpy.context.selected_objects Type sequence of bpy.types.Object bpy.context.selected_bases Type sequence of bpy.types.ObjectBase bpy.context.selected_editable_objects Type sequence of bpy.types.Object bpy.context.selected_editable_bases Type sequence of bpy.types.ObjectBase bpy.context.visible_bones Type sequence of bpy.types.Object bpy.context.editable_bones 37

Blender Index, Release 2.61.0 - API

Type sequence of bpy.types.EditBone bpy.context.selected_bones Type sequence of bpy.types.Bone bpy.context.selected_editable_bones Type sequence of bpy.types.Bone bpy.context.visible_pose_bones Type sequence of bpy.types.PoseBone bpy.context.selected_pose_bones Type sequence of bpy.types.PoseBone bpy.context.active_bone Type bpy.types.Bone bpy.context.active_pose_bone Type bpy.types.PoseBone bpy.context.active_base Type bpy.types.ObjectBase bpy.context.active_object Type bpy.types.Object bpy.context.object Type bpy.types.Object bpy.context.edit_object Type bpy.types.Object bpy.context.sculpt_object Type bpy.types.Object bpy.context.vertex_paint_object Type bpy.types.Object bpy.context.weight_paint_object Type bpy.types.Object bpy.context.image_paint_object Type bpy.types.Object bpy.context.particle_edit_object Type bpy.types.Object bpy.context.sequences Type sequence of bpy.types.Sequence bpy.context.selected_sequences Type sequence of bpy.types.Sequence bpy.context.selected_editable_sequences

Chapter 2. Application Modules

Blender Index, Release 2.61.0 - API

Type sequence of bpy.types.Sequence bpy.context.active_operator Type bpy.types.Operator

2.1.2 View3D Context

bpy.context.selected_objects Type sequence of bpy.types.Object bpy.context.selected_bases Type sequence of bpy.types.ObjectBase bpy.context.selected_editable_objects Type sequence of bpy.types.Object bpy.context.selected_editable_bases Type sequence of bpy.types.ObjectBase bpy.context.visible_objects Type sequence of bpy.types.Object bpy.context.visible_bases Type sequence of bpy.types.ObjectBase bpy.context.selectable_objects Type sequence of bpy.types.Object bpy.context.selectable_bases Type sequence of bpy.types.ObjectBase bpy.context.active_base Type bpy.types.ObjectBase bpy.context.active_object Type bpy.types.Object

2.1.3 Buttons Context

bpy.context.world Type bpy.types.World bpy.context.object Type bpy.types.Object bpy.context.mesh Type bpy.types.Mesh bpy.context.armature Type bpy.types.Armature bpy.context.lattice 2.1. Context Access (bpy.context) 39

Blender Index, Release 2.61.0 - API

Type bpy.types.Lattice bpy.context.curve Type bpy.types.Curve bpy.context.meta_ball Type bpy.types.MetaBall bpy.context.lamp Type bpy.types.Lamp bpy.context.speaker Type bpy.types.Speaker bpy.context.camera Type bpy.types.Camera bpy.context.material Type bpy.types.Material bpy.context.material_slot Type bpy.types.MaterialSlot bpy.context.texture Type bpy.types.Texture bpy.context.texture_slot Type bpy.types.MaterialTextureSlot bpy.context.texture_user Type bpy.types.ID bpy.context.bone Type bpy.types.Bone bpy.context.edit_bone Type bpy.types.EditBone bpy.context.pose_bone Type bpy.types.PoseBone bpy.context.particle_system Type bpy.types.ParticleSystem bpy.context.particle_system_editable Type bpy.types.ParticleSystem bpy.context.cloth Type bpy.types.ClothModifier bpy.context.soft_body Type bpy.types.SoftBodyModifier bpy.context.fluid

Chapter 2. Application Modules

Blender Index, Release 2.61.0 - API

Type bpy.types.FluidSimulationModifier bpy.context.smoke Type bpy.types.SmokeModifier bpy.context.collision Type bpy.types.CollisionModifier bpy.context.brush Type bpy.types.Brush bpy.context.dynamic_paint Type bpy.types.DynamicPaintModifier

2.1.4 Image Context

bpy.context.edit_image Type bpy.types.Image

2.1.5 Node Context

bpy.context.selected_nodes Type sequence of bpy.types.Node

2.1.6 Text Context

bpy.context.edit_text Type bpy.types.Text

2.2 Data Access (bpy.data)

This module is used for all blender/python access. bpy.data Access to blenders internal data Type bpy.types.BlendData
import bpy

# print all objects for obj in bpy.data.objects: print(obj.name)

# print all scene names in a list print(bpy.data.scenes.keys())

2.2. Data Access (bpy.data)

Blender Index, Release 2.61.0 - API

# remove mesh Cube if "Cube" in bpy.data.meshes: mesh = bpy.data.meshes["Cube"] print("removing mesh", mesh) bpy.data.meshes.remove(mesh)

# write images into a file next to the blend import os file = open(os.path.splitext(bpy.data.filepath)[0] + ".txt", w) for image in bpy.data.images: file.write("%s %d x %d\n" % (image.filepath, image.size[0], image.size[1])) file.close()

2.3 Operators (bpy.ops)

2.3.1 Calling Operators
Provides python access to calling operators, this includes operators written in C, Python or Macros. Only keyword arguments can be used to pass operator properties. Operators dont have return values as you might expect, instead they return a set() which is made up of: {RUNNING_MODAL, CANCELLED, FINISHED, PASS_THROUGH}. Common return values are {FINISHED} and {CANCELLED}. Calling an operator in the wrong context will raise a RuntimeError, there is a poll() method to avoid this problem. Note that the operator ID (bl_idname) in this example is mesh.subdivide, bpy.ops is just the access path for python.
import bpy # calling an operator bpy.ops.mesh.subdivide(number_cuts=3, smoothness=0.5)

# check poll() to avoid exception. if bpy.ops.object.mode_set.poll(): bpy.ops.object.mode_set(mode=EDIT)

2.3.2 Execution Context

When calling an operator you may want to pass the execution context. This determines the context thats given to the operator to run in, and weather invoke() is called or execute(). EXEC_DEFAULT is used by default but you may want the operator to take user interaction with INVOKE_DEFAULT. The execution context is as a non keyword, string argument in: (INVOKE_DEFAULT, INVOKE_REGION_WIN, INVOKE_REGION_CHANNELS, INVOKE_REGION_PREVIEW, INVOKE_AREA, INVOKE_SCREEN, EXEC_DEFAULT, EXEC_REGION_WIN, EXEC_REGION_CHANNELS, EXEC_REGION_PREVIEW, EXEC_AREA, EXEC_SCREEN)

Blender Index, Release 2.61.0 - API

bpy.ops.boid.state_move_down() Move boid state down in the list bpy.ops.boid.state_move_up() Move boid state up in the list Brush Operators bpy.ops.brush.active_index_set(mode=, index=0) Set active sculpt/paint brush from its number Parameters mode (string, (optional)) mode, Paint mode to set brush for index (int in [-inf, inf], (optional)) number, Brush number File startup/bl_operators/wm.py:161 bpy.ops.brush.add() Add brush by mode type bpy.ops.brush.curve_preset(shape=SMOOTH) Set brush shape Parameters shape (enum in [SHARP, SMOOTH, MAX, LINE, ROUND, ROOT], (optional)) Mode bpy.ops.brush.image_tool_set(tool=DRAW) Set the image tool Parameters tool (enum in [DRAW, SOFTEN, SMEAR, CLONE], (optional)) Tool bpy.ops.brush.reset() Return brush to defaults based on current tool bpy.ops.brush.scale_size(scalar=1.0) Change brush size by a scalar Parameters scalar (oat in [0, 2], (optional)) Scalar, Factor to scale brush size by bpy.ops.brush.sculpt_tool_set(tool=BLOB) Set the sculpt tool Parameters tool (enum in [BLOB, CLAY, CREASE, DRAW, FILL, FLATTEN, GRAB, INFLATE, LAYER, NUDGE, PINCH, ROTATE, SCRAPE, SMOOTH, SNAKE_HOOK, THUMB], (optional)) Tool bpy.ops.brush.vertex_tool_set(tool=MIX) Set the vertex paint tool Parameters tool (enum in [MIX, ADD, SUB, MUL, BLUR, LIGHTEN, DARKEN], (optional)) Tool MIX Mix, Use mix blending mode while painting. ADD Add, Use add blending mode while painting. SUB Subtract, Use subtract blending mode while painting. MUL Multiply, Use multiply blending mode while painting. BLUR Blur, Blur the color with surrounding values. LIGHTEN Lighten, Use lighten blending mode while painting. 2.3. Operators (bpy.ops) 53

Blender Index, Release 2.61.0 - API

Chapter 2. Application Modules

Blender Index, Release 2.61.0 - API

2.3. Operators (bpy.ops)

Blender Index, Release 2.61.0 - API

lter_blender (boolean, (optional)) Filter .blend les lter_image (boolean, (optional)) Filter image les lter_movie (boolean, (optional)) Filter movie les lter_python (boolean, (optional)) Filter python les lter_font (boolean, (optional)) Filter font les lter_sound (boolean, (optional)) Filter sound les lter_text (boolean, (optional)) Filter text les lter_btx (boolean, (optional)) Filter btx les lter_collada (boolean, (optional)) Filter COLLADA les lter_folder (boolean, (optional)) Filter folders lemode (int in [1, 9], (optional)) File Browser Mode, The setting for the le browser mode to load a .blend le, a library or a special le bpy.ops.font.insert_lorem() Insert placeholder text bpy.ops.font.line_break(ctrl=False) Insert line break at cursor position Parameters ctrl (boolean, (optional)) Ctrl bpy.ops.font.move(type=LINE_BEGIN) Move cursor to position type Parameters type (enum in [LINE_BEGIN, LINE_END, PREVIOUS_CHARACTER, NEXT_CHARACTER, PREVIOUS_WORD, NEXT_WORD, PREVIOUS_LINE, NEXT_LINE, PREVIOUS_PAGE, NEXT_PAGE], (optional)) Type, Where to move cursor to bpy.ops.font.move_select(type=LINE_BEGIN) Make selection from current cursor position to new cursor position type Parameters type (enum in [LINE_BEGIN, LINE_END, PREVIOUS_CHARACTER, NEXT_CHARACTER, PREVIOUS_WORD, NEXT_WORD, PREVIOUS_LINE, NEXT_LINE, PREVIOUS_PAGE, NEXT_PAGE], (optional)) Type, Where to move cursor to, to make a selection bpy.ops.font.open(lepath=, lter_blender=False, lter_image=False, lter_movie=False, lter_python=False, lter_font=True, lter_sound=False, lter_text=False, lter_btx=False, lter_collada=False, lter_folder=True, lemode=9, relative_path=True) Undocumented (contribute) Parameters lepath (string, (optional)) File Path, Path to le lter_blender (boolean, (optional)) Filter .blend les lter_image (boolean, (optional)) Filter image les lter_movie (boolean, (optional)) Filter movie les lter_python (boolean, (optional)) Filter python les lter_font (boolean, (optional)) Filter font les

Chapter 2. Application Modules

Blender Index, Release 2.61.0 - API

lter_sound (boolean, (optional)) Filter sound les lter_text (boolean, (optional)) Filter text les lter_btx (boolean, (optional)) Filter btx les lter_collada (boolean, (optional)) Filter COLLADA les lter_folder (boolean, (optional)) Filter folders lemode (int in [1, 9], (optional)) File Browser Mode, The setting for the le browser mode to load a .blend le, a library or a special le relative_path (boolean, (optional)) Relative Path, Select the le relative to the blend le bpy.ops.font.style_set(style=BOLD, clear=False) Set font style Parameters style (enum in [BOLD, ITALIC, UNDERLINE, SMALL_CAPS], (optional)) Style, Style to set selection to clear (boolean, (optional)) Clear, Clear style rather than setting it bpy.ops.font.style_toggle(style=BOLD) Toggle font style Parameters style (enum in [BOLD, ITALIC, UNDERLINE, SMALL_CAPS], (optional)) Style, Style to set selection to bpy.ops.font.text_copy() Copy selected text to clipboard bpy.ops.font.text_cut() Cut selected text to clipboard bpy.ops.font.text_insert(text=, accent=False) Insert text at cursor position Parameters text (string, (optional)) Text, Text to insert at the cursor position accent (boolean, (optional)) Accent mode, Next typed character will strike through previous, for special character input bpy.ops.font.text_paste() Paste text from clipboard bpy.ops.font.textbox_add() Add a new text box bpy.ops.font.textbox_remove(index=0) Remove the textbox Parameters index (int in [0, inf], (optional)) Index, The current text box bpy.ops.font.unlink() Unlink active font data block Gpencil Operators bpy.ops.gpencil.active_frame_delete() Delete the active frame for the active Grease Pencil datablock 2.3. Operators (bpy.ops) 79

Blender Index, Release 2.61.0 - API

bpy.ops.gpencil.convert(type=PATH) Convert the active Grease Pencil layer to a new Object Parameters type (enum in [PATH, CURVE], (optional)) Type bpy.ops.gpencil.data_add() Add new Grease Pencil datablock bpy.ops.gpencil.data_unlink() Unlink active Grease Pencil datablock bpy.ops.gpencil.draw(mode=DRAW, stroke=None) Make annotations on the active data Parameters mode (enum in [DRAW, DRAW_STRAIGHT, DRAW_POLY, ERASER], (optional)) Mode, Way to intepret mouse movements stroke (bpy_prop_collection of OperatorStrokeElement, (optional)) Stroke bpy.ops.gpencil.layer_add() Add new Grease Pencil layer for the active Grease Pencil datablock Graph Operators bpy.ops.graph.bake() Bake selected F-Curves to a set of sampled points dening a similar curve bpy.ops.graph.clean(threshold=0.001) Simplify F-Curves by removing closely spaced keyframes Parameters threshold (oat in [0, inf], (optional)) Threshold bpy.ops.graph.click_insert(frame=1.0, value=1.0) Insert new keyframe at the cursor position for the active F-Curve Parameters frame (oat in [-inf, inf], (optional)) Frame Number, Frame to insert keyframe on value (oat in [-inf, inf], (optional)) Value, Value for keyframe on bpy.ops.graph.clickselect(extend=False, column=False, curves=False) Select keyframes by clicking on them Parameters extend (boolean, (optional)) Extend Select column (boolean, (optional)) Column Select, Select all keyframes that occur on the same frame as the one under the mouse curves (boolean, (optional)) Only Curves, Select all the keyframes in the curve bpy.ops.graph.copy() Copy selected keyframes to the copy/paste buffer bpy.ops.graph.cursor_set(frame=0, value=0.0) Interactively set the current frame number and value cursor Parameters frame (int in [-300000, 300000], (optional)) Frame 80 Chapter 2. Application Modules

Blender Index, Release 2.61.0 - API

value (oat in [1.17549e-38, inf], (optional)) Value bpy.ops.graph.delete() Remove all selected keyframes bpy.ops.graph.duplicate(mode=TRANSLATION) Make a copy of all selected keyframes Parameters mode (enum in [INIT, DUMMY, TRANSLATION, ROTATION, RESIZE, TOSPHERE, SHEAR, WARP, SHRINKFATTEN, TILT, TRACKBALL, PUSHPULL, CREASE, MIRROR, BONE_SIZE, BONE_ENVELOPE, CURVE_SHRINKFATTEN, BONE_ROLL, TIME_TRANSLATE, TIME_SLIDE, TIME_SCALE, TIME_EXTEND, BAKE_TIME, BEVEL, BWEIGHT, ALIGN, EDGESLIDE, SEQSLIDE], (optional)) Mode bpy.ops.graph.duplicate_move(GRAPH_OT_duplicate=None, FORM_OT_transform=None) Undocumented (contribute) Parameters GRAPH_OT_duplicate (GRAPH_OT_duplicate, (optional)) Duplicate Keyframes, Make a copy of all selected keyframes TRANSFORM_OT_transform (TRANSFORM_OT_transform, (optional)) Transform, Transform selected items by mode type bpy.ops.graph.euler_filter() Fixes the most common causes of gimbal lock in the selected Euler Rotation F-Curves bpy.ops.graph.extrapolation_type(type=CONSTANT) Set extrapolation mode for selected F-Curves Parameters type (enum in [CONSTANT, LINEAR, MAKE_CYCLIC, CLEAR_CYCLIC], (optional)) Type CONSTANT Constant Extrapolation. LINEAR Linear Extrapolation. MAKE_CYCLIC Make Cyclic (F-Modier), Add Cycles F-Modier if one doesnt exist already. CLEAR_CYCLIC Clear Cyclic (F-Modier), Remove Cycles F-Modier if not needed anymore. bpy.ops.graph.fmodifier_add(type=NULL, only_active=True) Add F-Modiers to the selected F-Curves Parameters type (enum in [NULL, GENERATOR, FNGENERATOR, ENVELOPE, CYCLES, NOISE, FILTER, LIMITS, STEPPED], (optional)) Type only_active (boolean, (optional)) Only Active, Only add F-Modier to active F-Curve bpy.ops.graph.fmodifier_copy() Copy the F-Modier(s) of the active F-Curve bpy.ops.graph.fmodifier_paste() Add copied F-Modiers to the selected F-Curves bpy.ops.graph.frame_jump() Set the current frame to the average frame of the selected keyframes TRANS-

2.3. Operators (bpy.ops)

Blender Index, Release 2.61.0 - API

bpy.ops.graph.ghost_curves_clear() Clear F-Curve snapshots (Ghosts) for active Graph Editor bpy.ops.graph.ghost_curves_create() Create snapshot (Ghosts) of selected F-Curves as background aid for active Graph Editor bpy.ops.graph.handle_type(type=FREE) Set type of handle for selected keyframes Parameters type (enum in [FREE, VECTOR, ALIGNED, AUTO, AUTO_CLAMPED], (optional)) Type FREE Free. VECTOR Vector. ALIGNED Aligned. AUTO Automatic. AUTO_CLAMPED Auto Clamped, Auto handles clamped to not overshoot. bpy.ops.graph.handles_view_toggle() Toggle whether handles are drawn on all keyframes that need them bpy.ops.graph.interpolation_type(type=CONSTANT) Set interpolation mode for the F-Curve segments starting from the selected keyframes Parameters type (enum in [CONSTANT, LINEAR, BEZIER], (optional)) Type bpy.ops.graph.keyframe_insert(type=ALL) Insert keyframes for the specied channels Parameters type (enum in [ALL, SEL], (optional)) Type bpy.ops.graph.mirror(type=CFRA) Flip selected keyframes over the selected mirror line Parameters type (enum in [CFRA, VALUE, YAXIS, XAXIS, MARKER], (optional)) Type bpy.ops.graph.paste(offset=START, merge=MIX) Paste keyframes from copy/paste buffer for the selected channels, starting on the current frame Parameters offset (enum in [START, END, RELATIVE, NONE], (optional)) Offset, Paste time offset of keys START Frame Start, Paste keys starting at current frame. END Frame End, Paste keys ending at current frame. RELATIVE Frame Relative, Paste keys relative to the current frame when copying. NONE No Offset, Paste keys from original time. merge (enum in [MIX, OVER_ALL, OVER_RANGE, OVER_RANGE_ALL], (optional)) Type, Method of merging pasted keys and existing MIX Mix, Overlay existing with new keys. OVER_ALL Overwrite All, Replace all keys. OVER_RANGE Overwrite Range, Overwrite keys in pasted range. OVER_RANGE_ALL Overwrite Entire Range, Overwrite keys in pasted range, using the range of all copied keys.

Chapter 2. Application Modules

Blender Index, Release 2.61.0 - API

bpy.ops.graph.previewrange_set() Automatically set Preview Range based on range of keyframes bpy.ops.graph.properties() Toggle display properties panel bpy.ops.graph.sample() Add keyframes on every frame between the selected keyframes bpy.ops.graph.select_all_toggle(invert=False) Toggle selection of all keyframes Parameters invert (boolean, (optional)) Invert bpy.ops.graph.select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0, extend=True, axis_range=False, include_handles=False) Select all keyframes within the specied region Parameters gesture_mode (int in [-inf, inf], (optional)) Gesture Mode xmin (int in [-inf, inf], (optional)) X Min xmax (int in [-inf, inf], (optional)) X Max ymin (int in [-inf, inf], (optional)) Y Min ymax (int in [-inf, inf], (optional)) Y Max extend (boolean, (optional)) Extend, Extend selection instead of deselecting everything rst axis_range (boolean, (optional)) Axis Range include_handles (boolean, (optional)) Include Handles, Are handles tested individually against the selection criteria bpy.ops.graph.select_column(mode=KEYS) Select all keyframes on the specied frame(s) Parameters mode (enum in [KEYS, CFRA, MARKERS_COLUMN, MARKERS_BETWEEN], (optional)) Mode bpy.ops.graph.select_leftright(mode=CHECK, extend=False) Select keyframes to the left or the right of the current frame Parameters mode (enum in [CHECK, LEFT, RIGHT], (optional)) Mode extend (boolean, (optional)) Extend Select bpy.ops.graph.select_less() Deselect keyframes on ends of selection islands bpy.ops.graph.select_linked() Select keyframes occurring in the same F-Curves as selected ones bpy.ops.graph.select_more() Select keyframes beside already selected ones bpy.ops.graph.smooth() Apply weighted moving means to make selected F-Curves less bumpy bpy.ops.graph.snap(type=CFRA) Snap selected keyframes to the chosen times/values 2.3. Operators (bpy.ops) 83

Blender Index, Release 2.61.0 - API

Blender Index, Release 2.61.0 - API

Parameters frames (int in [-inf, inf], (optional)) Frames bpy.ops.marker.rename(name=RenamedMarker) Rename rst selected time marker Parameters name (string, (optional)) Name, New name for marker bpy.ops.marker.select(extend=False, camera=False) Select time marker(s) Parameters extend (boolean, (optional)) Extend, extend the selection camera (boolean, (optional)) Camera, Select the camera bpy.ops.marker.select_all(action=TOGGLE) Change selection of all time markers Parameters action (enum in [TOGGLE, SELECT, DESELECT, INVERT], (optional)) Action, Selection action to execute TOGGLE Toggle, Toggle selection for all elements. SELECT Select, Select all elements. DESELECT Deselect, Deselect all elements. INVERT Invert, Invert selection of all elements. bpy.ops.marker.select_border(gesture_mode=0, tend=True) Select all time markers using border selection Parameters gesture_mode (int in [-inf, inf], (optional)) Gesture Mode xmin (int in [-inf, inf], (optional)) X Min xmax (int in [-inf, inf], (optional)) X Max ymin (int in [-inf, inf], (optional)) Y Min ymax (int in [-inf, inf], (optional)) Y Max extend (boolean, (optional)) Extend, Extend selection instead of deselecting everything rst Material Operators bpy.ops.material.copy() Copy the material settings and nodes bpy.ops.material.new() Add a new material bpy.ops.material.paste() Paste the material settings and nodes bpy.ops.material.sss_preset_add(name=, remove_active=False) Add a Subsurface Scattering Preset Parameters name (string, (optional)) Name, Name of the preset, used to make the path name File startup/bl_operators/presets.py:50 xmin=0, xmax=0, ymin=0, ymax=0, ex-

2.3. Operators (bpy.ops)

Blender Index, Release 2.61.0 - API

Mball Operators bpy.ops.mball.delete_metaelems() Delete selected metaelement(s) bpy.ops.mball.duplicate_metaelems(mode=TRANSLATION) Delete selected metaelement(s) Parameters mode (enum in [INIT, DUMMY, TRANSLATION, ROTATION, RESIZE, TOSPHERE, SHEAR, WARP, SHRINKFATTEN, TILT, TRACKBALL, PUSHPULL, CREASE, MIRROR, BONE_SIZE, BONE_ENVELOPE, CURVE_SHRINKFATTEN, BONE_ROLL, TIME_TRANSLATE, TIME_SLIDE, TIME_SCALE, TIME_EXTEND, BAKE_TIME, BEVEL, BWEIGHT, ALIGN, EDGESLIDE, SEQSLIDE], (optional)) Mode bpy.ops.mball.hide_metaelems(unselected=False) Hide (un)selected metaelement(s) Parameters unselected (boolean, (optional)) Unselected, Hide unselected rather than selected bpy.ops.mball.reveal_metaelems() Reveal all hidden metaelements bpy.ops.mball.select_all(action=TOGGLE) Change selection of all meta elements Parameters action (enum in [TOGGLE, SELECT, DESELECT, INVERT], (optional)) Action, Selection action to execute TOGGLE Toggle, Toggle selection for all elements. SELECT Select, Select all elements. DESELECT Deselect, Deselect all elements. INVERT Invert, Invert selection of all elements. bpy.ops.mball.select_inverse_metaelems() Select inverse of (un)selected metaelements bpy.ops.mball.select_random_metaelems(percent=0.5) Randomly select metaelements Parameters percent (oat in [0, 1], (optional)) Percent, Percentage of metaelems to select randomly Mesh Operators bpy.ops.mesh.beautify_fill() Rearrange geometry on a selected surface to avoid skinny faces bpy.ops.mesh.blend_from_shape(shape=, blend=1.0, add=False) Blend in shape from a shape key Parameters shape (enum in [], (optional)) Shape, Shape key to use for blending blend (oat in [-inf, inf], (optional)) Blend, Blending factor add (boolean, (optional)) Add, Add rather than blend between shapes

Chapter 2. Application Modules

Blender Index, Release 2.61.0 - API

bpy.ops.mesh.colors_mirror(axis=X) Mirror UV/image color layer Parameters axis (enum in [X, Y], (optional)) Axis, Axis to mirror colors around bpy.ops.mesh.colors_rotate(direction=CW) Rotate UV/image color layer Parameters direction (enum in [CW, CCW], (optional)) Direction, Direction to rotate edge around bpy.ops.mesh.delete(type=VERT) Delete selected vertices, edges or faces Parameters type (enum in [VERT, EDGE, FACE, ALL, EDGE_FACE, ONLY_FACE, EDGE_LOOP], (optional)) Type, Method used for deleting mesh data bpy.ops.mesh.delete_edgeloop() Delete an edge loop by merging the faces on each side to a single face loop File startup/bl_operators/wm.py:38 bpy.ops.mesh.drop_named_image(name=Image, lepath=Path) Assign Image to active UV Map, or create an UV Map Parameters name (string, (optional)) Name, Image name to assign lepath (string, (optional)) Filepath, Path to image le bpy.ops.mesh.dupli_extrude_cursor(rotate_source=True) Duplicate and extrude selected vertices, edges or faces towards 3D Cursor Parameters rotate_source (boolean, (optional)) Rotate Source, Rotate initial selection giving better shape bpy.ops.mesh.duplicate(mode=TRANSLATION) Duplicate selected vertices, edges or faces Parameters mode (enum in [INIT, DUMMY, TRANSLATION, ROTATION, RESIZE, TOSPHERE, SHEAR, WARP, SHRINKFATTEN, TILT, TRACKBALL, PUSHPULL, CREASE, MIRROR, BONE_SIZE, BONE_ENVELOPE, CURVE_SHRINKFATTEN, BONE_ROLL, TIME_TRANSLATE, TIME_SLIDE, TIME_SCALE, TIME_EXTEND, BAKE_TIME, BEVEL, BWEIGHT, ALIGN, EDGESLIDE, SEQSLIDE], (optional)) Mode bpy.ops.mesh.duplicate_move(MESH_OT_duplicate=None, TRANSFORM_OT_translate=None) Undocumented (contribute) Parameters MESH_OT_duplicate (MESH_OT_duplicate, (optional)) Duplicate Mesh, Duplicate selected vertices, edges or faces TRANSFORM_OT_translate (TRANSFORM_OT_translate, (optional)) Translate, Translate selected items bpy.ops.mesh.edge_face_add() Add an edge or face to selected bpy.ops.mesh.edge_flip() Flip selected edge or adjoining faces

2.3. Operators (bpy.ops)

Blender Index, Release 2.61.0 - API

bpy.ops.mesh.edge_rotate(direction=CW) Rotate selected edge or adjoining faces Parameters direction (enum in [CW, CCW], (optional)) Direction, Direction to rotate the edge around bpy.ops.mesh.edgering_select(extend=False) Select an edge ring Parameters extend (boolean, (optional)) Extend, Extend the selection bpy.ops.mesh.edges_select_sharp(sharpness=0.01) Marked selected edges as sharp Parameters sharpness (oat in [0, inf], (optional)) sharpness bpy.ops.mesh.extrude(type=REGION) Extrude selected vertices, edges or faces Parameters type (enum in [REGION, FACES, EDGES, VERTS], (optional)) Type bpy.ops.mesh.extrude_edges_move(MESH_OT_extrude=None, FORM_OT_translate=None) Undocumented (contribute) Parameters MESH_OT_extrude (MESH_OT_extrude, (optional)) Extrude, Extrude selected vertices, edges or faces TRANSFORM_OT_translate (TRANSFORM_OT_translate, (optional)) Translate, Translate selected items bpy.ops.mesh.extrude_faces_move(MESH_OT_extrude=None, FORM_OT_shrink_fatten=None) Undocumented (contribute) Parameters MESH_OT_extrude (MESH_OT_extrude, (optional)) Extrude, Extrude selected vertices, edges or faces TRANSFORM_OT_shrink_fatten (TRANSFORM_OT_shrink_fatten, (optional)) Shrink/Fatten, Shrink/fatten selected vertices along normals bpy.ops.mesh.extrude_region_move(MESH_OT_extrude=None, FORM_OT_translate=None) Undocumented (contribute) Parameters MESH_OT_extrude (MESH_OT_extrude, (optional)) Extrude, Extrude selected vertices, edges or faces TRANSFORM_OT_translate (TRANSFORM_OT_translate, (optional)) Translate, Translate selected items bpy.ops.mesh.extrude_repeat(offset=2.0, steps=10, direction=(0.0, 0.0, 0.0)) Extrude selected vertices, edges or faces repeatedly Parameters offset (oat in [0, 100], (optional)) Offset steps (int in [0, 180], (optional)) Steps direction (oat array of 3 items in [-inf, inf], (optional)) Direction, Direction of extrude 98 Chapter 2. Application Modules TRANSTRANSTRANS-

Blender Index, Release 2.61.0 - API

bpy.ops.mesh.extrude_vertices_move(MESH_OT_extrude=None, FORM_OT_translate=None) Undocumented (contribute) Parameters

Blender Index, Release 2.61.0 - API

bpy.ops.mesh.select_axis(mode=POSITIVE, axis=X_AXIS) Select all data in the mesh on a single axis Parameters mode (enum in [POSITIVE, NEGATIVE, ALIGNED], (optional)) Axis Mode, Axis side to use when selecting axis (enum in [X_AXIS, Y_AXIS, Z_AXIS], (optional)) Axis, Select the axis to compare each vertex on bpy.ops.mesh.select_by_number_vertices(type=TRIANGLES) Select vertices or faces by vertex count Parameters type (enum in [TRIANGLES, QUADS, OTHER], (optional)) Type, Type of elements to select bpy.ops.mesh.select_inverse() Select inverse of (un)selected vertices, edges or faces bpy.ops.mesh.select_less() Select less vertices, edges or faces connected to initial selection bpy.ops.mesh.select_linked(limit=False) Select all vertices linked to the active mesh Parameters limit (boolean, (optional)) Limit by Seams, Limit selection by seam boundaries (faces only) bpy.ops.mesh.select_linked_pick(deselect=False, limit=False) (un)select all vertices linked to the active mesh Parameters deselect (boolean, (optional)) Deselect limit (boolean, (optional)) Limit by Seams, Limit selection by seam boundaries (faces only) bpy.ops.mesh.select_mirror(extend=False) Select mesh items at mirrored locations Parameters extend (boolean, (optional)) Extend, Extend the existing selection bpy.ops.mesh.select_more() Select more vertices, edges or faces connected to initial selection bpy.ops.mesh.select_non_manifold() Select all non-manifold vertices or edges bpy.ops.mesh.select_nth(nth=2) Undocumented (contribute) Parameters nth (int in [2, 100], (optional)) Nth Selection bpy.ops.mesh.select_random(percent=50.0, extend=False) Randomly select vertices Parameters percent (oat in [0, 100], (optional)) Percent, Percentage of elements to select randomly extend (boolean, (optional)) Extend Selection, Extend selection instead of deselecting everything rst

106

Chapter 2. Application Modules

Blender Index, Release 2.61.0 - API

bpy.ops.mesh.select_shortest_path(extend=False) Select shortest path between two selections Parameters extend (boolean, (optional)) Extend Select bpy.ops.mesh.select_similar(type=NORMAL, threshold=0.01) Select similar vertices, edges or faces by property types Parameters type (enum in [NORMAL, FACE, VGROUP, LENGTH, DIR, FACE, FACE_ANGLE, CREASE, SEAM, SHARP, MATERIAL, IMAGE, AREA, PERIMETER, NORMAL, COPLANAR], (optional)) Type threshold (oat in [0, inf], (optional)) Threshold bpy.ops.mesh.select_vertex_path(type=EDGE_LENGTH) Select shortest path between two vertices by distance type Parameters type (enum in [EDGE_LENGTH, TOPOLOGICAL], (optional)) Type, Method to compute distance bpy.ops.mesh.separate(type=SELECTED) Separate selected geometry into a new mesh Parameters type (enum in [SELECTED, MATERIAL, LOOSE], (optional)) Type bpy.ops.mesh.shape_propagate_to_all() Apply selected vertex locations to all other shape keys bpy.ops.mesh.solidify(thickness=0.01) Create a solid skin by extruding, compensating for sharp angles Parameters thickness (oat in [-inf, inf], (optional)) Thickness bpy.ops.mesh.sort_faces(type=VIEW_AXIS) The faces of the active Mesh Object are sorted, based on the current view Parameters type (enum in [VIEW_AXIS, CURSOR_DISTANCE, MATERIAL, SELECTED, RANDOMIZE], (optional)) Type bpy.ops.mesh.spin(steps=9, dupli=False, degrees=90.0, center=(0.0, 0.0, 0.0), axis=(0.0, 0.0, 0.0)) Extrude selected vertices in a circle around the cursor in indicated viewport Parameters steps (int in [0, inf], (optional)) Steps, Steps dupli (boolean, (optional)) Dupli, Make Duplicates degrees (oat in [-inf, inf], (optional)) Degrees, Degrees center (oat array of 3 items in [-inf, inf], (optional)) Center, Center in global view space axis (oat array of 3 items in [-1, 1], (optional)) Axis, Axis in global view space bpy.ops.mesh.split() Split selected geometry into separate disconnected mesh bpy.ops.mesh.sticky_add() Add sticky UV texture layer bpy.ops.mesh.sticky_remove() Remove sticky UV texture layer

2.3. Operators (bpy.ops)

107

Blender Index, Release 2.61.0 - API

bpy.ops.mesh.subdivide(number_cuts=1, smoothness=0.0, ner_cut_pattern=INNER_VERTEX) Subdivide selected edges Parameters number_cuts (int in [1, inf], (optional)) Number of Cuts

fractal=0.0,

cor-

smoothness (oat in [0, inf], (optional)) Smoothness, Smoothness factor fractal (oat in [0, inf], (optional)) Fractal, Fractal randomness factor corner_cut_pattern (enum in [PATH, INNER_VERTEX, FAN], (optional)) Corner Cut Pattern, Topology pattern to use to ll a face after cutting across its corner bpy.ops.mesh.tris_convert_to_quads() Convert selected triangles to quads bpy.ops.mesh.uv_texture_add() Add UV Map bpy.ops.mesh.uv_texture_remove() Remove UV Map bpy.ops.mesh.uvs_mirror(axis=X) Mirror selected UVs Parameters axis (enum in [X, Y], (optional)) Axis, Axis to mirror UVs around bpy.ops.mesh.uvs_rotate(direction=CW) Rotate selected UVs Parameters direction (enum in [CW, CCW], (optional)) Direction, Direction to rotate UVs around bpy.ops.mesh.vertex_color_add() Add vertex color layer bpy.ops.mesh.vertex_color_remove() Remove vertex color layer bpy.ops.mesh.vertices_randomize() Randomize vertex order bpy.ops.mesh.vertices_smooth(repeat=1, xaxis=True, yaxis=True, zaxis=True) Flatten angles of selected vertices Parameters repeat (int in [1, 100], (optional)) Smooth Iterations xaxis (boolean, (optional)) X-Axis, Smooth along the X axis yaxis (boolean, (optional)) Y-Axis, Smooth along the Y axis zaxis (boolean, (optional)) Z-Axis, Smooth along the Z axis bpy.ops.mesh.vertices_sort() Sort vertex order Nla Operators bpy.ops.nla.action_sync_length(active=True) Synchronise the length of the referenced Action with the length used in the strip

108

Chapter 2. Application Modules

Blender Index, Release 2.61.0 - API

bpy.ops.object.duplicate_move_linked(OBJECT_OT_duplicate=None, FORM_OT_translate=None) Undocumented (contribute) Parameters

replace_sel (boolean, (optional)) Replace Selection, replace the current selection overlap (boolean, (optional)) Allow Overlap, Dont correct overlap on new sequence strips scene (enum in [], (optional)) Scene bpy.ops.sequencer.select(extend=False, linked_handle=False, linked_time=False) Select a strip (last selected becomes the active strip) Parameters extend (boolean, (optional)) Extend, Extend the selection linked_handle (boolean, (optional)) Linked Handle, Select handles next to the active strip left_right (boolean, (optional)) Left/Right, Select based on the current frame side the cursor is on linked_time (boolean, (optional)) Linked Time, Select other strips at the same time bpy.ops.sequencer.select_active_side(side=BOTH) Select strips on the nominated side of the active strip Parameters side (enum in [LEFT, RIGHT, BOTH], (optional)) Side, The side of the handle that is selected bpy.ops.sequencer.select_all_toggle() Select or deselect all strips bpy.ops.sequencer.select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0, extend=True) Enable border select mode Parameters gesture_mode (int in [-inf, inf], (optional)) Gesture Mode xmin (int in [-inf, inf], (optional)) X Min xmax (int in [-inf, inf], (optional)) X Max ymin (int in [-inf, inf], (optional)) Y Min ymax (int in [-inf, inf], (optional)) Y Max extend (boolean, (optional)) Extend, Extend selection instead of deselecting everything rst bpy.ops.sequencer.select_grouped(extend=False, type=TYPE) Select all strips grouped by various properties Parameters extend (boolean, (optional)) Extend, Extend selection instead of deselecting everything rst type (enum in [TYPE, TYPE_BASIC, TYPE_EFFECT, DATA, EFFECT, EFFECT_LINK, OVERLAP], (optional)) Type TYPE Type, Shared strip type. TYPE_BASIC Global Type, All strips of same basic type (Graphical or Sound). TYPE_EFFECT Effect Type, Shared strip effect type (if active strip is not an effect one, select all non-effect strips). left_right=False,

2.3. Operators (bpy.ops)

159

Blender Index, Release 2.61.0 - API

DATA Data, Shared data (scene, image, sound, etc.). EFFECT Effect, Shared effects. EFFECT_LINK Effect/Linked, Other strips affected by the active one (sharing some time, and below or effect-assigned). OVERLAP Overlap, Overlapping time. bpy.ops.sequencer.select_handles(side=BOTH) Select manipulator handles on the sides of the selected strip Parameters side (enum in [LEFT, RIGHT, BOTH], (optional)) Side, The side of the handle that is selected bpy.ops.sequencer.select_inverse() Select unselected strips bpy.ops.sequencer.select_less() Shrink the current selection of adjacent selected strips bpy.ops.sequencer.select_linked() Select all strips adjacent to the current selection bpy.ops.sequencer.select_linked_pick(extend=False) Select a chain of linked strips nearest to the mouse pointer Parameters extend (boolean, (optional)) Extend, extend the selection bpy.ops.sequencer.select_more() Select more strips adjacent to the current selection bpy.ops.sequencer.snap(frame=0) Frame where selected strips will be snapped Parameters frame (int in [-inf, inf], (optional)) Frame, Frame where selected strips will be snapped bpy.ops.sequencer.sound_strip_add(lepath=, les=None, lter_blender=False, lter_image=False, lter_movie=False, lter_python=False, lter_font=False, lter_sound=True, lter_text=False, lter_btx=False, lter_collada=False, lter_folder=True, lemode=9, relative_path=True, frame_start=0, channel=1, replace_sel=True, overlap=False, cache=False) Add a sound strip to the sequencer Parameters lepath (string, (optional)) File Path, Path to le les (bpy_prop_collection of OperatorFileListElement, (optional)) Files lter_blender (boolean, (optional)) Filter .blend les lter_image (boolean, (optional)) Filter image les lter_movie (boolean, (optional)) Filter movie les lter_python (boolean, (optional)) Filter python les lter_font (boolean, (optional)) Filter font les lter_sound (boolean, (optional)) Filter sound les lter_text (boolean, (optional)) Filter text les lter_btx (boolean, (optional)) Filter btx les 160 Chapter 2. Application Modules

Blender Index, Release 2.61.0 - API

lter_collada (boolean, (optional)) Filter COLLADA les lter_folder (boolean, (optional)) Filter folders lemode (int in [1, 9], (optional)) File Browser Mode, The setting for the le browser mode to load a .blend le, a library or a special le relative_path (boolean, (optional)) Relative Path, Select the le relative to the blend le frame_start (int in [-inf, inf], (optional)) Start Frame, Start frame of the sequence strip channel (int in [1, 32], (optional)) Channel, Channel to place this strip into replace_sel (boolean, (optional)) Replace Selection, replace the current selection overlap (boolean, (optional)) Allow Overlap, Dont correct overlap on new sequence strips cache (boolean, (optional)) Cache, Cache the sound in memory bpy.ops.sequencer.swap(side=RIGHT) Swap active strip with strip to the right or left Parameters side (enum in [LEFT, RIGHT], (optional)) Side, Side of the strip to swap bpy.ops.sequencer.swap_data() Swap 2 sequencer strips bpy.ops.sequencer.swap_inputs() Swap the rst two inputs for the effect strip bpy.ops.sequencer.unlock() Unlock the active strip so that it cant be transformed bpy.ops.sequencer.unmute(unselected=False) Un-Mute unselected rather than selected strips Parameters unselected (boolean, (optional)) Unselected, UnMute unselected rather than selected strips bpy.ops.sequencer.view_all() View all the strips in the sequencer bpy.ops.sequencer.view_all_preview() Zoom preview to t in the area bpy.ops.sequencer.view_ghost_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0) Enable border select mode Parameters gesture_mode (int in [-inf, inf], (optional)) Gesture Mode xmin (int in [-inf, inf], (optional)) X Min xmax (int in [-inf, inf], (optional)) X Max ymin (int in [-inf, inf], (optional)) Y Min ymax (int in [-inf, inf], (optional)) Y Max bpy.ops.sequencer.view_selected() Zoom the sequencer on the selected strips bpy.ops.sequencer.view_toggle() Toggle between sequencer views (sequence, preview, both)

2.3. Operators (bpy.ops)

161

Blender Index, Release 2.61.0 - API

bpy.ops.sequencer.view_zoom_ratio(ratio=1.0) Change zoom ratio of sequencer preview Parameters ratio (oat in [0, inf], (optional)) Ratio, Zoom ratio, 1.0 is 1:1, higher is zoomed in, lower is zoomed out Sketch Operators bpy.ops.sketch.cancel_stroke() Undocumented (contribute) bpy.ops.sketch.convert() Undocumented (contribute) bpy.ops.sketch.delete() Undocumented (contribute) bpy.ops.sketch.draw_preview(snap=False) Undocumented (contribute) Parameters snap (boolean, (optional)) Snap bpy.ops.sketch.draw_stroke(snap=False) Undocumented (contribute) Parameters snap (boolean, (optional)) Snap bpy.ops.sketch.finish_stroke() Undocumented (contribute) bpy.ops.sketch.gesture(snap=False) Undocumented (contribute) Parameters snap (boolean, (optional)) Snap bpy.ops.sketch.select() Undocumented (contribute) Sound Operators bpy.ops.sound.bake_animation() Updates the audio animation cache so that its up to date bpy.ops.sound.mixdown(lepath=, check_existing=True, lter_blender=False, lter_image=False, lter_movie=False, lter_python=False, lter_font=False, lter_sound=True, lter_text=False, lter_btx=False, lter_collada=False, lter_folder=True, lemode=9) Mixes the scenes audio to a sound le Parameters lepath (string, (optional)) File Path, Path to le check_existing (boolean, (optional)) Check Existing, Check and warn on overwriting existing les lter_blender (boolean, (optional)) Filter .blend les lter_image (boolean, (optional)) Filter image les lter_movie (boolean, (optional)) Filter movie les

162

Chapter 2. Application Modules

Blender Index, Release 2.61.0 - API

lter_python (boolean, (optional)) Filter python les lter_font (boolean, (optional)) Filter font les lter_sound (boolean, (optional)) Filter sound les lter_text (boolean, (optional)) Filter text les lter_btx (boolean, (optional)) Filter btx les lter_collada (boolean, (optional)) Filter COLLADA les lter_folder (boolean, (optional)) Filter folders lemode (int in [1, 9], (optional)) File Browser Mode, The setting for the le browser mode to load a .blend le, a library or a special le bpy.ops.sound.open(lepath=, lter_blender=False, lter_image=False, lter_movie=True, lter_python=False, lter_font=False, lter_sound=True, lter_text=False, lter_btx=False, lter_collada=False, lter_folder=True, lemode=9, relative_path=True, cache=False, mono=False) Load a sound le Parameters lepath (string, (optional)) File Path, Path to le lter_blender (boolean, (optional)) Filter .blend les lter_image (boolean, (optional)) Filter image les lter_movie (boolean, (optional)) Filter movie les lter_python (boolean, (optional)) Filter python les lter_font (boolean, (optional)) Filter font les lter_sound (boolean, (optional)) Filter sound les lter_text (boolean, (optional)) Filter text les lter_btx (boolean, (optional)) Filter btx les lter_collada (boolean, (optional)) Filter COLLADA les lter_folder (boolean, (optional)) Filter folders lemode (int in [1, 9], (optional)) File Browser Mode, The setting for the le browser mode to load a .blend le, a library or a special le relative_path (boolean, (optional)) Relative Path, Select the le relative to the blend le cache (boolean, (optional)) Cache, Cache the sound in memory mono (boolean, (optional)) Mono, Mixdown the sound to mono bpy.ops.sound.open_mono(lepath=, lter_blender=False, lter_image=False, lter_movie=True, lter_python=False, lter_font=False, lter_sound=True, lter_text=False, lter_btx=False, lter_collada=False, lter_folder=True, lemode=9, relative_path=True, cache=False, mono=True) Load a sound le as mono Parameters lepath (string, (optional)) File Path, Path to le lter_blender (boolean, (optional)) Filter .blend les lter_image (boolean, (optional)) Filter image les 2.3. Operators (bpy.ops) 163

Blender Index, Release 2.61.0 - API

lter_movie (boolean, (optional)) Filter movie les lter_python (boolean, (optional)) Filter python les lter_font (boolean, (optional)) Filter font les lter_sound (boolean, (optional)) Filter sound les lter_text (boolean, (optional)) Filter text les lter_btx (boolean, (optional)) Filter btx les lter_collada (boolean, (optional)) Filter COLLADA les lter_folder (boolean, (optional)) Filter folders lemode (int in [1, 9], (optional)) File Browser Mode, The setting for the le browser mode to load a .blend le, a library or a special le relative_path (boolean, (optional)) Relative Path, Select the le relative to the blend le cache (boolean, (optional)) Cache, Cache the sound in memory mono (boolean, (optional)) Mono, Mixdown the sound to mono bpy.ops.sound.pack() Pack the sound into the current blend le bpy.ops.sound.unpack(method=USE_LOCAL, id=) Unpack the sound to the samples lename Parameters method (enum in [USE_LOCAL, WRITE_LOCAL, WRITE_ORIGINAL], (optional)) Method, How to unpack id (string, (optional)) Sound Name, Sound datablock name to unpack bpy.ops.sound.update_animation_flags() Update animation ags Surface Operators bpy.ops.surface.primitive_nurbs_surface_circle_add(view_align=False, enter_editmode=False, location=(0.0, 0.0, 0.0), rotation=(0.0, 0.0, 0.0), layers=(False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False)) Construct a Nurbs surface Circle Parameters view_align (boolean, (optional)) Align to View, Align the new object to the view enter_editmode (boolean, (optional)) Enter Editmode, Enter editmode when adding this object location (oat array of 3 items in [-inf, inf], (optional)) Location, Location for the newly added object USE_ORIGINAL,

164

ROOT Root, Root falloff. SHARP Sharp, Sharp falloff. LINEAR Linear, Linear falloff. CONSTANT Constant, Constant falloff. RANDOM Random, Random falloff. proportional_size (oat in [1e-05, inf], (optional)) Proportional Size snap (boolean, (optional)) Use Snapping Options snap_target (enum in [CLOSEST, CENTER, MEDIAN, ACTIVE], (optional)) Target CLOSEST Closest, Snap closest point onto target. CENTER Center, Snap center onto target. MEDIAN Median, Snap median onto target. ACTIVE Active, Snap active onto target. snap_point (oat array of 3 items in [-inf, inf], (optional)) Point snap_align (boolean, (optional)) Align with Point Normal snap_normal (oat array of 3 items in [-inf, inf], (optional)) Normal texture_space (boolean, (optional)) Edit Object data texture space release_conrm (boolean, (optional)) Conrm on Release, Always conrm operation when releasing button bpy.ops.transform.warp(value=(0.0), mirror=False, proportional=DISABLED, proportional_edit_falloff=SMOOTH, proportional_size=1.0, snap=False, snap_target=CLOSEST, snap_point=(0.0, 0.0, 0.0), snap_align=False, snap_normal=(0.0, 0.0, 0.0), release_conrm=False) Warp selected items around the cursor Parameters value (oat array of 1 items in [-inf, inf], (optional)) Angle mirror (boolean, (optional)) Mirror Editing proportional (enum in [DISABLED, ENABLED, CONNECTED], (optional)) Proportional Editing DISABLED Disable, Proportional Editing disabled. ENABLED Enable, Proportional Editing enabled. CONNECTED Connected, Proportional Editing using connected geometry only. proportional_edit_falloff (enum in [SMOOTH, SPHERE, ROOT, SHARP, LINEAR, CONSTANT, RANDOM], (optional)) Proportional Editing Falloff, Falloff type for proportional editing mode SMOOTH Smooth, Smooth falloff. SPHERE Sphere, Spherical falloff. ROOT Root, Root falloff. SHARP Sharp, Sharp falloff.

184

Chapter 2. Application Modules

Blender Index, Release 2.61.0 - API

LINEAR Linear, Linear falloff. CONSTANT Constant, Constant falloff. RANDOM Random, Random falloff. proportional_size (oat in [1e-05, inf], (optional)) Proportional Size snap (boolean, (optional)) Use Snapping Options snap_target (enum in [CLOSEST, CENTER, MEDIAN, ACTIVE], (optional)) Target CLOSEST Closest, Snap closest point onto target. CENTER Center, Snap center onto target. MEDIAN Median, Snap median onto target. ACTIVE Active, Snap active onto target. snap_point (oat array of 3 items in [-inf, inf], (optional)) Point snap_align (boolean, (optional)) Align with Point Normal snap_normal (oat array of 3 items in [-inf, inf], (optional)) Normal release_conrm (boolean, (optional)) Conrm on Release, Always conrm operation when releasing button Ui Operators bpy.ops.ui.copy_data_path_button() Copy the RNA data path for this property to the clipboard bpy.ops.ui.copy_to_selected_button(all=True) Copy property from this object to selected objects or bones Parameters all (boolean, (optional)) All, Reset to default values all elements of the array bpy.ops.ui.editsource() Edit source code for a button bpy.ops.ui.eyedropper() Sample a color from the Blender Window to store in a property bpy.ops.ui.reports_to_textblock() Write the reports bpy.ops.ui.reset_default_button(all=True) Reset this propertys value to its default value Parameters all (boolean, (optional)) All, Reset to default values all elements of the array bpy.ops.ui.reset_default_theme() Reset to the default theme colors Uv Operators bpy.ops.uv.align(axis=ALIGN_AUTO) Align selected UV vertices to an axis Parameters axis (enum in [ALIGN_S, ALIGN_T, ALIGN_U, ALIGN_AUTO, ALIGN_X, ALIGN_Y], (optional)) Axis, Axis to align UV locations on 2.3. Operators (bpy.ops) 185

Blender Index, Release 2.61.0 - API

ALIGN_S Straighten, Align UVs along the line dened by the endpoints. ALIGN_T Straighten X, Align UVs along the line dened by the endpoints along the X axis. ALIGN_U Straighten Y, Align UVs along the line dened by the endpoints along the Y axis. ALIGN_AUTO Align Auto, Automatically choose the axis on which there is most alignment already. ALIGN_X Align X, Align UVs on X axis. ALIGN_Y Align Y, Align UVs on Y axis. bpy.ops.uv.average_islands_scale() Undocumented (contribute) bpy.ops.uv.circle_select(x=0, y=0, radius=0, gesture_mode=0) Select UV vertices using circle selection Parameters x (int in [-inf, inf], (optional)) X y (int in [-inf, inf], (optional)) Y radius (int in [-inf, inf], (optional)) Radius gesture_mode (int in [-inf, inf], (optional)) Gesture Mode bpy.ops.uv.cube_project(cube_size=1.0, correct_aspect=True, scale_to_bounds=False) Undocumented (contribute) Parameters cube_size (oat in [0, inf], (optional)) Cube Size, Size of the cube to project on correct_aspect (boolean, (optional)) Correct Aspect, Map UVs taking image aspect ratio into account clip_to_bounds (boolean, (optional)) Clip to Bounds, Clip UV coordinates to bounds after unwrapping scale_to_bounds (boolean, (optional)) Scale to Bounds, Scale UV coordinates to bounds after unwrapping bpy.ops.uv.cursor_set(location=(0.0, 0.0)) Set 2D cursor location Parameters location (oat array of 2 items in [-inf, inf], (optional)) Location, Cursor location in normalised (0.0-1.0) coordinates bpy.ops.uv.cylinder_project(direction=VIEW_ON_EQUATOR, radius=1.0, correct_aspect=True, scale_to_bounds=False) Undocumented (contribute) Parameters direction (enum in [VIEW_ON_EQUATOR, VIEW_ON_POLES, ALIGN_TO_OBJECT], (optional)) Direction, Direction of the sphere or cylinder VIEW_ON_EQUATOR View on Equator, 3D view is on the equator. VIEW_ON_POLES View on Poles, 3D view is on the poles. align=POLAR_ZX, clip_to_bounds=False, clip_to_bounds=False,

186

Chapter 2. Application Modules

Blender Index, Release 2.61.0 - API

ALIGN_TO_OBJECT Align to Object, Align according to object transform. align (enum in [POLAR_ZX, POLAR_ZY], (optional)) Align, How to determine rotation around the pole POLAR_ZX Polar ZX, Polar 0 is X. POLAR_ZY Polar ZY, Polar 0 is Y. radius (oat in [0, inf], (optional)) Radius, Radius of the sphere or cylinder correct_aspect (boolean, (optional)) Correct Aspect, Map UVs taking image aspect ratio into account clip_to_bounds (boolean, (optional)) Clip to Bounds, Clip UV coordinates to bounds after unwrapping scale_to_bounds (boolean, (optional)) Scale to Bounds, Scale UV coordinates to bounds after unwrapping bpy.ops.uv.export_layout(lepath=, check_existing=True, export_all=False, mode=PNG, size=(1024, 1024), opacity=0.25) Export UV layout to le Parameters check_existing (boolean, (optional)) Check Existing, Check and warn on overwriting existing les export_all (boolean, (optional)) All UVs, Export all UVs in this mesh (not just visible ones) mode (enum in [SVG, EPS, PNG], (optional)) Format, File format to export the UV layout to SVG Scalable Vector Graphic (.svg), Export the UV layout to a vector SVG le. EPS Encapsulate PostScript (.eps), Export the UV layout to a vector EPS le. PNG PNG Image (.png), Export the UV layout to a bitmap image. size (int array of 2 items in [8, 32768], (optional)) Dimensions of the exported le opacity (oat in [0, 1], (optional)) Fill Opacity File addons/io_mesh_uv_layout/__init__.py:163 bpy.ops.uv.follow_active_quads(mode=LENGTH) Follow UVs from active quads along continuous face loops Parameters mode (enum in [EVEN, LENGTH], (optional)) Edge Length Mode, Method to space UV edge loops EVEN Even, Space all UVs evently. LENGTH Length, Average space UVs edge length of each loop. File startup/bl_operators/uvcalc_follow_active.py:249 bpy.ops.uv.hide(unselected=False) Hide (un)selected UV vertices Parameters unselected (boolean, (optional)) Unselected, Hide unselected rather than selected

2.3. Operators (bpy.ops)

187

Blender Index, Release 2.61.0 - API

bpy.ops.uv.lightmap_pack(PREF_CONTEXT=SEL_FACES, PREF_NEW_UVLAYER=False, PREF_IMG_PX_SIZE=512, PREF_MARGIN_DIV=0.1) Follow UVs from active quads along continuous face loops Parameters

PREF_PACK_IN_ONE=True, PREF_APPLY_IMAGE=False, PREF_BOX_DIV=12,

PREF_CONTEXT (enum in [SEL_FACES, ALL_FACES, ALL_OBJECTS], (optional)) Selection SEL_FACES Selected Faces, Space all UVs evently. ALL_FACES All Faces, Average space UVs edge length of each loop. ALL_OBJECTS Selected Mesh Object, Average space UVs edge length of each loop. PREF_PACK_IN_ONE (boolean, (optional)) Share Tex Space, Objects Share texture space, map all objects into 1 uvmap PREF_NEW_UVLAYER (boolean, (optional)) New UV Map, Create a new UV map for every mesh packed PREF_APPLY_IMAGE (boolean, (optional)) New Image, Assign new images for every mesh (only one if shared tex space enabled) PREF_IMG_PX_SIZE (int in [64, 5000], (optional)) Image Size, Width and Height for the new image PREF_BOX_DIV (int in [1, 48], (optional)) Pack Quality, Pre Packing before the complex boxpack PREF_MARGIN_DIV (oat in [0.001, 1], (optional)) Margin, Size of the margin as a division of the UV File startup/bl_operators/uvcalc_lightmap.py:599 bpy.ops.uv.minimize_stretch(ll_holes=True, blend=0.0, iterations=0) Reduce UV stretching by relaxing angles Parameters ll_holes (boolean, (optional)) Fill Holes, Virtual ll holes in mesh before unwrapping, to better avoid overlaps and preserve symmetry blend (oat in [0, 1], (optional)) Blend, Blend factor between stretch minimized and original iterations (int in [0, inf], (optional)) Iterations, Number of iterations to run, 0 is unlimited when run interactively bpy.ops.uv.pack_islands(margin=0.0) Undocumented (contribute) Parameters margin (oat in [0, 1], (optional)) Margin, Space between islands bpy.ops.uv.pin(clear=False) Set/clear selected UV vertices as anchored between multiple unwrap operations Parameters clear (boolean, (optional)) Clear, Clear pinning for the selection instead of setting it bpy.ops.uv.project_from_view(orthographic=False, correct_aspect=True, clip_to_bounds=False, scale_to_bounds=False) Undocumented (contribute) Parameters 188 Chapter 2. Application Modules

Blender Index, Release 2.61.0 - API

orthographic (boolean, (optional)) Orthographic, Use orthographic projection correct_aspect (boolean, (optional)) Correct Aspect, Map UVs taking image aspect ratio into account clip_to_bounds (boolean, (optional)) Clip to Bounds, Clip UV coordinates to bounds after unwrapping scale_to_bounds (boolean, (optional)) Scale to Bounds, Scale UV coordinates to bounds after unwrapping bpy.ops.uv.reset() Undocumented (contribute) bpy.ops.uv.reveal() Reveal all hidden UV vertices bpy.ops.uv.select(extend=False, location=(0.0, 0.0)) Select UV vertices Parameters extend (boolean, (optional)) Extend, Extend selection rather than clearing the existing selection location (oat array of 2 items in [-inf, inf], (optional)) Location, Mouse location in normalized coordinates, 0.0 to 1.0 is within the image bounds bpy.ops.uv.select_all(action=TOGGLE) Change selection of all UV vertices Parameters action (enum in [TOGGLE, SELECT, DESELECT, INVERT], (optional)) Action, Selection action to execute TOGGLE Toggle, Toggle selection for all elements. SELECT Select, Select all elements. DESELECT Deselect, Deselect all elements. INVERT Invert, Invert selection of all elements. bpy.ops.uv.select_border(pinned=False, gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0, extend=True) Select UV vertices using border selection Parameters pinned (boolean, (optional)) Pinned, Border select pinned UVs only gesture_mode (int in [-inf, inf], (optional)) Gesture Mode xmin (int in [-inf, inf], (optional)) X Min xmax (int in [-inf, inf], (optional)) X Max ymin (int in [-inf, inf], (optional)) Y Min ymax (int in [-inf, inf], (optional)) Y Max extend (boolean, (optional)) Extend, Extend selection instead of deselecting everything rst bpy.ops.uv.select_linked(extend=False) Select all UV vertices linked to the active UV map

2.3. Operators (bpy.ops)

189

Blender Index, Release 2.61.0 - API

Parameters extend (boolean, (optional)) Extend, Extend selection rather than clearing the existing selection bpy.ops.uv.select_linked_pick(extend=False, location=(0.0, 0.0)) Select all UV vertices linked under the mouse Parameters extend (boolean, (optional)) Extend, Extend selection rather than clearing the existing selection location (oat array of 2 items in [-inf, inf], (optional)) Location, Mouse location in normalized coordinates, 0.0 to 1.0 is within the image bounds bpy.ops.uv.select_loop(extend=False, location=(0.0, 0.0)) Select a loop of connected UV vertices Parameters extend (boolean, (optional)) Extend, Extend selection rather than clearing the existing selection location (oat array of 2 items in [-inf, inf], (optional)) Location, Mouse location in normalized coordinates, 0.0 to 1.0 is within the image bounds bpy.ops.uv.select_pinned() Select all pinned UV vertices bpy.ops.uv.smart_project(angle_limit=66.0, island_margin=0.0, user_area_weight=0.0) This script projection unwraps the selected faces of a mesh (it operates on all selected mesh objects, and can be used to unwrap selected faces, or all faces) Parameters angle_limit (oat in [1, 89], (optional)) Angle Limit, lower for more projection groups, higher for less distortion island_margin (oat in [0, 1], (optional)) Island Margin, Margin to reduce bleed from adjacent islands user_area_weight (oat in [0, 1], (optional)) Area Weight, Weight projections vector by faces with larger areas File startup/bl_operators/uvcalc_smart_project.py:1141 bpy.ops.uv.snap_cursor(target=PIXELS) Snap cursor to target type Parameters target (enum in [PIXELS, SELECTED], (optional)) Target, Target to snap the selected UVs to bpy.ops.uv.snap_selected(target=PIXELS) Snap selected UV vertices to target type Parameters target (enum in [PIXELS, CURSOR, ADJACENT_UNSELECTED], (optional)) Target, Target to snap the selected UVs to bpy.ops.uv.sphere_project(direction=VIEW_ON_EQUATOR, align=POLAR_ZX, correct_aspect=True, clip_to_bounds=False, scale_to_bounds=False) Undocumented (contribute) Parameters direction (enum in [VIEW_ON_EQUATOR, VIEW_ON_POLES, ALIGN_TO_OBJECT], (optional)) Direction, Direction of the sphere or cylinder

190

bpy.ops.wm.keyitem_add() Add key map item File startup/bl_operators/wm.py:1364 bpy.ops.wm.keyitem_remove(item_id=0) Remove key map item Parameters item_id (int in [-inf, inf], (optional)) Item Identier, Identier of the item to remove File startup/bl_operators/wm.py:1395 bpy.ops.wm.keyitem_restore(item_id=0) Restore key map item Parameters item_id (int in [-inf, inf], (optional)) Item Identier, Identier of the item to remove File startup/bl_operators/wm.py:1349 bpy.ops.wm.keymap_restore(all=False) Restore key map(s) Parameters all (boolean, (optional)) All Keymaps, Restore all keymaps to default File startup/bl_operators/wm.py:1321 bpy.ops.wm.link_append(lepath=, directory=, lename=, les=None, lter_blender=True, lter_image=False, lter_movie=False, lter_python=False, lter_font=False, lter_sound=False, lter_text=False, lter_btx=False, lter_collada=False, lter_folder=True, lemode=1, relative_path=True, link=True, autoselect=True, active_layer=True, instance_groups=True) Link or Append from a Library .blend le Parameters lepath (string, (optional)) File Path, Path to le directory (string, (optional)) Directory, Directory of the le lename (string, (optional)) File Name, Name of the le les (bpy_prop_collection of OperatorFileListElement, (optional)) Files lter_blender (boolean, (optional)) Filter .blend les lter_image (boolean, (optional)) Filter image les lter_movie (boolean, (optional)) Filter movie les lter_python (boolean, (optional)) Filter python les lter_font (boolean, (optional)) Filter font les lter_sound (boolean, (optional)) Filter sound les lter_text (boolean, (optional)) Filter text les lter_btx (boolean, (optional)) Filter btx les lter_collada (boolean, (optional)) Filter COLLADA les lter_folder (boolean, (optional)) Filter folders lemode (int in [1, 9], (optional)) File Browser Mode, The setting for the le browser mode to load a .blend le, a library or a special le relative_path (boolean, (optional)) Relative Path, Select the le relative to the blend le link (boolean, (optional)) Link, Link the objects or datablocks rather than appending 2.3. Operators (bpy.ops) 203

Blender Index, Release 2.61.0 - API

autoselect (boolean, (optional)) Select, Select the linked objects active_layer (boolean, (optional)) Active Layer, Put the linked objects on the active layer instance_groups (boolean, (optional)) Instance Groups, Create instances for each group as a DupliGroup bpy.ops.wm.memory_statistics() Print memory statistics to the console bpy.ops.wm.ndof_sensitivity_change(decrease=True, fast=False) Change NDOF sensitivity Parameters decrease (boolean, (optional)) Decrease NDOF sensitivity, If true then action decreases NDOF sensitivity instead of increasing fast (boolean, (optional)) Fast NDOF sensitivity change, If true then sensitivity changes 50%, otherwise 10% bpy.ops.wm.open_mainfile(lepath=, lter_blender=True, lter_image=False, lter_movie=False, lter_python=False, lter_font=False, lter_sound=False, lter_text=False, lter_btx=False, lter_collada=False, lter_folder=True, lemode=8, load_ui=True, use_scripts=True) Open a Blender le Parameters lepath (string, (optional)) File Path, Path to le lter_blender (boolean, (optional)) Filter .blend les lter_image (boolean, (optional)) Filter image les lter_movie (boolean, (optional)) Filter movie les lter_python (boolean, (optional)) Filter python les lter_font (boolean, (optional)) Filter font les lter_sound (boolean, (optional)) Filter sound les lter_text (boolean, (optional)) Filter text les lter_btx (boolean, (optional)) Filter btx les lter_collada (boolean, (optional)) Filter COLLADA les lter_folder (boolean, (optional)) Filter folders lemode (int in [1, 9], (optional)) File Browser Mode, The setting for the le browser mode to load a .blend le, a library or a special le load_ui (boolean, (optional)) Load UI, Load user interface setup in the .blend le use_scripts (boolean, (optional)) Trusted Source, Allow blend le execute scripts automatically, default available from system preferences bpy.ops.wm.operator_cheat_sheet() Undocumented (contribute) File startup/bl_operators/wm.py:1424 bpy.ops.wm.operator_preset_add(name=, remove_active=False, operator=) Add an Application Interaction Preset

204

Chapter 2. Application Modules

Blender Index, Release 2.61.0 - API

Parameters name (string, (optional)) Name, Name of the preset, used to make the path name operator (string, (optional)) Operator File startup/bl_operators/presets.py:50 bpy.ops.wm.path_open(lepath=) Open a path in a le browser File startup/bl_operators/wm.py:754 bpy.ops.wm.properties_add(data_path=) Internal use (edit a property data_path) Parameters data_path (string, (optional)) Property Edit, Property data_path edit File startup/bl_operators/wm.py:1031 bpy.ops.wm.properties_context_change(context=) Change the context tab in a Properties Window Parameters context (string, (optional)) Context File startup/bl_operators/wm.py:1061 bpy.ops.wm.properties_edit(data_path=, property=, value=, min=0.0, max=1.0, description=) Internal use (edit a property data_path) Parameters data_path (string, (optional)) Property Edit, Property data_path edit property (string, (optional)) Property Name, Property name edit value (string, (optional)) Property Value, Property value edit min (oat in [-inf, inf], (optional)) Min max (oat in [-inf, inf], (optional)) Max description (string, (optional)) Tip File startup/bl_operators/wm.py:952 bpy.ops.wm.properties_remove(data_path=, property=) Internal use (edit a property data_path) Parameters data_path (string, (optional)) Property Edit, Property data_path edit property (string, (optional)) Property Name, Property name edit File startup/bl_operators/wm.py:1074 bpy.ops.wm.quit_blender() Quit Blender bpy.ops.wm.radial_control(data_path=, rotation_path=, color_path=, ll_color_path=, zoom_path=, image_id=) Undocumented (contribute) Parameters data_path (string, (optional)) Data Path, Path of property to be set by the radial con

Blender 2.61.0 API Reference Guide

Uploaded by

Blender 2.61.0 API Reference Guide

Uploaded by

Blender Index

Release 2.61.0 - API

December 14, 2011

Blender Index, Release 2.61.0 - API

Blender Index, Release 2.61.0 - API

1.1.2 Before Starting

Blender Index, Release 2.61.0 - API

1.1.3 Key Concepts

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

>>> bpy.data.scenes["Scene"] bpy.data.scenes[Scene] >>> bpy.data.materials.new("MyMaterial") bpy.data.materials[MyMaterial]

1.1. Quickstart Introduction

Blender Index, Release 2.61.0 - API

>>> bpy.context.object >>> bpy.context.selected_objects >>> bpy.context.visible_bones

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

def main(context): for ob in context.scene.objects: print(ob)

def register(): bpy.utils.register_class(SimpleOperator)

def unregister(): bpy.utils.unregister_class(SimpleOperator)

if __name__ == "__main__": register() # test call bpy.ops.object.simple_operator()

1.1. Quickstart Introduction

Blender Index, Release 2.61.0 - API

def register(): bpy.utils.register_class(HelloWorldPanel)

def unregister(): bpy.utils.unregister_class(HelloWorldPanel)

if __name__ == "__main__": register()

Blender Index, Release 2.61.0 - API

blender enumerator (multiple) -> set of strings

1.1. Quickstart Introduction

Blender Index, Release 2.61.0 - API

Using Low-Level Functions:

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

1.2 Python API Overview

1.2.1 Python in Blender

1.2.2 The Default Environment

1.2.3 Script Loading

Blender Index, Release 2.61.0 - API

1.2.4 Integration through Classes

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

1.2. Python API Overview

Blender Index, Release 2.61.0 - API

bpy.utils.unregister_class(SimpleOperator) if __name__ == "__main__": register()

Operator.bl_idname expected a string

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

def register(): bpy.utils.register_module(__name__) def unregister(): bpy.utils.unregister_module(__name__)

1.2. Python API Overview

Blender Index, Release 2.61.0 - API

...this is equivalent to:

Dynamic Dened-Classes (Advanced)

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

1.3 Best Practice

1.3.1 Style Conventions

Blender Index, Release 2.61.0 - API

To enable line length checks use this instead. # <pep8-80 compliant>

1.3.2 User Interface Layout

1.3.3 Script Efciency

if len(faces[f_idx].vertices) == 3: faces.pop(f_idx) # remove the triangle

Its faster to build a new list with list comprehension.

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

Adding List Items

Removing List Items

1.3. Best Practice

Blender Index, Release 2.61.0 - API

>>> my_list = some_list_func(my_list)

This is generally faster since there is no re-assignment and no list duplication.

Pythons string joining function. To join a list of strings

If your checking the start of a string for a keyword, rather than...

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.61.0 - API

1.4 Tips and Tricks

1.4.1 Use The Terminal

Blender Index, Release 2.61.0 - API

if name == "main": register() # test call bpy.ops.object.simple_operator()

if name == "main": register()

bpy.utils.unregister_class(SimpleOperator) if name == "main": register()

def register(): bpy.utils.register_module(name) def unregister(): bpy.utils.unregister_module(name)