100% found this document useful (1 vote)

12K views1,502 pages

Blender Python Reference 2 59 2

This document provides an overview of the Blender 2.59.2 Python API. It discusses key concepts like accessing Blender data through modules, using custom properties, understanding the context, and running operators. The goal is to familiarize readers with the new Python API in Blender 2.59.2.

Uploaded by

blessed-be

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

100% found this document useful (1 vote)

12K views1,502 pages

Blender Python Reference 2 59 2

Uploaded by

blessed-be

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

Blender Index

Release 2.59.2 - API

Blender Foundation

September 15, 2011

CONTENTS

Blender/Python Documentation 1.1 Quickstart Introduction . . . 1.2 Python API Overview . . . 1.3 Best Practice . . . . . . . . 1.4 Tips and Tricks . . . . . . . 1.5 Gotchas . . . . . . . . . . .

. . . . .

3 3 11 17 18 22 31 31 35 36 195 1170 1172 1173 1174 1181 1181 1210 1214 1244 1247 1255 1261 1261 1334 1348 1351 1359 1364

Application Modules 2.1 Context Access ([Link]) . 2.2 Data Access ([Link]) . . . . . 2.3 Operators ([Link]) . . . . . . 2.4 Types ([Link]) . . . . . . . . 2.5 Utilities ([Link]) . . . . . . . 2.6 Path Utilities ([Link]) . . . . 2.7 Application Data ([Link]) . . . 2.8 Property Denitions ([Link])

. . . . . . . .

Standalone Modules 3.1 Math Types & Utilities (mathutils) . . . . 3.2 Geometry Utilities ([Link]) . 3.3 OpenGL Wrapper (bgl) . . . . . . . . . 3.4 Font Drawing (blf) . . . . . . . . . . . . 3.5 Audio System (aud) . . . . . . . . . . . 3.6 Extra Utilities (bpy_extras) . . . . . . . Game Engine Modules 4.1 Game Types ([Link]) . . . . . . . 4.2 Game Logic ([Link]) . . . . . . . 4.3 Rasterizer ([Link]) . . . . . . . . 4.4 Video Texture ([Link]) . . . . . 4.5 Game Keys ([Link]) . . . . . . . 4.6 Physics Constraints ([Link])

. . . . . .

API Info 1371 5.1 Blender API Change Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1371 1389 1391

Python Module Index Index

Blender Index, Release 2.59.2 - API

Welcome, this document is an API reference for Blender 2.59.2. built Unknown. A PDF version of this document is also available

CONTENTS

Blender Index, Release 2.59.2 - API

CONTENTS

CHAPTER

ONE

BLENDER/PYTHON DOCUMENTATION
1.1 Quickstart Introduction
1.1.1 Intro
This API is generally stable but some areas are still being added and improved. The Blender/Python API can do the following: Edit any data the user interface can (Scenes, Meshes, Particles etc.) Modify user preferences, keymaps and themes Run tools with own settings Create user interface elements such as menus, headers and panels Create new tools Create interactive tools Create new rendering engines that integrate with Blender Dene new settings in existing Blender data Draw in the 3D view using OpenGL commands from Python The Blender/Python API cant (yet)... Create new space types. Assign custom properties to every type. Dene callbacks or listeners to be notied when data is changed.

1.1.2 Before Starting

This document isnt intended to fully cover each topic. Rather, its purpose is to familiarize you with Blender 2.5s new Python API. A quick list of helpful things to know before starting: Blender uses Python 3.x; some 3rd party extensions are not available yet. The interactive console in Blender 2.5 has been improved; testing one-liners in the console is a good way to learn. Button tool tips show Python attributes and operator names.

Blender Index, Release 2.59.2 - API

Right clicking on buttons and menu items directly links to API documentation. For more examples, the text menu has a templates section where some example operators can be found. To examine further scripts distributed with Blender, see ~/.blender/scripts/startup/bl_ui for the user interface and ~/.blender/scripts/startup/bl_op for operators.

1.1.3 Key Concepts

Data Access
Accessing datablocks

Python accesses Blenders data in the same way as the animation system and user interface, which means any setting that is changed via a button can also be changed from Python. Accessing data from the currently loaded blend le is done with the module [Link]. This gives access to library data. For example:
>>> [Link] <bpy_collection[3], BlendDataObjects> >>> [Link] <bpy_collection[1], BlendDataScenes> >>> [Link] <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([Link]) [[Link]["Cube"], [Link]["Plane"]] >>> [Link][Cube] [Link]["Cube"] >>> [Link][0] [Link]["Cube"]

Accessing attributes

Once you have a data block such as a material, object, groups etc. its attributes can be accessed just like changing a setting in the interface; in fact, the button tooltip also displays the Python attribute which can help in nding what settings to change in a script.
>>> [Link][0].name Camera

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.59.2 - API

>>> [Link]["Scene"] [Link][Scene] >>> [Link]("MyMaterial") [Link][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:
>>> [Link][0].render.resolution_percentage 100 >>> [Link][0].objects["Torus"].[Link][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 [Link]. 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:
[Link]["MyOwnProperty"] = 42 if "SomeProp" in [Link]: print("Property found") # Use the get function like a python dictionary # which can have a fallback value. value = [Link]["Scene"].get("test_prop", "fallback value") # dictionaries can be assigned as long as they only use basic types. group = [Link]("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 [Link] 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.59.2 - API

>>> [Link] >>> [Link].selected_objects >>> [Link].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 [Link] = obj will raise an error. But [Link] = obj will work as expected. The context attributes change depending on where it is accessed. The 3D view has different context members to the Console, so take care when accessing context attributes that the user state is known. See [Link] 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 [Link] module. Examples:
>>> [Link].flip_normals() {FINISHED} >>> [Link](unselected=False) {FINISHED} >>> [Link].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 [Link].view3d.render_border() from the console raises the following error:
RuntimeError: Operator [Link].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 [Link].view3d.render_border.poll(): [Link].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.59.2 - 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 [Link]: print(ob)

class SimpleOperator([Link]): 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(): [Link].register_class(SimpleOperator)

def unregister(): [Link].unregister_class(SimpleOperator)

if name == "main": register() # test call [Link].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. Press Ctrl+V to paste the code into the text panel (the upper left frame). 5. Click on the button Run Script.

1.1. Quickstart Introduction

Blender Index, Release 2.59.2 - API

6. Move youre mouse into the 3D view, press spacebar for the operator search menu, and type Simple. 7. Click on the Simple Operator item found in search. See Also: The class members with the bl_ prex are documented in the API reference [Link] 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([Link]): 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 = [Link] obj = [Link] row = [Link]() [Link](text="Hello world!", icon=WORLD_DATA) row = [Link]() [Link](text="Active object is: " + [Link]) row = [Link]() [Link](obj, "name")

def register(): [Link].register_class(HelloWorldPanel)

def unregister(): [Link].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 4. Press Ctrl+V to paste the code into the text panel (the upper left frame) 5. Click on the button Run Script. To view the results:

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.59.2 - API

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: [Link]

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
>>> [Link].rotation_mode = AXIS_ANGLE

blender enumerator (multiple) -> set of strings

# setting multiple camera overlay guides [Link].show_guide = {GOLDEN, CENTER} # passing as an operator argument for report types [Link]({WARNING, INFO}, "Some message!")

Internal Types Used for Blender datablocks and collections: [Link].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.
>>> [Link] [Link][Cube] >>> [Link] [Link][Scene].objects

Note that these types reference Blenders data so modifying them is immediately visible.

1.1. Quickstart Introduction

Blender Index, Release 2.59.2 - API

Mathutils Types Used for vectors, quaternion, eulers, matrix and color types, accessible from mathutils Some attributes such as [Link], [Link].rotation_euler and [Link].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:
[Link].matrix_world * [Link][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. [Link].z += 2.0 # location variable holds a reference to the object too. location = [Link] location *= 2.0 # Copying the value drops the reference so the value can be passed to # functions and modified without unwanted side effects. location = [Link]()

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 = [Link] [Link][2] = 0.0 obj.keyframe_insert(data_path="location", frame=10.0, index=2) [Link][2] = 1.0 obj.keyframe_insert(data_path="location", frame=20.0, index=2)

Using Low-Level Functions:

obj = [Link] obj.animation_data_create() obj.animation_data.action = [Link](name="MyAction") fcu_z = obj.animation_data.[Link](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.59.2 - 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 [Link]["Cube"].[Link][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.59.2 - 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: [Link] [Link] [Link] [Link] [Link] [Link] 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([Link]): bl_idname = "object.simple_operator" bl_label = "Tool Name" def execute(self, context): print("Hello World") return {FINISHED} [Link].register_class(SimpleOperator)

First note that we subclass a member of [Link], 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.59.2 - 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([Link], BaseOperator): bl_idname = "object.simple_operator" bl_label = "Tool Name" [Link].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 [Link].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([Link]): """ See example above """ def register(): [Link].register_class(SimpleOperator) def unregister():

1.2. Python API Overview

Blender Index, Release 2.59.2 - API

[Link].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 [Link], 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 [Link].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 [Link].register_module [Link].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.59.2 - API

def register(): [Link].register_module(name) def unregister(): [Link].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 [Link].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 # [Link][0].my_custom_props.my_float import bpy class MyMaterialProps([Link]): my_float = [Link]() def register(): [Link].register_class(MyMaterialProps) [Link].my_custom_props = [Link](type=MyMaterialProps) def unregister(): del [Link].my_custom_props [Link].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 # [Link][0].my_custom_props.sub_group.my_float import bpy class MyMaterialSubProps([Link]): my_float = [Link]() class MyMaterialGroupProps([Link]): sub_group = [Link](type=MyMaterialSubProps) def register(): [Link].register_class(MyMaterialSubProps) [Link].register_class(MyMaterialGroupProps)

my_custom_props could

1.2. Python API Overview

Blender Index, Release 2.59.2 - API

[Link].my_custom_props = [Link](type=MyMaterialGroupProps) def unregister(): del [Link].my_custom_props [Link].unregister_class(MyMaterialGroupProps) [Link].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 [Link].my_float = [Link]() # remove del [Link].my_float

This works just as well for PropertyGroup subclasses you dene yourself.
class MyPropGroup([Link]): pass MyPropGroup.my_float = [Link]()

...this is equivalent to:

class MyPropGroup([Link]): my_float = [Link]()

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, ([Link], ), {"bl_idname": idname, "bl_label": "Test", "execute": func}, ) [Link].register_class(opclass)

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.59.2 - 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:
>>> [Link].operator_1() Hello World OBJECT_OT_operator_1 {FINISHED} >>> [Link].operator_2() Hello World OBJECT_OT_operator_2 {FINISHED}

1.3 Best Practice

TODO: Intro text

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.
[Link].file_format = PNG [Link] = "//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> To enable line length checks use this instead. # <pep8-80 compliant>

1.3. Best Practice

Blender Index, Release 2.59.2 - API

1.3.2 User Interface Layout

TODO: Thomas

1.3.3 Script Efciency

TODO: Campbell

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). 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 [Link] and [Link]. 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 [Link] 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. 18 Chapter 1. Blender/Python Documentation

Blender Index, Release 2.59.2 - API

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/[Link]" exec(compile(open(filename).read(), filename, exec))

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

import bpy import os filename = [Link]([Link]([Link]), "[Link]") 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 [Link](myscript) [Link]()

Notice that the script is reloaded every time, this forces use of the modied version, otherwise the cached one in [Link] 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 = [Link]([Link]) if blend_dir not in [Link]: [Link](blend_dir) import myscript import imp [Link](myscript) [Link]()

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.

1.4. Tips and Tricks

Blender Index, Release 2.59.2 - API

blender --background --python [Link]

You might want to run this with a blend le so the script has some data to operate on.
blender [Link] --background --python [Link]

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. 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 [Link] 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.

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.59.2 - API

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 [Link](local=locals())

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

import code namespace = globals().copy() [Link](locals()) [Link](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 [Link]()})

[Link] 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.

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.4. Tips and Tricks

Blender Index, Release 2.59.2 - API

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:
>>> [Link](threshold=0.001) RuntimeError: Operator [Link]() failed, context is incorrect

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.
>>> [Link]() RuntimeError: Operator [Link]() 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: 22 Chapter 1. Blender/Python Documentation

Blender Index, Release 2.59.2 - API

[Link].slot_move [Link].limitdistance_reset [Link].modifier_copy [Link].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 [Link] you may want to access its transformation right after from [Link].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 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 [Link] 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.

1.5. Gotchas

Blender Index, Release 2.59.2 - API

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.
[Link].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. 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 [Link] is assumed to be an armature object.

Edit Bones [Link].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 [Link] in armature editmode: This is only possible in edit mode.
>>> [Link].edit_bones["Bone"].head = Vector((1.0, 2.0, 3.0))

This will be empty outside of editmode.

>>> mybones = [Link].selected_editable_bones

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.59.2 - API

Returns an editbone only in edit mode.

>>> [Link].active_bone

Bones (Object Mode) [Link] 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 [Link] in object or pose mode: Returns a bone (not an editbone) outside of edit mode
>>> [Link].active_bone

This works, as with blender the setting can be edited in any mode
>>> [Link]["Bone"].use_deform = True

Accessible but read-only

>>> tail = [Link]["Bone"].tail

Pose Bones [Link] 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 [Link] in object or pose mode:
# Gets the name of the first constraint (if it exists) [Link]["Bone"].constraints[0].name # Gets the last selected pose bone (pose mode only) [Link].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 [Link] rather than the [Link], the real bones are however accessible from the pose bones - [Link]

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. Gotchas

Blender Index, Release 2.59.2 - API

1.5.6 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([Link]) UnicodeEncodeError: ascii codec cant encode characters in position 10-21: ordinal not in range(128 >>> [Link] = [Link] Traceback (most recent call last): File "<blender_console>", line 1, in <module> TypeError: bpy_struct: [Link]= val: [Link] expected a string type, not str

Here are 2 ways around lesystem encoding issues:

>>> print(repr([Link])) >>> >>> >>> >>> import os filepath_bytes = [Link]([Link]) filepath_utf8 = filepath_bytes.decode(utf-8, "replace") [Link] = 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 [Link] functions instead. Use [Link]() / [Link]() 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 deciede how to treat any strings you want to use with Blender, some importers do this.

1.5.7 Strange errors using threading module

Python threading with Blender only works properly when the threads nish up before the script does. By using [Link]() for example. Heres an example of threading supported by Blender:

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.59.2 - API

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) [Link]["Cube"].location += prod_vec [Link](random() + 1.0) # finish print(threading.current_thread().name, "Exiting") threads = [[Link](name="Prod %d " % i, target=prod) for i in range(10)]

print("Starting threads...") for t in threads: [Link]() print("Waiting for threads to finish...") for t in threads: [Link]()

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 [Link][Cube].location.x += 0.05 def my_timer(): from threading import Timer t = Timer(0.1, my_timer) [Link]() 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. 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. Gotchas

Blender Index, Release 2.59.2 - API

1.5.8 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 [Link] instances (Object, Scene, Mesh etc). This example shows how you can tell undo changes the memory locations.
>>> hash([Link]) -9223372036849950810 >>> hash([Link]) -9223372036849950810

# ... move the active object, then undo

>>> hash([Link]) -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 [Link].mode_set(mode=EDIT) / [Link].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.
mesh = [Link].active_object.data faces = [Link] [Link].mode_set(mode=EDIT) [Link].mode_set(mode=OBJECT) # this will crash print(faces)

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.59.2 - API

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 = [Link].active_object.data faces = [Link] [Link].mode_set(mode=EDIT) [Link].mode_set(mode=OBJECT) # faces have been re-allocated faces = [Link] 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.
[Link].primitive_bezier_curve_add() point = [Link][0].bezier_points[0] [Link][0].bezier_points.add() # this will crash! [Link] = 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. Gotchas

Blender Index, Release 2.59.2 - API

Chapter 1. Blender/Python Documentation

CHAPTER

TWO

APPLICATION MODULES
2.1 Context Access ([Link])
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

[Link] Type [Link] [Link].visible_objects Type sequence of [Link] [Link].visible_bases Type sequence of [Link] [Link].selectable_objects Type sequence of [Link] [Link].selectable_bases Type sequence of [Link] [Link].selected_objects Type sequence of [Link] [Link].selected_bases Type sequence of [Link] [Link].selected_editable_objects Type sequence of [Link] [Link].selected_editable_bases Type sequence of [Link] [Link].visible_bones Type sequence of [Link] [Link].editable_bones 31

Blender Index, Release 2.59.2 - API

Type sequence of [Link] [Link].selected_bones Type sequence of [Link] [Link].selected_editable_bones Type sequence of [Link] [Link].visible_pose_bones Type sequence of [Link] [Link].selected_pose_bones Type sequence of [Link] [Link].active_bone Type [Link] [Link].active_pose_bone Type [Link] [Link].active_base Type [Link] [Link].active_object Type [Link] [Link] Type [Link] [Link].edit_object Type [Link] [Link].sculpt_object Type [Link] [Link].vertex_paint_object Type [Link] [Link].weight_paint_object Type [Link] [Link].image_paint_object Type [Link] [Link].particle_edit_object Type [Link] [Link] Type sequence of [Link] [Link].selected_sequences Type sequence of [Link] [Link].selected_editable_sequences

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type sequence of [Link]

2.1.2 View3D Context

[Link].selected_objects Type sequence of [Link] [Link].selected_bases Type sequence of [Link] [Link].selected_editable_objects Type sequence of [Link] [Link].selected_editable_bases Type sequence of [Link] [Link].visible_objects Type sequence of [Link] [Link].visible_bases Type sequence of [Link] [Link].selectable_objects Type sequence of [Link] [Link].selectable_bases Type sequence of [Link] [Link].active_base Type [Link] [Link].active_object Type [Link]

2.1.3 Buttons Context

[Link] Type [Link] [Link] Type [Link] [Link] Type [Link] [Link] Type [Link] [Link] Type [Link] [Link] 2.1. Context Access ([Link]) 33

Blender Index, Release 2.59.2 - API

Type [Link] [Link].meta_ball Type [Link] [Link] Type [Link] [Link] Type [Link] [Link] Type [Link] [Link] Type [Link] [Link].material_slot Type [Link] [Link] Type [Link] [Link].texture_slot Type [Link] [Link] Type [Link] [Link].edit_bone Type [Link] [Link].pose_bone Type [Link] [Link].particle_system Type [Link] [Link].particle_system_editable Type [Link] [Link] Type [Link] [Link].soft_body Type [Link] [Link] Type [Link] [Link] Type [Link] [Link]

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type [Link] [Link] Type [Link]

2.1.4 Image Context

[Link].edit_image Type [Link]

2.1.5 Node Context

[Link].selected_nodes Type sequence of [Link]

2.1.6 Text Context

[Link].edit_text Type [Link]

2.2 Data Access ([Link])

This module is used for all blender/python access. [Link] Access to blenders internal data Type [Link]
import bpy

# print all objects for obj in [Link]: print([Link])

# print all scene names in a list print([Link]())

# remove mesh Cube if "Cube" in [Link]: mesh = [Link]["Cube"] print("removing mesh", mesh) [Link](mesh)

# write images into a file next to the blend import os file = open([Link]([Link])[0] + ".txt", w)

2.2. Data Access ([Link])

Blender Index, Release 2.59.2 - API

for image in [Link]: [Link]("%s %d x %d \n" % ([Link], [Link][0], [Link][1])) [Link]()

2.3 Operators ([Link])

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 [Link], [Link] is just the access path for python.
import bpy # calling an operator [Link](number_cuts=3, smoothness=0.5)

# check poll() to avoid exception. if [Link].mode_set.poll(): [Link].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)
# group add popup import bpy [Link].group_instance_add(INVOKE_DEFAULT)

Action Operators [Link](threshold=0.001) Simplify F-Curves by removing closely spaced keyframes Parameters threshold (oat in [0, inf], (optional)) Threshold 36 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link](extend=False, column=False) Select keyframes by clicking on them Parameters extend (boolean, (optional)) Extend Select column (boolean, (optional)) Column Select [Link]() Copy selected keyframes to the copy/paste buffer [Link]() Remove all selected keyframes [Link](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 [Link].duplicate_move(ACTION_OT_duplicate=None, FORM_OT_transform=None) Undocumented (contribute) Parameters ACTION_OT_duplicate (ACTION_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 [Link].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. [Link].frame_jump() Set the current frame to the average frame of the selected keyframes [Link].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. TRANS-

2.3. Operators ([Link])

Blender Index, Release 2.59.2 - API

ALIGNED Aligned. AUTO Automatic. AUTO_CLAMPED Auto Clamped, Auto handles clamped to not overshoot. [Link].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 [Link].keyframe_insert(type=ALL) Insert keyframes for the specied channels Parameters type (enum in [ALL, SEL, GROUP], (optional)) Type [Link].keyframe_type(type=KEYFRAME) Set type of keyframe for the selected keyframes Parameters type (enum in [KEYFRAME, BREAKDOWN, EXTREME, JITTER], (optional)) Type [Link].markers_make_local() Move selected scene markers to the active Action as local pose markers [Link](type=CFRA) Flip selected keyframes over the selected mirror line Parameters type (enum in [CFRA, XAXIS, MARKER], (optional)) Type [Link]() Create new action [Link](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 merking 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.. [Link].previewrange_set() Set Preview Range based on extents of selected Keyframes [Link]() Add keyframes on every frame between the selected keyframes

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.3. Operators ([Link])

Blender Index, Release 2.59.2 - API

[Link]() Isolate selected bones into a separate armature [Link](number_cuts=1) Break selected bones into chains of smaller bones Parameters number_cuts (int in [1, inf], (optional)) Number of Cuts [Link].switch_direction() Change the direction that a chain of bones points in (head <-> tail swap) Boid Operators [Link].rule_add(type=GOAL) Add a boid rule to the current boid state Parameters type (enum in [GOAL, AVOID, AVOID_COLLISION, SEPARATE, FLOCK, FOLLOW_LEADER, AVERAGE_SPEED, FIGHT], (optional)) Type GOAL Goal, Go to assigned object or loudest assigned signal source. AVOID Avoid, Get away from assigned object or loudest assigned signal source. AVOID_COLLISION Avoid Collision, Manoeuvre to avoid collisions with other boids and deector objects in near future. SEPARATE Separate, Keep from going through other boids. FLOCK Flock, Move to center of neighbors and match their velocity. FOLLOW_LEADER Follow Leader, Follow a boid or assigned object. AVERAGE_SPEED Average Speed, Maintain speed, ight level or wander. FIGHT Fight, Go to closest enemy and attack when in range. [Link].rule_del() Undocumented (contribute) [Link].rule_move_down() Move boid rule down in the list [Link].rule_move_up() Move boid rule up in the list [Link].state_add() Add a boid state to the particle system [Link].state_del() Undocumented (contribute) [Link].state_move_down() Move boid state down in the list [Link].state_move_up() Move boid state up in the list Brush Operators [Link].active_index_set(mode=, index=0) Set active sculpt/paint brush from its number Parameters 46 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

mode (string, (optional)) mode, Paint mode to set brush for index (int in [-inf, inf], (optional)) number, Brush number File startup/bl_operators/[Link] [Link]() Add brush by mode type [Link].curve_preset(shape=SMOOTH) Set brush shape Parameters shape (enum in [SHARP, SMOOTH, MAX, LINE, ROUND, ROOT], (optional)) Mode [Link].image_tool_set(tool=DRAW) Set the image tool Parameters tool (enum in [DRAW, SOFTEN, SMEAR, CLONE], (optional)) Tool [Link]() Return brush to defaults based on current tool [Link].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 [Link].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 [Link].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. DARKEN Darken, Use darken blending mode while painting. [Link].weight_tool_set(tool=MIX) Set the weight 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.

2.3. Operators ([Link])

Blender Index, Release 2.59.2 - API

MUL Multiply, Use multiply blending mode while painting. BLUR Blur, Blur the color with surrounding values. LIGHTEN Lighten, Use lighten blending mode while painting. DARKEN Darken, Use darken blending mode while painting. Buttons Operators [Link].directory_browse(directory=, lter_blender=False, 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=False, lemode=9, relative_path=False) Open a directory browser, Hold Shift to open the le, Alt to browse containing directory Parameters directory (string, (optional)) Directory, Directory of the 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 [Link].file_browse(lepath=, lter_blender=False, 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=False, lemode=9, relative_path=False) Open a le browser, Hold Shift to open the le, Alt to browse containing directory 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.59.2 - API

2.3. Operators ([Link])

Blender Index, Release 2.59.2 - API

[Link](need_active=False) Execute selected le Parameters need_active (boolean, (optional)) Need Active, Only execute if theres an active selected le in the le list. [Link](increment=1) Increment number in lename Parameters increment (int in [-100, 100], (optional)) Increment [Link].find_missing_files(lepath=, lter_blender=False, 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=False, lemode=9) 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 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 [Link]() Toggle hide hidden dot les [Link]() Highlight selected le(s) [Link].make_paths_absolute() Undocumented (contribute) [Link].make_paths_relative() Undocumented (contribute) [Link]() Move to next folder [Link].pack_all() Undocumented (contribute) [Link]() Move to parent directory [Link]() Move to previous folder 62 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link]() Refresh the le list [Link]() Rename le or le directory [Link].report_missing_files() Undocumented (contribute) [Link](extend=False, ll=False) Activate/select le Parameters extend (boolean, (optional)) Extend, Extend selection instead of deselecting everything rst. ll (boolean, (optional)) Fill, Select everything beginning with the last selection. [Link].select_all_toggle() Select/deselect all les [Link].select_bookmark(dir=) Select a bookmarked directory Parameters dir (string, (optional)) Dir [Link].select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0) Activate/select the le(s) contained in the border 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 [Link]() Smooth scroll to make editable le visible. [Link].unpack_all(method=USE_LOCAL) Undocumented (contribute) Parameters method (enum in [USE_LOCAL, WRITE_LOCAL, USE_ORIGINAL, WRITE_ORIGINAL, KEEP, ASK], (optional)) Method, How to unpack. Fluid Operators [Link]() Bake uid simulation Font Operators [Link].buffer_paste() Paste text from OS buffer [Link].case_set(case=LOWER) Set font case 2.3. Operators ([Link]) 63

Blender Index, Release 2.59.2 - API

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - 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 copy (boolean, (optional)) Copy, Create a new image le without modifying the current image in blender [Link].save_dirty() Save all modied textures File startup/bl_operators/[Link] [Link].save_sequence() Undocumented (contribute) [Link]() Toggle display scopes panel [Link](method=USE_LOCAL, id=) Save an image packed in the .blend le to disk Parameters method (enum in [USE_LOCAL, WRITE_LOCAL, WRITE_ORIGINAL], (optional)) Method, How to unpack. id (string, (optional)) Image Name, Image datablock name to unpack. [Link].view_all() Undocumented (contribute) [Link].view_ndof() Undocumented (contribute) [Link].view_pan(offset=(0.0, 0.0)) Undocumented (contribute) Parameters offset (oat array of 2 items in [-inf, inf], (optional)) Offset, Offset in oating point units, 1.0 is the width and height of the image. [Link].view_selected() Undocumented (contribute) [Link].view_zoom(factor=0.0) Undocumented (contribute) Parameters factor (oat in [0, inf], (optional)) Factor, Zoom factor, values higher than 1.0 zoom in, lower values zoom out. [Link].view_zoom_in() Undocumented (contribute) [Link].view_zoom_out() Undocumented (contribute) [Link].view_zoom_ratio(ratio=0.0) Undocumented (contribute) Parameters ratio (oat in [0, inf], (optional)) Ratio, Zoom ratio, 1.0 is 1:1, higher is zoomed in, lower is zoomed out. USE_ORIGINAL,

2.3. Operators ([Link])

Blender Index, Release 2.59.2 - API

Import Anim Operators [Link].import_anim.bvh(lepath=, lter_glob=*.bvh, target=ARMATURE, global_scale=1.0, frame_start=1, use_cyclic=False, rotate_mode=NATIVE, axis_forward=-Z, axis_up=Y) Load a BVH motion capture le Parameters lepath (string, (optional)) File Path, Filepath used for importing the le target (enum in [ARMATURE, OBJECT], (optional)) Target, Import target type. global_scale (oat in [0.0001, 1e+06], (optional)) Scale, Scale the BVH by this value frame_start (int in [-inf, inf], (optional)) Start Frame, Starting frame for the animation use_cyclic (boolean, (optional)) Loop, Loop the animation playback rotate_mode (enum in [QUATERNION, NATIVE, XYZ, XZY, YXZ, YZX, ZXY, ZYX], (optional)) Rotation, Rotation conversion. QUATERNION Quaternion, Convert rotations to quaternions. NATIVE Euler (Native), Use the rotation order dened in the BVH le. XYZ Euler (XYZ), Convert rotations to euler XYZ. XZY Euler (XZY), Convert rotations to euler XZY. YXZ Euler (YXZ), Convert rotations to euler YXZ. YZX Euler (YZX), Convert rotations to euler YZX. ZXY Euler (ZXY), Convert rotations to euler ZXY. ZYX Euler (ZYX), Convert rotations to euler ZYX. axis_forward (enum in [X, Y, Z, -X, -Y, -Z], (optional)) Forward axis_up (enum in [X, Y, Z, -X, -Y, -Z], (optional)) Up File addons/io_anim_bvh/__init__.py:130 Import Curve Operators [Link].import_curve.svg(lepath=, lter_glob=*.svg) Load a SVG le Parameters lepath (string, (optional)) File Path, Filepath used for importing the le File addons/io_curve_svg/__init__.py:58 Import Mesh Operators [Link].import_mesh.ply(lepath=, les=None, directory=, lter_glob=*.ply) Load a PLY geometry le Parameters lepath (string, (optional)) File Path, Filepath used for importing the le les (bpy_prop_collection of OperatorFileListElement, (optional)) File Path, File path used for importing the PLY le

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

File addons/io_mesh_ply/__init__.py:67 [Link].import_mesh.stl(lepath=, lter_glob=*.stl, les=None, directory=) Load STL triangle mesh data Parameters lepath (string, (optional)) File Path, Filepath used for importing the le les (bpy_prop_collection of OperatorFileListElement, (optional)) File Path File addons/io_mesh_stl/__init__.py:86 Import Scene Operators [Link].import_scene.autodesk_3ds(lepath=, lter_glob=*.3ds, constrain_size=10.0, use_image_search=True, use_apply_transform=True, axis_forward=Y, axis_up=Z) Import from 3DS le format (.3ds) Parameters lepath (string, (optional)) File Path, Filepath used for importing the le constrain_size (oat in [0, 1000], (optional)) Size Constraint, Scale the model by 10 until it reacehs the size constraint. Zero Disables. use_image_search (boolean, (optional)) Image Search, Search subdirectories for any assosiated images (Warning, may be slow) use_apply_transform (boolean, (optional)) Apply Transform, Workaround for object transformations importing incorrectly axis_forward (enum in [X, Y, Z, -X, -Y, -Z], (optional)) Forward axis_up (enum in [X, Y, Z, -X, -Y, -Z], (optional)) Up File addons/io_scene_3ds/__init__.py:107 [Link].import_scene.obj(lepath=, lter_glob=*.obj;*.mtl, use_ngons=True, use_edges=True, use_smooth_groups=True, use_split_objects=True, use_split_groups=True, use_groups_as_vgroups=False, use_image_search=True, split_mode=ON, global_clamp_size=0.0, axis_forward=-Z, axis_up=Y) Load a Wavefront OBJ File Parameters lepath (string, (optional)) File Path, Filepath used for importing the le use_ngons (boolean, (optional)) NGons, Import faces with more then 4 verts as fgons use_edges (boolean, (optional)) Lines, Import lines and faces with 2 verts as edge use_smooth_groups (boolean, (optional)) Smooth Groups, Surround smooth groups by sharp edges use_split_objects (boolean, (optional)) Object, Import OBJ Objects into Blender Objects use_split_groups (boolean, (optional)) Group, Import OBJ Groups into Blender Objects use_groups_as_vgroups (boolean, (optional)) Poly Groups, Import OBJ groups as vertex groups.

2.3. Operators ([Link])

Blender Index, Release 2.59.2 - API

use_image_search (boolean, (optional)) Image Search, Search subdirs for any assosiated images (Warning, may be slow) split_mode (enum in [ON, OFF], (optional)) Split ON Split, Split geometry, omits unused verts. OFF Keep Vert Order, Keep vertex order from le. global_clamp_size (oat in [0, 1000], (optional)) Clamp Scale, Clamp the size to this maximum (Zero to Disable) axis_forward (enum in [X, Y, Z, -X, -Y, -Z], (optional)) Forward axis_up (enum in [X, Y, Z, -X, -Y, -Z], (optional)) Up File addons/io_scene_obj/__init__.py:147 [Link].import_scene.x3d(lepath=, axis_up=Y) Import and X3D or VRML le Parameters lepath (string, (optional)) File Path, Filepath used for importing the le axis_forward (enum in [X, Y, Z, -X, -Y, -Z], (optional)) Forward axis_up (enum in [X, Y, Z, -X, -Y, -Z], (optional)) Up File addons/io_scene_x3d/__init__.py:84 Info Operators [Link].report_copy() Copy selected reports to Clipboard [Link].report_delete() Delete selected reports [Link].report_replay() Replay selected reports [Link].reports_display_update() Undocumented (contribute) [Link].select_all_toggle() (de)select all reports [Link].select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0) Toggle 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 [Link].select_pick(report_index=0) Select reports by index 78 Chapter 2. Application Modules lter_glob=*.x3d;*.wrl, axis_forward=Z,

Blender Index, Release 2.59.2 - API

Parameters report_index (int in [0, inf], (optional)) Report, The index of the report. Lamp Operators [Link].sunsky_preset_add(name=, remove_active=False) Add a Sky & Atmosphere Preset Parameters name (string, (optional)) Name, Name of the preset, used to make the path name File startup/bl_operators/[Link] Lattice Operators [Link].make_regular() Set UVW control points a uniform distance apart [Link].select_all(action=TOGGLE) Change selection of all UVW control points 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. Logic Operators [Link].actuator_add(type=, name=, object=) Add a actuator to the active object Parameters type (enum in [], (optional)) Type, Type of actuator to add name (string, (optional)) Name, Name of the Actuator to add object (string, (optional)) Object, Name of the Object to add the Actuator to [Link].actuator_move(actuator=, object=, direction=UP) Move Actuator Parameters actuator (string, (optional)) Actuator, Name of the actuator to edit object (string, (optional)) Object, Name of the object the actuator belongs to direction (enum in [UP, DOWN], (optional)) Direction, Move Up or Down [Link].actuator_remove(actuator=, object=) Remove a actuator from the active object Parameters actuator (string, (optional)) Actuator, Name of the actuator to edit object (string, (optional)) Object, Name of the object the actuator belongs to

2.3. Operators ([Link])

Blender Index, Release 2.59.2 - API

[Link].controller_add(type=LOGIC_AND, name=, object=) Add a controller to the active object Parameters type (enum in [LOGIC_AND, LOGIC_OR, LOGIC_NAND, LOGIC_NOR, LOGIC_XOR, LOGIC_XNOR, EXPRESSION, PYTHON], (optional)) Type, Type of controller to add LOGIC_AND And, Logic And. LOGIC_OR Or, Logic Or. LOGIC_NAND Nand, Logic Nand. LOGIC_NOR Nor, Logic Nor. LOGIC_XOR Xor, Logic Xor. LOGIC_XNOR Xnor, Logic Xnor. EXPRESSION Expression. PYTHON Python. name (string, (optional)) Name, Name of the Controller to add object (string, (optional)) Object, Name of the Object to add the Controller to [Link].controller_move(controller=, object=, direction=UP) Move Controller Parameters controller (string, (optional)) Controller, Name of the controller to edit object (string, (optional)) Object, Name of the object the controller belongs to direction (enum in [UP, DOWN], (optional)) Direction, Move Up or Down [Link].controller_remove(controller=, object=) Remove a controller from the active object Parameters controller (string, (optional)) Controller, Name of the controller to edit object (string, (optional)) Object, Name of the object the controller belongs to [Link].links_cut(path=None, cursor=9) Remove logic brick connections Parameters path (bpy_prop_collection of OperatorMousePath, (optional)) path cursor (int in [0, inf], (optional)) Cursor [Link]() Toggle display properties panel [Link].sensor_add(type=, name=, object=) Add a sensor to the active object Parameters type (enum in [], (optional)) Type, Type of sensor to add name (string, (optional)) Name, Name of the Sensor to add

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

object (string, (optional)) Object, Name of the Object to add the Sensor to [Link].sensor_move(sensor=, object=, direction=UP) Move Sensor Parameters sensor (string, (optional)) Sensor, Name of the sensor to edit object (string, (optional)) Object, Name of the object the sensor belongs to direction (enum in [UP, DOWN], (optional)) Direction, Move Up or Down [Link].sensor_remove(sensor=, object=) Remove a sensor from the active object Parameters sensor (string, (optional)) Sensor, Name of the sensor to edit object (string, (optional)) Object, Name of the object the sensor belongs to Marker Operators [Link]() Add a new time marker [Link].camera_bind() Bind the active camera to selected markers(s) [Link]() Delete selected time marker(s) [Link](frames=0) Duplicate selected time marker(s) Parameters frames (int in [-inf, inf], (optional)) Frames [Link].make_links_scene(scene=) Copy selected markers to another scene Parameters scene (enum in [], (optional)) Scene [Link](frames=0) Move selected time marker(s) Parameters frames (int in [-inf, inf], (optional)) Frames [Link](name=RenamedMarker) Rename rst selected time marker Parameters name (string, (optional)) Name, New name for marker [Link](extend=False, camera=False) Select time marker(s) Parameters extend (boolean, (optional)) Extend, extend the selection camera (boolean, (optional)) Camera, Select the camera [Link].select_all(action=TOGGLE) Change selection of all time markers

2.3. Operators ([Link])

Blender Index, Release 2.59.2 - API

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. [Link].select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0) 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 Material Operators [Link]() Copy the material settings and nodes [Link]() Add a new material [Link]() Paste the material settings and nodes [Link].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/[Link] Mball Operators [Link].delete_metaelems() Delete selected metaelement(s) [Link].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 [Link].hide_metaelems(unselected=False) Hide (un)selected metaelement(s) Parameters unselected (boolean, (optional)) Unselected, Hide unselected rather than selected. 82 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link].reveal_metaelems() Reveal all hidden metaelements [Link].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. [Link].select_inverse_metaelems() Select inverse of (un)selected metaelements [Link].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 [Link].beautify_fill() Rearrange geometry on a selected surface to avoid skinny faces [Link].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. [Link].colors_mirror(axis=X) Mirror UV/image color layer Parameters axis (enum in [X, Y], (optional)) Axis, Axis to mirror colors around. [Link].colors_rotate(direction=CW) Rotate UV/image color layer Parameters direction (enum in [CW, CCW], (optional)) Direction, Direction to rotate edge around. [Link](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 [Link].delete_edgeloop() Delete an edge loop by merging the faces on each side to a single face loop File startup/bl_operators/[Link]

2.3. Operators ([Link])

Blender Index, Release 2.59.2 - API

[Link].drop_named_image(name=Image, lepath=Path) Assigns Image to active UV layer, or creates a UV layer Parameters name (string, (optional)) Name, Image name to assign. lepath (string, (optional)) Filepath, Path to image le [Link].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 [Link](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 [Link].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 [Link].edge_face_add() Add an edge or face to selected [Link].edge_flip() Flip selected edge or adjoining faces [Link].edge_rotate(direction=CW) Rotate selected edge or adjoining faces Parameters direction (enum in [CW, CCW], (optional)) Direction, Direction to rotate the edge around. [Link].edgering_select(extend=False) Select an edge ring Parameters extend (boolean, (optional)) Extend, Extend the selection [Link].edges_select_sharp(sharpness=0.01) Marked selected edges as sharp Parameters sharpness (oat in [0, inf], (optional)) sharpness [Link](type=REGION) Extrude selected vertices, edges or faces Parameters type (enum in [REGION, FACES, EDGES, VERTS], (optional)) Type

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

major_segments (int in [3, 256], (optional)) Major Segments, Number of segments for the main ring of the torus minor_segments (int in [3, 256], (optional)) Minor Segments, Number of segments for the minor ring of the torus use_abso (boolean, (optional)) Use Int+Ext Controls, Use the Int / Ext controls for torus dimensions abso_major_rad (oat in [0.01, 100], (optional)) Exterior Radius, Total Exterior Radius of the torus abso_minor_rad (oat in [0.01, 100], (optional)) Inside Radius, Total Interior Radius of the torus view_align (boolean, (optional)) Align to View location (oat array of 3 items in [-inf, inf], (optional)) Location rotation (oat array of 3 items in [-inf, inf], (optional)) Rotation File startup/bl_operators/add_mesh_torus.py:148 [Link].primitive_uv_sphere_add(segments=32, ring_count=16, size=1.0, 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 UV sphere mesh Parameters segments (int in [3, inf], (optional)) Segments ring_count (int in [3, inf], (optional)) Rings size (oat in [0, inf], (optional)) Size 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 rotation (oat array of 3 items in [-inf, inf], (optional)) Rotation, Rotation for the newly added object layers (boolean array of 20 items, (optional)) Layer [Link].quads_convert_to_tris() Convert selected quads to triangles [Link].region_to_loop() Select a region as a loop of connected edges [Link].remove_doubles(limit=0.0001) Remove duplicate vertices Parameters limit (oat in [1e-06, 50], (optional)) Merge Threshold, Minimum distance between merged verts [Link]() Reveal all hidden vertices, edges and faces 2.3. Operators ([Link]) 91

Blender Index, Release 2.59.2 - API

[Link](constraint_axis=(False, False, False), constraint_orientation=, mirror=False, release_conrm=False) Rip selection from mesh (quads only) Parameters constraint_axis (boolean array of 3 items, (optional)) Constraint Axis constraint_orientation (enum in [], (optional)) Orientation, Transformation orientation mirror (boolean, (optional)) Mirror Editing release_conrm (boolean, (optional)) Conrm on Release, Always conrm operation when releasing button [Link].rip_move(MESH_OT_rip=None, TRANSFORM_OT_translate=None) Undocumented (contribute) Parameters MESH_OT_rip (MESH_OT_rip, (optional)) Rip, Rip selection from mesh (quads only) TRANSFORM_OT_translate (TRANSFORM_OT_translate, (optional)) Translate, Translate selected items [Link](steps=9, turns=1, center=(0.0, 0.0, 0.0), axis=(0.0, 0.0, 0.0)) Extrude selected vertices in screw-shaped rotation around the cursor in indicated viewport Parameters steps (int in [0, inf], (optional)) Steps, Steps turns (int in [0, inf], (optional)) Turns, Turns 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 [Link].select_all(action=TOGGLE) Change selection of all vertices, edges or faces 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. [Link].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 [Link].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. 92 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link].select_inverse() Select inverse of (un)selected vertices, edges or faces [Link].select_less() Select less vertices, edges or faces connected to initial selection [Link].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) [Link].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) [Link].select_mirror(extend=False) Select mesh items at mirrored locations Parameters extend (boolean, (optional)) Extend, Extend the existing selection [Link].select_more() Select more vertices, edges or faces connected to initial selection [Link].select_non_manifold() Select all non-manifold vertices or edges [Link].select_nth(nth=2) Undocumented (contribute) Parameters nth (int in [2, 100], (optional)) Nth Selection [Link].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. [Link].select_shortest_path(extend=False) Select shortest path between two selections Parameters extend (boolean, (optional)) Extend Select [Link].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 [Link].select_vertex_path(type=EDGE_LENGTH) Select shortest path between two vertices by distance type

2.3. Operators ([Link])

Blender Index, Release 2.59.2 - API

Parameters type (enum in [EDGE_LENGTH, TOPOLOGICAL], (optional)) Type, Method to compute distance. [Link](type=SELECTED) Separate selected geometry into a new mesh Parameters type (enum in [SELECTED, MATERIAL, LOOSE], (optional)) Type [Link].shape_propagate_to_all() Apply selected vertex locations to all other shape keys [Link](thickness=0.01) Create a solid skin by extruding, compensating for sharp angles Parameters thickness (oat in [-inf, inf], (optional)) Thickness [Link].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 [Link](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 [Link]() Split selected geometry into separate disconnected mesh [Link].sticky_add() Add sticky UV texture layer [Link].sticky_remove() Remove sticky UV texture layer [Link](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 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 [Link].tris_convert_to_quads() Convert selected triangles to quads [Link].uv_texture_add() Add UV texture layer fractal=0.0, cor-

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link].uv_texture_remove() Remove UV texture layer [Link].uvs_mirror(axis=X) Mirror selected UVs Parameters axis (enum in [X, Y], (optional)) Axis, Axis to mirror UVs around. [Link].uvs_rotate(direction=CW) Rotate selected UVs Parameters direction (enum in [CW, CCW], (optional)) Direction, Direction to rotate UVs around. [Link].vertex_color_add() Add vertex color layer [Link].vertex_color_remove() Remove vertex color layer [Link].vertices_randomize() Randomize vertex order [Link].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. [Link].vertices_sort() Sort vertex order Nla Operators [Link].action_sync_length(active=True) Synchronise the length of the referenced Action with the lengths used in the strip Parameters active (boolean, (optional)) Active Strip Only, Only sync the active length for the active strip. [Link].actionclip_add(action=) Add an Action-Clip strip (i.e. an NLA Strip referencing an Action) to the active track Parameters action (enum in [], (optional)) Action [Link].apply_scale() Apply scaling of selected strips to their referenced Actions [Link](frame_start=1, frame_end=250, step=1, clear_consraints=False, bake_types={POSE}) Bake animation to an Action Parameters frame_start (int in [0, 300000], (optional)) Start Frame, Start frame for baking frame_end (int in [1, 300000], (optional)) End Frame, End frame for baking only_selected=True,

2.3. Operators ([Link])

Blender Index, Release 2.59.2 - API

step (int in [1, 120], (optional)) Frame Step, Frame Step only_selected (boolean, (optional)) Only Selected clear_consraints (boolean, (optional)) Clear Constraints bake_types (enum set in {POSE, OBJECT}, (optional)) Bake Data File startup/bl_operators/[Link] [Link].channels_click(extend=False) Handle clicks to select NLA channels Parameters extend (boolean, (optional)) Extend Select [Link].clear_scale() Reset scaling of selected strips [Link].click_select(extend=False) Handle clicks to select NLA Strips Parameters extend (boolean, (optional)) Extend Select [Link]() Delete selected strips [Link].delete_tracks() Delete selected NLA-Tracks and the strips they contain [Link](mode=TRANSLATION) Duplicate selected NLA-Strips, adding the new strips in new tracks above the originals 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 [Link].fmodifier_add(type=NULL, only_active=False) Add F-Modier of the specied type to the selected NLA-Strips 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 of the specied type to the active strip. [Link].fmodifier_copy() Copy the F-Modier(s) of the active NLA-Strip [Link].fmodifier_paste() Add copied F-Modiers to the selected NLA-Strips [Link].meta_add() Add new meta-strips incorporating the selected strips [Link].meta_remove() Separate out the strips held by the selected meta-strips [Link].move_down() Move selected strips down a track if theres room

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link].move_up() Move selected strips up a track if theres room [Link].mute_toggle() Mute or un-mute selected strips [Link]() Toggle display properties panel [Link].select_all_toggle(invert=False) (De)Select all NLA-Strips Parameters invert (boolean, (optional)) Invert [Link].select_border(gesture_mode=0, axis_range=False) Use box selection to grab NLA-Strips 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 axis_range (boolean, (optional)) Axis Range [Link].select_leftright(mode=CHECK, extend=False) Select strips to the left or the right of the current frame Parameters mode (enum in [CHECK, LEFT, RIGHT], (optional)) Mode extend (boolean, (optional)) Extend Select [Link](type=CFRA) Move start of strips to specied time Parameters type (enum in [CFRA, NEAREST_FRAME, NEAREST_SECOND, NEAREST_MARKER], (optional)) Type [Link].soundclip_add() Add a strip for controlling when speaker plays its sound clip [Link]() Split selected strips at their midpoints [Link]() Swap order of selected strips within tracks [Link].tracks_add(above_selected=False) Add NLA-Tracks above/after the selected tracks Parameters above_selected (boolean, (optional)) Above Selected, Add a new NLA Track above every existing selected one. [Link].transition_add() Add a transition strip between two adjacent selected strips [Link].tweakmode_enter() Enter tweaking mode for the action referenced by the active strip 2.3. Operators ([Link]) 97 xmin=0, xmax=0, ymin=0, ymax=0,

Blender Index, Release 2.59.2 - API

[Link].tweakmode_exit() Exit tweaking mode for the action referenced by the active strip [Link].view_all() Reset viewable area to show full strips range [Link].view_selected() Reset viewable area to show selected strips range Node Operators [Link].add_file(lepath=, lter_blender=False, lter_image=True, 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=9, name=Image) Add a le node to the current node editor 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 name (string, (optional)) Name, Datablock name to assign. [Link].backimage_move() Move Node backdrop [Link].backimage_sample() Undocumented (contribute) [Link].backimage_zoom(factor=1.2) Undocumented (contribute) Parameters factor (oat in [0, 10], (optional)) Factor [Link]() Delete selected nodes [Link].delete_reconnect() Delete nodes; will reconnect nodes as if deletion was muted [Link](keep_inputs=False) Duplicate the nodes 98 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Parameters keep_inputs (boolean, (optional)) Keep Inputs, Keep the input links to duplicated nodes [Link].duplicate_move(NODE_OT_duplicate=None, TRANSFORM_OT_translate=None) Undocumented (contribute) Parameters NODE_OT_duplicate (NODE_OT_duplicate, (optional)) Duplicate Nodes, Duplicate the nodes TRANSFORM_OT_translate (TRANSFORM_OT_translate, (optional)) Translate, Translate selected items [Link].duplicate_move_keep_inputs(NODE_OT_duplicate=None, FORM_OT_translate=None) Undocumented (contribute) Parameters NODE_OT_duplicate (NODE_OT_duplicate, (optional)) Duplicate Nodes, Duplicate the nodes TRANSFORM_OT_translate (TRANSFORM_OT_translate, (optional)) Translate, Translate selected items [Link].group_edit() Edit node group [Link].group_make() Make group from selected nodes [Link].group_socket_add(in_out=SOCK_IN, name=, type=VALUE) Add node group socket Parameters in_out (enum in [SOCK_IN, SOCK_OUT], (optional)) Socket Type, Input or Output name (string, (optional)) Name, Group socket name type (enum in [VALUE, VECTOR, RGBA], (optional)) Type, Type of the group socket [Link].group_socket_move_down(index=0, in_out=SOCK_IN) Move down node group socket Parameters index (int in [0, inf], (optional)) Index in_out (enum in [SOCK_IN, SOCK_OUT], (optional)) Socket Type, Input or Output [Link].group_socket_move_up(index=0, in_out=SOCK_IN) Move up node group socket Parameters index (int in [0, inf], (optional)) Index in_out (enum in [SOCK_IN, SOCK_OUT], (optional)) Socket Type, Input or Output [Link].group_socket_remove(index=0, in_out=SOCK_IN) Removed node group socket Parameters index (int in [0, inf], (optional)) Index TRANS-

2.3. Operators ([Link])

Blender Index, Release 2.59.2 - API

in_out (enum in [SOCK_IN, SOCK_OUT], (optional)) Socket Type, Input or Output [Link].group_ungroup() Ungroup selected nodes [Link].hide_socket_toggle() Toggle unused node socket display [Link].hide_toggle() Toggle hiding of selected nodes [Link]() Undocumented (contribute) [Link].link_make(replace=False) Makes a link between selected output in input sockets Parameters replace (boolean, (optional)) Replace, Replace socket connections with the new links [Link].link_viewer() Link to Viewer Node [Link].links_cut(path=None, cursor=9) Undocumented (contribute) Parameters path (bpy_prop_collection of OperatorMousePath, (optional)) path cursor (int in [0, inf], (optional)) Cursor [Link].mute_toggle() Toggle muting of the nodes [Link].new_node_tree(type=COMPOSITING, name=NodeTree) Undocumented (contribute) Parameters type (enum in [MATERIAL, TEXTURE, COMPOSITING], (optional)) Tree Type MATERIAL Material, Material nodes. TEXTURE Texture, Texture nodes. COMPOSITING Compositing, Compositing nodes. name (string, (optional)) Name [Link].preview_toggle() Toggle preview display for selected nodes [Link]() Toggles the properties panel display [Link].read_fullsamplelayers() Undocumented (contribute) [Link].read_renderlayers() Undocumented (contribute) [Link].render_changed() Undocumented (contribute) [Link]() Undocumented (contribute)

100

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link](mouse_x=0, mouse_y=0, extend=False) Select node under cursor Parameters mouse_x (int in [-inf, inf], (optional)) Mouse X mouse_y (int in [-inf, inf], (optional)) Mouse Y extend (boolean, (optional)) Extend [Link].select_all() (De)select all nodes [Link].select_border(gesture_mode=0, xmin=0, xmax=0, ymin=0, ymax=0, tweak=False) Use box selection to select nodes 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 tweak (boolean, (optional)) Tweak, Only activate when mouse is not over a node - useful for tweak gesture [Link].select_link_viewer(NODE_OT_select=None, NODE_OT_link_viewer=None) Undocumented (contribute) Parameters NODE_OT_select (NODE_OT_select, (optional)) Select, Select node under cursor NODE_OT_link_viewer (NODE_OT_link_viewer, (optional)) Link to Viewer Node, Link to Viewer Node [Link].select_linked_from() Select nodes linked from the selected ones [Link].select_linked_to() Select nodes linked to the selected ones [Link].select_same_type() Select all the same type [Link].select_same_type_next() Select the next node of the same type. [Link].select_same_type_prev() Select the prev node of the same type. [Link].show_cyclic_dependencies() Sort the nodes and show the cyclic dependencies between the nodes [Link].view_all() Resize view so you can see all nodes [Link].visibility_toggle(mouse_x=0, mouse_y=0) Handle clicks on node header buttons Parameters

2.3. Operators ([Link])

101

Blender Index, Release 2.59.2 - API

mouse_x (int in [-inf, inf], (optional)) Mouse X mouse_y (int in [-inf, inf], (optional)) Mouse Y Object Operators [Link](type=EMPTY, 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)) Add an object to the scene Parameters type (enum in [MESH, CURVE, SURFACE, META, FONT, ARMATURE, LATTICE, EMPTY, CAMERA, LAMP, SPEAKER], (optional)) Type 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 rotation (oat array of 3 items in [-inf, inf], (optional)) Rotation, Rotation for the newly added object layers (boolean array of 20 items, (optional)) Layer [Link].add_named(linked=False, name=Cube) Add named object Parameters linked (boolean, (optional)) Linked, Duplicate object but not object data, linking to the original data name (string, (optional)) Name, Object name to add [Link].add_named_cursor(name=Cube, VIEW3D_OT_cursor3d=None, JECT_OT_add_named=None) Undocumented (contribute) Parameters name (string, (optional)) Name, Object name to add. VIEW3D_OT_cursor3d (VIEW3D_OT_cursor3d, (optional)) Set 3D Cursor, Set the location of the 3D cursor OBJECT_OT_add_named (OBJECT_OT_add_named, (optional)) Add Named Object, Add named object [Link](bb_quality=True, align_axis=set()) Align Objects Parameters bb_quality (boolean, (optional)) High Quality, Enables high quality calculation of the bounding box for perfect results on complex shape meshes with rotation/scale (Slow) align_mode (enum in [OPT_1, OPT_2, OPT_3], (optional)) Align Mode: align_mode=OPT_2, relative_to=OPT_4, OB-

102

[Link].render_layer_add() Add a render layer [Link].render_layer_remove() Remove the selected render layer Screen Operators [Link](modier=0) Handle area action zones for mouse actions/gestures Parameters modier (int in [0, 2], (optional)) modier, modier state [Link].animation_cancel(restore_frame=True) Cancel animation, returning to the original frame Parameters restore_frame (boolean, (optional)) Restore Frame, Restore the frame when animation was initialized. [Link].animation_play(reverse=False, sync=False) Play animation Parameters reverse (boolean, (optional)) Play in Reverse, Animation is played backwards sync (boolean, (optional)) Sync, Drop frames to maintain framerate [Link].animation_step() Step through animation by position [Link].area_dupli() Duplicate selected area into new window [Link].area_join(min_x=-100, min_y=-100, max_x=-100, max_y=-100) Join selected areas into new window Parameters min_x (int in [-inf, inf], (optional)) X 1 min_y (int in [-inf, inf], (optional)) Y 1 max_x (int in [-inf, inf], (optional)) X 2 max_y (int in [-inf, inf], (optional)) Y 2 [Link].area_move(x=0, y=0, delta=0) Move selected area edges Parameters x (int in [-inf, inf], (optional)) X y (int in [-inf, inf], (optional)) Y delta (int in [-inf, inf], (optional)) Delta [Link].area_options() Operations for splitting and merging [Link].area_split(direction=HORIZONTAL, factor=0.5, mouse_x=-100, mouse_y=100) Split selected area into new windows

2.3. Operators ([Link])

135

Blender Index, Release 2.59.2 - API

Parameters direction (enum in [HORIZONTAL, VERTICAL], (optional)) Direction factor (oat in [0, 1], (optional)) Factor mouse_x (int in [-inf, inf], (optional)) Mouse X mouse_y (int in [-inf, inf], (optional)) Mouse Y [Link].area_swap() Swap selected areas screen positions [Link].back_to_previous() Revert back to the original screen layout, before fullscreen area overlay [Link]() Delete active screen [Link].frame_jump(end=False) Jump to rst/last frame in frame range Parameters end (boolean, (optional)) Last Frame, Jump to the last frame of the frame range. [Link].frame_offset(delta=0) Undocumented (contribute) Parameters delta (int in [-inf, inf], (optional)) Delta [Link].header_flip() Undocumented (contribute) [Link].header_toolbox() Display header region toolbox [Link].keyframe_jump(next=True) Jump to previous/next keyframe Parameters next (boolean, (optional)) Next Keyframe [Link]() Add a new screen [Link].redo_last() Display menu for last action performed [Link].region_flip() Undocumented (contribute) [Link].region_quadview() Split selected area into camera, front, right & top views [Link].region_scale() Scale selected area [Link].repeat_history(index=0) Display menu for previous actions performed Parameters index (int in [0, inf], (optional)) Index [Link].repeat_last() Repeat last action [Link].screen_full_area() Toggle display selected area as fullscreen

136

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link].screen_set(delta=0) Cycle through available screens Parameters delta (int in [-inf, inf], (optional)) Delta [Link](lepath=, full=True) Undocumented (contribute) Parameters lepath (string, (optional)) lepath full (boolean, (optional)) Full Screen [Link](lepath=, check_existing=True, lter_blender=False, lter_image=True, 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=9, full=True) Undocumented (contribute) 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 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 full (boolean, (optional)) Full Screen [Link].spacedata_cleanup() Remove unused settings for invisible editors [Link].userpref_show() Show/hide user preferences Script Operators [Link].execute_preset(lepath=, menu_idname=) Executes a preset Parameters lepath (string, (optional)) Path, Path of the Python le to execute 2.3. Operators ([Link]) 137

Blender Index, Release 2.59.2 - API

menu_idname (string, (optional)) Menu ID Name, ID name of the menu this was called from File startup/bl_operators/[Link] [Link].python_file_run(lepath=) Run Python le Parameters lepath (string, (optional)) Path [Link]() Reload Scripts Sculpt Operators [Link].brush_stroke(stroke=None, mode=NORMAL, ignore_background_click=False) Undocumented (contribute) Parameters stroke (bpy_prop_collection of OperatorStrokeElement, (optional)) Stroke mode (enum in [NORMAL, INVERT, SMOOTH], (optional)) Sculpt Stroke Mode, Action taken when a sculpt stroke is made NORMAL Normal, Apply brush normally. INVERT Invert, Invert action of brush for duration of stroke. SMOOTH Smooth, Switch brush to smooth mode for duration of stroke. ignore_background_click (boolean, (optional)) Ignore Background Click, Clicks on the background do not start the stroke [Link].sculptmode_toggle() Undocumented (contribute) [Link].set_persistent_base() Undocumented (contribute) Sequencer Operators [Link].change_effect_input(swap=A_B) Undocumented (contribute) Parameters swap (enum in [A_B, B_C, A_C], (optional)) Swap, The effect inputs to swap [Link].change_effect_type(type=CROSS) Undocumented (contribute) Parameters type (enum in [CROSS, ADD, SUBTRACT, ALPHA_OVER, ALPHA_UNDER, GAMMA_CROSS, MULTIPLY, OVER_DROP, PLUGIN, WIPE, GLOW, TRANSFORM, COLOR, SPEED, MULTICAM, ADJUSTMENT], (optional)) Type, Sequencer effect type CROSS Crossfade, Crossfade effect strip type. ADD Add, Add effect strip type. SUBTRACT Subtract, Subtract effect strip type. ALPHA_OVER Alpha Over, Alpha Over effect strip type. 138 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

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. [Link](side=RIGHT) Swap active strip with strip to the left Parameters side (enum in [LEFT, RIGHT], (optional)) Side, Side of the strip to swap [Link].swap_data() Swap 2 sequencer strips [Link].swap_inputs() Swap the rst two inputs for the effects strip [Link]() Unlock the active strip so that it cant be transformed [Link](unselected=False) Un-Mute unselected rather than selected strips Parameters unselected (boolean, (optional)) Unselected, UnMute unselected rather than selected strips. [Link].view_all() View all the strips in the sequencer [Link].view_all_preview() Zoom preview to t in the area [Link].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 [Link].view_selected() Zoom the sequencer on the selected strips [Link].view_toggle() Toggle between sequencer views (sequence, preview, both) [Link].view_zoom_ratio(ratio=1.0) Change zoom ratio of sequencer preview

146

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

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 rotation (oat array of 3 items in [-inf, inf], (optional)) Rotation, Rotation for the newly added object layers (boolean array of 20 items, (optional)) Layer [Link].primitive_nurbs_surface_torus_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 Torus 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 rotation (oat array of 3 items in [-inf, inf], (optional)) Rotation, Rotation for the newly added object layers (boolean array of 20 items, (optional)) Layer Text Operators [Link]() Convert selected text to comment [Link].convert_whitespace(type=SPACES) Convert whitespaces by type Parameters type (enum in [SPACES, TABS], (optional)) type, Type of whitespace to convert to. [Link]() Copy selected text to clipboard [Link].cursor_set(x=0, y=0) Set cursor position Parameters x (int in [-inf, inf], (optional)) X y (int in [-inf, inf], (optional)) Y

152

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link]() Cut selected text to clipboard [Link](type=NEXT_CHARACTER) Delete text by cursor position Parameters type (enum in [NEXT_CHARACTER, PREVIOUS_CHARACTER, NEXT_WORD, PREVIOUS_WORD], (optional)) Type, Which part of the text to delete. [Link]() Find specied text [Link].find_set_selected() Find specied text and set as selected [Link]() Indent selected text [Link](text=) Insert text at cursor position Parameters text (string, (optional)) Text, Text to insert at the cursor position. [Link](line=1) Jump cursor to line Parameters line (int in [1, inf], (optional)) Line, Line number to jump to. [Link].line_break() Insert line break at cursor position [Link].line_number() The current line number [Link].make_internal() Make active text le internal [Link].mark_all() Mark all specied text [Link].markers_clear() Clear all markers [Link](type=LINE_BEGIN) Move cursor to position type Parameters type (enum in [LINE_BEGIN, LINE_END, FILE_TOP, FILE_BOTTOM, PREVIOUS_CHARACTER, NEXT_CHARACTER, PREVIOUS_WORD, NEXT_WORD, PREVIOUS_LINE, NEXT_LINE, PREVIOUS_PAGE, NEXT_PAGE], (optional)) Type, Where to move cursor to. [Link].move_select(type=LINE_BEGIN) Make selection from current cursor position to new cursor position type Parameters type (enum in [LINE_BEGIN, LINE_END, FILE_TOP, FILE_BOTTOM, 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. [Link]() Create a new text data block [Link].next_marker() Move to next marker

2.3. Operators ([Link])

153

Blender Index, Release 2.59.2 - API

[Link](lepath=, lter_blender=False, lter_image=False, lter_movie=False, lter_python=True, lter_font=False, lter_sound=False, lter_text=True, lter_btx=False, lter_collada=False, lter_folder=True, lemode=9, internal=False) Open a new text data block 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 internal (boolean, (optional)) Make internal, Make text le internal after loading [Link].overwrite_toggle() Toggle overwrite while typing [Link](selection=False) Paste text from clipboard Parameters selection (boolean, (optional)) Selection, Paste text selected elsewhere rather than copied, X11 only. [Link].previous_marker() Move to previous marker [Link]() Toggle text properties panel [Link].refresh_pyconstraints() Refresh all pyconstraints [Link]() Reload active text data block from its le [Link]() Replace text with the specied text [Link].replace_set_selected() Replace text with specied text and set as selected [Link].resolve_conflict(resolution=IGNORE) When external text is out of sync, resolve the conict Parameters resolution (enum in [IGNORE, RELOAD, SAVE, MAKE_INTERNAL], (optional)) Resolution, How to solve conict due to different in internal and external text. 154 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link].run_script() Run active script [Link]() Save active text data block [Link].save_as(lepath=, check_existing=True, lter_blender=False, lter_image=False, lter_movie=False, lter_python=True, lter_font=False, lter_sound=False, lter_text=True, lter_btx=False, lter_collada=False, lter_folder=True, lemode=9) Save active text le with options 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 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 [Link](lines=1) Scroll text screen Parameters lines (int in [-inf, inf], (optional)) Lines, Number of lines to scroll. [Link].scroll_bar(lines=1) Scroll text screen Parameters lines (int in [-inf, inf], (optional)) Lines, Number of lines to scroll. [Link].select_all() Select all text [Link].select_line() Select text by line [Link].select_word() Select word under cursor [Link].selection_set(select=False) Set cursor selection Parameters select (boolean, (optional)) Select, Set selection end rather than cursor.

2.3. Operators ([Link])

155

Blender Index, Release 2.59.2 - API

[Link].to_3d_object(split_lines=False) Create 3d text object from active text data block Parameters split_lines (boolean, (optional)) Split Lines, Create one object per line in the text. [Link]() Convert selected comment to text [Link]() Unindent selected text [Link]() Unlink active text data block Texture Operators [Link].envmap_clear() Discard the environment map and free it from memory [Link].envmap_clear_all() Discard all environment maps in the .blend le and free them from memory [Link].envmap_save(layout=(0.0, 0.0, 1.0, 0.0, 2.0, 0.0, 0.0, 1.0, 1.0, 1.0, 2.0, 1.0), lepath=, check_existing=True, lter_blender=False, lter_image=True, lter_movie=True, lter_python=False, lter_font=False, lter_sound=False, lter_text=False, lter_btx=False, lter_collada=False, lter_folder=True, lemode=9) Save the current generated Environment map to an image le Parameters layout (oat array of 12 items in [-inf, inf], (optional)) File layout, Flat array describing the X,Y position of each cube face in the output image, where 1 is the size of a face. Order is [+Z -Z +Y -X -Y +X]. Use -1 to skip a face. 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 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

156

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link]() Add a new texture [Link].slot_copy() Copy the material texture settings and nodes [Link].slot_move(type=UP) Move texture slots up and down Parameters type (enum in [UP, DOWN], (optional)) Type [Link].slot_paste() Copy the texture settings and nodes Time Operators [Link].end_frame_set() Set the end frame [Link].start_frame_set() Set the start frame [Link].view_all() Show the entire playable frame range Transform Operators [Link].create_orientation(name=, use=False, overwrite=False) Create transformation orientation from selection Parameters name (string, (optional)) Name, Text to insert at the cursor position. use (boolean, (optional)) Use after creation, Select orientation after its creation overwrite (boolean, (optional)) Overwrite previous, Overwrite previously created orientation with same name [Link].delete_orientation() Delete transformation orientation [Link].edge_crease(value=0.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) Change the crease of edges Parameters value (oat in [-1, 1], (optional)) Factor 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. 2.3. Operators ([Link]) 157

Blender Index, Release 2.59.2 - API

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 [Link].edge_slide(value=0.0, mirror=False, snap=False, snap_target=CLOSEST, snap_point=(0.0, 0.0, 0.0), snap_align=False, snap_normal=(0.0, 0.0, 0.0), correct_uv=False, release_conrm=False) Slide an edge loop along a mesh Parameters value (oat in [-1, 1], (optional)) Factor mirror (boolean, (optional)) Mirror Editing 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 correct_uv (boolean, (optional)) Correct UV coords when transforming release_conrm (boolean, (optional)) Conrm on Release, Always conrm operation when releasing button [Link](constraint_axis=(False, False, False), constraint_orientation=, proportional=DISABLED, proportional_edit_falloff=SMOOTH, proportional_size=1.0, release_conrm=False) Mirror selected vertices around one or more axes Parameters constraint_axis (boolean array of 3 items, (optional)) Constraint Axis constraint_orientation (enum in [], (optional)) Orientation, Transformation orientation 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.

158

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

SMOOTH Smooth, Smooth falloff. SPHERE Sphere, Spherical falloff. ROOT Root, Root falloff. SHARP Sharp, Sharp falloff. LINEAR Linear, Linear falloff. CONSTANT Constant, Consant falloff. RANDOM Random, Random falloff. proportional_size (oat in [1e-05, inf], (optional)) Proportional Size release_conrm (boolean, (optional)) Conrm on Release, Always conrm operation when releasing button [Link].push_pull(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) Push/Pull selected items Parameters value (oat in [-inf, inf], (optional)) Distance 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. LINEAR Linear, Linear falloff. CONSTANT Constant, Consant 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. 2.3. Operators ([Link]) 159

Blender Index, Release 2.59.2 - API

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 [Link](value=(1.0, 1.0, 1.0), constraint_axis=(False, False, False), constraint_orientation=, 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), texture_space=False, release_conrm=False) Resize selected items Parameters value (oat array of 3 items in [-inf, inf], (optional)) Vector constraint_axis (boolean array of 3 items, (optional)) Constraint Axis constraint_orientation (enum in [], (optional)) Orientation, Transformation orientation 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. LINEAR Linear, Linear falloff. CONSTANT Constant, Consant 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.

160

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

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 [Link](value=(0.0), axis=(0.0, 0.0, 0.0), constraint_axis=(False, False, False), constraint_orientation=, 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) Rotate selected items Parameters value (oat array of 1 items in [-inf, inf], (optional)) Angle axis (oat array of 3 items in [-inf, inf], (optional)) Axis, The axis around which the transformation occurs constraint_axis (boolean array of 3 items, (optional)) Constraint Axis constraint_orientation (enum in [], (optional)) Orientation, Transformation orientation 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. LINEAR Linear, Linear falloff. CONSTANT Constant, Consant 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

2.3. Operators ([Link])

161

Blender Index, Release 2.59.2 - API

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 [Link].select_orientation(orientation=) Select transformation orientation Parameters orientation (enum in [], (optional)) Orientation, Transformation orientation [Link].seq_slide(value=(1.0, 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) Slide a sequence strip in time Parameters value (oat array of 2 items in [-inf, inf], (optional)) angle 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 [Link](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) Shear selected items along the horizontal screen axis Parameters value (oat in [-inf, inf], (optional)) Offset mirror (boolean, (optional)) Mirror Editing proportional (enum in [DISABLED, ENABLED, CONNECTED], (optional)) Proportional Editing

162

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

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. LINEAR Linear, Linear falloff. CONSTANT Constant, Consant 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 [Link].shrink_fatten(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) Shrink/fatten selected vertices along normals Parameters value (oat in [-inf, inf], (optional)) Offset 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. 2.3. Operators ([Link]) 163

Blender Index, Release 2.59.2 - API

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. LINEAR Linear, Linear falloff. CONSTANT Constant, Consant 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 [Link].snap_type(type=INCREMENT) Set the snap element type Parameters type (enum in [INCREMENT, VERTEX, EDGE, FACE, VOLUME], (optional)) Type, Set the snap element type INCREMENT Increment, Snap to increments of grid. VERTEX Vertex, Snap to vertices. EDGE Edge, Snap to edges. FACE Face, Snap to faces. VOLUME Volume, Snap to volume. [Link](value=(0.0), constraint_axis=(False, False, False), constraint_orientation=, 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) Tilt selected control vertices of 3d curve Parameters value (oat array of 1 items in [-inf, inf], (optional)) Angle

164

Parameters target (enum in [PIXELS, SELECTED], (optional)) Target, Target to snap the selected UVs to. [Link].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. [Link].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. 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_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. 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. [Link](use_limit=True, limit=0.01) Stitch selected UV vertices by proximity Parameters use_limit (boolean, (optional)) Use Limit, Stitch UVs within a specied limit distance. limit (oat in [0, inf], (optional)) Limit, Limit distance in normalized coordinates. [Link].tile_set(tile=(0, 0)) Set UV image tile coordinates Parameters tile (int array of 2 items in [0, inf], (optional)) Tile, Tile coordinate. [Link].unlink_selected() Unlink selected UV vertices from active UV map [Link](method=ANGLE_BASED, ll_holes=True, correct_aspect=True) Unwrap the mesh of the object being edited Parameters method (enum in [ANGLE_BASED, CONFORMAL], (optional)) Method, Unwrapping method. Angle Based usually gives better results than Conformal, while being somewhat slower.

176

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Parameters type (enum in [ORBITLEFT, ORBITRIGHT, ORBITUP, ORBITDOWN], (optional)) Orbit, Direction of View Orbit ORBITLEFT Orbit Left, Orbit the view around to the Left. ORBITRIGHT Orbit Right, Orbit the view around to the Right. ORBITUP Orbit Up, Orbit the view Up. ORBITDOWN Orbit Down, Orbit the view Down. [Link].view3d.view_pan(type=PANLEFT) Pan the view Parameters type (enum in [PANLEFT, PANRIGHT, PANUP, PANDOWN], (optional)) Pan, Direction of View Pan PANLEFT Pan Left, Pan the view to the Left. PANRIGHT Pan Right, Pan the view to the Right. PANUP Pan Up, Pan the view Up. PANDOWN Pan Down, Pan the view Down. [Link].view3d.view_persportho() Switch the current view from perspective/orthographic [Link].view3d.view_selected() Move the view to the selection center [Link](type=FRONT, align_active=False) Set the view Parameters type (enum in [FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM, CAMERA], (optional)) View, The Type of view FRONT Front, View From the Front. BACK Back, View From the Back. LEFT Left, View From the Left. RIGHT Right, View From the Right. TOP Top, View From the Top. BOTTOM Bottom, View From the Bottom. CAMERA Camera, View From the active amera. align_active (boolean, (optional)) Align Active, Align to the active objects axis [Link](delta=0, mx=0, my=0) Zoom in/out in the view Parameters delta (int in [-inf, inf], (optional)) Delta mx (int in [0, inf], (optional)) Zoom Position X my (int in [0, inf], (optional)) Zoom Position Y [Link].view3d.zoom_border(xmin=0, xmax=0, ymin=0, ymax=0) Zoom in the view to the nearest object contained in the border

182

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Parameters 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 [Link].view3d.zoom_camera_1_to_1() Match the camera to 1:1 to the render output Wm Operators [Link].addon_disable(module=) Disable an addon Parameters module (string, (optional)) Module, Module name of the addon to disable File startup/bl_ui/space_userpref.py:1125 [Link].addon_enable(module=) Enable an addon Parameters module (string, (optional)) Module, Module name of the addon to enable File startup/bl_ui/space_userpref.py:1096 [Link].addon_expand(module=) Display more information on this add-on Parameters module (string, (optional)) Module, Module name of the addon to expand File startup/bl_ui/space_userpref.py:1356 [Link].addon_install(overwrite=True, target=DEFAULT, lepath=, lter_folder=True, lter_python=True, lter_glob=*.py;*.zip) Install an addon Parameters overwrite (boolean, (optional)) Overwrite, Remove existing addons with the same ID target (enum in [DEFAULT, PREFS], (optional)) Target Path lepath (string, (optional)) File Path, File path to write le to lter_folder (boolean, (optional)) Filter folders lter_python (boolean, (optional)) Filter python File startup/bl_ui/space_userpref.py:1178 [Link].addon_remove(module=) Disable an addon Parameters module (string, (optional)) Module, Module name of the addon to remove File startup/bl_ui/space_userpref.py:1317 [Link].appconfig_activate(lepath=) Undocumented (contribute) Parameters lepath (string, (optional)) File Path File startup/bl_operators/[Link] 2.3. Operators ([Link]) 183

Blender Index, Release 2.59.2 - API

[Link].appconfig_default() Undocumented (contribute) File startup/bl_operators/[Link] [Link].call_menu(name=) Undocumented (contribute) Parameters name (string, (optional)) Name, Name of the menu [Link].collada_export(lepath=, check_existing=True, lter_blender=False, lter_image=False, lter_movie=False, lter_python=False, lter_font=False, lter_sound=False, lter_text=False, lter_btx=False, lter_collada=True, lter_folder=True, lemode=8, selected=False) Undocumented (contribute) 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 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 selected (boolean, (optional)) Export only selected, Export only selected elements [Link].collada_import(lepath=, lter_blender=False, lter_image=False, ter_movie=False, lter_python=False, lter_font=False, ter_sound=False, lter_text=False, lter_btx=False, ter_collada=True, lter_folder=True, lemode=8) 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 lll-

184

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - 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 [Link].context_collection_boolean_set(data_path_iter=, type=TOGGLE) Set boolean values for a collection of items Parameters data_path_iter (string, (optional)) The data path relative to the context, must point to an iterable. data_path_item (string, (optional)) The data path from each iterable to the value (int or oat) type (enum in [TOGGLE, ENABLE, DISABLE], (optional)) Type File startup/bl_operators/[Link] [Link].context_cycle_array(data_path=, reverse=False) Set a context array value. Useful for cycling the active mesh edit mode. Parameters data_path (string, (optional)) Context Attributes, rna context string reverse (boolean, (optional)) Reverse, Cycle backwards File startup/bl_operators/[Link] [Link].context_cycle_enum(data_path=, reverse=False) Toggle a context value. Parameters data_path (string, (optional)) Context Attributes, rna context string reverse (boolean, (optional)) Reverse, Cycle backwards File startup/bl_operators/[Link] [Link].context_cycle_int(data_path=, reverse=False) Set a context value. Useful for cycling active material, Parameters data_path (string, (optional)) Context Attributes, rna context string reverse (boolean, (optional)) Reverse, Cycle backwards File startup/bl_operators/[Link] [Link].context_menu_enum(data_path=) Undocumented (contribute) Parameters data_path (string, (optional)) Context Attributes, rna context string data_path_item=,

2.3. Operators ([Link])

185

Blender Index, Release 2.59.2 - API

File startup/bl_operators/[Link] [Link].context_modal_mouse(data_path_iter=, data_path_item=, input_scale=0.01, invert=False, initial_x=0) Adjust arbitrary values with mouse input Parameters data_path_iter (string, (optional)) The data path relative to the context, must point to an iterable. data_path_item (string, (optional)) The data path from each iterable to the value (int or oat) input_scale (oat in [-inf, inf], (optional)) Scale the mouse movement by this value before applying the delta invert (boolean, (optional)) Invert the mouse input File startup/bl_operators/[Link] [Link].context_scale_int(data_path=, value=1.0, always_step=True) Scale an int context value. Parameters data_path (string, (optional)) Context Attributes, rna context string value (oat in [-inf, inf], (optional)) Value, Assign value always_step (boolean, (optional)) Always Step, Always adjust the value by a minimum of 1 when value is not 1.0. File startup/bl_operators/[Link] [Link].context_set_boolean(data_path=, value=True) Set a context value. Parameters data_path (string, (optional)) Context Attributes, rna context string value (boolean, (optional)) Value, Assignment value File startup/bl_operators/[Link] [Link].context_set_enum(data_path=, value=) Set a context value. Parameters data_path (string, (optional)) Context Attributes, rna context string value (string, (optional)) Value, Assignment value (as a string) File startup/bl_operators/[Link] [Link].context_set_float(data_path=, value=0.0, relative=False) Set a context value. Parameters data_path (string, (optional)) Context Attributes, rna context string value (oat in [-inf, inf], (optional)) Value, Assignment value relative (boolean, (optional)) Relative, Apply relative to the current value (delta) File startup/bl_operators/[Link] 186 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link].context_set_id(data_path=, value=) Toggle a context value. Parameters data_path (string, (optional)) Context Attributes, rna context string value (string, (optional)) Value, Assign value File startup/bl_operators/[Link] [Link].context_set_int(data_path=, value=0, relative=False) Set a context value. Parameters data_path (string, (optional)) Context Attributes, rna context string value (int in [-inf, inf], (optional)) Value, Assign value relative (boolean, (optional)) Relative, Apply relative to the current value (delta) File startup/bl_operators/[Link] [Link].context_set_string(data_path=, value=) Set a context value. Parameters data_path (string, (optional)) Context Attributes, rna context string value (string, (optional)) Value, Assign value File startup/bl_operators/[Link] [Link].context_set_value(data_path=, value=) Set a context value. Parameters data_path (string, (optional)) Context Attributes, rna context string value (string, (optional)) Value, Assignment value (as a string) File startup/bl_operators/[Link] [Link].context_toggle(data_path=) Toggle a context value. Parameters data_path (string, (optional)) Context Attributes, rna context string File startup/bl_operators/[Link] [Link].context_toggle_enum(data_path=, value_1=, value_2=) Toggle a context value. Parameters data_path (string, (optional)) Context Attributes, rna context string value_1 (string, (optional)) Value, Toggle enum value_2 (string, (optional)) Value, Toggle enum File startup/bl_operators/[Link] [Link].copy_prev_settings() Copy settings from previous version

2.3. Operators ([Link])

187

Blender Index, Release 2.59.2 - API

File startup/bl_operators/[Link] [Link].debug_menu(debug_value=0) Open a popup to set the debug level Parameters debug_value (int in [-10000, 10000], (optional)) Debug Value [Link].doc_edit(doc_id=, doc_new=) Load online reference docs Parameters doc_id (string, (optional)) Doc ID doc_new (string, (optional)) Edit Description File startup/bl_operators/[Link] [Link].doc_view(doc_id=) Load online reference docs Parameters doc_id (string, (optional)) Doc ID File startup/bl_operators/[Link] [Link].interaction_preset_add(name=, remove_active=False) Add an Application Interaction Preset Parameters name (string, (optional)) Name, Name of the preset, used to make the path name File startup/bl_operators/[Link] [Link].keyconfig_activate(lepath=) Undocumented (contribute) Parameters lepath (string, (optional)) File Path File startup/bl_operators/[Link] [Link].keyconfig_export(lepath=[Link], ter_python=True) Export key conguration to a python script Parameters lepath (string, (optional)) File Path, Filepath to write le to lter_folder (boolean, (optional)) Filter folders lter_text (boolean, (optional)) Filter text lter_python (boolean, (optional)) Filter python File startup/bl_ui/space_userpref_keymap.py:623 [Link].keyconfig_import(lepath=[Link], lter_folder=True, ter_python=True, keep_original=True) Import key conguration from a python script Parameters lepath (string, (optional)) File Path, Filepath to write le to lter_folder (boolean, (optional)) Filter folders lter_text (boolean, (optional)) Filter text lter_python (boolean, (optional)) Filter python lter_text=True, llter_folder=True, lter_text=True, l-

188

Parameters url (string, (optional)) URL, URL to open File startup/bl_operators/[Link] [Link].window_duplicate() Duplicate the current Blender window [Link].window_fullscreen_toggle() Toggle the current window fullscreen World Operators [Link]() Add a new world

2.4 Types ([Link])

2.4.1 Action(ID)
base classes bpy_struct, ID class [Link](ID) A collection of F-Curves for animation fcurves The individual F-Curves that make up the Action Type ActionFCurves bpy_prop_collection of FCurve, (readonly) frame_range The nal frame range of all fcurves within this action Type oat array of 2 items in [-inf, inf], default (0.0, 0.0), (readonly) groups Convenient groupings of F-Curves Type ActionGroups bpy_prop_collection of ActionGroup, (readonly) id_root Type of ID-block that action can be used on. DO NOT CHANGE UNLESS YOU KNOW WHAT YOURE DOING Type enum in [ACTION, ARMATURE, BRUSH, CAMERA, CURVE, FONT, GREASEPENCIL, GROUP, IMAGE, KEY, LAMP, LIBRARY, LATTICE, MATERIAL, META, MESH, NODETREE, OBJECT, PARTICLE, SCENE, SCREEN, SPEAKER, SOUND, TEXT, TEXTURE, WORLD, WINDOWMANAGER], default ACTION pose_markers Markers specic to this Action, for labeling poses Type ActionPoseMarkers bpy_prop_collection of TimelineMarker, (readonly)

2.4. Types ([Link])

195

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values [Link] ID.user_clear ID.animation_data_create ID.animation_data_clear ID.update_tag

References

[Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] Object.pose_library [Link] [Link]

2.4.2 ActionActuator(Actuator)
base classes bpy_struct, Actuator

196

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

class [Link](Actuator) Actuator to control the object movement action Type Action apply_to_children Update Action on all children Objects as well Type boolean, default False frame_blend_in Number of frames of motion blending Type int in [0, 32767], default 0 frame_end Type oat in [-inf, inf], default 0.0 frame_property Assign the actions current frame number to this property Type string, default frame_start Type oat in [-inf, inf], default 0.0 layer The animation layer to play the action on Type int in [0, 7], default 0 layer_weight How much of the previous layer to blend into this one (0 = add mode) Type oat in [0, 1], default 0.0 play_mode Action playback type Type enum in [PLAY, PINGPONG, FLIPPER, LOOPSTOP, LOOPEND, PROPERTY], default PLAY priority Execution priority - lower numbers will override actions with higher numbers. With 2 or more actions at once, the overriding channels must be lower in the stack Type int in [0, 100], default 0 property Use this property to dene the Action position Type string, default use_additive Action is added to the current loc/rot/scale in global or local coordinate according to Local ag Type boolean, default False use_continue_last_frame Restore last frame when switching on/off, otherwise play from the start each time Type boolean, default False

2.4. Types ([Link])

197

Blender Index, Release 2.59.2 - API

use_force Apply Action as a global or local force depending on the local option (dynamic objects only) Type boolean, default False use_local Let the Action act in local coordinates, used in Force and Add mode Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] Actuator.show_expanded [Link] [Link]

Inherited Functions

2.4.3 ActionConstraint(Constraint)
base classes bpy_struct, Constraint class [Link](Constraint) Map an action to the transform axes of a bone action The constraining action Type Action frame_end Last frame of the Action to use Type int in [-300000, 300000], default 0

198

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

frame_start First frame of the Action to use Type int in [-300000, 300000], default 0 max Maximum value for target channel range Type oat in [-1000, 1000], default 0.0 min Minimum value for target channel range Type oat in [-1000, 1000], default 0.0 subtarget Type string, default target Target Object Type Object transform_channel Transformation channel from the target that is used to key the Action Type enum in [LOCATION_X, LOCATION_Y, LOCATION_Z, ROTATION_X, ROTATION_Y, ROTATION_Z, SCALE_X, SCALE_Y, SCALE_Z], default ROTATION_X
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] Constraint.show_expanded [Link] Constraint.error_location Constraint.owner_space Constraint.is_proxy_local Constraint.error_rotation Constraint.target_space [Link] Constraint.is_valid

Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.4 ActionFCurves(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of action fcurves new(data_path, index=0, action_group=) Add a keyframe to the curve. Parameters data_path (string) Data Path, FCurve data path to use. index (int in [0, inf], (optional)) Index, Array index. action_group (string, (optional)) Action Group, Acton group to add this fcurve into. Returns Newly created fcurve Return type FCurve remove(fcurve) Remove action group. Parameters fcurve (FCurve, (never None)) FCurve to remove.
Inherited Properties

bpy_struct.id_data
Inherited Functions

200

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.values
References

[Link]

2.4.5 ActionGroup(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Groups of F-Curves channels F-Curves in this group Type bpy_prop_collection of FCurve, (readonly) custom_color Index of custom color set Type int in [-inf, inf], default 0 lock Action Group is locked Type boolean, default False name Type string, default select Action Group is selected Type boolean, default False show_expanded Action Group is expanded Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

[Link] [Link] [Link] [Link]

[Link] [Link] [Link]

2.4.9 ActuatorSensor(Sensor)
base classes bpy_struct, Sensor class [Link](Sensor) Sensor to detect state modications of actuators actuator Actuator name, actuator active state modications will be detected Type string, default
Inherited Properties

bpy_struct.id_data [Link] Sensor.show_expanded [Link] [Link] Sensor.use_level [Link] Sensor.use_pulse_false_level Sensor.use_pulse_true_level Sensor.use_tap [Link]

2.4. Types ([Link])

205

Blender Index, Release 2.59.2 - API

Inherited Functions

2.4.10 Addon(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Python addons to be loaded automatically module Module name Type string, default
Inherited Properties

bpy_struct.id_data
Inherited Functions

206

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

[Link] [Link] [Link]

2.4.11 Addons(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of add-ons classmethod new() Add a new addon Returns Addon datablock. Return type Addon classmethod remove(addon) Remove addon. Parameters addon (Addon, (never None)) Addon to remove.
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

207

Blender Index, Release 2.59.2 - API

References

[Link]

2.4.12 AdjustmentSequence(Sequence)
base classes bpy_struct, Sequence class [Link](Sequence) Sequence strip to perform lter adjustments to layers below animation_offset_end Animation end offset (trim end) Type int in [0, inf], default 0 animation_offset_start Animation start offset (trim start) Type int in [0, inf], default 0 color_balance Type SequenceColorBalance, (readonly) color_multiply Type oat in [0, 20], default 0.0 color_saturation Type oat in [0, 20], default 0.0 crop Type SequenceCrop, (readonly) proxy Type SequenceProxy, (readonly) strobe Only display every nth frame Type oat in [1, 30], default 0.0 transform Type SequenceTransform, (readonly) use_color_balance (3-Way color correction) on input Type boolean, default False use_crop Crop image before processing Type boolean, default False use_deinterlace For video movies to remove elds Type boolean, default False

208

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

use_flip_x Flip on the X axis Type boolean, default False use_flip_y Flip on the Y axis Type boolean, default False use_float Convert input to oat data Type boolean, default False use_premultiply Convert RGB from key alpha to premultiplied alpha Type boolean, default False use_proxy Use a preview proxy and/or timecode index for this strip Type boolean, default False use_proxy_custom_directory Use a custom directory to store data Type boolean, default False use_proxy_custom_file Use a custom le to read proxy data from Type boolean, default False use_reverse_frames Reverse frame order Type boolean, default False use_translation Translate image before processing Type boolean, default False
Inherited Properties

2.4. Types ([Link])

209

Blender Index, Release 2.59.2 - API

Sequence.frame_final_duration Sequence.frame_duration [Link] [Link] Sequence.select_right_handle [Link] Sequence.speed_factor Sequence.frame_start Sequence.frame_final_start Sequence.frame_offset_start Sequence.frame_still_start [Link] Sequence.use_default_fade Sequence.input_count

Inherited Functions

2.4.13 AlwaysSensor(Sensor)
base classes bpy_struct, Sensor class [Link](Sensor) Sensor to generate continuous pulses
Inherited Properties

210

bpy_struct.id_data [Link] Sensor.show_expanded [Link] [Link] Sensor.use_level [Link] Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Sensor.use_pulse_false_level Sensor.use_pulse_true_level Sensor.use_tap [Link]

Inherited Functions

2.4.14 AndController(Controller)
base classes bpy_struct, Controller class [Link](Controller) Controller passing on events based on a logical AND operation
Inherited Properties

bpy_struct.id_data [Link] [Link] Controller.show_expanded Controller.use_priority [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden 211

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values [Link] [Link]

2.4.15 AnimData(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Animation data for datablock action Active Action for this datablock Type Action action_blend_type Method used for combining Active Actions result with result of NLA stack REPLACE Replace, Result strip replaces the accumulated results by amount specied by inuence. ADD Add, Weighted result of strip is added to the accumulated results. SUBTRACT Subtract, Weighted result of strip is removed from the accumulated results. MULITPLY Multiply, Weighted result of strip is multiplied with the accumulated results. Type enum in [REPLACE, ADD, SUBTRACT, MULITPLY], default REPLACE action_extrapolation Action to take for gaps past the Active Actions range (when evaluating with NLA) NOTHING Nothing, Strip has no inuence past its extents. HOLD Hold, Hold the rst frame if no previous strips in track, and always hold last frame. HOLD_FORWARD Hold Forward, Only hold last frame. Type enum in [NOTHING, HOLD, HOLD_FORWARD], default HOLD action_influence Amount the Active Action contributes to the result of the NLA stack Type oat in [0, 1], default 1.0 drivers The Drivers/Expressions for this datablock Type AnimDataDrivers bpy_prop_collection of FCurve, (readonly) nla_tracks NLA Tracks (i.e. Animation Layers)

212

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type NlaTracks bpy_prop_collection of NlaTrack, (readonly) use_nla NLA stack is evaluated when evaluating this block Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Armature.animation_data Camera.animation_data Curve.animation_data ID.animation_data_create Key.animation_data Lamp.animation_data Lattice.animation_data Material.animation_data Mesh.animation_data MetaBall.animation_data NodeTree.animation_data Object.animation_data ParticleSettings.animation_data Scene.animation_data Speaker.animation_data Texture.animation_data World.animation_data

2.4. Types ([Link])

213

Blender Index, Release 2.59.2 - API

2.4.16 AnimDataDrivers(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of Driver F-Curves from_existing(src_driver=None) Add a new driver given an existing one Parameters src_driver (FCurve, (optional)) Existing Driver F-Curve to use as template for a new one Returns New Driver F-Curve. Return type FCurve
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.17 AnimViz(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Settings for the visualisation of motion motion_path Motion Path settings for visualisation

214

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type AnimVizMotionPaths, (readonly, never None) onion_skin_frames Onion Skinning (ghosting) settings for visualisation Type AnimVizOnionSkinning, (readonly, never None)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Object.animation_visualisation Pose.animation_visualisation

2.4.18 AnimVizMotionPaths(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Motion Path settings for animation visualisation bake_location When calculating Bone Paths, use Head or Tips HEADS Heads, Calculate bone paths from heads. TAILS Tails, Calculate bone paths from tails. Type enum in [HEADS, TAILS], default TAILS

2.4. Types ([Link])

215

Blender Index, Release 2.59.2 - API

frame_after Number of frames to show after the current frame (only for Around Current Frame Onion-skinning method) Type int in [1, 150000], default 0 frame_before Number of frames to show before the current frame (only for Around Current Frame Onion-skinning method) Type int in [1, 150000], default 0 frame_end End frame of range of paths to display/calculate (not for Around Current Frame Onion-skinning method) Type int in [-inf, inf], default 0 frame_start Starting frame of range of paths to display/calculate (not for Around Current Frame Onion-skinning method) Type int in [-inf, inf], default 0 frame_step Number of frames between paths shown (not for On Keyframes Onion-skinning method) Type int in [1, 100], default 0 show_frame_numbers Show frame numbers on Motion Paths Type boolean, default False show_keyframe_action_all For bone motion paths, search whole Action for keyframes instead of in group with matching name only (is slower) Type boolean, default False show_keyframe_highlight Emphasize position of keyframes on Motion Paths Type boolean, default False show_keyframe_numbers Show frame numbers of Keyframes on Motion Paths Type boolean, default False type Type of range to show for Motion Paths CURRENT_FRAME Around Frame, Display Paths of poses within a xed number of frames around the current frame. RANGE In Range, Display Paths of poses within specied range. Type enum in [CURRENT_FRAME, RANGE], default RANGE
Inherited Properties

bpy_struct.id_data

216

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Functions

References

AnimViz.motion_path

2.4.19 AnimVizOnionSkinning(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Onion Skinning settings for animation visualisation frame_after Number of frames to show after the current frame (only for Around Current Frame Onion-skinning method) Type int in [0, 30], default 0 frame_before Number of frames to show before the current frame (only for Around Current Frame Onion-skinning method) Type int in [0, 30], default 0 frame_end End frame of range of Ghosts to display (not for Around Current Frame Onion-skinning method) Type int in [-inf, inf], default 0 frame_start Starting frame of range of Ghosts to display (not for Around Current Frame Onion-skinning method) Type int in [-inf, inf], default 0 frame_step Number of frames between ghosts shown (not for On Keyframes Onion-skinning method) Type int in [1, 20], default 0

2.4. Types ([Link])

217

Blender Index, Release 2.59.2 - API

show_only_selected For Pose-Mode drawing, only draw ghosts for selected bones Type boolean, default False type Method used for determining what ghosts get drawn NONE No Ghosts, Do not show any ghosts. CURRENT_FRAME Around Current Frame, Show ghosts from around the current frame. RANGE In Range, Show ghosts for the specied frame range. KEYS On Keyframes, Show ghosts on keyframes. Type enum in [NONE, CURRENT_FRAME, RANGE, KEYS], default NONE
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

AnimViz.onion_skin_frames

2.4.20 AnyType(bpy_struct)
base class bpy_struct class [Link](bpy_struct) RNA type used for pointers to any possible data

218

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] UILayout.context_pointer_set [Link] UILayout.prop_enum UILayout.prop_menu_enum UILayout.prop_search UILayout.prop_search UILayout.props_enum UILayout.template_ID UILayout.template_ID_preview UILayout.template_any_ID UILayout.template_color_ramp UILayout.template_color_wheel UILayout.template_curve_mapping UILayout.template_histogram UILayout.template_image UILayout.template_layers UILayout.template_layers UILayout.template_list UILayout.template_list UILayout.template_path_builder UILayout.template_vectorscope UILayout.template_waveform

2.4. Types ([Link])

219

Blender Index, Release 2.59.2 - API

2.4.21 Area(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Area in a subdivided screen, containing an editor height Area height Type int in [0, 32767], default 0, (readonly) regions Regions this area is subdivided in Type bpy_prop_collection of Region, (readonly) show_menus Show menus in the header Type boolean, default False spaces Spaces contained in this area, the rst being the active space. NOTE: Useful for example to restore a previously used 3d view space in a certain area to get the old view orientation. Type AreaSpaces bpy_prop_collection of Space, (readonly) type Space type Type enum in [EMPTY, VIEW_3D, GRAPH_EDITOR, OUTLINER, PROPERTIES, FILE_BROWSER, IMAGE_EDITOR, INFO, SEQUENCE_EDITOR, TEXT_EDITOR, AUDIO_WINDOW, DOPESHEET_EDITOR, NLA_EDITOR, SCRIPTS_WINDOW, TIMELINE, NODE_EDITOR, LOGIC_EDITOR, CONSOLE, USER_PREFERENCES], default EMPTY width Area width Type int in [0, 32767], default 0, (readonly) tag_redraw() tag_redraw header_text_set(text=) Set the header text Parameters text (string, (optional)) Text, New string for the header, no argument clears the text.
Inherited Properties

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove

220

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

[Link] [Link]

2.4.22 AreaLamp(Lamp)
base classes bpy_struct, ID, Lamp class [Link](Lamp) Directional area lamp gamma Light gamma correction value Type oat in [-inf, inf], default 0.0 shadow_adaptive_threshold Threshold for Adaptive Sampling (Raytraced shadows) Type oat in [0, 1], default 0.0 shadow_color Color of shadows cast by the lamp Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) shadow_method Method to compute lamp shadow with NOSHADOW No Shadow. RAY_SHADOW Ray Shadow, Use ray tracing for shadow. Type enum in [NOSHADOW, RAY_SHADOW], default NOSHADOW shadow_ray_sample_method Method for generating shadow samples: Adaptive QMC is fastest, Constant QMC is less noisy but slower Type enum in [ADAPTIVE_QMC, CONSTANT_QMC, CONSTANT_JITTERED], default CONSTANT_JITTERED shadow_ray_samples_x Amount of samples taken extra (samples x samples)

2.4. Types ([Link])

221

Blender Index, Release 2.59.2 - API

Type int in [1, 64], default 0 shadow_ray_samples_y Amount of samples taken extra (samples x samples) Type int in [1, 64], default 0 shadow_soft_size Light size for ray shadow sampling (Raytraced shadows) Type oat in [-inf, inf], default 0.0 shape Shape of the area lamp Type enum in [SQUARE, RECTANGLE], default SQUARE size Size of the area of the area Lamp, X direction size for Rectangle shapes Type oat in [-inf, inf], default 0.0 size_y Size of the area of the area Lamp in the Y direction for Rectangle shapes Type oat in [-inf, inf], default 0.0 use_dither Use 2x2 dithering for sampling (Constant Jittered sampling) Type boolean, default False use_jitter Use noise for sampling (Constant Jittered sampling) Type boolean, default False use_only_shadow Causes light to cast shadows only without illuminating objects Type boolean, default False use_shadow_layer Causes only objects on the same layer to cast shadows Type boolean, default False use_umbra Emphasize parts that are fully shadowed (Constant Jittered sampling) Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link] Lamp.active_texture Lamp.active_texture_index Lamp.animation_data

222

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link] Lamp.use_diffuse [Link] [Link] Lamp.use_own_layer Lamp.use_negative Lamp.use_specular Lamp.texture_slots [Link]

Inherited Functions

2.4.23 AreaSpaces(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of spaces active Space currently being displayed in this area Type Space, (readonly)
Inherited Properties

bpy_struct.id_data

2.4. Types ([Link])

223

Blender Index, Release 2.59.2 - API

Inherited Functions

References

[Link]

2.4.24 Armature(ID)
base classes bpy_struct, ID class [Link](ID) Armature datablock containing a hierarchy of bones, usually used for rigging characters animation_data Animation data for this datablock Type AnimData, (readonly) bones Type ArmatureBones bpy_prop_collection of Bone, (readonly) draw_type OCTAHEDRAL Octahedral, Display bones as octahedral shape (default). STICK Stick, Display bones as simple 2D lines with dots. BBONE B-Bone, Display bones as boxes, showing subdivision and B-Splines. ENVELOPE Envelope, Display bones as extruded spheres, showing deformation inuence volume. WIRE Wire, Display bones as thin wires, showing subdivision and B-Splines. Type enum in [OCTAHEDRAL, STICK, BBONE, ENVELOPE, WIRE], default OCTAHEDRAL edit_bones Type ArmatureEditBones bpy_prop_collection of EditBone, (readonly)

224

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

ghost_frame_end End frame of range of Ghosts to display (not for Around Current Frame Onion-skinning method) Type int in [-inf, inf], default 0 ghost_frame_start Starting frame of range of Ghosts to display (not for Around Current Frame Onion-skinning method) Type int in [-inf, inf], default 0 ghost_size Frame step for Ghosts (not for On Keyframes Onion-skinning method) Type int in [1, 20], default 0 ghost_step Number of frame steps on either side of current frame to show as ghosts (only for Around Current Frame Onion-skinning method) Type int in [0, 30], default 0 ghost_type Method of Onion-skinning for active Action CURRENT_FRAME Around Frame, Display Ghosts of poses within a xed number of frames around the current frame. RANGE In Range, Display Ghosts of poses within specied range. KEYS On Keyframes, Display Ghosts of poses on Keyframes. Type enum in [CURRENT_FRAME, RANGE, KEYS], default CURRENT_FRAME layers Armature layer visibility Type boolean array of 32 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False) layers_protected Protected layers in Proxy Instances are restored to Proxy settings on le reload and undo Type boolean array of 32 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False) pose_position Show armature in binding pose or nal posed state POSE Pose Position, Show armature in posed state. REST Rest Position, Show Armature in binding pose state. No posing possible. Type enum in [POSE, REST], default POSE show_axes Draw bone axes Type boolean, default False show_bone_custom_shapes Draw bones with their custom shapes

2.4. Types ([Link])

225

Blender Index, Release 2.59.2 - API

Type boolean, default False show_group_colors Draw bone group colors Type boolean, default False show_names Draw bone names Type boolean, default False show_only_ghost_selected Type boolean, default False use_auto_ik Add temporaral IK constraints while grabbing bones in Pose Mode Type boolean, default False use_deform_delay Dont deform children when manipulating bones in Pose Mode Type boolean, default False use_deform_envelopes Enable Bone Envelopes when dening deform Type boolean, default False use_deform_preserve_volume Enable deform rotation with Quaternions Type boolean, default False use_deform_vertex_groups Enable Vertex Groups when dening deform Type boolean, default False use_mirror_x Apply changes to matching bone on opposite side of X-Axis Type boolean, default False vert_deformer BLENDER Blender, Uses Blenders armature vertex deformation. BGE_CPU BGE, Uses vertex deformation code optimized for the BGE. Type enum in [BLENDER, BGE_CPU], default BLENDER
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

226

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Functions

References

[Link] [Link] [Link]

2.4.25 ArmatureActuator(Actuator)
base classes bpy_struct, Actuator class [Link](Actuator) Actuator to .. bone Bone on which the constraint is dened Type string, default constraint Name of the constraint you want to control Type string, default mode Type enum in [RUN, ENABLE, DISABLE, SETTARGET, SETWEIGHT], default RUN secondary_target Set this object as the secondary target of the constraint (only IK polar target at the moment) Type Object

2.4. Types ([Link])

227

Blender Index, Release 2.59.2 - API

target Set this object as the target of the constraint Type Object weight Set weight of this constraint Type oat in [0, 1], default 0.0
Inherited Properties

bpy_struct.id_data [Link] Actuator.show_expanded [Link] [Link]

Inherited Functions

2.4.26 ArmatureBones(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of armature bones active Armatures active bone Type Bone

228

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.27 ArmatureEditBones(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of armature edit bones active Armatures active edit bone Type EditBone new(name) Add a new bone. Parameters name (string) New name for the bone Returns Newly created edit bone Return type EditBone remove(bone) Remove an existing bone from the armature Parameters bone (EditBone, (never None)) EditBone to remove

2.4. Types ([Link])

229

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Armature.edit_bones

2.4.28 ArmatureModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Armature deformation modier invert_vertex_group Invert vertex group inuence Type boolean, default False object Armature object to deform with Type Object use_bone_envelopes Binds Bone envelope to armature modier Type boolean, default False use_deform_preserve_volume Deform rotation interpolation with quaternions Type boolean, default False use_multi_modifier Use same input as previous modier, and mix results using overall vgroup 230 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type boolean, default False use_vertex_groups Binds vertex group to armature modier Type boolean, default False vertex_group Name of Vertex Group which determines inuence of modier per point Type string, default
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

2.4.29 ArmatureSensor(Sensor)
base classes bpy_struct, Sensor class [Link](Sensor) Sensor to detect values and changes in values of IK solver bone Identify the bone to check value from Type string, default

2.4. Types ([Link])

231

Blender Index, Release 2.59.2 - API

constraint Identify the bone constraint to check value from Type string, default test_type Type of value and test Type enum in [STATECHG, LINERRORBELOW, LINERRORABOVE, ROTERRORBELOW, ROTERRORABOVE], default STATECHG value Specify value to be used in comparison Type oat in [-inf, inf], default 0.0
Inherited Properties

bpy_struct.id_data [Link] Sensor.show_expanded [Link] [Link] Sensor.use_level [Link] Sensor.use_pulse_false_level Sensor.use_pulse_true_level Sensor.use_tap [Link]

Inherited Functions

2.4.30 ArrayModier(Modier)
base classes bpy_struct, Modifier 232 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

class [Link](Modier) Array duplication modier constant_offset_displace Value for the distance between arrayed items Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) count Number of duplicates to make Type int in [1, inf], default 0 curve Curve object to t array length to Type Object end_cap Mesh object to use as an end cap Type Object fit_length Length to t array within Type oat in [0, inf], default 0.0 fit_type Array length calculation method FIXED_COUNT Fixed Count, Duplicate the object a certain number of times. FIT_LENGTH Fit Length, Duplicate the object as many times as ts in a certain length. FIT_CURVE Fit Curve, Fit the duplicated objects to a curve. Type enum in [FIXED_COUNT, FIXED_COUNT merge_threshold Limit below which to merge vertices Type oat in [0, inf], default 0.0 offset_object Uses the location and rotation of another object to determine the distance and rotational change between arrayed items Type Object relative_offset_displace The size of the geometry will determine the distance between arrayed items Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) start_cap Mesh object to use as a start cap Type Object use_constant_offset Add a constant offset Type boolean, default False FIT_LENGTH, FIT_CURVE], default

2.4. Types ([Link])

233

Blender Index, Release 2.59.2 - API

use_merge_vertices Merge vertices in adjacent duplicates Type boolean, default False use_merge_vertices_cap Merge vertices in rst and last duplicates Type boolean, default False use_object_offset Add another objects transformation to the total offset Type boolean, default False use_relative_offset Add an offset relative to the objects bounding box Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

2.4.31 BackgroundImage(bpy_struct)
base class bpy_struct

234

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

class [Link](bpy_struct) Image and settings for display in the 3d View background image Image displayed and edited in this space Type Image image_user Parameters dening which layer, pass and frame of the image is displayed Type ImageUser, (readonly, never None) offset_x Offsets image horizontally from the world origin Type oat in [-inf, inf], default 0.0 offset_y Offsets image vertically from the world origin Type oat in [-inf, inf], default 0.0 opacity Image opacity to blend the image against the background color Type oat in [0, 1], default 0.0 show_expanded Show the expanded in the user interface Type boolean, default False size Scaling factor for the background image Type oat in [0, inf], default 0.0 view_axis The axis to display the image on LEFT Left, Show background image while looking to the left. RIGHT Right, Show background image while looking to the right. BACK Back, Show background image in back view. FRONT Front, Show background image in front view. BOTTOM Bottom, Show background image in bottom view. TOP Top, Show background image in top view. ALL All Views, Show background image in all views. CAMERA Camera, Show background image in camera view. Type enum in [LEFT, RIGHT, BACK, FRONT, BOTTOM, TOP, ALL, CAMERA], default ALL
Inherited Properties

bpy_struct.id_data

2.4. Types ([Link])

235

Blender Index, Release 2.59.2 - API

Inherited Functions

References

SpaceView3D.background_images

2.4.32 BevelModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Bevel modier to make edges and vertices more rounded angle_limit Angle above which to bevel edges Type oat in [0, 3.14159], default 0.0 edge_weight_method What edge weight to use for weighting a vertex Type enum in [AVERAGE, SHARPEST, LARGEST], default AVERAGE limit_method NONE None, Bevel the entire mesh by a constant amount. ANGLE Angle, Only bevel edges with sharp enough angles between faces. WEIGHT Weight, Use bevel weights to determine how much bevel is applied; apply them separately in vert/edge select mode. Type enum in [NONE, ANGLE, WEIGHT], default NONE use_only_vertices Bevel verts/corners, not edges Type boolean, default False

236

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

width Bevel value/amount Type oat in [0, inf], default 0.0

Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

2.4.33 BezierSplinePoint(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Bezier curve point with two handles co Coordinates of the control point Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_left Coordinates of the rst handle Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_left_type Handle types 2.4. Types ([Link]) 237

Blender Index, Release 2.59.2 - API

Type enum in [FREE, VECTOR, ALIGNED, AUTO], default FREE handle_right Coordinates of the second handle Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_right_type Handle types Type enum in [FREE, VECTOR, ALIGNED, AUTO], default FREE hide Visibility status Type boolean, default False radius Radius for bevelling Type oat in [0, inf], default 0.0 select_control_point Control point selection status Type boolean, default False select_left_handle Handle 1 selection status Type boolean, default False select_right_handle Handle 2 selection status Type boolean, default False tilt Tilt in 3D View Type oat in [-inf, inf], default 0.0 weight Softbody goal weight Type oat in [0.01, 100], default 0.0
Inherited Properties

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set

238

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

Spline.bezier_points

2.4.34 BlendData(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Main data structure representing a .blend le and all its datablocks actions Action datablocks. Type BlendDataActions bpy_prop_collection of Action, (readonly) armatures Armature datablocks. Type BlendDataArmatures bpy_prop_collection of Armature, (readonly) brushes Brush datablocks. Type BlendDataBrushes bpy_prop_collection of Brush, (readonly) cameras Camera datablocks. Type BlendDataCameras bpy_prop_collection of Camera, (readonly) curves Curve datablocks. Type BlendDataCurves bpy_prop_collection of Curve, (readonly) filepath Path to the .blend le Type string, default , (readonly) fonts Vector font datablocks. Type BlendDataFonts bpy_prop_collection of VectorFont, (readonly) grease_pencil Grease Pencil datablocks. Type BlendDataGreasePencils bpy_prop_collection of GreasePencil, (readonly)

2.4. Types ([Link])

239

Blender Index, Release 2.59.2 - API

groups Group datablocks. Type BlendDataGroups bpy_prop_collection of Group, (readonly) images Image datablocks. Type BlendDataImages bpy_prop_collection of Image, (readonly) is_dirty Have recent edits been saved to disk Type boolean, default False, (readonly) is_saved Has the current session been saved to disk as a .blend le Type boolean, default False, (readonly) lamps Lamp datablocks. Type BlendDataLamps bpy_prop_collection of Lamp, (readonly) lattices Lattice datablocks. Type BlendDataLattices bpy_prop_collection of Lattice, (readonly) libraries Library datablocks. Type BlendDataLibraries bpy_prop_collection of Library, (readonly) materials Material datablocks. Type BlendDataMaterials bpy_prop_collection of Material, (readonly) meshes Mesh datablocks. Type BlendDataMeshes bpy_prop_collection of Mesh, (readonly) metaballs Metaball datablocks. Type BlendDataMetaBalls bpy_prop_collection of MetaBall, (readonly) node_groups Node group datablocks. Type BlendDataNodeTrees bpy_prop_collection of NodeTree, (readonly) objects Object datablocks. Type BlendDataObjects bpy_prop_collection of Object, (readonly) particles Particle datablocks. Type BlendDataParticles bpy_prop_collection of ParticleSettings, (readonly)

240

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

scenes Scene datablocks. Type BlendDataScenes bpy_prop_collection of Scene, (readonly) screens Screen datablocks. Type BlendDataScreens bpy_prop_collection of Screen, (readonly) scripts Script datablocks (DEPRECATED). Type bpy_prop_collection of ID, (readonly) shape_keys Shape Key datablocks. Type bpy_prop_collection of Key, (readonly) sounds Sound datablocks. Type BlendDataSounds bpy_prop_collection of Sound, (readonly) speakers Speaker datablocks. Type BlendDataSpeakers bpy_prop_collection of Speaker, (readonly) texts Text datablocks. Type BlendDataTexts bpy_prop_collection of Text, (readonly) textures Texture datablocks. Type BlendDataTextures bpy_prop_collection of Texture, (readonly) window_managers Window manager datablocks. Type BlendDataWindowManagers bpy_prop_collection of WindowManager, (readonly) worlds World datablocks. Type BlendDataWorlds bpy_prop_collection of World, (readonly)
Inherited Properties

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove 241

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

References

[Link]

2.4.40 BlendDataFonts(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of fonts load(lepath) Load a new font into the main database Parameters lepath (string) path of the font to load. Returns New font datablock. Return type VectorFont remove(vfont) Remove a font from the current blendle. Parameters vfont (VectorFont, (never None)) Font to remove. tag(value) tag Parameters value (boolean) Value
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.type_recast bpy_struct.values
References

[Link]

2.4.41 BlendDataGreasePencils(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of grease pencils tag(value) tag Parameters value (boolean) Value
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

BlendData.grease_pencil

2.4.42 BlendDataGroups(bpy_struct)
base class bpy_struct

248

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

class [Link](bpy_struct) Collection of groups new(name) Add a new group to the main database Parameters name (string) New name for the datablock. Returns New group datablock. Return type Group remove(group) Remove a group from the current blendle. Parameters group (Group, (never None)) Group to remove. tag(value) tag Parameters value (boolean) Value
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.43 BlendDataImages(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of images 2.4. Types ([Link]) 249

Blender Index, Release 2.59.2 - API

new(name, width, height, alpha=False, oat_buffer=False) Add a new image to the main database Parameters name (string) New name for the datablock. width (int in [1, inf]) Width of the image. height (int in [1, inf]) Height of the image. alpha (boolean, (optional)) Alpha, Use alpha channel oat_buffer (boolean, (optional)) Float Buffer, Create an image with oating point color Returns New image datablock. Return type Image load(lepath) Load a new image into the main database Parameters lepath (string) path of the le to load. Returns New image datablock. Return type Image remove(image) Remove an image from the current blendle. Parameters image (Image, (never None)) Image to remove. tag(value) tag Parameters value (boolean) Value
Inherited Properties

bpy_struct.id_data
Inherited Functions

250

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

References

[Link]

2.4.44 BlendDataLamps(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of lamps new(name, type) Add a new lamp to the main database Parameters name (string) New name for the datablock. type (enum in [POINT, SUN, SPOT, HEMI, AREA]) Type, The type of texture to add POINT Point, Omnidirectional point light source. SUN Sun, Constant direction parallel ray light source. SPOT Spot, Directional cone light source. HEMI Hemi, 180 degree constant light source. AREA Area, Directional area light source. Returns New lamp datablock. Return type Lamp remove(lamp) Remove a lamp from the current blendle. Parameters lamp (Lamp, (never None)) Lamp to remove. tag(value) tag Parameters value (boolean) Value
Inherited Properties

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set

2.4. Types ([Link])

251

Blender Index, Release 2.59.2 - API

bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

[Link]

2.4.45 BlendDataLattices(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of lattices new(name) Add a new lattice to the main database Parameters name (string) New name for the datablock. Returns New lattices datablock. Return type Lattice remove(lattice) Remove a lattice from the current blendle. Parameters lattice (Lattice, (never None)) Lattice to remove. tag(value) tag Parameters value (boolean) Value
Inherited Properties

bpy_struct.id_data
Inherited Functions

252

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

[Link]

2.4.46 BlendDataLibraries(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of libraries tag(value) tag Parameters value (boolean) Value load(lepath, link=False, relative=False) Returns a context manager which exposes 2 library objects on entering. Each object has attributes matching [Link] which are lists of strings to be linked. Parameters lepath (string) The path to a blend le. link (bool) When False reference to the original le is lost. relative (bool) When True the path is stored relative to the open blend le.
import bpy filepath = "//link_library.blend" # load a single scene we know the name of. with [Link](filepath) as (data_from, data_to): data_to.scenes = ["Scene"]

# load all meshes with [Link](filepath) as (data_from, data_to): data_to.meshes = data_from.meshes

# link all objects starting with A with [Link](filepath, link=True) as (data_from, data_to): data_to.objects = [name for name in data_from.objects if [Link]("A")]

# append everything with [Link](filepath) as (data_from, data_to): for attr in dir(data_to): setattr(data_to, attr, getattr(data_from, attr))

2.4. Types ([Link])

253

Blender Index, Release 2.59.2 - API

# the loaded objects can be accessed from data_to outside of the context # since loading the data replaces the strings for the datablocks or None # if the datablock could not be loaded. with [Link](filepath) as (data_from, data_to): data_to.meshes = data_from.meshes # now operate directly on the loaded data for mesh in data_to.meshes: if mesh is not None: print([Link])

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.47 BlendDataMaterials(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of materials new(name) Add a new material to the main database Parameters name (string) New name for the datablock. Returns New material datablock. Return type Material 254 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

remove(material) Remove a material from the current blendle. Parameters material (Material, (never None)) Material to remove. tag(value) tag Parameters value (boolean) Value
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.48 BlendDataMeshes(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of meshes new(name) Add a new mesh to the main database Parameters name (string) New name for the datablock. Returns New mesh datablock. Return type Mesh remove(mesh) Remove a mesh from the current blendle. 2.4. Types ([Link]) 255

Blender Index, Release 2.59.2 - API

Parameters mesh (Mesh, (never None)) Mesh to remove. tag(value) tag Parameters value (boolean) Value
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.49 BlendDataMetaBalls(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of metaballs new(name) Add a new metaball to the main database Parameters name (string) New name for the datablock. Returns New metaball datablock. Return type MetaBall remove(metaball) Remove a metaball from the current blendle. Parameters metaball (MetaBall, (never None)) MetaBall to remove.

256

Chapter 2. Application Modules

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get 261

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.is_property_hidden bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

[Link]

2.4.55 BlendDataSounds(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of sounds tag(value) tag Parameters value (boolean) Value
Inherited Properties

bpy_struct.id_data
Inherited Functions

262

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

References

[Link]

2.4.56 BlendDataSpeakers(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of speakers new(name) Add a new speaker to the main database Parameters name (string) New name for the datablock. Returns New speaker datablock. Return type Speaker remove(speaker) Remove a speaker from the current blendle. Parameters speaker (Speaker, (never None)) Speaker to remove. tag(value) tag Parameters value (boolean) Value
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

263

Blender Index, Release 2.59.2 - API

References

[Link]

2.4.57 BlendDataTexts(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of texts new(name) Add a new text to the main database Parameters name (string) New name for the datablock. Returns New text datablock. Return type Text remove(text) Remove a text from the current blendle. Parameters text (Text, (never None)) Text to remove. load(lepath) Add a new text to the main database from a le Parameters lepath (string) path for the datablock. Returns New text datablock. Return type Text tag(value) tag Parameters value (boolean) Value
Inherited Properties

bpy_struct.id_data
Inherited Functions

264

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

[Link]

2.4.58 BlendDataTextures(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of groups new(name, type) Add a new texture to the main database Parameters name (string) New name for the datablock. type (enum in [NONE, BLEND, CLOUDS, DISTORTED_NOISE, ENVIRONMENT_MAP, IMAGE, MAGIC, MARBLE, MUSGRAVE, NOISE, POINT_DENSITY, STUCCI, VORONOI, VOXEL_DATA, WOOD]) Type, The type of texture to add NONE None. BLEND Blend, Procedural - Creates a ramp texture. CLOUDS Clouds, Procedural - Creates a cloud-like fractal noise texture. DISTORTED_NOISE Distorted Noise, Procedural - Noise texture distorted by two noise algorithms. ENVIRONMENT_MAP Environment Map, Creates a render of the environment mapped to a texture. IMAGE Image or Movie, Allows for images or movies to be used as textures. MAGIC Magic, Procedural - Color texture based on trigonometric functions. MARBLE Marble, Procedural - Marble-like noise texture with wave generated bands. MUSGRAVE Musgrave, Procedural - Highly exible fractal noise texture. NOISE Noise, Procedural - Random noise, gives a different result every time, for every frame, for every pixel. POINT_DENSITY Point Density. STUCCI Stucci, Procedural - Creates a fractal noise texture. VORONOI Voronoi, Procedural - Creates cell-like patterns based on Worley noise. VOXEL_DATA Voxel Data, Creates a 3d texture based on volumetric data. WOOD Wood, Procedural - Wave generated bands or rings, with optional noise. Returns New texture datablock.

2.4. Types ([Link])

265

Blender Index, Release 2.59.2 - API

Return type Texture remove(texture) Remove a texture from the current blendle. Parameters texture (Texture, (never None)) Texture to remove. tag(value) tag Parameters value (boolean) Value
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.59 BlendDataWindowManagers(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of window managers tag(value) tag Parameters value (boolean) Value

266

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

BlendData.window_managers

2.4.60 BlendDataWorlds(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of worlds new(name) Add a new world to the main database Parameters name (string) New name for the datablock. Returns New world datablock. Return type World remove(world) Remove a world from the current blendle. Parameters world (World, (never None)) World to remove. tag(value) tag Parameters value (boolean) Value

2.4. Types ([Link])

267

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.61 BlendTexture(Texture)
base classes bpy_struct, ID, Texture class [Link](Texture) Procedural color blending texture progression Sets the style of the color blending LINEAR Linear, Creates a linear progression. QUADRATIC Quadratic, Creates a quadratic progression. EASING Easing, Creates a progression easing from one step to the next. DIAGONAL Diagonal, Creates a diagonal progression. SPHERICAL Spherical, Creates a spherical progression. QUADRATIC_SPHERE Quadratic sphere, Creates a quadratic progression in the shape of a sphere. RADIAL Radial, Creates a radial progression. Type enum in [LINEAR, QUADRATIC, EASING, DIAGONAL, SPHERICAL, QUADRATIC_SPHERE, RADIAL], default LINEAR

268

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

use_flip_axis Flips the textures X and Y axis HORIZONTAL Horizontal, Flips the textures X and Y axis. VERTICAL Vertical, Flips the textures X and Y axis. Type enum in [HORIZONTAL, VERTICAL], default HORIZONTAL users_material Materials that use this texture (readonly) users_object_modifier Object modiers that use this texture (readonly)
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link] Texture.animation_data [Link] Texture.color_ramp [Link] Texture.factor_blue Texture.factor_green Texture.factor_red Texture.node_tree [Link] Texture.use_preview_alpha [Link] Texture.use_color_ramp Texture.use_nodes Texture.users_material Texture.users_object_modifier Texture.users_material Texture.users_object_modifier

Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values [Link] ID.user_clear ID.animation_data_create ID.animation_data_clear ID.update_tag [Link]

2.4.62 BlenderRNA(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Blender RNA structure denitions structs Type bpy_prop_collection of Struct, (readonly)
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4.63 BoidRule(bpy_struct)
base class bpy_struct subclasses BoidRuleAvoidCollision, BoidRuleAverageSpeed, BoidRuleFight, BoidRuleFollowLeader, BoidRuleGoal BoidRuleAvoid,

270

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

class [Link](bpy_struct) name Boid rule name Type string, default type GOAL Goal, Go to assigned object or loudest assigned signal source. AVOID Avoid, Get away from assigned object or loudest assigned signal source. AVOID_COLLISION Avoid Collision, Manoeuvre to avoid collisions with other boids and deector objects in near future. SEPARATE Separate, Keep from going through other boids. FLOCK Flock, Move to center of neighbors and match their velocity. FOLLOW_LEADER Follow Leader, Follow a boid or assigned object. AVERAGE_SPEED Average Speed, Maintain speed, ight level or wander. FIGHT Fight, Go to closest enemy and attack when in range. Type enum in [GOAL, AVOID, AVOID_COLLISION, SEPARATE, FLOCK, FOLLOW_LEADER, AVERAGE_SPEED, FIGHT], default GOAL, (readonly) use_in_air Use rule when boid is ying Type boolean, default False use_on_land Use rule when boid is on land Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

271

Blender Index, Release 2.59.2 - API

bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

BoidSettings.active_boid_state BoidState.active_boid_rule [Link]

2.4.64 BoidRuleAverageSpeed(BoidRule)
base classes bpy_struct, BoidRule class [Link](BoidRule) level How much velocitys z-component is kept constant Type oat in [0, 1], default 0.0 speed Percentage of maximum speed Type oat in [0, 1], default 0.0 wander How fast velocitys direction is randomized Type oat in [0, 1], default 0.0
Inherited Properties

bpy_struct.id_data [Link] BoidRule.use_in_air BoidRule.use_on_land [Link]

Inherited Functions

272

Blender Index, Release 2.59.2 - API

bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.65 BoidRuleAvoid(BoidRule)
base classes bpy_struct, BoidRule class [Link](BoidRule) fear_factor Avoid object if danger from it is above this threshold Type oat in [0, 100], default 0.0 object Object to avoid Type Object use_predict Predict target movement Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] BoidRule.use_in_air BoidRule.use_on_land [Link]

Inherited Functions

2.4. Types ([Link])

273

Blender Index, Release 2.59.2 - API

2.4.66 BoidRuleAvoidCollision(BoidRule)
base classes bpy_struct, BoidRule class [Link](BoidRule) look_ahead Time to look ahead in seconds Type oat in [0, 100], default 0.0 use_avoid Avoid collision with other boids Type boolean, default False use_avoid_collision Avoid collision with deector objects Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] BoidRule.use_in_air BoidRule.use_on_land [Link]

Inherited Functions

2.4.67 BoidRuleFight(BoidRule)
base classes bpy_struct, BoidRule class [Link](BoidRule)

274

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

distance Attack boids at max this distance Type oat in [0, 100], default 0.0 flee_distance Flee to this distance Type oat in [0, 100], default 0.0
Inherited Properties

bpy_struct.id_data [Link] BoidRule.use_in_air BoidRule.use_on_land [Link]

Inherited Functions

2.4.68 BoidRuleFollowLeader(BoidRule)
base classes bpy_struct, BoidRule class [Link](BoidRule) distance Distance behind leader to follow Type oat in [0, 100], default 0.0 object Follow this object instead of a boid Type Object queue_count How many boids in a line 2.4. Types ([Link]) 275

Blender Index, Release 2.59.2 - API

Type int in [0, 100], default 0 use_line Follow leader in a line Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] BoidRule.use_in_air BoidRule.use_on_land [Link]

Inherited Functions

2.4.69 BoidRuleGoal(BoidRule)
base classes bpy_struct, BoidRule class [Link](BoidRule) object Goal object Type Object use_predict Predict target movement Type boolean, default False
Inherited Properties

bpy_struct.id_data 276 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link] BoidRule.use_in_air BoidRule.use_on_land [Link]

Inherited Functions

2.4.70 BoidSettings(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Settings for boid physics accuracy Accuracy of attack Type oat in [0, 1], default 0.0 active_boid_state Type BoidRule, (readonly) active_boid_state_index Type int in [0, inf], default 0 aggression Boid will ght this times stronger enemy Type oat in [0, 100], default 0.0 air_acc_max Maximum acceleration in air (relative to maximum speed) Type oat in [0, 1], default 0.0 air_ave_max Maximum angular velocity in air (relative to 180 degrees) Type oat in [0, 1], default 0.0

2.4. Types ([Link])

277

Blender Index, Release 2.59.2 - API

air_personal_space Radius of boids personal space in air (% of particle size) Type oat in [0, 10], default 0.0 air_speed_max Maximum speed in air Type oat in [0, 100], default 0.0 air_speed_min Minimum speed in air (relative to maximum speed) Type oat in [0, 1], default 0.0 bank Amount of rotation around velocity vector on turns Type oat in [0, 2], default 0.0 health Initial boid health when born Type oat in [0, 100], default 0.0 height Boid height relative to particle size Type oat in [0, 2], default 0.0 land_acc_max Maximum acceleration on land (relative to maximum speed) Type oat in [0, 1], default 0.0 land_ave_max Maximum angular velocity on land (relative to 180 degrees) Type oat in [0, 1], default 0.0 land_jump_speed Maximum speed for jumping Type oat in [0, 100], default 0.0 land_personal_space Radius of boids personal space on land (% of particle size) Type oat in [0, 10], default 0.0 land_smooth How smoothly the boids land Type oat in [0, 10], default 0.0 land_speed_max Maximum speed on land Type oat in [0, 100], default 0.0 land_stick_force How strong a force must be to start effecting a boid on land Type oat in [0, 1000], default 0.0 pitch Amount of rotation around side vector

278

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type oat in [0, 2], default 0.0 range The maximum distance from which a boid can attack Type oat in [0, 100], default 0.0 states Type bpy_prop_collection of BoidState, (readonly) strength Maximum caused damage on attack per second Type oat in [0, 100], default 0.0 use_climb Allow boids to climb goal objects Type boolean, default False use_flight Allow boids to move in air Type boolean, default False use_land Allow boids to move on land Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4. Types ([Link])

279

Blender Index, Release 2.59.2 - API

2.4.71 BoidState(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Boid state for boid physics active_boid_rule Type BoidRule, (readonly) active_boid_rule_index Type int in [0, inf], default 0 falloff Type oat in [0, 10], default 0.0 name Boid state name Type string, default rule_fuzzy Type oat in [0, 1], default 0.0 rules Type bpy_prop_collection of BoidRule, (readonly) ruleset_type How the rules in the list are evaluated FUZZY Fuzzy, Rules are gone through top to bottom. Only the rst rule that effect above fuzziness threshold is evaluated. RANDOM Random, A random rule is selected for each boid. AVERAGE Average, All rules are averaged. Type enum in [FUZZY, RANDOM, AVERAGE], default FUZZY volume Type oat in [0, 100], default 0.0
Inherited Properties

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden

280

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

[Link]

2.4.72 Bone(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Bone in an Armature datablock bbone_in Length of rst Bezier Handle (for B-Bones only) Type oat in [0, 2], default 0.0 bbone_out Length of second Bezier Handle (for B-Bones only) Type oat in [0, 2], default 0.0 bbone_segments Number of subdivisions of bone (for B-Bones only) Type int in [1, 32], default 0 bbone_x B-Bone X size Type oat in [0, 1000], default 0.0 bbone_z B-Bone Z size Type oat in [0, 1000], default 0.0 children Bones which are children of this bone Type bpy_prop_collection of Bone, (readonly) envelope_distance Bone deformation distance (for Envelope deform only) Type oat in [0, 1000], default 0.0 envelope_weight Bone deformation weight (for Envelope deform only) Type oat in [0, 1000], default 0.0

2.4. Types ([Link])

281

Blender Index, Release 2.59.2 - API

head Location of head end of the bone relative to its parent Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) head_local Location of head end of the bone relative to armature Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) head_radius Radius of head of bone (for Envelope deform only) Type oat in [0, inf], default 0.0 hide Bone is not visible when it is not in Edit Mode (i.e. in Object or Pose Modes) Type boolean, default False hide_select Bone is able to be selected Type boolean, default False layers Layers bone exists in Type boolean array of 32 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False) matrix 3x3 bone matrix Type oat array of 9 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0) matrix_local 4x4 bone matrix relative to armature Type oat array of 16 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0) name Type string, default parent Parent bone (in same Armature) Type Bone, (readonly) select Type boolean, default False select_head Type boolean, default False select_tail Type boolean, default False show_wire Bone is always drawn as Wireframe regardless of viewport draw mode. Useful for non-obstructive custom bone shapes

282

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type boolean, default False tail Location of tail end of the bone Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) tail_local Location of tail end of the bone relative to armature Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) tail_radius Radius of tail of bone (for Envelope deform only) Type oat in [0, inf], default 0.0 use_connect When bone has a parent, bones head is struck to the parents tail Type boolean, default False, (readonly) use_cyclic_offset When bone doesnt have a parent, it receives cyclic offset effects Type boolean, default False use_deform Bone does not deform any geometry Type boolean, default False use_envelope_multiply When deforming bone, multiply effects of Vertex Group weights with Envelope inuence Type boolean, default False use_inherit_rotation Bone inherits rotation or scale from parent bone Type boolean, default False use_inherit_scale Bone inherits scaling from parent bone Type boolean, default False use_local_location Bone location is set in local space Type boolean, default False basename The name of this bone before any . character (readonly) center The midpoint between the head and the tail. (readonly) children A list of all the bones children. (readonly) children_recursive a list of all children from this bone. (readonly)

2.4. Types ([Link])

283

Blender Index, Release 2.59.2 - API

children_recursive_basename Returns a chain of children with the same base name as this bone Only direct chains are supported, forks caused by multiple children with matching basenames will terminate the function and not be returned. (readonly) length The distance from head to tail, when set the head is moved to t the length. parent_recursive A list of parents, starting with the immediate parent (readonly) vector The direction this bone is pointing. Utility function for (tail - head) (readonly) x_axis Vector pointing down the x-axis of the bone. (readonly) y_axis Vector pointing down the x-axis of the bone. (readonly) z_axis Vector pointing down the x-axis of the bone. (readonly) evaluate_envelope(point) Calculate bone envelope at given point. Parameters point (oat array of 3 items in [-inf, inf]) Point, Position in 3d space to evaluate Returns Factor, Envelope factor Return type oat in [-inf, inf] parent_index(parent_test) The same as bone in other_bone.parent_recursive but saved generating a list. translate(vec) Utility function to add vec to the head and tail of this bone.
Inherited Properties

bpy_struct.id_data
Inherited Functions

284

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.type_recast bpy_struct.values
References

[Link] [Link] [Link] [Link] [Link]

2.4.73 BoneGroup(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Groups of Pose Channels (Bones) color_set Custom color set to use Type enum in [DEFAULT, THEME01, THEME02, THEME03, THEME04, THEME05, THEME06, THEME07, THEME08, THEME09, THEME10, THEME11, THEME12, THEME13, THEME14, THEME15, THEME16, THEME17, THEME18, THEME19, THEME20, CUSTOM], default DEFAULT colors Copy of the colors associated with the groups color set Type ThemeBoneColorSet, (readonly, never None) name Type string, default
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

[Link] Pose.bone_groups PoseBone.bone_group

2.4.74 BoneGroups(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of bone groups active Active bone group for this pose Type BoneGroup active_index Active index in bone groups array Type int in [-inf, inf], default 0
Inherited Properties

bpy_struct.id_data
Inherited Functions

286

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

References

Pose.bone_groups

2.4.75 BooleanModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Boolean operations modier object Mesh object to use for Boolean operation Type Object operation INTERSECT Intersect, Keeps the part of the mesh that intersects with the other selected object. UNION Union, Combines two meshes in an additive way. DIFFERENCE Difference, Combines two meshes in a subtractive way. Type enum in [INTERSECT, UNION, DIFFERENCE], default INTERSECT
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

2.4. Types ([Link])

287

Blender Index, Release 2.59.2 - API

bpy_struct.type_recast bpy_struct.values

2.4.76 BooleanProperty(Property)
base classes bpy_struct, Property class [Link](Property) RNA boolean property denition array_length Maximum length of the array, 0 means unlimited Type int in [0, inf], default 0, (readonly) default Default value for this number Type boolean, default False, (readonly) default_array Default value for this array Type boolean array of 3 items, default (False, False, False), (readonly)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] Property.is_enum_flag Property.is_hidden [Link] Property.is_never_none Property.is_readonly Property.is_registered Property.is_registered_optional Property.is_required Property.is_output Property.is_runtime Property.is_skip_save [Link] [Link] [Link]

Inherited Functions

288

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.77 Brush(ID)
base classes bpy_struct, ID class [Link](ID) Brush datablock for storing brush settings for painting and sculpting auto_smooth_factor Amount of smoothing to automatically apply to each stroke Type oat in [0, 1], default 0.0 blend Brush blending mode 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. LIGHTEN Lighten, Use lighten blending mode while painting. DARKEN Darken, Use darken blending mode while painting. ERASE_ALPHA Erase Alpha, Erase alpha while painting. ADD_ALPHA Add Alpha, Add alpha while painting. Type enum in [MIX, ADD, SUB, MUL, LIGHTEN, DARKEN, ERASE_ALPHA, ADD_ALPHA], default MIX clone_alpha Opacity of clone image display Type oat in [0, 1], default 0.0 clone_image Image for clone tool Type Image clone_offset Type oat array of 2 items in [-inf, inf], default (0.0, 0.0) color Type oat array of 3 items in [0, 1], default (0.0, 0.0, 0.0)

2.4. Types ([Link])

289

Blender Index, Release 2.59.2 - API

crease_pinch_factor How much the crease brush pinches Type oat in [0, 1], default 0.666667 cursor_color_add Color of cursor when adding Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) cursor_color_subtract Color of cursor when subtracting Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) curve Editable falloff curve Type CurveMapping, (readonly, never None) direction ADD Add, Add effect of brush. SUBTRACT Subtract, Subtract effect of brush. Type enum in [ADD, SUBTRACT], default ADD height Affectable height of brush (layer height for layer tool, i.e.) Type oat in [0, 1], default 0.5 icon_filepath File path to brush icon Type string, default image_tool Type enum in [DRAW, SOFTEN, SMEAR, CLONE], default DRAW jitter Jitter the position of the brush while painting Type oat in [0, 1], default 0.0 normal_weight How much grab will pull vertexes out of surface during a grab Type oat in [0, 1], default 0.0 plane_offset Adjusts plane on which the brush acts towards or away from the object surface Type oat in [-2, 2], default 0.0 plane_trim If a vertex is further from offset plane than this then it is not affected Type oat in [0, 1], default 0.5 rate Interval between paints for Airbrush Type oat in [0.0001, 10000], default 0.0

290

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

sculpt_plane Type enum in [AREA, VIEW, X, Y, Z], default AREA sculpt_tool Type enum in [BLOB, CLAY, CREASE, DRAW, FILL, FLATTEN, GRAB, INFLATE, LAYER, NUDGE, PINCH, ROTATE, SCRAPE, SMOOTH, SNAKE_HOOK, THUMB], default BLOB size Radius of the brush in pixels Type int in [1, 2000], default 0 smooth_stroke_factor Higher values give a smoother stroke Type oat in [0.5, 0.99], default 0.0 smooth_stroke_radius Minimum distance from last point before stroke continues Type int in [10, 200], default 0 spacing Spacing between brush daubs as a percentage of brush diameter Type int in [1, 1000], default 0 strength How powerful the effect of the brush is when applied Type oat in [0, 10], default 0.5 stroke_method DOTS Dots, Apply paint on each mouse move step. DRAG_DOT Drag Dot, Allows a single dot to be carefully positioned. SPACE Space, Limit brush application to the distance specied by spacing. ANCHORED Anchored, Keep the brush anchored to the initial location. AIRBRUSH Airbrush, Keep applying paint effect while holding mouse (spray). Type enum in [DOTS, DRAG_DOT, SPACE, ANCHORED, AIRBRUSH], default DOTS texture Type Texture texture_angle_source_no_random USER User, Rotate the brush texture by given angle. RAKE Rake, Rotate the brush texture to match the stroke direction. Type enum in [USER, RAKE], default USER texture_angle_source_random USER User, Rotate the brush texture by given angle.

2.4. Types ([Link])

291

Blender Index, Release 2.59.2 - API

RAKE Rake, Rotate the brush texture to match the stroke direction. RANDOM Random, Rotate the brush texture at random. Type enum in [USER, RAKE, RANDOM], default USER texture_overlay_alpha Type int in [1, 100], default 0 texture_sample_bias Value added to texture samples Type oat in [-1, 1], default 0.0 texture_slot Type BrushTextureSlot, (readonly) unprojected_radius Radius of brush in Blender units Type oat in [0.001, inf], default 0.0 use_accumulate Accumulate stroke dabs on top of each other Type boolean, default False use_adaptive_space Space daubs according to surface orientation instead of screen space Type boolean, default False use_airbrush Keep applying paint effect while holding mouse (spray) Type boolean, default False use_alpha When this is disabled, lock alpha while painting Type boolean, default False use_anchor Keep the brush anchored to the initial location Type boolean, default False use_custom_icon Set the brush icon from an image le Type boolean, default False use_edge_to_edge Drag anchor brush from edge-to-edge Type boolean, default False use_fixed_texture Keep texture origin in xed position Type boolean, default False use_frontface Brush only affects vertexes that face the viewer

292

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type boolean, default False use_inverse_smooth_pressure Lighter pressure causes more smoothing to be applied Type boolean, default False use_locked_size When locked brush stays same size relative to object; when unlocked brush size is given in pixels Type boolean, default False use_offset_pressure Enable tablet pressure sensitivity for offset Type boolean, default False use_original_normal When locked keep using normal of surface where stroke was initiated Type boolean, default False use_paint_image Use this brush in texture paint mode Type boolean, default False use_paint_sculpt Use this brush in sculpt mode Type boolean, default False use_paint_vertex Use this brush in vertex paint mode Type boolean, default False use_paint_weight Use this brush in weight paint mode Type boolean, default False use_persistent Sculpts on a persistent layer of the mesh Type boolean, default False use_plane_trim Enable Plane Trim Type boolean, default False use_pressure_jitter Enable tablet pressure sensitivity for jitter Type boolean, default False use_pressure_size Enable tablet pressure sensitivity for size Type boolean, default False use_pressure_spacing Enable tablet pressure sensitivity for spacing Type boolean, default False

2.4. Types ([Link])

293

Blender Index, Release 2.59.2 - API

use_pressure_strength Enable tablet pressure sensitivity for strength Type boolean, default False use_rake Rotate the brush texture to match the stroke direction Type boolean, default False use_random_rotation Rotate the brush texture at random Type boolean, default False use_restore_mesh Allows a single dot to be carefully positioned Type boolean, default False use_smooth_stroke Brush lags behind mouse and follows a smoother path Type boolean, default False use_space Limit brush application to the distance specied by spacing Type boolean, default False use_space_atten Automatically adjusts strength to give consistent results for different spacings Type boolean, default False use_texture_overlay Show texture in viewport Type boolean, default False use_wrap Enable torus wrapping while painting Type boolean, default False vertex_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. DARKEN Darken, Use darken blending mode while painting. Type enum in [MIX, ADD, SUB, MUL, BLUR, LIGHTEN, DARKEN], default MIX

294

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

Inherited Functions

References

[Link] [Link] [Link] [Link]

2.4.78 BrushTextureSlot(TextureSlot)
base classes bpy_struct, TextureSlot class [Link](TextureSlot) Texture slot for textures in a Brush datablock angle Denes brush texture rotation Type oat in [0, 6.28319], default 0.0 map_mode

2.4. Types ([Link])

295

Blender Index, Release 2.59.2 - API

Type enum in [FIXED, TILED, 3D], default FIXED

Inherited Properties

bpy_struct.id_data [Link] TextureSlot.blend_type [Link] TextureSlot.default_value [Link] [Link] TextureSlot.output_node TextureSlot.use_rgb_to_intensity [Link] TextureSlot.use_stencil [Link]

Inherited Functions

References

Brush.texture_slot

2.4.79 BuildModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Build effect modier frame_duration Specify the total time the build effect requires Type oat in [1, 300000], default 0.0

296

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

frame_start Specify the start frame of the effect Type oat in [-300000, 300000], default 0.0 seed Specify the seed for random if used Type int in [1, 300000], default 0 use_random_order Randomize the faces or edges during build Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

2.4.80 Camera(ID)
base classes bpy_struct, ID class [Link](ID) Camera datablock for storing camera settings angle Perspective Camera lens eld of view in degrees 2.4. Types ([Link]) 297

Blender Index, Release 2.59.2 - API

Type oat in [0.00640536, 3.01675], default 0.0 animation_data Animation data for this datablock Type AnimData, (readonly) clip_end Camera far clipping distance Type oat in [1, inf], default 0.0 clip_start Camera near clipping distance Type oat in [0.001, inf], default 0.0 dof_distance Distance to the focus point for depth of eld Type oat in [0, 5000], default 0.0 dof_object Use this object to dene the depth of eld focal point Type Object draw_size Apparent size of the Camera object in the 3D View Type oat in [0.01, 1000], default 0.0 lens Perspective Camera lens value in millimeters Type oat in [1, 5000], default 0.0 lens_unit Unit to edit lens in for the user interface Type enum in [MILLIMETERS, DEGREES], default MILLIMETERS ortho_scale Orthographic Camera scale (similar to zoom) Type oat in [0.01, 4000], default 0.0 passepartout_alpha Opacity (alpha) of the darkened overlay in Camera view Type oat in [0, 1], default 0.0 shift_x Perspective Camera horizontal shift Type oat in [-10, 10], default 0.0 shift_y Perspective Camera vertical shift Type oat in [-10, 10], default 0.0 show_guide Draw overlay

298

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type enum set in {CENTER, CENTER_DIAGONAL, THIRDS, GOLDEN, GOLDEN_TRIANGLE_A, GOLDEN_TRIANGLE_B, HARMONY_TRIANGLE_A, HARMONY_TRIANGLE_B}, default {CENTER} show_limits Draw the clipping range and focus point on the camera Type boolean, default False show_mist Draw a line from the Camera to indicate the mist area Type boolean, default False show_name Show the active Cameras name in Camera view Type boolean, default False show_passepartout Show a darkened overlay outside the image area in Camera view Type boolean, default False show_title_safe Show indicators for the title safe zone in Camera view Type boolean, default False type Camera types Type enum in [PERSP, ORTHO], default PERSP use_panorama Render the scene with a cylindrical camera for pseudo-sheye lens effects Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set bpy_struct.items

2.4. Types ([Link])

299

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values [Link] ID.user_clear ID.animation_data_create ID.animation_data_clear ID.update_tag

References

[Link] [Link] [Link]

2.4.81 CameraActuator(Actuator)
base classes bpy_struct, Actuator class [Link](Actuator) Actuator to .. axis Specify the axis the Camera will try to get behind X X, Camera tries to get behind the X axis. Y Y, Camera tries to get behind the Y axis. Type enum in [X, Y], default X damping Specify the strength of the constraint that drive the camera behind the target Type oat in [0, 10], default 0.0 height Type oat in [-inf, inf], default 0.0 max Type oat in [-inf, inf], default 0.0 min Type oat in [-inf, inf], default 0.0 object Look at this Object Type Object

300

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data [Link] Actuator.show_expanded [Link] [Link]

Inherited Functions

2.4.82 CastModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Cast modier to cast to other shapes cast_type Target object shape Type enum in [SPHERE, CYLINDER, CUBOID], default SPHERE factor Type oat in [-inf, inf], default 0.0 object Control object: if available, its location determines the center of the effect Type Object radius Only deform vertices within this distance from the center of the effect (leave as 0 for innite.) Type oat in [0, inf], default 0.0 size Size of projection shape (leave as 0 for auto.) 2.4. Types ([Link]) 301

Blender Index, Release 2.59.2 - API

Type oat in [0, inf], default 0.0 use_radius_as_size Use radius as size of projection shape (0 = auto) Type boolean, default False use_transform Use object transform to control projection shape Type boolean, default False use_x Type boolean, default False use_y Type boolean, default False use_z Type boolean, default False vertex_group Vertex group name Type string, default
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

302

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.values

2.4.83 ChannelDriverVariables(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of channel driver Variables new() Add a new variable for the driver. Returns Newly created Driver Variable. Return type DriverVariable remove(variable) Remove an existing variable from the driver. Parameters variable (DriverVariable, (never None)) Variable to remove from the driver.
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.84 ChildOfConstraint(Constraint)
base classes bpy_struct, Constraint

2.4. Types ([Link])

303

Blender Index, Release 2.59.2 - API

class [Link](Constraint) Creates constraint-based parent-child relationship inverse_matrix Transformation matrix to apply before Type oat array of 16 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0) subtarget Type string, default target Target Object Type Object use_location_x Use X Location of Parent Type boolean, default False use_location_y Use Y Location of Parent Type boolean, default False use_location_z Use Z Location of Parent Type boolean, default False use_rotation_x Use X Rotation of Parent Type boolean, default False use_rotation_y Use Y Rotation of Parent Type boolean, default False use_rotation_z Use Z Rotation of Parent Type boolean, default False use_scale_x Use X Scale of Parent Type boolean, default False use_scale_y Use Y Scale of Parent Type boolean, default False use_scale_z Use Z Scale of Parent Type boolean, default False

304

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

Inherited Functions

2.4.85 ChildParticle(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Child particle interpolated from simulated or edited particles
Inherited Properties

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove 2.4. Types ([Link]) 305

Blender Index, Release 2.59.2 - API

References

ParticleSystem.child_particles

2.4.86 ClampToConstraint(Constraint)
base classes bpy_struct, Constraint class [Link](Constraint) Constrains an objects location to the nearest point along the target path main_axis Main axis of movement Type enum in [CLAMPTO_AUTO, CLAMPTO_X, CLAMPTO_Y, CLAMPTO_Z], default CLAMPTO_AUTO target Target Object Type Object use_cyclic Treat curve as cyclic curve (no clamping to curve bounding box Type boolean, default False
Inherited Properties

306

Blender Index, Release 2.59.2 - API

Constraint.is_valid
Inherited Functions

2.4.87 ClothCollisionSettings(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Cloth simulation settings for self collision and collision with other objects collision_quality How many collision iterations should be done. (higher is better quality but slower) Type int in [1, 20], default 0 distance_min Minimum distance between collision objects before collision response takes in Type oat in [0.001, 1], default 0.0 distance_repel Maximum distance to apply repulsion force, must be greater then minimum distance Type oat in [0.001, 10], default 0.005 friction Friction force if a collision happened. (higher = less movement) Type oat in [0, 80], default 0.0 group Limit colliders to this Group Type Group repel_force Repulsion force to apply on cloth when close to colliding Type oat in [0, 20], default 1.0

2.4. Types ([Link])

307

Blender Index, Release 2.59.2 - API

self_collision_quality How many self collision iterations should be done. (higher is better quality but slower) Type int in [1, 10], default 0 self_distance_min 0.5 means no distance at all, 1.0 is maximum distance Type oat in [0.5, 1], default 0.0 self_friction Friction/damping with self contact Type oat in [0, 80], default 0.0 use_collision Enable collisions with other objects Type boolean, default False use_self_collision Enable self collisions Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

ClothModifier.collision_settings

2.4.88 ClothModier(Modier)
base classes bpy_struct, Modifier 308 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

class [Link](Modier) Cloth simulation modier collision_settings Type ClothCollisionSettings, (readonly, never None) point_cache Type PointCache, (readonly, never None) settings Type ClothSettings, (readonly, never None)
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

References

[Link]

2.4.89 ClothSettings(bpy_struct)
base class bpy_struct

2.4. Types ([Link])

309

Blender Index, Release 2.59.2 - API

class [Link](bpy_struct) Cloth simulation settings for an object air_damping Air has normally some thickness which slows falling things down Type oat in [0, 10], default 0.0 bending_stiffness Wrinkle coefcient. (higher = less smaller but more big wrinkles) Type oat in [0, 10000], default 0.0 bending_stiffness_max Maximum bending stiffness value Type oat in [0, 10000], default 0.0 collider_friction Type oat in [0, 1], default 0.0 effector_weights Type EffectorWeights, (readonly) goal_default Default Goal (vertex target position) value, when no Vertex Group used Type oat in [0, 1], default 0.0 goal_friction Goal (vertex target position) friction Type oat in [0, 50], default 0.0 goal_max Goal maximum, vertex group weights are scaled to match this range Type oat in [0, 1], default 0.0 goal_min Goal minimum, vertex group weights are scaled to match this range Type oat in [0, 1], default 0.0 goal_spring Goal (vertex target position) spring stiffness Type oat in [0, 0.999], default 0.0 gravity Gravity or external force vector Type oat array of 3 items in [-100, 100], default (0.0, 0.0, 0.0) internal_friction Type oat in [0, 1], default 0.0 mass Mass of cloth material Type oat in [0, 10], default 0.0 pin_stiffness Pin (vertex target position) spring stiffness

310

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type oat in [0, 50], default 0.0 pre_roll Simulation starts on this frame Type int in [0, 200], default 0 quality Quality of the simulation in steps per frame. (higher is better quality but slower) Type int in [4, 80], default 0 rest_shape_key Shape key to use the rest spring lengths from Type ShapeKey spring_damping Damping of cloth velocity. (higher = more smooth, less jiggling) Type oat in [0, 50], default 0.0 structural_stiffness Overall stiffness of structure Type oat in [0, 10000], default 0.0 structural_stiffness_max Maximum structural stiffness value Type oat in [0, 10000], default 0.0 use_pin_cloth Enable pinning of cloth vertices to other objects/positions Type boolean, default False use_stiffness_scale If enabled, stiffness can be scaled along a weight painted vertex group Type boolean, default False vertex_group_bending Vertex group for ne control over bending stiffness Type string, default vertex_group_mass Vertex Group for pinning of vertices Type string, default vertex_group_structural_stiffness Vertex group for ne control over structural stiffness Type string, default
Inherited Properties

bpy_struct.id_data

2.4. Types ([Link])

311

Blender Index, Release 2.59.2 - API

Inherited Functions

References

[Link]

2.4.90 CloudsTexture(Texture)
base classes bpy_struct, ID, Texture class [Link](Texture) Procedural noise texture cloud_type Determines whether Noise returns grayscale or RGB values Type enum in [GREYSCALE, COLOR], default GREYSCALE nabla Size of derivative offset used for calculating normal Type oat in [0.001, 0.1], default 0.0 noise_basis Sets the noise basis used for turbulence BLENDER_ORIGINAL Blender Original, Noise algorithm - Blender original: Smooth interpolated noise. ORIGINAL_PERLIN Original Perlin, Noise algorithm - Original Perlin: Smooth interpolated noise. IMPROVED_PERLIN Improved Perlin, Noise algorithm - Improved Perlin: Smooth interpolated noise. VORONOI_F1 Voronoi F1, Noise algorithm - Voronoi F1: Returns distance to the closest feature point. VORONOI_F2 Voronoi F2, Noise algorithm - Voronoi F2: Returns distance to the 2nd closest feature point.

312

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

VORONOI_F3 Voronoi F3, Noise algorithm - Voronoi F3: Returns distance to the 3rd closest feature point. VORONOI_F4 Voronoi F4, Noise algorithm - Voronoi F4: Returns distance to the 4th closest feature point. VORONOI_F2_F1 Voronoi F2-F1, Noise algorithm - Voronoi F1-F2. VORONOI_CRACKLE Voronoi Crackle, Noise algorithm - Voronoi Crackle: Voronoi tessellation with sharp edges. CELL_NOISE Cell Noise, Noise algorithm - Cell Noise: Square cell tessallation. Type enum in [BLENDER_ORIGINAL, ORIGINAL_PERLIN, IMPROVED_PERLIN, VORONOI_F1, VORONOI_F2, VORONOI_F3, VORONOI_F4, VORONOI_F2_F1, VORONOI_CRACKLE, CELL_NOISE], default BLENDER_ORIGINAL noise_depth Sets the depth of the cloud calculation Type int in [0, 30], default 0 noise_scale Sets scaling for noise input Type oat in [0.0001, inf], default 0.0 noise_type SOFT_NOISE Soft, Generate soft noise (smooth transitions). HARD_NOISE Hard, Generate hard noise (sharp transitions). Type enum in [SOFT_NOISE, HARD_NOISE], default SOFT_NOISE users_material Materials that use this texture (readonly) users_object_modifier Object modiers that use this texture (readonly)
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link] Texture.animation_data [Link] Texture.color_ramp [Link] Texture.factor_blue Texture.factor_green Texture.factor_red Texture.node_tree

2.4. Types ([Link])

313

Blender Index, Release 2.59.2 - API

[Link] Texture.use_preview_alpha [Link] Texture.use_color_ramp Texture.use_nodes Texture.users_material Texture.users_object_modifier Texture.users_material Texture.users_object_modifier

Inherited Functions

2.4.91 CollectionProperty(Property)
base classes bpy_struct, Property class [Link](Property) RNA collection property to dene lists, arrays and mappings fixed_type Fixed pointer type, empty if variable type Type Struct, (readonly)
Inherited Properties

314

bpy_struct.id_data [Link] [Link] [Link] Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Property.is_enum_flag Property.is_hidden [Link] Property.is_never_none Property.is_readonly Property.is_registered Property.is_registered_optional Property.is_required Property.is_output Property.is_runtime Property.is_skip_save [Link] [Link] [Link]

Inherited Functions

2.4.92 CollisionModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Collision modier dening modier stack position used for collision settings Type CollisionSettings, (readonly, never None)
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage 315

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

2.4.93 CollisionSensor(Sensor)
base classes bpy_struct, Sensor class [Link](Sensor) Sensor to detect objects colliding with the current object, with more settings than the Touch sensor material Only look for Objects with this material (blank = all objects) Type string, default property Only look for Objects with this property (blank = all objects) Type string, default use_material Toggle collision on material or property Type boolean, default False use_pulse Changes to the set of colliding objects generates pulse Type boolean, default False
Inherited Properties

316

bpy_struct.id_data [Link] Sensor.show_expanded [Link] Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link] Sensor.use_level [Link] Sensor.use_pulse_false_level Sensor.use_pulse_true_level Sensor.use_tap [Link]

Inherited Functions

2.4.94 CollisionSettings(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collision settings for object in physics simulation absorption How much of effector force gets lost during collision with this object (in percent) Type oat in [0, 1], default 0.0 damping Amount of damping during collision Type oat in [0, 1], default 0.0 damping_factor Amount of damping during particle collision Type oat in [0, 1], default 0.0 damping_random Random variation of damping Type oat in [0, 1], default 0.0

2.4. Types ([Link])

317

Blender Index, Release 2.59.2 - API

friction_factor Amount of friction during particle collision Type oat in [0, 1], default 0.0 friction_random Random variation of friction Type oat in [0, 1], default 0.0 permeability Chance that the particle will pass through the mesh Type oat in [0, 1], default 0.0 stickness Amount of stickness to surface collision Type oat in [0, 10], default 0.0 thickness_inner Inner face thickness Type oat in [0.001, 1], default 0.0 thickness_outer Outer face thickness Type oat in [0.001, 1], default 0.0 use Enable this objects as a collider for physics systems Type boolean, default False use_particle_kill Kill collided particles Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

318

Blender Index, Release 2.59.2 - API

bpy_struct.type_recast bpy_struct.values
References

[Link] [Link]

2.4.95 ColorRamp(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Color ramp mapping a scalar value to a color elements Type ColorRampElements bpy_prop_collection of ColorRampElement, (readonly) interpolation Type enum in [EASE, CARDINAL, LINEAR, B_SPLINE, CONSTANT], default LINEAR evaluate(position) Evaluate ColorRamp Parameters position (oat in [0, 1]) Position, Evaluate ColorRamp at position Returns Color, Color at given position Return type oat array of 4 items in [-inf, inf]
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.values
References

CompositorNodeValToRGB.color_ramp Material.diffuse_ramp Material.specular_ramp PointDensity.color_ramp ShaderNodeValToRGB.color_ramp Texture.color_ramp TextureNodeValToRGB.color_ramp UserPreferencesSystem.weight_color_range

2.4.96 ColorRampElement(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Element dening a color at a position in the color ramp color Set color of selected color stop Type oat array of 4 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0) position Set position of selected color stop Type oat in [0, 1], default 0.0
Inherited Properties

bpy_struct.id_data
Inherited Functions

320

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

References

[Link] [Link] [Link]

2.4.97 ColorRampElements(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of Color Ramp Elements new(position) Add element to ColorRamp Parameters position (oat in [0, 1]) Position, Position to add element Returns New element. Return type ColorRampElement remove(element) Delete element from ColorRamp Parameters element (ColorRampElement, (never None)) Element to remove.
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4. Types ([Link])

321

Blender Index, Release 2.59.2 - API

2.4.98 ColorSequence(EffectSequence)
base classes bpy_struct, Sequence, EffectSequence class [Link](EffectSequence) Sequence strip creating an image lled with a single g color Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data [Link] Sequence.blend_type Sequence.blend_alpha [Link] [Link] Sequence.effect_fader Sequence.frame_final_end Sequence.frame_offset_end Sequence.frame_still_end Sequence.input_1 Sequence.input_2 Sequence.input_3 Sequence.select_left_handle Sequence.frame_final_duration Sequence.frame_duration [Link] [Link] Sequence.select_right_handle [Link] Sequence.speed_factor Sequence.frame_start Sequence.frame_final_start Sequence.frame_offset_start Sequence.frame_still_start [Link] Sequence.use_default_fade Sequence.input_count EffectSequence.color_balance EffectSequence.use_float [Link] EffectSequence.use_deinterlace EffectSequence.use_reverse_frames EffectSequence.use_flip_x EffectSequence.use_flip_y EffectSequence.color_multiply EffectSequence.use_premultiply [Link] EffectSequence.use_proxy_custom_directory EffectSequence.use_proxy_custom_file EffectSequence.color_saturation

322

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link] [Link] EffectSequence.use_color_balance EffectSequence.use_crop EffectSequence.use_proxy EffectSequence.use_translation

Inherited Functions

2.4.99 CompositorNode(Node)
base classes bpy_struct, Node subclasses CompositorNodeSepHSVA, CompositorNodeValToRGB, CompositorNodeSepYCCA, CompositorNodeSetAlpha, CompositorNodeCrop, CompositorNodeMath, CompositorNodeCurveRGB, CompositorNodeDilateErode, CompositorNodeGamma, CompositorNodeRotate, CompositorNodeLensdist, CompositorNodeLumaMatte, CompositorNodeTranslate, CompositorNodeCombYCCA, CompositorNodeBilateralblur, CompositorNodeZcombine, CompositorNodeFilter, CompositorNodePremulKey, CompositorNodeMixRGB, CompositorNodeTime, CompositorNodeValue, CompositorNodeHueCorrect, CompositorNodeNormal, CompositorNodeIDMask, CompositorNodeVecBlur, CompositorNodeRLayers, CompositorNodeComposite, CompositorNodeCombRGBA, CompositorNodeViewer, CompositorNodeCombHSVA, CompositorNodeOutputFile, CompositorNodeInvert, CompositorNodeFlip, CompositorNodeDistanceMatte, CompositorNodeRGBToBW, CompositorNodeCombYUVA, CompositorNodeBlur, CompositorNodeDefocus, CompositorNodeGlare, CompositorNodeDiffMatte, CompositorNodeImage, CompositorNodeDBlur, CompositorNodeMapValue, CompositorNodeBrightContrast, CompositorNodeTexture, CompositorNodeLevels, CompositorNodeNormalize, CompositorNodeChannelMatte, CompositorNodeRGB, CompositorNodeColorSpill, CompositorNodeSepRGBA, CompositorNodeScale, CompositorNodeMapUV, CompositorNodeChromaMatte, CompositorNodeDisplace, CompositorNodeColorBalance, CompositorNodeTonemap, CompositorNodeAlphaOver, CompositorNodeColorMatte, CompositorNodeHueSat, CompositorNodeSepYUVA, CompositorNodeCurveVec, CompositorNodeSplitViewer 2.4. Types ([Link]) 323

Blender Index, Release 2.59.2 - API

class [Link](Node) type Type enum in [VIEWER, RGB, VALUE, MIX_RGB, VALTORGB, RGBTOBW, NORMAL, CURVE_VEC, CURVE_RGB, ALPHAOVER, BLUR, FILTER, MAP_VALUE, TIME, VECBLUR, SEPRGBA, SEPHSVA, SETALPHA, HUE_SAT, IMAGE, R_LAYERS, COMPOSITE, OUTPUT_FILE, TEXTURE, TRANSLATE, ZCOMBINE, COMBRGBA, DILATEERODE, ROTATE, SCALE, SEPYCCA, COMBYCCA, SEPYUVA, COMBYUVA, DIFF_MATTE, COLOR_SPILL, CHROMA_MATTE, CHANNEL_MATTE, FLIP, SPLITVIEWER, MAP_UV, ID_MASK, DEFOCUS, DISPLACE, COMBHSVA, MATH, LUMA_MATTE, BRIGHTCONTRAST, GAMMA, INVERT, NORMALIZE, CROP, DBLUR, BILATERALBLUR, PREMULKEY, DISTANCE_MATTE, LEVELS, COLOR_MATTE, COLORBALANCE, HUECORRECT, GLARE, TONEMAP, LENSDIST, SCRIPT, GROUP], default VIEWER, (readonly)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.100 CompositorNodeAlphaOver(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode)

324

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

premul Mix Factor Type oat in [0, 1], default 0.0 use_premultiply Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.101 CompositorNodeBilateralblur(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) iterations Type int in [1, 128], default 0 sigma_color Type oat in [0.01, 3], default 0.0 sigma_space

2.4. Types ([Link])

325

Blender Index, Release 2.59.2 - API

Type oat in [0.01, 30], default 0.0

Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.102 CompositorNodeBlur(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) aspect_correction Type of aspect correction to use Type enum in [NONE, Y, X], default NONE factor Type oat in [0, 2], default 0.0 factor_x Type oat in [0, 100], default 0.0 factor_y Type oat in [0, 100], default 0.0

326

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

filter_type Type enum in [FLAT, TENT, QUAD, CUBIC, GAUSS, FAST_GAUSS, CATROM, MITCH], default FLAT size_x Type int in [0, 2048], default 0 size_y Type int in [0, 2048], default 0 use_bokeh Uses circular lter (slower) Type boolean, default False use_gamma_correction Applies lter on gamma corrected values Type boolean, default False use_relative Use relative (percent) values to dene blur radius Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4. Types ([Link])

327

Blender Index, Release 2.59.2 - API

2.4.103 CompositorNodeBrightContrast(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.104 CompositorNodeChannelMatte(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) color_space RGB RGB, RGB Color Space. HSV HSV, HSV Color Space. YUV YUV, YUV Color Space. YCC YCbCr, YCbCr Color Space. Type enum in [RGB, HSV, YUV, YCC], default RGB

328

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

limit_channel Limit by this channels value Type enum in [R, G, B], default R limit_max Values higher than this setting are 100% opaque Type oat in [0, 1], default 0.0 limit_method Algorithm to use to limit channel SINGLE Single, Limit by single channel. MAX Max, Limit by max of other channels . Type enum in [SINGLE, MAX], default SINGLE limit_min Values lower than this setting are 100% keyed Type oat in [0, 1], default 0.0 matte_channel Channel used to determine matte Type enum in [R, G, B], default R
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.values

2.4.105 CompositorNodeChromaMatte(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) gain Alpha gain Type oat in [0, 1], default 0.0 lift Alpha lift Type oat in [0, 1], default 0.0 shadow_adjust Adjusts the brightness of any shadows captured Type oat in [0, 1], default 0.0 threshold Tolerance below which colors will be considered as exact matches Type oat in [0, 30], default 0.0 tolerance Tolerance for a color to be considered a keying color Type oat in [1, 80], default 0.0
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

330

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.106 CompositorNodeColorBalance(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) correction_method LIFT_GAMMA_GAIN Lift/Gamma/Gain. OFFSET_POWER_SLOPE Offset/Power/Slope (ASC-CDL), ASC-CDL standard color correction. Type enum in [LIFT_GAMMA_GAIN, LIFT_GAMMA_GAIN gain Correction for Highlights Type oat array of 3 items in [-inf, inf], default (1.0, 1.0, 1.0) gamma Correction for Midtones Type oat array of 3 items in [-inf, inf], default (1.0, 1.0, 1.0) lift Correction for Shadows Type oat array of 3 items in [-inf, inf], default (1.0, 1.0, 1.0) offset Correction for Shadows Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) power Correction for Midtones Type oat array of 3 items in [0, inf], default (1.0, 1.0, 1.0) slope Correction for Highlights Type oat array of 3 items in [0, inf], default (1.0, 1.0, 1.0)
Inherited Properties

OFFSET_POWER_SLOPE],

default

bpy_struct.id_data [Link] [Link] [Link] [Link] 331

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

[Link] [Link] [Link]

Inherited Functions

2.4.107 CompositorNodeColorMatte(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) color_hue Hue tolerance for colors to be considered a keying color Type oat in [0, 1], default 0.0 color_saturation Saturation Tolerance for the color Type oat in [0, 1], default 0.0 color_value Value Tolerance for the color Type oat in [0, 1], default 0.0
Inherited Properties

332

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link] Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Functions

2.4.108 CompositorNodeColorSpill(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) channel R R, Red Spill Suppression. G G, Green Spill Suppression. B B, Blue Spill Suppression. Type enum in [R, G, B], default R limit_channel R R, Limit by Red. G G, Limit by Green. B B, Limit by Blue. Type enum in [R, G, B], default R limit_method SIMPLE Simple, Simple Limit Algorithm. AVERAGE Average, Average Limit Algorithm. Type enum in [SIMPLE, AVERAGE], default SIMPLE ratio Scale limit by value Type oat in [0.5, 1.5], default 0.0

2.4. Types ([Link])

333

Blender Index, Release 2.59.2 - API

unspill_blue Blue spillmap scale Type oat in [0, 1.5], default 0.0 unspill_green Green spillmap scale Type oat in [0, 1.5], default 0.0 unspill_red Red spillmap scale Type oat in [0, 1.5], default 0.0 use_unspill Compensate all channels (differently) by hand Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.109 CompositorNodeCombHSVA(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode)

334

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.113 CompositorNodeComposite(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode)
Inherited Properties

bpy_struct.id_data [Link] [Link]

2.4. Types ([Link])

337

Blender Index, Release 2.59.2 - API

[Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.114 CompositorNodeCrop(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) max_x Type int in [0, 10000], default 0 max_y Type int in [0, 10000], default 0 min_x Type int in [0, 10000], default 0 min_y Type int in [0, 10000], default 0 rel_max_x Type oat in [0, 1], default 0.0 rel_max_y Type oat in [0, 1], default 0.0 rel_min_x Type oat in [0, 1], default 0.0

338

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

rel_min_y Type oat in [0, 1], default 0.0 relative Use relative values to crop image Type boolean, default False use_crop_size Whether to crop the size of the input image Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.115 CompositorNodeCurveRGB(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) mapping Type CurveMapping, (readonly)

2.4. Types ([Link])

339

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.116 CompositorNodeCurveVec(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) mapping Type CurveMapping, (readonly)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

340

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Functions

2.4.117 CompositorNodeDBlur(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) angle Type oat in [0, 360], default 0.0 center_x Type oat in [0, 1], default 0.0 center_y Type oat in [0, 1], default 0.0 distance Type oat in [-1, 1], default 0.0 iterations Type int in [1, 32], default 0 spin Type oat in [-360, 360], default 0.0 use_wrap Type boolean, default False zoom Type oat in [0, 100], default 0.0

2.4. Types ([Link])

341

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.118 CompositorNodeDefocus(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) angle Bokeh shape rotation offset in degrees Type int in [0, 90], default 0 blur_max blur limit, maximum CoC radius, 0=no limit Type oat in [0, 10000], default 0.0 bokeh OCTAGON Octagonal, 8 sides. HEPTAGON Heptagonal, 7 sides. HEXAGON Hexagonal, 6 sides. PENTAGON Pentagonal, 5 sides.

342

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

SQUARE Square, 4 sides. TRIANGLE Triangular, 3 sides. CIRCLE Circular. Type enum in [OCTAGON, HEPTAGON, HEXAGON, PENTAGON, SQUARE, TRIANGLE, CIRCLE], default CIRCLE f_stop Amount of focal blur, 128=innity=perfect focus, half the value doubles the blur radius Type oat in [0, 128], default 0.0 samples Number of samples (16=grainy, higher=less noise) Type int in [16, 256], default 0 threshold CoC radius threshold, prevents background bleed on in-focus midground, 0=off Type oat in [0, 100], default 0.0 use_gamma_correction Enable gamma correction before and after main process Type boolean, default False use_preview Enable sampling mode, useful for preview when using low samplecounts Type boolean, default False use_zbuffer Disable when using an image as input instead of actual z-buffer (auto enabled if node not image based, eg. time node) Type boolean, default False z_scale Scales the Z input when not using a z-buffer, controls maximum blur designated by the color white or input value 1 Type oat in [0, 1000], default 0.0
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

2.4. Types ([Link])

343

Blender Index, Release 2.59.2 - API

Inherited Functions

2.4.119 CompositorNodeDiffMatte(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) falloff Color distances below this additional threshold are partially keyed Type oat in [0, 1], default 0.0 tolerance Color distances below this threshold are keyed Type oat in [0, 1], default 0.0
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add

344

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.120 CompositorNodeDilateErode(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) distance Distance to grow/shrink (number of iterations) Type int in [-100, 100], default 0
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.125 CompositorNodeGamma(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.126 CompositorNodeGlare(CompositorNode)
base classes bpy_struct, Node, CompositorNode

2.4. Types ([Link])

349

Blender Index, Release 2.59.2 - API

class [Link](CompositorNode) angle_offset Streak angle offset in degrees Type int in [0, 180], default 0 color_modulation Amount of Color Modulation, modulates colors of streaks and ghosts for a spectral dispersion effect Type oat in [0, 1], default 0.0 fade Streak fade-out factor Type oat in [0.75, 1], default 0.0 glare_type Type enum in [GHOSTS, STREAKS, FOG_GLOW, SIMPLE_STAR], default SIMPLE_STAR iterations Type int in [2, 5], default 0 mix -1 is original image only, 0 is exact 50/50 mix, 1 is processed image only Type oat in [-1, 1], default 0.0 quality If not set to high quality, the effect will be applied to a low-res copy of the source image Type enum in [HIGH, MEDIUM, LOW], default HIGH size Glow/glare size (not actual size; relative to initial size of bright area of pixels) Type int in [6, 9], default 0 streaks Total number of streaks Type int in [2, 16], default 0 threshold The glare lter will only be applied to pixels brighter than this value Type oat in [0, 1000], default 0.0 use_rotate_45 Simple star lter: add 45 degree rotation offset Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link]

350

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link] [Link] [Link]

Inherited Functions

2.4.127 CompositorNodeHueCorrect(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) mapping Type CurveMapping, (readonly)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove 351

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

2.4.128 CompositorNodeHueSat(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) color_hue Type oat in [0, 1], default 0.0 color_saturation Type oat in [0, 2], default 0.0 color_value Type oat in [0, 2], default 0.0
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

352

Blender Index, Release 2.59.2 - API

bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.129 CompositorNodeIDMask(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) index Pass index number to convert to alpha Type int in [0, 10000], default 0
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.130 CompositorNodeImage(CompositorNode)
base classes bpy_struct, Node, CompositorNode

2.4. Types ([Link])

353

Blender Index, Release 2.59.2 - API

class [Link](CompositorNode) frame_duration Sets the number of images of a movie to use Type int in [0, 300000], default 0 frame_offset Offsets the number of the frame to use in the animation Type int in [-300000, 300000], default 0 frame_start Sets the global starting frame of the movie/sequence, assuming rst picture has a #1 Type int in [-300000, 300000], default 0 image Type Image layer Type enum in [PLACEHOLDER], default PLACEHOLDER use_auto_refresh Always refresh image on frame changes Type boolean, default False use_cyclic Cycle the images in the movie Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

354

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.131 CompositorNodeInvert(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) invert_alpha Type boolean, default False invert_rgb Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4. Types ([Link])

355

Blender Index, Release 2.59.2 - API

2.4.132 CompositorNodeLensdist(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) use_fit For positive distortion factor only: scale image such that black areas are not visible Type boolean, default False use_jitter Enable/disable jittering; faster, but also noisier Type boolean, default False use_projector Enable/disable projector mode. Effect is applied in horizontal direction only Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

362

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.140 CompositorNodeNormalize(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.141 CompositorNodeOutputFile(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) exr_codec Type enum in [NONE, PXR24, ZIP, PIZ, RLE], default NONE filepath Output path for the image, same functionality as render output. 2.4. Types ([Link]) 363

Blender Index, Release 2.59.2 - API

Type string, default frame_end Type int in [0, 300000], default 0 frame_start Type int in [0, 300000], default 0 image_type Type enum in [TARGA, RAW_TARGA, PNG, BMP, JPEG, IRIS, RADIANCE_HDR, CINEON, DPX, OPENEXR], default TARGA quality Type int in [1, 100], default 0 use_exr_half Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.142 CompositorNodePremulKey(CompositorNode)
base classes bpy_struct, Node, CompositorNode

364

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

class [Link](CompositorNode) mapping Conversion between premultiplied alpha and key alpha Type enum in [KEY_TO_PREMUL, PREMUL_TO_KEY], default KEY_TO_PREMUL
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.143 CompositorNodeRGB(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] 365

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

[Link] [Link]
Inherited Functions

2.4.144 CompositorNodeRGBToBW(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

366

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.145 CompositorNodeRLayers(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) layer Type enum in [PLACEHOLDER], default PLACEHOLDER scene Type Scene
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4. Types ([Link])

367

Blender Index, Release 2.59.2 - API

2.4.146 CompositorNodeRotate(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) filter_type Method to use to lter rotation Type enum in [NEAREST, BILINEAR, BICUBIC], default NEAREST
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.147 CompositorNodeScale(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) space Coordinate space to scale relative to Type enum in [RELATIVE, ABSOLUTE, SCENE_SIZE, RENDER_SIZE], default RELATIVE

368

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.148 CompositorNodeSepHSVA(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode)
Inherited Properties

[Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.152 CompositorNodeSetAlpha(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

372

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.153 CompositorNodeSplitViewer(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) axis Type enum in [X, Y], default X factor Type int in [0, 100], default 0
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

2.4.154 CompositorNodeTexture(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) node_output For node-based textures, which output node to use Type int in [-32768, 32767], default 0 texture Type Texture
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.155 CompositorNodeTime(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) curve

374

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type CurveMapping, (readonly) frame_end Type int in [-32768, 32767], default 0 frame_start Type int in [-32768, 32767], default 0
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.156 CompositorNodeTonemap(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) adaptation If 0, global; if 1, based on pixel intensity Type oat in [0, 1], default 0.0 contrast Set to 0 to use estimate from input image Type oat in [0, 1], default 0.0 2.4. Types ([Link]) 375

Blender Index, Release 2.59.2 - API

correction If 0, same for all channels; if 1, each independent Type oat in [0, 1], default 0.0 gamma If not used, set to 1 Type oat in [0.001, 3], default 0.0 intensity If less than zero, darkens image; otherwise, makes it brighter Type oat in [-8, 8], default 0.0 key The value the average luminance is mapped to Type oat in [0, 1], default 0.0 offset Normally always 1, but can be used as an extra control to alter the brightness curve Type oat in [0.001, 10], default 0.0 tonemap_type Type enum in [RD_PHOTORECEPTOR, RH_SIMPLE], default RH_SIMPLE
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

376

Blender Index, Release 2.59.2 - API

2.4.157 CompositorNodeTranslate(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.158 CompositorNodeTree(NodeTree)
base classes bpy_struct, ID, NodeTree class [Link](NodeTree) Node tree consisting of linked nodes used for compositing nodes Type CompositorNodes bpy_prop_collection of Node, (readonly)
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user

2.4. Types ([Link])

377

Blender Index, Release 2.59.2 - API

[Link] [Link] [Link] NodeTree.animation_data NodeTree.grease_pencil [Link] [Link] [Link] [Link]

Inherited Functions

2.4.159 CompositorNodeValToRGB(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) color_ramp Type ColorRamp, (readonly)
Inherited Properties

378

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link] [Link]
Inherited Functions

2.4.160 CompositorNodeValue(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.161 CompositorNodeVecBlur(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode) factor Scaling factor for motion vectors; actually shutter speed in frames Type oat in [0, 2], default 0.0 samples Type int in [1, 256], default 0 speed_max Maximum speed, or zero for none Type int in [0, 1024], default 0 speed_min Minimum speed for a pixel to be blurred; used to separate background from foreground Type int in [0, 1024], default 0 use_curved Interpolate between frames in a Bezier curve, rather than linearly Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

380

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.162 CompositorNodeViewer(CompositorNode)
base classes bpy_struct, Node, CompositorNode class [Link](CompositorNode)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.163 CompositorNodeZcombine(CompositorNode)
base classes bpy_struct, Node, CompositorNode

2.4. Types ([Link])

381

Blender Index, Release 2.59.2 - API

class [Link](CompositorNode) use_alpha Takes Alpha channel into account when doing the Z operation Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.164 CompositorNodes(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of Compositor Nodes new(type, group=None) Add a node to this node tree. Parameters type (enum in [VIEWER, RGB, VALUE, MIX_RGB, VALTORGB, RGBTOBW, NORMAL, CURVE_VEC, CURVE_RGB, ALPHAOVER, BLUR, FILTER, MAP_VALUE, TIME, VECBLUR, SEPRGBA, SEPHSVA, SETALPHA, HUE_SAT, IMAGE, R_LAYERS, COMPOSITE, OUTPUT_FILE,

382

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

TEXTURE, TRANSLATE, ZCOMBINE, COMBRGBA, DILATEERODE, ROTATE, SCALE, SEPYCCA, COMBYCCA, SEPYUVA, COMBYUVA, DIFF_MATTE, COLOR_SPILL, CHROMA_MATTE, CHANNEL_MATTE, FLIP, SPLITVIEWER, MAP_UV, ID_MASK, DEFOCUS, DISPLACE, COMBHSVA, MATH, LUMA_MATTE, BRIGHTCONTRAST, GAMMA, INVERT, NORMALIZE, CROP, DBLUR, BILATERALBLUR, PREMULKEY, DISTANCE_MATTE, LEVELS, COLOR_MATTE, COLORBALANCE, HUECORRECT, GLARE, TONEMAP, LENSDIST, SCRIPT, GROUP]) Type, Type of node to add group (NodeTree, (optional)) The group tree Returns New node. Return type Node remove(node) remove a node from this node tree. Parameters node (Node) The node to remove.
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.165 ConsoleLine(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Input line for the interactive console

2.4. Types ([Link])

383

Blender Index, Release 2.59.2 - API

body Text in the line Type string, default current_character Type int in [-inf, inf], default 0
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] [Link]

2.4.166 Constraint(bpy_struct)
base class bpy_struct subclasses KinematicConstraint, CopyScaleConstraint, ShrinkwrapConstraint, FollowPathConstraint, LockedTrackConstraint, CopyTransformsConstraint, PythonConstraint, LimitDistanceConstraint, StretchToConstraint, PivotConstraint, ClampToConstraint, TransformConstraint, LimitRotationConstraint, LimitLocationConstraint, ChildOfConstraint, CopyRotationConstraint, DampedTrackConstraint, TrackToConstraint, SplineIKConstraint, MaintainVolumeConstraint, LimitScaleConstraint, RigidBodyJointConstraint, FloorConstraint, ActionConstraint, CopyLocationConstraint class [Link](bpy_struct) Constraint modifying the transformation of objects and bones

384

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

active Constraint is the one being edited Type boolean, default False error_location Amount of residual error in Blender space unit for constraints that work on position Type oat in [-inf, inf], default 0.0, (readonly) error_rotation Amount of residual error in radiant for constraints that work on orientation Type oat in [-inf, inf], default 0.0, (readonly) influence Amount of inuence constraint will have on the nal solution Type oat in [0, 1], default 0.0 is_proxy_local Constraint was added in this proxy instance (i.e. did not belong to source Armature) Type boolean, default False is_valid Constraint has valid settings and can be evaluated Type boolean, default False, (readonly) mute Enable/Disable Constraint Type boolean, default False name Constraint name Type string, default owner_space Space that owner is evaluated in WORLD World Space, The constraint is applied relative to the world coordinate system. POSE Pose Space, The constraint is applied in Pose Space, the object transformation is ignored. LOCAL_WITH_PARENT Local With Parent, The constraint is applied relative to the local coordinate system of the object, with the parent transformation added. LOCAL Local Space, The constraint is applied relative to the local coordinate sytem of the object. Type enum in [WORLD, POSE, LOCAL_WITH_PARENT, LOCAL], default WORLD show_expanded Constraints panel is expanded in UI Type boolean, default False target_space Space that target is evaluated in WORLD World Space, The transformation of the target is evaluated relative to the world coordinate system.

2.4. Types ([Link])

385

Blender Index, Release 2.59.2 - API

POSE Pose Space, The transformation of the target is only evaluated in the Pose Space, the target armature object transformation is ignored. LOCAL_WITH_PARENT Local With Parent, The transformation of the target bone is evaluated relative its local coordinate system, with the parent transformation added. LOCAL Local Space, The transformation of the target is evaluated relative to its local coordinate system. Type enum in [WORLD, POSE, LOCAL_WITH_PARENT, LOCAL], default WORLD type COPY_LOCATION Copy Location. COPY_ROTATION Copy Rotation. COPY_SCALE Copy Scale. COPY_TRANSFORMS Copy Transforms. LIMIT_DISTANCE Limit Distance. LIMIT_LOCATION Limit Location. LIMIT_ROTATION Limit Rotation. LIMIT_SCALE Limit Scale. MAINTAIN_VOLUME Maintain Volume. TRANSFORM Transformation. CLAMP_TO Clamp To. DAMPED_TRACK Damped Track, Tracking by taking the shortest path. IK Inverse Kinematics. LOCKED_TRACK Locked Track, Tracking along a single axis. SPLINE_IK Spline IK. STRETCH_TO Stretch To. TRACK_TO Track To, Legacy tracking constraint prone to twisting artifacts. ACTION Action. CHILD_OF Child Of. FLOOR Floor. FOLLOW_PATH Follow Path. PIVOT Pivot. RIGID_BODY_JOINT Rigid Body Joint. SCRIPT Script. SHRINKWRAP Shrinkwrap. Type enum in [COPY_LOCATION, COPY_ROTATION, COPY_SCALE, COPY_TRANSFORMS, LIMIT_DISTANCE, LIMIT_LOCATION, LIMIT_ROTATION, LIMIT_SCALE, MAINTAIN_VOLUME, TRANSFORM,

386

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

CLAMP_TO, DAMPED_TRACK, IK, LOCKED_TRACK, SPLINE_IK, STRETCH_TO, TRACK_TO, ACTION, CHILD_OF, FLOOR, FOLLOW_PATH, PIVOT, RIGID_BODY_JOINT, SCRIPT, SHRINKWRAP], default COPY_LOCATION, (readonly)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] UILayout.template_constraint

2.4.167 ConstraintActuator(Actuator)
base classes bpy_struct, Actuator class [Link](Actuator) Actuator to handle Constraints angle_max Maximum angle (in degree) allowed with target direction. No correction is done if angle with target direction is between min and max Type oat in [0, 180], default 0.0 2.4. Types ([Link]) 387

Blender Index, Release 2.59.2 - API

angle_min Minimum angle (in degree) to maintain with target direction. No correction is done if angle with target direction is between min and max Type oat in [0, 180], default 0.0 damping Damping factor: time constant (in frame) of low pass lter Type int in [-32768, 32767], default 0 damping_rotation Use a different damping for orientation Type int in [-32768, 32767], default 0 direction Set the direction of the ray Type enum in [NONE, DIRPX, DIRPY, DIRPZ, DIRNX, DIRNY, DIRNZ], default NONE direction_axis Select the axis to be aligned along the reference direction Type enum in [NONE, DIRPX, DIRPY, DIRPZ, DIRNX, DIRNY, DIRNZ], default NONE direction_axis_pos Select the axis to be aligned along the reference direction Type enum in [NONE, DIRPX, DIRPY, DIRPZ], default NONE distance Keep this distance to target Type oat in [-inf, inf], default 0.0 fh_damping Damping factor of the force eld spring Type oat in [-inf, inf], default 0.0 fh_force Spring force within the force eld area Type oat in [-inf, inf], default 0.0 fh_height Height of the force eld area Type oat in [-inf, inf], default 0.0 limit Type enum in [NONE, LOCX, LOCY, LOCZ], default NONE limit_max Type oat in [-inf, inf], default 0.0 limit_min Type oat in [-inf, inf], default 0.0 material Ray detects only Objects with this material

388

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type string, default mode The type of the constraint Type enum in [LOC, DIST, ORI, FH], default LOC property Ray detect only Objects with this property Type string, default range Set the maximum length of ray Type oat in [-inf, inf], default 0.0 rotation_max Reference Direction Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) time Maximum activation time in frame, 0 for unlimited Type int in [-32768, 32767], default 0 use_fh_normal Add a horizontal spring force on slopes Type boolean, default False use_fh_paralel_axis Keep object axis parallel to normal Type boolean, default False use_force_distance Force distance of object to point of impact of ray Type boolean, default False use_local Set ray along objects axis or global axis Type boolean, default False use_material_detect Detect material instead of property Type boolean, default False use_normal Set object axis along (local axis) or parallel (global axis) to the normal at hit position Type boolean, default False use_persistent Persistent actuator: stays active even if ray does not reach target Type boolean, default False

2.4. Types ([Link])

389

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data [Link] Actuator.show_expanded [Link] [Link]

Inherited Functions

2.4.168 ConstraintTarget(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Target object for multi-target constraints subtarget Type string, default target Target Object Type Object
Inherited Properties

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer

390

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

[Link]

2.4.169 Context(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Current windowmanager and data context area Type Area, (readonly) blend_data Type BlendData, (readonly) mode Type enum in [EDIT_MESH, EDIT_CURVE, EDIT_SURFACE, EDIT_TEXT, EDIT_ARMATURE, EDIT_METABALL, EDIT_LATTICE, POSE, SCULPT, PAINT_WEIGHT, PAINT_VERTEX, PAINT_TEXTURE, PARTICLE, OBJECT], default EDIT_MESH, (readonly) region Type Region, (readonly) region_data Type RegionView3D, (readonly) scene Type Scene, (readonly) screen Type Screen, (readonly) space_data Type Space, (readonly) 2.4. Types ([Link]) 391

Blender Index, Release 2.59.2 - API

tool_settings Type ToolSettings, (readonly) user_preferences Type UserPreferences, (readonly) window Type Window, (readonly) window_manager Type WindowManager, (readonly) static copy(self )
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link]

392

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link] [Link] [Link] [Link] Panel.draw_header [Link]

2.4.170 ControlFluidSettings(FluidSettings)
base classes bpy_struct, FluidSettings class [Link](FluidSettings) Fluid simulation settings for objects controlling the motion of uid in the simulation attraction_radius Species the force eld radius around the control object Type oat in [0, 10], default 0.0 attraction_strength Force strength for directional attraction towards the control object Type oat in [-10, 10], default 0.0 end_time Species time when the control particles are deactivated Type oat in [0, 100], default 0.0 quality Species the quality which is used for object sampling. (higher = better but slower) Type oat in [5, 100], default 0.0 start_time Species time when the control particles are activated Type oat in [0, 100], default 0.0 use Object contributes to the uid simulation Type boolean, default False use_reverse_frames Reverse control object movement Type boolean, default False velocity_radius Species the force eld radius around the control object Type oat in [0, 10], default 0.0 velocity_strength Force strength of how much of the control objects velocity is inuencing the uid velocity Type oat in [0, 10], default 0.0

2.4. Types ([Link])

393

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data [Link]
Inherited Functions

2.4.171 Controller(bpy_struct)
base class bpy_struct subclasses ExpressionController, XnorController, PythonController, AndController, NorController, OrController, XorController, NandController class [Link](bpy_struct) Game engine logic brick to process events, connecting sensors to actuators name Type string, default show_expanded Set controller expanded in the user interface Type boolean, default False states Set Controller state index (1 to 30) Type int in [1, 30], default 0 type LOGIC_AND And, Logic And. LOGIC_OR Or, Logic Or. LOGIC_NAND Nand, Logic Nand. LOGIC_NOR Nor, Logic Nor. LOGIC_XOR Xor, Logic Xor. 394 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

LOGIC_XNOR Xnor, Logic Xnor. EXPRESSION Expression. PYTHON Python. Type enum in [LOGIC_AND, LOGIC_OR, LOGIC_NAND, LOGIC_NOR, LOGIC_XOR, LOGIC_XNOR, EXPRESSION, PYTHON], default LOGIC_AND use_priority Mark controller for execution before all non-marked controllers (good for startup scripts) Type boolean, default False link(sensor=None, actuator=None) Link the controller with a sensor/actuator. Parameters sensor (Sensor, (optional)) Sensor to link the controller to. actuator (Actuator, (optional)) Actuator to link the controller to. unlink(sensor=None, actuator=None) Unlink the controller from a sensor/actuator. Parameters sensor (Sensor, (optional)) Sensor to unlink the controller from. actuator (Actuator, (optional)) Actuator to unlink the controller from.
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

395

Blender Index, Release 2.59.2 - API

References

[Link] [Link] [Link] [Link] [Link]

2.4.172 CopyLocationConstraint(Constraint)
base classes bpy_struct, Constraint class [Link](Constraint) Copies the location of the target head_tail Target along length of bone: Head=0, Tail=1 Type oat in [0, 1], default 0.0 invert_x Invert the X location Type boolean, default False invert_y Invert the Y location Type boolean, default False invert_z Invert the Z location Type boolean, default False subtarget Type string, default target Target Object Type Object use_offset Add original location into copied location Type boolean, default False use_x Copy the targets X location Type boolean, default False use_y Copy the targets Y location Type boolean, default False use_z Copy the targets Z location Type boolean, default False

396

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

Inherited Functions

2.4.173 CopyRotationConstraint(Constraint)
base classes bpy_struct, Constraint class [Link](Constraint) Copies the rotation of the target invert_x Invert the X rotation Type boolean, default False invert_y Invert the Y rotation Type boolean, default False invert_z Invert the Z rotation

2.4. Types ([Link])

397

Blender Index, Release 2.59.2 - API

Type boolean, default False subtarget Type string, default target Target Object Type Object use_offset Add original rotation into copied rotation Type boolean, default False use_x Copy the targets X rotation Type boolean, default False use_y Copy the targets Y rotation Type boolean, default False use_z Copy the targets Z rotation Type boolean, default False
Inherited Properties

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set bpy_struct.items

398

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.174 CopyScaleConstraint(Constraint)
base classes bpy_struct, Constraint class [Link](Constraint) Copies the scale of the target subtarget Type string, default target Target Object Type Object use_offset Add original scale into copied scale Type boolean, default False use_x Copy the targets X scale Type boolean, default False use_y Copy the targets Y scale Type boolean, default False use_z Copy the targets Z scale Type boolean, default False
Inherited Properties

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

Inherited Functions

2.4.175 CopyTransformsConstraint(Constraint)
base classes bpy_struct, Constraint class [Link](Constraint) Copies all the transforms of the target head_tail Target along length of bone: Head=0, Tail=1 Type oat in [0, 1], default 0.0 subtarget Type string, default target Target Object Type Object
Inherited Properties

400

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Functions

2.4.176 Curve(ID)
base classes bpy_struct, ID subclasses SurfaceCurve, TextCurve class [Link](ID) Curve datablock storing curves, splines and NURBS animation_data Animation data for this datablock Type AnimData, (readonly) bevel_depth Bevel depth when not using a bevel object Type oat in [-inf, inf], default 0.0 bevel_object Curve object name that denes the bevel shape Type Object bevel_resolution Bevel resolution when depth is non-zero and no specic bevel object has been dened Type int in [0, 32], default 0 dimensions Select 2D or 3D curve type 2D 2D, Clamp the Z axis of of the curve. 3D 3D, Allow editing on the Z axis of this curve, also allows tilt and curve radius to be used. Type enum in [2D, 3D], default 2D

2.4. Types ([Link])

401

Blender Index, Release 2.59.2 - API

eval_time Parametric position along the length of the curve that Objects following it should be at. Position is evaluated by dividing by the Path Length value Type oat in [-inf, inf], default 0.0 extrude Amount of curve extrusion when not using a bevel object Type oat in [0, inf], default 0.0 materials Type IDMaterials bpy_prop_collection of Material, (readonly) offset Offset the curve to adjust the width of a text Type oat in [-inf, inf], default 0.0 path_duration The number of frames that are needed to traverse the path, dening the maximum value for the Evaluation Time setting Type int in [1, 300000], default 0 render_resolution_u Surface resolution in U direction used while rendering. Zero skips this property Type int in [0, 32767], default 0 render_resolution_v Surface resolution in V direction used while rendering. Zero skips this property Type int in [0, 32767], default 0 resolution_u Surface resolution in U direction Type int in [1, 32767], default 0 resolution_v Surface resolution in V direction Type int in [1, 32767], default 0 shape_keys Type Key, (readonly) show_handles Display Bezier handles in editmode Type boolean, default False show_normal_face Display 3D curve normals in editmode Type boolean, default False splines Collection of splines in this curve data object Type CurveSplines bpy_prop_collection of Spline, (readonly) taper_object Curve object name that denes the taper (width)

402

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type Object texspace_location Texture space location Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) texspace_size Texture space size Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) twist_mode The type of tilt calculation for 3D Curves Z_UP Z-Up, Use Z-Up axis to calculate the curve twist at each point. MINIMUM Minimum, Use the least twist over the entire curve. TANGENT Tangent, Use the tangent to calculate twist. Type enum in [Z_UP, MINIMUM, TANGENT], default Z_UP twist_smooth Smoothing iteration for tangents Type oat in [-inf, inf], default 0.0 use_auto_texspace Adjusts active objects texture space automatically when transforming object Type boolean, default False use_deform_bounds Use the mesh bounds to clamp the deformation Type boolean, default False use_fill_back Draw lled back for extruded/beveled curves Type boolean, default False use_fill_deform Fill curve after applying shape keys and all modiers Type boolean, default False use_fill_front Draw lled front for extruded/beveled curves Type boolean, default False use_path Enable the curve to become a translation path Type boolean, default False use_path_follow Make curve path children to rotate along the path Type boolean, default False use_radius Option for paths: apply the curve radius with path following it and deforming

2.4. Types ([Link])

403

Blender Index, Release 2.59.2 - API

Type boolean, default False use_stretch Option for curve-deform: makes deformed child to stretch along entire path Type boolean, default False use_time_offset Children will use TimeOffs value as path distance offset Type boolean, default False use_uv_as_generated Uses the UV values as Generated textured coordinates Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

Inherited Functions

References

[Link] [Link]

404

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link]

2.4.177 CurveMap(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Curve in a curve mapping extend Extrapolate the curve or extend it horizontally Type enum in [HORIZONTAL, EXTRAPOLATED], default HORIZONTAL, (readonly) points Type bpy_prop_collection of CurveMapPoint, (readonly)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.178 CurveMapPoint(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Point of a curve used for a curve mapping

2.4. Types ([Link])

405

Blender Index, Release 2.59.2 - API

handle_type Curve interpolation at this point: Bezier or vector Type enum in [AUTO, VECTOR], default AUTO, (readonly) location X/Y coordinates of the curve point Type oat array of 2 items in [-inf, inf], default (0.0, 0.0), (readonly) select Selection state of the curve point Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.179 CurveMapping(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Curve mapping to map color, vector and scalar values to other values using a user dened curve black_level For RGB curves, the color that black is mapped to Type oat array of 3 items in [-1000, 1000], default (0.0, 0.0, 0.0) clip_max_x 406 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type oat in [-100, 100], default 0.0 clip_max_y Type oat in [-100, 100], default 0.0 clip_min_x Type oat in [-100, 100], default 0.0 clip_min_y Type oat in [-100, 100], default 0.0 curves Type bpy_prop_collection of CurveMap, (readonly) use_clip Force the curve view to t a dened boundary Type boolean, default False white_level For RGB curves, the color that white is mapped to Type oat array of 3 items in [-1000, 1000], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] [Link] [Link] [Link]

2.4. Types ([Link])

407

Blender Index, Release 2.59.2 - API

[Link] [Link] PointDensity.falloff_curve PointLamp.falloff_curve [Link] [Link] [Link] SpotLamp.falloff_curve [Link] [Link] VertexWeightEditModifier.map_curve WarpModifier.falloff_curve

2.4.180 CurveModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Curve deformation modier deform_axis The axis that the curve deforms along Type enum in [POS_X, POS_Y, POS_Z, NEG_X, NEG_Y, NEG_Z], default POS_X object Curve object to deform with Type Object vertex_group Name of Vertex Group which determines inuence of modier per point Type string, default
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

408

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.181 CurveSplines(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of curve splines active Active curve spline Type Object new(type) Add a new spline to the curve. Parameters type (enum in [POLY, BEZIER, BSPLINE, CARDINAL, NURBS]) type for the new spline. Returns The newly created spline. Return type Spline remove(spline) Remove a spline from a curve. Parameters spline (Spline, (never None)) The spline to remove.
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

[Link]

2.4.182 DampedTrackConstraint(Constraint)
base classes bpy_struct, Constraint class [Link](Constraint) Points toward target by taking the shortest rotation path head_tail Target along length of bone: Head=0, Tail=1 Type oat in [0, 1], default 0.0 subtarget Type string, default target Target Object Type Object track_axis Axis that points to the target object Type enum in [TRACK_X, TRACK_Y, TRACK_Z, TRACK_NEGATIVE_X, TRACK_NEGATIVE_Y, TRACK_NEGATIVE_Z], default TRACK_X
Inherited Properties

410

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Functions

2.4.183 DecimateModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Decimation modier face_count The current number of faces in the decimated mesh Type int in [-inf, inf], default 0, (readonly) ratio Denes the ratio of triangles to reduce to Type oat in [0, 1], default 0.0
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove

2.4. Types ([Link])

411

Blender Index, Release 2.59.2 - API

2.4.184 DelaySensor(Sensor)
base classes bpy_struct, Sensor class [Link](Sensor) Sensor to send delayed events delay Delay in number of logic tics before the positive trigger (default 60 per second) Type int in [0, 5000], default 0 duration If >0, delay in number of logic tics before the negative trigger following the positive trigger Type int in [0, 5000], default 0 use_repeat Toggle repeat option. If selected, the sensor restarts after Delay+Dur logic tics Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] Sensor.show_expanded [Link] [Link] Sensor.use_level [Link] Sensor.use_pulse_false_level Sensor.use_pulse_true_level Sensor.use_tap [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove 412 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.185 DisplaceModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Displacement modier direction X X, Uses the textures intensity value to displace in the X direction. Y Y, Uses the textures intensity value to displace in the Y direction. Z Z, Uses the textures intensity value to displace in the Z direction. NORMAL Normal, Uses the textures intensity value to displace in the normal direction. RGB_TO_XYZ RGB to XYZ, Uses the textures RGB values to displace the mesh in the XYZ direction. Type enum in [X, Y, Z, NORMAL, RGB_TO_XYZ], default X mid_level Material value that gives no displacement Type oat in [-inf, inf], default 0.0 strength Amount to displace geometry Type oat in [-inf, inf], default 0.0 texture Type Texture texture_coords LOCAL Map, Uses the local coordinate system for the texture coordinates. GLOBAL Global, Uses the global coordinate system for the texture coordinates. OBJECT Object, Uses the linked objects local coordinate system for the texture coordinates. UV UV, Uses UV coordinates for the texture coordinates.

2.4. Types ([Link])

413

Blender Index, Release 2.59.2 - API

Type enum in [LOCAL, GLOBAL, OBJECT, UV], default LOCAL texture_coords_object Object to set the texture coordinates Type Object uv_layer UV layer name Type string, default vertex_group Name of Vertex Group which determines inuence of modier per point Type string, default
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

2.4.186 DistortedNoiseTexture(Texture)
base classes bpy_struct, ID, Texture class [Link](Texture) Procedural distorted noise texture

414

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

distortion Amount of distortion Type oat in [0, 10], default 0.0 nabla Size of derivative offset used for calculating normal Type oat in [0.001, 0.1], default 0.0 noise_basis Sets the noise basis used for turbulence BLENDER_ORIGINAL Blender Original, Noise algorithm - Blender original: Smooth interpolated noise. ORIGINAL_PERLIN Original Perlin, Noise algorithm - Original Perlin: Smooth interpolated noise. IMPROVED_PERLIN Improved Perlin, Noise algorithm - Improved Perlin: Smooth interpolated noise. VORONOI_F1 Voronoi F1, Noise algorithm - Voronoi F1: Returns distance to the closest feature point. VORONOI_F2 Voronoi F2, Noise algorithm - Voronoi F2: Returns distance to the 2nd closest feature point. VORONOI_F3 Voronoi F3, Noise algorithm - Voronoi F3: Returns distance to the 3rd closest feature point. VORONOI_F4 Voronoi F4, Noise algorithm - Voronoi F4: Returns distance to the 4th closest feature point. VORONOI_F2_F1 Voronoi F2-F1, Noise algorithm - Voronoi F1-F2. VORONOI_CRACKLE Voronoi Crackle, Noise algorithm - Voronoi Crackle: Voronoi tessellation with sharp edges. CELL_NOISE Cell Noise, Noise algorithm - Cell Noise: Square cell tessallation. Type enum in [BLENDER_ORIGINAL, ORIGINAL_PERLIN, IMPROVED_PERLIN, VORONOI_F1, VORONOI_F2, VORONOI_F3, VORONOI_F4, VORONOI_F2_F1, VORONOI_CRACKLE, CELL_NOISE], default BLENDER_ORIGINAL noise_distortion Sets the noise basis for the distortion BLENDER_ORIGINAL Blender Original, Noise algorithm - Blender original: Smooth interpolated noise. ORIGINAL_PERLIN Original Perlin, Noise algorithm - Original Perlin: Smooth interpolated noise. IMPROVED_PERLIN Improved Perlin, Noise algorithm - Improved Perlin: Smooth interpolated noise. VORONOI_F1 Voronoi F1, Noise algorithm - Voronoi F1: Returns distance to the closest feature point. VORONOI_F2 Voronoi F2, Noise algorithm - Voronoi F2: Returns distance to the 2nd closest feature point. VORONOI_F3 Voronoi F3, Noise algorithm - Voronoi F3: Returns distance to the 3rd closest feature point.

2.4. Types ([Link])

415

Blender Index, Release 2.59.2 - API

VORONOI_F4 Voronoi F4, Noise algorithm - Voronoi F4: Returns distance to the 4th closest feature point. VORONOI_F2_F1 Voronoi F2-F1, Noise algorithm - Voronoi F1-F2. VORONOI_CRACKLE Voronoi Crackle, Noise algorithm - Voronoi Crackle: Voronoi tessellation with sharp edges. CELL_NOISE Cell Noise, Noise algorithm - Cell Noise: Square cell tessallation. Type enum in [BLENDER_ORIGINAL, ORIGINAL_PERLIN, IMPROVED_PERLIN, VORONOI_F1, VORONOI_F2, VORONOI_F3, VORONOI_F4, VORONOI_F2_F1, VORONOI_CRACKLE, CELL_NOISE], default BLENDER_ORIGINAL noise_scale Sets scaling for noise input Type oat in [0.0001, inf], default 0.0 users_material Materials that use this texture (readonly) users_object_modifier Object modiers that use this texture (readonly)
Inherited Properties

Inherited Functions

show_scenes Include visualization of Scene related Animation data Type boolean, default False show_shapekeys Include visualization of ShapeKey related Animation data Type boolean, default False show_speakers Include visualization of Speaker related Animation data Type boolean, default False show_summary Display an additional summary line. (DopeSheet Editors only) Type boolean, default False show_textures Include visualization of Texture related Animation data Type boolean, default False show_transforms Include visualization of Object-level Animation data (mostly Transforms) Type boolean, default False show_worlds Include visualization of World related Animation data Type boolean, default False source ID-Block representing source data, currently ID_SCE (for Dopesheet), and ID_SC (for Grease Pencil) Type ID, (readonly)
Inherited Properties

bpy_struct.id_data
Inherited Functions

422

Blender Index, Release 2.59.2 - API

bpy_struct.type_recast bpy_struct.values
References

[Link] [Link] [Link]

2.4.189 Driver(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Driver for the value of a setting based on an external value expression Expression to use for Scripted Expression Type string, default is_valid Driver could not be evaluated in past, so should be skipped Type boolean, default False show_debug_info Show intermediate values for the driver calculations to allow debugging of drivers Type boolean, default False type Driver type Type enum in [AVERAGE, SUM, SCRIPTED, MIN, MAX], default AVERAGE variables Properties acting as inputs for this driver Type ChannelDriverVariables bpy_prop_collection of DriverVariable, (readonly)
Inherited Properties

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set 423

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

[Link]

2.4.190 DriverTarget(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Source of input values for driver variables bone_target Name of PoseBone to use as target Type string, default data_path RNA Path (from ID-block) to property used Type string, default id ID-block that the specic property used can be found from (id_type property must be set rst) Type ID id_type Type of ID-block that can be used Type enum in [ACTION, ARMATURE, BRUSH, CAMERA, CURVE, FONT, GREASEPENCIL, GROUP, IMAGE, KEY, LAMP, LIBRARY, LATTICE, MATERIAL, META, MESH, NODETREE, OBJECT, PARTICLE, SCENE, SCREEN, SPEAKER, SOUND, TEXT, TEXTURE, WORLD, WINDOWMANAGER], default OBJECT transform_space Space in which transforms are used WORLD_SPACE World Space, Transforms include effects of parenting/restpose and constraints. TRANSFORM_SPACE Transform Space, Transforms dont include parenting/restpose or constraints. LOCAL_SPACE Local Space, Transforms include effects of constraints but not parenting/restpose. Type enum in [WORLD_SPACE, TRANSFORM_SPACE, LOCAL_SPACE], default WORLD_SPACE transform_type Driver variable type

424

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type enum in [LOC_X, LOC_Y, LOC_Z, ROT_X, ROT_Y, ROT_Z, SCALE_X, SCALE_Y, SCALE_Z], default LOC_X
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.191 DriverVariable(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Variable from some source/target for driver relationship name Name to use in scripted expressions/functions. (No spaces or dots are allowed. Also, must not start with a symbol or digit) Type string, default targets Sources of input data for evaluating this variable Type bpy_prop_collection of DriverTarget, (readonly) type Driver variable type SINGLE_PROP Single Property, Use the value from some RNA property (Default). TRANSFORMS Transform Channel, Final transformation value of object or bone.

2.4. Types ([Link])

425

Blender Index, Release 2.59.2 - API

ROTATION_DIFF Rotational Difference, Use the angle between two bones. LOC_DIFF Distance, Distance between two bones or objects. Type enum in [SINGLE_PROP, TRANSFORMS, ROTATION_DIFF, LOC_DIFF], default SINGLE_PROP
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] [Link] [Link]

2.4.192 DupliObject(bpy_struct)
base class bpy_struct class [Link](bpy_struct) An object duplicate matrix Object duplicate transformation matrix Type oat array of 16 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0) matrix_original The original matrix of this object before it was duplicated

426

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type oat array of 16 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0) object Object being duplicated Type Object, (readonly)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Object.dupli_list

2.4.193 EdgeSplitModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Edge splitting modier to create sharp edges split_angle Angle above which to split edges Type oat in [0, 3.14159], default 0.0 use_edge_angle Split edges with high angle between faces Type boolean, default False use_edge_sharp Split edges that are marked as sharp

2.4. Types ([Link])

427

Blender Index, Release 2.59.2 - API

Type boolean, default False

Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

2.4.194 EditBone(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Editmode bone in an Armature datablock bbone_in Length of rst Bezier Handle (for B-Bones only) Type oat in [0, 2], default 0.0 bbone_out Length of second Bezier Handle (for B-Bones only) Type oat in [0, 2], default 0.0 bbone_segments Number of subdivisions of bone (for B-Bones only) Type int in [1, 32], default 0

428

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bbone_x B-Bone X size Type oat in [0, 1000], default 0.0 bbone_z B-Bone Z size Type oat in [0, 1000], default 0.0 envelope_distance Bone deformation distance (for Envelope deform only) Type oat in [0, 1000], default 0.0 envelope_weight Bone deformation weight (for Envelope deform only) Type oat in [0, 1000], default 0.0 head Location of head end of the bone Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) head_radius Radius of head of bone (for Envelope deform only) Type oat in [0, inf], default 0.0 hide Bone is not visible when in Edit Mode Type boolean, default False hide_select Bone is able to be selected Type boolean, default False layers Layers bone exists in Type boolean array of 32 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False) lock Bone is not able to be transformed when in Edit Mode Type boolean, default False matrix Read-only matrix calculated from the roll (armature space) Type oat array of 16 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0), (readonly) name Type string, default parent Parent edit bone (in same Armature) Type EditBone

2.4. Types ([Link])

429

Blender Index, Release 2.59.2 - API

roll Bone rotation around head-tail axis Type oat in [-inf, inf], default 0.0 select Type boolean, default False select_head Type boolean, default False select_tail Type boolean, default False show_wire Bone is always drawn as Wireframe regardless of viewport draw mode. Useful for non-obstructive custom bone shapes Type boolean, default False tail Location of tail end of the bone Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) tail_radius Radius of tail of bone (for Envelope deform only) Type oat in [0, inf], default 0.0 use_connect When bone has a parent, bones head is struck to the parents tail Type boolean, default False use_cyclic_offset When bone doesnt have a parent, it receives cyclic offset effects Type boolean, default False use_deform Bone does not deform any geometry Type boolean, default False use_envelope_multiply When deforming bone, multiply effects of Vertex Group weights with Envelope inuence Type boolean, default False use_inherit_rotation Bone inherits rotation or scale from parent bone Type boolean, default False use_inherit_scale Bone inherits scaling from parent bone Type boolean, default False use_local_location Bone location is set in local space Type boolean, default False

430

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

basename The name of this bone before any . character (readonly) center The midpoint between the head and the tail. (readonly) children A list of all the bones children. (readonly) children_recursive a list of all children from this bone. (readonly) children_recursive_basename Returns a chain of children with the same base name as this bone Only direct chains are supported, forks caused by multiple children with matching basenames will terminate the function and not be returned. (readonly) length The distance from head to tail, when set the head is moved to t the length. parent_recursive A list of parents, starting with the immediate parent (readonly) vector The direction this bone is pointing. Utility function for (tail - head) (readonly) x_axis Vector pointing down the x-axis of the bone. (readonly) y_axis Vector pointing down the x-axis of the bone. (readonly) z_axis Vector pointing down the x-axis of the bone. (readonly) align_roll(vector) Align the bone to a localspace roll so the Z axis points in the direction of the vector given. Parameters vector (oat array of 3 items in [-inf, inf]) Vector align_orientation(other) Align this bone to another by moving its tail and settings its roll the length of the other bone is not used. parent_index(parent_test) The same as bone in other_bone.parent_recursive but saved generating a list. transform(matrix, scale=True, roll=True) Transform the the bones head, tail, roll and envalope (when the matrix has a scale component). Parameters matrix ([Link]) 3x3 or 4x4 transformation matrix. scale (bool) Scale the bone envalope by the matrix. roll (bool) Correct the roll to point in the same relative direction to the head and tail. translate(vec) Utility function to add vec to the head and tail of this bone.
Inherited Properties

bpy_struct.id_data

2.4. Types ([Link])

431

Blender Index, Release 2.59.2 - API

Inherited Functions

References

Armature.edit_bones [Link] [Link] [Link] [Link]

2.4.195 EditObjectActuator(Actuator)
base classes bpy_struct, Actuator class [Link](Actuator) Actuator used to edit objects angular_velocity Angular velocity upon creation Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) dynamic_operation Type enum in [RESTOREDYN, SUSPENDDYN, ENABLERIGIDBODY, DISABLERIGIDBODY, SETMASS], default RESTOREDYN linear_velocity Velocity upon creation Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) mass The mass of the object Type oat in [-inf, inf], default 0.0 mesh Replace the existing, when left blank Phys will remake the existing physics mesh

432

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type Mesh mode The mode of the actuator Type enum in [ADDOBJECT, ENDOBJECT, REPLACEMESH, TRACKTO, DYNAMICS], default ADDOBJECT object Add this Object and all its children (cant be on an visible layer) Type Object time Duration the new Object lives or the track takes Type int in [-inf, inf], default 0 track_object Track to this Object Type Object use_3d_tracking Enable 3D tracking Type boolean, default False use_local_angular_velocity Apply the rotation locally Type boolean, default False use_local_linear_velocity Apply the transformation locally Type boolean, default False use_replace_display_mesh Replace the display mesh Type boolean, default False use_replace_physics_mesh Replace the physics mesh (triangle bounds only - compound shapes not supported) Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] Actuator.show_expanded [Link] [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove

2.4. Types ([Link])

433

Blender Index, Release 2.59.2 - API

2.4.196 EffectSequence(Sequence)
base classes bpy_struct, Sequence subclasses GlowSequence, PluginSequence, ColorSequence, SpeedControlSequence TransformSequence, WipeSequence,

class [Link](Sequence) Sequence strip applying an effect on the images created by other strips color_balance Type SequenceColorBalance, (readonly) color_multiply Type oat in [0, 20], default 0.0 color_saturation Type oat in [0, 20], default 0.0 crop Type SequenceCrop, (readonly) proxy Type SequenceProxy, (readonly) strobe Only display every nth frame Type oat in [1, 30], default 0.0 transform Type SequenceTransform, (readonly) use_color_balance (3-Way color correction) on input Type boolean, default False use_crop Crop image before processing

434

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type boolean, default False use_deinterlace For video movies to remove elds Type boolean, default False use_flip_x Flip on the X axis Type boolean, default False use_flip_y Flip on the Y axis Type boolean, default False use_float Convert input to oat data Type boolean, default False use_premultiply Convert RGB from key alpha to premultiplied alpha Type boolean, default False use_proxy Use a preview proxy and/or timecode index for this strip Type boolean, default False use_proxy_custom_directory Use a custom directory to store data Type boolean, default False use_proxy_custom_file Use a custom le to read proxy data from Type boolean, default False use_reverse_frames Reverse frame order Type boolean, default False use_translation Translate image before processing Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] Sequence.blend_type Sequence.blend_alpha [Link] [Link] Sequence.effect_fader Sequence.frame_final_end Sequence.frame_offset_end

2.4. Types ([Link])

435

Blender Index, Release 2.59.2 - API

Sequence.frame_still_end Sequence.input_1 Sequence.input_2 Sequence.input_3 Sequence.select_left_handle Sequence.frame_final_duration Sequence.frame_duration [Link] [Link] Sequence.select_right_handle [Link] Sequence.speed_factor Sequence.frame_start Sequence.frame_final_start Sequence.frame_offset_start Sequence.frame_still_start [Link] Sequence.use_default_fade Sequence.input_count

Inherited Functions

2.4.197 EffectorWeights(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Effector weights for physics simulation all All effectors weight Type oat in [-200, 200], default 0.0

436

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

apply_to_hair_growing Use force elds when growing hair Type boolean, default False boid Boid effector weight Type oat in [-200, 200], default 0.0 charge Charge effector weight Type oat in [-200, 200], default 0.0 curve_guide Curve guide effector weight Type oat in [-200, 200], default 0.0 drag Drag effector weight Type oat in [-200, 200], default 0.0 force Force effector weight Type oat in [-200, 200], default 0.0 gravity Global gravity weight Type oat in [-200, 200], default 0.0 group Limit effectors to this Group Type Group harmonic Harmonic effector weight Type oat in [-200, 200], default 0.0 lennardjones Lennard-Jones effector weight Type oat in [-200, 200], default 0.0 magnetic Magnetic effector weight Type oat in [-200, 200], default 0.0 texture Texture effector weight Type oat in [-200, 200], default 0.0 turbulence Turbulence effector weight Type oat in [-200, 200], default 0.0 vortex Vortex effector weight

2.4. Types ([Link])

437

Blender Index, Release 2.59.2 - API

Type oat in [-200, 200], default 0.0 wind Wind effector weight Type oat in [-200, 200], default 0.0
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

ClothSettings.effector_weights ParticleSettings.effector_weights SmokeDomainSettings.effector_weights SoftBodySettings.effector_weights

2.4.198 EnumProperty(Property)
base classes bpy_struct, Property class [Link](Property) RNA enumeration property denition, to choose from a number of predened options default Default value for this enum Type enum in [DUMMY], default DUMMY, (readonly) default_flag Default value for this enum Type enum set in {DUMMY}, default set(), (readonly)

438

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

enum_items Possible values for the property Type bpy_prop_collection of EnumPropertyItem, (readonly)
Inherited Properties

Inherited Functions

2.4.199 EnumPropertyItem(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Denition of a choice in an RNA enum property

2.4. Types ([Link])

439

Blender Index, Release 2.59.2 - API

description Description of the items purpose Type string, default , (readonly) identifier Unique name used in the code and scripting Type string, default , (readonly) name Human readable name Type string, default , (readonly) value Value of the item Type int in [0, inf], default 0, (readonly)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

EnumProperty.enum_items

2.4.200 EnvironmentMap(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Environment map created by the renderer and cached for subsequent renders

440

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

clip_end Objects further than this are not visible to map Type oat in [0.01, inf], default 0.0 clip_start Objects nearer than this are not visible to map Type oat in [0.001, inf], default 0.0 depth Number of times a map will be rendered recursively (mirror effects.) Type int in [0, 5], default 0 is_valid True if this map is ready for use, False if it needs rendering. Type boolean, default False, (readonly) layers_ignore Hide objects on these layers when generating the Environment Map Type boolean array of 20 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False) mapping CUBE Cube, Use environment map with six cube sides. PLANE Plane, Only one side is rendered, with Z axis pointing in direction of image. Type enum in [CUBE, PLANE], default CUBE resolution Pixel resolution of the rendered environment map Type int in [50, 4096], default 0 source STATIC Static, Calculates environment map only once. ANIMATED Animated, Calculates environment map at each rendering. IMAGE_FILE Image File, Loads a saved environment map image from disk. Type enum in [STATIC, ANIMATED, IMAGE_FILE], default STATIC viewpoint_object Object to use as the environment maps viewpoint location Type Object zoom Type oat in [0.1, 5], default 0.0 clear() Discard the environment map and free it from memory. save(lepath, scene=None, layout=(0.0, 0.0, 1.0, 0.0, 2.0, 0.0, 0.0, 1.0, 1.0, 1.0, 2.0, 1.0)) Save the environment map to disc using the scene render settings. Parameters

2.4. Types ([Link])

441

Blender Index, Release 2.59.2 - API

lepath (string) File path, Location of the output le scene (Scene, (optional)) Overrides the scene from which image parameters are taken. layout (oat array of 12 items in [-inf, inf], (optional)) File layout, Flat array describing the X,Y position of each cube face in the output image, where 1 is the size of a face. Order is [+Z -Z +Y -X -Y +X]. Use -1 to skip a face.
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

EnvironmentMapTexture.environment_map

2.4.201 EnvironmentMapTexture(Texture)
base classes bpy_struct, ID, Texture class [Link](Texture) Environment map texture environment_map Gets the environment map associated with this texture Type EnvironmentMap, (readonly) filter_eccentricity Maximum eccentricity. Higher gives less blur at distant/oblique angles, but is also slower Type int in [1, 256], default 0 filter_probes Maximum number of samples. Higher gives less blur at distant/oblique angles, but is also slower

442

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type int in [1, 256], default 0 filter_size Multiplies the lter size used by MIP Map and Interpolation Type oat in [0.1, 50], default 0.0 filter_type Texture lter to use for sampling image Type enum in [BOX, EWA, FELINE, AREA], default BOX image Source image le to read the environment map from Type Image image_user Parameters dening which layer, pass and frame of the image is displayed Type ImageUser, (readonly) use_filter_size_min Use Filter Size as a minimal lter value in pixels Type boolean, default False use_mipmap Uses auto-generated MIP maps for the image Type boolean, default False use_mipmap_gauss Uses Gauss lter to sample down MIP maps Type boolean, default False users_material Materials that use this texture (readonly) users_object_modifier Object modiers that use this texture (readonly)
Inherited Properties

2.4. Types ([Link])

443

Blender Index, Release 2.59.2 - API

[Link] Texture.use_color_ramp Texture.use_nodes Texture.users_material Texture.users_object_modifier Texture.users_material Texture.users_object_modifier

Inherited Functions

2.4.202 Event(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Window Manager Event alt True when the Alt/Option key is held Type boolean, default False, (readonly) ascii Single ASCII character for this event Type string, default , (readonly) ctrl True when the Ctrl key is held Type boolean, default False, (readonly)

444

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

mouse_prev_x The window relative vertical location of the mouse Type int in [-inf, inf], default 0, (readonly) mouse_prev_y The window relative horizontal location of the mouse Type int in [-inf, inf], default 0, (readonly) mouse_region_x The region relative vertical location of the mouse Type int in [-inf, inf], default 0, (readonly) mouse_region_y The region relative horizontal location of the mouse Type int in [-inf, inf], default 0, (readonly) mouse_x The window relative vertical location of the mouse Type int in [-inf, inf], default 0, (readonly) mouse_y The window relative horizontal location of the mouse Type int in [-inf, inf], default 0, (readonly) oskey True when the Cmd key is held Type boolean, default False, (readonly) shift True when the Shift key is held Type boolean, default False, (readonly) type Type enum in [NONE, LEFTMOUSE, MIDDLEMOUSE, RIGHTMOUSE, BUTTON4MOUSE, BUTTON5MOUSE, ACTIONMOUSE, SELECTMOUSE, MOUSEMOVE, INBETWEEN_MOUSEMOVE, TRACKPADPAN, TRACKPADZOOM, MOUSEROTATE, WHEELUPMOUSE, WHEELDOWNMOUSE, WHEELINMOUSE, WHEELOUTMOUSE, EVT_TWEAK_L, EVT_TWEAK_M, EVT_TWEAK_R, EVT_TWEAK_A, EVT_TWEAK_S, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, ZERO, ONE, TWO, THREE, FOUR, FIVE, SIX, SEVEN, EIGHT, NINE, LEFT_CTRL, LEFT_ALT, LEFT_SHIFT, RIGHT_ALT, RIGHT_CTRL, RIGHT_SHIFT, OSKEY, GRLESS, ESC, TAB, RET, SPACE, LINE_FEED, BACK_SPACE, DEL, SEMI_COLON, PERIOD, COMMA, QUOTE, ACCENT_GRAVE, MINUS, SLASH, BACK_SLASH, EQUAL, LEFT_BRACKET, RIGHT_BRACKET, LEFT_ARROW, DOWN_ARROW, RIGHT_ARROW, UP_ARROW, NUMPAD_2, NUMPAD_4, NUMPAD_6, NUMPAD_8, NUMPAD_1, NUMPAD_3, NUMPAD_5, NUMPAD_7, NUMPAD_9, NUMPAD_PERIOD, NUMPAD_SLASH, NUMPAD_ASTERIX, NUMPAD_0, NUMPAD_MINUS, NUMPAD_ENTER, NUMPAD_PLUS, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, PAUSE, INSERT, HOME,

2.4. Types ([Link])

445

Blender Index, Release 2.59.2 - API

PAGE_UP, PAGE_DOWN, END, MEDIA_PLAY, MEDIA_STOP, MEDIA_FIRST, MEDIA_LAST, WINDOW_DEACTIVATE, TIMER, TIMER0, TIMER1, TIMER2, NDOF_BUTTON_MENU, NDOF_BUTTON_FIT, NDOF_BUTTON_TOP, NDOF_BUTTON_BOTTOM, NDOF_BUTTON_LEFT, NDOF_BUTTON_RIGHT, NDOF_BUTTON_FRONT, NDOF_BUTTON_BACK, NDOF_BUTTON_ISO1, NDOF_BUTTON_ISO2, NDOF_BUTTON_ROLL_CW, NDOF_BUTTON_ROLL_CCW, NDOF_BUTTON_SPIN_CW, NDOF_BUTTON_SPIN_CCW, NDOF_BUTTON_TILT_CW, NDOF_BUTTON_TILT_CCW, NDOF_BUTTON_ROTATE, NDOF_BUTTON_PANZOOM, NDOF_BUTTON_DOMINANT, NDOF_BUTTON_PLUS, NDOF_BUTTON_MINUS, NDOF_BUTTON_1, NDOF_BUTTON_2, NDOF_BUTTON_3, NDOF_BUTTON_4, NDOF_BUTTON_5, NDOF_BUTTON_6, NDOF_BUTTON_7, NDOF_BUTTON_8, NDOF_BUTTON_9, NDOF_BUTTON_10], default NONE, (readonly) value The type of event, only applies to some Type enum in [ANY, NOTHING, PRESS, RELEASE, CLICK, DOUBLE_CLICK], default NOTHING, (readonly)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] [Link] WindowManager.invoke_confirm WindowManager.invoke_props_popup

446

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.203 ExplodeModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Explosion effect modier based on a particle system particle_uv UV Layer to change with particle age Type string, default protect Clean vertex group edges Type oat in [0, 1], default 0.0 show_alive Show mesh when particles are alive Type boolean, default False show_dead Show mesh when particles are dead Type boolean, default False show_unborn Show mesh when particles are unborn Type boolean, default False use_edge_cut Cut face edges for nicer shrapnel Type boolean, default False use_size Use particle size for the shrapnel Type boolean, default False vertex_group Type string, default
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

2.4. Types ([Link])

447

Blender Index, Release 2.59.2 - API

Inherited Functions

2.4.204 ExpressionController(Controller)
base classes bpy_struct, Controller class [Link](Controller) Controller passing on events based on the evaluation of an expression expression Type string, default
Inherited Properties

bpy_struct.id_data [Link] [Link] Controller.show_expanded Controller.use_priority [Link]

Inherited Functions

448

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values [Link] [Link]

2.4.205 FCurve(bpy_struct)
base class bpy_struct class [Link](bpy_struct) F-Curve dening values of a period of time array_index Index to the specic property affected by F-Curve if applicable Type int in [-inf, inf], default 0 color Color of the F-Curve in the Graph Editor Type oat array of 3 items in [0, 1], default (0.0, 0.0, 0.0) color_mode Method used to determine color of F-Curve in Graph Editor Type enum in [AUTO_RAINBOW, AUTO_RAINBOW data_path RNA Path to property affected by F-Curve Type string, default driver Channel Driver (only set for Driver F-Curves) Type Driver, (readonly) extrapolation Type enum in [CONSTANT, LINEAR], default CONSTANT group Action Group that this F-Curve belongs to Type ActionGroup hide F-Curve and its keyframes are hidden in the Graph Editor graphs Type boolean, default False is_valid False when F-Curve could not be evaluated in past, so should be skipped when evaluating Type boolean, default False keyframe_points User-editable keyframes Type FCurveKeyframePoints bpy_prop_collection of Keyframe, (readonly) 2.4. Types ([Link]) 449 AUTO_RGB, CUSTOM], default

Blender Index, Release 2.59.2 - API

lock F-Curves settings cannot be edited Type boolean, default False modifiers Modiers affecting the shape of the F-Curve Type FCurveModifiers bpy_prop_collection of FModifier, (readonly) mute F-Curve is not evaluated Type boolean, default False sampled_points Sampled animation data Type bpy_prop_collection of FCurveSample, (readonly) select F-Curve is selected for editing Type boolean, default False evaluate(frame) Evaluate fcurve. Parameters frame (oat in [-inf, inf]) Frame, Evaluate fcurve at given frame Returns Position, FCurve position Return type oat in [-inf, inf] range() Get the time extents for F-Curve. Returns Range, Min/Max values Return type oat array of 2 items in [-inf, inf]
Inherited Properties

bpy_struct.id_data
Inherited Functions

450

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

[Link] [Link] [Link] [Link] [Link] AnimDataDrivers.from_existing AnimDataDrivers.from_existing [Link]

2.4.206 FCurveKeyframePoints(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of keyframe points insert(frame, value, options=set()) Add a keyframe point to a F-Curve. Parameters frame (oat in [-inf, inf]) X Value of this keyframe point value (oat in [-inf, inf]) Y Value of this keyframe point options (enum set in {REPLACE, NEEDED, FAST}, (optional)) Keyframe options. REPLACE Replace, Dont add any new keyframes, but just replace existing ones. NEEDED Needed, Only adds keyframes that are needed. FAST Fast, Fast keyframe insertion to avoid recalculating the curve each time. Returns Newly created keyframe Return type Keyframe add(count=1) Add a keyframe point to a F-Curve. Parameters count (int in [1, inf], (optional)) Number, Number of points to add to the spline remove(keyframe, fast=False) Remove keyframe from an fcurve. Parameters keyframe (Keyframe, (never None)) Keyframe to remove. fast (boolean, (optional)) Fast, Fast keyframe removal to avoid recalculating the curve each time

2.4. Types ([Link])

451

Blender Index, Release 2.59.2 - API

Inherited Properties

is_valid F-Curve Modier has invalid settings and will not be evaluated Type boolean, default False, (readonly) mute F-Curve Modier will not be evaluated Type boolean, default False show_expanded F-Curve Modiers panel is expanded in UI Type boolean, default False type F-Curve Modier Type Type enum in [NULL, GENERATOR, FNGENERATOR, ENVELOPE, CYCLES, NOISE, FILTER, LIMITS, STEPPED], default NULL, (readonly) use_influence F-Curve Modiers effects will be tempered by a default factor Type boolean, default False use_restricted_range F-Curve Modier is only applied for the specied frame range to help mask off effects in order to chain them Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

455

Blender Index, Release 2.59.2 - API

References

[Link] [Link] [Link] [Link] [Link]

2.4.210 FModierCycles(FModier)
base classes bpy_struct, FModifier class [Link](FModier) Repeats the values of the modied F-Curve cycles_after Maximum number of cycles to allow after last keyframe. (0 = innite) Type int in [-32768, 32767], default 0 cycles_before Maximum number of cycles to allow before rst keyframe. (0 = innite) Type int in [-32768, 32767], default 0 mode_after Cycling mode to use after last keyframe NONE No Cycles, Dont do anything. REPEAT Repeat Motion, Repeat keyframe range as-is. REPEAT_OFFSET Repeat with Offset, Repeat keyframe range, but with offset based on gradient between values. MIRROR Repeat Mirrored, Alternate between forward and reverse playback of keyframe range. Type enum in [NONE, REPEAT, REPEAT_OFFSET, MIRROR], default NONE mode_before Cycling mode to use before rst keyframe NONE No Cycles, Dont do anything. REPEAT Repeat Motion, Repeat keyframe range as-is. REPEAT_OFFSET Repeat with Offset, Repeat keyframe range, but with offset based on gradient between values. MIRROR Repeat Mirrored, Alternate between forward and reverse playback of keyframe range. Type enum in [NONE, REPEAT, REPEAT_OFFSET, MIRROR], default NONE
Inherited Properties

456

bpy_struct.id_data [Link] FModifier.blend_in FModifier.blend_out Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

FModifier.is_valid FModifier.frame_end FModifier.show_expanded [Link] [Link] FModifier.use_restricted_range FModifier.frame_start [Link] FModifier.use_influence

Blender Index, Release 2.59.2 - API

2.4.214 FModierGenerator(FModier)
base classes bpy_struct, FModifier class [Link](FModier) Deterministically generates values for the modied F-Curve coefficients Coefcients for x (starting from lowest power of x^0) Type oat array of 32 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0) mode Type of generator to use Type enum in [POLYNOMIAL, POLYNOMIAL_FACTORISED], default POLYNOMIAL poly_order The highest power of x for this polynomial. (number of coefcients - 1) Type int in [-inf, inf], default 0 use_additive Values generated by this modier are applied on top of the existing values instead of overwriting them Type boolean, default False
Inherited Properties

Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.215 FModierLimits(FModier)
base classes bpy_struct, FModifier class [Link](FModier) Limits the time/value ranges of the modied F-Curve max_x Highest X value to allow Type oat in [-inf, inf], default 0.0 max_y Highest Y value to allow Type oat in [-inf, inf], default 0.0 min_x Lowest X value to allow Type oat in [-inf, inf], default 0.0 min_y Lowest Y value to allow Type oat in [-inf, inf], default 0.0 use_max_x Use the maximum X value Type boolean, default False use_max_y Use the maximum Y value Type boolean, default False use_min_x Use the minimum X value Type boolean, default False use_min_y Use the minimum Y value Type boolean, default False
Inherited Properties

462

bpy_struct.id_data [Link] FModifier.blend_in FModifier.blend_out Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

FModifier.is_valid FModifier.frame_end FModifier.show_expanded [Link] [Link] FModifier.use_restricted_range FModifier.frame_start [Link] FModifier.use_influence

Inherited Functions

2.4.216 FModierNoise(FModier)
base classes bpy_struct, FModifier class [Link](FModier) Gives randomness to the modied F-Curve blend_type Method of modifying the existing F-Curve Type enum in [REPLACE, ADD, SUBTRACT, MULTIPLY], default REPLACE depth Amount of ne level detail present in the noise Type int in [0, 32767], default 0 phase A random seed for the noise effect Type oat in [-inf, inf], default 0.0 scale Scaling (in time) of the noise Type oat in [-inf, inf], default 0.0

2.4. Types ([Link])

463

Blender Index, Release 2.59.2 - API

strength Amplitude of the noise - the amount that it modies the underlying curve Type oat in [-inf, inf], default 0.0
Inherited Properties

Inherited Functions

2.4.217 FModierPython(FModier)
base classes bpy_struct, FModifier class [Link](FModier) Performs user-dened operation on the modied F-Curve
Inherited Properties

bpy_struct.id_data [Link]

464

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

FModifier.blend_in FModifier.blend_out FModifier.is_valid FModifier.frame_end FModifier.show_expanded [Link] [Link] FModifier.use_restricted_range FModifier.frame_start [Link] FModifier.use_influence

Inherited Functions

2.4.218 FModierStepped(FModier)
base classes bpy_struct, FModifier class [Link](FModier) Holds each interpolated value from the F-Curve for several frames without changing the timing frame_end Frame that modiers inuence ends (if applicable) Type oat in [-inf, inf], default 0.0 frame_offset Reference number of frames before frames get held. Use to get hold for 1-3 vs 5-7 holding patterns Type oat in [-inf, inf], default 0.0 frame_start Frame that modiers inuence starts (if applicable) Type oat in [-inf, inf], default 0.0 frame_step Number of frames to hold each value Type oat in [-inf, inf], default 0.0 2.4. Types ([Link]) 465

Blender Index, Release 2.59.2 - API

use_frame_end Restrict modier to only act before its end frame Type boolean, default False use_frame_start Restrict modier to only act after its start frame Type boolean, default False
Inherited Properties

Inherited Functions

2.4.219 FieldSettings(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Field settings for an object in physics simulation apply_to_location Effect particles location 466 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type boolean, default False apply_to_rotation Effect particles dynamic rotation Type boolean, default False distance_max Maximum distance for the eld to work Type oat in [0, 1000], default 0.0 distance_min Minimum distance for the elds fall-off Type oat in [0, 1000], default 0.0 falloff_power Falloff power (real gravitational falloff = 2) Type oat in [0, 10], default 0.0 falloff_type Type enum in [SPHERE, TUBE, CONE], default SPHERE flow Convert effector force into air ow velocity Type oat in [0, 10], default 0.0 guide_clump_amount Amount of clumping Type oat in [-1, 1], default 0.0 guide_clump_shape Shape of clumping Type oat in [-0.999, 0.999], default 0.0 guide_free Guide-free time from particle lifes end Type oat in [0, 0.99], default 0.0 guide_kink_amplitude The amplitude of the offset Type oat in [0, 10], default 0.0 guide_kink_axis Which axis to use for offset Type enum in [X, Y, Z], default X guide_kink_frequency The frequency of the offset (1/total length) Type oat in [0, 10], default 0.0 guide_kink_shape Adjust the offset to the beginning/end Type oat in [-0.999, 0.999], default 0.0

2.4. Types ([Link])

467

Blender Index, Release 2.59.2 - API

guide_kink_type Type of periodic offset on the curve Type enum in [NONE, CURL, RADIAL, WAVE, BRAID, ROTATION, ROLL], default NONE guide_minimum The distance from which particles are affected fully Type oat in [0, 1000], default 0.0 harmonic_damping Damping of the harmonic force Type oat in [0, 10], default 0.0 inflow Inwards component of the vortex force Type oat in [-10, 10], default 0.0 linear_drag Drag component proportional to velocity Type oat in [-2, 2], default 0.0 noise Amount of noise for the force strength Type oat in [0, 10], default 0.0 quadratic_drag Drag component proportional to the square of velocity Type oat in [-2, 2], default 0.0 radial_falloff Radial falloff power (real gravitational falloff = 2) Type oat in [0, 10], default 0.0 radial_max Maximum radial distance for the eld to work Type oat in [0, 1000], default 0.0 radial_min Minimum radial distance for the elds fall-off Type oat in [0, 1000], default 0.0 rest_length Rest length of the harmonic force Type oat in [0, 1000], default 0.0 seed Seed of the noise Type int in [1, 128], default 0 shape Which direction is used to calculate the effector force Type enum in [POINT, PLANE, SURFACE, POINTS], default POINT

468

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

size Size of the turbulence Type oat in [0, 10], default 0.0 strength Strength of force eld Type oat in [-1000, 1000], default 0.0 texture Texture to use as force Type Texture texture_mode How the texture effect is calculated (RGB & Curl need a RGB texture else Gradient will be used instead) Type enum in [RGB, GRADIENT, CURL], default RGB texture_nabla Denes size of derivative offset used for calculating gradient and curl Type oat in [0.0001, 1], default 0.0 type Type of eld NONE None. FORCE Force, Gives a radial eld toward the center of object. WIND Wind, Gives a constant force along the force objects local Z axis. VORTEX Vortex, Gives a spiraling force that twists the force objects local Z axis. MAGNET Magnetic, Forceeld depends on the speed of the particles. HARMONIC Harmonic, The source of this force eld is the zero point of a harmonic oscillator. CHARGE Charge, Spherical forceeld based on the charge of particles, only inuences other charge force elds. LENNARDJ Lennard-Jones, Forceeld based on the Lennard-Jones potential. TEXTURE Texture, Forceeld based on a texture. GUIDE Curve Guide, Creates a force along a curve object. BOID Boid. TURBULENCE Turbulence, Creates turbulence with a noise eld. DRAG Drag, Creates a force that dampens motion. Type enum in [NONE, FORCE, WIND, VORTEX, MAGNET, HARMONIC, CHARGE, LENNARDJ, TEXTURE, GUIDE, BOID, TURBULENCE, DRAG], default NONE use_2d_force Apply force only in 2d Type boolean, default False use_absorption Force gets absorbed by collision objects

2.4. Types ([Link])

469

Blender Index, Release 2.59.2 - API

Type boolean, default False use_global_coords Use effector/global coordinates for turbulence Type boolean, default False use_guide_path_add Based on distance/falloff it adds a portion of the entire path Type boolean, default False use_guide_path_weight Use curve weights to inuence the particle inuence along the curve Type boolean, default False use_max_distance Use a maximum distance for the eld to work Type boolean, default False use_min_distance Use a minimum distance for the elds fall-off Type boolean, default False use_multiple_springs Every point is effected by multiple springs Type boolean, default False use_object_coords Use object/global coordinates for texture Type boolean, default False use_radial_max Use a maximum radial distance for the eld to work Type boolean, default False use_radial_min Use a minimum radial distance for the elds fall-off Type boolean, default False use_root_coords Texture coordinates from root particle locations Type boolean, default False z_direction Effect in full or only positive/negative Z direction Type enum in [BOTH, POSITIVE, NEGATIVE], default BOTH
Inherited Properties

bpy_struct.id_data

470

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Functions

References

[Link] ParticleSettings.force_field_1 ParticleSettings.force_field_2

2.4.220 FileSelectParams(bpy_struct)
base class bpy_struct class [Link](bpy_struct) File Select Parameters directory Directory displayed in the le browser Type string, default display_type Display mode for the le list FILE_SHORTDISPLAY Short List, Display les as short list. FILE_LONGDISPLAY Long List, Display les as a detailed list. FILE_IMGDISPLAY Thumbnails, Display les as thumbnails. Type enum in [FILE_SHORTDISPLAY, FILE_LONGDISPLAY, FILE_IMGDISPLAY], default FILE_SHORTDISPLAY filename Active le in the le browser Type string, default filter_glob Type string, default 2.4. Types ([Link]) 471

Blender Index, Release 2.59.2 - API

show_hidden Show hidden dot les Type boolean, default False sort_method FILE_SORT_ALPHA Sort alphabetically, Sort the le list alphabetically. FILE_SORT_EXTENSION Sort by extension, Sort the le list by extension. FILE_SORT_TIME Sort by time, Sort les by modication time. FILE_SORT_SIZE Sort by size, Sort les by size. Type enum in [FILE_SORT_ALPHA, FILE_SORT_EXTENSION, FILE_SORT_TIME, FILE_SORT_SIZE], default FILE_SORT_ALPHA title Title for the le browser Type string, default , (readonly) use_filter Enable ltering of les Type boolean, default False use_filter_blender Show .blend les Type boolean, default False use_filter_folder Show folders Type boolean, default False use_filter_font Show font les Type boolean, default False use_filter_image Show image les Type boolean, default False use_filter_movie Show movie les Type boolean, default False use_filter_script Show script les Type boolean, default False use_filter_sound Show sound les Type boolean, default False use_filter_text Show text les

472

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type boolean, default False

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.221 Filter2DActuator(Actuator)
base classes bpy_struct, Actuator class [Link].Filter2DActuator(Actuator) Actuator to apply screen graphic effects filter_pass Set lter order Type int in [0, 99], default 0 glsl_shader Type Text mode Type enum in [ENABLE, DISABLE, REMOVE, MOTIONBLUR, BLUR, SHARPEN, DILATION, EROSION, LAPLACIAN, SOBEL, PREWITT, GRAYSCALE, SEPIA, INVERT, CUSTOMFILTER], default REMOVE motion_blur_factor Set motion blur factor Type oat in [0, 1], default 0.0 2.4. Types ([Link]) 473

Blender Index, Release 2.59.2 - API

2.4.226 FluidSettings(bpy_struct)
base class bpy_struct subclasses FluidFluidSettings, DomainFluidSettings, InflowFluidSettings, ObstacleFluidSettings, OutflowFluidSettings class [Link](bpy_struct) Fluid simulation settings for an object taking part in the simulation type Type of participation in the uid simulation NONE None. DOMAIN Domain, Bounding box of this object represents the computational domain of the uid simulation. FLUID Fluid, Object represents a volume of uid in the simulation. OBSTACLE Obstacle, Object is a xed obstacle. INFLOW Inow, Object adds uid to the simulation. OUTFLOW Outow, Object removes uid from the simulation. PARTICLE Particle, Object is made a particle system to display particles generated by a uidsim domain object. CONTROL Control, Object is made a uid control mesh, which inuences the uid. Type enum in [NONE, DOMAIN, FLUID, OBSTACLE, INFLOW, OUTFLOW, PARTICLE, CONTROL], default NONE
Inherited Properties

ControlFluidSettings, ParticleFluidSettings,

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove 479

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

References

[Link]

2.4.227 FluidSimulationModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Fluid simulation modier settings Settings for how this object is used in the uid simulation Type FluidSettings, (readonly, never None)
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

480

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.228 FollowPathConstraint(Constraint)
base classes bpy_struct, Constraint class [Link](Constraint) Locks motion to the target path forward_axis Axis that points forward along the path Type enum in [FORWARD_X, FORWARD_Y, FORWARD_Z, TRACK_NEGATIVE_X, TRACK_NEGATIVE_Y, TRACK_NEGATIVE_Z], default FORWARD_X offset Offset from the position corresponding to the time frame Type oat in [-300000, 300000], default 0.0 offset_factor Percentage value dening target position along length of bone Type oat in [0, 1], default 0.0 target Target Object Type Object up_axis Axis that points upward Type enum in [UP_X, UP_Y, UP_Z], default UP_X use_curve_follow Object will follow the heading and banking of the curve Type boolean, default False use_curve_radius Objects scale by the curve radius Type boolean, default False use_fixed_location Object will stay locked to a single point somewhere along the length of the curve regardless of time Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] [Link] 2.4. Types ([Link]) 481

Blender Index, Release 2.59.2 - API

[Link] Constraint.show_expanded [Link] Constraint.error_location Constraint.owner_space Constraint.is_proxy_local Constraint.error_rotation Constraint.target_space [Link] Constraint.is_valid

Inherited Functions

2.4.229 Function(bpy_struct)
base class bpy_struct class [Link](bpy_struct) RNA function denition description Description of the Functions purpose Type string, default , (readonly) identifier Unique name used in the code and scripting Type string, default , (readonly) is_registered Function is registered as callback as part of type registration Type boolean, default False, (readonly) is_registered_optional Function is optionally registered as callback part of type registration Type boolean, default False, (readonly)

482

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

parameters Parameters for the function Type bpy_prop_collection of Property, (readonly) use_self Function does not pass its self as an argument (becomes a class method in python) Type boolean, default False, (readonly)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.230 GPencilFrame(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of related sketches on a particular frame frame_number The frame on which this sketch appears Type int in [0, 300000], default 0 is_edited Frame is being edited (painted on) Type boolean, default False

2.4. Types ([Link])

483

Blender Index, Release 2.59.2 - API

select Frame is selected for editing in the DopeSheet Type boolean, default False strokes Freehand curves dening the sketch on this frame Type bpy_prop_collection of GPencilStroke, (readonly)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

GPencilLayer.active_frame [Link]

2.4.231 GPencilLayer(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of related sketches active_frame Frame currently being displayed for this layer Type GPencilFrame, (readonly) alpha Layer Opacity Type oat in [0.3, 1], default 0.0

484

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

color Color for all strokes in this layer Type oat array of 3 items in [0, 1], default (0.0, 0.0, 0.0) frames Sketches for this layer on different frames Type bpy_prop_collection of GPencilFrame, (readonly) ghost_range_max Maximum number of frames on either side of the active frame to show (0 = show the rst available sketch on either side) Type int in [0, 120], default 0 hide Set layer Visibility Type boolean, default False info Layer name Type string, default line_width Thickness of strokes (in pixels) Type int in [1, 10], default 0 lock Protect layer from further editing and/or frame changes Type boolean, default False lock_frame Lock current frame displayed by layer Type boolean, default False select Layer is selected for editing in the DopeSheet Type boolean, default False show_points Draw the points which make up the strokes (for debugging purposes) Type boolean, default False show_x_ray Type boolean, default False use_onion_skinning Ghost frames on either side of frame Type boolean, default False
Inherited Properties

bpy_struct.id_data

2.4. Types ([Link])

485

Blender Index, Release 2.59.2 - API

Inherited Functions

Type boolean, default False

Inherited Properties

bpy_struct.id_data [Link] GameProperty.show_debug [Link]

Inherited Functions

2.4.236 GameFloatProperty(GameProperty)
base classes bpy_struct, GameProperty class [Link](GameProperty) Game engine user dened oating pointer number property value Property value Type oat in [-10000, 10000], default 0.0
Inherited Properties

bpy_struct.id_data [Link] GameProperty.show_debug [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add 2.4. Types ([Link]) 489

Blender Index, Release 2.59.2 - API

2.4.237 GameIntProperty(GameProperty)
base classes bpy_struct, GameProperty class [Link](GameProperty) Game engine user dened integer number property value Property value Type int in [-10000, 10000], default 0
Inherited Properties

bpy_struct.id_data [Link] GameProperty.show_debug [Link]

Inherited Functions

490

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.238 GameObjectSettings(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Game engine related settings for the object actuators Game engine actuators to act on events Type bpy_prop_collection of Actuator, (readonly) collision_bounds_type Selects the collision type Type enum in [BOX, SPHERE, CYLINDER, CONE, CONVEX_HULL, TRIANGLE_MESH, CAPSULE], default BOX collision_margin Extra margin around object for collision detection, small amount required for stability Type oat in [0, 1], default 0.0 controllers Game engine controllers to process events, connecting sensor to actuators Type bpy_prop_collection of Controller, (readonly) create_obstacle Create representation for obstacle simulation Type boolean, default False damping General movement damping Type oat in [0, 1], default 0.0 form_factor Form factor scales the inertia tensor Type oat in [0, 1], default 0.0 friction_coefficients Relative friction coefcient in the in the X, Y and Z directions, when anisotropic friction is enabled Type oat array of 3 items in [0, 1], default (0.0, 0.0, 0.0) lock_location_x Disable simulation of linear motion along the X axis Type boolean, default False lock_location_y Disable simulation of linear motion along the Y axis Type boolean, default False lock_location_z Disable simulation of linear motion along the Z axis Type boolean, default False lock_rotation_x Disable simulation of angular motion along the X axis

2.4. Types ([Link])

491

Blender Index, Release 2.59.2 - API

Type boolean, default False lock_rotation_y Disable simulation of angular motion along the Y axis Type boolean, default False lock_rotation_z Disable simulation of angular motion along the Z axis Type boolean, default False mass Mass of the object Type oat in [0.01, 10000], default 0.0 obstacle_radius Radius of object representation in obstacle simulation Type oat in [0, 1000], default 0.0 physics_type Selects the type of physical representation NO_COLLISION No Collision, Disable collision for this object. STATIC Static, Stationary object. DYNAMIC Dynamic, Linear physics. RIGID_BODY Rigid Body, Linear and angular physics. SOFT_BODY Soft Body, Soft body. OCCLUDE Occlude, Occluder for optimizing scene rendering. SENSOR Sensor, Collision Sensor, detects static and dynamic objects but not the other collision sensor objects. NAVMESH Navigation Mesh, Navigation mesh. Type enum in [NO_COLLISION, STATIC, DYNAMIC, RIGID_BODY, SOFT_BODY, OCCLUDE, SENSOR, NAVMESH], default NO_COLLISION properties Game engine properties Type bpy_prop_collection of GameProperty, (readonly) radius Radius of bounding sphere and material physics Type oat in [0.01, 10], default 0.0 rotation_damping General rotation damping Type oat in [0, 1], default 0.0 sensors Game engine sensor to detect events Type bpy_prop_collection of Sensor, (readonly)

492

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

show_actuators Shows actuators for this object in the user interface Type boolean, default False show_controllers Shows controllers for this object in the user interface Type boolean, default False show_debug_state Print state debug info in the game engine Type boolean, default False show_sensors Shows sensors for this object in the user interface Type boolean, default False show_state_panel Show state panel Type boolean, default False soft_body Settings for Bullet soft body simulation Type GameSoftBodySettings, (readonly) states_initial Initial state when the game starts Type boolean array of 30 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False) states_visible State determining which controllers are displayed Type boolean array of 30 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False) use_activity_culling Disable simulation of angular motion along the Z axis Type boolean, default False use_actor Object is detected by the Near and Radar sensor Type boolean, default False use_all_states Set all state bits Type boolean, default False use_anisotropic_friction Enable anisotropic friction Type boolean, default False use_collision_bounds Specify a collision bounds type other than the default

2.4. Types ([Link])

493

Blender Index, Release 2.59.2 - API

Type boolean, default False use_collision_compound Add children to form a compound collision object Type boolean, default False use_ghost Object does not restitute collisions, like a ghost Type boolean, default False use_material_physics_fh React to force eld physics settings in materials Type boolean, default False use_rotate_from_normal Use face normal to rotate object, so that it points away from the surface Type boolean, default False use_sleep Disable auto (de)activation in physics simulation Type boolean, default False used_states States which are being used by controllers Type boolean array of 30 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False), (readonly) velocity_max Clamp velocity to this maximum speed Type oat in [0, 1000], default 0.0 velocity_min Clamp velocity to this minimum speed (except when totally still) Type oat in [0, 1000], default 0.0
Inherited Properties

bpy_struct.id_data
Inherited Functions

494

Chapter 2. Application Modules

497

Blender Index, Release 2.59.2 - API

Type string, default

Inherited Properties

bpy_struct.id_data [Link] GameProperty.show_debug [Link]

Inherited Functions

2.4.242 GameTimerProperty(GameProperty)
base classes bpy_struct, GameProperty class [Link](GameProperty) Game engine user dened timer property value Property value Type oat in [-10000, 10000], default 0.0
Inherited Properties

bpy_struct.id_data [Link] GameProperty.show_debug [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add 498 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.243 GlowSequence(EffectSequence)
base classes bpy_struct, Sequence, EffectSequence class [Link](EffectSequence) Sequence strip creating a glow effect blur_radius Radius of glow effect Type oat in [0.5, 20], default 0.0 boost_factor Brightness multiplier Type oat in [0, 10], default 0.0 clamp rightness limit of intensity Type oat in [0, 1], default 0.0 quality Accuracy of the blur effect Type int in [1, 5], default 0 threshold Minimum intensity to trigger a glow Type oat in [0, 1], default 0.0 use_only_boost Show the glow buffer only Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] Sequence.blend_type Sequence.blend_alpha [Link] 499

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

[Link] Sequence.effect_fader Sequence.frame_final_end Sequence.frame_offset_end Sequence.frame_still_end Sequence.input_1 Sequence.input_2 Sequence.input_3 Sequence.select_left_handle Sequence.frame_final_duration Sequence.frame_duration [Link] [Link] Sequence.select_right_handle [Link] Sequence.speed_factor Sequence.frame_start Sequence.frame_final_start Sequence.frame_offset_start Sequence.frame_still_start [Link] Sequence.use_default_fade Sequence.input_count EffectSequence.color_balance EffectSequence.use_float [Link] EffectSequence.use_deinterlace EffectSequence.use_reverse_frames EffectSequence.use_flip_x EffectSequence.use_flip_y EffectSequence.color_multiply EffectSequence.use_premultiply [Link] EffectSequence.use_proxy_custom_directory EffectSequence.use_proxy_custom_file EffectSequence.color_saturation [Link] [Link] EffectSequence.use_color_balance EffectSequence.use_crop EffectSequence.use_proxy EffectSequence.use_translation

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set

500

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values [Link] [Link]

2.4.244 GreasePencil(ID)
base classes bpy_struct, ID class [Link](ID) Freehand annotation sketchbook draw_mode CURSOR Cursor, Draw stroke at the 3D cursor. VIEW View, Stick stroke to the view . SURFACE Surface, Stick stroke to surfaces. STROKE Stroke, Stick stroke to other strokes. Type enum in [CURSOR, VIEW, SURFACE, STROKE], default VIEW layers Type GreasePencilLayers bpy_prop_collection of GPencilLayer, (readonly) use_stroke_endpoints Only use the rst and last parts of the stroke for snapping Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get 501

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

References

BlendData.grease_pencil [Link] NodeTree.grease_pencil Object.grease_pencil Scene.grease_pencil SpaceImageEditor.grease_pencil

2.4.245 GreasePencilLayers(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of grease pencil layers active Active grease pencil layer Type GreasePencil
Inherited Properties

bpy_struct.id_data
Inherited Functions

502

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

[Link]

2.4.246 Group(ID)
base classes bpy_struct, ID class [Link](ID) Group of Object datablocks dupli_offset Offset from the origin to use when instancing as DupliGroup Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) layers Layers visible when this groups is instanced as a dupli Type boolean array of 20 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False) objects A collection of this groups objects Type GroupObjects bpy_prop_collection of Object, (readonly) users_dupli_group The dupli group this group is used in (readonly)
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove

2.4. Types ([Link])

503

Blender Index, Release 2.59.2 - API

References

[Link] [Link] [Link] [Link] DopeSheet.filter_group [Link] Material.light_group Object.dupli_group ParticleSettings.dupli_group RenderLayer.light_override SceneRenderLayer.light_override SmokeDomainSettings.collision_group SmokeDomainSettings.effector_group SmokeDomainSettings.fluid_group

2.4.247 GroupInputs(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of group sockets new(name=Socket, type=VALUE) Add a socket to the group tree. Parameters name (string, (optional)) Name, Name of the socket type (enum in [VALUE, VECTOR, RGBA], (optional)) Type, Type of socket Returns New socket. Return type NodeSocket expose(sock=None, add_link=True) Expose an internal socket in the group tree.

504

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Parameters sock (NodeSocket, (optional)) Socket, Internal node socket to expose add_link (boolean, (optional)) Add Link, If TRUE, adds a link to the internal socket Returns New socket. Return type NodeSocket
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.248 GroupObjects(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of group objects link(object) Add this object to a group Parameters object (Object, (never None)) Object to add. unlink(object) Remove this object to a group Parameters object (Object) Object to remove.

2.4. Types ([Link])

505

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.249 GroupOutputs(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of group sockets new(name=Socket, type=VALUE) Add a socket to the group tree. Parameters name (string, (optional)) Name, Name of the socket type (enum in [VALUE, VECTOR, RGBA], (optional)) Type, Type of socket Returns New socket. Return type NodeSocket expose(sock=None, add_link=True) Expose an internal socket in the group tree. Parameters sock (NodeSocket, (optional)) Socket, Internal node socket to expose add_link (boolean, (optional)) Add Link, If TRUE, adds a link to the internal socket Returns New socket. 506 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Return type NodeSocket

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.250 Header(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Editor header containing UI elements. bl_idname If this is set, the header gets a custom ID, otherwise it takes the name of the class used to dene the panel. For example, if the class name is OBJECT_HT_hello, and bl_idname is not set by the script, then bl_idname = OBJECT_HT_hello Type string, default bl_space_type The space where the header is going to be used in. Type enum in [EMPTY, VIEW_3D, GRAPH_EDITOR, OUTLINER, PROPERTIES, FILE_BROWSER, IMAGE_EDITOR, INFO, SEQUENCE_EDITOR, TEXT_EDITOR, AUDIO_WINDOW, DOPESHEET_EDITOR, NLA_EDITOR, SCRIPTS_WINDOW, TIMELINE, NODE_EDITOR, LOGIC_EDITOR, CONSOLE, USER_PREFERENCES], default EMPTY

2.4. Types ([Link])

507

Blender Index, Release 2.59.2 - API

layout Denes the structure of the header in the UI. Type UILayout, (readonly) draw(context) Draw UI elements into the header UI layout.

classmethod append(draw_func) Append a draw function to this menu, takes the same arguments as the menus draw function. classmethod prepend(draw_func) Prepend a draw function to this menu, takes the same arguments as the menus draw function. classmethod remove(draw_func) Remove a draw function that has been added to this menu
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4.251 HemiLamp(Lamp)
base classes bpy_struct, ID, Lamp class [Link](Lamp) 180 degree constant lamp
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user 508 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link] [Link] [Link] Lamp.active_texture Lamp.active_texture_index Lamp.animation_data [Link] Lamp.use_diffuse [Link] [Link] Lamp.use_own_layer Lamp.use_negative Lamp.use_specular Lamp.texture_slots [Link]

Inherited Functions

2.4.252 Histogram(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Statistical view of the levels of color in an image mode Channels to display when drawing the histogram Type enum in [LUMA, RGB, R, G, B], default LUMA

2.4. Types ([Link])

509

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] SpaceImageEditor.sample_histogram

2.4.253 HookModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Hook modier to modify the location of vertices falloff If not zero, the distance from the hook where inuence ends Type oat in [0, inf], default 0.0 force Relative force of the hook Type oat in [0, 1], default 0.0 object Parent Object for hook, also recalculates and clears offset Type Object subtarget Name of Parent Bone for hook (if applicable), also recalculates and clears offset Type string, default

510

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

vertex_group Name of Vertex Group which determines inuence of modier per point Type string, default
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

2.4.254 ID(bpy_struct)
base class bpy_struct subclasses Lattice, Library, Key, NodeTree, MetaBall, Text, Lamp, World, Brush, Object, Armature, Mesh, VectorFont, GreasePencil, Sound, ParticleSettings, Scene, WindowManager, Texture, Curve, Action, Group, Screen, Speaker, Material, Image, Camera class [Link](bpy_struct) Base type for datablocks, dening a unique name, linking from other libraries and garbage collection library Library le the datablock is linked from Type Library, (readonly) name Unique datablock ID name

2.4. Types ([Link])

511

Blender Index, Release 2.59.2 - API

Type string, default tag Tools can use this to tag data, (initial state is undened) Type boolean, default False use_fake_user Saves this datablock even if it has no users Type boolean, default False users Number of times this datablock is referenced Type int in [0, 32767], default 0, (readonly) copy() Create a copy of this datablock (not supported for all datablocks). Returns New copy of the ID. Return type ID user_clear() Clears the user count of a datablock so its not saved, on reload the data will be removed. This function is for advanced use only, misuse can crash blender since the user count is used to prevent data being removed when it is used.
# This example shows what _not_ to do, and will crash blender. import bpy # object which is in the scene. obj = [Link]["Cube"] # without this, removal would raise an error. obj.user_clear() # runs without an exception # but will crash on redraw. [Link](obj)

animation_data_create() Create animation data to this ID, note that not all ID types support this. Returns New animation data or NULL. Return type AnimData animation_data_clear() Clear animation on this this ID. update_tag(refresh=set()) Tag the id to update its display data. Parameters refresh (enum set in {OBJECT, DATA, TIME}, (optional)) Type of updates to perform.
Inherited Properties

bpy_struct.id_data

512

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Functions

References

[Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] SpaceNodeEditor.id_from SpaceProperties.pin_id UILayout.template_path_builder UILayout.template_preview UILayout.template_preview

2.4.255 IDMaterials(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of materials append(material) Add a new material to the data block. Parameters material (Material) Material to add. pop(index, update_data=False) Remove a material from the data block. Parameters index (int in [0, 32767]) Index of material to remove. 2.4. Types ([Link]) 513

Blender Index, Release 2.59.2 - API

update_data (boolean, (optional)) Update data by re-adjusting the material slots assigned. Returns Material to remove. Return type Material
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] [Link] [Link]

2.4.256 IKParam(bpy_struct)
base class bpy_struct subclasses Itasc class [Link](bpy_struct) Base type for IK solver parameters ik_solver IK solver for which these parameters are dened, 0 for Legacy, 1 for iTaSC LEGACY Legacy, Original IK solver. ITASC iTaSC, Multi constraint, stateful IK solver. Type enum in [LEGACY, ITASC], default LEGACY, (readonly)

514

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Pose.ik_param

2.4.257 Image(ID)
base classes bpy_struct, ID class [Link](ID) Image datablock referencing an external or packed image bindcode OpenGL bindcode Type int in [0, inf], default 0, (readonly) depth Image bit depth Type int in [0, inf], default 0, (readonly) display_aspect Display Aspect for this image, does not affect rendering Type oat array of 2 items in [0.1, 5000], default (0.0, 0.0) field_order Order of video elds. Select which lines are displayed rst EVEN Upper First, Upper eld rst. ODD Lower First, Lower eld rst.

2.4. Types ([Link])

515

Blender Index, Release 2.59.2 - API

Type enum in [EVEN, ODD], default EVEN file_format Format used for re-saving this le BMP BMP, Output image in bitmap format. IRIS Iris, Output image in (old!) SGI IRIS format. PNG PNG, Output image in PNG format. JPEG JPEG, Output image in JPEG format. TARGA Targa, Output image in Targa format. TARGA_RAW Targa Raw, Output image in uncompressed Targa format. AVI_JPEG AVI JPEG, Output video in AVI JPEG format. AVI_RAW AVI Raw, Output video in AVI Raw format. Type enum in [BMP, IRIS, PNG, JPEG, TARGA, TARGA_RAW, AVI_JPEG, AVI_RAW], default TARGA filepath Image/Movie le name Type string, default filepath_raw Image/Movie le name (without data refreshing) Type string, default fps Speed of the animation in frames per second Type int in [1, 100], default 0 frame_end End frame of an animated texture Type int in [0, 128], default 0 frame_start Start frame of an animated texture Type int in [0, 128], default 0 generated_height Generated image height Type int in [1, 16384], default 0 generated_type Generated image type BLANK Blank, Generate a blank image. UV_GRID UV Grid, Generated grid to test UV mappings. COLOR_GRID Color Grid, Generated improved UV grid to test UV mappings. Type enum in [BLANK, UV_GRID, COLOR_GRID], default BLANK

516

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

generated_width Generated image width Type int in [1, 16384], default 0 has_data True if this image has data Type boolean, default False, (readonly) is_dirty Image has changed and is not saved Type boolean, default False, (readonly) mapping Mapping type to use for this image in the game engine UV UV Coordinates, Use UV coordinates for mapping the image. REFLECTION Reection, Use reection mapping for mapping the image. Type enum in [UV, REFLECTION], default UV packed_file Type PackedFile, (readonly) pixels Image pixels in oating point values Type oat in [-inf, inf], default 0.0 resolution X/Y pixels per meter Type oat array of 2 items in [-inf, inf], default (0.0, 0.0) size Width and height in pixels, zero when image data cant be loaded Type int array of 2 items in [-inf, inf], default (0, 0), (readonly) source Where the image comes from FILE Single Image, Single image le. SEQUENCE Image Sequence, Multiple image les, as a sequence. MOVIE Movie File, Movie le. GENERATED Generated, Generated image. VIEWER Viewer, Compositing node viewer. Type enum in [FILE, SEQUENCE, MOVIE, GENERATED, VIEWER], default FILE tiles_x Degree of repetition in the X direction Type int in [1, 16], default 0 tiles_y Degree of repetition in the Y direction

2.4. Types ([Link])

517

Blender Index, Release 2.59.2 - API

Type int in [1, 16], default 0 type How to generate the image Type enum in [IMAGE, MULTILAYER, UV_TEST, RENDER_RESULT, COMPOSITING], default IMAGE, (readonly) use_animation Use as animated texture in the game engine Type boolean, default False use_clamp_x Disable texture repeating horizontally Type boolean, default False use_clamp_y Disable texture repeating vertically Type boolean, default False use_fields Use elds of the image Type boolean, default False use_generated_float Generate oating point buffer Type boolean, default False use_premultiply Convert RGB from key alpha to premultiplied alpha Type boolean, default False use_tiles Use of tilemode for faces (default shift-LMB to pick the tile for selected faces) Type boolean, default False save_render(lepath, scene=None) Save image to a specic path using a scenes render settings Parameters lepath (string) Save path. scene (Scene, (optional)) Scene to take image parameters from save() Save image to its source path reload() Reload the image from its source path update() Update the display image from the oating point buffer gl_load(lter=9985, mag=9729) Load the image into OpenGL graphics memory Parameters lter (int in [-inf, inf], (optional)) Filter, The texture minifying function

518

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

mag (int in [-inf, inf], (optional)) Magnication, The texture magnication function Returns Error, OpenGL error value Return type int in [-inf, inf] gl_free() Free the image from OpenGL graphics memory
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

Inherited Functions

References

[Link] [Link] [Link] [Link] [Link] Brush.clone_image [Link] [Link] [Link] 519

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

[Link] [Link] [Link] UILayout.template_image_layers [Link] [Link]

2.4.258 ImagePaint(Paint)
base classes bpy_struct, Paint class [Link](Paint) Properties of image and texture painting mode invert_stencil Invert the stencil layer Type boolean, default False normal_angle Paint most on faces pointing towards the view according to this angle Type int in [0, 90], default 0 screen_grab_size Size to capture the image for re-projecting Type int array of 2 items in [512, 16384], default (0, 0) seam_bleed Extend paint beyond the faces UVs to reduce seams (in pixels, slower) Type int in [0, 32767], default 0 use_backface_culling Ignore faces pointing away from the view (faster) Type boolean, default False use_clone_layer Use another UV layer as clone source, otherwise use 3D the cursor as the source Type boolean, default False use_normal_falloff Paint most on faces pointing towards the view Type boolean, default False use_occlude Only paint onto the faces directly under the brush (slower) Type boolean, default False use_projection Use projection painting for improved consistency in the brush strokes Type boolean, default False use_stencil_layer Set the mask layer from the UV layer buttons Type boolean, default False

520

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data [Link] Paint.show_low_resolution Paint.show_brush Paint.show_brush_on_surface

Inherited Functions

References

ToolSettings.image_paint

2.4.259 ImageSequence(Sequence)
base classes bpy_struct, Sequence class [Link](Sequence) Sequence strip to load one or more images animation_offset_end Animation end offset (trim end) Type int in [0, inf], default 0 animation_offset_start Animation start offset (trim start) Type int in [0, inf], default 0 color_balance Type SequenceColorBalance, (readonly) color_multiply Type oat in [0, 20], default 0.0

2.4. Types ([Link])

521

Blender Index, Release 2.59.2 - API

color_saturation Type oat in [0, 20], default 0.0 crop Type SequenceCrop, (readonly) directory Type string, default elements Type bpy_prop_collection of SequenceElement, (readonly) proxy Type SequenceProxy, (readonly) strobe Only display every nth frame Type oat in [1, 30], default 0.0 transform Type SequenceTransform, (readonly) use_color_balance (3-Way color correction) on input Type boolean, default False use_crop Crop image before processing Type boolean, default False use_deinterlace For video movies to remove elds Type boolean, default False use_flip_x Flip on the X axis Type boolean, default False use_flip_y Flip on the Y axis Type boolean, default False use_float Convert input to oat data Type boolean, default False use_premultiply Convert RGB from key alpha to premultiplied alpha Type boolean, default False use_proxy Use a preview proxy and/or timecode index for this strip Type boolean, default False

522

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

use_proxy_custom_directory Use a custom directory to store data Type boolean, default False use_proxy_custom_file Use a custom le to read proxy data from Type boolean, default False use_reverse_frames Reverse frame order Type boolean, default False use_translation Translate image before processing Type boolean, default False
Inherited Properties

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove 2.4. Types ([Link]) 523

Blender Index, Release 2.59.2 - API

2.4.260 ImageTexture(Texture)
base classes bpy_struct, ID, Texture class [Link](Texture) checker_distance Sets distance between checker tiles Type oat in [0, 0.99], default 0.0 crop_max_x Sets maximum X value to crop the image Type oat in [-10, 10], default 0.0 crop_max_y Sets maximum Y value to crop the image Type oat in [-10, 10], default 0.0 crop_min_x Sets minimum X value to crop the image Type oat in [-10, 10], default 0.0 crop_min_y Sets minimum Y value to crop the image Type oat in [-10, 10], default 0.0 extension Sets how the image is extrapolated past its original bounds EXTEND Extend, Extends by repeating edge pixels of the image. CLIP Clip, Clips to image size and sets exterior pixels as transparent. CLIP_CUBE Clip Cube, Clips to cubic-shaped area around the image and sets exterior pixels as transparent. REPEAT Repeat, Causes the image to repeat horizontally and vertically. CHECKER Checker, Causes the image to repeat in checker board pattern.

524

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type enum in [EXTEND, CLIP, CLIP_CUBE, REPEAT, CHECKER], default EXTEND filter_eccentricity Maximum eccentricity. Higher gives less blur at distant/oblique angles, but is also slower Type int in [1, 256], default 0 filter_probes Maximum number of samples. Higher gives less blur at distant/oblique angles, but is also slower Type int in [1, 256], default 0 filter_size Multiplies the lter size used by MIP Map and Interpolation Type oat in [0.1, 50], default 0.0 filter_type Texture lter to use for sampling image Type enum in [BOX, EWA, FELINE, AREA], default BOX image Type Image image_user Parameters dening which layer, pass and frame of the image is displayed Type ImageUser, (readonly) invert_alpha Inverts all the alpha values in the image Type boolean, default False repeat_x Sets a repetition multiplier in the X direction Type int in [1, 512], default 0 repeat_y Sets a repetition multiplier in the Y direction Type int in [1, 512], default 0 use_alpha Uses the alpha channel information in the image Type boolean, default False use_calculate_alpha Calculates an alpha channel based on RGB values in the image Type boolean, default False use_checker_even Sets even checker tiles Type boolean, default False use_checker_odd Sets odd checker tiles Type boolean, default False

2.4. Types ([Link])

525

Blender Index, Release 2.59.2 - API

use_derivative_map Uses red and green as derivative values Type boolean, default False use_filter_size_min Use Filter Size as a minimal lter value in pixels Type boolean, default False use_flip_axis Flips the textures X and Y axis Type boolean, default False use_interpolation Interpolates pixels using selected lter Type boolean, default False use_mipmap Uses auto-generated MIP maps for the image Type boolean, default False use_mipmap_gauss Uses Gauss lter to sample down MIP maps Type boolean, default False use_mirror_x Mirrors the image repetition on the X direction Type boolean, default False use_mirror_y Mirrors the image repetition on the Y direction Type boolean, default False use_normal_map Uses image RGB values for normal mapping Type boolean, default False users_material Materials that use this texture (readonly) users_object_modifier Object modiers that use this texture (readonly)
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link] Texture.animation_data [Link] Texture.color_ramp

526

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link] Texture.factor_blue Texture.factor_green Texture.factor_red Texture.node_tree [Link] Texture.use_preview_alpha [Link] Texture.use_color_ramp Texture.use_nodes Texture.users_material Texture.users_object_modifier Texture.users_material Texture.users_object_modifier

Inherited Functions

2.4.261 ImageUser(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Parameters dening how an Image datablock is used by another datablock fields_per_frame The number of elds per rendered frame (2 elds is 1 image) Type int in [1, 200], default 0 frame_duration Sets the number of images of a movie to use

2.4. Types ([Link])

527

Blender Index, Release 2.59.2 - API

Type int in [0, 300000], default 0 frame_offset Offsets the number of the frame to use in the animation Type int in [-300000, 300000], default 0 frame_start Sets the global starting frame of the movie/sequence, assuming rst picture has a #1 Type int in [-300000, 300000], default 0 multilayer_layer Layer in multilayer image Type int in [0, 32767], default 0, (readonly) multilayer_pass Pass in multilayer image Type int in [0, 32767], default 0, (readonly) use_auto_refresh Always refresh image on frame changes Type boolean, default False use_cyclic Cycle the images in the movie Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

528

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

References

BackgroundImage.image_user EnvironmentMapTexture.image_user ImageTexture.image_user SpaceImageEditor.image_user UILayout.template_image UILayout.template_image_layers VoxelDataTexture.image_user

2.4.262 InowFluidSettings(FluidSettings)
base classes bpy_struct, FluidSettings class [Link](FluidSettings) Fluid simulation settings for objects adding uids in the simulation inflow_velocity Initial velocity of uid Type oat array of 3 items in [-1000.1, 1000.1], default (0.0, 0.0, 0.0) use Object contributes to the uid simulation Type boolean, default False use_animated_mesh Export this mesh as an animated one. Slower, only use if really necessary (e.g. armatures or parented objects), animated pos/rot/scale IPOs do not require it Type boolean, default False use_local_coords Use local coordinates for inow. (e.g. for rotating objects) Type boolean, default False volume_initialization Volume initialization type VOLUME Volume, Use only the inner volume of the mesh. SHELL Shell, Use only the outer shell of the mesh. BOTH Both, Use both the inner volume and the outer shell of the mesh. Type enum in [VOLUME, SHELL, BOTH], default VOLUME
Inherited Properties

bpy_struct.id_data [Link]
Inherited Functions

bpy_struct.as_pointer

2.4. Types ([Link])

529

Blender Index, Release 2.59.2 - API

2.4.263 IntProperty(Property)
base classes bpy_struct, Property class [Link](Property) RNA integer number property denition array_length Maximum length of the array, 0 means unlimited Type int in [0, inf], default 0, (readonly) default Default value for this number Type int in [-inf, inf], default 0, (readonly) default_array Default value for this array Type int array of 3 items in [-inf, inf], default (0, 0, 0), (readonly) hard_max Maximum value used by buttons Type int in [-inf, inf], default 0, (readonly) hard_min Minimum value used by buttons Type int in [-inf, inf], default 0, (readonly) soft_max Maximum value used by buttons Type int in [-inf, inf], default 0, (readonly) soft_min Minimum value used by buttons Type int in [-inf, inf], default 0, (readonly) step Step size used by number buttons, for oats 1/100th of the step size Type int in [0, inf], default 0, (readonly) 530 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

Inherited Functions

2.4.264 Itasc(IKParam)
base classes bpy_struct, IKParam class [Link](IKParam) Parameters for the iTaSC IK solver damping_epsilon Singular value under which damping is progressively applied. Higher values=more stability, less reactivity. Default=0.1 Type oat in [0, 1], default 0.0

2.4. Types ([Link])

531

Blender Index, Release 2.59.2 - API

damping_max Maximum damping coefcient when singular value is nearly 0. Higher values=more stability, less reactivity. Default=0.5 Type oat in [0, 1], default 0.0 feedback Feedback coefcient for error correction. Average response time=1/feedback. Default=20 Type oat in [0, 100], default 0.0 iterations Maximum number of iterations for convergence in case of reiteration Type int in [1, 1000], default 0 mode ANIMATION Animation, Stateless solver computing pose starting from current action and non-IK constraints. SIMULATION Simulation, Statefull solver running in real-time context and ignoring actions and nonIK constraints. Type enum in [ANIMATION, SIMULATION], default ANIMATION precision Precision of convergence in case of reiteration Type oat in [0, 0.1], default 0.0 reiteration_method Denes if the solver is allowed to reiterate (converges until precision is met) on none, rst or all frames NEVER Never, The solver does not reiterate, not even on rst frame (starts from rest pose). INITIAL Initial, The solver reiterates (converges) on the rst frame but not on subsequent frame. ALWAYS Always, The solver reiterates (converges) on all frames. Type enum in [NEVER, INITIAL, ALWAYS], default NEVER solver Solving method selection: Automatic damping or manual damping SDLS SDLS, Selective Damped Least Square. DLS DLS, Damped Least Square with Numerical Filtering. Type enum in [SDLS, DLS], default SDLS step_count Divides the frame interval into this many steps Type int in [1, 50], default 0 step_max Higher bound for timestep in second in case of automatic substeps Type oat in [0, 1], default 0.0 step_min Lower bound for timestep in second in case of automatic substeps

532

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type oat in [0, 0.1], default 0.0 use_auto_step Automatically determine the optimal number of steps for best performance/accuracy trade off Type boolean, default False velocity_max Maximum joint velocity in rad/s. Default=50 Type oat in [0, 100], default 0.0
Inherited Properties

bpy_struct.id_data IKParam.ik_solver
Inherited Functions

2.4.265 JoystickSensor(Sensor)
base classes bpy_struct, Sensor class [Link](Sensor) Sensor to detect joystick events axis_direction The direction of the axis Type enum in [RIGHTAXIS, UPAXIS, LEFTAXIS, DOWNAXIS], default RIGHTAXIS axis_number Specify which axis pair to use, 1 is usually the main direction input Type int in [1, 8], default 0 axis_threshold Specify the precision of the axis

2.4. Types ([Link])

533

Blender Index, Release 2.59.2 - API

Type int in [0, 32768], default 0 button_number Specify which button to use Type int in [0, 18], default 0 event_type The type of event this joystick sensor is triggered on Type enum in [BUTTON, AXIS, HAT, AXIS_SINGLE], default BUTTON hat_direction Specify hat direction Type enum in [UP, DOWN, LEFT, RIGHT, UPRIGHT, DOWNLEFT, UPLEFT, DOWNRIGHT], default UP hat_number Specify which hat to use Type int in [1, 2], default 0 joystick_index Specify which joystick to use Type int in [0, 7], default 0 single_axis_number Specify a single axis (verticle/horizontal/other) to detect Type int in [1, 16], default 0 use_all_events Triggered by all events on this joysticks current type (axis/button/hat) Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] Sensor.show_expanded [Link] [Link] Sensor.use_level [Link] Sensor.use_pulse_false_level Sensor.use_pulse_true_level Sensor.use_tap [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove

534

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.266 Key(ID)
base classes bpy_struct, ID class [Link](ID) Shape keys datablock containing different shapes of geometric datablocks animation_data Animation data for this datablock Type AnimData, (readonly) key_blocks Shape keys Type bpy_prop_collection of ShapeKey, (readonly) reference_key Type ShapeKey, (readonly, never None) slurph Creates a delay in amount of frames in applying keypositions, rst vertex goes rst Type int in [-500, 500], default 0 use_relative Makes shape keys relative Type boolean, default False user Datablock using these shape keys Type ID, (readonly, never None)
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

2.4. Types ([Link])

535

Blender Index, Release 2.59.2 - API

Inherited Functions

References

BlendData.shape_keys Curve.shape_keys Lattice.shape_keys Mesh.shape_keys

2.4.267 KeyCong(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Input conguration, including keymaps is_user_defined Indicates that a keycong was dened by the user Type boolean, default False, (readonly) keymaps Key maps congured as part of this conguration Type KeyMaps bpy_prop_collection of KeyMap, (readonly) name Name of the key conguration Type string, default

536

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] [Link] [Link] [Link] [Link] [Link] [Link]

2.4.268 KeyCongurations(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of KeyCongs active Active key conguration (preset) Type KeyConfig addon Key conguration that can be extended by addons, and is added to the active conguration when handling events Type KeyConfig, (readonly) default Default builtin key conguration

2.4. Types ([Link])

537

Blender Index, Release 2.59.2 - API

Type KeyConfig, (readonly) user Final key conguration that combines keymaps from the active and addon congurations, and can be edited by the user Type KeyConfig, (readonly) new(name) new Parameters name (string) Name Returns Key Conguration, Added key conguration. Return type KeyConfig remove(keycong) remove Parameters keycong (KeyConfig) Key Conguration, Removed key conguration.
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.269 KeyMap(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Input conguration, including keymaps 538 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

is_modal Indicates that a keymap is used for translate modal events for an operator Type boolean, default False, (readonly) is_user_modified Keymap is dened by the user Type boolean, default False keymap_items Items in the keymap, linking an operator to an input event Type KeyMapItems bpy_prop_collection of KeyMapItem, (readonly) name Name of the key map Type string, default , (readonly) region_type Optional region type keymap is associated with Type enum in [WINDOW, HEADER, CHANNELS, TEMPORARY, UI, TOOLS, TOOL_PROPS, PREVIEW], default WINDOW, (readonly) show_expanded_children Children expanded in the user interface Type boolean, default False show_expanded_items Expanded in the user interface Type boolean, default False space_type Optional space type keymap is associated with Type enum in [EMPTY, VIEW_3D, GRAPH_EDITOR, OUTLINER, PROPERTIES, FILE_BROWSER, IMAGE_EDITOR, INFO, SEQUENCE_EDITOR, TEXT_EDITOR, AUDIO_WINDOW, DOPESHEET_EDITOR, NLA_EDITOR, SCRIPTS_WINDOW, TIMELINE, NODE_EDITOR, LOGIC_EDITOR, CONSOLE, USER_PREFERENCES], default EMPTY, (readonly) active() active Returns Key Map, Active key map. Return type KeyMap restore_to_default() restore_to_default restore_item_to_default(item) restore_item_to_default Parameters item (KeyMapItem, (never None)) Item
Inherited Properties

bpy_struct.id_data

2.4. Types ([Link])

539

Blender Index, Release 2.59.2 - API

Inherited Functions

References

[Link] [Link] [Link] KeyMaps.find_modal [Link]

2.4.270 KeyMapItem(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Item in a Key Map active Activate or deactivate item Type boolean, default False alt Alt key pressed Type boolean, default False any Any modier keys pressed Type boolean, default False ctrl Control key pressed Type boolean, default False id ID of the item

540

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type int in [-32768, 32767], default 0, (readonly) idname Identier of operator to call on input event Type string, default is_user_defined Is this keymap item user dened (doesnt just replace a builtin item) Type boolean, default False, (readonly) is_user_modified Is this keymap item modied by the user Type boolean, default False, (readonly) key_modifier Regular key pressed as a modier Type enum in [NONE, LEFTMOUSE, MIDDLEMOUSE, RIGHTMOUSE, BUTTON4MOUSE, BUTTON5MOUSE, ACTIONMOUSE, SELECTMOUSE, MOUSEMOVE, INBETWEEN_MOUSEMOVE, TRACKPADPAN, TRACKPADZOOM, MOUSEROTATE, WHEELUPMOUSE, WHEELDOWNMOUSE, WHEELINMOUSE, WHEELOUTMOUSE, EVT_TWEAK_L, EVT_TWEAK_M, EVT_TWEAK_R, EVT_TWEAK_A, EVT_TWEAK_S, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, ZERO, ONE, TWO, THREE, FOUR, FIVE, SIX, SEVEN, EIGHT, NINE, LEFT_CTRL, LEFT_ALT, LEFT_SHIFT, RIGHT_ALT, RIGHT_CTRL, RIGHT_SHIFT, OSKEY, GRLESS, ESC, TAB, RET, SPACE, LINE_FEED, BACK_SPACE, DEL, SEMI_COLON, PERIOD, COMMA, QUOTE, ACCENT_GRAVE, MINUS, SLASH, BACK_SLASH, EQUAL, LEFT_BRACKET, RIGHT_BRACKET, LEFT_ARROW, DOWN_ARROW, RIGHT_ARROW, UP_ARROW, NUMPAD_2, NUMPAD_4, NUMPAD_6, NUMPAD_8, NUMPAD_1, NUMPAD_3, NUMPAD_5, NUMPAD_7, NUMPAD_9, NUMPAD_PERIOD, NUMPAD_SLASH, NUMPAD_ASTERIX, NUMPAD_0, NUMPAD_MINUS, NUMPAD_ENTER, NUMPAD_PLUS, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, PAUSE, INSERT, HOME, PAGE_UP, PAGE_DOWN, END, MEDIA_PLAY, MEDIA_STOP, MEDIA_FIRST, MEDIA_LAST, WINDOW_DEACTIVATE, TIMER, TIMER0, TIMER1, TIMER2, NDOF_BUTTON_MENU, NDOF_BUTTON_FIT, NDOF_BUTTON_TOP, NDOF_BUTTON_BOTTOM, NDOF_BUTTON_LEFT, NDOF_BUTTON_RIGHT, NDOF_BUTTON_FRONT, NDOF_BUTTON_BACK, NDOF_BUTTON_ISO1, NDOF_BUTTON_ISO2, NDOF_BUTTON_ROLL_CW, NDOF_BUTTON_ROLL_CCW, NDOF_BUTTON_SPIN_CW, NDOF_BUTTON_SPIN_CCW, NDOF_BUTTON_TILT_CW, NDOF_BUTTON_TILT_CCW, NDOF_BUTTON_ROTATE, NDOF_BUTTON_PANZOOM, NDOF_BUTTON_DOMINANT, NDOF_BUTTON_PLUS, NDOF_BUTTON_MINUS, NDOF_BUTTON_1, NDOF_BUTTON_2, NDOF_BUTTON_3, NDOF_BUTTON_4, NDOF_BUTTON_5, NDOF_BUTTON_6, NDOF_BUTTON_7, NDOF_BUTTON_8, NDOF_BUTTON_9, NDOF_BUTTON_10], default NONE map_type Type of event mapping Type enum in [KEYBOARD, TWEAK, MOUSE, NDOF, TEXTINPUT, TIMER], default KEYBOARD

2.4. Types ([Link])

541

Blender Index, Release 2.59.2 - API

name Name of operator to call on input event Type string, default , (readonly) oskey Operating system key pressed Type boolean, default False properties Properties to set when the operator is called Type OperatorProperties, (readonly) propvalue The value this event translates to in a modal keymap Type enum in [NONE], default NONE shift Shift key pressed Type boolean, default False show_expanded Show key map event and property details in the user interface Type boolean, default False type Type of event Type enum in [NONE, LEFTMOUSE, MIDDLEMOUSE, RIGHTMOUSE, BUTTON4MOUSE, BUTTON5MOUSE, ACTIONMOUSE, SELECTMOUSE, MOUSEMOVE, INBETWEEN_MOUSEMOVE, TRACKPADPAN, TRACKPADZOOM, MOUSEROTATE, WHEELUPMOUSE, WHEELDOWNMOUSE, WHEELINMOUSE, WHEELOUTMOUSE, EVT_TWEAK_L, EVT_TWEAK_M, EVT_TWEAK_R, EVT_TWEAK_A, EVT_TWEAK_S, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, ZERO, ONE, TWO, THREE, FOUR, FIVE, SIX, SEVEN, EIGHT, NINE, LEFT_CTRL, LEFT_ALT, LEFT_SHIFT, RIGHT_ALT, RIGHT_CTRL, RIGHT_SHIFT, OSKEY, GRLESS, ESC, TAB, RET, SPACE, LINE_FEED, BACK_SPACE, DEL, SEMI_COLON, PERIOD, COMMA, QUOTE, ACCENT_GRAVE, MINUS, SLASH, BACK_SLASH, EQUAL, LEFT_BRACKET, RIGHT_BRACKET, LEFT_ARROW, DOWN_ARROW, RIGHT_ARROW, UP_ARROW, NUMPAD_2, NUMPAD_4, NUMPAD_6, NUMPAD_8, NUMPAD_1, NUMPAD_3, NUMPAD_5, NUMPAD_7, NUMPAD_9, NUMPAD_PERIOD, NUMPAD_SLASH, NUMPAD_ASTERIX, NUMPAD_0, NUMPAD_MINUS, NUMPAD_ENTER, NUMPAD_PLUS, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, PAUSE, INSERT, HOME, PAGE_UP, PAGE_DOWN, END, MEDIA_PLAY, MEDIA_STOP, MEDIA_FIRST, MEDIA_LAST, WINDOW_DEACTIVATE, TIMER, TIMER0, TIMER1, TIMER2, NDOF_BUTTON_MENU, NDOF_BUTTON_FIT, NDOF_BUTTON_TOP, NDOF_BUTTON_BOTTOM, NDOF_BUTTON_LEFT, NDOF_BUTTON_RIGHT, NDOF_BUTTON_FRONT, NDOF_BUTTON_BACK, NDOF_BUTTON_ISO1, NDOF_BUTTON_ISO2, NDOF_BUTTON_ROLL_CW, NDOF_BUTTON_ROLL_CCW, NDOF_BUTTON_SPIN_CW, NDOF_BUTTON_SPIN_CCW, NDOF_BUTTON_TILT_CW,

542

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

NDOF_BUTTON_TILT_CCW, NDOF_BUTTON_ROTATE, NDOF_BUTTON_PANZOOM, NDOF_BUTTON_DOMINANT, NDOF_BUTTON_PLUS, NDOF_BUTTON_MINUS, NDOF_BUTTON_1, NDOF_BUTTON_2, NDOF_BUTTON_3, NDOF_BUTTON_4, NDOF_BUTTON_5, NDOF_BUTTON_6, NDOF_BUTTON_7, NDOF_BUTTON_8, NDOF_BUTTON_9, NDOF_BUTTON_10], default NONE value Type enum in [ANY, NOTHING, PRESS, RELEASE, CLICK, DOUBLE_CLICK], default NOTHING compare(item) compare Parameters item (KeyMapItem) Item Returns Comparison result Return type boolean
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

KeyMap.keymap_items KeyMap.restore_item_to_default [Link] KeyMapItems.from_id [Link] KeyMapItems.new_modal [Link]

2.4. Types ([Link])

543

Blender Index, Release 2.59.2 - API

2.4.271 KeyMapItems(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of keymap items new(idname, type, value, key_modier=NONE) new Parameters idname (string) Operator Identier type (enum in [NONE, LEFTMOUSE, MIDDLEMOUSE, RIGHTMOUSE, BUTTON4MOUSE, BUTTON5MOUSE, ACTIONMOUSE, SELECTMOUSE, MOUSEMOVE, INBETWEEN_MOUSEMOVE, TRACKPADPAN, TRACKPADZOOM, MOUSEROTATE, WHEELUPMOUSE, WHEELDOWNMOUSE, WHEELINMOUSE, WHEELOUTMOUSE, EVT_TWEAK_L, EVT_TWEAK_M, EVT_TWEAK_R, EVT_TWEAK_A, EVT_TWEAK_S, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, ZERO, ONE, TWO, THREE, FOUR, FIVE, SIX, SEVEN, EIGHT, NINE, LEFT_CTRL, LEFT_ALT, LEFT_SHIFT, RIGHT_ALT, RIGHT_CTRL, RIGHT_SHIFT, OSKEY, GRLESS, ESC, TAB, RET, SPACE, LINE_FEED, BACK_SPACE, DEL, SEMI_COLON, PERIOD, COMMA, QUOTE, ACCENT_GRAVE, MINUS, SLASH, BACK_SLASH, EQUAL, LEFT_BRACKET, RIGHT_BRACKET, LEFT_ARROW, DOWN_ARROW, RIGHT_ARROW, UP_ARROW, NUMPAD_2, NUMPAD_4, NUMPAD_6, NUMPAD_8, NUMPAD_1, NUMPAD_3, NUMPAD_5, NUMPAD_7, NUMPAD_9, NUMPAD_PERIOD, NUMPAD_SLASH, NUMPAD_ASTERIX, NUMPAD_0, NUMPAD_MINUS, NUMPAD_ENTER, NUMPAD_PLUS, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, PAUSE, INSERT, HOME, PAGE_UP, PAGE_DOWN, END, MEDIA_PLAY, MEDIA_STOP, MEDIA_FIRST, MEDIA_LAST, WINDOW_DEACTIVATE, TIMER, TIMER0, TIMER1, TIMER2, NDOF_BUTTON_MENU, NDOF_BUTTON_FIT, NDOF_BUTTON_TOP, NDOF_BUTTON_BOTTOM, NDOF_BUTTON_LEFT, NDOF_BUTTON_RIGHT, NDOF_BUTTON_FRONT, NDOF_BUTTON_BACK, NDOF_BUTTON_ISO1, NDOF_BUTTON_ISO2, NDOF_BUTTON_ROLL_CW, NDOF_BUTTON_ROLL_CCW, NDOF_BUTTON_SPIN_CW, NDOF_BUTTON_SPIN_CCW, NDOF_BUTTON_TILT_CW, NDOF_BUTTON_TILT_CCW, NDOF_BUTTON_ROTATE, NDOF_BUTTON_PANZOOM, NDOF_BUTTON_DOMINANT, NDOF_BUTTON_PLUS, NDOF_BUTTON_MINUS, NDOF_BUTTON_1, NDOF_BUTTON_2, NDOF_BUTTON_3, NDOF_BUTTON_4, NDOF_BUTTON_5, NDOF_BUTTON_6, NDOF_BUTTON_7, NDOF_BUTTON_8, NDOF_BUTTON_9, NDOF_BUTTON_10]) Type value (enum in [ANY, NOTHING, PRESS, RELEASE, CLICK, DOUBLE_CLICK]) Value any (boolean, (optional)) Any shift (boolean, (optional)) Shift ctrl (boolean, (optional)) Ctrl alt (boolean, (optional)) Alt any=False, shift=False, ctrl=False, alt=False, oskey=False,

544

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

oskey (boolean, (optional)) OS Key key_modier (enum in [NONE, LEFTMOUSE, MIDDLEMOUSE, RIGHTMOUSE, BUTTON4MOUSE, BUTTON5MOUSE, ACTIONMOUSE, SELECTMOUSE, MOUSEMOVE, INBETWEEN_MOUSEMOVE, TRACKPADPAN, TRACKPADZOOM, MOUSEROTATE, WHEELUPMOUSE, WHEELDOWNMOUSE, WHEELINMOUSE, WHEELOUTMOUSE, EVT_TWEAK_L, EVT_TWEAK_M, EVT_TWEAK_R, EVT_TWEAK_A, EVT_TWEAK_S, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, ZERO, ONE, TWO, THREE, FOUR, FIVE, SIX, SEVEN, EIGHT, NINE, LEFT_CTRL, LEFT_ALT, LEFT_SHIFT, RIGHT_ALT, RIGHT_CTRL, RIGHT_SHIFT, OSKEY, GRLESS, ESC, TAB, RET, SPACE, LINE_FEED, BACK_SPACE, DEL, SEMI_COLON, PERIOD, COMMA, QUOTE, ACCENT_GRAVE, MINUS, SLASH, BACK_SLASH, EQUAL, LEFT_BRACKET, RIGHT_BRACKET, LEFT_ARROW, DOWN_ARROW, RIGHT_ARROW, UP_ARROW, NUMPAD_2, NUMPAD_4, NUMPAD_6, NUMPAD_8, NUMPAD_1, NUMPAD_3, NUMPAD_5, NUMPAD_7, NUMPAD_9, NUMPAD_PERIOD, NUMPAD_SLASH, NUMPAD_ASTERIX, NUMPAD_0, NUMPAD_MINUS, NUMPAD_ENTER, NUMPAD_PLUS, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, PAUSE, INSERT, HOME, PAGE_UP, PAGE_DOWN, END, MEDIA_PLAY, MEDIA_STOP, MEDIA_FIRST, MEDIA_LAST, WINDOW_DEACTIVATE, TIMER, TIMER0, TIMER1, TIMER2, NDOF_BUTTON_MENU, NDOF_BUTTON_FIT, NDOF_BUTTON_TOP, NDOF_BUTTON_BOTTOM, NDOF_BUTTON_LEFT, NDOF_BUTTON_RIGHT, NDOF_BUTTON_FRONT, NDOF_BUTTON_BACK, NDOF_BUTTON_ISO1, NDOF_BUTTON_ISO2, NDOF_BUTTON_ROLL_CW, NDOF_BUTTON_ROLL_CCW, NDOF_BUTTON_SPIN_CW, NDOF_BUTTON_SPIN_CCW, NDOF_BUTTON_TILT_CW, NDOF_BUTTON_TILT_CCW, NDOF_BUTTON_ROTATE, NDOF_BUTTON_PANZOOM, NDOF_BUTTON_DOMINANT, NDOF_BUTTON_PLUS, NDOF_BUTTON_MINUS, NDOF_BUTTON_1, NDOF_BUTTON_2, NDOF_BUTTON_3, NDOF_BUTTON_4, NDOF_BUTTON_5, NDOF_BUTTON_6, NDOF_BUTTON_7, NDOF_BUTTON_8, NDOF_BUTTON_9, NDOF_BUTTON_10], (optional)) Key Modier Returns Item, Added key map item. Return type KeyMapItem new_modal(propvalue, type, value, any=False, shift=False, ctrl=False, alt=False, oskey=False, key_modier=NONE) new_modal Parameters propvalue (string) Property Value type (enum in [NONE, LEFTMOUSE, MIDDLEMOUSE, RIGHTMOUSE, BUTTON4MOUSE, BUTTON5MOUSE, ACTIONMOUSE, SELECTMOUSE, MOUSEMOVE, INBETWEEN_MOUSEMOVE, TRACKPADPAN, TRACKPADZOOM, MOUSEROTATE, WHEELUPMOUSE, WHEELDOWNMOUSE, WHEELINMOUSE, WHEELOUTMOUSE, EVT_TWEAK_L, EVT_TWEAK_M, EVT_TWEAK_R, EVT_TWEAK_A, EVT_TWEAK_S, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, ZERO, ONE, TWO, THREE, FOUR, FIVE, SIX, SEVEN, EIGHT, NINE, LEFT_CTRL, LEFT_ALT, LEFT_SHIFT, RIGHT_ALT, 2.4. Types ([Link]) 545

Blender Index, Release 2.59.2 - API

RIGHT_CTRL, RIGHT_SHIFT, OSKEY, GRLESS, ESC, TAB, RET, SPACE, LINE_FEED, BACK_SPACE, DEL, SEMI_COLON, PERIOD, COMMA, QUOTE, ACCENT_GRAVE, MINUS, SLASH, BACK_SLASH, EQUAL, LEFT_BRACKET, RIGHT_BRACKET, LEFT_ARROW, DOWN_ARROW, RIGHT_ARROW, UP_ARROW, NUMPAD_2, NUMPAD_4, NUMPAD_6, NUMPAD_8, NUMPAD_1, NUMPAD_3, NUMPAD_5, NUMPAD_7, NUMPAD_9, NUMPAD_PERIOD, NUMPAD_SLASH, NUMPAD_ASTERIX, NUMPAD_0, NUMPAD_MINUS, NUMPAD_ENTER, NUMPAD_PLUS, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, PAUSE, INSERT, HOME, PAGE_UP, PAGE_DOWN, END, MEDIA_PLAY, MEDIA_STOP, MEDIA_FIRST, MEDIA_LAST, WINDOW_DEACTIVATE, TIMER, TIMER0, TIMER1, TIMER2, NDOF_BUTTON_MENU, NDOF_BUTTON_FIT, NDOF_BUTTON_TOP, NDOF_BUTTON_BOTTOM, NDOF_BUTTON_LEFT, NDOF_BUTTON_RIGHT, NDOF_BUTTON_FRONT, NDOF_BUTTON_BACK, NDOF_BUTTON_ISO1, NDOF_BUTTON_ISO2, NDOF_BUTTON_ROLL_CW, NDOF_BUTTON_ROLL_CCW, NDOF_BUTTON_SPIN_CW, NDOF_BUTTON_SPIN_CCW, NDOF_BUTTON_TILT_CW, NDOF_BUTTON_TILT_CCW, NDOF_BUTTON_ROTATE, NDOF_BUTTON_PANZOOM, NDOF_BUTTON_DOMINANT, NDOF_BUTTON_PLUS, NDOF_BUTTON_MINUS, NDOF_BUTTON_1, NDOF_BUTTON_2, NDOF_BUTTON_3, NDOF_BUTTON_4, NDOF_BUTTON_5, NDOF_BUTTON_6, NDOF_BUTTON_7, NDOF_BUTTON_8, NDOF_BUTTON_9, NDOF_BUTTON_10]) Type value (enum in [ANY, NOTHING, PRESS, RELEASE, CLICK, DOUBLE_CLICK]) Value any (boolean, (optional)) Any shift (boolean, (optional)) Shift ctrl (boolean, (optional)) Ctrl alt (boolean, (optional)) Alt oskey (boolean, (optional)) OS Key key_modier (enum in [NONE, LEFTMOUSE, MIDDLEMOUSE, RIGHTMOUSE, BUTTON4MOUSE, BUTTON5MOUSE, ACTIONMOUSE, SELECTMOUSE, MOUSEMOVE, INBETWEEN_MOUSEMOVE, TRACKPADPAN, TRACKPADZOOM, MOUSEROTATE, WHEELUPMOUSE, WHEELDOWNMOUSE, WHEELINMOUSE, WHEELOUTMOUSE, EVT_TWEAK_L, EVT_TWEAK_M, EVT_TWEAK_R, EVT_TWEAK_A, EVT_TWEAK_S, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, ZERO, ONE, TWO, THREE, FOUR, FIVE, SIX, SEVEN, EIGHT, NINE, LEFT_CTRL, LEFT_ALT, LEFT_SHIFT, RIGHT_ALT, RIGHT_CTRL, RIGHT_SHIFT, OSKEY, GRLESS, ESC, TAB, RET, SPACE, LINE_FEED, BACK_SPACE, DEL, SEMI_COLON, PERIOD, COMMA, QUOTE, ACCENT_GRAVE, MINUS, SLASH, BACK_SLASH, EQUAL, LEFT_BRACKET, RIGHT_BRACKET, LEFT_ARROW, DOWN_ARROW, RIGHT_ARROW, UP_ARROW, NUMPAD_2, NUMPAD_4, NUMPAD_6, NUMPAD_8, NUMPAD_1, NUMPAD_3, NUMPAD_5, NUMPAD_7, NUMPAD_9, NUMPAD_PERIOD, NUMPAD_SLASH, NUMPAD_ASTERIX, NUMPAD_0, NUMPAD_MINUS, NUMPAD_ENTER, NUMPAD_PLUS, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, PAUSE, INSERT, HOME,

546

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

PAGE_UP, PAGE_DOWN, END, MEDIA_PLAY, MEDIA_STOP, MEDIA_FIRST, MEDIA_LAST, WINDOW_DEACTIVATE, TIMER, TIMER0, TIMER1, TIMER2, NDOF_BUTTON_MENU, NDOF_BUTTON_FIT, NDOF_BUTTON_TOP, NDOF_BUTTON_BOTTOM, NDOF_BUTTON_LEFT, NDOF_BUTTON_RIGHT, NDOF_BUTTON_FRONT, NDOF_BUTTON_BACK, NDOF_BUTTON_ISO1, NDOF_BUTTON_ISO2, NDOF_BUTTON_ROLL_CW, NDOF_BUTTON_ROLL_CCW, NDOF_BUTTON_SPIN_CW, NDOF_BUTTON_SPIN_CCW, NDOF_BUTTON_TILT_CW, NDOF_BUTTON_TILT_CCW, NDOF_BUTTON_ROTATE, NDOF_BUTTON_PANZOOM, NDOF_BUTTON_DOMINANT, NDOF_BUTTON_PLUS, NDOF_BUTTON_MINUS, NDOF_BUTTON_1, NDOF_BUTTON_2, NDOF_BUTTON_3, NDOF_BUTTON_4, NDOF_BUTTON_5, NDOF_BUTTON_6, NDOF_BUTTON_7, NDOF_BUTTON_8, NDOF_BUTTON_9, NDOF_BUTTON_10], (optional)) Key Modier Returns Item, Added key map item. Return type KeyMapItem remove(item) remove Parameters item (KeyMapItem) Item from_id(id) from_id Parameters id (int in [-inf, inf]) id, ID of the item Returns Item Return type KeyMapItem
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

547

Blender Index, Release 2.59.2 - API

References

KeyMap.keymap_items

2.4.272 KeyMaps(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of keymaps new(name, space_type=EMPTY, region_type=WINDOW, modal=False) new Parameters name (string) Name space_type (enum in [EMPTY, VIEW_3D, GRAPH_EDITOR, OUTLINER, PROPERTIES, FILE_BROWSER, IMAGE_EDITOR, INFO, SEQUENCE_EDITOR, TEXT_EDITOR, AUDIO_WINDOW, DOPESHEET_EDITOR, NLA_EDITOR, SCRIPTS_WINDOW, TIMELINE, NODE_EDITOR, LOGIC_EDITOR, CONSOLE, USER_PREFERENCES], (optional)) Space Type region_type (enum in [WINDOW, HEADER, CHANNELS, TEMPORARY, UI, TOOLS, TOOL_PROPS, PREVIEW], (optional)) Region Type modal (boolean, (optional)) Modal Returns Key Map, Added key map. Return type KeyMap find(name, space_type=EMPTY, region_type=WINDOW) nd Parameters name (string) Name space_type (enum in [EMPTY, VIEW_3D, GRAPH_EDITOR, OUTLINER, PROPERTIES, FILE_BROWSER, IMAGE_EDITOR, INFO, SEQUENCE_EDITOR, TEXT_EDITOR, AUDIO_WINDOW, DOPESHEET_EDITOR, NLA_EDITOR, SCRIPTS_WINDOW, TIMELINE, NODE_EDITOR, LOGIC_EDITOR, CONSOLE, USER_PREFERENCES], (optional)) Space Type region_type (enum in [WINDOW, HEADER, CHANNELS, TEMPORARY, UI, TOOLS, TOOL_PROPS, PREVIEW], (optional)) Region Type Returns Key Map, Corresponding key map. Return type KeyMap find_modal(name) nd_modal Parameters name (string) Operator Name Returns Key Map, Corresponding key map. Return type KeyMap 548 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.273 KeyboardSensor(Sensor)
base classes bpy_struct, Sensor class [Link](Sensor) Sensor to detect keyboard events key Type enum in [NONE, LEFTMOUSE, MIDDLEMOUSE, RIGHTMOUSE, BUTTON4MOUSE, BUTTON5MOUSE, ACTIONMOUSE, SELECTMOUSE, MOUSEMOVE, INBETWEEN_MOUSEMOVE, TRACKPADPAN, TRACKPADZOOM, MOUSEROTATE, WHEELUPMOUSE, WHEELDOWNMOUSE, WHEELINMOUSE, WHEELOUTMOUSE, EVT_TWEAK_L, EVT_TWEAK_M, EVT_TWEAK_R, EVT_TWEAK_A, EVT_TWEAK_S, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, ZERO, ONE, TWO, THREE, FOUR, FIVE, SIX, SEVEN, EIGHT, NINE, LEFT_CTRL, LEFT_ALT, LEFT_SHIFT, RIGHT_ALT, RIGHT_CTRL, RIGHT_SHIFT, OSKEY, GRLESS, ESC, TAB, RET, SPACE, LINE_FEED, BACK_SPACE, DEL, SEMI_COLON, PERIOD, COMMA, QUOTE, ACCENT_GRAVE, MINUS, SLASH, BACK_SLASH, EQUAL, LEFT_BRACKET, RIGHT_BRACKET, LEFT_ARROW, DOWN_ARROW, RIGHT_ARROW, UP_ARROW, NUMPAD_2, NUMPAD_4, NUMPAD_6, NUMPAD_8, NUMPAD_1, NUMPAD_3, NUMPAD_5, NUMPAD_7, NUMPAD_9, NUMPAD_PERIOD, NUMPAD_SLASH, NUMPAD_ASTERIX,

2.4. Types ([Link])

549

Blender Index, Release 2.59.2 - API

NUMPAD_0, NUMPAD_MINUS, NUMPAD_ENTER, NUMPAD_PLUS, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, PAUSE, INSERT, HOME, PAGE_UP, PAGE_DOWN, END, MEDIA_PLAY, MEDIA_STOP, MEDIA_FIRST, MEDIA_LAST, WINDOW_DEACTIVATE, TIMER, TIMER0, TIMER1, TIMER2, NDOF_BUTTON_MENU, NDOF_BUTTON_FIT, NDOF_BUTTON_TOP, NDOF_BUTTON_BOTTOM, NDOF_BUTTON_LEFT, NDOF_BUTTON_RIGHT, NDOF_BUTTON_FRONT, NDOF_BUTTON_BACK, NDOF_BUTTON_ISO1, NDOF_BUTTON_ISO2, NDOF_BUTTON_ROLL_CW, NDOF_BUTTON_ROLL_CCW, NDOF_BUTTON_SPIN_CW, NDOF_BUTTON_SPIN_CCW, NDOF_BUTTON_TILT_CW, NDOF_BUTTON_TILT_CCW, NDOF_BUTTON_ROTATE, NDOF_BUTTON_PANZOOM, NDOF_BUTTON_DOMINANT, NDOF_BUTTON_PLUS, NDOF_BUTTON_MINUS, NDOF_BUTTON_1, NDOF_BUTTON_2, NDOF_BUTTON_3, NDOF_BUTTON_4, NDOF_BUTTON_5, NDOF_BUTTON_6, NDOF_BUTTON_7, NDOF_BUTTON_8, NDOF_BUTTON_9, NDOF_BUTTON_10], default NONE log Property that indicates whether to log keystrokes as a string Type string, default modifier_key_1 Modier key code Type enum in [NONE, LEFTMOUSE, MIDDLEMOUSE, RIGHTMOUSE, BUTTON4MOUSE, BUTTON5MOUSE, ACTIONMOUSE, SELECTMOUSE, MOUSEMOVE, INBETWEEN_MOUSEMOVE, TRACKPADPAN, TRACKPADZOOM, MOUSEROTATE, WHEELUPMOUSE, WHEELDOWNMOUSE, WHEELINMOUSE, WHEELOUTMOUSE, EVT_TWEAK_L, EVT_TWEAK_M, EVT_TWEAK_R, EVT_TWEAK_A, EVT_TWEAK_S, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, ZERO, ONE, TWO, THREE, FOUR, FIVE, SIX, SEVEN, EIGHT, NINE, LEFT_CTRL, LEFT_ALT, LEFT_SHIFT, RIGHT_ALT, RIGHT_CTRL, RIGHT_SHIFT, OSKEY, GRLESS, ESC, TAB, RET, SPACE, LINE_FEED, BACK_SPACE, DEL, SEMI_COLON, PERIOD, COMMA, QUOTE, ACCENT_GRAVE, MINUS, SLASH, BACK_SLASH, EQUAL, LEFT_BRACKET, RIGHT_BRACKET, LEFT_ARROW, DOWN_ARROW, RIGHT_ARROW, UP_ARROW, NUMPAD_2, NUMPAD_4, NUMPAD_6, NUMPAD_8, NUMPAD_1, NUMPAD_3, NUMPAD_5, NUMPAD_7, NUMPAD_9, NUMPAD_PERIOD, NUMPAD_SLASH, NUMPAD_ASTERIX, NUMPAD_0, NUMPAD_MINUS, NUMPAD_ENTER, NUMPAD_PLUS, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, PAUSE, INSERT, HOME, PAGE_UP, PAGE_DOWN, END, MEDIA_PLAY, MEDIA_STOP, MEDIA_FIRST, MEDIA_LAST, WINDOW_DEACTIVATE, TIMER, TIMER0, TIMER1, TIMER2, NDOF_BUTTON_MENU, NDOF_BUTTON_FIT, NDOF_BUTTON_TOP, NDOF_BUTTON_BOTTOM, NDOF_BUTTON_LEFT, NDOF_BUTTON_RIGHT, NDOF_BUTTON_FRONT, NDOF_BUTTON_BACK, NDOF_BUTTON_ISO1, NDOF_BUTTON_ISO2, NDOF_BUTTON_ROLL_CW, NDOF_BUTTON_ROLL_CCW, NDOF_BUTTON_SPIN_CW, NDOF_BUTTON_SPIN_CCW, NDOF_BUTTON_TILT_CW, NDOF_BUTTON_TILT_CCW, NDOF_BUTTON_ROTATE, NDOF_BUTTON_PANZOOM, NDOF_BUTTON_DOMINANT, NDOF_BUTTON_PLUS, NDOF_BUTTON_MINUS, NDOF_BUTTON_1,

550

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

NDOF_BUTTON_2, NDOF_BUTTON_3, NDOF_BUTTON_4, NDOF_BUTTON_5, NDOF_BUTTON_6, NDOF_BUTTON_7, NDOF_BUTTON_8, NDOF_BUTTON_9, NDOF_BUTTON_10], default NONE modifier_key_2 Modier key code Type enum in [NONE, LEFTMOUSE, MIDDLEMOUSE, RIGHTMOUSE, BUTTON4MOUSE, BUTTON5MOUSE, ACTIONMOUSE, SELECTMOUSE, MOUSEMOVE, INBETWEEN_MOUSEMOVE, TRACKPADPAN, TRACKPADZOOM, MOUSEROTATE, WHEELUPMOUSE, WHEELDOWNMOUSE, WHEELINMOUSE, WHEELOUTMOUSE, EVT_TWEAK_L, EVT_TWEAK_M, EVT_TWEAK_R, EVT_TWEAK_A, EVT_TWEAK_S, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, ZERO, ONE, TWO, THREE, FOUR, FIVE, SIX, SEVEN, EIGHT, NINE, LEFT_CTRL, LEFT_ALT, LEFT_SHIFT, RIGHT_ALT, RIGHT_CTRL, RIGHT_SHIFT, OSKEY, GRLESS, ESC, TAB, RET, SPACE, LINE_FEED, BACK_SPACE, DEL, SEMI_COLON, PERIOD, COMMA, QUOTE, ACCENT_GRAVE, MINUS, SLASH, BACK_SLASH, EQUAL, LEFT_BRACKET, RIGHT_BRACKET, LEFT_ARROW, DOWN_ARROW, RIGHT_ARROW, UP_ARROW, NUMPAD_2, NUMPAD_4, NUMPAD_6, NUMPAD_8, NUMPAD_1, NUMPAD_3, NUMPAD_5, NUMPAD_7, NUMPAD_9, NUMPAD_PERIOD, NUMPAD_SLASH, NUMPAD_ASTERIX, NUMPAD_0, NUMPAD_MINUS, NUMPAD_ENTER, NUMPAD_PLUS, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, PAUSE, INSERT, HOME, PAGE_UP, PAGE_DOWN, END, MEDIA_PLAY, MEDIA_STOP, MEDIA_FIRST, MEDIA_LAST, WINDOW_DEACTIVATE, TIMER, TIMER0, TIMER1, TIMER2, NDOF_BUTTON_MENU, NDOF_BUTTON_FIT, NDOF_BUTTON_TOP, NDOF_BUTTON_BOTTOM, NDOF_BUTTON_LEFT, NDOF_BUTTON_RIGHT, NDOF_BUTTON_FRONT, NDOF_BUTTON_BACK, NDOF_BUTTON_ISO1, NDOF_BUTTON_ISO2, NDOF_BUTTON_ROLL_CW, NDOF_BUTTON_ROLL_CCW, NDOF_BUTTON_SPIN_CW, NDOF_BUTTON_SPIN_CCW, NDOF_BUTTON_TILT_CW, NDOF_BUTTON_TILT_CCW, NDOF_BUTTON_ROTATE, NDOF_BUTTON_PANZOOM, NDOF_BUTTON_DOMINANT, NDOF_BUTTON_PLUS, NDOF_BUTTON_MINUS, NDOF_BUTTON_1, NDOF_BUTTON_2, NDOF_BUTTON_3, NDOF_BUTTON_4, NDOF_BUTTON_5, NDOF_BUTTON_6, NDOF_BUTTON_7, NDOF_BUTTON_8, NDOF_BUTTON_9, NDOF_BUTTON_10], default NONE target Property that receive the keystrokes in case a string is logged Type string, default use_all_keys Trigger this sensor on any keystroke Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] Sensor.show_expanded

2.4. Types ([Link])

551

Blender Index, Release 2.59.2 - API

[Link] [Link] Sensor.use_level [Link] Sensor.use_pulse_false_level Sensor.use_pulse_true_level Sensor.use_tap [Link]

Inherited Functions

2.4.274 Keyframe(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Bezier curve point with two handles dening a Keyframe on an F-Curve co Coordinates of the control point Type oat array of 2 items in [-inf, inf], default (0.0, 0.0) handle_left Coordinates of the left handle (before the control point) Type oat array of 2 items in [-inf, inf], default (0.0, 0.0) handle_left_type Handle types FREE Free. VECTOR Vector. ALIGNED Aligned. AUTO Automatic.

552

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

AUTO_CLAMPED Auto Clamped, Auto handles clamped to not overshoot. Type enum in [FREE, VECTOR, ALIGNED, AUTO, AUTO_CLAMPED], default FREE handle_right Coordinates of the right handle (after the control point) Type oat array of 2 items in [-inf, inf], default (0.0, 0.0) handle_right_type Handle types FREE Free. VECTOR Vector. ALIGNED Aligned. AUTO Automatic. AUTO_CLAMPED Auto Clamped, Auto handles clamped to not overshoot. Type enum in [FREE, VECTOR, ALIGNED, AUTO, AUTO_CLAMPED], default FREE interpolation Interpolation method to use for segment of the curve from this Keyframe until the next Keyframe Type enum in [CONSTANT, LINEAR, BEZIER], default CONSTANT select_control_point Control point selection status Type boolean, default False select_left_handle Left handle selection status Type boolean, default False select_right_handle Right handle selection status Type boolean, default False type The type of keyframe (for visual purposes only Type enum in [KEYFRAME, BREAKDOWN, EXTREME, JITTER], default KEYFRAME
Inherited Properties

bpy_struct.id_data

2.4. Types ([Link])

553

Blender Index, Release 2.59.2 - API

Inherited Functions

References

FCurve.keyframe_points [Link] [Link]

2.4.275 KeyingSet(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Settings that should be keyframed together bl_options Keying set options INSERTKEY_NEEDED Insert Keyframes - Only Needed, Only insert keyframes where theyre needed in the relevant F-Curves. INSERTKEY_VISUAL Insert Keyframes - Visual, Insert keyframes based on visual transforms. INSERTKEY_XYZ_TO_RGB F-Curve Colors - XYZ to RGB, Color for newly added transformation F-Curves (Location, Rotation, Scale) and also Color is based on the transform axis. Type enum set in {INSERTKEY_NEEDED, INSERTKEY_VISUAL, SERTKEY_XYZ_TO_RGB}, default {INSERTKEY_NEEDED} is_path_absolute Keying Set denes specic paths/settings to be keyframed (i.e. is not reliant on context info) Type boolean, default False, (readonly) name Type string, default IN-

554

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

paths Keying Set Paths to dene settings that get keyframed together Type KeyingSetPaths bpy_prop_collection of KeyingSetPath, (readonly) type_info Callback function denes for built-in Keying Sets Type KeyingSetInfo, (readonly) refresh() Refresh Keying Set to ensure that it is valid for the current context. Call before each use of one
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] [Link] [Link] [Link] [Link] Scene.keying_sets Scene.keying_sets_all

2.4.276 KeyingSetInfo(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Callback function denes for builtin Keying Sets

2.4. Types ([Link])

555

Blender Index, Release 2.59.2 - API

bl_idname Type string, default bl_label Type string, default bl_options Keying set options INSERTKEY_NEEDED Insert Keyframes - Only Needed, Only insert keyframes where theyre needed in the relevant F-Curves. INSERTKEY_VISUAL Insert Keyframes - Visual, Insert keyframes based on visual transforms. INSERTKEY_XYZ_TO_RGB F-Curve Colors - XYZ to RGB, Color for newly added transformation F-Curves (Location, Rotation, Scale) and also Color is based on the transform axis. Type enum set in {INSERTKEY_NEEDED, INSERTKEY_VISUAL, SERTKEY_XYZ_TO_RGB}, default {INSERTKEY_NEEDED} poll(context) Test if Keying Set can be used or not Return type boolean iterator(context, ks) Call generate() on the structs which have properties to be keyframed IN-

generate(context, ks, data) Add Paths to the Keying Set to keyframe the properties of the given data

Inherited Properties

bpy_struct.id_data
Inherited Functions

556

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.values
References

KeyingSet.type_info

2.4.277 KeyingSetPath(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Path to a setting for use in a Keying Set array_index Index to the specic setting if applicable Type int in [-inf, inf], default 0 bl_options Keying set options INSERTKEY_NEEDED Insert Keyframes - Only Needed, Only insert keyframes where theyre needed in the relevant F-Curves. INSERTKEY_VISUAL Insert Keyframes - Visual, Insert keyframes based on visual transforms. INSERTKEY_XYZ_TO_RGB F-Curve Colors - XYZ to RGB, Color for newly added transformation F-Curves (Location, Rotation, Scale) and also Color is based on the transform axis. Type enum set in {INSERTKEY_NEEDED, INSERTKEY_VISUAL, SERTKEY_XYZ_TO_RGB}, default {INSERTKEY_NEEDED} data_path Path to property setting Type string, default group Name of Action Group to assign setting(s) for this path to Type string, default group_method Method used to dene which Group-name to use Type enum in [NAMED, NONE, KEYINGSET], default NAMED id ID-Block that keyframes for Keying Set should be added to (for Absolute Keying Sets only) Type ID id_type Type of ID-block that can be used Type enum in [ACTION, ARMATURE, BRUSH, CAMERA, CURVE, FONT, GREASEPENCIL, GROUP, IMAGE, KEY, LAMP, LIBRARY, LATTICE, MATERIAL, META, MESH, NODETREE, OBJECT, PARTICLE, SCENE, SCREEN, SPEAKER, SOUND, TEXT, TEXTURE, WORLD, WINDOWMANAGER], default OBJECT IN-

2.4. Types ([Link])

557

Blender Index, Release 2.59.2 - API

use_entire_array When an array/vector type is chosen (Location, Rotation, Color, etc.), entire array is to be used Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] [Link] [Link] [Link]

2.4.278 KeyingSetPaths(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of keying set paths active Active Keying Set used to insert/delete keyframes Type KeyingSetPath active_index Current Keying Set index Type int in [-inf, inf], default 0 add(target_id, data_path, index=-1, group_method=KEYINGSET, group_name=) Add a new path for the Keying Set. 558 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Parameters target_id (ID) Target ID, ID-Datablock for the destination. data_path (string) Data-Path, RNA-Path to destination property. index (int in [-1, inf], (optional)) Index, The index of the destination property (i.e. axis of Location/Rotation/etc.), or -1 for the entire array. group_method (enum in [NAMED, NONE, KEYINGSET], (optional)) Grouping Method, Method used to dene which Group-name to use. group_name (string, (optional)) Group Name, Name of Action Group to assign destination to (only if grouping mode is to use this name). Returns New Path, Path created and added to the Keying Set Return type KeyingSetPath remove(path) Remove the given path from the Keying Set. Parameters path (KeyingSetPath, (never None)) Path clear() Remove all the paths from the Keying Set.
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4. Types ([Link])

559

Blender Index, Release 2.59.2 - API

2.4.279 KeyingSets(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Scene keying sets active Active Keying Set used to insert/delete keyframes Type KeyingSet active_index Current Keying Set index (negative for builtin and positive for absolute) Type int in [-inf, inf], default 0 new(name=KeyingSet) Add a new Keying Set to Scene. Parameters name (string, (optional)) Name, Name of Keying Set Returns Newly created Keying Set. Return type KeyingSet
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Scene.keying_sets

560

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.280 KeyingSetsAll(bpy_struct)
base class bpy_struct class [Link](bpy_struct) All available keying sets active Active Keying Set used to insert/delete keyframes Type KeyingSet active_index Current Keying Set index (negative for builtin and positive for absolute) Type int in [-inf, inf], default 0
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Scene.keying_sets_all

2.4.281 KinematicConstraint(Constraint)
base classes bpy_struct, Constraint class [Link](Constraint) Inverse Kinematics chain_count How many bones are included in the IK effect - 0 uses all bones

2.4. Types ([Link])

561

Blender Index, Release 2.59.2 - API

Type int in [0, 255], default 0 distance Radius of limiting sphere Type oat in [0, 100], default 0.0 ik_type Type enum in [COPY_POSE, DISTANCE], default COPY_POSE iterations Maximum number of solving iterations Type int in [1, 10000], default 0 limit_mode Distances in relation to sphere of inuence to allow LIMITDIST_INSIDE Inside, The object is constrained inside a virtual sphere around the target object, with a radius dened by the limit distance. LIMITDIST_OUTSIDE Outside, The object is constrained outside a virtual sphere around the target object, with a radius dened by the limit distance. LIMITDIST_ONSURFACE On Surface, The object is constrained on the surface of a virtual sphere around the target object, with a radius dened by the limit distance. Type enum in [LIMITDIST_INSIDE, LIMITDIST_OUTSIDE, DIST_ONSURFACE], default LIMITDIST_INSIDE lock_location_x Constraint position along X axis Type boolean, default False lock_location_y Constraint position along Y axis Type boolean, default False lock_location_z Constraint position along Z axis Type boolean, default False lock_rotation_x Constraint rotation along X axis Type boolean, default False lock_rotation_y Constraint rotation along Y axis Type boolean, default False lock_rotation_z Constraint rotation along Z axis Type boolean, default False orient_weight For Tree-IK: Weight of orientation control for this target Type oat in [0.01, 1], default 0.0 LIMIT-

562

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

pole_angle Pole rotation offset Type oat in [-3.14159, 3.14159], default 0.0 pole_subtarget Type string, default pole_target Object for pole rotation Type Object reference_axis Constraint axis Lock options relative to Bone or Target reference Type enum in [BONE, TARGET], default BONE subtarget Type string, default target Target Object Type Object use_location Chain follows position of target Type boolean, default False use_rotation Chain follows rotation of target Type boolean, default False use_stretch Enable IK Stretching Type boolean, default False use_tail Include bones tail as last element in chain Type boolean, default False use_target Disable for targetless IK Type boolean, default False weight For Tree-IK: Weight of position control for this target Type oat in [0.01, 1], default 0.0
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link]

2.4. Types ([Link])

563

Blender Index, Release 2.59.2 - API

Constraint.show_expanded [Link] Constraint.error_location Constraint.owner_space Constraint.is_proxy_local Constraint.error_rotation Constraint.target_space [Link] Constraint.is_valid

Inherited Functions

2.4.282 Lamp(ID)
base classes bpy_struct, ID subclasses SpotLamp, AreaLamp, HemiLamp, PointLamp, SunLamp class [Link](ID) Lamp datablock for lighting a scene active_texture Active texture slot being displayed Type Texture active_texture_index Index of active texture slot Type int in [0, 17], default 0 animation_data Animation data for this datablock Type AnimData, (readonly) color Light color Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)

564

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

distance Falloff distance - the light is at half the original intensity at this point Type oat in [0, inf], default 0.0 energy Amount of light that the lamp emits Type oat in [-inf, inf], default 0.0 texture_slots Texture slots dening the mapping and inuence of textures Type LampTextureSlots bpy_prop_collection of LampTextureSlot, (readonly) type Type of Lamp POINT Point, Omnidirectional point light source. SUN Sun, Constant direction parallel ray light source. SPOT Spot, Directional cone light source. HEMI Hemi, 180 degree constant light source. AREA Area, Directional area light source. Type enum in [POINT, SUN, SPOT, HEMI, AREA], default POINT use_diffuse Lamp does diffuse shading Type boolean, default False use_negative Lamp casts negative light Type boolean, default False use_own_layer Illuminates objects only on the same layer the lamp is on Type boolean, default False use_specular Lamp creates specular highlights Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

2.4. Types ([Link])

565

Blender Index, Release 2.59.2 - API

Inherited Functions

References

[Link] [Link] [Link]

2.4.283 LampSkySettings(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Sky related settings for a sun lamp atmosphere_distance_factor Multiplier to convert blender units to physical distance Type oat in [0, 500], default 0.0 atmosphere_extinction Extinction scattering contribution factor Type oat in [0, 1], default 0.0 atmosphere_inscattering Scatter contribution factor Type oat in [0, 1], default 0.0 atmosphere_turbidity Sky turbidity Type oat in [1, 30], default 0.0

566

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

backscattered_light Backscattered light Type oat in [-1, 1], default 0.0 horizon_brightness Horizon brightness Type oat in [0, 20], default 0.0 sky_blend Blend factor with sky Type oat in [0, 2], default 0.0 sky_blend_type Blend mode for combining sun sky with world sky Type enum in [MIX, ADD, MULTIPLY, SUBTRACT, SCREEN, DIVIDE, DIFFERENCE, DARKEN, LIGHTEN, OVERLAY, DODGE, BURN, HUE, SATURATION, VALUE, COLOR, SOFT_LIGHT, LINEAR_LIGHT], default MIX sky_color_space Color space to use for internal XYZ->RGB color conversion Type enum in [SMPTE, REC709, CIE], default SMPTE sky_exposure Strength of sky shading exponential exposure correction Type oat in [0, 20], default 0.0 spread Horizon Spread Type oat in [0, 10], default 0.0 sun_brightness Sun brightness Type oat in [0, 10], default 0.0 sun_intensity Sun intensity Type oat in [0, 10], default 0.0 sun_size Sun size Type oat in [0, 10], default 0.0 use_atmosphere Apply sun effect on atmosphere Type boolean, default False use_sky Apply sun effect on sky Type boolean, default False

2.4. Types ([Link])

567

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.284 LampTextureSlot(TextureSlot)
base classes bpy_struct, TextureSlot class [Link](TextureSlot) Texture slot for textures in a Lamp datablock color_factor Amount texture affects color values Type oat in [-inf, inf], default 0.0 object Object to use for mapping with Object texture coordinates Type Object shadow_factor Amount texture affects shadow Type oat in [-inf, inf], default 0.0 texture_coords GLOBAL Global, Uses global coordinates for the texture coordinates. VIEW View, Uses view coordinates for the texture coordinates. OBJECT Object, Uses linked objects coordinates for texture coordinates.

568

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type enum in [GLOBAL, VIEW, OBJECT], default GLOBAL use_map_color Lets the texture affect the basic color of the lamp Type boolean, default False use_map_shadow Lets the texture affect the shadow color of the lamp Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] TextureSlot.blend_type [Link] TextureSlot.default_value [Link] [Link] TextureSlot.output_node TextureSlot.use_rgb_to_intensity [Link] TextureSlot.use_stencil [Link]

Inherited Functions

References

Lamp.texture_slots [Link] [Link]

2.4. Types ([Link])

569

Blender Index, Release 2.59.2 - API

2.4.285 LampTextureSlots(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of texture slots classmethod add() add Returns The newly initialized mtex. Return type LampTextureSlot classmethod create(index) create Parameters index (int in [0, inf]) Index, Slot index to initialize. Returns The newly initialized mtex. Return type LampTextureSlot classmethod clear(index) clear Parameters index (int in [0, inf]) Index, Slot index to clear.
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Lamp.texture_slots

570

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.286 Lattice(ID)
base classes bpy_struct, ID class [Link](ID) Lattice datablock dening a grid for deforming other objects animation_data Animation data for this datablock Type AnimData, (readonly) interpolation_type_u Type enum in [KEY_LINEAR, KEY_LINEAR interpolation_type_v Type enum in [KEY_LINEAR, KEY_LINEAR interpolation_type_w Type enum in [KEY_LINEAR, KEY_LINEAR points Points of the lattice Type bpy_prop_collection of LatticePoint, (readonly) points_u Points in U direction (cant be changed when there are shape keys) Type int in [1, 64], default 0 points_v Points in V direction (cant be changed when there are shape keys) Type int in [1, 64], default 0 points_w Points in W direction (cant be changed when there are shape keys) Type int in [1, 64], default 0 shape_keys Type Key, (readonly) use_outside Only draw, and take into account, the outer vertices Type boolean, default False vertex_group Vertex group to apply the inuence of the lattice Type string, default
Inherited Properties

KEY_CARDINAL,

KEY_BSPLINE],

default

KEY_CARDINAL,

KEY_BSPLINE],

default

KEY_CARDINAL,

KEY_BSPLINE],

default

bpy_struct.id_data

2.4. Types ([Link])

571

Blender Index, Release 2.59.2 - API

[Link] ID.use_fake_user [Link] [Link] [Link]

Inherited Functions

References

[Link] [Link] [Link]

2.4.287 LatticeModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Lattice deformation modier object Lattice object to deform with Type Object vertex_group Name of Vertex Group which determines inuence of modier per point Type string, default

572

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

2.4.288 LatticePoint(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Point in the lattice grid co Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0), (readonly) co_deform Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) groups Weights for the vertex groups this point is member of Type bpy_prop_collection of VertexGroupElement, (readonly)
Inherited Properties

bpy_struct.id_data

2.4. Types ([Link])

573

Blender Index, Release 2.59.2 - API

Inherited Functions

References

[Link]

2.4.289 Library(ID)
base classes bpy_struct, ID class [Link](ID) External .blend le from which data is linked filepath Path to the library .blend le Type string, default parent Type Library, (readonly) users_id ID datablocks which use this library (readonly)
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

574

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Functions

References

[Link] [Link] [Link]

2.4.290 LimitDistanceConstraint(Constraint)
base classes bpy_struct, Constraint class [Link](Constraint) Limits the distance from target object distance Radius of limiting sphere Type oat in [0, 100], default 0.0 head_tail Target along length of bone: Head=0, Tail=1 Type oat in [0, 1], default 0.0 limit_mode Distances in relation to sphere of inuence to allow LIMITDIST_INSIDE Inside, The object is constrained inside a virtual sphere around the target object, with a radius dened by the limit distance. LIMITDIST_OUTSIDE Outside, The object is constrained outside a virtual sphere around the target object, with a radius dened by the limit distance.

2.4. Types ([Link])

575

Blender Index, Release 2.59.2 - API

LIMITDIST_ONSURFACE On Surface, The object is constrained on the surface of a virtual sphere around the target object, with a radius dened by the limit distance. Type enum in [LIMITDIST_INSIDE, LIMITDIST_OUTSIDE, DIST_ONSURFACE], default LIMITDIST_INSIDE subtarget Type string, default target Target Object Type Object use_transform_limit Transforms are affected by this constraint as well Type boolean, default False
Inherited Properties

LIMIT-

Inherited Functions

576

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.291 LimitLocationConstraint(Constraint)
base classes bpy_struct, Constraint class [Link](Constraint) Limits the location of the constrained object max_x Highest X value to allow Type oat in [-1000, 1000], default 0.0 max_y Highest Y value to allow Type oat in [-1000, 1000], default 0.0 max_z Highest Z value to allow Type oat in [-1000, 1000], default 0.0 min_x Lowest X value to allow Type oat in [-1000, 1000], default 0.0 min_y Lowest Y value to allow Type oat in [-1000, 1000], default 0.0 min_z Lowest Z value to allow Type oat in [-1000, 1000], default 0.0 use_max_x Use the maximum X value Type boolean, default False use_max_y Use the maximum Y value Type boolean, default False use_max_z Use the maximum Z value Type boolean, default False use_min_x Use the minimum X value Type boolean, default False use_min_y Use the minimum Y value Type boolean, default False use_min_z Use the minimum Z value Type boolean, default False

2.4. Types ([Link])

577

Blender Index, Release 2.59.2 - API

use_transform_limit Transforms are affected by this constraint as well Type boolean, default False
Inherited Properties

Inherited Functions

2.4.292 LimitRotationConstraint(Constraint)
base classes bpy_struct, Constraint class [Link](Constraint) Limits the rotation of the constrained object max_x Highest X value to allow Type oat in [-1000, 1000], default 0.0 max_y Highest Y value to allow 578 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type oat in [-1000, 1000], default 0.0 max_z Highest Z value to allow Type oat in [-1000, 1000], default 0.0 min_x Lowest X value to allow Type oat in [-1000, 1000], default 0.0 min_y Lowest Y value to allow Type oat in [-1000, 1000], default 0.0 min_z Lowest Z value to allow Type oat in [-1000, 1000], default 0.0 use_limit_x Use the minimum X value Type boolean, default False use_limit_y Use the minimum Y value Type boolean, default False use_limit_z Use the minimum Z value Type boolean, default False use_transform_limit Transforms are affected by this constraint as well Type boolean, default False
Inherited Properties

2.4. Types ([Link])

579

Blender Index, Release 2.59.2 - API

Inherited Functions

2.4.293 LimitScaleConstraint(Constraint)
base classes bpy_struct, Constraint class [Link](Constraint) Limits the scaling of the constrained object max_x Highest X value to allow Type oat in [-1000, 1000], default 0.0 max_y Highest Y value to allow Type oat in [-1000, 1000], default 0.0 max_z Highest Z value to allow Type oat in [-1000, 1000], default 0.0 min_x Lowest X value to allow Type oat in [-1000, 1000], default 0.0 min_y Lowest Y value to allow Type oat in [-1000, 1000], default 0.0 min_z Lowest Z value to allow Type oat in [-1000, 1000], default 0.0 use_max_x Use the maximum X value Type boolean, default False

580

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

use_max_y Use the maximum Y value Type boolean, default False use_max_z Use the maximum Z value Type boolean, default False use_min_x Use the minimum X value Type boolean, default False use_min_y Use the minimum Y value Type boolean, default False use_min_z Use the minimum Z value Type boolean, default False use_transform_limit Transforms are affected by this constraint as well Type boolean, default False
Inherited Properties

Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.294 LockedTrackConstraint(Constraint)
base classes bpy_struct, Constraint class [Link](Constraint) Points toward the target along the track axis, while locking the other axis head_tail Target along length of bone: Head=0, Tail=1 Type oat in [0, 1], default 0.0 lock_axis Axis that points upward Type enum in [LOCK_X, LOCK_Y, LOCK_Z], default LOCK_X subtarget Type string, default target Target Object Type Object track_axis Axis that points to the target object Type enum in [TRACK_X, TRACK_Y, TRACK_Z, TRACK_NEGATIVE_X, TRACK_NEGATIVE_Y, TRACK_NEGATIVE_Z], default TRACK_X
Inherited Properties

582

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Functions

2.4.295 Macro(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Storage of a macro operator being executed, or registered after execution bl_description Type string, default bl_idname Type string, default bl_label Type string, default bl_options Options for this operator type REGISTER Register, Display in the info window and support the redo toolbar panel. UNDO Undo, Push an undo event (needed for operator redo). BLOCKING Blocking, Block anything else from using the cursor. MACRO Macro, Use to check if an operator is a macro. GRAB_POINTER Grab Pointer, Use so the operator grabs the mouse focus, enables wrapping when continuous grab is enabled. PRESET Preset, Display a preset button with the operators settings. INTERNAL Internal, Removes the operator from search results. Type enum set in {REGISTER, UNDO, BLOCKING, MACRO, GRAB_POINTER, PRESET, INTERNAL}, default {REGISTER} name

2.4. Types ([Link])

583

Blender Index, Release 2.59.2 - API

Type string, default , (readonly) properties Type OperatorProperties, (readonly, never None) report(type, message) report Parameters type (enum set in {DEBUG, INFO, OPERATOR, WARNING, ROR, ERROR_INVALID_INPUT, ERROR_INVALID_CONTEXT, ROR_OUT_OF_MEMORY}) Type message (string) Report Message classmethod poll(context) Test if the operator can be called or not. Return type boolean draw(context) Draw function for the operator. ERER-

define(opname)
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4.296 MagicTexture(Texture)
base classes bpy_struct, ID, Texture

584

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

class [Link](Texture) Procedural noise texture noise_depth Sets the depth of the cloud calculation Type int in [0, 30], default 0 turbulence Sets the turbulence of the bandnoise and ringnoise types Type oat in [0.0001, inf], default 0.0 users_material Materials that use this texture (readonly) users_object_modifier Object modiers that use this texture (readonly)
Inherited Properties

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set

2.4. Types ([Link])

585

Blender Index, Release 2.59.2 - API

bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values [Link] ID.user_clear ID.animation_data_create ID.animation_data_clear ID.update_tag [Link]

2.4.297 MaintainVolumeConstraint(Constraint)
base classes bpy_struct, Constraint class [Link](Constraint) Maintains a constant volume along a single scaling axis free_axis The free scaling axis of the object Type enum in [SAMEVOL_X, SAMEVOL_Y, SAMEVOL_Z], default SAMEVOL_X volume Volume of the bone at rest Type oat in [0.001, 100], default 0.0
Inherited Properties

Inherited Functions

586

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.298 MarbleTexture(Texture)
base classes bpy_struct, ID, Texture class [Link](Texture) Procedural noise texture marble_type SOFT Soft, Uses soft marble. SHARP Sharp, Uses more clearly dened marble. SHARPER Sharper, Uses very clearly dened marble. Type enum in [SOFT, SHARP, SHARPER], default SOFT nabla Size of derivative offset used for calculating normal Type oat in [0.001, 0.1], default 0.0 noise_basis Sets the noise basis used for turbulence BLENDER_ORIGINAL Blender Original, Noise algorithm - Blender original: Smooth interpolated noise. ORIGINAL_PERLIN Original Perlin, Noise algorithm - Original Perlin: Smooth interpolated noise. IMPROVED_PERLIN Improved Perlin, Noise algorithm - Improved Perlin: Smooth interpolated noise. VORONOI_F1 Voronoi F1, Noise algorithm - Voronoi F1: Returns distance to the closest feature point. VORONOI_F2 Voronoi F2, Noise algorithm - Voronoi F2: Returns distance to the 2nd closest feature point. VORONOI_F3 Voronoi F3, Noise algorithm - Voronoi F3: Returns distance to the 3rd closest feature point. VORONOI_F4 Voronoi F4, Noise algorithm - Voronoi F4: Returns distance to the 4th closest feature point. VORONOI_F2_F1 Voronoi F2-F1, Noise algorithm - Voronoi F1-F2.

2.4. Types ([Link])

587

Blender Index, Release 2.59.2 - API

VORONOI_CRACKLE Voronoi Crackle, Noise algorithm - Voronoi Crackle: Voronoi tessellation with sharp edges. CELL_NOISE Cell Noise, Noise algorithm - Cell Noise: Square cell tessallation. Type enum in [BLENDER_ORIGINAL, ORIGINAL_PERLIN, IMPROVED_PERLIN, VORONOI_F1, VORONOI_F2, VORONOI_F3, VORONOI_F4, VORONOI_F2_F1, VORONOI_CRACKLE, CELL_NOISE], default BLENDER_ORIGINAL noise_basis_2 SIN Sin, Uses a sine wave to produce bands. SAW Saw, Uses a saw wave to produce bands. TRI Tri, Uses a triangle wave to produce bands. Type enum in [SIN, SAW, TRI], default SIN noise_depth Sets the depth of the cloud calculation Type int in [0, 30], default 0 noise_scale Sets scaling for noise input Type oat in [0.0001, inf], default 0.0 noise_type SOFT_NOISE Soft, Generate soft noise (smooth transitions). HARD_NOISE Hard, Generate hard noise (sharp transitions). Type enum in [SOFT_NOISE, HARD_NOISE], default SOFT_NOISE turbulence Sets the turbulence of the bandnoise and ringnoise types Type oat in [0.0001, inf], default 0.0 users_material Materials that use this texture (readonly) users_object_modifier Object modiers that use this texture (readonly)
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link] Texture.animation_data [Link]

588

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Texture.color_ramp [Link] Texture.factor_blue Texture.factor_green Texture.factor_red Texture.node_tree [Link] Texture.use_preview_alpha [Link] Texture.use_color_ramp Texture.use_nodes Texture.users_material Texture.users_object_modifier Texture.users_material Texture.users_object_modifier

Inherited Functions

2.4.299 MaskModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Mask modier to hide parts of the mesh armature Armature to use as source of bones to mask Type Object

2.4. Types ([Link])

589

Blender Index, Release 2.59.2 - API

invert_vertex_group Use vertices that are not part of region dened Type boolean, default False mode Type enum in [VERTEX_GROUP, ARMATURE], default VERTEX_GROUP vertex_group Vertex group name Type string, default
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Blender Index, Release 2.59.2 - API

use_cast_buffer_shadows Allow this material to cast shadows from shadow buffer lamps Type boolean, default False use_cast_shadows_only Makes objects with this material appear invisible, only casting shadows (not rendered) Type boolean, default False use_cubic Use cubic interpolation for diffuse values, for smoother transitions Type boolean, default False use_diffuse_ramp Toggle diffuse ramp operations Type boolean, default False use_face_texture Replaces the objects base color with color from face assigned image textures Type boolean, default False use_face_texture_alpha Replaces the objects base alpha value with alpha from face assigned image textures Type boolean, default False use_full_oversampling Force this material to render full shading/textures for all anti-aliasing samples Type boolean, default False use_light_group_exclusive Material uses the light group exclusively - these lamps are excluded from other scene lighting Type boolean, default False use_mist Use mist with this material (in world settings) Type boolean, default False use_nodes Use shader nodes to render the material Type boolean, default False use_object_color Modulate the result with a per-object color Type boolean, default False use_only_shadow Renders shadows as the materials alpha value, making materials transparent except for shadowed areas Type boolean, default False use_ray_shadow_bias Prevents raytraced shadow errors on surfaces with smooth shaded normals (terminator problem) Type boolean, default False use_raytrace Include this material and geometry that uses it in ray tracing calculations

596

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type boolean, default False use_shadeless Makes this material insensitive to light or shadow Type boolean, default False use_shadows Allows this material to receive shadows Type boolean, default False use_sky Renders this material with zero alpha, with sky background in place (scanline only) Type boolean, default False use_specular_ramp Toggle specular ramp operations Type boolean, default False use_tangent_shading Use the materials tangent vector instead of the normal for shading - for anisotropic shading effects Type boolean, default False use_textures Enable/Disable each texture Type boolean array of 18 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False) use_transparency Render material as transparent Type boolean, default False use_transparent_shadows Allow this object to receive transparent shadows cast through other objects Type boolean, default False use_vertex_color_light Add vertex colors as additional lighting Type boolean, default False use_vertex_color_paint Replaces object base color with vertex colors (multiplies with texture face face assigned textures) Type boolean, default False volume Volume settings for the material Type MaterialVolume, (readonly, never None)
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link]

2.4. Types ([Link])

597

Blender Index, Release 2.59.2 - API

[Link] [Link]
Inherited Functions

References

[Link] [Link] [Link] [Link] [Link] [Link] Material.active_node_material [Link] [Link] [Link] Object.active_material RenderLayer.material_override SceneRenderLayer.material_override [Link] [Link] [Link]

2.4.301 MaterialHalo(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Halo particle effect settings for a Material datablock 598 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

add Sets the strength of the add effect Type oat in [0, 1], default 0.0 flare_boost Gives the are extra strength Type oat in [0.1, 10], default 0.0 flare_seed Species an offset in the are seed table Type int in [0, 255], default 0 flare_size Sets the factor by which the are is larger than the halo Type oat in [0.1, 25], default 0.0 flare_subflare_count Sets the number of sub-ares Type int in [1, 32], default 0 flare_subflare_size Sets the dimension of the sub-ares, dots and circles Type oat in [0.1, 25], default 0.0 hardness Sets the hardness of the halo Type int in [0, 127], default 0 line_count Sets the number of star shaped lines rendered over the halo Type int in [0, 250], default 0 ring_count Sets the number of rings rendered over the halo Type int in [0, 24], default 0 seed Randomizes ring dimension and line location Type int in [0, 255], default 0 size Sets the dimension of the halo Type oat in [0, 100], default 0.0 star_tip_count Sets the number of points on the star shaped halo Type int in [3, 50], default 0 use_extreme_alpha Uses extreme alpha Type boolean, default False use_flare_mode Renders halo as a lens are

2.4. Types ([Link])

599

Blender Index, Release 2.59.2 - API

Type boolean, default False use_lines Renders star shaped lines over halo Type boolean, default False use_ring Renders rings over halo Type boolean, default False use_shaded Lets halo receive light and shadows from external objects Type boolean, default False use_soft Softens the edges of halos at intersections with other geometry Type boolean, default False use_star Renders halo as a star Type boolean, default False use_texture Gives halo a texture Type boolean, default False use_vertex_normal Uses the vertex normal to specify the dimension of the halo Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

600

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

References

[Link]

2.4.302 MaterialPhysics(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Physics settings for a Material datablock elasticity Elasticity of collisions Type oat in [0, 1], default 0.0 fh_damping Damping of the spring force, when inside the physics distance area Type oat in [0, 1], default 0.0 fh_distance Distance of the physics area Type oat in [0, 20], default 0.0 fh_force Upward spring force, when inside the physics distance area Type oat in [0, 1], default 0.0 friction Coulomb friction coefcient, when inside the physics distance area Type oat in [0, 100], default 0.0 use_fh_normal Align dynamic game objects along the surface normal, when inside the physics distance area Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

601

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

[Link]

2.4.303 MaterialRaytraceMirror(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Raytraced reection settings for a Material datablock depth Maximum allowed number of light inter-reections Type int in [0, 32767], default 0 distance Maximum distance of reected rays. Reections further than this range fade to sky color or material color Type oat in [0, 10000], default 0.0 fade_to The color that rays with no intersection within the Max Distance take. Material color can be best for indoor scenes, sky color for outdoor Type enum in [FADE_TO_SKY, FADE_TO_MATERIAL], default FADE_TO_SKY fresnel Power of Fresnel for mirror reection Type oat in [0, 5], default 0.0 fresnel_factor Blending factor for Fresnel Type oat in [0, 5], default 0.0 gloss_anisotropic The shape of the reection, from 0.0 (circular) to 1.0 (fully stretched along the tangent Type oat in [0, 1], default 0.0 gloss_factor The shininess of the reection. Values < 1.0 give diffuse, blurry reections Type oat in [0, 1], default 0.0 gloss_samples Number of cone samples averaged for blurry reections Type int in [0, 1024], default 0

602

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

gloss_threshold Threshold for adaptive sampling. If a sample contributes less than this amount (as a percentage), sampling is stopped Type oat in [0, 1], default 0.0 reflect_factor Sets the amount mirror reection for raytrace Type oat in [0, 1], default 0.0 use Enable raytraced reections Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Material.raytrace_mirror

2.4.304 MaterialRaytraceTransparency(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Raytraced refraction settings for a Material datablock depth Maximum allowed number of light inter-refractions Type int in [0, 32767], default 0

2.4. Types ([Link])

603

Blender Index, Release 2.59.2 - API

Material.subsurface_scattering

608

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.308 MaterialTextureSlot(TextureSlot)
base classes bpy_struct, TextureSlot class [Link](TextureSlot) Texture slot for textures in a Material datablock alpha_factor Amount texture affects alpha Type oat in [-inf, inf], default 0.0 ambient_factor Amount texture affects ambient Type oat in [-inf, inf], default 0.0 bump_method Method to use for bump mapping Type enum in [BUMP_ORIGINAL, BUMP_COMPATIBLE, BUMP_BEST_QUALITY], default BUMP_ORIGINAL bump_objectspace Space to apply bump mapping in Type enum in [BUMP_VIEWSPACE, BUMP_OBJECTSPACE, BUMP_TEXTURESPACE], default BUMP_VIEWSPACE density_factor Amount texture affects density Type oat in [-inf, inf], default 0.0 diffuse_color_factor Amount texture affects diffuse color Type oat in [-inf, inf], default 0.0 diffuse_factor Amount texture affects diffuse reectivity Type oat in [-inf, inf], default 0.0 displacement_factor Amount texture displaces the surface Type oat in [-inf, inf], default 0.0 emission_color_factor Amount texture affects emission color Type oat in [-inf, inf], default 0.0 emission_factor Amount texture affects emission Type oat in [-inf, inf], default 0.0 emit_factor Amount texture affects emission Type oat in [-inf, inf], default 0.0 hardness_factor Amount texture affects hardness 2.4. Types ([Link]) 609 BUMP_DEFAULT,

Blender Index, Release 2.59.2 - API

Type oat in [-inf, inf], default 0.0 mapping FLAT Flat, Maps X and Y coordinates directly. CUBE Cube, Maps using the normal vector. TUBE Tube, Maps with Z as central axis. SPHERE Sphere, Maps with Z as central axis. Type enum in [FLAT, CUBE, TUBE, SPHERE], default FLAT mapping_x Type enum in [NONE, X, Y, Z], default NONE mapping_y Type enum in [NONE, X, Y, Z], default NONE mapping_z Type enum in [NONE, X, Y, Z], default NONE mirror_factor Amount texture affects mirror color Type oat in [-inf, inf], default 0.0 normal_factor Amount texture affects normal values Type oat in [-inf, inf], default 0.0 normal_map_space Sets space of normal map image Type enum in [CAMERA, WORLD, OBJECT, TANGENT], default CAMERA object Object to use for mapping with Object texture coordinates Type Object raymir_factor Amount texture affects ray mirror Type oat in [-inf, inf], default 0.0 reflection_color_factor Amount texture affects color of out-scattered light Type oat in [-inf, inf], default 0.0 reflection_factor Amount texture affects brightness of out-scattered light Type oat in [-inf, inf], default 0.0 scattering_factor Amount texture affects scattering Type oat in [-inf, inf], default 0.0

610

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

specular_color_factor Amount texture affects specular color Type oat in [-inf, inf], default 0.0 specular_factor Amount texture affects specular reectivity Type oat in [-inf, inf], default 0.0 texture_coords GLOBAL Global, Uses global coordinates for the texture coordinates. OBJECT Object, Uses linked objects coordinates for texture coordinates. UV UV, Uses UV coordinates for texture coordinates. ORCO Generated, Uses the original undeformed coordinates of the object. STRAND Strand / Particle, Uses normalized strand texture coordinate (1D) or particle age (X) and trail position (Y). STICKY Sticky, Uses meshs sticky coordinates for the texture coordinates. WINDOW Window, Uses screen coordinates as texture coordinates. NORMAL Normal, Uses normal vector as texture coordinates. REFLECTION Reection, Uses reection vector as texture coordinates. STRESS Stress, Uses the difference of edge lengths compared to original coordinates of the mesh. TANGENT Tangent, Uses the optional tangent vector as texture coordinates. Type enum in [GLOBAL, OBJECT, UV, ORCO, STRAND, STICKY, WINDOW, NORMAL, REFLECTION, STRESS, TANGENT], default GLOBAL translucency_factor Amount texture affects translucency Type oat in [-inf, inf], default 0.0 transmission_color_factor Amount texture affects result color after light has been scattered/absorbed Type oat in [-inf, inf], default 0.0 use Enable this material texture slot Type boolean, default False use_from_dupli Duplis instanced from verts, faces or particles, inherit texture coordinate from their parent Type boolean, default False use_from_original Duplis derive their object coordinates from the original objects transformation Type boolean, default False use_map_alpha Causes the texture to affect the alpha value Type boolean, default False

2.4. Types ([Link])

611

Blender Index, Release 2.59.2 - API

use_map_ambient Causes the texture to affect the value of ambient Type boolean, default False use_map_color_diffuse Causes the texture to affect basic color of the material Type boolean, default False use_map_color_emission Causes the texture to affect the color of emission Type boolean, default False use_map_color_reflection Causes the texture to affect the color of scattered light Type boolean, default False use_map_color_spec Causes the texture to affect the specularity color Type boolean, default False use_map_color_transmission Causes the texture to affect the result color after other light has been scattered/absorbed Type boolean, default False use_map_density Causes the texture to affect the volumes density Type boolean, default False use_map_diffuse Causes the texture to affect the value of the materials diffuse reectivity Type boolean, default False use_map_displacement Let the texture displace the surface Type boolean, default False use_map_emission Causes the texture to affect the volumes emission Type boolean, default False use_map_emit Causes the texture to affect the emit value Type boolean, default False use_map_hardness Causes the texture to affect the hardness value Type boolean, default False use_map_mirror Causes the texture to affect the mirror color Type boolean, default False use_map_normal Causes the texture to affect the rendered normal

612

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type boolean, default False use_map_raymir Causes the texture to affect the ray-mirror value Type boolean, default False use_map_reflect Causes the texture to affect the reected lights brightness Type boolean, default False use_map_scatter Causes the texture to affect the volumes scattering Type boolean, default False use_map_specular Causes the texture to affect the value of specular reectivity Type boolean, default False use_map_translucency Causes the texture to affect the translucency value Type boolean, default False use_map_warp Let the texture warp texture coordinates of next channels Type boolean, default False uv_layer UV layer to use for mapping with UV texture coordinates Type string, default warp_factor Amount texture affects texture coordinates of next channels Type oat in [-inf, inf], default 0.0
Inherited Properties

bpy_struct.id_data [Link] TextureSlot.blend_type [Link] TextureSlot.default_value [Link] [Link] TextureSlot.output_node TextureSlot.use_rgb_to_intensity [Link] TextureSlot.use_stencil [Link]

Inherited Functions

bpy_struct.as_pointer

2.4. Types ([Link])

613

Blender Index, Release 2.59.2 - API

References

Material.texture_slots [Link] [Link]

2.4.309 MaterialTextureSlots(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of texture slots classmethod add() add Returns The newly initialized mtex. Return type MaterialTextureSlot classmethod create(index) create Parameters index (int in [0, inf]) Index, Slot index to initialize. Returns The newly initialized mtex. Return type MaterialTextureSlot classmethod clear(index) clear Parameters index (int in [0, inf]) Index, Slot index to clear.
Inherited Properties

bpy_struct.id_data

614

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Functions

References

Material.texture_slots

2.4.310 MaterialVolume(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Volume rendering settings for a Material datablock asymmetry Back scattering (-1.0) to Forward scattering (1.0) and the range in between Type oat in [-1, 1], default 0.0 cache_resolution Resolution of the voxel grid, low resolutions are faster, high resolutions use more memory Type int in [1, 1024], default 0 density The base density of the volume Type oat in [0, 1], default 0.0 density_scale Multiplier for the materials density Type oat in [0, inf], default 0.0 depth_threshold Stop ray marching early if transmission drops below this luminance - higher values give speedups in dense volumes at the expense of accuracy Type oat in [0, 1], default 0.0 emission Amount of light that gets emitted by the volume 2.4. Types ([Link]) 615

Blender Index, Release 2.59.2 - API

Type oat in [0, inf], default 0.0 emission_color Color of emitted light Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) light_method Method of shading, attenuating, and scattering light through the volume SHADELESS Shadeless, Do not calculate lighting and shadows. SHADOWED Shadowed. SHADED Shaded. MULTIPLE_SCATTERING Multiple Scattering. SHADED_PLUS_MULTIPLE_SCATTERING Shaded + Multiple Scattering. Type enum in [SHADELESS, SHADOWED, SHADED, MULTIPLE_SCATTERING, SHADED_PLUS_MULTIPLE_SCATTERING], default SHADELESS ms_diffusion Diffusion factor, the strength of the blurring effect Type oat in [0, inf], default 0.0 ms_intensity Multiplier for multiple scattered light energy Type oat in [0, inf], default 0.0 ms_spread Proportional distance over which the light is diffused Type oat in [0, inf], default 0.0 reflection Multiplier to make out-scattered light brighter or darker (non-physically correct) Type oat in [0, inf], default 0.0 reflection_color Color of light scattered out of the volume (does not affect transmission) Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) scattering Amount of light that gets scattered out by the volume - the more out-scattering, the shallower the light will penetrate Type oat in [0, inf], default 0.0 step_method Method of calculating the steps through the volume Type enum in [RANDOMIZED, CONSTANT], default RANDOMIZED step_size Distance between subsequent volume depth samples Type oat in [0, inf], default 0.0 transmission_color Result color of the volume, after other light has been scattered/absorbed

616

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) use_external_shadows Receive shadows from sources outside the volume (temporary) Type boolean, default False use_light_cache Pre-calculate the shading information into a voxel grid, speeds up shading at slightly less accuracy Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.311 Menu(bpy_struct)
Basic Menu Example This script is a simple menu, menus differ from panels in that they must reference from a header, panel or another menu. Notice the CATEGORY_MT_name Menu.bl_idname, this is a naming convention for menus. Note: Menu subclasses must be registered before referencing them from blender.

2.4. Types ([Link])

617

Blender Index, Release 2.59.2 - API

Note: Menus have their Layout.operator_context initialized as EXEC_REGION_WIN rather then INVOKE_DEFAULT, so if the operator context needs to initialize inputs from the [Link] function then this needs to be explicitly set.
import bpy

class BasicMenu([Link]): bl_idname = "OBJECT_MT_select_test" bl_label = "Select" def draw(self, context): layout = [Link] [Link]("object.select_all", text="Select/Deselect All") [Link]("object.select_inverse", text="Inverse") [Link]("object.select_random", text="Random")

[Link].register_class(BasicMenu) # test call to display immediately. [Link].call_menu(name="OBJECT_MT_select_test")

Submenus This menu demonstrates some different functions.

import bpy

class SubMenu([Link]): bl_idname = "OBJECT_MT_select_submenu" bl_label = "Select" def draw(self, context): layout = [Link] [Link]("object.select_all", text="Select/Deselect All") [Link]("object.select_inverse", text="Inverse") [Link]("object.select_random", text="Random") # access this operator as a submenu layout.operator_menu_enum("object.select_by_type", "type", text="Select All by Type...") [Link]() # expand each operator option into this menu layout.operator_enum("object.lamp_add", "type") [Link]() # use existing memu [Link]("VIEW3D_MT_transform")

[Link].register_class(SubMenu)

618

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

# test call to display immediately. [Link].call_menu(name="OBJECT_MT_select_submenu")

Extending Menus When creating menus for addons you cant reference menus in blenders default scripts. Instead the addon can add menu items to existing menus. The function menu_draw acts like [Link]
import bpy

def menu_draw(self, context): [Link]("wm.save_homefile") [Link].INFO_MT_file.append(menu_draw)

base class bpy_struct class [Link](bpy_struct) Editor menu containing buttons bl_idname If this is set, the menu gets a custom ID, otherwise it takes the name of the class used to dene the panel. For example, if the class name is OBJECT_MT_hello, and bl_idname is not set by the script, then bl_idname = OBJECT_MT_hello Type string, default bl_label The menu label Type string, default layout Denes the structure of the menu in the UI. Type UILayout, (readonly) classmethod poll(context) If this method returns a non-null output, then the menu can be drawn. Return type boolean draw(context) Draw UI elements into the menu UI layout.

classmethod append(draw_func) Append a draw function to this menu, takes the same arguments as the menus draw function. draw_preset(context) Dene these on the subclass preset_operator preset_subdir path_menu(searchpaths, operator, props_default={}) 2.4. Types ([Link]) 619

Blender Index, Release 2.59.2 - API

classmethod prepend(draw_func) Prepend a draw function to this menu, takes the same arguments as the menus draw function. classmethod remove(draw_func) Remove a draw function that has been added to this menu
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4.312 Mesh(ID)
base classes bpy_struct, ID class [Link](ID) Mesh datablock dening geometric surfaces animation_data Animation data for this datablock Type AnimData, (readonly) auto_smooth_angle Denes maximum angle between face normals that Auto Smooth will operate on Type oat in [-inf, inf], default 0.0 edges Edges of the mesh Type MeshEdges bpy_prop_collection of MeshEdge, (readonly) faces Faces of the mesh Type MeshFaces bpy_prop_collection of MeshFace, (readonly) layers_float 620 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type bpy_prop_collection of MeshFloatPropertyLayer, (readonly) layers_int Type bpy_prop_collection of MeshIntPropertyLayer, (readonly) layers_string Type bpy_prop_collection of MeshStringPropertyLayer, (readonly) materials Type IDMaterials bpy_prop_collection of Material, (readonly) shape_keys Type Key, (readonly) show_all_edges Displays all edges for wireframe in all view modes in the 3D view Type boolean, default False show_double_sided Render/display the mesh with double or single sided lighting Type boolean, default False show_edge_bevel_weight Displays weights created for the Bevel modier Type boolean, default False show_edge_crease Displays creases created for subsurf weighting Type boolean, default False show_edge_seams Displays UV unwrapping seams Type boolean, default False show_edge_sharp Displays sharp edges, used with the EdgeSplit modier Type boolean, default False show_edges Displays selected edges using highlights in the 3D view and UV editor Type boolean, default False show_extra_edge_length Displays selected edge lengths, Using global values when set in the transform panel Type boolean, default False show_extra_face_angle Displays the angles in the selected edges in degrees, Using global values when set in the transform panel Type boolean, default False show_extra_face_area Displays the area of selected faces, Using global values when set in the transform panel Type boolean, default False

2.4. Types ([Link])

621

Blender Index, Release 2.59.2 - API

show_faces Displays all faces as shades in the 3D view and UV editor Type boolean, default False show_normal_face Displays face normals as lines Type boolean, default False show_normal_vertex Displays vertex normals as lines Type boolean, default False sticky Sticky texture coordinates Type bpy_prop_collection of MeshSticky, (readonly) texco_mesh Derive texture coordinates from another mesh Type Mesh texspace_location Texture space location Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) texspace_size Texture space size Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) texture_mesh Use another mesh for texture indices (vertex indices must be aligned) Type Mesh total_edge_sel Selected edge count in editmode Type int in [0, inf], default 0, (readonly) total_face_sel Selected face count in editmode Type int in [0, inf], default 0, (readonly) total_vert_sel Selected vertex count in editmode Type int in [0, inf], default 0, (readonly) use_auto_smooth Treats all set-smoothed faces with angles less than the specied angle as smooth during render Type boolean, default False use_auto_texspace Adjusts active objects texture space automatically when transforming object Type boolean, default False use_mirror_topology Use topology based mirroring. For when both sides of mesh have matching, unique topology

622

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type boolean, default False use_mirror_x X Axis mirror editing Type boolean, default False use_paint_mask Face selection masking for painting Type boolean, default False uv_texture_clone UV texture to be used as cloning source Type MeshTextureFaceLayer uv_texture_clone_index Clone UV texture index Type int in [0, inf], default 0 uv_texture_stencil UV texture to mask the painted area Type MeshTextureFaceLayer uv_texture_stencil_index Mask UV texture index Type int in [0, inf], default 0 uv_textures Type UVTextures bpy_prop_collection of MeshTextureFaceLayer, (readonly) vertex_colors Type VertexColors bpy_prop_collection of MeshColorLayer, (readonly) vertices Vertices of the mesh Type MeshVertices bpy_prop_collection of MeshVertex, (readonly) edge_keys (readonly) transform(matrix) Transform mesh vertices by a matrix. Parameters matrix (oat array of 16 items in [-inf, inf]) Matrix. calc_normals() Calculate vertex normals. update(calc_edges=False) update Parameters calc_edges (boolean, (optional)) Calculate Edges, Force recalculation of edges. validate(verbose=False) validate geometry, return True when the mesh has had invalid geometry corrected/removed. Parameters verbose (boolean, (optional)) Verbose, Output information about the errors found Returns Result

2.4. Types ([Link])

623

Blender Index, Release 2.59.2 - API

Return type boolean from_pydata(vertices, edges, faces) Make a mesh from a list of verts/edges/faces Until we have a nicer way to make geometry, use this. Parameters vertices (iterable object) oat triplets each representing (X, Y, Z) eg: [(0.0, 1.0, 0.5), ...]. edges (iterable object) int pairs, each pair contains two indices to the vertices argument. eg: [(1, 2), ...] faces (iterable object) iterator of faces, each faces contains three or four indices to the vertices argument. eg: [(5, 6, 8, 9), (1, 2, 3), ...]
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

Inherited Functions

References

624

[Link] [Link] [Link] [Link] Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Mesh.texco_mesh Mesh.texture_mesh Object.to_mesh

2.4.313 MeshColor(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Vertex colors for a face in a Mesh color1 Type oat array of 3 items in [0, 1], default (0.0, 0.0, 0.0) color2 Type oat array of 3 items in [0, 1], default (0.0, 0.0, 0.0) color3 Type oat array of 3 items in [0, 1], default (0.0, 0.0, 0.0) color4 Type oat array of 3 items in [0, 1], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4. Types ([Link])

625

Blender Index, Release 2.59.2 - API

2.4.314 MeshColorLayer(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Layer of vertex colors in a Mesh datablock active Sets the layer as active for display and editing Type boolean, default False active_render Sets the layer as active for rendering Type boolean, default False data Type bpy_prop_collection of MeshColor, (readonly) name Name of Vertex color layer Type string, default
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Mesh.vertex_colors [Link] [Link]

626

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.315 MeshDeformModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Mesh deformation modier to deform with other meshes invert_vertex_group Invert vertex group inuence Type boolean, default False is_bound Whether geometry has been bound to control cage Type boolean, default False, (readonly) object Mesh object to deform with Type Object precision The grid size for binding Type int in [2, 10], default 0 use_dynamic_bind Recompute binding dynamically on top of other deformers (slower and more memory consuming.) Type boolean, default False vertex_group Vertex group name Type string, default
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set 627

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.316 MeshEdge(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Edge in a Mesh datablock bevel_weight Weight used by the Bevel modier Type oat in [-inf, inf], default 0.0 crease Weight used by the Subsurf modier for creasing Type oat in [-inf, inf], default 0.0 hide Type boolean, default False index Index number of the vertex Type int in [0, inf], default 0, (readonly) is_fgon Fgon edge Type boolean, default False is_loose Loose edge Type boolean, default False select Type boolean, default False use_edge_sharp Sharp edge for the EdgeSplit modier Type boolean, default False use_seam Seam edge for UV unwrapping Type boolean, default False vertices Vertex indices Type int array of 2 items in [0, inf], default (0, 0)

628

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

key (readonly)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.317 MeshEdges(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of mesh edges add(count=0) add Parameters count (int in [0, inf], (optional)) Count, Number of vertices to add.
Inherited Properties

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add

2.4. Types ([Link])

629

Blender Index, Release 2.59.2 - API

References

[Link]

2.4.318 MeshFace(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Face in a Mesh datablock area read only area of the face Type oat in [0, inf], default 0.0, (readonly) hide Type boolean, default False index Index number of the vertex Type int in [0, inf], default 0, (readonly) material_index Type int in [0, 32767], default 0 normal local space unit length normal vector for this face Type oat array of 3 items in [-1, 1], default (0.0, 0.0, 0.0), (readonly) select Type boolean, default False use_smooth Type boolean, default False vertices Vertex indices Type int array of 4 items in [0, inf], default (0, 0, 0, 0) 630 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

vertices_raw Fixed size vertex indices array Type int array of 4 items in [0, inf], default (0, 0, 0, 0) center The midpoint of the face. (readonly) edge_keys (readonly)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.319 MeshFaces(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of mesh faces active The active face for this mesh Type int in [-inf, inf], default 0 active_tface Active Texture Face Type MeshTextureFace, (readonly)

2.4. Types ([Link])

631

Blender Index, Release 2.59.2 - API

add(count=0) add Parameters count (int in [0, inf], (optional)) Count, Number of vertices to add.
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.320 MeshFloatProperty(bpy_struct)
base class bpy_struct class [Link](bpy_struct) User dened oating point number value in a oat properties layer value Type oat in [-inf, inf], default 0.0
Inherited Properties

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add 632 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

References

[Link]

2.4.321 MeshFloatPropertyLayer(bpy_struct)
base class bpy_struct class [Link](bpy_struct) User dened layer of oating pointer number values data Type bpy_prop_collection of MeshFloatProperty, (readonly) name Type string, default
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

Mesh.layers_float

2.4.322 MeshIntProperty(bpy_struct)
base class bpy_struct class [Link](bpy_struct) User dened integer number value in an integer properties layer value Type int in [-inf, inf], default 0
Inherited Properties

bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

[Link]

2.4.326 MeshStringPropertyLayer(bpy_struct)
base class bpy_struct class [Link](bpy_struct) User dened layer of string text values data Type bpy_prop_collection of MeshStringProperty, (readonly) name Type string, default
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Mesh.layers_string

2.4. Types ([Link])

637

Blender Index, Release 2.59.2 - API

2.4.327 MeshTextureFace(bpy_struct)
base class bpy_struct class [Link](bpy_struct) UV mapping, texturing and game engine data for a face blend_type Transparency blending mode OPAQUE Opaque, Render color of textured face as color. ADD Add, Render face transparent and add color of face. ALPHA Alpha, Render polygon transparent, depending on alpha channel of the texture. CLIPALPHA Clip Alpha, Use the images alpha values clipped with no blending (binary alpha). Type enum in [OPAQUE, ADD, ALPHA, CLIPALPHA], default OPAQUE hide Make face invisible Type boolean, default False image Type Image pin_uv Type boolean array of 4 items, default (False, False, False, False) select_uv Type boolean array of 4 items, default (False, False, False, False) use_alpha_sort Enable sorting of faces for correct alpha drawing (slow, use Clip Alpha instead when possible) Type boolean, default False use_billboard Billboard with Z-axis constraint Type boolean, default False use_bitmap_text Enable bitmap text on face Type boolean, default False use_blend_shared Blend vertex colors across face when vertices are shared Type boolean, default False use_collision Use face for collision and ray-sensor detection Type boolean, default False use_halo Screen aligned billboard Type boolean, default False

638

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

use_image Render face with texture Type boolean, default False use_light Use light for face Type boolean, default False use_object_color Use ObColor instead of vertex colors Type boolean, default False use_shadow_cast Face is used for shadow Type boolean, default False use_twoside Render face two-sided Type boolean, default False uv Type oat array of 8 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0) uv1 Type oat array of 2 items in [-inf, inf], default (0.0, 0.0) uv2 Type oat array of 2 items in [-inf, inf], default (0.0, 0.0) uv3 Type oat array of 2 items in [-inf, inf], default (0.0, 0.0) uv4 Type oat array of 2 items in [-inf, inf], default (0.0, 0.0) uv_raw Fixed size UV coordinates array Type oat array of 8 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden 639

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

MeshFaces.active_tface [Link]

2.4.328 MeshTextureFaceLayer(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Layer of texture faces in a Mesh datablock active Sets the layer as active for display and editing Type boolean, default False active_clone Sets the layer as active for cloning Type boolean, default False active_render Sets the layer as active for rendering Type boolean, default False data Type bpy_prop_collection of MeshTextureFace, (readonly) name Name of UV unwrapping layer Type string, default
Inherited Properties

bpy_struct.id_data
Inherited Functions

640

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

References

Mesh.uv_texture_clone Mesh.uv_texture_stencil Mesh.uv_textures [Link] [Link]

2.4.329 MeshVertex(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Vertex in a Mesh datablock bevel_weight Weight used by the Bevel modier Only Vertices option Type oat in [-inf, inf], default 0.0 co Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) groups Weights for the vertex groups this vertex is member of Type bpy_prop_collection of VertexGroupElement, (readonly) hide Type boolean, default False index Index number of the vertex Type int in [0, inf], default 0, (readonly) normal Vertex Normal Type oat array of 3 items in [-1, 1], default (0.0, 0.0, 0.0) select Type boolean, default False

2.4. Types ([Link])

641

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.330 MeshVertices(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of mesh vertices add(count=0) add Parameters count (int in [0, inf], (optional)) Count, Number of vertices to add.
Inherited Properties

bpy_struct.id_data
Inherited Functions

642

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

References

[Link]

2.4.331 MessageActuator(Actuator)
base classes bpy_struct, Actuator class [Link](Actuator) Actuator to .. body_message Optional message body Text Type string, default body_property The message body will be set by the Property Value Type string, default body_type Toggle message type: either Text or a PropertyName Type enum in [TEXT, PROPERTY], default TEXT subject Optional message subject. This is what can be ltered on Type string, default to_property Optional send message to objects with this name only, or empty to broadcast Type string, default
Inherited Properties

bpy_struct.id_data [Link] Actuator.show_expanded [Link] [Link]

2.4. Types ([Link])

643

Blender Index, Release 2.59.2 - API

Inherited Functions

2.4.332 MessageSensor(Sensor)
base classes bpy_struct, Sensor class [Link](Sensor) Sensor to detect incoming messages subject Optional subject lter: only accept messages with this subject, or empty for all Type string, default
Inherited Properties

bpy_struct.id_data [Link] Sensor.show_expanded [Link] [Link] Sensor.use_level [Link] Sensor.use_pulse_false_level Sensor.use_pulse_true_level Sensor.use_tap [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove

644

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.333 MetaBall(ID)
base classes bpy_struct, ID class [Link](ID) Metaball datablock to dened blobby surfaces animation_data Animation data for this datablock Type AnimData, (readonly) elements Meta elements Type MetaBallElements bpy_prop_collection of MetaElement, (readonly) materials Type IDMaterials bpy_prop_collection of Material, (readonly) render_resolution Polygonization resolution in rendering Type oat in [0.05, 1], default 0.0 resolution Polygonization resolution in the 3D viewport Type oat in [0.05, 1], default 0.0 texspace_location Texture space location Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) texspace_size Texture space size Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) threshold Inuence of meta elements Type oat in [0, 5], default 0.0

2.4. Types ([Link])

645

Blender Index, Release 2.59.2 - API

update_method Metaball edit update behavior UPDATE_ALWAYS Always, While editing, update metaball always. HALFRES Half, While editing, update metaball in half resolution. FAST Fast, While editing, update metaball without polygonization. NEVER Never, While editing, dont update metaball at all. Type enum in [UPDATE_ALWAYS, HALFRES, FAST, NEVER], default UPDATE_ALWAYS use_auto_texspace Adjusts active objects texture space automatically when transforming object Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

Inherited Functions

646

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

References

[Link] [Link] [Link]

2.4.334 MetaBallElements(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of metaball elements active Last selected element Type MetaElement, (readonly) new(type=BALL) Add a new spline to the curve. Parameters type (enum in [BALL, CAPSULE, PLANE, ELLIPSOID, CUBE], (optional)) type for the new meta-element. Returns The newly created meta-element. Return type MetaElement remove(element) Remove a spline from a curve. Parameters element (MetaElement, (never None)) The element to remove.
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

647

Blender Index, Release 2.59.2 - API

References

[Link]

2.4.335 MetaElement(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Blobby element in a MetaBall datablock co Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) hide Hide element Type boolean, default False radius Type oat in [0, inf], default 0.0 rotation Normalized quaternion rotation Type oat array of 4 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0) size_x Size of element, use of components depends on element type Type oat in [0, 20], default 0.0 size_y Size of element, use of components depends on element type Type oat in [0, 20], default 0.0 size_z Size of element, use of components depends on element type Type oat in [0, 20], default 0.0 stiffness Stiffness denes how much of the element to ll Type oat in [0, 10], default 0.0 type Metaball types Type enum in [BALL, CAPSULE, PLANE, ELLIPSOID, CUBE], default BALL use_negative Set metaball as negative one Type boolean, default False
Inherited Properties

bpy_struct.id_data

648

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Functions

References

[Link] [Link] [Link] [Link]

2.4.336 MetaSequence(Sequence)
base classes bpy_struct, Sequence class [Link](Sequence) Sequence strip to group other strips as a single sequence strip animation_offset_end Animation end offset (trim end) Type int in [0, inf], default 0 animation_offset_start Animation start offset (trim start) Type int in [0, inf], default 0 color_balance Type SequenceColorBalance, (readonly) color_multiply Type oat in [0, 20], default 0.0 color_saturation Type oat in [0, 20], default 0.0 crop Type SequenceCrop, (readonly)

2.4. Types ([Link])

649

Blender Index, Release 2.59.2 - API

proxy Type SequenceProxy, (readonly) sequences Type bpy_prop_collection of Sequence, (readonly) strobe Only display every nth frame Type oat in [1, 30], default 0.0 transform Type SequenceTransform, (readonly) use_color_balance (3-Way color correction) on input Type boolean, default False use_crop Crop image before processing Type boolean, default False use_deinterlace For video movies to remove elds Type boolean, default False use_flip_x Flip on the X axis Type boolean, default False use_flip_y Flip on the Y axis Type boolean, default False use_float Convert input to oat data Type boolean, default False use_premultiply Convert RGB from key alpha to premultiplied alpha Type boolean, default False use_proxy Use a preview proxy and/or timecode index for this strip Type boolean, default False use_proxy_custom_directory Use a custom directory to store data Type boolean, default False use_proxy_custom_file Use a custom le to read proxy data from Type boolean, default False

650

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

use_reverse_frames Reverse frame order Type boolean, default False use_translation Translate image before processing Type boolean, default False
Inherited Properties

Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values [Link] [Link]

2.4.337 MirrorModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Mirroring modier merge_threshold Distance from axis within which mirrored vertices are merged Type oat in [0, inf], default 0.0 mirror_object Object to use as mirror Type Object use_clip Prevents vertices from going through the mirror during transform Type boolean, default False use_mirror_merge Merge vertices within the merge threshold Type boolean, default False use_mirror_u Mirror the U texture coordinate around the 0.5 point Type boolean, default False use_mirror_v Mirror the V texture coordinate around the 0.5 point Type boolean, default False use_mirror_vertex_groups Mirror vertex groups (e.g. .R->.L) Type boolean, default False use_x Enable X axis mirror Type boolean, default False use_y Enable Y axis mirror Type boolean, default False use_z Enable Z axis mirror Type boolean, default False 652 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

2.4.338 Modier(bpy_struct)
base class bpy_struct subclasses FluidSimulationModifier, BevelModifier, SolidifyModifier, SmokeModifier, UVProjectModifier, VertexWeightProximityModifier, VertexWeightEditModifier, DecimateModifier, ExplodeModifier, SmoothModifier, HookModifier, SoftBodyModifier, BooleanModifier, ArrayModifier, LatticeModifier, BuildModifier, ClothModifier, NavMeshModifier, ParticleSystemModifier, SubsurfModifier, CurveModifier, ScrewModifier, MaskModifier, ShrinkwrapModifier, CollisionModifier, CastModifier, WaveModifier, ParticleInstanceModifier, SurfaceModifier, SimpleDeformModifier, DisplaceModifier, ArmatureModifier, MeshDeformModifier, WarpModifier, EdgeSplitModifier, MultiresModifier, MirrorModifier, VertexWeightMixModifier class [Link](bpy_struct) Modier affecting the geometry data of an object name Modier name Type string, default

2.4. Types ([Link])

653

Blender Index, Release 2.59.2 - API

show_expanded Set modier expanded in the user interface Type boolean, default False show_in_editmode Use modier while in the edit mode Type boolean, default False show_on_cage Enable direct editing of modier control cage Type boolean, default False show_render Use modier during rendering Type boolean, default False show_viewport Realtime display of a modier Type boolean, default False type Type enum in [ARRAY, BEVEL, BOOLEAN, BUILD, DECIMATE, EDGE_SPLIT, MASK, MIRROR, MULTIRES, SCREW, SOLIDIFY, SUBSURF, UV_PROJECT, VERTEX_WEIGHT_EDIT, VERTEX_WEIGHT_MIX, VERTEX_WEIGHT_PROXIMITY, ARMATURE, CAST, CURVE, DISPLACE, HOOK, LATTICE, MESH_DEFORM, SHRINKWRAP, SIMPLE_DEFORM, SMOOTH, WARP, WAVE, CLOTH, COLLISION, EXPLODE, FLUID_SIMULATION, NAVMESH, PARTICLE_INSTANCE, PARTICLE_SYSTEM, SMOKE, SOFT_BODY, SURFACE], default ARRAY, (readonly) use_apply_on_spline Apply this and all preceding deformation modiers on splines points rather than on lled curve/surface Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

654

Blender Index, Release 2.59.2 - API

bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

[Link] [Link] [Link] UILayout.template_modifier

2.4.339 MotionPath(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Cache of the worldspace positions of an element over a frame range frame_end End frame of the stored range Type int in [-inf, inf], default 0, (readonly) frame_start Starting frame of the stored range Type int in [-inf, inf], default 0, (readonly) is_modified Path is being edited Type boolean, default False length Number of frames cached Type int in [-inf, inf], default 0, (readonly) points Cached positions per frame Type bpy_prop_collection of MotionPathVert, (readonly) use_bone_head For PoseBone paths, use the bone head location when calculating this path Type boolean, default False, (readonly)
Inherited Properties

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add 2.4. Types ([Link]) 655

Blender Index, Release 2.59.2 - API

References

Object.motion_path PoseBone.motion_path

2.4.340 MotionPathVert(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Cached location on path co Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) select Path point is selected for editing Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

656

Blender Index, Release 2.59.2 - API

bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

[Link]

2.4.341 MouseSensor(Sensor)
base classes bpy_struct, Sensor class [Link](Sensor) Sensor to detect mouse events mouse_event Specify the type of event this mouse sensor should trigger on Type enum in [LEFTCLICK, MIDDLECLICK, RIGHTCLICK, WHEELUP, WHEELDOWN, MOVEMENT, MOUSEOVER, MOUSEOVERANY], default LEFTCLICK
Inherited Properties

bpy_struct.id_data [Link] Sensor.show_expanded [Link] [Link] Sensor.use_level [Link] Sensor.use_pulse_false_level Sensor.use_pulse_true_level Sensor.use_tap [Link]

Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values [Link] [Link]

2.4.342 MovieSequence(Sequence)
base classes bpy_struct, Sequence class [Link](Sequence) Sequence strip to load a video animation_offset_end Animation end offset (trim end) Type int in [0, inf], default 0 animation_offset_start Animation start offset (trim start) Type int in [0, inf], default 0 color_balance Type SequenceColorBalance, (readonly) color_multiply Type oat in [0, 20], default 0.0 color_saturation Type oat in [0, 20], default 0.0 crop Type SequenceCrop, (readonly) elements Type bpy_prop_collection of SequenceElement, (readonly) filepath Type string, default mpeg_preseek For MPEG movies, preseek this many frames Type int in [0, 50], default 0 proxy Type SequenceProxy, (readonly) streamindex For les with several movie streams, use the stream with the given index Type int in [0, 20], default 0 strobe Only display every nth frame Type oat in [1, 30], default 0.0

658

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

transform Type SequenceTransform, (readonly) use_color_balance (3-Way color correction) on input Type boolean, default False use_crop Crop image before processing Type boolean, default False use_deinterlace For video movies to remove elds Type boolean, default False use_flip_x Flip on the X axis Type boolean, default False use_flip_y Flip on the Y axis Type boolean, default False use_float Convert input to oat data Type boolean, default False use_premultiply Convert RGB from key alpha to premultiplied alpha Type boolean, default False use_proxy Use a preview proxy and/or timecode index for this strip Type boolean, default False use_proxy_custom_directory Use a custom directory to store data Type boolean, default False use_proxy_custom_file Use a custom le to read proxy data from Type boolean, default False use_reverse_frames Reverse frame order Type boolean, default False use_translation Translate image before processing Type boolean, default False

2.4. Types ([Link])

659

Blender Index, Release 2.59.2 - API

Inherited Properties

Inherited Functions

660

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.343 MulticamSequence(Sequence)
base classes bpy_struct, Sequence class [Link](Sequence) Sequence strip to perform multicam editing: select channel from below animation_offset_end Animation end offset (trim end) Type int in [0, inf], default 0 animation_offset_start Animation start offset (trim start) Type int in [0, inf], default 0 color_balance Type SequenceColorBalance, (readonly) color_multiply Type oat in [0, 20], default 0.0 color_saturation Type oat in [0, 20], default 0.0 crop Type SequenceCrop, (readonly) multicam_source Type int in [0, 31], default 0 proxy Type SequenceProxy, (readonly) strobe Only display every nth frame Type oat in [1, 30], default 0.0 transform Type SequenceTransform, (readonly) use_color_balance (3-Way color correction) on input Type boolean, default False use_crop Crop image before processing Type boolean, default False use_deinterlace For video movies to remove elds Type boolean, default False use_flip_x Flip on the X axis

2.4. Types ([Link])

661

Blender Index, Release 2.59.2 - API

Type boolean, default False use_flip_y Flip on the Y axis Type boolean, default False use_float Convert input to oat data Type boolean, default False use_premultiply Convert RGB from key alpha to premultiplied alpha Type boolean, default False use_proxy Use a preview proxy and/or timecode index for this strip Type boolean, default False use_proxy_custom_directory Use a custom directory to store data Type boolean, default False use_proxy_custom_file Use a custom le to read proxy data from Type boolean, default False use_reverse_frames Reverse frame order Type boolean, default False use_translation Translate image before processing Type boolean, default False
Inherited Properties

662

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link] Sequence.select_right_handle [Link] Sequence.speed_factor Sequence.frame_start Sequence.frame_final_start Sequence.frame_offset_start Sequence.frame_still_start [Link] Sequence.use_default_fade Sequence.input_count

Inherited Functions

2.4.344 MultiresModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Multiresolution mesh modier filepath Path to external displacements le Type string, default is_external Store multires displacements outside the .blend le, to save memory Type boolean, default False, (readonly) levels Number of subdivisions to use in the viewport Type int in [0, 255], default 0

2.4. Types ([Link])

663

Blender Index, Release 2.59.2 - API

render_levels The subdivision level visible at render time Type int in [0, 255], default 0 sculpt_levels Number of subdivisions to use in sculpt mode Type int in [0, 255], default 0 show_only_control_edges Skip drawing/rendering of interior subdivided edges Type boolean, default False subdivision_type Selects type of subdivision algorithm Type enum in [CATMULL_CLARK, SIMPLE], default CATMULL_CLARK total_levels Number of subdivisions for which displacements are stored Type int in [0, 255], default 0, (readonly) use_subsurf_uv Use subsurf to subdivide UVs Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

664

Blender Index, Release 2.59.2 - API

bpy_struct.type_recast bpy_struct.values

2.4.345 MusgraveTexture(Texture)
base classes bpy_struct, ID, Texture class [Link](Texture) Procedural musgrave texture dimension_max Highest fractal dimension Type oat in [0.0001, 2], default 0.0 gain The gain multiplier Type oat in [0, 6], default 0.0 lacunarity Gap between successive frequencies Type oat in [0, 6], default 0.0 musgrave_type MULTIFRACTAL Multifractal, Fractal noise algorithm. Multifractal: Uses Perlin noise as a basis. RIDGED_MULTIFRACTAL Ridged Multifractal, Fractal noise algorithm. Ridged Multifractal: Uses Perlin noise with inection as a basis. HYBRID_MULTIFRACTAL Hybrid Multifractal, Fractal noise [Link] Multifractal: Uses Perlin noise as a basis, with extended controls. FBM fBM, Fractal noise algorithm. Fractal Brownian Motion: Uses Brownian noise as a basis. HETERO_TERRAIN Hetero Terrain, Fractal noise algorithm. Hetero Terrain: similar to multifractal. Type enum in [MULTIFRACTAL, RIDGED_MULTIFRACTAL, HYBRID_MULTIFRACTAL, FBM, HETERO_TERRAIN], default MULTIFRACTAL nabla Size of derivative offset used for calculating normal Type oat in [0.001, 0.1], default 0.0 noise_basis Sets the noise basis used for turbulence BLENDER_ORIGINAL Blender Original, Noise algorithm - Blender original: Smooth interpolated noise. ORIGINAL_PERLIN Original Perlin, Noise algorithm - Original Perlin: Smooth interpolated noise. IMPROVED_PERLIN Improved Perlin, Noise algorithm - Improved Perlin: Smooth interpolated noise. VORONOI_F1 Voronoi F1, Noise algorithm - Voronoi F1: Returns distance to the closest feature point. VORONOI_F2 Voronoi F2, Noise algorithm - Voronoi F2: Returns distance to the 2nd closest feature point.

2.4. Types ([Link])

665

Blender Index, Release 2.59.2 - API

VORONOI_F3 Voronoi F3, Noise algorithm - Voronoi F3: Returns distance to the 3rd closest feature point. VORONOI_F4 Voronoi F4, Noise algorithm - Voronoi F4: Returns distance to the 4th closest feature point. VORONOI_F2_F1 Voronoi F2-F1, Noise algorithm - Voronoi F1-F2. VORONOI_CRACKLE Voronoi Crackle, Noise algorithm - Voronoi Crackle: Voronoi tessellation with sharp edges. CELL_NOISE Cell Noise, Noise algorithm - Cell Noise: Square cell tessallation. Type enum in [BLENDER_ORIGINAL, ORIGINAL_PERLIN, IMPROVED_PERLIN, VORONOI_F1, VORONOI_F2, VORONOI_F3, VORONOI_F4, VORONOI_F2_F1, VORONOI_CRACKLE, CELL_NOISE], default BLENDER_ORIGINAL noise_intensity Scales the intensity of the noise Type oat in [0, 10], default 0.0 noise_scale Sets scaling for noise input Type oat in [0.0001, inf], default 0.0 octaves Number of frequencies used Type oat in [0, 8], default 0.0 offset The fractal offset Type oat in [0, 6], default 0.0 users_material Materials that use this texture (readonly) users_object_modifier Object modiers that use this texture (readonly)
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link] Texture.animation_data [Link] Texture.color_ramp [Link] Texture.factor_blue Texture.factor_green Texture.factor_red

666

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Texture.node_tree [Link] Texture.use_preview_alpha [Link] Texture.use_color_ramp Texture.use_nodes Texture.users_material Texture.users_object_modifier Texture.users_material Texture.users_object_modifier

Inherited Functions

2.4.346 NandController(Controller)
base classes bpy_struct, Controller class [Link](Controller) Controller passing on events based on a logical NAND operation
Inherited Properties

bpy_struct.id_data [Link] [Link] Controller.show_expanded Controller.use_priority [Link]

2.4. Types ([Link])

667

Blender Index, Release 2.59.2 - API

Inherited Functions

2.4.347 NavMeshModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) NavMesh modier
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set bpy_struct.items

668

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.348 NearSensor(Sensor)
base classes bpy_struct, Sensor class [Link](Sensor) Sensor to detect nearby objects distance Trigger distance Type oat in [0, 10000], default 0.0 property Only look for objects with this property (blank = all objects) Type string, default reset_distance The distance where the sensor forgets the actor Type oat in [0, 10000], default 0.0
Inherited Properties

bpy_struct.id_data [Link] Sensor.show_expanded [Link] [Link] Sensor.use_level [Link] Sensor.use_pulse_false_level Sensor.use_pulse_true_level Sensor.use_tap [Link]

Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values [Link] [Link]

2.4.349 NlaStrip(bpy_struct)
base class bpy_struct class [Link](bpy_struct) A container referencing an existing Action action Action referenced by this strip Type Action action_frame_end Type oat in [-inf, inf], default 0.0 action_frame_start Type oat in [-inf, inf], default 0.0 active NLA Strip is active Type boolean, default False, (readonly) blend_in Number of frames at start of strip to fade in inuence Type oat in [-inf, inf], default 0.0 blend_out Type oat in [-inf, inf], default 0.0 blend_type Method used for combining strips result with accumulated result REPLACE Replace, Result strip replaces the accumulated results by amount specied by inuence. ADD Add, Weighted result of strip is added to the accumulated results. SUBTRACT Subtract, Weighted result of strip is removed from the accumulated results. MULITPLY Multiply, Weighted result of strip is multiplied with the accumulated results. Type enum in [REPLACE, ADD, SUBTRACT, MULITPLY], default REPLACE extrapolation Action to take for gaps past the strip extents NOTHING Nothing, Strip has no inuence past its extents. HOLD Hold, Hold the rst frame if no previous strips in track, and always hold last frame.

670

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

HOLD_FORWARD Hold Forward, Only hold last frame. Type enum in [NOTHING, HOLD, HOLD_FORWARD], default HOLD fcurves F-Curves for controlling the strips inuence and timing Type bpy_prop_collection of FCurve, (readonly) frame_end Type oat in [-inf, inf], default 0.0 frame_start Type oat in [-inf, inf], default 0.0 influence Amount the strip contributes to the current result Type oat in [0, 1], default 0.0 modifiers Modiers affecting all the F-Curves in the referenced Action Type bpy_prop_collection of FModifier, (readonly) mute NLA Strip is not evaluated Type boolean, default False name Type string, default repeat Number of times to repeat the action range Type oat in [0.1, 1000], default 0.0 scale Scaling factor for action Type oat in [0.0001, 1000], default 0.0 select NLA Strip is selected Type boolean, default False strip_time Frame of referenced Action to evaluate Type oat in [-inf, inf], default 0.0 strips NLA Strips that this strip acts as a container for (if it is of type Meta) Type bpy_prop_collection of NlaStrip, (readonly) type Type of NLA Strip CLIP Action Clip, NLA Strip references some Action. TRANSITION Transition, NLA Strip transitions between adjacent strips.

2.4. Types ([Link])

671

Blender Index, Release 2.59.2 - API

META Meta, NLA Strip acts as a container for adjacent strips. SOUND Sound Clip, NLA Strip representing a sound event for speakers. Type enum in [CLIP, TRANSITION, META, SOUND], default CLIP, (readonly) use_animated_influence Inuence setting is controlled by an F-Curve rather than automatically determined Type boolean, default False use_animated_time Strip time is controlled by an F-Curve rather than automatically determined Type boolean, default False use_animated_time_cyclic Cycle the animated time within the action start & end Type boolean, default False use_auto_blend Number of frames for Blending In/Out is automatically determined from overlapping strips Type boolean, default False use_reverse NLA Strip is played back in reverse order (only when timing is automatically determined) Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

672

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

References

[Link] [Link] [Link] [Link]

2.4.350 NlaStrips(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of Nla Strips new(name, start, action) Add a new Action-Clip strip to the track Parameters name (string) Name for the NLA Strips. start (int in [-inf, inf]) Start Frame, Start frame for this strip. action (Action, (never None)) Action to assign to this strip. Returns New NLA Strip. Return type NlaStrip remove(strip) Remove a NLA Strip. Parameters strip (NlaStrip, (never None)) NLA Strip to remove.
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

673

Blender Index, Release 2.59.2 - API

References

[Link]

2.4.351 NlaTrack(bpy_struct)
base class bpy_struct class [Link](bpy_struct) A animation layer containing Actions referenced as NLA strips active NLA Track is active Type boolean, default False, (readonly) is_solo NLA Track is evaluated itself (i.e. active Action and all other NLA Tracks in the same AnimData block are disabled) Type boolean, default False, (readonly) lock NLA Track is locked Type boolean, default False mute NLA Track is not evaluated Type boolean, default False name Type string, default select NLA Track is selected Type boolean, default False strips NLA Strips on this NLA-track Type NlaStrips bpy_prop_collection of NlaStrip, (readonly)
Inherited Properties

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get

674

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

References

AnimData.nla_tracks [Link] [Link] [Link] [Link]

2.4.352 NlaTracks(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of NLA Tracks active Active Object constraint Type NlaTrack new(prev=None) Add a new NLA Track Parameters prev (NlaTrack, (optional)) NLA Track to add the new one after. Returns New NLA Track. Return type NlaTrack remove(track) Remove a NLA Track. Parameters track (NlaTrack, (never None)) NLA Track to remove.
Inherited Properties

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add 675

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

References

AnimData.nla_tracks

2.4.353 Node(bpy_struct)
base class bpy_struct subclasses NodeFrame, NodeForLoop, NodeGroup NodeWhileLoop, TextureNode, ShaderNode, CompositorNode,

class [Link](bpy_struct) Node in a node tree inputs Type bpy_prop_collection of NodeSocket, (readonly) label Optional custom node label Type string, default location Type oat array of 2 items in [-10000, 10000], default (0.0, 0.0) name Unique node identier Type string, default outputs Type bpy_prop_collection of NodeSocket, (readonly) parent Parent this node is attached to Type Node, (readonly)
Inherited Properties

bpy_struct.id_data

676

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Functions

References

[Link] [Link] [Link] [Link] NodeLink.from_node NodeLink.to_node [Link] [Link] [Link] [Link] [Link] [Link]

2.4.354 NodeForLoop(Node)
base classes bpy_struct, Node class [Link](Node) node_tree Type NodeTree
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link]

2.4. Types ([Link])

677

Blender Index, Release 2.59.2 - API

[Link] [Link]
Inherited Functions

2.4.355 NodeFrame(Node)
base classes bpy_struct, Node class [Link](Node)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

678

Blender Index, Release 2.59.2 - API

bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.356 NodeGroup(Node)
base classes bpy_struct, Node class [Link](Node) node_tree Type NodeTree
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.357 NodeLink(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Link between nodes in a node tree

2.4. Types ([Link])

679

Blender Index, Release 2.59.2 - API

from_node Type Node, (readonly) from_socket Type NodeSocket, (readonly) to_node Type Node, (readonly) to_socket Type NodeSocket, (readonly)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] [Link] [Link]

2.4.358 NodeLinks(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of Node Links new(input, output) Add a node link to this node tree.

680

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Parameters input (NodeSocket) The input socket. output (NodeSocket) The output socket. Returns New node link. Return type NodeLink remove(link) remove a node link from the node tree. Parameters link (NodeLink) The node link to remove.
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.359 NodeSocket(bpy_struct)
base class bpy_struct subclasses NodeSocketVectorAcceleration, NodeSocketVectorTranslation, NodeSocketFloatPercentage, NodeSocketFloatAngle, NodeSocketIntUnsigned, NodeSocketVectorEuler, NodeSocketFloatNone, NodeSocketFloatTime, NodeSocketIntNone, NodeSocketFloatFactor, NodeSocketVectorXYZ, NodeSocketFloatDistance, NodeSocketFloatUnsigned, NodeSocketVectorNone, NodeSocketRGBA, NodeSocketBoolean, NodeSocketVectorDirection, NodeSocketVectorVelocity

2.4. Types ([Link])

681

Blender Index, Release 2.59.2 - API

class [Link](bpy_struct) Input or output socket of a node name Socket name Type string, default type Node Socket type Type enum in [VALUE, VECTOR, RGBA], default VALUE, (readonly)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] NodeLink.from_socket NodeLink.to_socket [Link] [Link] [Link] [Link]

682

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Blender Index, Release 2.59.2 - API

bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.364 NodeSocketFloatNone(NodeSocket)
base classes bpy_struct, NodeSocket class [Link](NodeSocket) Input or output socket of a node default_value Type oat in [-inf, inf], default 0.0 subtype Subtype dening the socket value details Type enum in [NONE, UNSIGNED, NONE, UNSIGNED, PERCENTAGE, FACTOR, ANGLE, TIME, DISTANCE, NONE, TRANSLATION, DIRECTION, VELOCITY, ACCELERATION, EULER, XYZ], default NONE
Inherited Properties

bpy_struct.id_data [Link] [Link]

Inherited Functions

2.4.365 NodeSocketFloatPercentage(NodeSocket)
base classes bpy_struct, NodeSocket

686

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

class [Link](NodeSocket) Input or output socket of a node default_value Type oat in [-inf, inf], default 0.0 subtype Subtype dening the socket value details Type enum in [NONE, UNSIGNED, NONE, UNSIGNED, PERCENTAGE, FACTOR, ANGLE, TIME, DISTANCE, NONE, TRANSLATION, DIRECTION, VELOCITY, ACCELERATION, EULER, XYZ], default NONE
Inherited Properties

bpy_struct.id_data [Link] [Link]

692

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.373 NodeSocketVectorEuler(NodeSocket)
base classes bpy_struct, NodeSocket class [Link](NodeSocket) Input or output socket of a node default_value Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) subtype Subtype dening the socket value details Type enum in [NONE, UNSIGNED, NONE, UNSIGNED, PERCENTAGE, FACTOR, ANGLE, TIME, DISTANCE, NONE, TRANSLATION, DIRECTION, VELOCITY, ACCELERATION, EULER, XYZ], default NONE
Inherited Properties

bpy_struct.id_data [Link] [Link]

Inherited Functions

2.4. Types ([Link])

693

Blender Index, Release 2.59.2 - API

2.4.374 NodeSocketVectorNone(NodeSocket)
base classes bpy_struct, NodeSocket class [Link](NodeSocket) Input or output socket of a node default_value Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) subtype Subtype dening the socket value details Type enum in [NONE, UNSIGNED, NONE, UNSIGNED, PERCENTAGE, FACTOR, ANGLE, TIME, DISTANCE, NONE, TRANSLATION, DIRECTION, VELOCITY, ACCELERATION, EULER, XYZ], default NONE
Inherited Properties

bpy_struct.id_data [Link] [Link]

Inherited Functions

2.4.375 NodeSocketVectorTranslation(NodeSocket)
base classes bpy_struct, NodeSocket class [Link](NodeSocket) Input or output socket of a node default_value Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) subtype Subtype dening the socket value details 694 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type enum in [NONE, UNSIGNED, NONE, UNSIGNED, PERCENTAGE, FACTOR, ANGLE, TIME, DISTANCE, NONE, TRANSLATION, DIRECTION, VELOCITY, ACCELERATION, EULER, XYZ], default NONE
Inherited Properties

bpy_struct.id_data [Link] [Link]

Inherited Functions

2.4.376 NodeSocketVectorVelocity(NodeSocket)
base classes bpy_struct, NodeSocket class [Link](NodeSocket) Input or output socket of a node default_value Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) subtype Subtype dening the socket value details Type enum in [NONE, UNSIGNED, NONE, UNSIGNED, PERCENTAGE, FACTOR, ANGLE, TIME, DISTANCE, NONE, TRANSLATION, DIRECTION, VELOCITY, ACCELERATION, EULER, XYZ], default NONE
Inherited Properties

bpy_struct.id_data [Link] [Link]

2.4. Types ([Link])

695

Blender Index, Release 2.59.2 - API

Inherited Functions

2.4.377 NodeSocketVectorXYZ(NodeSocket)
base classes bpy_struct, NodeSocket class [Link](NodeSocket) Input or output socket of a node default_value Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) subtype Subtype dening the socket value details Type enum in [NONE, UNSIGNED, NONE, UNSIGNED, PERCENTAGE, FACTOR, ANGLE, TIME, DISTANCE, NONE, TRANSLATION, DIRECTION, VELOCITY, ACCELERATION, EULER, XYZ], default NONE
Inherited Properties

bpy_struct.id_data [Link] [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set

696

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.378 NodeTree(ID)
base classes bpy_struct, ID subclasses CompositorNodeTree, ShaderNodeTree, TextureNodeTree class [Link](ID) Node tree consisting of linked nodes used for materials, textures and compositing animation_data Animation data for this datablock Type AnimData, (readonly) grease_pencil Grease Pencil datablock Type GreasePencil inputs Type GroupInputs bpy_prop_collection of NodeSocket, (readonly) links Type NodeLinks bpy_prop_collection of NodeLink, (readonly) outputs Type GroupOutputs bpy_prop_collection of NodeSocket, (readonly) type Node Tree type MATERIAL Material, Material nodes. TEXTURE Texture, Texture nodes. COMPOSITING Compositing, Compositing nodes. Type enum in [MATERIAL, TEXTURE, COMPOSITING], default MATERIAL, (readonly)
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

2.4. Types ([Link])

697

Blender Index, Release 2.59.2 - API

Inherited Functions

References

BlendData.node_groups [Link] [Link] [Link] Material.node_tree NodeForLoop.node_tree NodeGroup.node_tree NodeWhileLoop.node_tree Scene.node_tree [Link] SpaceNodeEditor.node_tree Texture.node_tree [Link]

2.4.379 NodeWhileLoop(Node)
base classes bpy_struct, Node class [Link](Node) max_iterations Limit for number of iterations Type int in [0, 32767], default 0 node_tree

698

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type NodeTree
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.380 NoiseTexture(Texture)
base classes bpy_struct, ID, Texture class [Link](Texture) Procedural noise texture users_material Materials that use this texture (readonly) users_object_modifier Object modiers that use this texture (readonly)
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link] 699

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

Texture.animation_data [Link] Texture.color_ramp [Link] Texture.factor_blue Texture.factor_green Texture.factor_red Texture.node_tree [Link] Texture.use_preview_alpha [Link] Texture.use_color_ramp Texture.use_nodes Texture.users_material Texture.users_object_modifier Texture.users_material Texture.users_object_modifier

Inherited Functions

2.4.381 NorController(Controller)
base classes bpy_struct, Controller class [Link](Controller) Controller passing on events based on a logical NOR operation

700

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

710

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

Inherited Functions

References

[Link] ArmatureActuator.secondary_target [Link] [Link] [Link] ArrayModifier.end_cap ArrayModifier.offset_object ArrayModifier.start_cap [Link] [Link] [Link] [Link] [Link] [Link] [Link] Camera.dof_object [Link] 711

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

[Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] Curve.bevel_object Curve.taper_object [Link] [Link] [Link] DisplaceModifier.texture_coords_object [Link] [Link] EditObjectActuator.track_object EnvironmentMap.viewpoint_object [Link] [Link] [Link] [Link] [Link] [Link] KinematicConstraint.pole_target [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] MirrorModifier.mirror_object Object.find_armature [Link] [Link] Object.proxy_group ObjectActuator.reference_object [Link] [Link] [Link] [Link] ParticleSettings.billboard_object ParticleSettings.dupli_object [Link] [Link] ParticleSystem.reactor_target_object [Link] [Link] [Link] PoseBone.custom_shape [Link] [Link]

712

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link] [Link] [Link] [Link] [Link] [Link] [Link] SceneSequence.scene_camera [Link] [Link] ShrinkwrapModifier.auxiliary_target [Link] [Link] [Link] SpaceView3D.lock_object [Link] [Link] [Link] [Link] TextCurve.follow_curve [Link] ToolSettings.etch_template [Link] [Link] [Link] VertexWeightEditModifier.mask_tex_map_object VertexWeightMixModifier.mask_tex_map_object VertexWeightProximityModifier.mask_tex_map_object [Link] VoxelData.domain_object WarpModifier.object_from WarpModifier.object_to WarpModifier.texture_coords_object WaveModifier.start_position_object WaveModifier.texture_coords_object [Link]

2.4.383 ObjectActuator(Actuator)
base classes bpy_struct, Actuator class [Link](Actuator) Actuator to control the object movement angular_velocity Sets the angular velocity Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) damping Number of frames to reach the target velocity Type int in [-32768, 32767], default 0 derivate_coefficient Not required, high values can cause instability

2.4. Types ([Link])

713

Blender Index, Release 2.59.2 - API

Type oat in [-inf, inf], default 0.0 force Sets the force Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) force_max_x Set the upper limit for force Type oat in [-inf, inf], default 0.0 force_max_y Set the upper limit for force Type oat in [-inf, inf], default 0.0 force_max_z Set the upper limit for force Type oat in [-inf, inf], default 0.0 force_min_x Set the lower limit for force Type oat in [-inf, inf], default 0.0 force_min_y Set the lower limit for force Type oat in [-inf, inf], default 0.0 force_min_z Set the lower limit for force Type oat in [-inf, inf], default 0.0 integral_coefficient Low value (0.01) for slow response, high value (0.5) for fast response Type oat in [-inf, inf], default 0.0 linear_velocity Sets the linear velocity (in Servo mode it sets the target relative linear velocity, it will be achieved by automatic application of force. Null velocity is a valid target) Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) mode Specify the motion system Type enum in [OBJECT_NORMAL, OBJECT_SERVO], default OBJECT_NORMAL offset_location Sets the location Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) offset_rotation Sets the rotation Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) proportional_coefficient Typical value is 60x integral coefcient Type oat in [-inf, inf], default 0.0

714

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

reference_object Reference object for velocity calculation, leave empty for world reference Type Object torque Sets the torque Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) use_add_linear_velocity Toggles between ADD and SET linV Type boolean, default False use_local_angular_velocity Angular velocity is dened in local coordinates Type boolean, default False use_local_force Force is dened in local coordinates Type boolean, default False use_local_linear_velocity Velocity is dened in local coordinates Type boolean, default False use_local_location Location is dened in local coordinates Type boolean, default False use_local_rotation Rotation is dened in local coordinates Type boolean, default False use_local_torque Torque is dened in local coordinates Type boolean, default False use_servo_limit_x Set limit to force along the X axis Type boolean, default False use_servo_limit_y Set limit to force along the Y axis Type boolean, default False use_servo_limit_z Set limit to force along the Z axis Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link]

2.4. Types ([Link])

715

Blender Index, Release 2.59.2 - API

Actuator.show_expanded [Link] [Link]

Inherited Functions

2.4.384 ObjectBase(bpy_struct)
base class bpy_struct class [Link](bpy_struct) An object instance in a scene layers Layers the object base is on Type boolean array of 20 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False) object Object this base links to Type Object, (readonly) select Object base selection state Type boolean, default False layers_from_view(view) Sets the object layers from a 3D View (use when adding an object in local view).

Inherited Properties

bpy_struct.id_data 716 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Functions

References

Scene.object_bases [Link] [Link]

2.4.385 ObjectConstraints(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of object constraints active Active Object constraint Type Constraint new(type) Add a new constraint to this object Parameters type (enum in [COPY_LOCATION, COPY_ROTATION, COPY_SCALE, COPY_TRANSFORMS, LIMIT_DISTANCE, LIMIT_LOCATION, LIMIT_ROTATION, LIMIT_SCALE, MAINTAIN_VOLUME, TRANSFORM, CLAMP_TO, DAMPED_TRACK, IK, LOCKED_TRACK, SPLINE_IK, STRETCH_TO, TRACK_TO, ACTION, CHILD_OF, FLOOR, FOLLOW_PATH, PIVOT, RIGID_BODY_JOINT, SCRIPT, SHRINKWRAP]) Constraint type to add. COPY_LOCATION Copy Location. COPY_ROTATION Copy Rotation. COPY_SCALE Copy Scale. COPY_TRANSFORMS Copy Transforms. LIMIT_DISTANCE Limit Distance.

2.4. Types ([Link])

717

Blender Index, Release 2.59.2 - API

bpy_struct.id_data
Inherited Functions

718

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

[Link]

2.4.386 ObjectModiers(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of object modiers new(name, type) Add a new modier. Parameters name (string) New name for the bone. type (enum in [ARRAY, BEVEL, BOOLEAN, BUILD, DECIMATE, EDGE_SPLIT, MASK, MIRROR, MULTIRES, SCREW, SOLIDIFY, SUBSURF, UV_PROJECT, VERTEX_WEIGHT_EDIT, VERTEX_WEIGHT_MIX, VERTEX_WEIGHT_PROXIMITY, ARMATURE, CAST, CURVE, DISPLACE, HOOK, LATTICE, MESH_DEFORM, SHRINKWRAP, SIMPLE_DEFORM, SMOOTH, WARP, WAVE, CLOTH, COLLISION, EXPLODE, FLUID_SIMULATION, NAVMESH, PARTICLE_INSTANCE, PARTICLE_SYSTEM, SMOKE, SOFT_BODY, SURFACE]) Modier type to add. Returns Newly created modier. Return type Modifier remove(modier) Remove an existing modier from the object. Parameters modier (Modifier, (never None)) Modier to remove.
Inherited Properties

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove 719

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

References

[Link]

2.4.387 ObstacleFluidSettings(FluidSettings)
base classes bpy_struct, FluidSettings class [Link](FluidSettings) Fluid simulation settings for obstacles in the simulation impact_factor This is an unphysical value for moving objects - it controls the impact an obstacle has on the uid, =0 behaves a bit like outow (deleting uid), =1 is default, while >1 results in high forces. Can be used to tweak total mass Type oat in [-2, 10], default 0.0 partial_slip_factor Amount of mixing between no- and free-slip, 0 is no slip and 1 is free slip Type oat in [0, 1], default 0.0 slip_type NOSLIP No Slip, Obstacle causes zero normal and tangential velocity (=sticky). Default for all. Only option for moving objects. PARTIALSLIP Partial Slip, Mix between no-slip and free-slip. Non moving objects only!. FREESLIP Free Slip, Obstacle only causes zero normal velocity (=not sticky). Non moving objects only!. Type enum in [NOSLIP, PARTIALSLIP, FREESLIP], default NOSLIP use Object contributes to the uid simulation Type boolean, default False use_animated_mesh Export this mesh as an animated one. Slower, only use if really necessary (e.g. armatures or parented objects), animated pos/rot/scale IPOs do not require it Type boolean, default False

720

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

volume_initialization Volume initialization type VOLUME Volume, Use only the inner volume of the mesh. SHELL Shell, Use only the outer shell of the mesh. BOTH Both, Use both the inner volume and the outer shell of the mesh. Type enum in [VOLUME, SHELL, BOTH], default VOLUME
Inherited Properties

bpy_struct.id_data [Link]
Inherited Functions

2.4.388 Operator(bpy_struct)
Basic Operator Example This script shows simple operator which prints a message. Since the operator only has an [Link] function it takes no user input. Note: Operator subclasses must be registered before accessing them from blender.
import bpy

class HelloWorldOperator([Link]): bl_idname = "wm.hello_world" bl_label = "Minimal Operator" def execute(self, context):

2.4. Types ([Link])

721

Blender Index, Release 2.59.2 - API

print("Hello World") return {FINISHED} [Link].register_class(HelloWorldOperator) # test call to the newly defined operator [Link].hello_world()

Invoke Function [Link] is used to initialize the operator from the context at the moment the operator is called. invoke() is typically used to assign properties which are then used by execute(). Some operators dont have an execute() function, removing the ability to be repeated from a script or macro. This example shows how to dene an operator which gets mouse input to execute a function and that this operator can be invoked or executed from the python api. Also notice this operator denes its own properties, these are different to typical class properties because blender registers them with the operator, to use as arguments when called, saved for operator undo/redo and automatically added into the user interface.
import bpy

class SimpleMouseOperator([Link]): """ This operator shows the mouse location, this string is used for the tooltip and API docs """ bl_idname = "wm.mouse_position" bl_label = "Invoke Mouse Operator" x = [Link]() y = [Link]() def execute(self, context): # rather then printing, use the report function, # this way the message appears in the header, [Link]({INFO}, "Mouse coords are %d %d " % (self.x, self.y)) return {FINISHED} def invoke(self, context, event): self.x = event.mouse_x self.y = event.mouse_y return [Link](context) [Link].register_class(SimpleMouseOperator) # Test call to the newly defined operator. # Here we call the operator and invoke it, meaning that the settings are taken # from the mouse. [Link].mouse_position(INVOKE_DEFAULT) # Another test call, this time call execute() directly with pre-defined settings. [Link].mouse_position(EXEC_DEFAULT, x=20, y=66)

722

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Calling a File Selector This example shows how an operator can use the le selector. Notice the invoke function calls a window manager method and returns RUNNING_MODAL, this means the le selector stays open and the operator does not exit immediately after invoke nishes. The le selector runs the operator, calling [Link] when the user conrms. The [Link] function is optional, used to check if the operator can run.
import bpy

class ExportSomeData([Link]): """Test exporter which just writes hello world""" bl_idname = "export.some_data" bl_label = "Export Some Data" filepath = [Link](subtype="FILE_PATH") @classmethod def poll(cls, context): return [Link] is not None def execute(self, context): file = open([Link], w) [Link]("Hello World " + [Link]) return {FINISHED} def invoke(self, context, event): context.window_manager.fileselect_add(self) return {RUNNING_MODAL}

# Only needed if you want to add into a dynamic menu def menu_func(self, context): [Link].operator_context = INVOKE_DEFAULT [Link](ExportSomeData.bl_idname, text="Text Export Operator") # Register and add to the file selector [Link].register_class(ExportSomeData) [Link].INFO_MT_file_export.append(menu_func)

# test call [Link].some_data(INVOKE_DEFAULT)

Dialog Box This operator uses its [Link] function to call a popup.
import bpy

class DialogOperator([Link]): bl_idname = "object.dialog_operator" bl_label = "Simple Dialog Operator"

2.4. Types ([Link])

723

Blender Index, Release 2.59.2 - API

my_float = [Link](name="Some Floating Point") my_bool = [Link](name="Toggle Option") my_string = [Link](name="String Value") def execute(self, context): message = "Popup Values: %f , %d , %s" % \ (self.my_float, self.my_bool, self.my_string) [Link]({INFO}, message) return {FINISHED} def invoke(self, context, event): wm = context.window_manager return wm.invoke_props_dialog(self)

[Link].register_class(DialogOperator) # test call [Link].dialog_operator(INVOKE_DEFAULT)

Custom Drawing By default operator properties use an automatic user interface layout. If you need more control you can create your own layout with a [Link] function. This works like the Panel and Menu draw functions, its used for dialogs and le selectors.
import bpy

class CustomDrawOperator([Link]): bl_idname = "object.custom_draw" bl_label = "Simple Modal Operator" filepath = [Link](subtype="FILE_PATH") my_float = [Link](name="Float") my_bool = [Link](name="Toggle Option") my_string = [Link](name="String Value") def execute(self, context): print() return {FINISHED} def invoke(self, context, event): context.window_manager.fileselect_add(self) return {RUNNING_MODAL} def draw(self, context): layout = [Link] col = [Link]() [Link](text="Custom Interface!") row = [Link]() [Link](self, "my_float") [Link](self, "my_bool")

724

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link](self, "my_string") [Link].register_class(CustomDrawOperator) # test call [Link].custom_draw(INVOKE_DEFAULT)

Modal Execution This operator denes a [Link] function which running, handling events until it returns {FINISHED} or {CANCELLED}. Grab, Rotate, Scale and Fly-Mode are examples of modal operators. They are especially useful for interactive tools, your operator can have its own state where keys toggle options as the operator runs. [Link] is used to initialize the operator as being by returning {RUNNING_MODAL}, initializing the modal loop. Notice __init__() and __del__() are declared. For other operator types they are not useful but for modal operators they will be called before the [Link] and after the operator nishes.
import bpy

class ModalOperator([Link]): bl_idname = "object.modal_operator" bl_label = "Simple Modal Operator" def __init__(self): print("Start") def __del__(self): print("End") def execute(self, context): [Link].x = [Link] / 100.0 def modal(self, context, event): if [Link] == MOUSEMOVE: # Apply [Link] = event.mouse_x [Link](context) elif [Link] == LEFTMOUSE: # Confirm return {FINISHED} elif [Link] in (RIGHTMOUSE, ESC): # Cancel return {CANCELLED} return {RUNNING_MODAL} def invoke(self, context, event): [Link] = event.mouse_x [Link](context) print(context.window_manager.modal_handler_add(self)) return {RUNNING_MODAL}

[Link].register_class(ModalOperator)

2.4. Types ([Link])

725

Blender Index, Release 2.59.2 - API

# test call [Link].modal_operator(INVOKE_DEFAULT)

base class bpy_struct class [Link](bpy_struct) Storage of an operator being executed, or registered after execution bl_description Type string, default bl_idname Type string, default bl_label Type string, default bl_options Options for this operator type REGISTER Register, Display in the info window and support the redo toolbar panel. UNDO Undo, Push an undo event (needed for operator redo). BLOCKING Blocking, Block anything else from using the cursor. MACRO Macro, Use to check if an operator is a macro. GRAB_POINTER Grab Pointer, Use so the operator grabs the mouse focus, enables wrapping when continuous grab is enabled. PRESET Preset, Display a preset button with the operators settings. INTERNAL Internal, Removes the operator from search results. Type enum set in {REGISTER, UNDO, BLOCKING, MACRO, GRAB_POINTER, PRESET, INTERNAL}, default {REGISTER} has_reports Operator has a set of reports (warnings and errors) from last execution Type boolean, default False, (readonly) layout Type UILayout, (readonly) name Type string, default , (readonly) properties Type OperatorProperties, (readonly, never None) report(type, message) report Parameters type (enum set in {DEBUG, INFO, OPERATOR, WARNING, ROR, ERROR_INVALID_INPUT, ERROR_INVALID_CONTEXT, ROR_OUT_OF_MEMORY}) Type ERER-

726

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

message (string) Report Message classmethod poll(context) Test if the operator can be called or not. Return type boolean execute(context) Execute the operator. Returns result RUNNING_MODAL Running Modal, Keep the operator running with blender. CANCELLED Cancelled, When no action has been taken. FINISHED Finished. PASS_THROUGH Pass Through, Do nothing and pass the event on. Return type enum set PASS_THROUGH} in {RUNNING_MODAL, CANCELLED, FINISHED,

check(context) Check the operator settings, return True to signal a change to redraw. Returns result Return type boolean invoke(context, event) Invoke the operator. Returns result RUNNING_MODAL Running Modal, Keep the operator running with blender. CANCELLED Cancelled, When no action has been taken. FINISHED Finished. PASS_THROUGH Pass Through, Do nothing and pass the event on. Return type enum set PASS_THROUGH} modal(context, event) Modal operator function. Returns result RUNNING_MODAL Running Modal, Keep the operator running with blender. CANCELLED Cancelled, When no action has been taken. FINISHED Finished. PASS_THROUGH Pass Through, Do nothing and pass the event on. Return type enum set PASS_THROUGH} in {RUNNING_MODAL, CANCELLED, FINISHED, in {RUNNING_MODAL, CANCELLED, FINISHED,

2.4. Types ([Link])

727

Blender Index, Release 2.59.2 - API

draw(context) Draw function for the operator.

cancel(context) Called when the operator is cancelled. Returns result RUNNING_MODAL Running Modal, Keep the operator running with blender. CANCELLED Cancelled, When no action has been taken. FINISHED Finished. PASS_THROUGH Pass Through, Do nothing and pass the event on. Return type enum set PASS_THROUGH} in {RUNNING_MODAL, CANCELLED, FINISHED,

as_keywords(ignore=()) Return a copy of the properties as a dictionary.

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] WindowManager.fileselect_add WindowManager.invoke_confirm WindowManager.invoke_popup WindowManager.invoke_props_dialog

728

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

WindowManager.invoke_props_popup WindowManager.invoke_search_popup WindowManager.modal_handler_add [Link]

2.4.389 OperatorFileListElement(PropertyGroup)
base classes bpy_struct, PropertyGroup class [Link](PropertyGroup) name the name of a le or directory within a le list Type string, default
Inherited Properties

bpy_struct.id_data [Link]
Inherited Functions

2.4.390 OperatorMousePath(PropertyGroup)
base classes bpy_struct, PropertyGroup class [Link](PropertyGroup) Mouse path values for operators that record such paths loc Mouse location Type oat array of 2 items in [-inf, inf], default (0.0, 0.0)

2.4. Types ([Link])

729

Blender Index, Release 2.59.2 - API

time Time of mouse location Type oat in [-inf, inf], default 0.0
Inherited Properties

bpy_struct.id_data [Link]
Inherited Functions

2.4.391 OperatorProperties(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Input properties of an Operator
Inherited Properties

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set

730

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

[Link] [Link] [Link] [Link] [Link]

2.4.392 OperatorStrokeElement(PropertyGroup)
base classes bpy_struct, PropertyGroup class [Link](PropertyGroup) is_start Type boolean, default False location Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) mouse Type oat array of 2 items in [-inf, inf], default (0.0, 0.0) pen_flip Type boolean, default False pressure Tablet pressure Type oat in [0, 1], default 0.0 time Type oat in [0, inf], default 0.0
Inherited Properties

bpy_struct.id_data [Link]

2.4. Types ([Link])

731

Blender Index, Release 2.59.2 - API

Inherited Functions

2.4.393 OperatorTypeMacro(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Storage of a sub operator in a macro after it has been added properties Type OperatorProperties, (readonly, never None)
Inherited Properties

bpy_struct.id_data
Inherited Functions

732

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.394 OrController(Controller)
base classes bpy_struct, Controller class [Link](Controller) Controller passing on events based on a logical OR operation
Inherited Properties

bpy_struct.id_data [Link] [Link] Controller.show_expanded Controller.use_priority [Link]

Inherited Functions

2.4.395 OutowFluidSettings(FluidSettings)
base classes bpy_struct, FluidSettings class [Link](FluidSettings) Fluid simulation settings for objects removing uids from the simulation use Object contributes to the uid simulation Type boolean, default False use_animated_mesh Export this mesh as an animated one. Slower, only use if really necessary (e.g. armatures or parented objects), animated pos/rot/scale IPOs do not require it Type boolean, default False

2.4. Types ([Link])

733

Blender Index, Release 2.59.2 - API

bpy_struct.id_data [Link]
Inherited Functions

2.4.396 PackedFile(bpy_struct)
base class bpy_struct class [Link](bpy_struct) External le packed into the .blend le size Size of packed le in bytes Type int in [-inf, inf], default 0, (readonly)
Inherited Properties

bpy_struct.id_data

734

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Functions

References

Image.packed_file Sound.packed_file VectorFont.packed_file

2.4.397 Paint(bpy_struct)
base class bpy_struct subclasses VertexPaint, Sculpt, ImagePaint class [Link](bpy_struct) brush Active Brush Type Brush show_brush Type boolean, default False show_brush_on_surface Type boolean, default False show_low_resolution For multires, show low resolution while navigating the view Type boolean, default False
Inherited Properties

bpy_struct.id_data

2.4. Types ([Link])

735

Blender Index, Release 2.59.2 - API

Inherited Functions

2.4.398 Panel(bpy_struct)
Basic Panel Example This script is a simple panel which will draw into the object properties section. Notice the CATEGORY_PT_name Panel.bl_idname, this is a naming convention for panels. Note: Panel subclasses must be registered for blender to use them.
import bpy

class HelloWorldPanel([Link]): bl_idname = "OBJECT_PT_hello_world" bl_label = "Hello World" bl_space_type = PROPERTIES bl_region_type = WINDOW bl_context = "object" def draw(self, context): [Link](text="Hello World")

[Link].register_class(HelloWorldPanel)

Simple Object Panel This panel has a [Link] and Panel.draw_header function, even though the contents is basic this closely resemples blenders panels.
import bpy

736

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

class ObjectSelectPanel([Link]): bl_idname = "OBJECT_PT_select" bl_label = "Select" bl_space_type = PROPERTIES bl_region_type = WINDOW bl_context = "object" bl_options = {DEFAULT_CLOSED} @classmethod def poll(cls, context): return ([Link] is not None) def draw_header(self, context): layout = [Link] obj = [Link] [Link](obj, "select", text="") def draw(self, context): layout = [Link] obj = [Link] row = [Link]() [Link](obj, "hide_select") [Link](obj, "hide_render") box = [Link]() [Link]("Selection Tools") [Link]("object.select_all") row = [Link]() [Link]("object.select_inverse") [Link]("object.select_random")

[Link].register_class(ObjectSelectPanel)

Mix-in Classes A mix-in parent class can be used to share common properties and [Link] function.
import bpy

class View3DPanel(): bl_space_type = VIEW_3D bl_region_type = TOOLS @classmethod def poll(cls, context): return ([Link] is not None)

class PanelOne(View3DPanel, [Link]): bl_idname = "VIEW3D_PT_test_1" bl_label = "Panel One" def draw(self, context): [Link]("Small Class")

2.4. Types ([Link])

737

Blender Index, Release 2.59.2 - API

class PanelTwo(View3DPanel, [Link]): bl_idname = "VIEW3D_PT_test_2" bl_label = "Panel Two" def draw(self, context): [Link]("Also Small Class")

[Link].register_class(PanelOne) [Link].register_class(PanelTwo)

base class bpy_struct class [Link](bpy_struct) Panel containing UI elements bl_context The context in which the panel belongs to. bl_context/bl_region_type/bl_space_type) Type string, default bl_idname If this is set, the panel gets a custom ID, otherwise it takes the name of the class used to dene the panel. For example, if the class name is OBJECT_PT_hello, and bl_idname is not set by the script, then bl_idname = OBJECT_PT_hello Type string, default bl_label The panel label, shows up in the panel header at the right of the triangle used to collapse the panel. Type string, default bl_options Options for this panel type DEFAULT_CLOSED Default Closed, Denes if the panel has to be open or collapsed at the time of its creation.. HIDE_HEADER Show Header, If set to True, the panel shows a header, which contains a clickable arrow to collapse the panel and the label (see bl_label).. Type enum set in {DEFAULT_CLOSED, FAULT_CLOSED} bl_region_type The region where the panel is going to be used in. Type enum in [WINDOW, HEADER, CHANNELS, TEMPORARY, UI, TOOLS, TOOL_PROPS, PREVIEW], default WINDOW bl_space_type The space where the panel is going to be used in. Type enum in [EMPTY, VIEW_3D, GRAPH_EDITOR, OUTLINER, PROPERTIES, FILE_BROWSER, IMAGE_EDITOR, INFO, SEQUENCE_EDITOR, TEXT_EDITOR, AUDIO_WINDOW, DOPESHEET_EDITOR, NLA_EDITOR, SCRIPTS_WINDOW, TIMELINE, NODE_EDITOR, LOGIC_EDITOR, CONSOLE, USER_PREFERENCES], default EMPTY 738 Chapter 2. Application Modules HIDE_HEADER}, default {DE(TODO: explain the possible combinations

Blender Index, Release 2.59.2 - API

layout Denes the structure of the panel in the UI. Type UILayout, (readonly) text XXX todo Type string, default classmethod poll(context) If this method returns a non-null output, then the panel can be drawn. Return type boolean draw(context) Draw UI elements into the panel UI layout.

draw_header(context) Draw UI elements into the panels header UI layout.

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

739

Blender Index, Release 2.59.2 - API

2.4.399 ParentActuator(Actuator)
base classes bpy_struct, Actuator class [Link](Actuator) mode Type enum in [SETPARENT, REMOVEPARENT], default SETPARENT object Set this object as parent Type Object use_compound Add this object shape to the parent shape (only if the parent shape is already compound) Type boolean, default False use_ghost Make this object ghost while parented Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] Actuator.show_expanded [Link] [Link]

Inherited Functions

740

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.400 Particle(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Particle in a particle system alive_state Type enum in [DEAD, UNBORN, ALIVE, DYING], default DEAD angular_velocity Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) birth_time Type oat in [-inf, inf], default 0.0 die_time Type oat in [-inf, inf], default 0.0 hair_keys Type bpy_prop_collection of ParticleHairKey, (readonly) is_exist Type boolean, default False, (readonly) is_visible Type boolean, default False, (readonly) lifetime Type oat in [-inf, inf], default 0.0 location Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) particle_keys Type bpy_prop_collection of ParticleKey, (readonly) prev_angular_velocity Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) prev_location Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) prev_rotation Type oat array of 4 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0) prev_velocity Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) rotation Type oat array of 4 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0) size Type oat in [-inf, inf], default 0.0

2.4. Types ([Link])

741

Blender Index, Release 2.59.2 - API

velocity Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.401 ParticleBrush(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Particle editing brush count Particle count Type int in [1, 1000], default 0 curve Type CurveMapping, (readonly) length_mode GROW Grow, Make hairs longer. SHRINK Shrink, Make hairs shorter. Type enum in [GROW, SHRINK], default GROW

742

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

puff_mode ADD Add, Make hairs more puffy. SUB Sub, Make hairs less puffy. Type enum in [ADD, SUB], default ADD size Radius of the brush in pixels Type int in [1, 32767], default 0 steps Brush steps Type int in [1, 32767], default 0 strength Brush strength Type oat in [0.001, 1], default 0.0 use_puff_volume Apply puff to unselected end-points, (helps maintain hair volume when pufng root) Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4. Types ([Link])

743

Blender Index, Release 2.59.2 - API

2.4.402 ParticleDupliWeight(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Weight of a particle dupliobject in a group count The number of times this object is repeated with respect to other objects Type int in [0, 32767], default 0 name Particle dupliobject name Type string, default , (readonly)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

ParticleSettings.active_dupliweight ParticleSettings.dupli_weights

2.4.403 ParticleEdit(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Properties of particle editing mode brush

744

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type ParticleBrush, (readonly) default_key_count How many keys to make new particles with Type int in [2, 32767], default 0 draw_step How many steps to draw the path with Type int in [2, 10], default 0 emitter_distance Distance to keep particles away from the emitter Type oat in [0, inf], default 0.0 fade_frames How many frames to fade Type int in [2, 100], default 0 is_editable A valid edit mode exists Type boolean, default False, (readonly) is_hair Editing hair Type boolean, default False, (readonly) object The edited object Type Object, (readonly) select_mode Particle select and display mode PATH Path, Path edit mode. POINT Point, Point select mode. TIP Tip, Tip select mode. Type enum in [PATH, POINT, TIP], default PATH show_particles Draw actual particles Type boolean, default False tool NONE None, Dont use any brush. COMB Comb, Comb hairs. SMOOTH Smooth, Smooth hairs. ADD Add, Add hairs. LENGTH Length, Make hairs longer or shorter. PUFF Puff, Make hairs stand up.

2.4. Types ([Link])

745

Blender Index, Release 2.59.2 - API

CUT Cut, Cut hairs. WEIGHT Weight, Weight hair particles. Type enum in [NONE, COMB, SMOOTH, ADD, LENGTH, PUFF, CUT, WEIGHT], default COMB type Type enum in [PARTICLES, SOFT_BODY, CLOTH], default PARTICLES use_auto_velocity Calculate point velocities automatically Type boolean, default False use_default_interpolate Interpolate new particles from the existing ones Type boolean, default False use_emitter_deflect Keep paths from intersecting the emitter Type boolean, default False use_fade_time Fade paths and keys further away from current frame Type boolean, default False use_preserve_length Keep path lengths constant Type boolean, default False use_preserve_root Keep root keys unmodied Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

746

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

ToolSettings.particle_edit

2.4.404 ParticleFluidSettings(FluidSettings)
base classes bpy_struct, FluidSettings class [Link](FluidSettings) Fluid simulation settings for objects storing uid particles generated by the simulation alpha_influence Amount of particle alpha change, inverse of size inuence: 0=off (all same alpha), 1=full. (large particles get lower alphas, smaller ones higher values) Type oat in [0, 2], default 0.0 filepath Directory (and/or lename prex) to store and load particles from Type string, default particle_influence Amount of particle size scaling: 0=off (all same size), 1=full (range 0.2-2.0), >1=stronger Type oat in [0, 2], default 0.0 show_tracer Show tracer particles Type boolean, default False use_drops Show drop particles Type boolean, default False use_floats Show oating foam particles Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link]
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove 2.4. Types ([Link]) 747

Blender Index, Release 2.59.2 - API

2.4.405 ParticleHairKey(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Particle key for hair particle system co Location of the hair key in object space Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) co_hair_space Location of the hair key in its internal coordinate system, relative to the emitting face Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) time Relative time of key over hair length Type oat in [0, inf], default 0.0 weight Weight for cloth simulation Type oat in [0, 1], default 0.0
Inherited Properties

bpy_struct.id_data
Inherited Functions

748

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

Particle.hair_keys

2.4.406 ParticleInstanceModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Particle system instancing modier axis Pole axis for rotation Type enum in [X, Y, Z], default X object Object that has the particle system Type Object particle_system_index Type int in [1, 10], default 0 position Position along path Type oat in [0, 1], default 0.0 random_position Randomize position along path Type oat in [0, 1], default 0.0 show_alive Show instances when particles are alive Type boolean, default False show_dead Show instances when particles are dead Type boolean, default False show_unborn Show instances when particles are unborn Type boolean, default False use_children Create instances from child particles Type boolean, default False 2.4. Types ([Link]) 749

Blender Index, Release 2.59.2 - API

use_normal Create instances from normal particles Type boolean, default False use_path Create instances along particle paths Type boolean, default False use_preserve_shape Dont stretch the object Type boolean, default False use_size Use particle size to scale the instances Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

2.4.407 ParticleKey(bpy_struct)
base class bpy_struct

750

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

class [Link](bpy_struct) Key location for a particle over time angular_velocity Key angular velocity Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) location Key location Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) rotation Key rotation quaternion Type oat array of 4 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0) time Time of key over the simulation Type oat in [0, inf], default 0.0 velocity Key velocity Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data
Inherited Functions

Blender Index, Release 2.59.2 - API

Type boolean, default False use_self_effect Particle effectors effect themselves Type boolean, default False use_simplify Remove child strands as the object becomes smaller on the screen Type boolean, default False use_simplify_viewport Type boolean, default False use_size_deflect Use particles size in deection Type boolean, default False use_strand_primitive Use the strand primitive for rendering Type boolean, default False use_velocity_length Multiply line length by particle speed Type boolean, default False use_whole_group Use whole group at once Type boolean, default False userjit Emission locations / face (0 = automatic) Type int in [0, 1000], default 0 virtual_parents Relative amount of virtual parents Type oat in [0, 1], default 0.0
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add

2.4. Types ([Link])

763

Blender Index, Release 2.59.2 - API

References

[Link] [Link] [Link] [Link]

2.4.409 ParticleSettingsTextureSlot(TextureSlot)
base classes bpy_struct, TextureSlot class [Link](TextureSlot) Texture slot for textures in a Particle Settings datablock clump_factor Amount texture affects child clump Type oat in [-inf, inf], default 0.0 damp_factor Amount texture affects particle damping Type oat in [-inf, inf], default 0.0 density_factor Amount texture affects particle density Type oat in [-inf, inf], default 0.0 field_factor Amount texture affects particle force elds Type oat in [-inf, inf], default 0.0 gravity_factor Amount texture affects particle gravity Type oat in [-inf, inf], default 0.0

764

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

kink_factor Amount texture affects child kink Type oat in [-inf, inf], default 0.0 length_factor Amount texture affects child hair length Type oat in [-inf, inf], default 0.0 life_factor Amount texture affects particle life time Type oat in [-inf, inf], default 0.0 mapping FLAT Flat, Maps X and Y coordinates directly. CUBE Cube, Maps using the normal vector. TUBE Tube, Maps with Z as central axis. SPHERE Sphere, Maps with Z as central axis. Type enum in [FLAT, CUBE, TUBE, SPHERE], default FLAT mapping_x Type enum in [NONE, X, Y, Z], default NONE mapping_y Type enum in [NONE, X, Y, Z], default NONE mapping_z Type enum in [NONE, X, Y, Z], default NONE object Object to use for mapping with Object texture coordinates Type Object rough_factor Amount texture affects child roughness Type oat in [-inf, inf], default 0.0 size_factor Amount texture affects physical particle size Type oat in [-inf, inf], default 0.0 texture_coords Texture coordinates used to map the texture onto the background GLOBAL Global, Uses global coordinates for the texture coordinates. OBJECT Object, Uses linked objects coordinates for texture coordinates. UV UV, Uses UV coordinates for texture coordinates. ORCO Generated, Uses the original undeformed coordinates of the object. STRAND Strand / Particle, Uses normalized strand texture coordinate (1D) or particle age (X) and trail position (Y).

2.4. Types ([Link])

765

Blender Index, Release 2.59.2 - API

Type enum in [GLOBAL, OBJECT, UV, ORCO, STRAND], default GLOBAL time_factor Amount texture affects particle emission time Type oat in [-inf, inf], default 0.0 use_map_clump Affect the child clumping Type boolean, default False use_map_damp Affect the particle velocity damping Type boolean, default False use_map_density Affect the density of the particles Type boolean, default False use_map_field Affect the particle force elds Type boolean, default False use_map_gravity Affect the particle gravity Type boolean, default False use_map_kink Affect the child kink Type boolean, default False use_map_length Affect the child hair length Type boolean, default False use_map_life Affect the life time of the particles Type boolean, default False use_map_rough Affect the child rough Type boolean, default False use_map_size Affect the particle size Type boolean, default False use_map_time Affect the emission time of the particles Type boolean, default False use_map_velocity Affect the particle initial velocity Type boolean, default False

766

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

uv_layer UV layer to use for mapping with UV texture coordinates Type string, default velocity_factor Amount texture affects particle initial velocity Type oat in [-inf, inf], default 0.0
Inherited Properties

bpy_struct.id_data [Link] TextureSlot.blend_type [Link] TextureSlot.default_value [Link] [Link] TextureSlot.output_node TextureSlot.use_rgb_to_intensity [Link] TextureSlot.use_stencil [Link]

Inherited Functions

References

ParticleSettings.texture_slots [Link] [Link]

2.4. Types ([Link])

767

Blender Index, Release 2.59.2 - API

2.4.410 ParticleSettingsTextureSlots(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of texture slots classmethod add() add Returns The newly initialized mtex. Return type ParticleSettingsTextureSlot classmethod create(index) create Parameters index (int in [0, inf]) Index, Slot index to initialize. Returns The newly initialized mtex. Return type ParticleSettingsTextureSlot classmethod clear(index) clear Parameters index (int in [0, inf]) Index, Slot index to clear.
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

ParticleSettings.texture_slots

768

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.411 ParticleSystem(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Particle system in an object active_particle_target Type ParticleTarget, (readonly) active_particle_target_index Type int in [0, inf], default 0 billboard_normal_uv UV Layer to control billboard normals Type string, default billboard_split_uv UV Layer to control billboard splitting Type string, default billboard_time_index_uv UV Layer to control billboard time index (X-Y) Type string, default child_particles Child particles generated by the particle system Type bpy_prop_collection of ChildParticle, (readonly) child_seed Offset in the random number table for child particles, to get a different randomized result Type int in [0, inf], default 0 cloth Cloth dynamics for hair Type ClothModifier, (readonly, never None) has_multiple_caches Particle system has multiple point caches Type boolean, default False, (readonly) invert_vertex_group_clump Negate the effect of the clump vertex group Type boolean, default False invert_vertex_group_density Negate the effect of the density vertex group Type boolean, default False invert_vertex_group_field Negate the effect of the eld vertex group Type boolean, default False invert_vertex_group_kink Negate the effect of the kink vertex group 2.4. Types ([Link]) 769

Blender Index, Release 2.59.2 - API

Type boolean, default False invert_vertex_group_length Negate the effect of the length vertex group Type boolean, default False invert_vertex_group_rotation Negate the effect of the rotation vertex group Type boolean, default False invert_vertex_group_roughness_1 Negate the effect of the roughness 1 vertex group Type boolean, default False invert_vertex_group_roughness_2 Negate the effect of the roughness 2 vertex group Type boolean, default False invert_vertex_group_roughness_end Negate the effect of the roughness end vertex group Type boolean, default False invert_vertex_group_size Negate the effect of the size vertex group Type boolean, default False invert_vertex_group_tangent Negate the effect of the tangent vertex group Type boolean, default False invert_vertex_group_velocity Negate the effect of the velocity vertex group Type boolean, default False is_editable Particle system can be edited in particle mode Type boolean, default False, (readonly) is_edited Particle system has been edited in particle mode Type boolean, default False, (readonly) is_global_hair Hair keys are in global coordinate space Type boolean, default False, (readonly) name Particle system name Type string, default parent Use this objects coordinate system instead of global coordinate system Type Object

770

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

particles Particles generated by the particle system Type bpy_prop_collection of Particle, (readonly) point_cache Type PointCache, (readonly, never None) reactor_target_object For reactor systems, the object that has the target particle system (empty if same object) Type Object reactor_target_particle_system For reactor systems, index of particle system on the target object Type int in [1, 32767], default 0 seed Offset in the random number table, to get a different randomized result Type int in [0, inf], default 0 settings Particle system settings Type ParticleSettings, (never None) targets Target particle systems Type bpy_prop_collection of ParticleTarget, (readonly) use_hair_dynamics Enable hair dynamics using cloth simulation Type boolean, default False use_keyed_timing Use key times Type boolean, default False vertex_group_clump Vertex group to control clump Type string, default vertex_group_density Vertex group to control density Type string, default vertex_group_field Vertex group to control eld Type string, default vertex_group_kink Vertex group to control kink Type string, default vertex_group_length Vertex group to control length

2.4. Types ([Link])

771

Blender Index, Release 2.59.2 - API

Type string, default vertex_group_rotation Vertex group to control rotation Type string, default vertex_group_roughness_1 Vertex group to control roughness 1 Type string, default vertex_group_roughness_2 Vertex group to control roughness 2 Type string, default vertex_group_roughness_end Vertex group to control roughness end Type string, default vertex_group_size Vertex group to control size Type string, default vertex_group_tangent Vertex group to control tangent Type string, default vertex_group_velocity Vertex group to control velocity Type string, default
Inherited Properties

bpy_struct.id_data
Inherited Functions

772

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

References

Object.particle_systems ParticleSystemModifier.particle_system [Link] PointDensity.particle_system SmokeFlowSettings.particle_system

2.4.412 ParticleSystemModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Particle system simulation modier particle_system Particle System that this modier controls Type ParticleSystem, (readonly, never None)
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

2.4. Types ([Link])

773

Blender Index, Release 2.59.2 - API

2.4.413 ParticleSystems(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of particle systems active Active particle system being displayed Type ParticleSystem, (readonly) active_index Index of active particle system slot Type int in [0, inf], default 0
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Object.particle_systems

2.4.414 ParticleTarget(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Target particle system alliance Type enum in [FRIEND, NEUTRAL, ENEMY], default NEUTRAL

774

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

duration Type oat in [0, 30000], default 0.0 is_valid Keyed particles target is valid Type boolean, default False name Particle target name Type string, default , (readonly) object The object that has the target particle system (empty if same object) Type Object system The index of particle system on the target object Type int in [1, inf], default 0 time Type oat in [0, 30000], default 0.0
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

ParticleSystem.active_particle_target [Link]

2.4. Types ([Link])

775

Blender Index, Release 2.59.2 - API

2.4.415 PivotConstraint(Constraint)
base classes bpy_struct, Constraint class [Link](Constraint) Rotate around a different point head_tail Target along length of bone: Head=0, Tail=1 Type oat in [0, 1], default 0.0 offset Offset of pivot from target (when set), or from owners location (when Fixed Position is off), or the absolute pivot point Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) rotation_range Rotation range on which pivoting should occur ALWAYS_ACTIVE Always, Use the pivot point in every rotation. NX -X Rot, Use the pivot point in the negative rotation range around the X-axis. NY -Y Rot, Use the pivot point in the negative rotation range around the Y-axis. NZ -Z Rot, Use the pivot point in the negative rotation range around the Z-axis. X X Rot, Use the pivot point in the positive rotation range around the X-axis. Y Y Rot, Use the pivot point in the positive rotation range around the Y-axis. Z Z Rot, Use the pivot point in the positive rotation range around the Z-axis. Type enum in [ALWAYS_ACTIVE, NX, NY, NZ, X, Y, Z], default NX subtarget Type string, default target Target Object, dening the position of the pivot when dened Type Object use_relative_location Offset will be an absolute point in space instead of relative to the target Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] Constraint.show_expanded [Link] Constraint.error_location Constraint.owner_space Constraint.is_proxy_local

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values [Link] ID.user_clear ID.animation_data_create ID.animation_data_clear ID.update_tag [Link]

2.4.418 PointCache(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Point cache for physics simulations compression Compression method to be used NO No, No compression. LIGHT Light, Fast but not so effective compression. HEAVY Heavy, Effective but slow compression. Type enum in [NO, LIGHT, HEAVY], default NO filepath Cache le path Type string, default frame_end Frame on which the simulation stops Type int in [1, 300000], default 0 frame_start Frame on which the simulation starts Type int in [1, 300000], default 0 frame_step Number of frames between cached frames Type int in [1, 20], default 0 frames_skipped Type boolean, default False, (readonly) index Index number of cache les Type int in [-1, 100], default 0 info Info on current cache status Type string, default , (readonly) is_baked 780 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type boolean, default False, (readonly) is_baking Type boolean, default False, (readonly) is_outdated Type boolean, default False, (readonly) name Cache name Type string, default point_caches Point cache list Type PointCaches bpy_prop_collection of PointCache, (readonly) use_disk_cache Save cache les to disk (.blend le must be saved rst) Type boolean, default False use_external Read cache from an external location Type boolean, default False use_library_path Use this les path when library linked into another le. Type boolean, default False use_quick_cache Update simulation with cache steps Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

781

Blender Index, Release 2.59.2 - API

bpy_struct.type_recast bpy_struct.values
References

ClothModifier.point_cache ParticleSystem.point_cache PointCache.point_caches SmokeDomainSettings.point_cache SoftBodyModifier.point_cache

2.4.419 PointCaches(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of point caches active_index Type int in [0, inf], default 0
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

PointCache.point_caches

782

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.420 PointDensity(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Point density settings color_ramp Type ColorRamp, (readonly) color_source Data to derive color results from CONSTANT Constant. PARTICLE_AGE Particle Age, Lifetime mapped as 0.0 - 1.0 intensity. PARTICLE_SPEED Particle Speed, Particle speed (absolute magnitude of velocity) mapped as 0.01.0 intensity. PARTICLE_VELOCITY Particle Velocity, XYZ velocity mapped to RGB colors. Type enum in [CONSTANT, PARTICLE_AGE, CLE_VELOCITY], default CONSTANT falloff Method of attenuating density by distance from the point STANDARD Standard. SMOOTH Smooth. SOFT Soft. CONSTANT Constant, Density is constant within lookup radius. ROOT Root. PARTICLE_AGE Particle Age. PARTICLE_VELOCITY Particle Velocity. Type enum in [STANDARD, SMOOTH, SOFT, CONSTANT, ROOT, PARTICLE_AGE, PARTICLE_VELOCITY], default STANDARD falloff_curve Type CurveMapping, (readonly) falloff_soft Softness of the soft falloff option Type oat in [0.01, inf], default 0.0 falloff_speed_scale Multiplier to bring particle speed within an acceptable range Type oat in [0.001, 100], default 0.0 noise_basis Noise formula used for turbulence BLENDER_ORIGINAL Blender Original, Noise algorithm - Blender original: Smooth interpolated noise. 2.4. Types ([Link]) 783 PARTICLE_SPEED, PARTI-

Blender Index, Release 2.59.2 - API

ORIGINAL_PERLIN Original Perlin, Noise algorithm - Original Perlin: Smooth interpolated noise. IMPROVED_PERLIN Improved Perlin, Noise algorithm - Improved Perlin: Smooth interpolated noise. VORONOI_F1 Voronoi F1, Noise algorithm - Voronoi F1: Returns distance to the closest feature point. VORONOI_F2 Voronoi F2, Noise algorithm - Voronoi F2: Returns distance to the 2nd closest feature point. VORONOI_F3 Voronoi F3, Noise algorithm - Voronoi F3: Returns distance to the 3rd closest feature point. VORONOI_F4 Voronoi F4, Noise algorithm - Voronoi F4: Returns distance to the 4th closest feature point. VORONOI_F2_F1 Voronoi F2-F1, Noise algorithm - Voronoi F1-F2. VORONOI_CRACKLE Voronoi Crackle, Noise algorithm - Voronoi Crackle: Voronoi tessellation with sharp edges. CELL_NOISE Cell Noise, Noise algorithm - Cell Noise: Square cell tessallation. Type enum in [BLENDER_ORIGINAL, ORIGINAL_PERLIN, IMPROVED_PERLIN, VORONOI_F1, VORONOI_F2, VORONOI_F3, VORONOI_F4, VORONOI_F2_F1, VORONOI_CRACKLE, CELL_NOISE], default BLENDER_ORIGINAL object Object to take point data from Type Object particle_cache_space Co-ordinate system to cache particles in Type enum in [OBJECT_LOCATION, OBJECT_SPACE, WORLD_SPACE], default OBJECT_LOCATION particle_system Particle System to render as points Type ParticleSystem point_source Point data to use as renderable point density PARTICLE_SYSTEM Particle System, Generate point density from a particle system. OBJECT Object Vertices, Generate point density from an objects vertices. Type enum in [PARTICLE_SYSTEM, OBJECT], default PARTICLE_SYSTEM radius Radius from the shaded sample to look for points within Type oat in [0.001, inf], default 0.0 speed_scale Multiplier to bring particle speed within an acceptable range Type oat in [0.001, 100], default 0.0

784

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

turbulence_depth Level of detail in the added turbulent noise Type int in [0, 30], default 0 turbulence_influence Method for driving added turbulent noise STATIC Static, Noise patterns will remain unchanged, faster and suitable for stills. PARTICLE_VELOCITY Particle Velocity, Turbulent noise driven by particle velocity. PARTICLE_AGE Particle Age, Turbulent noise driven by the particles age between birth and death. GLOBAL_TIME Global Time, Turbulent noise driven by the global current frame. Type enum in [STATIC, PARTICLE_VELOCITY, GLOBAL_TIME], default STATIC turbulence_scale Scale of the added turbulent noise Type oat in [0.01, inf], default 0.0 turbulence_strength Type oat in [0.01, inf], default 0.0 use_falloff_curve Use a custom falloff curve Type boolean, default False use_turbulence Add directed noise to the density at render-time Type boolean, default False vertex_cache_space Co-ordinate system to cache vertices in Type enum in [OBJECT_LOCATION, OBJECT_SPACE, WORLD_SPACE], default OBJECT_LOCATION
Inherited Properties

PARTICLE_AGE,

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

PointDensityTexture.point_density

2.4.421 PointDensityTexture(Texture)
base classes bpy_struct, ID, Texture class [Link](Texture) Settings for the Point Density texture point_density The point density settings associated with this texture Type PointDensity, (readonly) users_material Materials that use this texture (readonly) users_object_modifier Object modiers that use this texture (readonly)
Inherited Properties

786

Blender Index, Release 2.59.2 - API

Inherited Functions

2.4.422 PointLamp(Lamp)
base classes bpy_struct, ID, Lamp class [Link](Lamp) Omnidirectional point lamp falloff_curve Custom Lamp Falloff Curve Type CurveMapping, (readonly) falloff_type Intensity Decay with distance Type enum in [CONSTANT, INVERSE_LINEAR, INVERSE_SQUARE, CUSTOM_CURVE, LINEAR_QUADRATIC_WEIGHTED], default CONSTANT linear_attenuation Linear distance attenuation Type oat in [0, 1], default 0.0 quadratic_attenuation Quadratic distance attenuation Type oat in [0, 1], default 0.0 shadow_adaptive_threshold Threshold for Adaptive Sampling (Raytraced shadows) Type oat in [0, 1], default 0.0

2.4. Types ([Link])

787

Blender Index, Release 2.59.2 - API

shadow_color Color of shadows cast by the lamp Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) shadow_method Method to compute lamp shadow with NOSHADOW No Shadow. RAY_SHADOW Ray Shadow, Use ray tracing for shadow. Type enum in [NOSHADOW, RAY_SHADOW], default NOSHADOW shadow_ray_sample_method Method for generating shadow samples: Adaptive QMC is fastest, Constant QMC is less noisy but slower Type enum in [ADAPTIVE_QMC, CONSTANT_QMC], default ADAPTIVE_QMC shadow_ray_samples Amount of samples taken extra (samples x samples) Type int in [1, 64], default 0 shadow_soft_size Light size for ray shadow sampling (Raytraced shadows) Type oat in [-inf, inf], default 0.0 use_only_shadow Causes light to cast shadows only without illuminating objects Type boolean, default False use_shadow_layer Causes only objects on the same layer to cast shadows Type boolean, default False use_sphere Sets light intensity to zero beyond lamp distance Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link] Lamp.active_texture Lamp.active_texture_index Lamp.animation_data [Link] Lamp.use_diffuse [Link] [Link] Lamp.use_own_layer

788

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Lamp.use_negative Lamp.use_specular Lamp.texture_slots [Link]

Inherited Functions

2.4.423 PointerProperty(Property)
base classes bpy_struct, Property class [Link](Property) RNA pointer property to point to another RNA struct fixed_type Fixed pointer type, empty if variable type Type Struct, (readonly)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] Property.is_enum_flag Property.is_hidden [Link] Property.is_never_none Property.is_readonly Property.is_registered 789

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

Property.is_registered_optional Property.is_required Property.is_output Property.is_runtime Property.is_skip_save [Link] [Link] [Link]

Inherited Functions

2.4.424 Pose(bpy_struct)
base class bpy_struct class [Link](bpy_struct) A collection of pose channels, including settings for animating bones animation_visualisation Animation data for this datablock Type AnimViz, (readonly, never None) bone_groups Groups of the bones Type BoneGroups bpy_prop_collection of BoneGroup, (readonly) bones Individual pose bones for the armature Type bpy_prop_collection of PoseBone, (readonly) ik_param Parameters for IK solver Type IKParam, (readonly) ik_solver Selection of IK solver for IK chain, current choice is 0 for Legacy, 1 for iTaSC

790

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

LEGACY Legacy, Original IK solver. ITASC iTaSC, Multi constraint, stateful IK solver. Type enum in [LEGACY, ITASC], default LEGACY
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.426 PoseBoneConstraints(bpy_struct)
base class bpy_struct 796 Chapter 2. Application Modules

base class bpy_struct subclasses OperatorFileListElement, OperatorMousePath, OperatorStrokeElement class [Link](bpy_struct) Group of ID properties name Unique name used in the code and scripting Type string, default
Inherited Properties

bpy_struct.id_data

802

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Functions

References

[Link] [Link] PropertyGroupItem.idp_array

2.4.430 PropertyGroupItem(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Property that stores arbitrary, user dened properties collection Type bpy_prop_collection of PropertyGroup, (readonly) double Type oat in [-inf, inf], default 0.0 double_array Type oat array of 1 items in [-inf, inf], default (0.0) float Type oat in [-inf, inf], default 0.0 float_array Type oat array of 1 items in [-inf, inf], default (0.0) group Type PropertyGroup, (readonly) idp_array Type bpy_prop_collection of PropertyGroup, (readonly)

2.4. Types ([Link])

803

Blender Index, Release 2.59.2 - API

int Type int in [-inf, inf], default 0 int_array Type int array of 1 items in [-inf, inf], default (0,) string Type string, default
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4.431 PropertySensor(Sensor)
base classes bpy_struct, Sensor class [Link](Sensor) Sensor to detect values and changes in values of properties evaluation_type Type of property evaluation Type enum in [PROPEQUAL, PROPNEQUAL, PROPINTERVAL, PROPCHANGED], default PROPEQUAL property Type string, default value Check for this value in types in Equal or Not Equal types Type string, default

804

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

value_max Specify maximum value in Interval type Type string, default value_min Specify minimum value in Interval type Type string, default
Inherited Properties

bpy_struct.id_data [Link] Sensor.show_expanded [Link] [Link] Sensor.use_level [Link] Sensor.use_pulse_false_level Sensor.use_pulse_true_level Sensor.use_tap [Link]

Inherited Functions

2.4.432 PythonConstraint(Constraint)
base classes bpy_struct, Constraint class [Link](Constraint) Uses Python script for constraint evaluation has_script_error The linked Python script has thrown an error 2.4. Types ([Link]) 805

Blender Index, Release 2.59.2 - API

Type boolean, default False, (readonly) target_count Usually only 1-3 are needed Type int in [-inf, inf], default 0 targets Target Objects Type bpy_prop_collection of ConstraintTarget, (readonly) text The text object that contains the Python script Type Text use_targets Use the targets indicated in the constraint panel Type boolean, default False
Inherited Properties

Inherited Functions

806

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.433 PythonController(Controller)
base classes bpy_struct, Controller class [Link](Controller) Controller executing a python script mode Python script type (textblock or module - faster) Type enum in [SCRIPT, MODULE], default SCRIPT module Module name and function to run e.g. [Link]. Internal texts and external python les can be used Type string, default text Text datablock with the python script Type Text use_debug Continuously reload the module from disk for editing external modules without restarting Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] [Link] Controller.show_expanded Controller.use_priority [Link]

Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

2.4.434 RadarSensor(Sensor)
base classes bpy_struct, Sensor class [Link](Sensor) Sensor to detect objects in a cone shaped radar emanating from the current object angle Opening angle of the radar cone (in degrees) Type oat in [0, 179.9], default 0.0 axis Specify along which axis the radar cone is cast Type enum in [XAXIS, YAXIS, ZAXIS, NEGXAXIS, NEGYAXIS, NEGZAXIS], default XAXIS distance Depth of the radar cone Type oat in [0, 10000], default 0.0 property Only look for Objects with this property (blank = all objects) Type string, default
Inherited Properties

bpy_struct.id_data [Link] Sensor.show_expanded [Link] [Link] Sensor.use_level [Link] Sensor.use_pulse_false_level Sensor.use_pulse_true_level Sensor.use_tap [Link]

Inherited Functions

808

Blender Index, Release 2.59.2 - API

bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values [Link] [Link]

2.4.435 RandomActuator(Actuator)
base classes bpy_struct, Actuator class [Link](Actuator) Actuator to .. chance Pick a number between 0 and 1. Success if you stay below this value Type oat in [0, 1], default 0.0 distribution Choose the type of distribution Type enum in [BOOL_CONSTANT, BOOL_UNIFORM, BOOL_BERNOUILLI, INT_CONSTANT, INT_UNIFORM, INT_POISSON, FLOAT_CONSTANT, FLOAT_UNIFORM, FLOAT_NORMAL, FLOAT_NEGATIVE_EXPONENTIAL], default BOOL_CONSTANT float_max Choose a number from a range. Upper boundary of the range Type oat in [-1000, 1000], default 0.0 float_mean A normal distribution. Mean of the distribution Type oat in [-1000, 1000], default 0.0 float_min Choose a number from a range. Lower boundary of the range Type oat in [-1000, 1000], default 0.0 float_value Always return this number Type oat in [0, 1], default 0.0 half_life_time Negative exponential dropoff Type oat in [-1000, 1000], default 0.0 int_max Choose a number from a range. Upper boundary of the range Type int in [-1000, 1000], default 0 int_mean Expected mean value of the distribution Type oat in [0.01, 100], default 0.0 int_min Choose a number from a range. Lower boundary of the range

2.4. Types ([Link])

809

Blender Index, Release 2.59.2 - API

Type int in [-1000, 1000], default 0 int_value Always return this number Type int in [-inf, inf], default 0 property Assign the random value to this property Type string, default seed Initial seed of the random generator. Use Python for more freedom (choose 0 for not random) Type int in [0, 300000], default 0 standard_derivation A normal distribution. Standard deviation of the distribution Type oat in [-1000, 1000], default 0.0 use_always_true Always false or always true Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] Actuator.show_expanded [Link] [Link]

Inherited Functions

810

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.436 RandomSensor(Sensor)
base classes bpy_struct, Sensor class [Link](Sensor) Sensor to send random events seed Initial seed of the generator. (Choose 0 for not random) Type int in [0, 1000], default 0
Inherited Properties

bpy_struct.id_data [Link] Sensor.show_expanded [Link] [Link] Sensor.use_level [Link] Sensor.use_pulse_false_level Sensor.use_pulse_true_level Sensor.use_tap [Link]

Inherited Functions

2.4.437 RaySensor(Sensor)
base classes bpy_struct, Sensor class [Link](Sensor) Sensor to detect intersections with a ray emanating from the current object

2.4. Types ([Link])

811

Blender Index, Release 2.59.2 - API

axis Specify along which axis the ray is cast Type enum in [XAXIS, YAXIS, ZAXIS, NEGXAXIS, NEGYAXIS, NEGZAXIS], default YAXIS material Only look for Objects with this material (blank = all objects) Type string, default property Only look for Objects with this property (blank = all objects) Type string, default range Sense objects no farther than this distance Type oat in [0.01, 10000], default 0.0 ray_type Toggle collision on material or property PROPERTY Property, Use a material for ray intersections. MATERIAL Material, Use a property for ray intersections. Type enum in [PROPERTY, MATERIAL], default PROPERTY use_x_ray Toggle X-Ray option (see through objects that dont have the property) Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] Sensor.show_expanded [Link] [Link] Sensor.use_level [Link] Sensor.use_pulse_false_level Sensor.use_pulse_true_level Sensor.use_tap [Link]

Inherited Functions

812

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.438 Region(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Region in a subdivided screen area height Region height Type int in [0, 32767], default 0, (readonly) id Unique ID for this region Type int in [-32768, 32767], default 0, (readonly) type Type of this region Type enum in [WINDOW, HEADER, CHANNELS, TEMPORARY, UI, TOOLS, TOOL_PROPS, PREVIEW], default WINDOW, (readonly) width Region width Type int in [0, 32767], default 0, (readonly) tag_redraw() tag_redraw
Inherited Properties

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden

2.4. Types ([Link])

813

Blender Index, Release 2.59.2 - API

bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

[Link] [Link]

2.4.439 RegionView3D(bpy_struct)
base class bpy_struct class [Link].RegionView3D(bpy_struct) 3D View region data is_perspective Type boolean, default False lock_rotation Lock view rotation in side views Type boolean, default False perspective_matrix Current perspective matrix of the 3D region Type oat array of 16 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0), (readonly) show_sync_view Sync view position between side views Type boolean, default False use_box_clip Clip objects based on whats visible in other side views Type boolean, default False view_distance Distance to the view location Type oat in [0, inf], default 0.0 view_location View pivot location Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) view_matrix Current view matrix of the 3D region

814

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type oat array of 16 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0) view_perspective View Perspective Type enum in [PERSP, ORTHO, CAMERA], default ORTHO view_rotation Rotation in quaternions (keep normalized) Type oat array of 4 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Context.region_data SpaceView3D.region_3d SpaceView3D.region_quadview

2.4.440 RenderEngine(bpy_struct)
Simple Render Engine
import bpy

class CustomRenderEngine([Link]): # These three members are used by blender to set up the # RenderEngine; define its internal name, visible name and capabilities.

2.4. Types ([Link])

815

Blender Index, Release 2.59.2 - API

bl_idname = custom_renderer bl_label = Flat Color Renderer bl_use_preview = True # This is the only method called by blender, in this example # we use it to detect preview rendering and call the implementation # in another method. def render(self, scene): scale = [Link].resolution_percentage / 100.0 self.size_x = int([Link].resolution_x * scale) self.size_y = int([Link].resolution_y * scale) if [Link] == preview: self.render_preview(scene) else: self.render_scene(scene) # In this example, we fill the preview renders with a flat green color. def render_preview(self, scene): pixel_count = self.size_x * self.size_y # The framebuffer is defined as a list of pixels, each pixel # itself being a list of R,G,B,A values green_rect = [[0.0, 1.0, 0.0, 1.0]] * pixel_count # Here we write the pixel values to the RenderResult result = self.begin_result(0, 0, self.size_x, self.size_y) layer = [Link][0] [Link] = green_rect self.end_result(result) # In this example, we fill the full renders with a flat blue color. def render_scene(self, scene): pixel_count = self.size_x * self.size_y # The framebuffer is defined as a list of pixels, each pixel # itself being a list of R,G,B,A values blue_rect = [[0.0, 0.0, 1.0, 1.0]] * pixel_count # Here we write the pixel values to the RenderResult result = self.begin_result(0, 0, self.size_x, self.size_y) layer = [Link][0] [Link] = blue_rect self.end_result(result) # Register the RenderEngine [Link].register_class(CustomRenderEngine) # RenderEngines also need to tell UI Panels that they are compatible # Otherwise most of the UI will be empty when the engine is selected. # In this example, we need to see the main render image button and # the material preview panel. from bl_ui import properties_render properties_render.RENDER_PT_render.COMPAT_ENGINES.add(custom_renderer) del properties_render from bl_ui import properties_material properties_material.MATERIAL_PT_preview.COMPAT_ENGINES.add(custom_renderer)

816

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

del properties_material

base class bpy_struct class [Link](bpy_struct) Render engine bl_idname Type string, default bl_label Type string, default bl_use_postprocess Type boolean, default False bl_use_preview Type boolean, default False render(scene=None) Render scene into an image.

begin_result(x, y, w, h) begin_result Parameters x (int in [0, inf]) X y (int in [0, inf]) Y w (int in [0, inf]) Width h (int in [0, inf]) Height Returns Result Return type RenderResult update_result(result) update_result Parameters result (RenderResult) Result end_result(result) end_result Parameters result (RenderResult) Result test_break() test_break Returns Break Return type boolean update_stats(stats, info) update_stats Parameters stats (string) Stats

2.4. Types ([Link])

817

Blender Index, Release 2.59.2 - API

info (string) Info report(type, message) report Parameters type (enum set in {DEBUG, INFO, OPERATOR, WARNING, ROR, ERROR_INVALID_INPUT, ERROR_INVALID_CONTEXT, ROR_OUT_OF_MEMORY}) Type message (string) Report Message
Inherited Properties

ERER-

bpy_struct.id_data
Inherited Functions

2.4.441 RenderLayer(bpy_struct)
base class bpy_struct class [Link](bpy_struct) exclude_ambient_occlusion Exclude AO pass from combined Type boolean, default False, (readonly) exclude_emit Exclude emission pass from combined Type boolean, default False, (readonly) exclude_environment Exclude environment pass from combined Type boolean, default False, (readonly) 818 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

exclude_indirect Exclude indirect pass from combined Type boolean, default False, (readonly) exclude_reflection Exclude raytraced reection pass from combined Type boolean, default False, (readonly) exclude_refraction Exclude raytraced refraction pass from combined Type boolean, default False, (readonly) exclude_shadow Exclude shadow pass from combined Type boolean, default False, (readonly) exclude_specular Exclude specular pass from combined Type boolean, default False, (readonly) invert_zmask For Zmask, only render what is behind solid z values instead of in front Type boolean, default False, (readonly) layers Scene layers included in this render layer Type boolean array of 20 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False), (readonly) layers_zmask Zmask scene layers for solid faces Type boolean array of 20 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False), (readonly) light_override Group to override all other lights in this render layer Type Group, (readonly) material_override Material to override all other materials in this render layer Type Material, (readonly) name Render layer name Type string, default , (readonly) passes Type bpy_prop_collection of RenderPass, (readonly) rect Type oat in [-inf, inf], default 0.0 use Disable or enable the render layer

2.4. Types ([Link])

819

Blender Index, Release 2.59.2 - API

Type boolean, default False, (readonly) use_all_z Fill in Z values for solid faces in invisible layers, for masking Type boolean, default False, (readonly) use_edge_enhance Render Edge-enhance in this Layer (only works for Solid faces) Type boolean, default False, (readonly) use_halo Render Halos in this Layer (on top of Solid) Type boolean, default False, (readonly) use_pass_ambient_occlusion Deliver AO pass Type boolean, default False, (readonly) use_pass_color Deliver shade-less color pass Type boolean, default False, (readonly) use_pass_combined Deliver full combined RGBA buffer Type boolean, default False, (readonly) use_pass_diffuse Deliver diffuse pass Type boolean, default False, (readonly) use_pass_emit Deliver emission pass Type boolean, default False, (readonly) use_pass_environment Deliver environment lighting pass Type boolean, default False, (readonly) use_pass_indirect Deliver indirect lighting pass Type boolean, default False, (readonly) use_pass_material_index Deliver material index pass Type boolean, default False, (readonly) use_pass_mist Deliver mist factor pass (0.0-1.0) Type boolean, default False, (readonly) use_pass_normal Deliver normal pass Type boolean, default False, (readonly)

820

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

use_pass_object_index Deliver object index pass Type boolean, default False, (readonly) use_pass_reflection Deliver raytraced reection pass Type boolean, default False, (readonly) use_pass_refraction Deliver raytraced refraction pass Type boolean, default False, (readonly) use_pass_shadow Deliver shadow pass Type boolean, default False, (readonly) use_pass_specular Deliver specular pass Type boolean, default False, (readonly) use_pass_uv Deliver texture UV pass Type boolean, default False, (readonly) use_pass_vector Deliver speed vector pass Type boolean, default False, (readonly) use_pass_z Deliver Z values pass Type boolean, default False, (readonly) use_sky Render Sky in this Layer Type boolean, default False, (readonly) use_solid Render Solid faces in this Layer Type boolean, default False, (readonly) use_strand Render Strands in this Layer Type boolean, default False, (readonly) use_zmask Only render whats in front of the solid z values Type boolean, default False, (readonly) use_ztransp Render Z-Transparent faces in this Layer (On top of Solid and Halos) Type boolean, default False, (readonly) load_from_file(lename, x=0, y=0) Copies the pixels of this renderlayer from an image le.

2.4. Types ([Link])

821

Blender Index, Release 2.59.2 - API

Parameters lename (string) Filename, Filename to load into this render tile, must be no smaller than the renderlayer x (int in [0, inf], (optional)) Offset X, Offset the position to copy from if the image is larger than the render layer y (int in [0, inf], (optional)) Offset Y, Offset the position to copy from if the image is larger than the render layer
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.442 RenderLayers(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of render layers active Active Render Layer Type SceneRenderLayer, (never None) active_index Active index in render layer array Type int in [-32768, 32767], default 0

822

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data
Inherited Functions

Blender Index, Release 2.59.2 - API

use_game_engine Current rendering engine is a game engine Type boolean, default False, (readonly) use_instances Instance support leads to effective memory reduction when using duplicates Type boolean, default False use_local_coords Vertex coordinates are stored localy on each primitive. Increases memory usage, but may have impact on speed Type boolean, default False use_motion_blur Use multi-sampled 3D scene motion blur Type boolean, default False use_overwrite Overwrite existing les while rendering Type boolean, default False use_placeholder Create empty placeholder les while rendering frames (similar to Unix touch) Type boolean, default False use_radiosity Calculate radiosity in a pre-process before rendering Type boolean, default False use_raytrace Pre-calculate the raytrace accelerator and render raytracing effects Type boolean, default False use_save_buffers Save tiles for all RenderLayers and SceneNodes to les in the temp directory (saves memory, required for Full Sample) Type boolean, default False use_sequencer Process the render (and composited) result through the video sequence editor pipeline, if sequencer strips exist Type boolean, default False use_sequencer_gl_preview Type boolean, default False use_sequencer_gl_render Type boolean, default False use_shadows Calculate shadows while rendering Type boolean, default False

834

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

use_simplify Enable simplication of scene for quicker preview renders Type boolean, default False use_simplify_triangulate Disables non-planer quads being triangulated Type boolean, default False use_single_layer Only render the active layer Type boolean, default False use_sss Calculate sub-surface scattering in materials rendering Type boolean, default False use_stamp Render the stamp info text in the rendered image Type boolean, default False use_stamp_camera Include the name of the active camera in image metadata Type boolean, default False use_stamp_date Include the current date in image metadata Type boolean, default False use_stamp_filename Include the lename of the .blend le in image metadata Type boolean, default False use_stamp_frame Include the frame number in image metadata Type boolean, default False use_stamp_lens Include the name of the active cameras lens in image metadata Type boolean, default False use_stamp_marker Include the name of the last marker in image metadata Type boolean, default False use_stamp_note Include a custom note in image metadata Type boolean, default False use_stamp_render_time Include the render time in the stamp image Type boolean, default False use_stamp_scene Include the name of the active scene in image metadata

2.4. Types ([Link])

835

Blender Index, Release 2.59.2 - API

Type boolean, default False use_stamp_sequencer_strip Include the name of the foreground sequence strip in image metadata Type boolean, default False use_stamp_time Include the render frame as HH:MM:[Link] in image metadata Type boolean, default False use_textures Use textures to affect material properties Type boolean, default False use_tiff_16bit Save TIFF with 16 bits per channel Type boolean, default False frame_path(frame=-2147483648) Return the absolute path to the lename to be written for a given frame. Parameters frame (int in [-inf, inf], (optional)) Frame number to use, if unset the current frame will be used. Returns File Path, the resulting lepath from the scenes render settings. Return type string
Inherited Properties

bpy_struct.id_data
Inherited Functions

836

Chapter 2. Application Modules

2.4.448 Scene(ID)
base classes bpy_struct, ID class [Link](ID) Scene consisting objects and dening time and render related settings animation_data Animation data for this datablock Type AnimData, (readonly) audio_distance_model Distance model for distance attenuation calculation NONE None, No distance attenuation. INVERSE Inverse, Inverse distance model. INVERSE_CLAMPED Inverse Clamped, Inverse distance model with clamping. LINEAR Linear, Linear distance model. LINEAR_CLAMPED Linear Clamped, Linear distance model with clamping. EXPONENT Exponent, Exponent distance model. EXPONENT_CLAMPED Exponent Clamped, Exponent distance model with clamping. Type enum in [NONE, INVERSE, INVERSE_CLAMPED, LINEAR, EAR_CLAMPED, EXPONENT, EXPONENT_CLAMPED], default NONE audio_doppler_factor Pitch factor for Doppler effect calculation Type oat in [0, inf], default 0.0 audio_doppler_speed Speed of sound for Doppler effect calculation Type oat in [0.01, inf], default 0.0 audio_volume Audio volume Type oat in [0, 1], default 0.0 background_set Background set scene Type Scene camera Active camera used for rendering the scene Type Object cursor_location 3D cursor location LIN-

842

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) frame_current Current Frame, to update animation data from python frame_set() instead Type int in [-300000, 300000], default 0 frame_end Final frame of the playback/rendering range Type int in [0, 300000], default 0 frame_preview_end Alternative end frame for UI playback Type int in [-inf, inf], default 0 frame_preview_start Alternative start frame for UI playback Type int in [-inf, inf], default 0 frame_start First frame of the playback/rendering range Type int in [0, 300000], default 0 frame_step Number of frames to skip forward while rendering/playing back each frame Type int in [0, 300000], default 0 frame_subframe Type oat in [-inf, inf], default 0.0, (readonly) game_settings Type SceneGameData, (readonly, never None) gravity Constant acceleration in a given direction Type oat array of 3 items in [-200, 200], default (0.0, 0.0, 0.0) grease_pencil Grease Pencil datablock Type GreasePencil is_nla_tweakmode Indicates whether there is any action referenced by NLA being edited. Strictly read-only Type boolean, default False, (readonly) keying_sets Absolute Keying Sets for this Scene Type KeyingSets bpy_prop_collection of KeyingSet, (readonly) keying_sets_all All Keying Sets available for use (Builtins and Absolute Keying Sets for this Scene) Type KeyingSetsAll bpy_prop_collection of KeyingSet, (readonly) layers Layers visible when rendering the scene

2.4. Types ([Link])

843

Blender Index, Release 2.59.2 - API

Type boolean array of 20 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False) node_tree Compositing node tree Type NodeTree, (readonly) object_bases Type SceneBases bpy_prop_collection of ObjectBase, (readonly) objects Type SceneObjects bpy_prop_collection of Object, (readonly) orientations Type bpy_prop_collection of TransformOrientation, (readonly) render Type RenderSettings, (readonly, never None) sequence_editor Type SequenceEditor, (readonly) sync_mode How to sync playback NONE No Sync, Do not sync, play every frame. FRAME_DROP Frame Dropping, Drop frames if playback is too slow. AUDIO_SYNC AV-sync, Sync to audio playback, dropping frames. Type enum in [NONE, FRAME_DROP, AUDIO_SYNC], default NONE timeline_markers Markers used in all timelines for the current scene Type TimelineMarkers bpy_prop_collection of TimelineMarker, (readonly) tool_settings Type ToolSettings, (readonly, never None) unit_settings Unit editing settings Type UnitSettings, (readonly, never None) use_audio Play back of audio from Sequence Editor will be muted Type boolean, default False use_audio_scrub Play audio from Sequence Editor while scrubbing Type boolean, default False use_audio_sync Play back and sync with audio clock, dropping frames if frame display is too slow Type boolean, default False

844

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

use_frame_drop Play back dropping frames if frame display is too slow Type boolean, default False use_gravity Use global gravity for all dynamics Type boolean, default False use_nodes Enable the compositing node tree Type boolean, default False use_preview_range Use an alternative start/end frame for UI playback, rather than the scene start/end frame Type boolean, default False use_stamp_note User dene note for the render stamping Type string, default world World used for rendering the scene Type World statistics() statistics Returns Statistics Return type string frame_set(frame, subframe=0.0) Set scene frame updating all objects immediately. Parameters frame (int in [-300000, 300000]) Frame number to set. subframe (oat in [0, 1], (optional)) Sub-frame time, between 0.0 and 1.0 update() Update data tagged to be updated from previous access to data or operators. collada_export(lepath=, selected) Export to collada le. Parameters lepath (string, (optional)) File Path, File path to write Collada le. selected (boolean) Export only selected, Export only selected elements.
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link]

2.4. Types ([Link])

845

Blender Index, Release 2.59.2 - API

[Link] [Link]
Inherited Functions

References

[Link] [Link] [Link] [Link] [Link] [Link] Image.save_render Object.dupli_list_create Object.is_modified Object.is_visible Object.to_mesh [Link] Scene.background_set [Link] [Link] [Link]

2.4.449 SceneActuator(Actuator)
base classes bpy_struct, Actuator class [Link](Actuator) Actuator to .. 846 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

camera Set this Camera. Leave empty to refer to self object Type Object mode Type enum in [RESTART, SET, CAMERA, ADDFRONT, ADDBACK, REMOVE, SUSPEND, RESUME], default RESTART scene Set the Scene to be added/removed/paused/resumed Type Scene
Inherited Properties

bpy_struct.id_data [Link] Actuator.show_expanded [Link] [Link]

Inherited Functions

2.4.450 SceneBases(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of scene bases active Active object base in the scene Type ObjectBase

2.4. Types ([Link])

847

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Scene.object_bases

2.4.451 SceneGameData(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Game data for a Scene datablock activity_culling_box_radius Radius of the activity bubble, in Manhattan length. Objects outside the box are activity-culled Type oat in [0, 1000], default 0.0 depth Displays bit depth of full screen display Type int in [8, 32], default 0 dome_angle Field of View of the Dome - it only works in mode Fisheye and Truncated Type int in [-32768, 32767], default 0 dome_buffer_resolution Buffer Resolution - decrease it to increase speed Type oat in [-inf, inf], default 0.0 dome_mode Dome physical congurations 848 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type enum in [FISHEYE, TRUNCATED_FRONT, TRUNCATED_REAR, ENVMAP, PANORAM_SPH], default FISHEYE dome_tesselation Tessellation level - check the generated mesh in wireframe mode Type int in [-32768, 32767], default 0 dome_text Custom Warp Mesh data le Type Text dome_tilt Camera rotation in horizontal axis Type int in [-32768, 32767], default 0 fps The nominal number of game frames per second. Physics xed timestep = 1/fps, independently of actual frame rate Type int in [1, 250], default 0 frame_color Set color of the bars Type oat array of 3 items in [0, 1], default (0.0, 0.0, 0.0) frame_type Select the type of Framing you want LETTERBOX Letterbox, Show the entire viewport in the display window, using bar horizontally or vertically. EXTEND Extend, Show the entire viewport in the display window, viewing more horizontally or vertically. SCALE Scale, Stretch or squeeze the viewport to ll the display window. Type enum in [LETTERBOX, EXTEND, SCALE], default LETTERBOX frequency Displays clock frequency of fullscreen display Type int in [4, 2000], default 0 level_height Max difference in heights of obstacles to enable their interaction Type oat in [0, 200], default 0.0 logic_step_max Sets the maximum number of logic frame per game frame if graphics slows down the game, higher value allows better synchronization with physics Type int in [1, 5], default 0 material_mode Material mode to use for rendering TEXTURE_FACE Texture Face, Single texture face materials. MULTITEXTURE Multitexture, Multitexture materials.

2.4. Types ([Link])

849

Blender Index, Release 2.59.2 - API

GLSL GLSL, OpenGL shading language shaders. Type enum in [TEXTURE_FACE, TURE_FACE MULTITEXTURE, GLSL], default TEX-

obstacle_simulation Simulation used for obstacle avoidance in the game engine Type enum in [NONE, RVO (rays), RVO (cells)], default NONE occlusion_culling_resolution The size of the occlusion buffer in pixel, use higher value for better precision (slower) Type int in [128, 1024], default 0 physics_engine Physics engine used for physics simulation in the game engine NONE None, Dont use a physics engine. BULLET Bullet, Use the Bullet physics engine. Type enum in [NONE, BULLET], default NONE physics_gravity Gravitational constant used for physics simulation in the game engine Type oat in [0, 10000], default 0.0 physics_step_max Sets the maximum number of physics step per game frame if graphics slows down the game, higher value allows physics to keep up with realtime Type int in [1, 5], default 0 physics_step_sub Sets the number of simulation substep per physic timestep, higher value give better physics precision Type int in [1, 5], default 0 recast_data Type SceneGameRecastData, (readonly, never None) resolution_x Number of horizontal pixels in the screen Type int in [4, 10000], default 0 resolution_y Number of vertical pixels in the screen Type int in [4, 10000], default 0 restrict_animation_updates Restrict the number of animation updates to the animation FPS. This is better for performance, but can cause issues with smooth playback. Type boolean, default False show_debug_properties Show properties marked for debugging while the game runs Type boolean, default False

850

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

show_framerate_profile Show framerate and proling information while the game runs Type boolean, default False show_fullscreen Starts player in a new fullscreen display Type boolean, default False show_mouse Start player with a visible mouse cursor Type boolean, default False show_obstacle_simulation Enable debug visualization for obstacle simulation Type boolean, default False show_physics_visualization Show a visualization of physics bounds and interactions Type boolean, default False stereo NONE None, Disable Stereo and Dome environments. STEREO Stereo, Enable Stereo environment. DOME Dome, Enable Dome environment. Type enum in [NONE, STEREO, DOME], default NONE stereo_eye_separation Set the distance between the eyes - the camera focal length/30 should be ne Type oat in [0.01, 5], default 0.0 stereo_mode Stereographic techniques Type enum in [QUADBUFFERED, ABOVEBELOW, INTERLACED, ANAGLYPH, SIDEBYSIDE, VINTERLACE], default QUADBUFFERED use_activity_culling Activity culling is enabled Type boolean, default False use_animation_record Record animation to fcurves Type boolean, default False use_auto_start Automatically start game at load time Type boolean, default False use_deprecation_warnings Print warnings when using deprecated features in the python API Type boolean, default False

2.4. Types ([Link])

851

Blender Index, Release 2.59.2 - API

use_display_lists Use display lists to speed up rendering by keeping geometry on the GPU Type boolean, default False use_frame_rate Respect the frame rate rather than rendering as many frames as possible Type boolean, default False use_glsl_color_management Use color management for GLSL rendering Type boolean, default False use_glsl_extra_textures Use extra textures like normal or specular maps for GLSL rendering Type boolean, default False use_glsl_lights Use lights for GLSL rendering Type boolean, default False use_glsl_nodes Use nodes for GLSL rendering Type boolean, default False use_glsl_ramps Use ramps for GLSL rendering Type boolean, default False use_glsl_shaders Use shaders for GLSL rendering Type boolean, default False use_glsl_shadows Use shadows for GLSL rendering Type boolean, default False use_occlusion_culling Use optimized Bullet DBVT tree for view frustum and occlusion culling Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

852

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get Chapter 2. Application Modules

856

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

name Render layer name Type string, default use Disable or enable the render layer Type boolean, default False use_all_z Fill in Z values for solid faces in invisible layers, for masking Type boolean, default False use_edge_enhance Render Edge-enhance in this Layer (only works for Solid faces) Type boolean, default False use_halo Render Halos in this Layer (on top of Solid) Type boolean, default False use_pass_ambient_occlusion Deliver AO pass Type boolean, default False use_pass_color Deliver shade-less color pass Type boolean, default False use_pass_combined Deliver full combined RGBA buffer Type boolean, default False use_pass_diffuse Deliver diffuse pass Type boolean, default False use_pass_emit Deliver emission pass Type boolean, default False use_pass_environment Deliver environment lighting pass Type boolean, default False use_pass_indirect Deliver indirect lighting pass Type boolean, default False use_pass_material_index Deliver material index pass Type boolean, default False use_pass_mist Deliver mist factor pass (0.0-1.0)

2.4. Types ([Link])

857

Blender Index, Release 2.59.2 - API

Type boolean, default False use_pass_normal Deliver normal pass Type boolean, default False use_pass_object_index Deliver object index pass Type boolean, default False use_pass_reflection Deliver raytraced reection pass Type boolean, default False use_pass_refraction Deliver raytraced refraction pass Type boolean, default False use_pass_shadow Deliver shadow pass Type boolean, default False use_pass_specular Deliver specular pass Type boolean, default False use_pass_uv Deliver texture UV pass Type boolean, default False use_pass_vector Deliver speed vector pass Type boolean, default False use_pass_z Deliver Z values pass Type boolean, default False use_sky Render Sky in this Layer Type boolean, default False use_solid Render Solid faces in this Layer Type boolean, default False use_strand Render Strands in this Layer Type boolean, default False use_zmask Only render whats in front of the solid z values Type boolean, default False

858

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

use_ztransp Render Z-Transparent faces in this Layer (On top of Solid and Halos) Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] [Link]

2.4.455 SceneSequence(Sequence)
base classes bpy_struct, Sequence class [Link](Sequence) Sequence strip to used the rendered image of a scene animation_offset_end Animation end offset (trim end) Type int in [0, inf], default 0 animation_offset_start Animation start offset (trim start) Type int in [0, inf], default 0 color_balance Type SequenceColorBalance, (readonly) color_multiply 2.4. Types ([Link]) 859

Blender Index, Release 2.59.2 - API

Type oat in [0, 20], default 0.0 color_saturation Type oat in [0, 20], default 0.0 crop Type SequenceCrop, (readonly) proxy Type SequenceProxy, (readonly) scene Scene that this sequence uses Type Scene scene_camera Override the scenes active camera Type Object strobe Only display every nth frame Type oat in [1, 30], default 0.0 transform Type SequenceTransform, (readonly) use_color_balance (3-Way color correction) on input Type boolean, default False use_crop Crop image before processing Type boolean, default False use_deinterlace For video movies to remove elds Type boolean, default False use_flip_x Flip on the X axis Type boolean, default False use_flip_y Flip on the Y axis Type boolean, default False use_float Convert input to oat data Type boolean, default False use_premultiply Convert RGB from key alpha to premultiplied alpha Type boolean, default False

860

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

use_proxy Use a preview proxy and/or timecode index for this strip Type boolean, default False use_proxy_custom_directory Use a custom directory to store data Type boolean, default False use_proxy_custom_file Use a custom le to read proxy data from Type boolean, default False use_reverse_frames Reverse frame order Type boolean, default False use_translation Translate image before processing Type boolean, default False
Inherited Properties

2.4. Types ([Link])

861

Blender Index, Release 2.59.2 - API

Inherited Functions

2.4.456 Scopes(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Scopes for statistical view of an image accuracy Proportion of original image source pixel lines to sample Type oat in [0, 100], default 0.0 histogram Histogram for viewing image statistics Type Histogram, (readonly) use_full_resolution Sample every pixel of the image Type boolean, default False vectorscope_alpha Opacity of the points Type oat in [0, 1], default 0.0 waveform_alpha Opacity of the points Type oat in [0, 1], default 0.0 waveform_mode Type enum in [LUMA, RGB, YCBCR601, YCBCR709, YCBCRJPG], default LUMA

862

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.457 Screen(ID)
base classes bpy_struct, ID class [Link](ID) Screen datablock, dening the layout of areas in a window areas Areas the screen is subdivided into Type bpy_prop_collection of Area, (readonly) is_animation_playing Animation playback is active Type boolean, default False, (readonly) scene Active scene to be edited in the screen Type Scene, (never None) show_fullscreen An area is maximised, lling this screen Type boolean, default False, (readonly) use_play_3d_editors

2.4. Types ([Link])

863

Blender Index, Release 2.59.2 - API

Type boolean, default False use_play_animation_editors Type boolean, default False use_play_image_editors Type boolean, default False use_play_node_editors Type boolean, default False use_play_properties_editors Type boolean, default False use_play_sequence_editors Type boolean, default False use_play_top_left_3d_editor Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

Inherited Functions

864

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

References

[Link] [Link] [Link]

2.4.458 ScrewModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Revolve edges angle Angle of revolution Type oat in [-inf, inf], default 0.0 axis Screw axis Type enum in [X, Y, Z], default X iterations Number of times to apply the screw operation Type int in [1, 10000], default 0 object Object to dene the screw axis Type Object render_steps Number of steps in the revolution Type int in [2, 10000], default 0 screw_offset Offset the revolution along its axis Type oat in [-inf, inf], default 0.0 steps Number of steps in the revolution Type int in [2, 10000], default 0 use_normal_calculate Calculate the order of edges (needed for meshes, but not curves) Type boolean, default False use_normal_flip Flip normals of lathed faces Type boolean, default False use_object_screw_offset Use the distance between the objects to make a screw Type boolean, default False

2.4. Types ([Link])

865

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

2.4.459 Sculpt(Paint)
base classes bpy_struct, Paint class [Link](Paint) lock_x Disallow changes to the X axis of vertices Type boolean, default False lock_y Disallow changes to the Y axis of vertices Type boolean, default False lock_z Disallow changes to the Z axis of vertices Type boolean, default False radial_symmetry Number of times to copy strokes across the surface

866

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type int array of 3 items in [1, 64], default (1, 1, 1) use_deform_only Use only deformation modiers (temporary disable all constructive modiers except multi-resolution) Type boolean, default False use_symmetry_feather Reduce the strength of the brush where it overlaps symmetrical daubs Type boolean, default False use_symmetry_x Mirror brush across the X axis Type boolean, default False use_symmetry_y Mirror brush across the Y axis Type boolean, default False use_symmetry_z Mirror brush across the Z axis Type boolean, default False use_threaded Take advantage of multiple CPU cores to improve sculpting performance Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] Paint.show_low_resolution Paint.show_brush Paint.show_brush_on_surface

Inherited Functions

2.4. Types ([Link])

867

Blender Index, Release 2.59.2 - API

References

[Link]

2.4.460 Sensor(bpy_struct)
base class bpy_struct subclasses RaySensor, PropertySensor, MessageSensor, TouchSensor, KeyboardSensor, CollisionSensor, RadarSensor, DelaySensor, RandomSensor, AlwaysSensor, ActuatorSensor, JoystickSensor, MouseSensor, ArmatureSensor, NearSensor class [Link](bpy_struct) Game engine logic brick to detect events frequency Delay between repeated pulses(in logic tics, 0=no delay) Type int in [0, 10000], default 0 invert Invert the level(output) of this sensor Type boolean, default False name Sensor name Type string, default pin Display when not linked to a visible states controller Type boolean, default False show_expanded Set sensor expanded in the user interface Type boolean, default False type Type enum in [ACTUATOR, ALWAYS, ARMATURE, COLLISION, DELAY, JOYSTICK, KEYBOARD, MESSAGE, MOUSE, NEAR, PROPERTY, RADAR, RANDOM, RAY, TOUCH], default ALWAYS use_level Level detector, trigger controllers of new states(only applicable upon logic state transition) Type boolean, default False use_pulse_false_level Activate FALSE level triggering (pulse mode) Type boolean, default False use_pulse_true_level Activate TRUE level triggering (pulse mode) Type boolean, default False use_tap Trigger controllers only for an instant, even while the sensor remains true

868

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type boolean, default False link(controller) Link the sensor to a controller. Parameters controller (Controller) Controller to link to. unlink(controller) Unlink the sensor from a controller. Parameters controller (Controller) Controller to unlink from.
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] [Link] [Link]

2.4.461 Sequence(bpy_struct)
base class bpy_struct subclasses MulticamSequence, ImageSequence, SceneSequence, MetaSequence, SoundSequence, MovieSequence, EffectSequence class [Link](bpy_struct) Sequence strip in the sequence editor blend_alpha Type oat in [0, 1], default 0.0 AdjustmentSequence,

2.4. Types ([Link])

869

Blender Index, Release 2.59.2 - API

blend_type Type enum in [REPLACE, CROSS, ADD, SUBTRACT, ALPHA_OVER, ALPHA_UNDER, GAMMA_CROSS, MULTIPLY, OVER_DROP], default REPLACE channel Y position of the sequence strip Type int in [0, 31], default 0 effect_fader Type oat in [0, 1], default 0.0 frame_duration The length of the contents of this strip before the handles are applied Type int in [1, 300000], default 0, (readonly) frame_final_duration The length of the contents of this strip before the handles are applied Type int in [1, 300000], default 0 frame_final_end End frame displayed in the sequence editor after offsets are applied Type int in [-inf, inf], default 0 frame_final_start Start frame displayed in the sequence editor after offsets are applied, setting this is equivalent to moving the handle, not the actual start frame Type int in [-inf, inf], default 0 frame_offset_end Type int in [-inf, inf], default 0, (readonly) frame_offset_start Type int in [-inf, inf], default 0, (readonly) frame_start Type int in [-inf, inf], default 0 frame_still_end Type int in [0, 300000], default 0, (readonly) frame_still_start Type int in [0, 300000], default 0, (readonly) input_1 First input for the effect strip Type Sequence, (readonly) input_2 Second input for the effect strip Type Sequence, (readonly) input_3 Third input for the effect strip

870

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type Sequence, (readonly) input_count Type int in [0, inf], default 0, (readonly) lock Lock strip so that it cant be transformed Type boolean, default False mute Type boolean, default False name Type string, default select Type boolean, default False select_left_handle Type boolean, default False select_right_handle Type boolean, default False speed_factor Multiply the current speed of the sequence with this number or remap current frame to this frame Type oat in [-inf, inf], default 0.0 type Type enum in [IMAGE, META, SCENE, MOVIE, SOUND, CROSS, ADD, SUBTRACT, ALPHA_OVER, ALPHA_UNDER, GAMMA_CROSS, MULTIPLY, OVER_DROP, PLUGIN, WIPE, GLOW, TRANSFORM, COLOR, SPEED, MULTICAM, ADJUSTMENT], default IMAGE, (readonly) use_default_fade Fade effect using the built-in default (usually make transition as long as effect strip) Type boolean, default False waveform Whether to draw the sounds waveform. Type boolean, default False getStripElem(frame) Return the strip element from a given frame or None. Parameters frame (int in [-300000, 300000]) Frame, The frame to get the strip element from Returns strip element of the current frame Return type SequenceElement swap(other) swap Parameters other (Sequence, (never None)) Other

2.4. Types ([Link])

871

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] Sequence.input_1 Sequence.input_2 Sequence.input_3 [Link] SequenceEditor.active_strip SequenceEditor.meta_stack [Link] SequenceEditor.sequences_all

2.4.462 SequenceColorBalance(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Color balance parameters for a sequence strip gain Color balance gain (highlights) Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) gamma Color balance gamma (midtones) Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) invert_gain

872

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type boolean, default False invert_gamma Type boolean, default False invert_lift Type boolean, default False lift Color balance lift (shadows) Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

AdjustmentSequence.color_balance EffectSequence.color_balance ImageSequence.color_balance MetaSequence.color_balance MovieSequence.color_balance MulticamSequence.color_balance SceneSequence.color_balance

2.4.463 SequenceCrop(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Cropping parameters for a sequence strip 2.4. Types ([Link]) 873

Blender Index, Release 2.59.2 - API

max_x Type int in [0, inf], default 0 max_y Type int in [0, inf], default 0 min_x Type int in [0, inf], default 0 min_y Type int in [0, inf], default 0
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] [Link] [Link] [Link] [Link] [Link] [Link]

2.4.464 SequenceEditor(bpy_struct)
base class bpy_struct

874

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

class [Link](bpy_struct) Sequence editing data for a Scene datablock active_strip Type Sequence meta_stack Meta strip stack, last is currently edited meta strip Type bpy_prop_collection of Sequence, (readonly) overlay_frame Sequencers active strip Type int in [-inf, inf], default 0 overlay_lock Type boolean, default False sequences Type bpy_prop_collection of Sequence, (readonly) sequences_all Type bpy_prop_collection of Sequence, (readonly) show_overlay Partial overlay on top of the sequencer Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

875

Blender Index, Release 2.59.2 - API

References

Scene.sequence_editor

2.4.465 SequenceElement(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Sequence strip data for a single frame filename Type string, default orig_height Original image height Type int in [-inf, inf], default 0, (readonly) orig_width Original image width Type int in [-inf, inf], default 0, (readonly)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] [Link] [Link]

876

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.466 SequenceProxy(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Proxy parameters for a sequence strip build_100 Build 100% proxy resolution Type boolean, default False build_25 Build 25% proxy resolution Type boolean, default False build_50 Build 50% proxy resolution Type boolean, default False build_75 Build 75% proxy resolution Type boolean, default False build_free_run Build free run time code index Type boolean, default False build_free_run_rec_date Build free run time code index using Record Date/Time Type boolean, default False build_record_run Build record run time code index Type boolean, default False directory Location to store the proxy les Type string, default filepath Location of custom proxy le Type string, default quality JPEG Quality of proxies to build Type int in [0, 32767], default 0 timecode NONE No TC in use. RECORD_RUN Record Run, use images in the order as they are recorded. FREE_RUN Free Run, use global timestamp written by recording device. FREE_RUN_REC_DATE Free Run (rec date), interpolate a global timestamp using the record date and time written by recording device. 2.4. Types ([Link]) 877

Blender Index, Release 2.59.2 - API

Type enum in [NONE, RECORD_RUN, FREE_RUN, FREE_RUN_REC_DATE], default NONE

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] [Link] [Link] [Link] [Link] [Link] [Link]

2.4.467 SequenceTransform(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Transform parameters for a sequence strip offset_x Type int in [-inf, inf], default 0 offset_y Type int in [-inf, inf], default 0

878

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] [Link] [Link] [Link] [Link] [Link] [Link]

2.4.468 ShaderNode(Node)
base classes bpy_struct, Node subclasses ShaderNodeHueSaturation, ShaderNodeVectorMath, ShaderNodeRGB, ShaderNodeCameraData, ShaderNodeMath, ShaderNodeRGBToBW, ShaderNodeRGBCurve, ShaderNodeInvert, ShaderNodeExtendedMaterial, ShaderNodeMaterial, ShaderNodeValue, ShaderNodeMixRGB, ShaderNodeSeparateRGB, ShaderNodeVectorCurve, ShaderNodeCombineRGB, ShaderNodeOutput, ShaderNodeValToRGB, ShaderNodeGeometry, ShaderNodeTexture, ShaderNodeMapping, ShaderNodeSqueeze, ShaderNodeNormal class [Link](Node) Material shader node type Type enum in [OUTPUT, MATERIAL, RGB, VALUE, MIX_RGB, VALTORGB, RGBTOBW, TEXTURE, NORMAL, GEOMETRY, MAPPING, CURVE_VEC, CURVE_RGB, CAMERA, MATH, VECT_MATH, SQUEEZE,

2.4. Types ([Link])

879

Blender Index, Release 2.59.2 - API

MATERIAL_EXT, INVERT, SEPRGB, COMBRGB, HUE_SAT, SCRIPT, GROUP], default OUTPUT, (readonly)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.469 ShaderNodeCameraData(ShaderNode)
base classes bpy_struct, Node, ShaderNode class [Link](ShaderNode)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

880

Chapter 2. Application Modules

2.4.472 ShaderNodeGeometry(ShaderNode)
base classes bpy_struct, Node, ShaderNode class [Link](ShaderNode) color_layer Type string, default uv_layer Type string, default
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.473 ShaderNodeHueSaturation(ShaderNode)
base classes bpy_struct, Node, ShaderNode

2.4. Types ([Link])

883

Blender Index, Release 2.59.2 - API

class [Link](ShaderNode)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.474 ShaderNodeInvert(ShaderNode)
base classes bpy_struct, Node, ShaderNode class [Link](ShaderNode)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

884

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Functions

2.4.475 ShaderNodeMapping(ShaderNode)
base classes bpy_struct, Node, ShaderNode class [Link](ShaderNode) location Location offset for the input coordinate Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) max Maximum value to clamp coordinate to Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) min Minimum value to clamp coordinate to Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) rotation Rotation offset for the input coordinate Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) scale Scale adjustment for the input coordinate Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) use_max Clamp the output coordinate to a maximum value Type boolean, default False use_min Clamp the output coordinate to a minimum value Type boolean, default False

2.4. Types ([Link])

885

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.476 ShaderNodeMaterial(ShaderNode)
base classes bpy_struct, Node, ShaderNode class [Link](ShaderNode) invert_normal Material Node uses inverted normal Type boolean, default False material Type Material use_diffuse Material Node outputs Diffuse Type boolean, default False use_specular Material Node outputs Specular Type boolean, default False

886

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.477 ShaderNodeMath(ShaderNode)
base classes bpy_struct, Node, ShaderNode class [Link](ShaderNode) operation Type enum in [ADD, SUBTRACT, MULTIPLY, DIVIDE, SINE, COSINE, TANGENT, ARCSINE, ARCCOSINE, ARCTANGENT, POWER, LOGARITHM, MINIMUM, MAXIMUM, ROUND, LESS_THAN, GREATER_THAN], default ADD
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link]

2.4. Types ([Link])

887

Blender Index, Release 2.59.2 - API

[Link] [Link]
Inherited Functions

2.4.478 ShaderNodeMixRGB(ShaderNode)
base classes bpy_struct, Node, ShaderNode class [Link](ShaderNode) blend_type Type enum in [MIX, ADD, MULTIPLY, SUBTRACT, SCREEN, DIVIDE, DIFFERENCE, DARKEN, LIGHTEN, OVERLAY, DODGE, BURN, HUE, SATURATION, VALUE, COLOR, SOFT_LIGHT, LINEAR_LIGHT], default MIX use_alpha Include alpha of second input in this operation Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

888

Chapter 2. Application Modules

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.482 ShaderNodeRGBCurve(ShaderNode)
base classes bpy_struct, Node, ShaderNode class [Link](ShaderNode) mapping Type CurveMapping, (readonly)
Inherited Properties

[Link]
Inherited Functions

2.4.486 ShaderNodeTexture(ShaderNode)
base classes bpy_struct, Node, ShaderNode class [Link](ShaderNode) node_output For node-based textures, which output node to use Type int in [-32768, 32767], default 0 texture Type Texture
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove 894 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.487 ShaderNodeTree(NodeTree)
base classes bpy_struct, ID, NodeTree class [Link](NodeTree) Node tree consisting of linked nodes used for materials nodes Type ShaderNodes bpy_prop_collection of Node, (readonly)
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link] NodeTree.animation_data NodeTree.grease_pencil [Link] [Link] [Link] [Link]

Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values [Link] ID.user_clear ID.animation_data_create ID.animation_data_clear ID.update_tag

2.4.488 ShaderNodeValToRGB(ShaderNode)
base classes bpy_struct, Node, ShaderNode class [Link](ShaderNode) color_ramp Type ColorRamp, (readonly)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

896

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.489 ShaderNodeValue(ShaderNode)
base classes bpy_struct, Node, ShaderNode class [Link](ShaderNode)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.490 ShaderNodeVectorCurve(ShaderNode)
base classes bpy_struct, Node, ShaderNode class [Link](ShaderNode) mapping Type CurveMapping, (readonly)
Inherited Properties

bpy_struct.id_data [Link] [Link]

2.4. Types ([Link])

897

Blender Index, Release 2.59.2 - API

[Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.491 ShaderNodeVectorMath(ShaderNode)
base classes bpy_struct, Node, ShaderNode class [Link](ShaderNode) operation Type enum in [ADD, SUBTRACT, AVERAGE, CROSS_PRODUCT, NORMALIZE], default ADD
Inherited Properties

DOT_PRODUCT,

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add 898 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.492 ShaderNodes(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of Shader Nodes new(type, group=None) Add a node to this node tree. Parameters type (enum in [OUTPUT, MATERIAL, RGB, VALUE, MIX_RGB, VALTORGB, RGBTOBW, TEXTURE, NORMAL, GEOMETRY, MAPPING, CURVE_VEC, CURVE_RGB, CAMERA, MATH, VECT_MATH, SQUEEZE, MATERIAL_EXT, INVERT, SEPRGB, COMBRGB, HUE_SAT, SCRIPT, GROUP]) Type, Type of node to add group (NodeTree, (optional)) The group tree Returns New node. Return type Node remove(node) remove a node from this node tree. Parameters node (Node) The node to remove.
Inherited Properties

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get 899

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

References

[Link]

2.4.493 ShapeActionActuator(Actuator)
base classes bpy_struct, Actuator class [Link](Actuator) Actuator to control shape key animations action Type Action frame_blend_in Number of frames of motion blending Type int in [0, 32767], default 0 frame_end Type oat in [-inf, inf], default 0.0 frame_property Assign the actions current frame number to this property Type string, default frame_start Type oat in [-inf, inf], default 0.0 mode Action playback type Type enum in [PLAY, PINGPONG, FLIPPER, LOOPSTOP, LOOPEND, PROPERTY], default PLAY priority Execution priority - lower numbers will override actions with higher numbers. With 2 or more actions at once, the overriding channels must be lower in the stack Type int in [0, 100], default 0 property Use this property to dene the Action position Type string, default

900

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

use_continue_last_frame Restore last frame when switching on/off, otherwise play from the start each time Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] Actuator.show_expanded [Link] [Link]

Inherited Functions

2.4.494 ShapeKey(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Shape key in a shape keys datablock data Type bpy_prop_collection of UnknownType, (readonly) frame Frame for absolute keys Type oat in [-inf, inf], default 0.0, (readonly) interpolation Interpolation type Type enum in [KEY_LINEAR, KEY_LINEAR KEY_CARDINAL, KEY_BSPLINE], default

2.4. Types ([Link])

901

Blender Index, Release 2.59.2 - API

mute Mute this shape key Type boolean, default False name Name of Shape Key Type string, default relative_key Shape used as a relative key Type ShapeKey slider_max Maximum for slider Type oat in [-10, 10], default 1.0 slider_min Minimum for slider Type oat in [-10, 10], default 0.0 value Value of shape key at the current frame Type oat in [0, 1], default 0.0 vertex_group Vertex weight group, to blend with basis shape Type string, default
Inherited Properties

bpy_struct.id_data
Inherited Functions

902

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

References

ClothSettings.rest_shape_key Key.key_blocks Key.reference_key Object.active_shape_key Object.shape_key_add ShapeKey.relative_key

2.4.495 ShapeKeyBezierPoint(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Point in a shape key for Bezier curves co Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_left Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_right Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

903

Blender Index, Release 2.59.2 - API

2.4.496 ShapeKeyCurvePoint(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Point in a shape key for curves co Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) tilt Type oat in [-inf, inf], default 0.0
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4.497 ShapeKeyPoint(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Point in a shape key co Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data

904

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Functions

2.4.498 ShrinkwrapConstraint(Constraint)
base classes bpy_struct, Constraint class [Link](Constraint) Creates constraint-based shrinkwrap relationship distance Distance to Target Type oat in [0, 100], default 0.0 shrinkwrap_type Selects type of shrinkwrap algorithm for target position NEAREST_SURFACE Nearest Surface Point, Shrinks the location to the nearest target surface. PROJECT Project, Shrinks the location to the nearest target surface along a given axis. NEAREST_VERTEX Nearest Vertex, Shrinks the location to the nearest target vertex. Type enum in [NEAREST_SURFACE, PROJECT, NEAREST_VERTEX], default NEAREST_SURFACE target Target Object Type Object use_x Projection over X Axis Type boolean, default False use_y Projection over Y Axis Type boolean, default False

2.4. Types ([Link])

905

Blender Index, Release 2.59.2 - API

use_z Projection over Z Axis Type boolean, default False

Inherited Properties

Inherited Functions

2.4.499 ShrinkwrapModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Shrink wrapping modier to shrink wrap and object to a target auxiliary_target Additional mesh target to shrink to Type Object cull_face Stop vertices from projecting to a the face on the target when facing towards/away 906 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type enum in [OFF, FRONT, BACK], default OFF offset Distance to keep from the target Type oat in [-inf, inf], default 0.0 subsurf_levels Number of subdivisions that must be performed before extracting vertices positions and normals Type int in [0, 6], default 0 target Mesh target to shrink to Type Object use_keep_above_surface Type boolean, default False use_negative_direction Allow vertices to move in the negative direction of axis Type boolean, default False use_positive_direction Allow vertices to move in the positive direction of axis Type boolean, default False use_project_x Type boolean, default False use_project_y Type boolean, default False use_project_z Type boolean, default False vertex_group Vertex group name Type string, default wrap_method NEAREST_SURFACEPOINT Nearest Surface Point, Shrinks the mesh to the nearest target surface. PROJECT Project, Shrinks the mesh to the nearest target surface along a given axis. NEAREST_VERTEX Nearest Vertex, Shrinks the mesh to the nearest target vertex. Type enum in [NEAREST_SURFACEPOINT, PROJECT, NEAREST_VERTEX], default NEAREST_SURFACEPOINT
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode

2.4. Types ([Link])

907

Blender Index, Release 2.59.2 - API

Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

2.4.500 SimpleDeformModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Simple deformation modier to apply effects such as twisting and bending deform_method TWIST Twist, Rotates around the Z axis of the modier space. BEND Bend, Bends the mesh over the Z axis of the modier space. TAPER Taper, Linearly scales along Z axis of the modier space. STRETCH Stretch, Stretches the object along the Z axis of the modier space. Type enum in [TWIST, BEND, TAPER, STRETCH], default TWIST factor Amount to deform object Type oat in [-inf, inf], default 0.0 limits Lower/Upper limits for deform Type oat array of 2 items in [0, 1], default (0.0, 0.0) lock_x Do not allow tapering along the X axis Type boolean, default False 908 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

lock_y Do not allow tapering along the Y axis Type boolean, default False origin Origin of modier space coordinates Type Object use_relative Sets the origin of deform space to be relative to the object Type boolean, default False vertex_group Vertex group name Type string, default
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

2.4.501 SmokeCollSettings(bpy_struct)
base class bpy_struct

2.4. Types ([Link])

909

Blender Index, Release 2.59.2 - API

class [Link](bpy_struct) Smoke collision settings

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

SmokeModifier.coll_settings

2.4.502 SmokeDomainSettings(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Smoke domain settings alpha How much density effects smoke motion, higher value results in faster rising smoke Type oat in [-5, 5], default 0.0 amplify Enhance the resolution of smoke by this factor using noise Type int in [1, 10], default 0 beta How much heat effects smoke motion, higher value results in faster rising smoke Type oat in [-5, 5], default 0.0 collision_extents Selects which domain border will be treated as collision object.

910

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

BORDEROPEN Open, Smoke doesnt collide with any border. BORDERVERTICAL Vertically Open, Smoke doesnt collide with top and bottom sides. BORDERCLOSED Collide All, Smoke collides with every side. Type enum in [BORDEROPEN, BORDERVERTICAL, BORDERCLOSED], default BORDEROPEN collision_group Limit collisions to this group Type Group dissolve_speed Dissolve Speed Type int in [1, 10000], default 0 effector_group Limit effectors to this group Type Group effector_weights Type EffectorWeights, (readonly) fluid_group Limit uid objects to this group Type Group noise_type Noise method which is used for creating the high resolution Type enum in [NOISEWAVE], default NOISEWAVE point_cache Type PointCache, (readonly, never None) point_cache_compress_type Compression method to be used CACHELIGHT Light, Fast but not so effective compression. CACHEHEAVY Heavy, Effective but slow compression. Type enum in [CACHELIGHT, CACHEHEAVY], default CACHELIGHT resolution_max Maximal resolution used in the uid domain Type int in [24, 512], default 0 show_high_resolution Show high resolution (using amplication) Type boolean, default False smooth_emitter Smoothens emitted smoke to avoid blockiness. Type boolean, default False

2.4. Types ([Link])

911

Blender Index, Release 2.59.2 - API

strength Strength of noise Type oat in [0, 10], default 0.0 time_scale Adjust simulation speed. Type oat in [0.2, 1.5], default 0.0 use_dissolve_smoke Enable smoke to disappear over time Type boolean, default False use_dissolve_smoke_log Using 1/x Type boolean, default False use_high_resolution Enable high resolution (using amplication) Type boolean, default False vorticity Amount of turbulence/rotation in uid. Type oat in [0.01, 4], default 0.0
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

SmokeModifier.domain_settings

912

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.503 SmokeFlowSettings(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Smoke ow settings density Type oat in [0.001, 1], default 0.0 initial_velocity Smoke inherits its velocity from the emitter particle Type boolean, default False particle_system Particle systems emitted from the object Type ParticleSystem temperature Temperature difference to ambient temperature Type oat in [-10, 10], default 0.0 use_absolute Only allows given density value in emitter area. Type boolean, default False use_outflow Deletes smoke from simulation Type boolean, default False velocity_factor Multiplier to adjust velocity passed to smoke Type oat in [-2, 2], default 0.0
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

SmokeModifier.flow_settings

2.4.504 SmokeModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Smoke simulation modier coll_settings Type SmokeCollSettings, (readonly) domain_settings Type SmokeDomainSettings, (readonly) flow_settings Type SmokeFlowSettings, (readonly) smoke_type NONE None. DOMAIN Domain. FLOW Flow, Inow/Outow. COLLISION Collision. Type enum in [NONE, DOMAIN, FLOW, COLLISION], default NONE
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove

914

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.505 SmoothModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Smoothing effect modier factor Strength of modier effect Type oat in [-inf, inf], default 0.0 iterations Type int in [-32768, 32767], default 0 use_x Smooth object along X axis Type boolean, default False use_y Smooth object along Y axis Type boolean, default False use_z Smooth object along Z axis Type boolean, default False vertex_group Name of Vertex Group which determines inuence of modier per point Type string, default
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport 915

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

Modifier.show_render [Link]
Inherited Functions

2.4.506 SoftBodyModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Soft body simulation modier point_cache Type PointCache, (readonly, never None) settings Type SoftBodySettings, (readonly, never None)
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add 916 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.507 SoftBodySettings(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Soft body simulation settings for an object aero Make edges sail Type int in [0, 30000], default 0 aerodynamics_type Method of calculating aerodynamic interaction SIMPLE Simple, Edges receive a drag force from surrounding media. LIFT_FORCE Lift Force, Edges receive a lift force when passing through surrounding media. Type enum in [SIMPLE, LIFT_FORCE], default SIMPLE ball_damp Blending to inelastic collision Type oat in [0.001, 1], default 0.0 ball_size Absolute ball size or factor if not manual adjusted Type oat in [-10, 10], default 0.0 ball_stiff Ball inating pressure Type oat in [0.001, 100], default 0.0 bend Bending Stiffness Type oat in [0, 10], default 0.0 choke Viscosity inside collision target Type int in [0, 100], default 0

2.4. Types ([Link])

917

Blender Index, Release 2.59.2 - API

collision_type Choose Collision Type MANUAL Manual, Manual adjust. AVERAGE Average, Average Spring length * Ball Size. MINIMAL Minimal, Minimal Spring length * Ball Size. MAXIMAL Maximal, Maximal Spring length * Ball Size. MINMAX AvMinMax, (Min+Max)/2 * Ball Size. Type enum in [MANUAL, AVERAGE, MINIMAL, MAXIMAL, MINMAX], default MANUAL damping Edge spring friction Type oat in [0, 50], default 0.0 effector_weights Type EffectorWeights, (readonly) error_threshold The Runge-Kutta ODE solver error limit, low value gives more precision, high values speed Type oat in [0.001, 10], default 0.0 friction General media friction for point movements Type oat in [0, 50], default 0.0 fuzzy Fuzziness while on collision, high values make collision handling faster but less stable Type int in [1, 100], default 0 goal_default Default Goal (vertex target position) value, when no Vertex Group used Type oat in [0, 1], default 0.0 goal_friction Goal (vertex target position) friction Type oat in [0, 50], default 0.0 goal_max Goal maximum, vertex weights are scaled to match this range Type oat in [0, 1], default 0.0 goal_min Goal minimum, vertex weights are scaled to match this range Type oat in [0, 1], default 0.0 goal_spring Goal (vertex target position) spring stiffness Type oat in [0, 0.999], default 0.0

918

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

gravity Apply gravitation to point movement Type oat in [-10, 10], default 0.0 location_mass_center Location of Center of mass Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) mass General Mass value Type oat in [0, 50000], default 0.0 plastic Permanent deform Type int in [0, 100], default 0 pull Edge spring stiffness when longer than rest length Type oat in [0, 0.999], default 0.0 push Edge spring stiffness when shorter than rest length Type oat in [0, 0.999], default 0.0 rotation_estimate Estimated rotation matrix Type oat array of 9 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0) scale_estimate Estimated scale matrix Type oat array of 9 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0) shear Shear Stiffness Type oat in [0, 1], default 0.0 speed Tweak timing for physics to control frequency and speed Type oat in [0.01, 100], default 0.0 spring_length Alter spring length to shrink/blow up (unit %) 0 to disable Type int in [0, 200], default 0 step_max Maximal # solver steps/frame Type int in [0, 30000], default 0 step_min Minimal # solver steps/frame Type int in [0, 30000], default 0 use_auto_step Use velocities for automagic step sizes

2.4. Types ([Link])

919

Blender Index, Release 2.59.2 - API

Type boolean, default False use_diagnose Turn on SB diagnose console prints Type boolean, default False use_edge_collision Edges collide too Type boolean, default False use_edges Use Edges as springs Type boolean, default False use_estimate_matrix estimate matrix .. split to COM , ROT ,SCALE Type boolean, default False use_face_collision Faces collide too, can be very slow Type boolean, default False use_goal Dene forces for vertices to stick to animated position Type boolean, default False use_self_collision Enable naive vertex ball self collision Type boolean, default False use_stiff_quads Adds diagonal springs on 4-gons Type boolean, default False vertex_group_goal Control point weight values Type string, default vertex_group_mass Control point mass values Type string, default vertex_group_spring Control point spring strength values Type string, default
Inherited Properties

bpy_struct.id_data

920

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Functions

References

Object.soft_body [Link]

2.4.508 SolidifyModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Create a solid skin by extruding, compensating for sharp angles edge_crease_inner Assign a crease to inner edges Type oat in [0, 1], default 0.0 edge_crease_outer Assign a crease to outer edges Type oat in [0, 1], default 0.0 edge_crease_rim Assign a crease to the edges making up the rim Type oat in [0, 1], default 0.0 invert_vertex_group Invert the vertex group inuence Type boolean, default False material_offset Offset material index of generated faces Type int in [-32768, 32767], default 0 material_offset_rim Offset material index of generated rim faces 2.4. Types ([Link]) 921

Blender Index, Release 2.59.2 - API

Type int in [-32768, 32767], default 0 offset Offset the thickness from the center Type oat in [-inf, inf], default 0.0 thickness Thickness of the shell Type oat in [-inf, inf], default 0.0 thickness_vertex_group Thickness factor to use for zero vertex group inuence Type oat in [0, 1], default 0.0 use_even_offset Maintain thickness by adjusting for sharp corners (slow, disable when not needed) Type boolean, default False use_quality_normals Calculate normals which result in more even thickness (slow, disable when not needed) Type boolean, default False use_rim Create edge loops between the inner and outer surfaces on face edges (slow, disable when not needed) Type boolean, default False vertex_group Vertex group name Type string, default
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set

922

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.509 Sound(ID)
base classes bpy_struct, ID class [Link](ID) Sound datablock referencing an external or packed sound le filepath Sound sample le used by this Sound datablock Type string, default mono If the le contains multiple audio channels they are rendered to a single one. Type boolean, default False packed_file Type PackedFile, (readonly) use_memory_cache The sound le is decoded and loaded into RAM Type boolean, default False factory The [Link] object of the sound. (readonly)
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden

2.4. Types ([Link])

923

Blender Index, Release 2.59.2 - API

References

[Link] [Link] [Link] [Link]

2.4.510 SoundActuator(Actuator)
base classes bpy_struct, Actuator class [Link](Actuator) Sound le cone_inner_angle_3d The angle of the inner cone Type oat in [-inf, inf], default 0.0 cone_outer_angle_3d The angle of the outer cone Type oat in [-inf, inf], default 0.0 cone_outer_gain_3d The gain outside the outer cone. The gain in the outer cone will be interpolated between this value and the normal gain in the inner cone Type oat in [-inf, inf], default 0.0 distance_3d_max The maximum distance at which you can hear the sound Type oat in [-inf, inf], default 0.0 distance_3d_reference The distance where the sound has a gain of 1.0 Type oat in [-inf, inf], default 0.0 gain_3d_max The maximum gain of the sound, no matter how near it is Type oat in [-inf, inf], default 0.0 924 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

gain_3d_min The minimum gain of the sound, no matter how far it is away Type oat in [-inf, inf], default 0.0 mode Type enum in [PLAYSTOP, PLAYEND, LOOPSTOP, LOOPEND, LOOPBIDIRECTIONAL, LOOPBIDIRECTIONALSTOP], default PLAYSTOP pitch Sets the pitch of the sound Type oat in [-inf, inf], default 0.0 rolloff_factor_3d The inuence factor on volume depending on distance Type oat in [-inf, inf], default 0.0 sound Type Sound use_sound_3d Enable/Disable 3D Sound Type boolean, default False volume Sets the initial volume of the sound Type oat in [0, 2], default 0.0
Inherited Properties

bpy_struct.id_data [Link] Actuator.show_expanded [Link] [Link]

Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.values [Link] [Link]

2.4.511 SoundSequence(Sequence)
base classes bpy_struct, Sequence class [Link](Sequence) Sequence strip dening a sound to be played over a period of time animation_offset_end Animation end offset (trim end) Type int in [0, inf], default 0 animation_offset_start Animation start offset (trim start) Type int in [0, inf], default 0 filepath Type string, default pan Playback panning of the sound (only for Mono sources) Type oat in [-2, 2], default 0.0 pitch Playback pitch of the sound Type oat in [0.1, 10], default 0.0 sound Sound datablock used by this sequence Type Sound, (readonly) volume Playback volume of the sound Type oat in [0, 100], default 0.0
Inherited Properties

926

Blender Index, Release 2.59.2 - API

Sequence.select_left_handle Sequence.frame_final_duration Sequence.frame_duration [Link] [Link] Sequence.select_right_handle [Link] Sequence.speed_factor Sequence.frame_start Sequence.frame_final_start Sequence.frame_offset_start Sequence.frame_still_start [Link] Sequence.use_default_fade Sequence.input_count

Inherited Functions

2.4.512 Space(bpy_struct)
base class bpy_struct subclasses SpaceUserPreferences, SpaceOutliner, SpaceImageEditor, SpaceSequenceEditor, SpaceProperties, SpaceGraphEditor, SpaceLogicEditor, SpaceInfo, SpaceConsole, SpaceNodeEditor, SpaceView3D, SpaceDopeSheetEditor, SpaceTextEditor, SpaceFileBrowser, SpaceNLA, SpaceTimeline class [Link](bpy_struct) Space data for a screen area type Space data type Type enum in [EMPTY, VIEW_3D, GRAPH_EDITOR, OUTLINER, PROPERTIES, FILE_BROWSER, IMAGE_EDITOR, INFO, SEQUENCE_EDITOR,

2.4. Types ([Link])

927

Blender Index, Release 2.59.2 - API

TEXT_EDITOR, AUDIO_WINDOW, DOPESHEET_EDITOR, NLA_EDITOR, SCRIPTS_WINDOW, TIMELINE, NODE_EDITOR, LOGIC_EDITOR, CONSOLE, USER_PREFERENCES], default EMPTY, (readonly)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] [Link] Context.space_data

2.4.513 SpaceConsole(Space)
base classes bpy_struct, Space class [Link](Space) Interactive python console font_size Font size to use for displaying the text Type int in [8, 32], default 0 history Command history Type bpy_prop_collection of ConsoleLine, (readonly) language Command line prompt language Type string, default 928 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

prompt Command line prompt Type string, default scrollback Command output Type bpy_prop_collection of ConsoleLine, (readonly) select_end Type int in [0, inf], default 0 select_start Type int in [0, inf], default 0
Inherited Properties

bpy_struct.id_data [Link]
Inherited Functions

2.4.514 SpaceDopeSheetEditor(Space)
base classes bpy_struct, Space class [Link](Space) DopeSheet space data action Action displayed and edited in this space Type Action auto_snap Automatic time snapping settings for transformations

2.4. Types ([Link])

929

Blender Index, Release 2.59.2 - API

NONE No Auto-Snap. STEP Time Step, Snap to 1.0 frame/second intervals. FRAME Nearest Frame, Snap to actual frames/seconds (nla-action time). MARKER Nearest Marker, Snap to nearest marker. Type enum in [NONE, STEP, FRAME, MARKER], default NONE dopesheet Settings for ltering animation data Type DopeSheet, (readonly) mode Editing context being displayed DOPESHEET DopeSheet, DopeSheet Editor. ACTION Action Editor, Action Editor. SHAPEKEY ShapeKey Editor, ShapeKey Editor. GPENCIL Grease Pencil, Grease Pencil. Type enum in [DOPESHEET, ACTION, SHAPEKEY, GPENCIL], default ACTION show_frame_indicator Show frame number beside the current frame indicator line Type boolean, default False show_pose_markers Show markers belonging to the active action instead of Scene markers (Action and Shape Key Editors only) Type boolean, default False show_seconds Show timing in seconds not frames Type boolean, default False, (readonly) show_sliders Show sliders beside F-Curve channels Type boolean, default False use_auto_merge_keyframes Automatically merge nearby keyframes Type boolean, default False use_marker_sync Sync Markers with keyframe edits Type boolean, default False use_realtime_update When transforming keyframes, changes to the animation data are ushed to other views Type boolean, default False

930

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data [Link]
Inherited Functions

2.4.515 SpaceFileBrowser(Space)
base classes bpy_struct, Space class [Link](Space) File browser space data operator Type Operator, (readonly) params Parameters and Settings for the Filebrowser Type FileSelectParams, (readonly)
Inherited Properties

bpy_struct.id_data [Link]
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove

2.4. Types ([Link])

931

Blender Index, Release 2.59.2 - API

2.4.516 SpaceGraphEditor(Space)
base classes bpy_struct, Space class [Link](Space) Graph Editor space data auto_snap Automatic time snapping settings for transformations NONE No Auto-Snap. STEP Time Step, Snap to 1.0 frame/second intervals. FRAME Nearest Frame, Snap to actual frames/seconds (nla-action time). MARKER Nearest Marker, Snap to nearest marker. Type enum in [NONE, STEP, FRAME, MARKER], default NONE cursor_position_y Graph Editor 2D-Value cursor - Y-Value component Type oat in [-inf, inf], default 0.0 dopesheet Settings for ltering animation data Type DopeSheet, (readonly) has_ghost_curves Graph Editor instance has some ghost curves stored Type boolean, default False mode Editing context being displayed FCURVES F-Curve Editor, Edit animation/keyframes displayed as 2D curves. DRIVERS Drivers, Edit drivers. Type enum in [FCURVES, DRIVERS], default FCURVES pivot_point Pivot center for rotation/scaling Type enum in [BOUNDING_BOX_CENTER, CURSOR, INDIVIDUAL_ORIGINS], default BOUNDING_BOX_CENTER 932 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

show_cursor Show 2D cursor Type boolean, default False show_frame_indicator Show frame number beside the current frame indicator line Type boolean, default False show_handles Show handles of Bezier control points Type boolean, default False show_seconds Show timing in seconds not frames Type boolean, default False, (readonly) show_sliders Show sliders beside F-Curve channels Type boolean, default False use_auto_merge_keyframes Automatically merge nearby keyframes Type boolean, default False use_beauty_drawing Draw F-Curves using Anti-Aliasing and other fancy effects. Disable for better performance Type boolean, default False use_only_selected_curves_handles Only keyframes of selected F-Curves are visible and editable Type boolean, default False use_only_selected_keyframe_handles Only show and edit handles of selected keyframes Type boolean, default False use_realtime_update When transforming keyframes, changes to the animation data are ushed to other views Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link]
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove 933

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

2.4.517 SpaceImageEditor(Space)
base classes bpy_struct, Space class [Link](Space) Image and UV editor space data curve Color curve mapping to use for displaying the image Type CurveMapping, (readonly) draw_channels Channels of the image to draw COLOR Color, Draw image with RGB colors. COLOR_ALPHA Color and Alpha, Draw image with RGB colors and alpha transparency. ALPHA Alpha, Draw alpha transparency channel. Z_BUFFER Z-Buffer, Draw Z-buffer associated with image (mapped from camera clip start to end). Type enum in [COLOR, COLOR_ALPHA, ALPHA, Z_BUFFER], default COLOR grease_pencil Grease pencil data for this space Type GreasePencil image Image displayed and edited in this space Type Image image_user Parameters dening which layer, pass and frame of the image is displayed Type ImageUser, (readonly, never None) sample_histogram Sampled colors along line Type Histogram, (readonly) scopes Scopes to visualize image statistics. Type Scopes, (readonly)

934

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

show_paint Show paint related properties Type boolean, default False, (readonly) show_render Show render related properties Type boolean, default False, (readonly) show_repeat Draw the image repeated outside of the main view Type boolean, default False show_uvedit Show UV editing related properties Type boolean, default False, (readonly) use_grease_pencil Display and edit the grease pencil freehand annotations overlay Type boolean, default False use_image_paint Enable image painting mode Type boolean, default False use_image_pin Display current image regardless of object selection Type boolean, default False use_realtime_update Update other affected window spaces automatically to reect changes during interactive operations such as transform Type boolean, default False uv_editor UV editor settings Type SpaceUVEditor, (readonly, never None) zoom Zoom factor Type oat array of 2 items in [-inf, inf], default (0.0, 0.0), (readonly)
Inherited Properties

bpy_struct.id_data [Link]
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add 935

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

2.4.518 SpaceInfo(Space)
base classes bpy_struct, Space class [Link](Space) Info space data show_report_debug Display debug reporting info Type boolean, default False show_report_error Display error text Type boolean, default False show_report_info Display general information Type boolean, default False show_report_operator Display the operator log Type boolean, default False show_report_warning Display warnings Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link]
Inherited Functions

936

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.519 SpaceLogicEditor(Space)
base classes bpy_struct, Space class [Link](Space) Logic editor space data show_actuators_active_object Show actuators of active object Type boolean, default False show_actuators_active_states Show only actuators connected to active states Type boolean, default False show_actuators_linked_controller Show linked objects to the actuator Type boolean, default False show_actuators_selected_objects Show actuators of all selected objects Type boolean, default False show_controllers_active_object Show controllers of active object Type boolean, default False show_controllers_linked_controller Show linked objects to sensor/actuator Type boolean, default False show_controllers_selected_objects Show controllers of all selected objects Type boolean, default False show_sensors_active_object Show sensors of active object Type boolean, default False show_sensors_active_states Show only sensors connected to active states Type boolean, default False 2.4. Types ([Link]) 937

Blender Index, Release 2.59.2 - API

show_sensors_linked_controller Show linked objects to the controller Type boolean, default False show_sensors_selected_objects Show sensors of all selected objects Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link]
Inherited Functions

2.4.520 SpaceNLA(Space)
base classes bpy_struct, Space class [Link](Space) NLA editor space data auto_snap Automatic time snapping settings for transformations NONE No Auto-Snap. STEP Time Step, Snap to 1.0 frame/second intervals. FRAME Nearest Frame, Snap to actual frames/seconds (nla-action time). MARKER Nearest Marker, Snap to nearest marker. Type enum in [NONE, STEP, FRAME, MARKER], default NONE dopesheet Settings for ltering animation data 938 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type DopeSheet, (readonly) show_frame_indicator Show frame number beside the current frame indicator line Type boolean, default False show_seconds Show timing in seconds not frames Type boolean, default False, (readonly) show_strip_curves Show inuence curves on strips Type boolean, default False use_realtime_update When transforming strips, changes to the animation data are ushed to other views Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link]
Inherited Functions

2.4.521 SpaceNodeEditor(Space)
base classes bpy_struct, Space class [Link](Space) Node editor space data backdrop_channels Channels of the image to draw COLOR Color, Draw image with RGB colors. 2.4. Types ([Link]) 939

Blender Index, Release 2.59.2 - API

COLOR_ALPHA Color and Alpha, Draw image with RGB colors and alpha transparency. ALPHA Alpha, Draw alpha transparency channel. Type enum in [COLOR, COLOR_ALPHA, ALPHA], default COLOR backdrop_x Backdrop X offset Type oat in [-inf, inf], default 0.0 backdrop_y Backdrop Y offset Type oat in [-inf, inf], default 0.0 backdrop_zoom Backdrop zoom factor Type oat in [0.01, inf], default 1.0 id Datablock whose nodes are being edited Type ID, (readonly) id_from Datablock from which the edited datablock is linked Type ID, (readonly) node_tree Node tree being displayed and edited Type NodeTree show_backdrop Use active Viewer Node output as backdrop for compositing nodes Type boolean, default False texture_type Type of data to take texture from OBJECT Object, Edit texture nodes from Object. WORLD World, Edit texture nodes from World. BRUSH Brush, Edit texture nodes from Brush. Type enum in [OBJECT, WORLD, BRUSH], default OBJECT tree_type Node tree type to display and edit MATERIAL Material, Material nodes. TEXTURE Texture, Texture nodes. COMPOSITING Compositing, Compositing nodes. Type enum in [MATERIAL, TEXTURE, COMPOSITING], default MATERIAL

940

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

use_auto_render Re-render and composite changed layer on 3D edits Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link]
Inherited Functions

2.4.522 SpaceOutliner(Space)
base classes bpy_struct, Space class [Link](Space) Outliner space data display_mode Type of information to display ALL_SCENES All Scenes, Display datablocks in all scenes. CURRENT_SCENE Current Scene, Display datablocks in current scene. VISIBLE_LAYERS Visible Layers, Display datablocks in visible layers. SELECTED Selected, Display datablocks of selected objects. ACTIVE Active, Display datablocks of active object. SAME_TYPES Same Types, Display datablocks of all objects of same type as selected object. GROUPS Groups, Display groups and their datablocks. LIBRARIES Libraries, Display libraries. SEQUENCE Sequence, Display sequence datablocks. DATABLOCKS Datablocks, Display raw datablocks. 2.4. Types ([Link]) 941

Blender Index, Release 2.59.2 - API

USER_PREFERENCES User Preferences, Display the user preference datablocks. KEYMAPS Key Maps, Display keymap datablocks. Type enum in [ALL_SCENES, CURRENT_SCENE, VISIBLE_LAYERS, SELECTED, ACTIVE, SAME_TYPES, GROUPS, LIBRARIES, SEQUENCE, DATABLOCKS, USER_PREFERENCES, KEYMAPS], default ALL_SCENES filter_text Live search ltering string Type string, default show_restrict_columns Show column Type boolean, default False use_filter_case_sensitive Only use case sensitive matches of search string Type boolean, default False use_filter_complete Only use complete matches of search string Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link]
Inherited Functions

2.4.523 SpaceProperties(Space)
base classes bpy_struct, Space

942

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

class [Link](Space) Properties space data align Arrangement of the panels Type enum in [HORIZONTAL, VERTICAL], default HORIZONTAL context Type of active data to display and edit SCENE Scene, Scene. RENDER Render, Render. WORLD World, World. OBJECT Object, Object. CONSTRAINT Constraints, Constraints. MODIFIER Modiers, Modiers. DATA Data, Data. BONE Bone, Bone. BONE_CONSTRAINT Bone Constraints, Bone Constraints. MATERIAL Material, Material. TEXTURE Texture, Texture. PARTICLES Particles, Particle. PHYSICS Physics, Physics. Type enum in [SCENE, RENDER, WORLD, OBJECT, CONSTRAINT, MODIFIER, DATA, BONE, BONE_CONSTRAINT, MATERIAL, TEXTURE, PARTICLES, PHYSICS], default RENDER pin_id Type ID texture_context Type of texture data to display and edit MATERIAL Material, Material. Type enum in [MATERIAL], default MATERIAL use_pin_id Use the pinned context Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link]

2.4. Types ([Link])

943

Blender Index, Release 2.59.2 - API

Inherited Functions

2.4.524 SpaceSequenceEditor(Space)
base classes bpy_struct, Space class [Link](Space) Sequence editor space data display_channel The channel number shown in the image preview. 0 is the result of all strips combined Type int in [-5, 32], default 0 display_mode The view mode to use for displaying sequencer output Type enum in [IMAGE, WAVEFORM, VECTOR_SCOPE, HISTOGRAM], default IMAGE draw_overexposed Show overexposed areas with zebra stripes Type int in [0, 110], default 0 grease_pencil Grease pencil data for this space Type UnknownType, (readonly) offset_x Offsets image horizontally from the view center Type oat in [-inf, inf], default 0.0 offset_y Offsets image horizontally from the view center Type oat in [-inf, inf], default 0.0 proxy_render_size Draw preview using full resolution or different proxy resolutions

944

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type enum in [NONE, SCENE, PROXY_25, PROXY_100, FULL], default SCENE show_frame_indicator Show frame number beside the current frame indicator line Type boolean, default False show_frames Draw frames rather than seconds Type boolean, default False show_safe_margin Draw title safe margins in preview Type boolean, default False show_separate_color Separate color channels in preview Type boolean, default False use_grease_pencil Display and edit the grease pencil freehand annotations overlay Type boolean, default False use_marker_sync Transform markers as well as strips Type boolean, default False view_type The type of the Sequencer view (sequencer, preview or both)

PROXY_50,

PROXY_75,

Type enum in [SEQUENCER, PREVIEW, SEQUENCER_PREVIEW], default SEQUENCER zoom Display zoom level Type oat in [-inf, inf], default 0.0
Inherited Properties

bpy_struct.id_data [Link]
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set bpy_struct.items

2.4. Types ([Link])

945

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.525 SpaceTextEditor(Space)
base classes bpy_struct, Space class [Link](Space) Text editor space data find_text Text to search for with the nd tool Type string, default font_size Font size to use for displaying the text Type int in [8, 32], default 0 margin_column Column number to show right margin at Type int in [0, 1024], default 0 replace_text Text to replace selected text with using the replace tool Type string, default show_line_highlight Highlight the current line Type boolean, default False show_line_numbers Show line numbers next to the text Type boolean, default False show_margin Show right margin Type boolean, default False show_syntax_highlight Syntax highlight for scripting Type boolean, default False show_word_wrap Wrap words if there is not enough horizontal space Type boolean, default False tab_width Number of spaces to display tabs with Type int in [2, 8], default 0 946 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

text Text displayed and edited in this space Type Text use_find_all Search in all text datablocks, instead of only the active one Type boolean, default False use_find_wrap Search again from the start of the le when reaching the end Type boolean, default False use_live_edit Run python while editing Type boolean, default False use_match_case Search string is sensitive to uppercase and lowercase letters Type boolean, default False use_overwrite Overwrite characters when typing rather than inserting them Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link]
Inherited Functions

2.4.526 SpaceTimeline(Space)
base classes bpy_struct, Space 2.4. Types ([Link]) 947

Blender Index, Release 2.59.2 - API

class [Link](Space) Timeline editor space data cache_cloth Show the active objects cloth point cache Type boolean, default False cache_particles Show the active objects particle point cache Type boolean, default False cache_smoke Show the active objects smoke cache Type boolean, default False cache_softbody Show the active objects softbody point cache Type boolean, default False show_cache Show the status of cached frames in the timeline Type boolean, default False show_frame_indicator Show frame number beside the current frame indicator line Type boolean, default False show_only_selected Show keyframes for active Object and/or its selected bones only Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link]
Inherited Functions

948

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.type_recast bpy_struct.values

2.4.527 SpaceUVEditor(bpy_struct)
base class bpy_struct class [Link](bpy_struct) UV editor data for the image editor space cursor_location 2D cursor location for this view Type oat array of 2 items in [-inf, inf], default (0.0, 0.0) draw_stretch_type Type of stretch to draw ANGLE Angle, Angular distortion between UV and 3D angles. AREA Area, Area distortion between UV and 3D faces. Type enum in [ANGLE, AREA], default ANGLE edge_draw_type Draw type for drawing UV edges OUTLINE Outline, Draw white edges with black outline. DASH Dash, Draw dashed black-white edges. BLACK Black, Draw black edges. WHITE White, Draw white edges. Type enum in [OUTLINE, DASH, BLACK, WHITE], default OUTLINE lock_bounds Constraint to stay within the image bounds while editing Type boolean, default False pivot_point Rotation/Scaling Pivot Type enum in [CENTER, MEDIAN, CURSOR], default CENTER show_faces Draw faces over the image Type boolean, default False show_modified_edges Draw edges after modiers are applied Type boolean, default False show_normalized_coords Display UV coordinates from 0.0 to 1.0 rather than in pixels Type boolean, default False

2.4. Types ([Link])

949

Blender Index, Release 2.59.2 - API

show_other_objects Draw other selected objects that share the same image Type boolean, default False show_smooth_edges Draw UV edges anti-aliased Type boolean, default False show_stretch Draw faces colored according to the difference in shape between UVs and their 3D coordinates (blue for low distortion, red for high distortion) Type boolean, default False sticky_select_mode Automatically select also UVs sharing the same vertex as the ones being selected DISABLED Disabled, Sticky vertex selection disabled. SHARED_LOCATION Shared Location, Select UVs that are at the same location and share a mesh vertex. SHARED_VERTEX Shared Vertex, Select UVs that share mesh vertex, irrespective if they are in the same location. Type enum in [DISABLED, SHARED_LOCATION, SHARED_VERTEX], default SHARED_LOCATION use_live_unwrap Continuously unwrap the selected UV island while transforming pinned vertices Type boolean, default False use_snap_to_pixels Snap UVs to pixel locations while editing Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

950

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

SpaceImageEditor.uv_editor

2.4.528 SpaceUserPreferences(Space)
base classes bpy_struct, Space class [Link](Space) User preferences space data filter_text Search term for ltering in the UI Type string, default
Inherited Properties

bpy_struct.id_data [Link]
Inherited Functions

2.4.529 SpaceView3D(Space)
base classes bpy_struct, Space class [Link].SpaceView3D(Space) 3D View space data

2.4. Types ([Link])

951

Blender Index, Release 2.59.2 - API

background_images List of background images Type bpy_prop_collection of BackgroundImage, (readonly) camera Active camera used in this view (when unlocked from the scenes active camera) Type Object clip_end 3D View far clipping distance Type oat in [1, inf], default 0.0 clip_start 3D View near clipping distance Type oat in [0.001, inf], default 0.0 current_orientation Current Transformation orientation Type TransformOrientation, (readonly) cursor_location 3D cursor location for this view (dependent on local view setting) Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) grid_lines The number of grid lines to display in perspective view Type int in [0, 1024], default 0 grid_scale The distance between 3D View grid lines Type oat in [0, inf], default 0.0 grid_subdivisions The number of subdivisions between grid lines Type int in [1, 1024], default 0 layers Layers visible in this 3D View Type boolean array of 20 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False) layers_used Layers that contain something Type boolean array of 20 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False), (readonly) lens Lens angle (mm) in perspective view Type oat in [1, 250], default 0.0 local_view Display an isolated sub-set of objects, apart from the scene visibility Type SpaceView3D, (readonly)

952

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

lock_bone 3D View center is locked to this bones position Type string, default lock_camera Enable view navigation within the camera view Type boolean, default False lock_camera_and_layers Use the scenes active camera and layers in this view, rather than local layers Type boolean, default False lock_cursor 3D View center is locked to the cursors position Type boolean, default False lock_object 3D View center is locked to this objects position Type Object pivot_point Pivot center for rotation/scaling BOUNDING_BOX_CENTER Bounding Box Center, Pivot around bounding box center of selected object(s). CURSOR 3D Cursor, Pivot around the 3D cursor. INDIVIDUAL_ORIGINS Individual Origins, Pivot around each objects own origin. MEDIAN_POINT Median Point, Pivot around the median point of selected objects. ACTIVE_ELEMENT Active Element, Pivot around active object. Type enum in [BOUNDING_BOX_CENTER, CURSOR, INDIVIDUAL_ORIGINS, MEDIAN_POINT, ACTIVE_ELEMENT], default BOUNDING_BOX_CENTER region_3d 3D region in this space, in case of quad view the camera region Type RegionView3D, (readonly) region_quadview 3D region that denes the quad view settings Type RegionView3D, (readonly) show_all_objects_origin Show the object origin center dot for all (selected and unselected) objects Type boolean, default False show_axis_x Show the X axis line in perspective view Type boolean, default False show_axis_y Show the Y axis line in perspective view Type boolean, default False

2.4. Types ([Link])

953

Blender Index, Release 2.59.2 - API

show_axis_z Show the Z axis line in perspective view Type boolean, default False show_background_images Display reference images behind objects in the 3D View Type boolean, default False show_floor Show the ground plane grid in perspective view Type boolean, default False show_manipulator Use a 3D manipulator widget for controlling transforms Type boolean, default False show_only_render Display only objects which will be rendered Type boolean, default False show_outline_selected Show an outline highlight around selected objects in non-wireframe views Type boolean, default False show_relationship_lines Show dashed lines indicating parent or constraint relationships Type boolean, default False show_textured_solid Display face-assigned textures in solid view Type boolean, default False transform_orientation Transformation orientation GLOBAL Global, Align the transformation axes to world space. LOCAL Local, Align the transformation axes to the selected objects local space. GIMBAL Gimbal, Align each axis to the Euler rotation axis as used for input. NORMAL Normal, Align the transformation axes to average normal of selected elements (bone Y axis for pose mode). VIEW View, Align the transformation axes to the window. CUSTOM Custom, Use a custom transform orientation. Type enum in [GLOBAL, LOCAL, GIMBAL, NORMAL, VIEW, CUSTOM], default GLOBAL use_manipulator_rotate Use the manipulator for rotation transformations Type boolean, default False use_manipulator_scale Use the manipulator for scale transformations

954

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type boolean, default False use_manipulator_translate Use the manipulator for movement transformations Type boolean, default False use_occlude_geometry Limit selection to visible (clipped with depth buffer) Type boolean, default False use_pivot_point_align Manipulate object centers only Type boolean, default False viewport_shade Method to display/shade objects in the 3D View BOUNDBOX Bounding Box, Display the objects local bounding boxes only. WIREFRAME Wireframe, Display the object as wire edges. SOLID Solid, Display the object solid, lit with default OpenGL lights. TEXTURED Textured, Display the object solid, with face-assigned textures. Type enum in [BOUNDBOX, WIREFRAME, SOLID, TEXTURED], default BOUNDBOX
Inherited Properties

bpy_struct.id_data [Link]
Inherited Functions

2.4. Types ([Link])

955

Blender Index, Release 2.59.2 - API

References

ObjectBase.layers_from_view SpaceView3D.local_view

2.4.530 Speaker(ID)
base classes bpy_struct, ID class [Link](ID) Speaker datablock for 3D audio speaker objects animation_data Animation data for this datablock Type AnimData, (readonly) attenuation How strong the distance affects volume, depending on distance model. Type oat in [0, inf], default 0.0 cone_angle_inner Inner angle of the cone in degrees, inside the cone the volume is 100 %. Type oat in [0, 360], default 0.0 cone_angle_outer Outer angle of the cone in degrees, outside this cone the volume is the outer cone volume, between inner and outer cone the volume is interpolated. Type oat in [0, 360], default 0.0 cone_volume_outer Volume outside the outer cone. Type oat in [0, 1], default 0.0 distance_max Maximum distance for volume calculation, no matter how far away the object is. Type oat in [0, inf], default 0.0 distance_reference Reference distance at which volume is 100 %. Type oat in [0, inf], default 0.0 muted Mutes the speaker. Type boolean, default False pitch Playback pitch of the sound. Type oat in [0.1, 10], default 0.0 sound Sound datablock used by this speaker. Type Sound

956

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

volume How loud the sound is. Type oat in [0, 1], default 0.0 volume_max Maximum volume, no matter how near the object is. Type oat in [0, 1], default 0.0 volume_min Minimum volume, no matter how far away the object is. Type oat in [0, 1], default 0.0
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

Inherited Functions

References

[Link] [Link] [Link]

2.4. Types ([Link])

957

Blender Index, Release 2.59.2 - API

2.4.531 SpeedControlSequence(EffectSequence)
base classes bpy_struct, Sequence, EffectSequence class [Link](EffectSequence) Sequence strip to control the speed of other strips multiply_speed Multiply the resulting speed after the speed factor Type oat in [0, inf], default 0.0 scale_to_length Scale values from 0.0 to 1.0 to target sequence length Type boolean, default False use_as_speed Interpret the value as speed instead of a frame number Type boolean, default False use_frame_blend Blend two frames into the target for a smoother result Type boolean, default False
Inherited Properties

958

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

EffectSequence.color_balance EffectSequence.use_float [Link] EffectSequence.use_deinterlace EffectSequence.use_reverse_frames EffectSequence.use_flip_x EffectSequence.use_flip_y EffectSequence.color_multiply EffectSequence.use_premultiply [Link] EffectSequence.use_proxy_custom_directory EffectSequence.use_proxy_custom_file EffectSequence.color_saturation [Link] [Link] EffectSequence.use_color_balance EffectSequence.use_crop EffectSequence.use_proxy EffectSequence.use_translation

Inherited Functions

2.4.532 Spline(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Element of a curve, either Nurbs, Bezier or Polyline or a character with text objects bezier_points Collection of points for Bezier curves only Type SplineBezierPoints bpy_prop_collection of BezierSplinePoint, (readonly)

2.4. Types ([Link])

959

Blender Index, Release 2.59.2 - API

character_index Location of this character in the text data (only for text curves) Type int in [0, inf], default 0, (readonly) hide Hide this curve in editmode Type boolean, default False material_index Type int in [0, 32767], default 0 order_u Nurbs order in the U direction (For splines and surfaces), Higher values let points inuence a greater area Type int in [2, 6], default 0 order_v Nurbs order in the V direction (For surfaces only), Higher values let points inuence a greater area Type int in [2, 6], default 0 point_count_u Total number points for the curve or surface in the U direction Type int in [0, 32767], default 0, (readonly) point_count_v Total number points for the surface on the V direction Type int in [0, 32767], default 0, (readonly) points Collection of points that make up this poly or nurbs spline Type SplinePoints bpy_prop_collection of SplinePoint, (readonly) radius_interpolation The type of radius interpolation for Bezier curves Type enum in [LINEAR, CARDINAL, BSPLINE, EASE], default LINEAR resolution_u Curve or Surface subdivisions per segment Type int in [1, 32767], default 0 resolution_v Surface subdivisions per segment Type int in [1, 32767], default 0 tilt_interpolation The type of tilt interpolation for 3D, Bezier curves Type enum in [LINEAR, CARDINAL, BSPLINE, EASE], default LINEAR type The interpolation type for this curve element Type enum in [POLY, BEZIER, BSPLINE, CARDINAL, NURBS], default POLY use_bezier_u Make this nurbs curve or surface act like a Bezier spline in the U direction (Order U must be 3 or 4, Cyclic U must be disabled)

960

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type boolean, default False use_bezier_v Make this nurbs surface act like a Bezier spline in the V direction (Order V must be 3 or 4, Cyclic V must be disabled) Type boolean, default False use_cyclic_u Make this curve or surface a closed loop in the U direction Type boolean, default False use_cyclic_v Make this surface a closed loop in the V direction Type boolean, default False use_endpoint_u Make this nurbs curve or surface meet the endpoints in the U direction (Cyclic U must be disabled) Type boolean, default False use_endpoint_v Make this nurbs surface meet the endpoints in the V direction (Cyclic V must be disabled) Type boolean, default False use_smooth Smooth the normals of the surface or beveled curve Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

961

Blender Index, Release 2.59.2 - API

References

[Link] [Link] [Link]

2.4.533 SplineBezierPoints(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of spline bezirt points add(count=1) Add a number of points to this spline. Parameters count (int in [-inf, inf], (optional)) Number, Number of points to add to the spline
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Spline.bezier_points

2.4.534 SplineIKConstraint(Constraint)
base classes bpy_struct, Constraint class [Link](Constraint) Align n bones along a curve

962

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

chain_count How many bones are included in the chain Type int in [1, 255], default 0 joint_bindings (EXPERIENCED USERS ONLY) The relative positions of the joints along the chain as percentages Type oat array of 32 items in [0, 1], default (0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0) target Curve that controls this relationship Type Object use_chain_offset Offset the entire chain relative to the root joint Type boolean, default False use_curve_radius Average radius of the endpoints is used to tweak the X and Z Scaling of the bones, on top of XZ Scale mode Type boolean, default False use_even_divisions Ignore the relative lengths of the bones when tting to the curve Type boolean, default False use_y_stretch Stretch the Y axis of the bones to t the curve Type boolean, default False xz_scale_mode Method used for determining the scaling of the X and Z axes of the bones NONE None, Dont scale the X and Z axes (Default). BONE_ORIGINAL Bone Original, Use the original scaling of the bones. VOLUME_PRESERVE Volume Preservation, Scale of the X and Z axes is the inverse of the Y-Scale. Type enum in [NONE, BONE_ORIGINAL, VOLUME_PRESERVE], default NONE
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] Constraint.show_expanded [Link] Constraint.error_location Constraint.owner_space Constraint.is_proxy_local Constraint.error_rotation Constraint.target_space

2.4. Types ([Link])

963

Blender Index, Release 2.59.2 - API

[Link] Constraint.is_valid
Inherited Functions

2.4.535 SplinePoint(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Spline point without handles co Point coordinates Type oat array of 4 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0) hide Visibility status Type boolean, default False radius Radius for bevelling Type oat in [0, inf], default 0.0 select Selection status Type boolean, default False tilt Tilt in 3D View Type oat in [-inf, inf], default 0.0 weight Nurbs weight Type oat in [-inf, inf], default 0.0

964

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

weight_softbody Softbody goal weight Type oat in [0.01, 100], default 0.0
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.536 SplinePoints(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of spline points add(count=1) Add a number of points to this spline. Parameters count (int in [1, inf], (optional)) Number, Number of points to add to the spline
Inherited Properties

bpy_struct.id_data

2.4. Types ([Link])

965

Blender Index, Release 2.59.2 - API

Inherited Functions

References

[Link]

2.4.537 SpotLamp(Lamp)
base classes bpy_struct, ID, Lamp class [Link](Lamp) Directional cone lamp compression_threshold Deep shadow map compression threshold Type oat in [0, 1], default 0.0 falloff_curve Custom Lamp Falloff Curve Type CurveMapping, (readonly) falloff_type Intensity Decay with distance Type enum in [CONSTANT, INVERSE_LINEAR, INVERSE_SQUARE, CUSTOM_CURVE, LINEAR_QUADRATIC_WEIGHTED], default CONSTANT halo_intensity Brightness of the spotlights halo cone Type oat in [-inf, inf], default 0.0 halo_step Volumetric halo sampling frequency Type int in [0, 12], default 0 linear_attenuation Linear distance attenuation 966 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type oat in [0, 1], default 0.0 quadratic_attenuation Quadratic distance attenuation Type oat in [0, 1], default 0.0 shadow_adaptive_threshold Threshold for Adaptive Sampling (Raytraced shadows) Type oat in [0, 1], default 0.0 shadow_buffer_bias Shadow buffer sampling bias Type oat in [0.001, 5], default 0.0 shadow_buffer_clip_end Shadow map clip end beyond which objects will not generate shadows Type oat in [0, 9999], default 0.0 shadow_buffer_clip_start Shadow map clip start: objects closer will not generate shadows Type oat in [0, 9999], default 0.0 shadow_buffer_samples Number of shadow buffer samples Type int in [1, 16], default 0 shadow_buffer_size Resolution of the shadow buffer, higher values give crisper shadows but use more memory Type int in [512, 10240], default 0 shadow_buffer_soft Size of shadow buffer sampling area Type oat in [0, 100], default 0.0 shadow_buffer_type Type of shadow buffer REGULAR Classical, Classic shadow buffer. HALFWAY Classic-Halfway, Regular buffer, averaging the closest and 2nd closest Z value to reducing bias artifacts. IRREGULAR Irregular, Irregular buffer produces sharp shadow always, but it doesnt show up for raytracing. DEEP Deep, Deep shadow buffer supports transparency and better ltering, at the cost of more memory usage and processing time. Type enum in [REGULAR, HALFWAY, IRREGULAR, DEEP], default REGULAR shadow_color Color of shadows cast by the lamp Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) shadow_filter_type Type of shadow lter (Buffer Shadows)

2.4. Types ([Link])

967

Blender Index, Release 2.59.2 - API

BOX Box, Apply the Box lter to shadow buffer samples. TENT Tent, Apply the Tent Filter to shadow buffer samples. GAUSS Gauss, Apply the Gauss lter to shadow buffer samples. Type enum in [BOX, TENT, GAUSS], default BOX shadow_method Method to compute lamp shadow with NOSHADOW No Shadow. BUFFER_SHADOW Buffer Shadow, Lets spotlight produce shadows using shadow buffer. RAY_SHADOW Ray Shadow, Use ray tracing for shadow. Type enum in [NOSHADOW, NOSHADOW BUFFER_SHADOW, RAY_SHADOW], default

shadow_ray_sample_method Method for generating shadow samples: Adaptive QMC is fastest, Constant QMC is less noisy but slower Type enum in [ADAPTIVE_QMC, CONSTANT_QMC], default ADAPTIVE_QMC shadow_ray_samples Amount of samples taken extra (samples x samples) Type int in [1, 64], default 0 shadow_sample_buffers Number of shadow buffers to render for better AA, this increases memory usage BUFFERS_1 1, Only one buffer rendered. BUFFERS_4 4, Renders 4 buffers for better AA, this quadruples memory usage. BUFFERS_9 9, Renders 9 buffers for better AA, this uses nine times more memory. Type enum in [BUFFERS_1, BUFFERS_4, BUFFERS_9], default BUFFERS_1 shadow_soft_size Light size for ray shadow sampling (Raytraced shadows) Type oat in [-inf, inf], default 0.0 show_cone Draw transparent cone in 3D view to visualize which objects are contained in it Type boolean, default False spot_blend The softness of the spotlight edge Type oat in [0, 1], default 0.0 spot_size Angle of the spotlight beam in degrees Type oat in [0.0174533, 3.14159], default 0.0 use_auto_clip_end Automatic calculation of clipping-end, based on visible vertices

968

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type boolean, default False use_auto_clip_start Automatic calculation of clipping-start, based on visible vertices Type boolean, default False use_halo Renders spotlight with a volumetric halo Type boolean, default False use_only_shadow Causes light to cast shadows only without illuminating objects Type boolean, default False use_shadow_layer Causes only objects on the same layer to cast shadows Type boolean, default False use_sphere Sets light intensity to zero beyond lamp distance Type boolean, default False use_square Casts a square spot light shape Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link] Lamp.active_texture Lamp.active_texture_index Lamp.animation_data [Link] Lamp.use_diffuse [Link] [Link] Lamp.use_own_layer Lamp.use_negative Lamp.use_specular Lamp.texture_slots [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove

2.4. Types ([Link])

969

Blender Index, Release 2.59.2 - API

2.4.538 StateActuator(Actuator)
base classes bpy_struct, Actuator class [Link](Actuator) Actuator to handle states operation Select the bit operation on object state mask Type enum in [SET, ADD, REMOVE, CHANGE], default SET states Type boolean array of 30 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False)
Inherited Properties

bpy_struct.id_data [Link] Actuator.show_expanded [Link] [Link]

Inherited Functions

970

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.539 SteeringActuator(Actuator)
base classes bpy_struct, Actuator class [Link](Actuator) acceleration Max acceleration Type oat in [0, 1000], default 0.0 distance Relax distance Type oat in [0, 1000], default 0.0 facing Enable automatic facing Type boolean, default False facing_axis Axis for automatic facing Type enum in [X, Y, Z, -X, -Y, -Z], default X mode Type enum in [SEEK, FLEE, PATHFOLLOWING], default SEEK navmesh Navigation mesh Type Object normal_up Use normal of the navmesh to set UP vector Type boolean, default False self_terminated Terminate when target is reached Type boolean, default False show_visualization Enable debug visualization Type boolean, default False

2.4. Types ([Link])

971

Blender Index, Release 2.59.2 - API

target Set target object Type Object turn_speed Max turn speed Type oat in [0, 720], default 0.0 update_period Path update period Type int in [-inf, inf], default 0 velocity Velocity magnitude Type oat in [0, 1000], default 0.0
Inherited Properties

bpy_struct.id_data [Link] Actuator.show_expanded [Link] [Link]

Inherited Functions

2.4.540 StretchToConstraint(Constraint)
base classes bpy_struct, Constraint class [Link](Constraint) Stretches to meet the target object

972

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bulge Factor between volume variation and stretching Type oat in [0, 100], default 0.0 head_tail Target along length of bone: Head=0, Tail=1 Type oat in [0, 1], default 0.0 keep_axis Axis to maintain during stretch PLANE_X X, Keep X Axis. PLANE_Z Z, Keep Z Axis. Type enum in [PLANE_X, PLANE_Z], default PLANE_X rest_length Length at rest position Type oat in [0, 100], default 0.0 subtarget Type string, default target Target Object Type Object volume Maintain the objects volume as it stretches Type enum in [VOLUME_XZX, VOLUME_X, VOLUME_Z, NO_VOLUME], default VOLUME_XZX
Inherited Properties

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add 2.4. Types ([Link]) 973

Blender Index, Release 2.59.2 - API

2.4.541 StringProperty(Property)
base classes bpy_struct, Property class [Link](Property) RNA text string property denition default string default value Type string, default , (readonly) length_max Maximum length of the string, 0 means unlimited Type int in [0, inf], default 0, (readonly)
Inherited Properties

974

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Functions

References

Struct.name_property

2.4.542 Struct(bpy_struct)
base class bpy_struct class [Link](bpy_struct) RNA structure denition base Struct denition this is derived from Type Struct, (readonly) description Description of the Structs purpose Type string, default , (readonly) functions Type bpy_prop_collection of Function, (readonly) identifier Unique name used in the code and scripting Type string, default , (readonly) name Human readable name Type string, default , (readonly) name_property Property that gives the name of the struct Type StringProperty, (readonly)

2.4. Types ([Link])

975

Blender Index, Release 2.59.2 - API

nested Struct in which this struct is always nested, and to which it logically belongs Type Struct, (readonly) properties Properties in the struct Type bpy_prop_collection of Property, (readonly)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] CollectionProperty.fixed_type PointerProperty.fixed_type [Link] [Link] [Link]

2.4.543 StucciTexture(Texture)
base classes bpy_struct, ID, Texture class [Link](Texture) Procedural noise texture noise_basis Sets the noise basis used for turbulence

976

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

BLENDER_ORIGINAL Blender Original, Noise algorithm - Blender original: Smooth interpolated noise. ORIGINAL_PERLIN Original Perlin, Noise algorithm - Original Perlin: Smooth interpolated noise. IMPROVED_PERLIN Improved Perlin, Noise algorithm - Improved Perlin: Smooth interpolated noise. VORONOI_F1 Voronoi F1, Noise algorithm - Voronoi F1: Returns distance to the closest feature point. VORONOI_F2 Voronoi F2, Noise algorithm - Voronoi F2: Returns distance to the 2nd closest feature point. VORONOI_F3 Voronoi F3, Noise algorithm - Voronoi F3: Returns distance to the 3rd closest feature point. VORONOI_F4 Voronoi F4, Noise algorithm - Voronoi F4: Returns distance to the 4th closest feature point. VORONOI_F2_F1 Voronoi F2-F1, Noise algorithm - Voronoi F1-F2. VORONOI_CRACKLE Voronoi Crackle, Noise algorithm - Voronoi Crackle: Voronoi tessellation with sharp edges. CELL_NOISE Cell Noise, Noise algorithm - Cell Noise: Square cell tessallation. Type enum in [BLENDER_ORIGINAL, ORIGINAL_PERLIN, IMPROVED_PERLIN, VORONOI_F1, VORONOI_F2, VORONOI_F3, VORONOI_F4, VORONOI_F2_F1, VORONOI_CRACKLE, CELL_NOISE], default BLENDER_ORIGINAL noise_scale Sets scaling for noise input Type oat in [0.0001, inf], default 0.0 noise_type SOFT_NOISE Soft, Generate soft noise (smooth transitions). HARD_NOISE Hard, Generate hard noise (sharp transitions). Type enum in [SOFT_NOISE, HARD_NOISE], default SOFT_NOISE stucci_type PLASTIC Plastic, Uses standard stucci. WALL_IN Wall in, Creates Dimples. WALL_OUT Wall out, Creates Ridges. Type enum in [PLASTIC, WALL_IN, WALL_OUT], default PLASTIC turbulence Sets the turbulence of the bandnoise and ringnoise types Type oat in [0.0001, inf], default 0.0 users_material Materials that use this texture (readonly)

2.4. Types ([Link])

977

Blender Index, Release 2.59.2 - API

users_object_modifier Object modiers that use this texture (readonly)

Inherited Properties

Inherited Functions

978

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link]

2.4.544 SubsurfModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Subdivision surface modier levels Number of subdivisions to perform Type int in [0, 32767], default 0 render_levels Number of subdivisions to perform when rendering Type int in [0, 32767], default 0 show_only_control_edges Skip drawing/rendering of interior subdivided edges Type boolean, default False subdivision_type Selects type of subdivision algorithm Type enum in [CATMULL_CLARK, SIMPLE], default CATMULL_CLARK use_subsurf_uv Use subsurf to subdivide UVs Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.545 SunLamp(Lamp)
base classes bpy_struct, ID, Lamp class [Link](Lamp) Constant direction parallel ray lamp shadow_adaptive_threshold Threshold for Adaptive Sampling (Raytraced shadows) Type oat in [0, 1], default 0.0 shadow_color Color of shadows cast by the lamp Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) shadow_method Method to compute lamp shadow with NOSHADOW No Shadow. RAY_SHADOW Ray Shadow, Use ray tracing for shadow. Type enum in [NOSHADOW, RAY_SHADOW], default NOSHADOW shadow_ray_sample_method Method for generating shadow samples: Adaptive QMC is fastest, Constant QMC is less noisy but slower Type enum in [ADAPTIVE_QMC, CONSTANT_QMC], default ADAPTIVE_QMC shadow_ray_samples Amount of samples taken extra (samples x samples) Type int in [1, 64], default 0 shadow_soft_size Light size for ray shadow sampling (Raytraced shadows) Type oat in [-inf, inf], default 0.0 sky Sky related settings for sun lamps Type LampSkySettings, (readonly, never None) use_only_shadow Causes light to cast shadows only without illuminating objects Type boolean, default False use_shadow_layer Causes only objects on the same layer to cast shadows Type boolean, default False 980 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

Inherited Functions

2.4.546 SurfaceCurve(Curve)
base classes bpy_struct, ID, Curve class [Link](Curve) Curve datablock used for storing surfaces

2.4. Types ([Link])

981

Blender Index, Release 2.59.2 - API

use_uv_as_generated Uses the UV values as Generated textured coordinates Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link] Curve.animation_data Curve.use_auto_texspace Curve.use_fill_back Curve.bevel_depth Curve.bevel_object Curve.bevel_resolution Curve.use_deform_bounds [Link] Curve.show_handles Curve.show_normal_face Curve.eval_time [Link] Curve.use_fill_deform Curve.use_path_follow Curve.use_fill_front [Link] [Link] Curve.use_time_offset Curve.use_path Curve.path_duration Curve.use_radius Curve.render_resolution_u Curve.render_resolution_v Curve.resolution_u Curve.resolution_v Curve.shape_keys [Link] Curve.use_stretch Curve.taper_object Curve.texspace_location Curve.texspace_size Curve.twist_mode Curve.twist_smooth Curve.use_uv_as_generated

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove 982 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.547 SurfaceModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Surface modier dening modier stack position used for surface elds
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.548 TexMapping(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Mapping settings location Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) max Maximum value for clipping Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) min Minimum value for clipping Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) rotation Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) scale Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) use_max Whether to use maximum clipping value Type boolean, default False use_min Whether to use minimum clipping value Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

984

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.549 Text(ID)
base classes bpy_struct, ID class [Link](ID) Text datablock referencing an external or packed text le current_character Index of current character in current line, and also start index of character in selection if one exists Type int in [0, inf], default 0, (readonly) current_line Current line, and start line of selection if one exists Type TextLine, (readonly, never None) filepath Filename of the text le Type string, default is_dirty Text le has been edited since last save Type boolean, default False, (readonly) is_in_memory Text le is in memory, without a corresponding le on disk Type boolean, default False, (readonly) is_modified Text le on disk is different than the one in memory Type boolean, default False, (readonly) lines Lines of text Type bpy_prop_collection of TextLine, (readonly) markers Text markers highlighting part of the text Type bpy_prop_collection of TextMarker, (readonly) select_end_character Index of character after end of selection in the selection end line Type int in [0, inf], default 0, (readonly) select_end_line End line of selection Type TextLine, (readonly, never None) 2.4. Types ([Link]) 985

Blender Index, Release 2.59.2 - API

use_module Register this text as a module on loading, Text name must end with .py Type boolean, default False use_tabs_as_spaces Automatically converts all new tabs into spaces Type boolean, default False users_logic Logic bricks that use this text (readonly) clear() clear the text block. write(text) write text at the cursor location and advance to the end of the text block. Parameters text (string) New text for this datablock. static as_string(self ) Return the text as a string. from_string(string) Replace text with this string.
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

Inherited Functions

986

Blender Index, Release 2.59.2 - API

ID.animation_data_clear ID.update_tag
References

[Link] [Link] [Link] [Link] Filter2DActuator.glsl_shader [Link] [Link] SceneGameData.dome_text [Link]

2.4.550 TextBox(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Text bounding box for layout height Type oat in [0, 50], default 0.0 width Type oat in [0, 50], default 0.0 x Type oat in [-50, 50], default 0.0 y Type oat in [-50, 50], default 0.0
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

TextCurve.text_boxes

2.4.551 TextCharacterFormat(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Text character formatting settings use_bold Type boolean, default False use_italic Type boolean, default False use_small_caps Type boolean, default False use_underline Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

988

Blender Index, Release 2.59.2 - API

References

TextCurve.body_format TextCurve.edit_format

2.4.552 TextCurve(Curve)
base classes bpy_struct, ID, Curve class [Link](Curve) Curve datablock used for storing text active_textbox Type int in [-inf, inf], default 0 align Text align from the object center LEFT Left, Align text to the left. CENTER Center, Center text. RIGHT Right, Align text to the right. JUSTIFY Justify, Align to the left and the right. FLUSH Flush, Align to the left and the right, with equal character spacing. Type enum in [LEFT, CENTER, RIGHT, JUSTIFY, FLUSH], default LEFT body contents of this text object Type string, default body_format Stores the style of each character Type bpy_prop_collection of TextCharacterFormat, (readonly) edit_format Editing settings character formatting Type TextCharacterFormat, (readonly) family Use Blender Objects as font characters. Give font objects a common name followed by the character it represents, eg. familya, familyb etc, and turn on Verts Duplication Type string, default follow_curve Curve deforming text object Type Object font Type VectorFont font_bold Type VectorFont 2.4. Types ([Link]) 989

Blender Index, Release 2.59.2 - API

font_bold_italic Type VectorFont font_italic Type VectorFont offset_x Horizontal offset from the object origin Type oat in [-50, 50], default 0.0 offset_y Vertical offset from the object origin Type oat in [-50, 50], default 0.0 shear Italic angle of the characters Type oat in [-1, 1], default 0.0 size Type oat in [0.0001, 10000], default 0.0 small_caps_scale Scale of small capitals Type oat in [-inf, inf], default 0.0 space_character Type oat in [0, 10], default 0.0 space_line Type oat in [0, 10], default 0.0 space_word Type oat in [0, 10], default 0.0 text_boxes Type bpy_prop_collection of TextBox, (readonly) underline_height Type oat in [-0.2, 0.8], default 0.0 underline_position Vertical position of underline Type oat in [-0.2, 0.8], default 0.0 use_fast_edit Dont ll polygons while editing Type boolean, default False use_uv_as_generated Uses the UV values as Generated textured coordinates Type boolean, default False

990

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden bpy_struct.is_property_set 991

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

2.4.553 TextLine(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Line of text in a Text datablock body Text in the line Type string, default
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Text.current_line 992 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link] Text.select_end_line

2.4.554 TextMarker(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Marker highlighting a portion of text in a Text datablock character_index_end Start position of the marker in the line Type int in [0, inf], default 0, (readonly) character_index_start Start position of the marker in the line Type int in [0, inf], default 0, (readonly) color Color to display the marker with Type oat array of 4 items in [0, 1], default (0.0, 0.0, 0.0, 0.0) group Type int in [0, 65535], default 0, (readonly) is_temporary Marker is temporary Type boolean, default False, (readonly) line Line in which the marker is located Type int in [0, inf], default 0, (readonly) use_edit_all Edit all markers of the same group as one Type boolean, default False, (readonly)
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

[Link]

2.4.555 Texture(ID)
base classes bpy_struct, ID subclasses ImageTexture, MarbleTexture, EnvironmentMapTexture, PointDensityTexture, BlendTexture, MusgraveTexture, StucciTexture, VoronoiTexture, MagicTexture, VoxelDataTexture, PluginTexture, WoodTexture, CloudsTexture, DistortedNoiseTexture, NoiseTexture class [Link](ID) Texture datablock used by materials, lamps, worlds and brushes animation_data Animation data for this datablock Type AnimData, (readonly) color_ramp Type ColorRamp, (readonly) contrast Adjusts the contrast of the texture Type oat in [0.01, 5], default 0.0 factor_blue Type oat in [0, 2], default 0.0 factor_green Type oat in [0, 2], default 0.0 factor_red Type oat in [0, 2], default 0.0 intensity Adjusts the brightness of the texture Type oat in [0, 2], default 0.0 node_tree Node tree for node-based textures Type NodeTree, (readonly) saturation Adjusts the saturation of colors in the texture 994 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type oat in [0, 2], default 0.0 type NONE None. BLEND Blend, Procedural - Creates a ramp texture. CLOUDS Clouds, Procedural - Creates a cloud-like fractal noise texture. DISTORTED_NOISE Distorted Noise, Procedural - Noise texture distorted by two noise algorithms. ENVIRONMENT_MAP Environment Map, Creates a render of the environment mapped to a texture. IMAGE Image or Movie, Allows for images or movies to be used as textures. MAGIC Magic, Procedural - Color texture based on trigonometric functions. MARBLE Marble, Procedural - Marble-like noise texture with wave generated bands. MUSGRAVE Musgrave, Procedural - Highly exible fractal noise texture. NOISE Noise, Procedural - Random noise, gives a different result every time, for every frame, for every pixel. POINT_DENSITY Point Density. STUCCI Stucci, Procedural - Creates a fractal noise texture. VORONOI Voronoi, Procedural - Creates cell-like patterns based on Worley noise. VOXEL_DATA Voxel Data, Creates a 3d texture based on volumetric data. WOOD Wood, Procedural - Wave generated bands or rings, with optional noise. Type enum in [NONE, BLEND, CLOUDS, DISTORTED_NOISE, ENVIRONMENT_MAP, IMAGE, MAGIC, MARBLE, MUSGRAVE, NOISE, POINT_DENSITY, STUCCI, VORONOI, VOXEL_DATA, WOOD], default NONE use_color_ramp Toggle color ramp operations Type boolean, default False use_nodes Make this a node-based texture Type boolean, default False use_preview_alpha Show Alpha in Preview Render Type boolean, default False users_material Materials that use this texture (readonly) users_object_modifier Object modiers that use this texture (readonly) evaluate(value) Evaluate the texture at the coordinates given Returns Result Return type oat array of 4 items in [-inf, inf]

2.4. Types ([Link])

995

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

Inherited Functions

References

996

[Link] [Link] [Link] [Link] [Link] [Link] [Link] Lamp.active_texture Material.active_texture ParticleSettings.active_texture [Link] [Link] [Link] VertexWeightEditModifier.mask_texture VertexWeightMixModifier.mask_texture VertexWeightProximityModifier.mask_texture [Link] Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link] World.active_texture

2.4.556 TextureNode(Node)
base classes bpy_struct, Node subclasses TextureNodeScale, TextureNodeRGBToBW, TextureNodeTranslate, TextureNodeTexture, TextureNodeCompose, TextureNodeValToNor, TextureNodeDecompose, TextureNodeHueSaturation, TextureNodeImage, TextureNodeBricks, TextureNodeCurveTime, TextureNodeInvert, TextureNodeCurveRGB, TextureNodeDistance, TextureNodeRotate, TextureNodeMixRGB, TextureNodeChecker, TextureNodeOutput, TextureNodeCoordinates, TextureNodeValToRGB, TextureNodeMath, TextureNodeViewer class [Link](Node) type Type enum in [OUTPUT, CHECKER, TEXTURE, BRICKS, MATH, MIX_RGB, RGBTOBW, VALTORGB, IMAGE, CURVE_RGB, INVERT, HUE_SAT, CURVE_TIME, ROTATE, VIEWER, TRANSLATE, COORD, DISTANCE, COMPOSE, DECOMPOSE, VALTONOR, SCALE, SCRIPT, GROUP], default OUTPUT, (readonly)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4. Types ([Link])

997

Blender Index, Release 2.59.2 - API

2.4.557 TextureNodeBricks(TextureNode)
base classes bpy_struct, Node, TextureNode class [Link](TextureNode) offset Type oat in [0, 1], default 0.0 offset_frequency Offset every N rows Type int in [2, 99], default 0 squash Type oat in [0, 99], default 0.0 squash_frequency Squash every N rows Type int in [2, 99], default 0
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

998

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.558 TextureNodeChecker(TextureNode)
base classes bpy_struct, Node, TextureNode class [Link](TextureNode)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.559 TextureNodeCompose(TextureNode)
base classes bpy_struct, Node, TextureNode class [Link](TextureNode)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link]

2.4. Types ([Link])

999

Blender Index, Release 2.59.2 - API

[Link]
Inherited Functions

2.4.560 TextureNodeCoordinates(TextureNode)
base classes bpy_struct, Node, TextureNode class [Link](TextureNode)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

1000

Blender Index, Release 2.59.2 - API

bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.561 TextureNodeCurveRGB(TextureNode)
base classes bpy_struct, Node, TextureNode class [Link](TextureNode) mapping Type CurveMapping, (readonly)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.562 TextureNodeCurveTime(TextureNode)
base classes bpy_struct, Node, TextureNode

2.4. Types ([Link])

1001

Blender Index, Release 2.59.2 - API

class [Link](TextureNode) curve Type CurveMapping, (readonly) frame_end Type int in [-32768, 32767], default 0 frame_start Type int in [-32768, 32767], default 0
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.563 TextureNodeDecompose(TextureNode)
base classes bpy_struct, Node, TextureNode class [Link](TextureNode)
Inherited Properties

bpy_struct.id_data 1002 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

Blender Index, Release 2.59.2 - API

[Link]
Inherited Functions

Blender Index, Release 2.59.2 - API

class [Link](TextureNode)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.572 TextureNodeRotate(TextureNode)
base classes bpy_struct, Node, TextureNode class [Link](TextureNode)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

2.4. Types ([Link])

1009

Blender Index, Release 2.59.2 - API

Inherited Functions

2.4.573 TextureNodeScale(TextureNode)
base classes bpy_struct, Node, TextureNode class [Link](TextureNode)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

1010

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.574 TextureNodeTexture(TextureNode)
base classes bpy_struct, Node, TextureNode class [Link](TextureNode) node_output For node-based textures, which output node to use Type int in [-32768, 32767], default 0 texture Type Texture
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.575 TextureNodeTranslate(TextureNode)
base classes bpy_struct, Node, TextureNode 2.4. Types ([Link]) 1011

Blender Index, Release 2.59.2 - API

class [Link](TextureNode)
Inherited Properties

bpy_struct.type_recast bpy_struct.values

2.4.579 TextureNodeViewer(TextureNode)
base classes bpy_struct, Node, TextureNode class [Link](TextureNode)
Inherited Properties

bpy_struct.id_data [Link] [Link] [Link] [Link] [Link] [Link] [Link]

Inherited Functions

2.4.580 TextureNodes(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of Texture Nodes new(type, group=None) Add a node to this node tree. Parameters

2.4. Types ([Link])

1015

Blender Index, Release 2.59.2 - API

type (enum in [OUTPUT, CHECKER, TEXTURE, BRICKS, MATH, MIX_RGB, RGBTOBW, VALTORGB, IMAGE, CURVE_RGB, INVERT, HUE_SAT, CURVE_TIME, ROTATE, VIEWER, TRANSLATE, COORD, DISTANCE, COMPOSE, DECOMPOSE, VALTONOR, SCALE, SCRIPT, GROUP]) Type, Type of node to add group (NodeTree, (optional)) The group tree Returns New node. Return type Node remove(node) remove a node from this node tree. Parameters node (Node) The node to remove.
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.581 TextureSlot(bpy_struct)
base class bpy_struct subclasses ParticleSettingsTextureSlot, BrushTextureSlot, WorldTextureSlot MaterialTextureSlot, LampTextureSlot,

class [Link](bpy_struct) Texture slot dening the mapping and inuence of a texture

1016

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

blend_type The mode used to apply the texture Type enum in [MIX, ADD, SUBTRACT, MULTIPLY, SCREEN, OVERLAY, DIFFERENCE, DIVIDE, DARKEN, LIGHTEN, HUE, SATURATION, VALUE, COLOR, SOFT_LIGHT, LINEAR_LIGHT], default MIX color The default color for textures that dont return RGB or when RGB to intensity is enabled Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) default_value Value to use for Ref, Spec, Amb, Emit, Alpha, RayMir, TransLu and Hard Type oat in [-inf, inf], default 0.0 invert Inverts the values of the texture to reverse its effect Type boolean, default False name Texture slot name Type string, default , (readonly) offset Fine tunes texture mapping X, Y and Z locations Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) output_node Which output node to use, for node-based textures Type enum in [DUMMY], default DUMMY scale Sets scaling for the textures X, Y and Z sizes Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) texture Texture datablock used by this texture slot Type Texture use_rgb_to_intensity Converts texture RGB values to intensity (gray) values Type boolean, default False use_stencil Use this texture as a blending value on the next texture Type boolean, default False
Inherited Properties

bpy_struct.id_data

2.4. Types ([Link])

1017

Blender Index, Release 2.59.2 - API

Inherited Functions

References

UILayout.template_preview

2.4.582 Theme(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Theme settings dening draw style and colors in the user interface bone_color_sets Type bpy_prop_collection of ThemeBoneColorSet, (readonly, never None) console Type ThemeConsole, (readonly, never None) dopesheet_editor Type ThemeDopeSheet, (readonly, never None) file_browser Type ThemeFileBrowser, (readonly, never None) graph_editor Type ThemeGraphEditor, (readonly, never None) image_editor Type ThemeImageEditor, (readonly, never None) info Type ThemeInfo, (readonly, never None) logic_editor

1018

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type ThemeLogicEditor, (readonly, never None) name Name of the theme Type string, default nla_editor Type ThemeNLAEditor, (readonly, never None) node_editor Type ThemeNodeEditor, (readonly, never None) outliner Type ThemeOutliner, (readonly, never None) properties Type ThemeProperties, (readonly, never None) sequence_editor Type ThemeSequenceEditor, (readonly, never None) text_editor Type ThemeTextEditor, (readonly, never None) theme_area Type enum in [USER_INTERFACE, BONE_COLOR_SETS, VIEW_3D, TIMELINE, GRAPH_EDITOR, DOPESHEET_EDITOR, NLA_EDITOR, IMAGE_EDITOR, SEQUENCE_EDITOR, TEXT_EDITOR, NODE_EDITOR, LOGIC_EDITOR, PROPERTIES, OUTLINER, USER_PREFERENCES, INFO, FILE_BROWSER, CONSOLE], default USER_INTERFACE timeline Type ThemeTimeline, (readonly, never None) user_interface Type ThemeUserInterface, (readonly, never None) user_preferences Type ThemeUserPreferences, (readonly, never None) view_3d Type ThemeView3D, (readonly, never None)
Inherited Properties

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove

2.4. Types ([Link])

1019

Blender Index, Release 2.59.2 - API

References

[Link]

2.4.583 ThemeAudioWindow(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Theme settings for the Audio Window back Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) frame_current Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) grid Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text_hi

1020

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) window_sliders Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4.584 ThemeBoneColorSet(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Theme settings for bone color sets active Color used for active bones Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) normal Color used for the surface of bones Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)

2.4. Types ([Link])

1021

Blender Index, Release 2.59.2 - API

select Color used for selected bones Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) show_colored_constraints Allow the use of colors indicating constraints/keyed status Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] Theme.bone_color_sets

2.4.585 ThemeConsole(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Theme settings for the Console back Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text

1022

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) cursor Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) line_error Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) line_info Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) line_input Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) line_output Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove

2.4. Types ([Link])

1023

Blender Index, Release 2.59.2 - API

References

[Link]

2.4.586 ThemeDopeSheet(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Theme settings for the DopeSheet active_channels_group Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) back Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) channel_group Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) channels Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) channels_selected Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) dopesheet_channel Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)

1024

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

dopesheet_subchannel Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) frame_current Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) grid Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) list Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) list_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) list_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) list_title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) long_key Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) long_key_selected Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) value_sliders Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) view_sliders Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)

2.4. Types ([Link])

1025

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Theme.dopesheet_editor

2.4.587 ThemeFileBrowser(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Theme settings for the File Browser active_file Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) active_file_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) back Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)

1026

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

button_title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) list Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) list_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) list_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) list_title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) scroll_handle Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) scrollbar Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) selected_file Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) tiles Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data

2.4. Types ([Link])

1027

Blender Index, Release 2.59.2 - API

Inherited Functions

References

Theme.file_browser

2.4.588 ThemeFontStyle(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Theme settings for Font font_kerning_style Which style to use for font kerning UNFITTED Untted, Use scaled but un-grid-tted kerning distances. DEFAULT Default, Use scaled and grid-tted kerning distances. Type enum in [UNFITTED, DEFAULT], default UNFITTED points Type int in [6, 48], default 0 shadow Shadow size in pixels (0, 3 and 5 supported) Type int in [0, 5], default 0 shadow_offset_x Shadow offset in pixels Type int in [-10, 10], default 0 shadow_offset_y Shadow offset in pixels Type int in [-10, 10], default 0

1028

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

shadowalpha Type oat in [0, 1], default 0.0 shadowcolor Shadow color in grey value Type oat in [0, 1], default 0.0
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

ThemeStyle.panel_title [Link] ThemeStyle.widget_label

2.4.589 ThemeGraphEditor(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Theme settings for the graph editor active_channels_group Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) back Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button

2.4. Types ([Link])

1029

Blender Index, Release 2.59.2 - API

Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) channel_group Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) channels_region Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) dopesheet_channel Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) dopesheet_subchannel Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) frame_current Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) grid Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_align Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_auto Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_auto_clamped Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_free Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_sel_align Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_sel_auto Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_sel_auto_clamped Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_sel_free Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_sel_vect

1030

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_vect Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_vertex Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_vertex_select Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_vertex_size Type int in [0, 255], default 0 header Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) lastsel_point Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) list Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) list_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) list_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) list_title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) panel Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) vertex Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) vertex_select

2.4. Types ([Link])

1031

Blender Index, Release 2.59.2 - API

Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) vertex_size Type int in [1, 10], default 0 window_sliders Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Theme.graph_editor

2.4.590 ThemeImageEditor(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Theme settings for the Image Editor back Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)

1032

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

button_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) editmesh_active Type oat array of 4 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0) face Type oat array of 4 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0) face_dot Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) face_select Type oat array of 4 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0) facedot_size Type int in [1, 10], default 0 header Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) scope_back Type oat array of 4 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0) text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) vertex Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) vertex_select Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) vertex_size Type int in [1, 10], default 0

2.4. Types ([Link])

1033

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Theme.image_editor

2.4.591 ThemeInfo(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Theme settings for Info back Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)

1034

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

header_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.592 ThemeLogicEditor(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Theme settings for the Logic Editor back

2.4. Types ([Link])

1035

Blender Index, Release 2.59.2 - API

Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) panel Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data
Inherited Functions

1036

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

Theme.logic_editor

2.4.593 ThemeNLAEditor(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Theme settings for the NLA Editor back Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) bars Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) bars_selected Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) frame_current Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) grid Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)

2.4. Types ([Link])

1037

Blender Index, Release 2.59.2 - API

list Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) list_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) list_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) list_title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) strips Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) strips_selected Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) view_sliders Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data
Inherited Functions

1038

Blender Index, Release 2.59.2 - API

References

Theme.nla_editor

2.4.594 ThemeNodeEditor(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Theme settings for the Node Editor back Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) converter_node Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) group_node Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) in_out_node Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) list Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) list_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) list_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) list_title 2.4. Types ([Link]) 1039

Blender Index, Release 2.59.2 - API

Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) node_backdrop Type oat array of 4 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0) noodle_curving Curving of the noodle Type int in [0, 10], default 5 operator_node Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) selected_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) wire Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) wire_select Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data
Inherited Functions

1040

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

References

Theme.node_editor

2.4.595 ThemeOutliner(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Theme settings for the Outliner back Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data

2.4. Types ([Link])

1041

Blender Index, Release 2.59.2 - API

Inherited Functions

References

[Link]

2.4.596 ThemeProperties(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Theme settings for the Properties back Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text_hi

1042

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) panel Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.597 ThemeSequenceEditor(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Theme settings for the Sequence Editor audio_strip Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)

2.4. Types ([Link])

1043

Blender Index, Release 2.59.2 - API

back Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) draw_action Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) effect_strip Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) frame_current Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) grid Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) image_strip Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) keyframe Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) meta_strip Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) movie_strip Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) plugin_strip Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) scene_strip Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)

1044

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) transition_strip Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) window_sliders Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Theme.sequence_editor

2.4.598 ThemeStyle(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Theme settings for style sets panel_title

2.4. Types ([Link])

1045

Blender Index, Release 2.59.2 - API

Type ThemeFontStyle, (readonly, never None) widget Type ThemeFontStyle, (readonly, never None) widget_label Type ThemeFontStyle, (readonly, never None)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

UserPreferences.ui_styles

2.4.599 ThemeTextEditor(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Theme settings for the Text Editor back Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)

1046

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

button_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) cursor Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) line_numbers_background Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) scroll_bar Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) selected_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) syntax_builtin Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) syntax_comment Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) syntax_numbers Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) syntax_special Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) syntax_string Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)

2.4. Types ([Link])

1047

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Theme.text_editor

2.4.600 ThemeTimeline(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Theme settings for the Timeline back Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) frame_current Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)

1048

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

grid Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4. Types ([Link])

1049

Blender Index, Release 2.59.2 - API

2.4.601 ThemeUserInterface(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Theme settings for user interface elements icon_file Type string, default wcol_box Type ThemeWidgetColors, (readonly, never None) wcol_list_item Type ThemeWidgetColors, (readonly, never None) wcol_menu Type ThemeWidgetColors, (readonly, never None) wcol_menu_back Type ThemeWidgetColors, (readonly, never None) wcol_menu_item Type ThemeWidgetColors, (readonly, never None) wcol_num Type ThemeWidgetColors, (readonly, never None) wcol_numslider Type ThemeWidgetColors, (readonly, never None) wcol_option Type ThemeWidgetColors, (readonly, never None) wcol_progress Type ThemeWidgetColors, (readonly, never None) wcol_pulldown Type ThemeWidgetColors, (readonly, never None) wcol_radio Type ThemeWidgetColors, (readonly, never None) wcol_regular Type ThemeWidgetColors, (readonly, never None) wcol_scroll Type ThemeWidgetColors, (readonly, never None) wcol_state Type ThemeWidgetStateColors, (readonly, never None) wcol_text Type ThemeWidgetColors, (readonly, never None)

1050

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

wcol_toggle Type ThemeWidgetColors, (readonly, never None) wcol_tool Type ThemeWidgetColors, (readonly, never None)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Theme.user_interface

2.4.602 ThemeUserPreferences(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Theme settings for the User Preferences back Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text_hi

2.4. Types ([Link])

1051

Blender Index, Release 2.59.2 - API

Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Theme.user_preferences

1052

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.603 ThemeView3D(bpy_struct)
base class bpy_struct class [Link].ThemeView3D(bpy_struct) Theme settings for the 3D View act_spline Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) back Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) bone_pose Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) bone_solid Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) button_title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) edge_crease Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) edge_facesel Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) edge_seam Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) edge_select Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) edge_sharp Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) editmesh_active Type oat array of 4 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0) extra_edge_len Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) extra_face_angle Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)

2.4. Types ([Link])

1053

Blender Index, Release 2.59.2 - API

extra_face_area Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) face Type oat array of 4 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0) face_dot Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) face_select Type oat array of 4 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0) facedot_size Type int in [1, 10], default 0 frame_current Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) grid Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_align Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_auto Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_free Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_sel_align Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_sel_auto Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_sel_free Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_sel_vect Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) handle_vect Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) header_text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)

1054

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

lamp Type oat array of 4 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0) lastsel_point Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) normal Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) nurb_sel_uline Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) nurb_sel_vline Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) nurb_uline Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) nurb_vline Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) object_active Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) object_grouped Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) object_grouped_active Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) object_selected Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) outline_width Type int in [1, 5], default 0 panel Type oat array of 4 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0) speaker Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text_hi Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) title Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) transform Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)

2.4. Types ([Link])

1055

Blender Index, Release 2.59.2 - API

vertex Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) vertex_normal Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) vertex_select Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) vertex_size Type int in [1, 10], default 0 wire Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Theme.view_3d

2.4.604 ThemeWidgetColors(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Theme settings for widget color sets inner

1056

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type oat array of 4 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0) inner_sel Type oat array of 4 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0) item Type oat array of 4 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0) outline Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) shadedown Type int in [-100, 100], default 0 shadetop Type int in [-100, 100], default 0 show_shaded Type boolean, default False text Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) text_sel Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

1057

Blender Index, Release 2.59.2 - API

References

ThemeUserInterface.wcol_box ThemeUserInterface.wcol_list_item ThemeUserInterface.wcol_menu ThemeUserInterface.wcol_menu_back ThemeUserInterface.wcol_menu_item ThemeUserInterface.wcol_num ThemeUserInterface.wcol_numslider ThemeUserInterface.wcol_option ThemeUserInterface.wcol_progress ThemeUserInterface.wcol_pulldown ThemeUserInterface.wcol_radio ThemeUserInterface.wcol_regular ThemeUserInterface.wcol_scroll ThemeUserInterface.wcol_text ThemeUserInterface.wcol_toggle ThemeUserInterface.wcol_tool

2.4.605 ThemeWidgetStateColors(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Theme settings for widget state colors blend Type oat in [0, 1], default 0.0 inner_anim Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) inner_anim_sel Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) inner_driven Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) inner_driven_sel Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) inner_key Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) inner_key_sel Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data

1058

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Functions

References

ThemeUserInterface.wcol_state

2.4.606 TimelineMarker(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Marker for noting points in the timeline camera Camera this timeline sets to active Type Object frame The frame on which the timeline marker appears Type int in [-inf, inf], default 0 name Type string, default select Marker selection state Type boolean, default False
Inherited Properties

bpy_struct.id_data

2.4. Types ([Link])

1059

Blender Index, Release 2.59.2 - API

Inherited Functions

Blender Index, Release 2.59.2 - API

etch_length_limit Number of bones in the subdivided stroke Type oat in [1e-05, 100000], default 0.0 etch_number DOC BROKEN Type string, default etch_roll_mode Method used to adjust the roll of bones when retargeting NONE None, Dont adjust roll. VIEW View, Roll bones to face the view. JOINT Joint, Roll bone to original joint plane offset. Type enum in [NONE, VIEW, JOINT], default NONE etch_side DOC BROKEN Type string, default etch_subdivision_number Number of bones in the subdivided stroke Type int in [1, 255], default 0 etch_template Template armature that will be retargeted to the stroke Type Object image_paint Type ImagePaint, (readonly) mesh_select_mode Which mesh elements selection works on Type boolean array of 3 items, default (False, False, False) normal_size Display size for normals in the 3D view Type oat in [1e-05, 1000], default 0.0 particle_edit Type ParticleEdit, (readonly) proportional_edit Proportional Editing mode, allows transforms with distance fall-off DISABLED Disable, Proportional Editing disabled. ENABLED Enable, Proportional Editing enabled. CONNECTED Connected, Proportional Editing using connected geometry only. Type enum in [DISABLED, ENABLED, CONNECTED], default DISABLED

2.4. Types ([Link])

1063

Blender Index, Release 2.59.2 - API

proportional_edit_falloff Falloff type for proportional editing mode SMOOTH Smooth, Smooth falloff. SPHERE Sphere, Spherical falloff. ROOT Root, Root falloff. SHARP Sharp, Sharp falloff. LINEAR Linear, Linear falloff. CONSTANT Constant, Consant falloff. RANDOM Random, Random falloff. Type enum in [SMOOTH, SPHERE, ROOT, SHARP, LINEAR, CONSTANT, RANDOM], default SMOOTH proportional_size Display size for proportional editing circle Type oat in [1e-05, 5000], default 0.0 sculpt Type Sculpt, (readonly) sculpt_paint_use_unified_size Instead of per brush radius, the radius is shared across brushes Type boolean, default False sculpt_paint_use_unified_strength Instead of per brush strength, the strength is shared across brushes Type boolean, default False show_uv_local_view Draw only faces with the currently displayed image assigned Type boolean, default False snap_element Type of element to snap to INCREMENT Increment, Snap to increments of grid. VERTEX Vertex, Snap to vertices. EDGE Edge, Snap to edges. FACE Face, Snap to faces. VOLUME Volume, Snap to volume. Type enum in [INCREMENT, VERTEX, EDGE, FACE, VOLUME], default INCREMENT snap_target Which part to snap onto the target CLOSEST Closest, Snap closest point onto target. CENTER Center, Snap center onto target.

1064

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

MEDIAN Median, Snap median onto target. ACTIVE Active, Snap active onto target. Type enum in [CLOSEST, CENTER, MEDIAN, ACTIVE], default CLOSEST use_auto_normalize Ensure all bone-deforming vertex groups add up to 1.0 while weight painting Type boolean, default False use_bone_sketching DOC BROKEN Type boolean, default False use_etch_autoname DOC BROKEN Type boolean, default False use_etch_overdraw DOC BROKEN Type boolean, default False use_etch_quick DOC BROKEN Type boolean, default False use_grease_pencil_sessions Allow drawing multiple strokes at a time with Grease Pencil Type boolean, default False use_keyframe_insert_auto Automatic keyframe insertion for Objects and Bones Type boolean, default False use_keyframe_insert_keyingset Automatic keyframe insertion using active Keying Set only Type boolean, default False use_mesh_automerge Automatically merge vertices moved to the same location Type boolean, default False use_proportional_edit_objects Proportional editing object mode Type boolean, default False use_record_with_nla Add a new NLA Track + Strip for every loop/pass made over the animation to allow non-destructive tweaking Type boolean, default False use_snap Snap during transform Type boolean, default False

2.4. Types ([Link])

1065

Blender Index, Release 2.59.2 - API

use_snap_align_rotation Align rotation with the snapping target Type boolean, default False use_snap_peel_object Consider objects as whole when nding volume center Type boolean, default False use_snap_project Project individual elements on the surface of other objects Type boolean, default False use_snap_self Snap onto its self (editmode) Type boolean, default False use_uv_select_sync Keep UV and edit mode mesh selection in sync Type boolean, default False uv_select_mode UV selection and display mode VERTEX Vertex, Vertex selection mode. EDGE Edge, Edge selection mode. FACE Face, Face selection mode. ISLAND Island, Island selection mode. Type enum in [VERTEX, EDGE, FACE, ISLAND], default VERTEX vertex_group_weight Weight to assign in vertex groups Type oat in [0, 1], default 0.0 vertex_paint Type VertexPaint, (readonly) weight_paint Type VertexPaint, (readonly)
Inherited Properties

bpy_struct.id_data
Inherited Functions

1066

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

References

Context.tool_settings Scene.tool_settings

2.4.610 TouchSensor(Sensor)
base classes bpy_struct, Sensor class [Link](Sensor) Sensor to detect objects colliding with the current object material Only look for objects with this material (blank = all objects) Type Material
Inherited Properties

bpy_struct.id_data [Link] Sensor.show_expanded [Link] [Link] Sensor.use_level [Link] Sensor.use_pulse_false_level Sensor.use_pulse_true_level Sensor.use_tap [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden 1067

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

2.4.611 TrackToConstraint(Constraint)
base classes bpy_struct, Constraint class [Link](Constraint) Aims the constrained object toward the target head_tail Target along length of bone: Head=0, Tail=1 Type oat in [0, 1], default 0.0 subtarget Type string, default target Target Object Type Object track_axis Axis that points to the target object Type enum in [TRACK_X, TRACK_Y, TRACK_Z, TRACK_NEGATIVE_X, TRACK_NEGATIVE_Y, TRACK_NEGATIVE_Z], default TRACK_X up_axis Axis that points upward Type enum in [UP_X, UP_Y, UP_Z], default UP_X use_target_z Targets Z axis, not World Z axis, will constraint the Up direction Type boolean, default False
Inherited Properties

1068

bpy_struct.id_data [Link] [Link] [Link] Constraint.show_expanded [Link] Constraint.error_location Constraint.owner_space Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Constraint.is_proxy_local Constraint.error_rotation Constraint.target_space [Link] Constraint.is_valid

Inherited Functions

2.4.612 TransformConstraint(Constraint)
base classes bpy_struct, Constraint class [Link](Constraint) Maps transformations of the target to the object from_max_x Top range of X axis source motion Type oat in [-inf, inf], default 0.0 from_max_y Top range of Y axis source motion Type oat in [-inf, inf], default 0.0 from_max_z Top range of Z axis source motion Type oat in [-inf, inf], default 0.0 from_min_x Bottom range of X axis source motion Type oat in [-inf, inf], default 0.0 from_min_y Bottom range of Y axis source motion Type oat in [-inf, inf], default 0.0

2.4. Types ([Link])

1069

Blender Index, Release 2.59.2 - API

from_min_z Bottom range of Z axis source motion Type oat in [-inf, inf], default 0.0 map_from The transformation type to use from the target Type enum in [LOCATION, ROTATION, SCALE], default LOCATION map_to The transformation type to affect of the constrained object Type enum in [LOCATION, ROTATION, SCALE], default LOCATION map_to_x_from The source axis constrained objects X axis uses Type enum in [X, Y, Z], default X map_to_y_from The source axis constrained objects Y axis uses Type enum in [X, Y, Z], default X map_to_z_from The source axis constrained objects Z axis uses Type enum in [X, Y, Z], default X subtarget Type string, default target Target Object Type Object to_max_x Top range of X axis destination motion Type oat in [-inf, inf], default 0.0 to_max_y Top range of Y axis destination motion Type oat in [-inf, inf], default 0.0 to_max_z Top range of Z axis destination motion Type oat in [-inf, inf], default 0.0 to_min_x Bottom range of X axis destination motion Type oat in [-inf, inf], default 0.0 to_min_y Bottom range of Y axis destination motion Type oat in [-inf, inf], default 0.0 to_min_z Bottom range of Z axis destination motion

1070

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type oat in [-inf, inf], default 0.0 use_motion_extrapolate Extrapolate ranges Type boolean, default False
Inherited Properties

Inherited Functions

2.4.613 TransformOrientation(bpy_struct)
base class bpy_struct class [Link](bpy_struct) matrix Type oat array of 9 items in [-inf, inf], default (0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0) name

2.4. Types ([Link])

1071

Blender Index, Release 2.59.2 - API

Type string, default

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] SpaceView3D.current_orientation

2.4.614 TransformSequence(EffectSequence)
base classes bpy_struct, Sequence, EffectSequence class [Link](EffectSequence) Sequence strip applying afne transformations to other strips interpolation NONE None, No interpolation. BILINEAR Bilinear, Bilinear interpolation. BICUBIC Bicubic, Bicubic interpolation. Type enum in [NONE, BILINEAR, BICUBIC], default NONE rotation_start Type oat in [-360, 360], default 0.0 scale_start_x Type oat in [0, inf], default 0.0

1072

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

scale_start_y Type oat in [0, inf], default 0.0 translate_start_x Type oat in [-inf, inf], default 0.0 translate_start_y Type oat in [-inf, inf], default 0.0 translation_unit Type enum in [PIXELS, PERCENT], default PIXELS use_uniform_scale Scale uniformly, preserving aspect ratio Type boolean, default False
Inherited Properties

template_reports_banner() template_reports_banner introspect() introspect Returns Descr, DESCR Return type string
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] [Link] [Link] [Link] [Link] [Link] UILayout.column_flow [Link] [Link] UILayout.template_constraint UILayout.template_modifier

2.4.616 UVProjectModier(Modier)
base classes bpy_struct, Modifier

2.4. Types ([Link])

1097

Blender Index, Release 2.59.2 - API

class [Link](Modier) UV projection modier to sets UVs from a projector aspect_x Type oat in [1, inf], default 0.0 aspect_y Type oat in [1, inf], default 0.0 image Type Image projector_count Number of projectors to use Type int in [1, 10], default 0 projectors Type bpy_prop_collection of UVProjector, (readonly) scale_x Type oat in [0, inf], default 0.0 scale_y Type oat in [0, inf], default 0.0 use_image_override Override faces current images with the given image Type boolean, default False uv_layer UV layer name Type string, default
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove

1098

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.617 UVProjector(bpy_struct)
base class bpy_struct class [Link](bpy_struct) UV projector used by the UV project modier object Object to use as projector transform Type Object
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4. Types ([Link])

1099

Blender Index, Release 2.59.2 - API

2.4.618 UVTextures(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of uv textures active Active UV texture Type MeshTextureFaceLayer active_index Active UV texture index Type int in [0, inf], default 0 new(name=UVTex) Add a UV texture layer to Mesh. Parameters name (string, (optional)) UV Texture name. Returns The newly created layer. Return type MeshTextureFaceLayer
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

Mesh.uv_textures

1100

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.619 UnitSettings(bpy_struct)
base class bpy_struct class [Link](bpy_struct) scale_length Scale to use when converting between blender units and dimensions Type oat in [1e-05, 100000], default 0.0 system The unit system to use for button display Type enum in [NONE, METRIC, IMPERIAL], default NONE system_rotation Unit to use for displaying/editing rotation values DEGREES Degrees, Use degrees for measuring rotation. RADIANS Radians. Type enum in [DEGREES, RADIANS], default DEGREES use_separate Display units in pairs Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

1101

Blender Index, Release 2.59.2 - API

References

Scene.unit_settings

2.4.620 UnknownType(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Stub RNA type used for pointers to unknown or internal data
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] SpaceSequenceEditor.grease_pencil

2.4.621 UserPreferences(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Global user preferences active_section Active section of the user preferences shown in the user interface Type enum in [INTERFACE, EDITING, INPUT, ADDONS, THEMES, FILES, SYSTEM], default INTERFACE

1102

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

addons Type Addons bpy_prop_collection of Addon, (readonly) edit Settings for interacting with Blender data Type UserPreferencesEdit, (readonly, never None) filepaths Default paths for external les Type UserPreferencesFilePaths, (readonly, never None) inputs Settings for input devices Type UserPreferencesInput, (readonly, never None) system Graphics driver and operating system settings Type UserPreferencesSystem, (readonly, never None) themes Type bpy_prop_collection of Theme, (readonly) ui_styles Type bpy_prop_collection of ThemeStyle, (readonly) view Preferences related to viewing data Type UserPreferencesView, (readonly, never None)
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4. Types ([Link])

1103

Blender Index, Release 2.59.2 - API

References

Context.user_preferences

2.4.622 UserPreferencesEdit(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Settings for interacting with Blender data auto_keying_mode Mode of automatic keyframe insertion for Objects and Bones (default setting used for new Scenes) Type enum in [ADD_REPLACE_KEYS, ADD_REPLACE_KEYS grease_pencil_eraser_radius Radius of eraser brush Type int in [0, 100], default 0 grease_pencil_euclidean_distance Distance moved by mouse when drawing stroke (in pixels) to include Type int in [0, 100], default 0 grease_pencil_manhattan_distance Pixels moved by mouse per axis when drawing stroke Type int in [0, 100], default 0 keyframe_new_handle_type Handle type for handles of new keyframes FREE Free. VECTOR Vector. ALIGNED Aligned. AUTO Automatic. AUTO_CLAMPED Auto Clamped, Auto handles clamped to not overshoot. Type enum in [FREE, VECTOR, ALIGNED, AUTO, AUTO_CLAMPED], default FREE keyframe_new_interpolation_type Interpolation mode used for rst keyframe on newly added F-Curves. Subsequent keyframes take interpolation from preceeding keyframe Type enum in [CONSTANT, LINEAR, BEZIER], default CONSTANT material_link Toggle whether the material is linked to object data or the object block OBDATA ObData, Toggle whether the material is linked to object data or the object block. OBJECT Object, Toggle whether the material is linked to object data or the object block. Type enum in [OBDATA, OBJECT], default OBDATA REPLACE_KEYS], default

1104

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

object_align When adding objects from a 3D View menu, either align them to that views direction or the world coordinates WORLD World, Align newly added objects to the world coordinates. VIEW View, Align newly added objects facing the active 3D View direction. Type enum in [WORLD, VIEW], default WORLD sculpt_paint_overlay_color Color of texture overlay Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) undo_memory_limit Maximum memory usage in megabytes (0 means unlimited) Type int in [0, 32767], default 0 undo_steps Number of undo steps available (smaller values conserve memory) Type int in [0, 64], default 0 use_auto_keying Automatic keyframe insertion for Objects and Bones (default setting used for new Scenes) Type boolean, default False use_drag_immediately Moving things with a mouse drag conrms when releasing the button Type boolean, default False use_duplicate_action Causes actions to be duplicated with the object Type boolean, default False use_duplicate_armature Causes armature data to be duplicated with the object Type boolean, default False use_duplicate_curve Causes curve data to be duplicated with the object Type boolean, default False use_duplicate_fcurve Causes F-curve data to be duplicated with the object Type boolean, default False use_duplicate_lamp Causes lamp data to be duplicated with the object Type boolean, default False use_duplicate_material Causes material data to be duplicated with the object Type boolean, default False

2.4. Types ([Link])

1105

Blender Index, Release 2.59.2 - API

use_duplicate_mesh Causes mesh data to be duplicated with the object Type boolean, default False use_duplicate_metaball Causes metaball data to be duplicated with the object Type boolean, default False use_duplicate_particle Causes particle systems to be duplicated with the object Type boolean, default False use_duplicate_surface Causes surface data to be duplicated with the object Type boolean, default False use_duplicate_text Causes text data to be duplicated with the object Type boolean, default False use_duplicate_texture Causes texture data to be duplicated with the object Type boolean, default False use_enter_edit_mode Enter Edit Mode automatically after adding a new object Type boolean, default False use_global_undo Global undo works by keeping a full copy of the le itself in memory, so takes extra memory Type boolean, default False use_grease_pencil_simplify_stroke Simplify the nal stroke Type boolean, default False use_grease_pencil_smooth_stroke Smooth the nal stroke Type boolean, default False use_insertkey_xyz_to_rgb Color for newly added transformation F-Curves (Location, Rotation, Scale) and also Color is based on the transform axis Type boolean, default False use_keyframe_insert_available Automatic keyframe insertion in available curves Type boolean, default False use_keyframe_insert_needed Keyframe insertion only when keyframe needed Type boolean, default False

1106

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

use_negative_frames Current frame number can be manually set to a negative value Type boolean, default False use_visual_keying Use Visual keying automatically for constrained objects Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.623 UserPreferencesFilePaths(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Default paths for external les animation_player Path to a custom animation/frame sequence player Type string, default animation_player_preset Preset congs for external animation players BLENDER24 Blender 2.4, Blender command line animation playback - path to Blender 2.4. DJV Djv, Open source frame player: [Link] 2.4. Types ([Link]) 1107

Blender Index, Release 2.59.2 - API

FRAMECYCLER FrameCycler, Frame player from IRIDAS. RV rv, Frame player from Tweak Software. MPLAYER MPlayer, Media player for video & png/jpeg/sgi image sequences. CUSTOM Custom, Custom animation player executable path. Type enum in [BLENDER24, DJV, FRAMECYCLER, RV, MPLAYER, CUSTOM], default BLENDER24 auto_save_time The time (in minutes) to wait between automatic temporary saves Type int in [1, 60], default 0 font_directory The default directory to search for loading fonts Type string, default hide_recent_locations Hide recent locations in the le selector Type boolean, default False image_editor Path to an image editor Type string, default recent_files Maximum number of recently opened les to remember Type int in [0, 30], default 0 render_output_directory The default directory for rendering output, for new scenes Type string, default save_version The number of old versions to maintain in the current directory, when manually saving Type int in [0, 32], default 0 script_directory Alternate script path, matching the default layout with subdirs: startup, addons & modules (requires restart) Type string, default sequence_plugin_directory The default directory to search for sequence plugins Type string, default show_hidden_files_datablocks Hide les/datablocks that start with a dot(.*) Type boolean, default False show_thumbnails Open in thumbnail view for images and movies Type boolean, default False

1108

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

sound_directory The default directory to search for sounds Type string, default temporary_directory The directory for storing temporary save les Type string, default texture_directory The default directory to search for textures Type string, default texture_plugin_directory The default directory to search for texture plugins Type string, default use_auto_save_temporary_files Automatic saving of temporary les in temp directory, uses process ID Type boolean, default False use_file_compression Enable le compression when saving .blend les Type boolean, default False use_filter_files Display only les with extensions in the image select window Type boolean, default False use_load_ui Load user interface setup when loading .blend les Type boolean, default False use_relative_paths Default relative path option for the le selector Type boolean, default False use_save_preview_images Enables automatic saving of preview images in the .blend le Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get 1109

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

References

[Link]

2.4.624 UserPreferencesInput(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Settings for input devices active_keyconfig The name of the active key conguration Type string, default drag_threshold Amount of pixels you have to drag before dragging UI items happens Type int in [3, 40], default 0 invert_mouse_zoom Invert the axis of mouse movement for zooming Type boolean, default False invert_zoom_wheel Swap the Mouse Wheel zoom direction Type boolean, default False mouse_double_click_time The time (in ms) for a double click Type int in [1, 1000], default 0 ndof_fly_helicopter Device up/down directly controls your Z position Type boolean, default False ndof_lock_horizon Keep horizon level while ying with 3D Mouse Type boolean, default False ndof_orbit_invert_axes Toggle between moving the viewpoint or moving the scene being viewed Type boolean, default False 1110 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

ndof_panx_invert_axis Invert x axis Type boolean, default False ndof_pany_invert_axis Invert y axis Type boolean, default False ndof_panz_invert_axis Invert z axis Type boolean, default False ndof_roll_invert_axis Invert roll axis Type boolean, default False ndof_rotate_invert_axis Invert rotation axis Type boolean, default False ndof_sensitivity Overall sensitivity of the 3D Mouse Type oat in [0.25, 4], default 0.0 ndof_show_guide Display the center and axis during rotation Type boolean, default False ndof_tilt_invert_axis Invert tilt axis Type boolean, default False ndof_zoom_invert Zoom using opposite direction Type boolean, default False ndof_zoom_updown Zoom using up/down on the device (otherwise forward/backward) Type boolean, default False select_mouse The mouse button used for selection LEFT Left, Use left Mouse Button for selection. RIGHT Right, Use Right Mouse Button for selection. Type enum in [LEFT, RIGHT], default RIGHT use_emulate_numpad Causes the 1 to 0 keys to act as the numpad (useful for laptops) Type boolean, default False use_mouse_continuous Allow moving the mouse outside the view on some manipulations (transform, ui control drag)

2.4. Types ([Link])

1111

Blender Index, Release 2.59.2 - API

Type boolean, default False use_mouse_emulate_3_button Emulates Middle Mouse with Alt+Left Mouse (doesnt work with Left Mouse Select option) Type boolean, default False use_mouse_mmb_paste In text window, paste with middle mouse button instead of panning Type boolean, default False view_rotate_method Rotation style in the viewport TURNTABLE Turntable, Use turntable style rotation in the viewport. TRACKBALL Trackball, Use trackball style rotation in the viewport. Type enum in [TURNTABLE, TRACKBALL], default TURNTABLE view_zoom_axis Axis of mouse movement to zoom in or out on VERTICAL Vertical, Zooms in and out based on vertical mouse movement. HORIZONTAL Horizontal, Zooms in and out based on horizontal mouse movement. Type enum in [VERTICAL, HORIZONTAL], default VERTICAL view_zoom_method Which style to use for viewport scaling CONTINUE Continue, Old style zoom, continues while moving mouse up or down. DOLLY Dolly, Zooms in and out based on vertical mouse movement. SCALE Scale, Zooms in and out like scaling the view, mouse movements relative to center. Type enum in [CONTINUE, DOLLY, SCALE], default CONTINUE wheel_scroll_lines The number of lines scrolled at a time with the mouse wheel Type int in [0, 32], default 0
Inherited Properties

bpy_struct.id_data
Inherited Functions

1112

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

[Link]

2.4.625 UserPreferencesSystem(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Graphics driver and operating system settings anisotropic_filter The quality of the anisotropic ltering (values greater than 1.0 enable anisotropic ltering) Type enum in [FILTER_0, FILTER_2, FILTER_4, FILTER_8, FILTER_16], default FILTER_0 audio_channels Sets the audio channel count MONO Mono, Set audio channels to mono. STEREO Stereo, Set audio channels to stereo. SURROUND4 4 Channels, Set audio channels to 4 channels. SURROUND51 5.1 Surround, Set audio channels to 5.1 surround sound. SURROUND71 7.1 Surround, Set audio channels to 7.1 surround sound. Type enum in [MONO, STEREO, SURROUND4, SURROUND51, SURROUND71], default MONO audio_device Sets the audio output device NONE None, Null device - there will be no audio output. Type enum in [NONE], default NONE audio_mixing_buffer Sets the number of samples used by the audio mixing buffer SAMPLES_256 256, Set audio mixing buffer size to 256 samples. SAMPLES_512 512, Set audio mixing buffer size to 512 samples. SAMPLES_1024 1024, Set audio mixing buffer size to 1024 samples.

2.4. Types ([Link])

1113

Blender Index, Release 2.59.2 - API

SAMPLES_2048 2048, Set audio mixing buffer size to 2048 samples. SAMPLES_4096 4096, Set audio mixing buffer size to 4096 samples. SAMPLES_8192 8192, Set audio mixing buffer size to 8192 samples. SAMPLES_16384 16384, Set audio mixing buffer size to 16384 samples. SAMPLES_32768 32768, Set audio mixing buffer size to 32768 samples. Type enum in [SAMPLES_256, SAMPLES_512, SAMPLES_1024, SAMPLES_2048, SAMPLES_4096, SAMPLES_8192, SAMPLES_16384, SAMPLES_32768], default SAMPLES_256 audio_sample_format Sets the audio sample format U8 8-bit Unsigned, Set audio sample format to 8 bit unsigned integer. S16 16-bit Signed, Set audio sample format to 16 bit signed integer. S24 24-bit Signed, Set audio sample format to 24 bit signed integer. S32 32-bit Signed, Set audio sample format to 32 bit signed integer. FLOAT 32-bit Float, Set audio sample format to 32 bit oat. DOUBLE 64-bit Float, Set audio sample format to 64 bit oat. Type enum in [U8, S16, S24, S32, FLOAT, DOUBLE], default U8 audio_sample_rate Sets the audio sample rate RATE_44100 44.1 kHz, Set audio sampling rate to 44100 samples per second. RATE_48000 48 kHz, Set audio sampling rate to 48000 samples per second. RATE_96000 96 kHz, Set audio sampling rate to 96000 samples per second. RATE_192000 192 kHz, Set audio sampling rate to 192000 samples per second. Type enum in [RATE_44100, RATE_48000, RATE_96000, RATE_192000], default RATE_44100 author Name that will be used in exported les when format supports such feature Type string, default color_picker_type Different styles of displaying the color picker widget CIRCLE Circle, A circular Hue/Saturation color wheel, with Value slider. SQUARE_SV Square (SV + H), A square showing Saturation/Value, with Hue slider. SQUARE_HS Square (HS + V), A square showing Hue/Saturation, with Value slider. SQUARE_HV Square (HV + S), A square showing Hue/Value, with Saturation slider. Type enum in [CIRCLE, SQUARE_SV, SQUARE_HS, SQUARE_HV], default CIRCLE

1114

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

dpi Font size and resolution for display Type int in [48, 128], default 0 frame_server_port Frameserver Port for Frameserver Rendering Type int in [0, 32727], default 0 gl_clip_alpha Clip alpha below this threshold in the 3D textured view Type oat in [0, 1], default 0.0 gl_texture_limit Limit the texture size to save graphics memory Type enum in [CLAMP_OFF, CLAMP_8192, CLAMP_4096, CLAMP_2048, CLAMP_1024, CLAMP_512, CLAMP_256, CLAMP_128], default CLAMP_OFF language Language use for translation Type enum in [ENGLISH, JAPANESE, DUTCH, ITALIAN, GERMAN, FINNISH, SWEDISH, FRENCH, SPANISH, CATALAN, CZECH, BRAZILIAN_PORTUGUESE, SIMPLIFIED_CHINESE, RUSSIAN, CROATIAN, SERBIAN, UKRAINIAN, POLISH, ROMANIAN, ARABIC, BULGARIAN, GREEK, KOREAN], default ENGLISH memory_cache_limit Memory cache limit in sequencer (megabytes) Type int in [0, 16384], default 0 prefetch_frames Number of frames to render ahead during playback Type int in [0, 500], default 0 screencast_fps Frame rate for the screencast to be played back Type int in [10, 50], default 0 screencast_wait_time Time in milliseconds between each frame recorded for screencast Type int in [50, 1000], default 0 scrollback Maximum number of lines to store for the console buffer Type int in [32, 32768], default 0 solid_lights Lights user to display objects in solid draw mode Type bpy_prop_collection of UserSolidLight, (readonly) texture_collection_rate Number of seconds between each run of the GL texture garbage collector Type int in [1, 3600], default 0

2.4. Types ([Link])

1115

Blender Index, Release 2.59.2 - API

texture_time_out Time since last access of a GL texture in seconds after which it is freed. (Set to 0 to keep textures allocated.) Type int in [0, 3600], default 0 use_antialiasing Use anti-aliasing for the 3D view (may impact redraw performance) Type boolean, default False use_international_fonts Use international fonts Type boolean, default False use_mipmaps Scale textures for the 3D View (looks nicer but uses more memory and slows image reloading) Type boolean, default False use_preview_images Enables automatic saving of preview images in the .blend le (Windows only) Type boolean, default False use_scripts_auto_execute Allow any .blend le to run scripts automatically (unsafe with blend les from an untrusted source) Type boolean, default False use_tabs_as_spaces Automatically converts all new tabs into spaces for new and loaded text les Type boolean, default False use_text_antialiasing Draw user interface text anti-aliased Type boolean, default False use_textured_fonts Use textures for drawing international fonts Type boolean, default False use_translate_buttons Translate button labels Type boolean, default False use_translate_toolbox Translate toolbox menu Type boolean, default False use_translate_tooltips Translate Tooltips Type boolean, default False use_vertex_buffer_objects Use Vertex Buffer Objects (or Vertex Arrays, if unsupported) for viewport rendering Type boolean, default False use_weight_color_range Enable color range used for weight visualization in weight painting mode

1116

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type boolean, default False weight_color_range Color range used for weight visualization in weight painting mode Type ColorRamp, (readonly, never None) window_draw_method Drawing method used by the window manager AUTOMATIC Automatic, Automatically set based on graphics card and driver. TRIPLE_BUFFER Triple Buffer, Use a third buffer for minimal redraws at the cost of more memory. OVERLAP Overlap, Redraw all overlapping regions, minimal memory usage but more redraws. OVERLAP_FLIP Overlap Flip, Redraw all overlapping regions, minimal memory usage but more redraws (for graphics drivers that do ipping). FULL Full, Do a full redraw each time, slow, only use for reference or when all else fails. Type enum in [AUTOMATIC, TRIPLE_BUFFER, OVERLAP, OVERLAP_FLIP, FULL], default TRIPLE_BUFFER
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link]

2.4.626 UserPreferencesView(bpy_struct)
base class bpy_struct

2.4. Types ([Link])

1117

Blender Index, Release 2.59.2 - API

class [Link](bpy_struct) Preferences related to viewing data manipulator_handle_size Size of widget handles as percentage of widget radius Type int in [2, 40], default 25 manipulator_hotspot Pixel distance around the handles to accept mouse clicks Type int in [4, 40], default 14 manipulator_size Diameter of widget, in 10 pixel units Type int in [2, 40], default 15 mini_axis_brightness The brightness of the icon Type int in [0, 10], default 0 mini_axis_size The axis icons size Type int in [10, 64], default 0 object_origin_size Diameter in Pixels for Object/Lamp origin display Type int in [4, 10], default 0 open_left_mouse_delay Time in 1/10 seconds to hold the Left Mouse Button before opening the toolbox Type int in [1, 40], default 0 open_right_mouse_delay Time in 1/10 seconds to hold the Right Mouse Button before opening the toolbox Type int in [1, 40], default 0 open_sublevel_delay Time delay in 1/10 seconds before automatically opening sub level menus Type int in [1, 40], default 0 open_toplevel_delay Time delay in 1/10 seconds before automatically opening top level menus Type int in [1, 40], default 0 rotation_angle The rotation step for numerical pad keys (2 4 6 8) Type int in [0, 90], default 0 show_column_layout Use a column layout for toolbox Type boolean, default False show_large_cursors Use large mouse cursors when available Type boolean, default False

1118

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

show_manipulator Use 3D transform manipulator Type boolean, default False show_mini_axis Show a small rotating 3D axis in the bottom left corner of the 3D View Type boolean, default False show_object_info Display objects name and frame number in 3D view Type boolean, default False show_playback_fps Show the frames per second screen refresh rate, while animation is played back Type boolean, default False show_splash Display splash screen on startup Type boolean, default False show_tooltips Display tooltips Type boolean, default False show_tooltips_python Show Python references in tooltips Type boolean, default False show_view_name Show the name of the views direction in each 3D View Type boolean, default False smooth_view The time to animate the view in milliseconds, zero to disable Type int in [0, 1000], default 0 timecode_style Format of Time Codes displayed when not displaying timing in terms of frames MINIMAL Minimal Info, Most compact representation. Uses + as separator for sub-second frame numbers, with left and right truncation of the timecode as necessary. SMPTE SMPTE (Full), Full SMPTE timecode. Format is HH:MM:SS:FF. SMPTE_COMPACT SMPTE (Compact), SMPTE timecode showing minutes, seconds, and frames only. Hours are also shown if necessary, but not by default. MILLISECONDS Compact with Milliseconds, Similar to SMPTE (Compact), except that instead of frames, milliseconds are shown instead. SECONDS_ONLY Only Seconds, Direct conversion of frame numbers to seconds. Type enum in [MINIMAL, SMPTE, SMPTE_COMPACT, MILLISECONDS, SECONDS_ONLY], default MINIMAL

2.4. Types ([Link])

1119

Blender Index, Release 2.59.2 - API

use_auto_perspective Automatically switch between orthographic and perspective when changing from top/front/side views Type boolean, default False use_camera_lock_parent When the camera is locked to the view and in y mode, transform the parent rather than the camera Type boolean, default False use_directional_menus Otherwise menus, etc will always be top to bottom, left to right, no matter opening direction Type boolean, default False use_global_pivot Lock the same rotation/scaling pivot in all 3D Views Type boolean, default False use_global_scene Forces the current Scene to be displayed in all Screens Type boolean, default False use_mouse_auto_depth Use the depth under the mouse to improve view pan/rotate/zoom functionality Type boolean, default False use_mouse_over_open Open menu buttons and pulldowns automatically when the mouse is hovering Type boolean, default False use_rotate_around_active Use selection as the pivot point Type boolean, default False use_zoom_to_mouse Zoom in towards the mouse pointers position in the 3D view, rather than the 2D window center Type boolean, default False view2d_grid_spacing_min Minimum number of pixels between each gridline in 2D Viewports Type int in [1, 500], default 0
Inherited Properties

bpy_struct.id_data
Inherited Functions

1120

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

References

[Link]

2.4.627 UserSolidLight(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Light used for OpenGL lighting in solid draw mode diffuse_color The diffuse color of the OpenGL light Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) direction The direction that the OpenGL light is shining Type oat array of 3 items in [-inf, inf], default (0.0, 1.0, 0.0) specular_color The color of the lights specular highlight Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) use Enable this OpenGL light in solid draw mode Type boolean, default False
Inherited Properties

bpy_struct.id_data
Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden 1121

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

References

UserPreferencesSystem.solid_lights

2.4.628 VectorFont(ID)
base classes bpy_struct, ID class [Link](ID) Vector font for Text objects filepath Type string, default , (readonly) packed_file Type PackedFile, (readonly)
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

Inherited Functions

1122

Blender Index, Release 2.59.2 - API

bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values [Link] ID.user_clear ID.animation_data_create ID.animation_data_clear ID.update_tag

References

[Link] [Link] [Link] [Link] TextCurve.font_bold TextCurve.font_bold_italic TextCurve.font_italic

2.4.629 VertexColors(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of vertex colors active Active vertex color layer Type MeshColorLayer active_index Active vertex color index Type int in [0, inf], default 0 new(name=Col) Add a vertex color layer to Mesh. Parameters name (string, (optional)) Vertex color name. Returns The newly created layer. Return type MeshColorLayer
Inherited Properties

bpy_struct.id_data
Inherited Functions

2.4.633 VertexPaint(Paint)
base classes bpy_struct, Paint class [Link](Paint) Properties of vertex and weight paint mode use_all_faces Paint on all faces inside brush Type boolean, default False use_normal Applies the vertex normal before painting Type boolean, default False use_spray Keep applying paint effect while holding mouse Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link]

2.4. Types ([Link])

1127

Blender Index, Release 2.59.2 - API

Paint.show_low_resolution Paint.show_brush Paint.show_brush_on_surface

Inherited Functions

References

ToolSettings.vertex_paint ToolSettings.weight_paint

2.4.634 VertexWeightEditModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Edit the weights of vertices in a group. add_threshold Lower bound for a vertexs weight to be added to the vgroup. Type oat in [0, 1], default 0.0 default_weight Default weight a vertex will have if it is not in the vgroup. Type oat in [0, 1], default 0.0 falloff_type How weights are mapped to there new values. Type enum in [LINEAR, CURVE, SHARP, SMOOTH, ICON_SPHERECURVE, RANDOM, STEP], default LINEAR map_curve Custom mapping curve. Type CurveMapping, (readonly) ROOT,

1128

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

mask_constant Global inuence of current modications on vgroup. Type oat in [-inf, inf], default 0.0 mask_tex_map_object Which object to take texture coordinates from. Type Object mask_tex_mapping Which texture coordinates to use for mapping. Type enum in [LOCAL, GLOBAL, OBJECT, UV], default LOCAL mask_tex_use_channel Which texture channel to use for masking. Type enum in [INT, RED, GREEN, BLUE, HUE, SAT, VAL, ALPHA], default INT mask_tex_uv_layer UV layer name Type string, default mask_texture Masking texture. Type Texture mask_vertex_group Masking vertex group name. Type string, default remove_threshold Upper bound for a vertexs weight to be removed from the vgroup. Type oat in [0, 1], default 0.0 use_add Add vertices with weight over threshold to vgroup. Type boolean, default False use_remove Remove vertices with weight below threshold from vgroup. Type boolean, default False vertex_group Vertex group name. Type string, default
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded

2.4. Types ([Link])

1129

Blender Index, Release 2.59.2 - API

Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

2.4.635 VertexWeightMixModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Mix the weights of two vertex groups. default_weight_a Default weight a vertex will have if it is not in the rst vgroup. Type oat in [0, 1], default 0.0 default_weight_b Default weight a vertex will have if it is not in the second vgroup. Type oat in [0, 1], default 0.0 mask_constant Global inuence of current modications on vgroup. Type oat in [-inf, inf], default 0.0 mask_tex_map_object Which object to take texture coordinates from. Type Object mask_tex_mapping Which texture coordinates to use for mapping. Type enum in [LOCAL, GLOBAL, OBJECT, UV], default LOCAL mask_tex_use_channel Which texture channel to use for masking.

1130

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type enum in [INT, RED, GREEN, BLUE, HUE, SAT, VAL, ALPHA], default INT mask_tex_uv_layer UV layer name Type string, default mask_texture Masking texture. Type Texture mask_vertex_group Masking vertex group name. Type string, default mix_mode How weights from vgroup 2 affect weights of vgroup 1. Type enum in [SET, ADD, SUB, MUL, DIV, DIF, AVG], default SET mix_set Which vertices should be affected. Type enum in [ALL, A, B, OR, AND], default ALL vertex_group_a First vertex group name. Type string, default vertex_group_b Second vertex group name. Type string, default
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden

2.4. Types ([Link])

1131

Blender Index, Release 2.59.2 - API

bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.636 VertexWeightProximityModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Set the weights of vertices in a group from a target objects distance. falloff_type How weights are mapped to there new values. Type enum in [LINEAR, SHARP, SMOOTH, ROOT, ICON_SPHERECURVE, RANDOM, STEP], default LINEAR mask_constant Global inuence of current modications on vgroup. Type oat in [-inf, inf], default 0.0 mask_tex_map_object Which object to take texture coordinates from. Type Object mask_tex_mapping Which texture coordinates to use for mapping. Type enum in [LOCAL, GLOBAL, OBJECT, UV], default LOCAL mask_tex_use_channel Which texture channel to use for masking. Type enum in [INT, RED, GREEN, BLUE, HUE, SAT, VAL, ALPHA], default INT mask_tex_uv_layer UV layer name Type string, default mask_texture Masking texture. Type Texture mask_vertex_group Masking vertex group name. Type string, default max_dist Distance mapping to weight 1.0 (or weight 0.0 if below Lowest Dist). Type oat in [0, inf], default 0.0 1132 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

min_dist Distance mapping to weight 0.0 (or weight 1.0 if above Highest Dist). Type oat in [0, inf], default 0.0 proximity_geometry Use the shortest computed distance to target objects geometry as weight. VERTEX Vertex, Compute distance to nearest vertex.. EDGE Edge, Compute distance to nearest edge.. FACE Face, Compute distance to nearest face.. Type enum set in {VERTEX, EDGE, FACE}, default {VERTEX} proximity_mode Which distances to target object to use. OBJECT Object Distance, Use distance between affected and target objects.. GEOMETRY Geometry Distance, Use distance between affected objects vertices and target object, or target objects geometry.. Type enum in [OBJECT, GEOMETRY], default OBJECT target Object to calculate vertices distances from. Type Object vertex_group Vertex group name. Type string, default
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add bpy_struct.callback_remove bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.is_property_hidden

2.4. Types ([Link])

1133

Blender Index, Release 2.59.2 - API

bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.637 VisibilityActuator(Actuator)
base classes bpy_struct, Actuator class [Link](Actuator) Actuator to set visibility and occlusion of the object apply_to_children Set all the children of this object to the same visibility/occlusion recursively Type boolean, default False use_occlusion Set the object to occlude objects behind it. Initialized from the object type in physics button Type boolean, default False use_visible Set the objects visible. Initialized from the object render restriction toggle in physics button Type boolean, default False
Inherited Properties

bpy_struct.id_data [Link] Actuator.show_expanded [Link] [Link]

Inherited Functions

1134

Blender Index, Release 2.59.2 - API

bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values [Link] [Link]

2.4.638 VoronoiTexture(Texture)
base classes bpy_struct, ID, Texture class [Link](Texture) Procedural voronoi texture color_mode INTENSITY Intensity, Only calculate intensity. POSITION Position, Color cells by position. POSITION_OUTLINE Position and Outline, Use position plus an outline based on F2-F.1. POSITION_OUTLINE_INTENSITY Position, Outline, and Intensity, Multiply position and outline by intensity. Type enum in [INTENSITY, POSITION, POSITION_OUTLINE, TION_OUTLINE_INTENSITY], default INTENSITY distance_metric DISTANCE Actual Distance, Algorithm used to calculate distance of sample points to feature points. Actual Distance: sqrt(x*x+y*y+z*z). DISTANCE_SQUARED Distance Squared, Algorithm used to calculate distance of sample points to feature points. Distance squared: (x*x+y*y+z*z). MANHATTAN Manhattan, Algorithm used to calculate distance of sample points to feature points. Manhattan: The length of the distance in axial directions. CHEBYCHEV Chebychev, Algorithm used to calculate distance of sample points to feature points. Chebychev: The length of the longest Axial journey. MINKOVSKY_HALF Minkovsky 1/2, Algorithm used to calculate distance of sample points to feature points. Minovsky 1/2: Sets Minkovsky variable to 0.5. MINKOVSKY_FOUR Minkovsky 4, Algorithm used to calculate distance of sample points to feature points. Minkovsky 4: Sets Minkovsky variable to 4. MINKOVSKY Minkovsky, Algorithm used to calculate distance of sample points to feature points. Minkovsky: Uses the Minkowsky function to calculate distance. Exponent value determines the shape of the boundaries. Type enum in [DISTANCE, DISTANCE_SQUARED, MANHATTAN, CHEBYCHEV, MINKOVSKY_HALF, MINKOVSKY_FOUR, MINKOVSKY], default DISTANCE minkovsky_exponent Minkovsky exponent Type oat in [0.01, 10], default 0.0 nabla Size of derivative offset used for calculating normal 2.4. Types ([Link]) 1135 POSI-

Blender Index, Release 2.59.2 - API

Type oat in [0.001, 0.1], default 0.0 noise_intensity Scales the intensity of the noise Type oat in [0.01, 10], default 0.0 noise_scale Sets scaling for noise input Type oat in [0.0001, inf], default 0.0 weight_1 Voronoi feature weight 1 Type oat in [-2, 2], default 0.0 weight_2 Voronoi feature weight 2 Type oat in [-2, 2], default 0.0 weight_3 Voronoi feature weight 3 Type oat in [-2, 2], default 0.0 weight_4 Voronoi feature weight 4 Type oat in [-2, 2], default 0.0 users_material Materials that use this texture (readonly) users_object_modifier Object modiers that use this texture (readonly)
Inherited Properties

1136

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Texture.users_object_modifier Texture.users_material Texture.users_object_modifier

Inherited Functions

2.4.639 VoxelData(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Voxel data settings domain_object Object used as the smoke simulation domain Type Object extension Sets how the texture is extrapolated past its original bounds EXTEND Extend, Extends by repeating edge pixels of the image. CLIP Clip, Clips to image size and sets exterior pixels as transparent. REPEAT Repeat, Causes the image to repeat horizontally and vertically. Type enum in [EXTEND, CLIP, REPEAT], default EXTEND file_format Format of the source data set to render BLENDER_VOXEL Blender Voxel, Default binary voxel le format.

2.4. Types ([Link])

1137

Blender Index, Release 2.59.2 - API

RAW_8BIT 8 bit RAW, 8 bit greyscale binary data. IMAGE_SEQUENCE Image Sequence, Generate voxels from a sequence of image slices. SMOKE Smoke, Render voxels from a Blender smoke simulation. Type enum in [BLENDER_VOXEL, RAW_8BIT, IMAGE_SEQUENCE, SMOKE], default BLENDER_VOXEL filepath The external source data le to use Type string, default intensity Multiplier for intensity values Type oat in [0.01, inf], default 0.0 interpolation Method to interpolate/smooth values between voxel cells NEREASTNEIGHBOR Nearest Neighbor, No interpolation, fast but blocky and low quality. TRILINEAR Linear, Good smoothness and speed. QUADRATIC Quadratic, Mid-range quality and speed. TRICUBIC_CATROM Cubic Catmull-Rom, High quality interpolation, but slower. TRICUBIC_BSPLINE Cubic B-Spline, Smoothed high quality interpolation, but slower. Type enum in [NEREASTNEIGHBOR, TRILINEAR, QUADRATIC, BIC_CATROM, TRICUBIC_BSPLINE], default NEREASTNEIGHBOR resolution Resolution of the voxel grid Type int array of 3 items in [1, 100000], default (0, 0, 0) smoke_data_type Simulation value to be used as a texture SMOKEDENSITY Density, Use smoke density as texture data. SMOKEHEAT Heat, Use smoke heat as texture data. Values from -2.0 to 2.0 are used. SMOKEVEL Velocity, Use smoke velocity as texture data. Type enum in [SMOKEDENSITY, SMOKEHEAT, SMOKEVEL], default SMOKEDENSITY still_frame The frame number to always use Type int in [-300000, 300000], default 0 use_still_frame Always render a still frame from the voxel data sequence Type boolean, default False TRICU-

1138

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Properties

bpy_struct.id_data
Inherited Functions

References

VoxelDataTexture.voxel_data

2.4.640 VoxelDataTexture(Texture)
base classes bpy_struct, ID, Texture class [Link](Texture) Settings for the Voxel Data texture image Type Image image_user Parameters dening which layer, pass and frame of the image is displayed Type ImageUser, (readonly) voxel_data The voxel data associated with this texture Type VoxelData, (readonly) users_material Materials that use this texture (readonly) users_object_modifier Object modiers that use this texture (readonly)

2.4. Types ([Link])

1139

Blender Index, Release 2.59.2 - API

Inherited Properties

Inherited Functions

1140

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.641 WarpModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Warp modier falloff_curve Custom Lamp Falloff Curve Type CurveMapping, (readonly) falloff_radius Radius to apply Type oat in [0, inf], default 0.0 falloff_type Type enum in [NONE, CURVE, SMOOTH, SPHERE, ROOT, SHARP, LINEAR, CONSTANT], default NONE object_from Object to transform from Type Object object_to Object to transform to Type Object strength Type oat in [-inf, inf], default 0.0 texture Type Texture texture_coords LOCAL Map, Uses the local coordinate system for the texture coordinates. GLOBAL Global, Uses the global coordinate system for the texture coordinates. OBJECT Object, Uses the linked objects local coordinate system for the texture coordinates. UV UV, Uses UV coordinates for the texture coordinates. Type enum in [LOCAL, GLOBAL, OBJECT, UV], default LOCAL texture_coords_object Object to set the texture coordinates Type Object use_volume_preserve Preserve volume when rotations are used Type boolean, default False uv_layer UV layer name Type string, default

2.4. Types ([Link])

1141

Blender Index, Release 2.59.2 - API

vertex_group Vertex group name for modulating the deform Type string, default
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

2.4.642 WaveModier(Modier)
base classes bpy_struct, Modifier class [Link](Modier) Wave effect modier damping_time Number of frames in which the waves damps out after it dies Type oat in [-300000, 300000], default 0.0 falloff_radius Distance after which it fades out Type oat in [0, inf], default 0.0 height Height of the wave 1142 Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Type oat in [-inf, inf], default 0.0 lifetime Lifetime of the wave in frames, zero means innite Type oat in [-300000, 300000], default 0.0 narrowness Distance between the top and the base of a wave, the higher the value, the more narrow the wave Type oat in [0, inf], default 0.0 speed Speed of the wave, towards the starting point when negative Type oat in [-inf, inf], default 0.0 start_position_object Object which denes the wave center Type Object start_position_x X coordinate of the start position Type oat in [-inf, inf], default 0.0 start_position_y Z coordinate of the start position Type oat in [-inf, inf], default 0.0 texture Texture for modulating the wave Type Texture texture_coords Texture coordinates used for modulating input Type enum in [LOCAL, GLOBAL, OBJECT, MAP_UV], default LOCAL texture_coords_object Type Object time_offset Either the starting frame (for positive speed) or ending frame (for negative speed.) Type oat in [-300000, 300000], default 0.0 use_cyclic Cyclic wave effect Type boolean, default False use_normal Displace along normals Type boolean, default False use_normal_x Enable displacement along the X normal Type boolean, default False

2.4. Types ([Link])

1143

Blender Index, Release 2.59.2 - API

use_normal_y Enable displacement along the Y normal Type boolean, default False use_normal_z Enable displacement along the Z normal Type boolean, default False use_x X axis motion Type boolean, default False use_y Y axis motion Type boolean, default False uv_layer UV layer name Type string, default vertex_group Vertex group name for modulating the wave Type string, default width Distance between the waves Type oat in [0, inf], default 0.0
Inherited Properties

bpy_struct.id_data [Link] Modifier.use_apply_on_spline Modifier.show_in_editmode Modifier.show_expanded Modifier.show_on_cage Modifier.show_viewport Modifier.show_render [Link]

Inherited Functions

1144

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values

2.4.643 Window(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Open window screen Active screen showing in the window Type Screen, (never None)
Inherited Properties

bpy_struct.id_data
Inherited Functions

References

[Link] WindowManager.event_timer_add [Link]

2.4.644 WindowManager(ID)
base classes bpy_struct, ID

2.4. Types ([Link])

1145

Blender Index, Release 2.59.2 - API

class [Link](ID) Window manager datablock dening open windows and other user interface data addon_filter Filter add-ons by category Type enum in [], default addon_search Search within the selected lter Type string, default addon_support Display support level Type enum set in {OFFICIAL, COMMUNITY}, default {OFFICIAL, COMMUNITY} clipboard Type string, default keyconfigs Registered key congurations Type KeyConfigurations bpy_prop_collection of KeyConfig, (readonly) operators Operator registry Type bpy_prop_collection of Operator, (readonly) windows Open windows Type bpy_prop_collection of Window, (readonly) classmethod fileselect_add(operator) Show up the le selector. Parameters operator (Operator) Operator to call. classmethod modal_handler_add(operator) modal_handler_add Parameters operator (Operator) Operator to call. Return type boolean event_timer_add(time_step, window=None) event_timer_add Parameters time_step (oat in [0, inf]) Time Step, Interval in seconds between timer events window (Window, (optional)) Window to attach the timer to or None. Return type Timer event_timer_remove(timer) event_timer_remove

classmethod invoke_props_popup(operator, event) Operator popup invoke.

1146

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Parameters operator (Operator) Operator to call. event (Event) Event. Returns result RUNNING_MODAL Running Modal, Keep the operator running with blender. CANCELLED Cancelled, When no action has been taken. FINISHED Finished. PASS_THROUGH Pass Through, Do nothing and pass the event on. Return type enum set PASS_THROUGH} in {RUNNING_MODAL, CANCELLED, FINISHED,

classmethod invoke_props_dialog(operator, width=300, height=20) Operator dialog (non-autoexec popup) invoke. Parameters operator (Operator) Operator to call. width (int in [0, inf], (optional)) Width of the popup. height (int in [0, inf], (optional)) Height of the popup. Returns result RUNNING_MODAL Running Modal, Keep the operator running with blender. CANCELLED Cancelled, When no action has been taken. FINISHED Finished. PASS_THROUGH Pass Through, Do nothing and pass the event on. Return type enum set PASS_THROUGH} in {RUNNING_MODAL, CANCELLED, FINISHED,

classmethod invoke_search_popup(operator) invoke_search_popup Parameters operator (Operator) Operator to call. classmethod invoke_popup(operator, width=300, height=20) Operator popup invoke. Parameters operator (Operator) Operator to call. width (int in [0, inf], (optional)) Width of the popup. height (int in [0, inf], (optional)) Height of the popup. Returns result RUNNING_MODAL Running Modal, Keep the operator running with blender. CANCELLED Cancelled, When no action has been taken.

2.4. Types ([Link])

1147

Blender Index, Release 2.59.2 - API

FINISHED Finished. PASS_THROUGH Pass Through, Do nothing and pass the event on. Return type enum set PASS_THROUGH} in {RUNNING_MODAL, CANCELLED, FINISHED,

classmethod invoke_confirm(operator, event) Operator conrmation. Parameters operator (Operator) Operator to call. event (Event) Event. Returns result RUNNING_MODAL Running Modal, Keep the operator running with blender. CANCELLED Cancelled, When no action has been taken. FINISHED Finished. PASS_THROUGH Pass Through, Do nothing and pass the event on. Return type enum set PASS_THROUGH}
Inherited Properties

{RUNNING_MODAL,

CANCELLED,

FINISHED,

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

Inherited Functions

1148

Blender Index, Release 2.59.2 - API

ID.user_clear ID.animation_data_create ID.animation_data_clear ID.update_tag

References

BlendData.window_managers Context.window_manager

2.4.645 WipeSequence(EffectSequence)
base classes bpy_struct, Sequence, EffectSequence class [Link](EffectSequence) Sequence strip creating a wipe transition angle Edge angle Type oat in [-1.5708, 1.5708], default 0.0 blur_width Width of the blur edge, in percentage relative to the image size Type oat in [0, 1], default 0.0 direction Wipe direction Type enum in [OUT, IN], default OUT transition_type Type enum in [SINGLE, DOUBLE, IRIS, CLOCK], default SINGLE
Inherited Properties

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

Sequence.select_right_handle [Link] Sequence.speed_factor Sequence.frame_start Sequence.frame_final_start Sequence.frame_offset_start Sequence.frame_still_start [Link] Sequence.use_default_fade Sequence.input_count EffectSequence.color_balance EffectSequence.use_float [Link] EffectSequence.use_deinterlace EffectSequence.use_reverse_frames EffectSequence.use_flip_x EffectSequence.use_flip_y EffectSequence.color_multiply EffectSequence.use_premultiply [Link] EffectSequence.use_proxy_custom_directory EffectSequence.use_proxy_custom_file EffectSequence.color_saturation [Link] [Link] EffectSequence.use_color_balance EffectSequence.use_crop EffectSequence.use_proxy EffectSequence.use_translation

Inherited Functions

1150

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

2.4.646 WoodTexture(Texture)
base classes bpy_struct, ID, Texture class [Link](Texture) Procedural noise texture nabla Size of derivative offset used for calculating normal Type oat in [0.001, 0.1], default 0.0 noise_basis Sets the noise basis used for turbulence BLENDER_ORIGINAL Blender Original, Noise algorithm - Blender original: Smooth interpolated noise. ORIGINAL_PERLIN Original Perlin, Noise algorithm - Original Perlin: Smooth interpolated noise. IMPROVED_PERLIN Improved Perlin, Noise algorithm - Improved Perlin: Smooth interpolated noise. VORONOI_F1 Voronoi F1, Noise algorithm - Voronoi F1: Returns distance to the closest feature point. VORONOI_F2 Voronoi F2, Noise algorithm - Voronoi F2: Returns distance to the 2nd closest feature point. VORONOI_F3 Voronoi F3, Noise algorithm - Voronoi F3: Returns distance to the 3rd closest feature point. VORONOI_F4 Voronoi F4, Noise algorithm - Voronoi F4: Returns distance to the 4th closest feature point. VORONOI_F2_F1 Voronoi F2-F1, Noise algorithm - Voronoi F1-F2. VORONOI_CRACKLE Voronoi Crackle, Noise algorithm - Voronoi Crackle: Voronoi tessellation with sharp edges. CELL_NOISE Cell Noise, Noise algorithm - Cell Noise: Square cell tessallation. Type enum in [BLENDER_ORIGINAL, ORIGINAL_PERLIN, IMPROVED_PERLIN, VORONOI_F1, VORONOI_F2, VORONOI_F3, VORONOI_F4, VORONOI_F2_F1, VORONOI_CRACKLE, CELL_NOISE], default BLENDER_ORIGINAL noise_basis_2 SIN Sine, Uses a sine wave to produce bands. SAW Saw, Uses a saw wave to produce bands. TRI Tri, Uses a triangle wave to produce bands. Type enum in [SIN, SAW, TRI], default SIN noise_scale Sets scaling for noise input Type oat in [0.0001, inf], default 0.0 noise_type

2.4. Types ([Link])

1151

Blender Index, Release 2.59.2 - API

SOFT_NOISE Soft, Generate soft noise (smooth transitions). HARD_NOISE Hard, Generate hard noise (sharp transitions). Type enum in [SOFT_NOISE, HARD_NOISE], default SOFT_NOISE turbulence Sets the turbulence of the bandnoise and ringnoise types Type oat in [0.0001, inf], default 0.0 wood_type BANDS Bands, Uses standard wood texture in bands. RINGS Rings, Uses wood texture in rings. BANDNOISE Band Noise, Adds noise to standard wood. RINGNOISE Ring Noise, Adds noise to rings. Type enum in [BANDS, RINGS, BANDNOISE, RINGNOISE], default BANDS users_material Materials that use this texture (readonly) users_object_modifier Object modiers that use this texture (readonly)
Inherited Properties

1152

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Functions

2.4.647 World(ID)
base classes bpy_struct, ID class [Link](ID) World datablock describing the environment and ambient lighting of a scene active_texture Active texture slot being displayed Type Texture active_texture_index Index of active texture slot Type int in [0, 17], default 0 ambient_color Ambient color of the world Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) animation_data Animation data for this datablock Type AnimData, (readonly) color_range The color range that will be mapped to 0-1 Type oat in [0.2, 5], default 0.0 exposure Amount of exponential color correction for light 2.4. Types ([Link]) 1153

Blender Index, Release 2.59.2 - API

Type oat in [0, 1], default 0.0 horizon_color Color at the horizon Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0) light_settings World lighting settings Type WorldLighting, (readonly, never None) mist_settings World mist settings Type WorldMistSettings, (readonly, never None) star_settings World stars settings Type WorldStarsSettings, (readonly, never None) texture_slots Texture slots dening the mapping and inuence of textures Type WorldTextureSlots bpy_prop_collection of WorldTextureSlot, (readonly) use_sky_blend Render background with natural progression from horizon to zenith Type boolean, default False use_sky_paper Flatten blend or texture coordinates Type boolean, default False use_sky_real Render background with a real horizon, relative to the camera angle Type boolean, default False zenith_color Color at the zenith Type oat array of 3 items in [-inf, inf], default (0.0, 0.0, 0.0)
Inherited Properties

bpy_struct.id_data [Link] ID.use_fake_user [Link] [Link] [Link]

Inherited Functions

bpy_struct.as_pointer bpy_struct.callback_add

1154

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

References

[Link] [Link] [Link] [Link]

2.4.648 WorldLighting(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Lighting for a World datablock adapt_to_speed Use the speed vector pass to reduce AO samples in fast moving pixels. Higher values result in more aggressive sample reduction. Requires Vec pass enabled (for Raytrace Adaptive QMC) Type oat in [0, 1], default 0.0 ao_blend_type Denes how AO mixes with material shading MULTIPLY Multiply, Multiply direct lighting with ambient occlusion, darkening the result. ADD Add, Add light and shadow. Type enum in [MULTIPLY, ADD], default ADD ao_factor Factor for ambient occlusion blending Type oat in [0, inf], default 0.0 bias Bias (in radians) to prevent smoothed faces from showing banding (for Raytrace Constant Jittered)

2.4. Types ([Link])

1155

Blender Index, Release 2.59.2 - API

Type oat in [0, 0.5], default 0.0 correction Ad-hoc correction for over-occlusion due to the approximation Type oat in [0, 1], default 0.0 distance Length of rays, denes how far away other faces give occlusion effect Type oat in [-inf, inf], default 0.0 environment_color Denes where the color of the environment light comes from PLAIN White, Plain diffuse energy (white.). SKY_COLOR Sky Color, Use horizon and zenith color for diffuse energy. SKY_TEXTURE Sky Texture, Does full Sky texture render for diffuse energy. Type enum in [PLAIN, SKY_COLOR, SKY_TEXTURE], default PLAIN environment_energy Denes the strength of environment light Type oat in [-inf, inf], default 0.0 error_threshold Low values are slower and higher quality Type oat in [0.0001, 10], default 0.0 falloff_strength Attenuation falloff strength, the higher, the less inuence distant objects have Type oat in [-inf, inf], default 0.0 gather_method RAYTRACE Raytrace, Accurate, but slow when noise-free results are required. APPROXIMATE Approximate, Inaccurate, but faster and without noise. Type enum in [RAYTRACE, APPROXIMATE], default RAYTRACE indirect_bounces Number of indirect diffuse light bounces Type int in [1, 32767], default 0 indirect_factor Factor for how much surrounding objects contribute to light Type oat in [0, inf], default 0.0 passes Number of preprocessing passes to reduce overocclusion Type int in [0, 10], default 0 sample_method Method for generating shadow samples (for Raytrace) CONSTANT_JITTERED Constant Jittered, Fastest and gives the most noise.

1156

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

World.star_settings

2.4.651 WorldTextureSlot(TextureSlot)
base classes bpy_struct, TextureSlot class [Link](TextureSlot) Texture slot for textures in a World datablock blend_factor Amount texture affects color progression of the background Type oat in [-inf, inf], default 0.0 horizon_factor Amount texture affects color of the horizon Type oat in [-inf, inf], default 0.0 object Object to use for mapping with Object texture coordinates Type Object texture_coords Texture coordinates used to map the texture onto the background VIEW View, Uses view vector for the texture coordinates. GLOBAL Global, Uses global coordinates for the texture coordinates (interior mist).

1160

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

ANGMAP AngMap, Uses 360 degree angular coordinates, e.g. for spherical light probes. SPHERE Sphere, For 360 degree panorama sky, spherical mapped, only top half. TUBE Tube, For 360 degree panorama sky, cylindrical mapped, only top half. OBJECT Object, Uses linked objects coordinates for texture coordinates. Type enum in [VIEW, GLOBAL, ANGMAP, SPHERE, TUBE, OBJECT], default VIEW use_map_blend Affect the color progression of the background Type boolean, default False use_map_horizon Affect the color of the horizon Type boolean, default False use_map_zenith_down Affect the color of the zenith below Type boolean, default False use_map_zenith_up Affect the color of the zenith above Type boolean, default False zenith_down_factor Amount texture affects color of the zenith below Type oat in [-inf, inf], default 0.0 zenith_up_factor Amount texture affects color of the zenith above Type oat in [-inf, inf], default 0.0
Inherited Properties

bpy_struct.id_data [Link] TextureSlot.blend_type [Link] TextureSlot.default_value [Link] [Link] TextureSlot.output_node TextureSlot.use_rgb_to_intensity [Link] TextureSlot.use_stencil [Link]

Inherited Functions

bpy_struct.as_pointer

2.4. Types ([Link])

1161

Blender Index, Release 2.59.2 - API

References

World.texture_slots [Link] [Link]

2.4.652 WorldTextureSlots(bpy_struct)
base class bpy_struct class [Link](bpy_struct) Collection of texture slots classmethod add() add Returns The newly initialized mtex. Return type WorldTextureSlot classmethod create(index) create Parameters index (int in [0, inf]) Index, Slot index to initialize. Returns The newly initialized mtex. Return type WorldTextureSlot classmethod clear(index) clear Parameters index (int in [0, inf]) Index, Slot index to clear.
Inherited Properties

bpy_struct.id_data

1162

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Inherited Functions

References

World.texture_slots

2.4.653 XnorController(Controller)
base classes bpy_struct, Controller class [Link](Controller) Controller passing on events based on a logical XNOR operation
Inherited Properties

bpy_struct.id_data [Link] [Link] Controller.show_expanded Controller.use_priority [Link]

Inherited Functions

2.4. Types ([Link])

Blender Index, Release 2.59.2 - API

bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.type_recast bpy_struct.values [Link] [Link]

2.4.654 XorController(Controller)
base classes bpy_struct, Controller class [Link](Controller) Controller passing on events based on a logical XOR operation
Inherited Properties

bpy_struct.id_data [Link] [Link] Controller.show_expanded Controller.use_priority [Link]

Inherited Functions

2.4.655 bpy_prop_collection
class [Link].bpy_prop_collection built-in class used for all collections.

1164

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Note: Note that [Link].bpy_prop_collection is not actually available from within blender, it only exists for the purpose of documentation. foreach_get(attr, seq) This is a function to give fast access to attributes within a collection.
collection.foreach_get(someseq, attr) # Python equivalent for i in range(len(seq)): someseq[i]= getattr(collection, attr)

foreach_set(attr, seq) This is a function to give fast access to attributes within a collection.
collection.foreach_set(seq, attr) # Python equivalent for i in range(len(seq)): setattr(collection[i], attr, seq[i])

get(key, default=None) Returns the value of the item assigned to key or default when not found (matches pythons dictionary function of the same name). Parameters key (string) The identier for the collection member. default (Undened) Optional argument for the value to return if key is not found. items() Return the identiers of collection members (matching pythons [Link]() functionality). Returns (key, value) pairs for each member of this collection. Return type list of tuples keys() Return the identiers of collection members (matching pythons [Link]() functionality). Returns the identiers for each member of this collection. Return type list of stings values() Return the values of collection (matching pythons [Link]() functionality). Returns the members of this collection. Return type list

2.4.656 bpy_struct
subclasses ActionFCurves, ActionGroup, ActionGroups, ActionPoseMarkers, Actuator, Addon, Addons, AnimData, AnimDataDrivers, AnimViz, AnimVizMotionPaths, AnimVizOnionSkinning, AnyType, Area, AreaSpaces, ArmatureBones, ArmatureEditBones, BackgroundImage, BezierSplinePoint, BlendData, BlendDataActions, BlendDataArmatures, BlendDataBrushes, BlendDataCameras, BlendDataCurves, BlendDataFonts, BlendDataGreasePencils, BlendDataGroups, BlendDataImages, BlendDataLamps, BlendDataLattices, BlendDataLibraries, BlendDataMaterials, BlendDataMeshes, BlendDataMetaBalls, BlendDataNodeTrees, BlendDataObjects,

2.4. Types ([Link])

1165

Blender Index, Release 2.59.2 - API

BlendDataParticles, BlendDataScenes, BlendDataScreens, BlendDataSounds, BlendDataSpeakers, BlendDataTexts, BlendDataTextures, BlendDataWindowManagers, BlendDataWorlds, BlenderRNA, BoidRule, BoidSettings, BoidState, Bone, BoneGroup, BoneGroups, ChannelDriverVariables, ChildParticle, ClothCollisionSettings, ClothSettings, CollisionSettings, ColorRamp, ColorRampElement, ColorRampElements, CompositorNodes, ConsoleLine, Constraint, ConstraintTarget, Context, Controller, CurveMap, CurveMapPoint, CurveMapping, CurveSplines, DopeSheet, Driver, DriverTarget, DriverVariable, DupliObject, EditBone, EffectorWeights, EnumPropertyItem, EnvironmentMap, Event, FCurve, FCurveKeyframePoints, FCurveModifiers, FCurveSample, FModifier, FModifierEnvelopeControlPoint, FieldSettings, FileSelectParams, FluidMeshVertex, FluidSettings, Function, GPencilFrame, GPencilLayer, GPencilStroke, GPencilStrokePoint, GameObjectSettings, GameProperty, GameSoftBodySettings, GreasePencilLayers, GroupInputs, GroupObjects, GroupOutputs, Header, Histogram, ID, IDMaterials, IKParam, ImageUser, KeyConfig, KeyConfigurations, KeyMap, KeyMapItem, KeyMapItems, KeyMaps, Keyframe, KeyingSet, KeyingSetInfo, KeyingSetPath, KeyingSetPaths, KeyingSets, KeyingSetsAll, LampSkySettings, LampTextureSlots, LatticePoint, Macro, MaterialHalo, MaterialPhysics, MaterialRaytraceMirror, MaterialRaytraceTransparency, MaterialSlot, MaterialStrand, MaterialSubsurfaceScattering, MaterialTextureSlots, MaterialVolume, Menu, MeshColor, MeshColorLayer, MeshEdge, MeshEdges, MeshFace, MeshFaces, MeshFloatProperty, MeshFloatPropertyLayer, MeshIntProperty, MeshIntPropertyLayer, MeshSticky, MeshStringProperty, MeshStringPropertyLayer, MeshTextureFace, MeshTextureFaceLayer, MeshVertex, MeshVertices, MetaBallElements, MetaElement, Modifier, MotionPath, MotionPathVert, NlaStrip, NlaStrips, NlaTrack, NlaTracks, Node, NodeLink, NodeLinks, NodeSocket, ObjectBase, ObjectConstraints, ObjectModifiers, Operator, OperatorProperties, OperatorTypeMacro, PackedFile, Paint, Panel, Particle, ParticleBrush, ParticleDupliWeight, ParticleEdit, ParticleHairKey, ParticleKey, ParticleSettingsTextureSlots, ParticleSystem, ParticleSystems, ParticleTarget, PointCache, PointCaches, PointDensity, Pose, PoseBone, PoseBoneConstraints, Property, PropertyGroup, PropertyGroupItem, Region, RegionView3D, RenderEngine, RenderLayer, RenderLayers, RenderPass, RenderResult, RenderSettings, SPHFluidSettings, SceneBases, SceneGameData, SceneGameRecastData, SceneObjects, SceneRenderLayer, Scopes, Sensor, Sequence, SequenceColorBalance, SequenceCrop, SequenceEditor, SequenceElement, SequenceProxy, SequenceTransform, ShaderNodes, ShapeKey, ShapeKeyBezierPoint, ShapeKeyCurvePoint, ShapeKeyPoint, SmokeCollSettings, SmokeDomainSettings, SmokeFlowSettings, SoftBodySettings, Space, SpaceUVEditor, Spline, SplineBezierPoints, SplinePoint, SplinePoints, Struct, TexMapping, TextBox, TextCharacterFormat, TextLine, TextMarker, TextureNodes, TextureSlot, Theme, ThemeAudioWindow, ThemeBoneColorSet, ThemeConsole, ThemeDopeSheet, ThemeFileBrowser, ThemeFontStyle, ThemeGraphEditor, ThemeImageEditor, ThemeInfo, ThemeLogicEditor, ThemeNLAEditor, ThemeNodeEditor, ThemeOutliner, ThemeProperties, ThemeSequenceEditor, ThemeStyle, ThemeTextEditor, ThemeTimeline, ThemeUserInterface, ThemeUserPreferences, ThemeView3D, ThemeWidgetColors, ThemeWidgetStateColors, TimelineMarker, TimelineMarkers, Timer, ToolSettings, TransformOrientation, UILayout, UVProjector, UVTextures, UnitSettings, UnknownType, UserPreferences, UserPreferencesEdit, UserPreferencesFilePaths, UserPreferencesInput, UserPreferencesSystem, UserPreferencesView, UserSolidLight, VertexColors, VertexGroup, VertexGroupElement, VertexGroups, VoxelData, Window, WorldLighting, WorldMistSettings, WorldStarsSettings, WorldTextureSlots class [Link].bpy_struct built-in base class for all classes in [Link]. Note: Note that [Link].bpy_struct is not actually available from within blender, it only exists for the purpose

1166

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

of documentation. as_pointer() Returns the memory address which holds a pointer to blenders internal data Returns int (memory address). Return type int Note: This is intended only for advanced script writers who need to pass blender data to their own C/Python modules. Undocumented (contribute) Undocumented (contribute) driver_add(path, index=-1) Adds driver(s) to the given property Parameters path (string) path to the property to drive, analogous to the fcurves data path. index (int) array index of the property drive. Defaults to -1 for all indices or a single channel if the property is not an array. Returns The driver(s) added. Return type FCurve or list if index is -1 with an array property. driver_remove(path, index=-1) Remove driver(s) from the given property Parameters path (string) path to the property to drive, analogous to the fcurves data path. index (int) array index of the property drive. Defaults to -1 for all indices or a single channel if the property is not an array. Returns Success of driver removal. Return type boolean get(key, default=None) Returns the value of the custom property assigned to key or default when not found (matches pythons dictionary function of the same name). Parameters key (string) The key assosiated with the custom property. default (Undened) Optional argument for the value to return if key is not found. Note: Only ID, Bone and PoseBone classes support custom properties. is_property_hidden(property) Check if a property is hidden. Returns True when the property is hidden. Return type boolean

2.4. Types ([Link])

1167

Blender Index, Release 2.59.2 - API

is_property_set(property) Check if a property is set, use for testing operator properties. Returns True when the property has been set. Return type boolean items() Returns the items of this objects custom properties (matches pythons dictionary function of the same name). Returns custom property key, value pairs. Return type list of key, value tuples Note: Only ID, Bone and PoseBone classes support custom properties. keyframe_delete(data_path, index=-1, frame=[Link].frame_current, group=) Remove a keyframe from this properties fcurve. Parameters data_path (string) path to the property to remove a key, analogous to the fcurves data path. index (int) array index of the property to remove a key. Defaults to -1 removing all indices or a single channel if the property is not an array. frame (oat) The frame on which the keyframe is deleted, defaulting to the current frame. group (str) The name of the group the F-Curve should be added to if it doesnt exist yet. Returns Success of keyframe deleation. Return type boolean keyframe_insert(data_path, index=-1, frame=[Link].frame_current, group=) Insert a keyframe on the property given, adding fcurves and animation data when necessary. Parameters data_path (string) path to the property to key, analogous to the fcurves data path. index (int) array index of the property to key. Defaults to -1 which will key all indices or a single channel if the property is not an array. frame (oat) The frame on which the keyframe is inserted, defaulting to the current frame. group (str) The name of the group the F-Curve should be added to if it doesnt exist yet. Returns Success of keyframe insertion. Return type boolean This is the most simple example of inserting a keyframe from python.
import bpy obj = [Link] # set the keyframe at frame 1

1168

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

[Link] = 3.0, 4.0, 10.0 obj.keyframe_insert(data_path="location", frame=1)

Note that when keying data paths which contain nested properties this must be done from the ID subclass, in this case the Armature rather then the bone.
import bpy from [Link] import PointerProperty

# define a nested property class MyPropGroup([Link]): nested = [Link](name="Nested", default=0.0) # register it so its available for all bones [Link].register_class(MyPropGroup) [Link].my_prop = PointerProperty(type=MyPropGroup, name="MyProp") # get a bone obj = [Link]["Armature"] arm = [Link] # set the keyframe at frame 1 [Link]["Bone"].my_prop_group.nested = 10 arm.keyframe_insert(data_path=bones["Bone"].my_prop.nested, frame=1, group="Nested Group")

keys() Returns the keys of this objects custom properties (matches pythons dictionary function of the same name). Returns custom property keys. Return type list of strings Note: Only ID, Bone and PoseBone classes support custom properties. path_from_id(property=) Returns the data path from the ID to this object (string). Parameters property (string) Optional property name which can be used if the path is to a property of this object. Returns The path from bpy_struct.id_data to this struct and property (when given). Return type str path_resolve(path, coerce=True) Returns the property from the path, raise an exception when not found. Parameters path (string) path which this property resolves. coerce (boolean) optional argument, when True, the property will be converted into its python representation. type_recast() Return a new instance, this is needed because types such as textures can be changed at runtime.

2.4. Types ([Link])

1169

Blender Index, Release 2.59.2 - API

Returns a new instance of this object with the type initialized again. Return type subclass of bpy_struct values() Returns the values of this objects custom properties (matches pythons dictionary function of the same name). Returns custom property values. Return type list Note: Only ID, Bone and PoseBone classes support custom properties. id_data The ID object this datablock is from or None, (not available for all data types)

2.5 Utilities ([Link])

This module contains utility functions specic to blender but not assosiated with blenders internal data. [Link].blend_paths(absolute=False) Returns a list of paths to external les referenced by the loaded .blend le. Parameters absolute (boolean) When true the paths returned are made absolute. Returns path list. Return type list of strings [Link].keyconfig_set(lepath) [Link].load_scripts(reload_scripts=False, refresh_scripts=False) Load scripts and run each modules register function. Parameters reload_scripts (bool) Causes all scripts to have their unregister method called before loading. refresh_scripts (bool) only load scripts which are not already loaded as modules. [Link].modules_from_path(path, loaded_modules) Load all modules in a path and return them as a list. Parameters path (string) this path is scanned for scripts and packages. loaded_modules (set) already loaded module names, les matching these names will be ignored. Returns all loaded modules. Return type list [Link].preset_find(name, preset_path, display_name=False) [Link].preset_paths(subdir) Returns a list of paths for a specic preset. Parameters subdir (string) preset subdirectory (must not be an absolute path).

1170

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Returns script paths. Return type list [Link].refresh_script_paths() Run this after creating new script paths to update [Link] [Link].register_class(cls) Register a subclass of a blender type in ([Link], [Link], [Link], [Link], [Link], [Link]). If the class has a register class method it will be called before registration. Note: ValueError exception is raised if the class is not a subclass of a registerable blender class. [Link].register_module(module, verbose=False) [Link].resource_path(type, major=2, minor=57 ) Return the base path for storing system les. Parameters type (string) string in [USER, LOCAL, SYSTEM]. major (int) major version, defaults to current. minor (string) minor version, defaults to current. Returns the resource path (not necessarily existing). Return type string [Link].script_paths(subdir=None, user_pref=True, all=False) Returns a list of valid script paths. Parameters subdir (string) Optional subdir. user_pref (bool) Include the user preference script path. all (bool) Include local, user and system paths rather just the paths blender uses. Returns script paths. Return type list [Link].smpte_from_frame(frame, fps=None, fps_base=None) Returns an SMPTE formatted string from the frame: HH:MM:SS:FF. If fps and fps_base are not given the current scene is used. [Link].smpte_from_seconds(time, fps=None) Returns an SMPTE formatted string from the time in seconds: HH:MM:SS:FF. If the fps is not given the current scene is used. [Link].unregister_class(cls) Unload the python class from blender. If the class has an unregister class method it will be called before unregistering. [Link].unregister_module(module, verbose=False) [Link].user_resource(type, path=, create=False) Return a user resource path (normally from the users home directory).

2.5. Utilities ([Link])

1171

Blender Index, Release 2.59.2 - API

Parameters type (string) Resource type in [DATAFILES, CONFIG, SCRIPTS, AUTOSAVE]. subdir (string) Optional subdirectory. create (boolean) Treat the path as a directory and create it if its not existing. Returns a path. Return type string [Link].user_script_path()

2.6 Path Utilities ([Link])

This module has a similar scope to [Link], containing utility functions for dealing with paths in Blender. [Link](path, start=None) Returns the absolute path relative to the current blend le using the // prex. Parameters start (string) Relative to this path, when not set the current lename is used. [Link](path) Equivalent to [Link], but skips a // sufx. Use for Windows compatibility. [Link].clean_name(name, replace=_) Returns a name with characters replaced that may cause problems under various circumstances, such as writing to a le. All characters besides A-Z/a-z, 0-9 are replaced with _ or the replace argument if dened. [Link].display_name(name) Creates a display string from name to be used menus and the user interface. Capitalize the rst letter in all lowercase names, mixed case names are kept as is. Intended for use with lenames and module names. [Link].display_name_from_filepath(name) Returns the path stripped of directory and extension, ensured to be utf8 compatible. [Link].ensure_ext(lepath, ext, case_sensitive=False) Return the path with the extension added if it is not already set. Parameters ext (string) The extension to check for. case_sensitive (bool) Check for matching case when comparing extensions. [Link].is_subdir(path, directory) Returns true if path in a subdirectory of directory. Both paths must be absolute. [Link].module_names(path, recursive=False) Return a list of modules which can be imported from path. Parameters path (string) a directory to scan. recursive (bool) Also return submodule names for packages. Returns a list of string pairs (module_name, module_le).

1172

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

Return type list [Link](path, start=None) Returns the path relative to the current blend le using the // prex. Parameters start (string) Relative to this path, when not set the current lename is used. [Link].resolve_ncase(path) Resolve a case insensitive path on a case sensitive system, returning a string with the path if found else return the original path.

2.7 Application Data ([Link])

This module contains application values that remain unchanged during runtime. [Link] Boolean, set when blender is running in debug mode (started with -d) [Link].debug_value Int, number which can be set to non-zero values for testing purposes. [Link].driver_namespace Dictionary for drivers namespace, editable in-place, reset on le load (read-only) [Link] String, the temp directory used by blender (read-only) [Link] Boolean, True when blender is running without a user interface (started with -b) [Link].binary_path The location of blenders executable, useful for utilities that spawn new instances [Link].build_cflags C compiler ags [Link].build_cxxflags C++ compiler ags [Link].build_date The date this blender instance was built [Link].build_linkflags Binary linking ags [Link].build_platform The platform this blender instance was built for [Link].build_revision The subversion revision this blender instance was built with [Link].build_system Build system used [Link].build_time The time this blender instance was built [Link].build_type The type of build (Release, Debug) [Link] Application handler callbacks 2.7. Application Data ([Link]) 1173

Blender Index, Release 2.59.2 - API

[Link] The Blender version as a tuple of 3 numbers. eg. (2, 50, 11) [Link].version_char The Blender version character (for minor releases) [Link].version_cycle The release status of this build alpha/beta/rc/release [Link].version_string The Blender version formatted as a string [Link](value) -> integer return number of occurrences of value [Link](value, [start, [stop]]) -> integer return rst index of value. Raises ValueError if the value is not present.

2.8 Property Denitions ([Link])

This module denes properties to extend blenders internal data, the result of these functions is used to assign properties to classes registered with blender and cant be used directly.

2.8.1 Assigning to Existing Classes

Custom properties can be added to any subclass of an ID, Bone and PoseBone. These properties can be animated, accessed by the user interface and python like blenders existing properties.
import bpy # Assign a custom property to an existing type. [Link].custom_float = [Link](name="Test Prob") # Test the property is there. [Link][0].custom_float = 5.0

2.8.2 Operator Example

A common use of custom properties is for python based Operator classes.
import bpy

class DialogOperator([Link]): bl_idname = "object.dialog_operator" bl_label = "Property Example" my_float = [Link](name="Some Floating Point") my_bool = [Link](name="Toggle Option") my_string = [Link](name="String Value") def execute(self, context): print("Dialog Runs") return {FINISHED} def invoke(self, context, event): wm = context.window_manager

1174

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

return wm.invoke_props_dialog(self)

[Link].register_class(DialogOperator) # test call [Link].dialog_operator(INVOKE_DEFAULT)

2.8.3 PropertyGroup Example

PropertyGroups can be used for collecting custom settings into one value to avoid many indervidual settings mixed in together.
import bpy

class MaterialSettings([Link]): my_int = [Link]() my_float = [Link]() my_string = [Link]() [Link].register_class(MaterialSettings) [Link].my_settings = \ [Link](type=MaterialSettings) # test the new settings work material = [Link][0] material.my_settings.my_int = 5 material.my_settings.my_float = 3.0 material.my_settings.my_string = "Foo"

2.8.4 Collection Example

Custom properties can be added to any subclass of an ID, Bone and PoseBone.
import bpy

# Assign a collection class SceneSettingItem([Link]): name = [Link](name="Test Prop", default="Unknown") value = [Link](name="Test Prop", default=22) [Link].register_class(SceneSettingItem) [Link].my_settings = \ [Link](type=SceneSettingItem) # Assume an armature object selected print("Adding 3 values!") my_item = [Link].my_settings.add() my_item.name = "Spam"

2.8. Property Denitions ([Link])

1175

Blender Index, Release 2.59.2 - API

my_item.value = 1000 my_item = [Link].my_settings.add() my_item.name = "Eggs" my_item.value = 30 for my_item in [Link].my_settings: print(my_item.name, my_item.value)

2.8.5 Update Example

It can be useful to perform an action when a property is changed and can be used to update other properties or synchronize with external data. All properties dene update functions except for CollectionProperty.
import bpy

def update_func(self, context): print("my test function", self) [Link] = [Link](update=update_func) [Link] = 11.0 # >>> my test function <bpy_struct, Scene("Scene")>

[Link](name=, description=, default=False, options={ANIMATABLE}, subtype=NONE, update=None) Returns a new boolean property denition. Parameters name (string) Name used in the user interface. description (string) Text used for the tooltip and api documentation. options (set) Enumerator in [HIDDEN, SKIP_SAVE, ANIMATABLE]. subtype (string) Enumerator in [UNSIGNED, PERCENTAGE, FACTOR, ANGLE, TIME, DISTANCE, NONE]. update (function) function to be called when this value is modied, This function must take 2 values (self, context) and return None. [Link](name=, description=, default=(False, False, False), options={ANIMATABLE}, subtype=NONE, size=3, update=None) Returns a new vector boolean property denition. Parameters name (string) Name used in the user interface. description (string) Text used for the tooltip and api documentation. default (sequence) sequence of booleans the length of size. options (set) Enumerator in [HIDDEN, SKIP_SAVE, ANIMATABLE].

1176

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

subtype (string) Enumerator in [COLOR, TRANSLATION, DIRECTION, VELOCITY, ACCELERATION, MATRIX, EULER, QUATERNION, AXISANGLE, XYZ, COLOR_GAMMA, LAYER, NONE]. size (int) Vector dimensions in [1, and 32]. update (function) function to be called when this value is modied, This function must take 2 values (self, context) and return None. [Link](items, type=, description=, tions={ANIMATABLE}) Returns a new collection property denition. Parameters type (class) A subclass of [Link]. name (string) Name used in the user interface. description (string) Text used for the tooltip and api documentation. options (set) Enumerator in [HIDDEN, SKIP_SAVE, ANIMATABLE]. [Link](items, name=, description=, default=, options={ANIMATABLE}, update=None) Returns a new enumerator property denition. Parameters name (string) Name used in the user interface. description (string) Text used for the tooltip and api documentation. default (string or set) The default value for this enum, A string when ENUM_FLAG is disabled otherwise a set which may only contain string identiers used in items. options (set) ENUM_FLAG]. Enumerator in [HIDDEN, SKIP_SAVE, ANIMATABLE, default=, op-

items (sequence of string triplets or a function) sequence of enum items formatted: [(identier, name, description), ...] where the identier is used for python access and other values are used for the interface. For dynamic values a callback can be passed which returns a list in the same format as the static list. This function must take 2 arguments (self, context) update (function) function to be called when this value is modied, This function must take 2 values (self, context) and return None. [Link](name=, description=, default=0.0, min=sys.oat_info.min, max=sys.oat_info.max, soft_min=sys.oat_info.min, soft_max=sys.oat_info.max, step=3, precision=2, options={ANIMATABLE}, subtype=NONE, unit=NONE, update=None) Returns a new oat property denition. Parameters name (string) Name used in the user interface. description (string) Text used for the tooltip and api documentation. options (set) Enumerator in [HIDDEN, SKIP_SAVE, ANIMATABLE]. subtype (string) Enumerator in [UNSIGNED, PERCENTAGE, FACTOR, ANGLE, TIME, DISTANCE, NONE]. unit (string) Enumerator in [NONE, LENGTH, AREA, VOLUME, ROTATION, TIME, VELOCITY, ACCELERATION].

2.8. Property Denitions ([Link])

1177

Blender Index, Release 2.59.2 - API

update (function) function to be called when this value is modied, This function must take 2 values (self, context) and return None. [Link](name=, description=, default=(0.0, 0.0, 0.0), min=sys.oat_info.min, max=sys.oat_info.max, soft_min=sys.oat_info.min, soft_max=sys.oat_info.max, step=3, precision=2, options={ANIMATABLE}, subtype=NONE, size=3, update=None) Returns a new vector oat property denition. Parameters name (string) Name used in the user interface. description (string) Text used for the tooltip and api documentation. default (sequence) sequence of oats the length of size. options (set) Enumerator in [HIDDEN, SKIP_SAVE, ANIMATABLE]. subtype (string) Enumerator in [COLOR, TRANSLATION, DIRECTION, VELOCITY, ACCELERATION, MATRIX, EULER, QUATERNION, AXISANGLE, XYZ, COLOR_GAMMA, LAYER, NONE]. unit (string) Enumerator in [NONE, LENGTH, AREA, VOLUME, ROTATION, TIME, VELOCITY, ACCELERATION]. size (int) Vector dimensions in [1, and 32]. update (function) function to be called when this value is modied, This function must take 2 values (self, context) and return None. [Link](name=, description=, default=0, min=-[Link], max=[Link], soft_min=-[Link], soft_max=[Link], step=1, options={ANIMATABLE}, subtype=NONE, update=None) Returns a new int property denition. Parameters name (string) Name used in the user interface. description (string) Text used for the tooltip and api documentation. options (set) Enumerator in [HIDDEN, SKIP_SAVE, ANIMATABLE]. subtype (string) Enumerator in [UNSIGNED, PERCENTAGE, FACTOR, ANGLE, TIME, DISTANCE, NONE]. update (function) function to be called when this value is modied, This function must take 2 values (self, context) and return None. [Link](name=, description=, default=(0, 0, 0), min=-[Link], max=[Link], soft_min=-[Link], soft_max=[Link], options={ANIMATABLE}, subtype=NONE, size=3, update=None) Returns a new vector int property denition. Parameters name (string) Name used in the user interface. description (string) Text used for the tooltip and api documentation. default (sequence) sequence of ints the length of size. options (set) Enumerator in [HIDDEN, SKIP_SAVE, ANIMATABLE].

1178

Chapter 2. Application Modules

Blender Index, Release 2.59.2 - API

subtype (string) Enumerator in [COLOR, TRANSLATION, DIRECTION, VELOCITY, ACCELERATION, MATRIX, EULER, QUATERNION, AXISANGLE, XYZ, COLOR_GAMMA, LAYER, NONE]. size (int) Vector dimensions in [1, and 32]. update (function) function to be called when this value is modied, This function must take 2 values (self, context) and return None. [Link](type=, description=, options={ANIMATABLE}, update=None) Returns a new pointer property denition. Parameters type (class) A subclass of [Link]. name (string) Name used in the user interface. description (string) Text used for the tooltip and api documentation. options (set) Enumerator in [HIDDEN, SKIP_SAVE, ANIMATABLE]. update (function) function to be called when this value is modied, This function must take 2 values (self, context) and return None. [Link](attr) Removes a dynamically dened property. Parameters attr (string) Property name. [Link](name=, description=, default=, maxlen=0, tions={ANIMATABLE}, subtype=NONE, update=None) Returns a new string property denition. Parameters name (string) Name used in the user interface. description (string) Text used for the tooltip and api documentation. options (set) Enumerator in [HIDDEN, SKIP_SAVE, ANIMATABLE]. subtype (string) Enumerator in [FILE_PATH, DIR_PATH, FILENAME, NONE]. update (function) function to be called when this value is modied, This function must take 2 values (self, context) and return None. op-

2.8. Property Denitions ([Link])

1179

Blender Index, Release 2.59.2 - API

1180

Chapter 2. Application Modules

CHAPTER

THREE

STANDALONE MODULES
3.1 Math Types & Utilities (mathutils)
This module provides access to matrices, eulers, quaternions and vectors.
import mathutils from math import radians vec = [Link]((1.0, 2.0, 3.0)) mat_rot = [Link](radians(90.0), 4, X) mat_trans = [Link](vec) mat = mat_trans * mat_rot [Link]() mat3 = mat.to_3x3() quat1 = mat.to_quaternion() quat2 = mat3.to_quaternion() quat_diff = quat1.rotation_difference(quat2) print(quat_diff.angle)

class [Link] This object gives access to Colors in Blender. copy() Returns a copy of this color. Returns A copy of the color. Return type Color Note: use this to get a copy of a wrapped color with no reference to the original data. b Blue color channel. Type oat g Green color channel.

1181

Blender Index, Release 2.59.2 - API

Type oat h HSV Hue component in [0, 1]. Type oat hsv HSV Values in [0, 1]. Type oat triplet is_wrapped True when this object wraps external data (readonly). Type boolean owner The item this is wrapping or None (readonly). r Red color channel. Type oat s HSV Saturation component in [0, 1]. Type oat v HSV Value component in [0, 1]. Type oat class [Link] This object gives access to Eulers in Blender.
import mathutils # todo

copy() Returns a copy of this euler. Returns A copy of the euler. Return type Euler Note: use this to get a copy of a wrapped euler with no reference to the original data. make_compatible(other) Make this euler compatible with another, so interpolating between them works as intended. Note: the rotation order is not taken into account for this function. rotate(other) Rotates the euler a by another mathutils value. Parameters other (Euler, Quaternion or Matrix) rotation component of mathutils value

1182

Chapter 3. Standalone Modules

Blender Index, Release 2.59.2 - API

rotate_axis(axis, angle) Rotates the euler a certain amount and returning a unique euler rotation (no 720 degree pitches). Parameters axis (string) single character in [X, Y, Z]. angle (oat) angle in radians. to_matrix() Return a matrix representation of the euler. Returns A 3x3 roation matrix representation of the euler. Return type Matrix to_quaternion() Return a quaternion representation of the euler. Returns Quaternion representation of the euler. Return type Quaternion zero() Set all values to zero. is_wrapped True when this object wraps external data (readonly). Type boolean order Euler rotation order. Type string in [XYZ, XZY, YXZ, YZX, ZXY, ZYX] owner The item this is wrapping or None (readonly). x Euler X axis in radians. Type oat y Euler Y axis in radians. Type oat z Euler Z axis in radians. Type oat class [Link] This object gives access to Matrices in Blender.
import mathutils # todo

classmethod OrthoProjection(axis, size) Create a matrix to represent an orthographic projection. Parameters

3.1. Math Types & Utilities (mathutils)

1183

Blender Index, Release 2.59.2 - API

axis (string or Vector) Can be any of the following: [X, Y, XY, XZ, YZ], where a single axis is for a 2D matrix. Or a vector for an arbitrary axis size (int) The size of the projection matrix to construct [2, 4]. Returns A new projection matrix. Return type Matrix classmethod Rotation(angle, size, axis) Create a matrix representing a rotation. Parameters angle (oat) The angle of rotation desired, in radians. size (int) The size of the rotation matrix to construct [2, 4]. axis (string or Vector) a string in [X, Y, Z] or a 3D Vector Object (optional when size is 2). Returns A new rotation matrix. Return type Matrix classmethod Scale(factor, size, axis) Create a matrix representing a scaling. Parameters factor (oat) The factor of scaling to apply. size (int) The size of the scale matrix to construct [2, 4]. axis (Vector) Direction to inuence scale. (optional). Returns A new scale matrix. Return type Matrix classmethod Shear(plane, size, factor) Create a matrix to represent an shear transformation. Parameters plane (string) Can be any of the following: [X, Y, XY, XZ, YZ], where a single axis is for a 2D matrix only. size (int) The size of the shear matrix to construct [2, 4]. factor (oat or oat pair) The factor of shear to apply. For a 3 or 4 size matrix pass a pair of oats corrasponding with the plane axis. Returns A new shear matrix. Return type Matrix classmethod Translation(vector) Create a matrix representing a translation. Parameters vector (Vector) The translation vector. Returns An identity matrix with a translation. Return type Matrix copy() Returns a copy of this matrix.

1184

Chapter 3. Standalone Modules

Blender Index, Release 2.59.2 - API

Returns an instance of itself Return type Matrix decompose() Return the location, rotaion and scale components of this matrix. Returns loc, rot, scale triple. Return type (Vector, Quaternion, Vector) determinant() Return the determinant of a matrix. Returns Return a the determinant of a matrix. Return type oat See Also: <[Link] identity() Set the matrix to the identity matrix. Note: An object with zero location and rotation, a scale of one, will have an identity matrix. See Also: <[Link] invert() Set the matrix to its inverse. See Also: <[Link] inverted() Return an inverted copy of the matrix. Returns the inverted matrix. Return type Matrix lerp(other, factor) Returns the interpolation of two matricies. Parameters other (Matrix) value to interpolate with. factor (oat) The interpolation value in [0.0, 1.0]. Returns The interpolated rotation. Return type Matrix resize_4x4() Resize the matrix to 4x4. rotate(other) Rotates the matrix a by another mathutils value. Parameters other (Euler, Quaternion or Matrix) rotation component of mathutils value

3.1. Math Types & Utilities (mathutils)

1185

Blender Index, Release 2.59.2 - API

Note: If any of the columns are not unit length this may not have desired results. to_3x3() Return a 3x3 copy of this matrix. Returns a new matrix. Return type Matrix to_4x4() Return a 4x4 copy of this matrix. Returns a new matrix. Return type Matrix to_euler(order, euler_compat) Return an Euler representation of the rotation matrix (3x3 or 4x4 matrix only). Parameters order (string) Optional rotation order argument in [XYZ, XZY, YXZ, YZX, ZXY, ZYX]. euler_compat (Euler) Optional euler argument the new euler will be made compatible with (no axis ipping between them). Useful for converting a series of matrices to animation curves. Returns Euler representation of the matrix. Return type Euler to_quaternion() Return a quaternion representation of the rotation matrix. Returns Quaternion representation of the rotation matrix. Return type Quaternion to_scale() Return a the scale part of a 3x3 or 4x4 matrix. Returns Return a the scale of a matrix. Return type Vector Note: This method does not return negative a scale on any axis because it is not possible to obtain this data from the matrix alone. to_translation() Return a the translation part of a 4 row matrix. Returns Return a the translation of a matrix. Return type Vector transpose() Set the matrix to its transpose. See Also: <[Link]

1186

Chapter 3. Standalone Modules

Blender Index, Release 2.59.2 - API

transposed() Return a new, transposed matrix. Returns a transposed matrix Return type Matrix zero() Set all the matrix values to zero. Returns an instance of itself Return type Matrix col_size The column size of the matrix (readonly). Type int is_negative True if this matrix results in a negative scale, 3x3 and 4x4 only, (readonly). Type bool is_orthogonal True if this matrix is orthogonal, 3x3 and 4x4 only, (readonly). Type bool is_wrapped True when this object wraps external data (readonly). Type boolean median_scale The average scale applied to each axis (readonly). Type oat owner The item this is wrapping or None (readonly). row_size The row size of the matrix (readonly). Type int class [Link] This object gives access to Quaternions in Blender.
import mathutils # todo

conjugate() Set the quaternion to its conjugate (negate x, y, z). conjugated() Return a new conjugated quaternion. Returns a new quaternion. Return type Quaternion copy() Returns a copy of this quaternion.

3.1. Math Types & Utilities (mathutils)

1187

Blender Index, Release 2.59.2 - API

Returns A copy of the quaternion. Return type Quaternion Note: use this to get a copy of a wrapped quaternion with no reference to the original data. cross(other) Return the cross product of this quaternion and another. Parameters other (Quaternion) The other quaternion to perform the cross product with. Returns The cross product. Return type Quaternion dot(other) Return the dot product of this quaternion and another. Parameters other (Quaternion) The other quaternion to perform the dot product with. Returns The dot product. Return type Quaternion identity() Set the quaternion to an identity quaternion. Returns an instance of itself. Return type Quaternion invert() Set the quaternion to its inverse. inverted() Return a new, inverted quaternion. Returns the inverted value. Return type Quaternion negate() Set the quaternion to its negative. Returns an instance of itself. Return type Quaternion normalize() Normalize the quaternion. normalized() Return a new normalized quaternion. Returns a normalized copy. Return type Quaternion rotate(other) Rotates the quaternion a by another mathutils value. Parameters other (Euler, Quaternion or Matrix) rotation component of mathutils value difference(other) Returns a quaternion representing the rotational difference. 1188 Chapter 3. Standalone Modules

Blender Index, Release 2.59.2 - API

Parameters other (Quaternion) second quaternion. Returns the rotational difference between the two quat rotations. Return type Quaternion slerp(other, factor) Returns the interpolation of two quaternions. Parameters other (Quaternion) value to interpolate with. factor (oat) The interpolation value in [0.0, 1.0]. Returns The interpolated rotation. Return type Quaternion to_euler(order, euler_compat) Return Euler representation of the quaternion. Parameters order (string) Optional rotation order argument in [XYZ, XZY, YXZ, YZX, ZXY, ZYX]. euler_compat (Euler) Optional euler argument the new euler will be made compatible with (no axis ipping between them). Useful for converting a series of matrices to animation curves. Returns Euler representation of the quaternion. Return type Euler to_matrix() Return a matrix representation of the quaternion. Returns A 3x3 rotation matrix representation of the quaternion. Return type Matrix angle angle of the quaternion. Type oat axis quaternion axis as a vector. Type Vector is_wrapped True when this object wraps external data (readonly). Type boolean magnitude Size of the quaternion (readonly). Type oat owner The item this is wrapping or None (readonly). w Quaternion W value.

3.1. Math Types & Utilities (mathutils)

1189

Blender Index, Release 2.59.2 - API

Type oat x Quaternion X axis. Type oat y Quaternion Y axis. Type oat z Quaternion Z axis. Type oat class [Link] This object gives access to Vectors in Blender.
import mathutils # zero length vector vec = [Link]((0.0, 0.0, 1.0)) # unit length vector vec_a = [Link]().normalize() vec_b = [Link]((0.0, 1.0, 2.0)) vec2d = [Link]((1.0, 2.0)) vec3d = [Link]((1.0, 0.0, 0.0)) vec4d = vec_a.to_4d() # other mathutuls types quat = [Link]() matrix = [Link]() # Comparison operators can be done on Vector classes: # greater and less then test vector length. vec_a > vec_b vec_a >= vec_b vec_a < vec_b vec_a <= vec_b # ==, != test vector values e.g. 1,2,3 != 3,2,1 even if they are the same length vec_a == vec_b vec_a != vec_b

# Math can be performed on Vector classes vec_a + vec_b vec_a - vec_b vec_a * vec_b vec_a * 10.0 matrix * vec_a quat * vec_a vec_a * vec_b -vec_a

1190

Chapter 3. Standalone Modules

Blender Index, Release 2.59.2 - API

# You can access a vector object like a sequence x = vec_a[0] len(vec) vec_a[:] = vec_b vec_a[:] = 1.0, 2.0, 3.0 vec2d[:] = vec3d[:2]

# Vectors support swizzle operations # See [Link] [Link] = [Link] [Link] = [Link] [Link] = [Link] [Link] = [Link]

angle(other, fallback) Return the angle between two vectors. Parameters other (Vector) another vector to compare the angle with fallback (any) return this value when the angle cant be calculated (zero length vector) Returns angle in radians or fallback when given Return type oat Note: Zero length vectors raise an AttributeError. copy() Returns a copy of this vector. Returns A copy of the vector. Return type Vector Note: use this to get a copy of a wrapped vector with no reference to the original data. cross(other) Return the cross product of this vector and another. Parameters other (Vector) The other vector to perform the cross product with. Returns The cross product. Return type Vector Note: both vectors must be 3D dot(other) Return the dot product of this vector and another. Parameters other (Vector) The other vector to perform the dot product with. Returns The dot product. Return type Vector

3.1. Math Types & Utilities (mathutils)

1191

Blender Index, Release 2.59.2 - API

Blender Index, Release 2.59.2 - API

zzxx Undocumented (contribute) zzxy Undocumented (contribute) zzxz Undocumented (contribute) zzy Undocumented (contribute) zzyw Undocumented (contribute) zzyx Undocumented (contribute) zzyy Undocumented (contribute) zzyz Undocumented (contribute) zzz Undocumented (contribute) zzzw Undocumented (contribute) zzzx Undocumented (contribute) zzzy Undocumented (contribute) zzzz Undocumented (contribute)

3.2 Geometry Utilities ([Link])

The Blender geometry module [Link].area_tri(v1, v2, v3) Returns the area size of the 2D or 3D triangle dened. Parameters v1 ([Link]) Point1 v2 ([Link]) Point2 v3 ([Link]) Point3 Return type oat [Link].barycentric_transform(point, tri_a1, tri_a2, tri_a3, tri_b1, tri_b2, tri_b3) Return a transformed point, the transformation is dened by 2 triangles. Parameters point ([Link]) The point to transform.

1210

Chapter 3. Standalone Modules

Blender Index, Release 2.59.2 - API

tri_a1 ([Link]) source triangle vertex. tri_a2 ([Link]) source triangle vertex. tri_a3 ([Link]) source triangle vertex. tri_a1 target triangle vertex. tri_a2 target triangle vertex. tri_a3 target triangle vertex. Returns The transformed point Return type [Link] [Link].box_pack_2d(boxes) Returns the normal of the 3D tri or quad. Parameters boxes (list) list of boxes, each box is a list where the rst 4 items are [x, y, width, height, ...] other items are ignored. Returns the width and height of the packed bounding box Return type tuple, pair of oats [Link].interpolate_bezier(knot1, handle1, handle2, knot2, resolution) Interpolate a bezier spline segment. Parameters knot1 ([Link]) First bezier spline point. handle1 ([Link]) First bezier spline handle. handle2 ([Link]) Second bezier spline handle. knot2 ([Link]) Second bezier spline point. resolution (int) Number of points to return. Returns The interpolated points Return type list of [Link] [Link].intersect_line_line(v1, v2, v3, v4) Returns a tuple with the points on each line respectively closest to the other. Parameters v1 ([Link]) First point of the rst line v2 ([Link]) Second point of the rst line v3 ([Link]) First point of the second line v4 ([Link]) Second point of the second line Return type tuple of [Link] [Link].intersect_line_line_2d(lineA_p1, lineA_p2, lineB_p1, lineB_p2) Takes 2 lines (as 4 vectors) and returns a vector for their point of intersection or None. Parameters lineA_p1 ([Link]) First point of the rst line lineA_p2 ([Link]) Second point of the rst line lineB_p1 ([Link]) First point of the second line

3.2. Geometry Utilities ([Link])

1211

Blender Index, Release 2.59.2 - API

lineB_p2 ([Link]) Second point of the second line Returns The point of intersection or None when not found Return type [Link] or None [Link].intersect_line_plane(line_a, line_b, plane_co, plane_no, no_ip=False) Takes 2 lines (as 4 vectors) and returns a vector for their point of intersection or None. Parameters line_a ([Link]) First point of the rst line line_b ([Link]) Second point of the rst line plane_co ([Link]) A point on the plane plane_no ([Link]) The direction the plane is facing no_ip (:boolean) Always return an intersection on the directon dened bt line_a -> line_b Returns The point of intersection or None when not found Return type [Link] or None [Link].intersect_line_sphere(line_a, line_b, sphere_co, clip=True) Takes a lines (as 2 vectors), a sphere as a point and a radius and returns the intersection Parameters line_a ([Link]) First point of the rst line line_b ([Link]) Second point of the rst line sphere_co ([Link]) The center of the sphere sphere_radius (sphere_radius) Radius of the sphere Returns The intersection points as a pair of vectors or None when there is no intersection Return type A tuple pair containing [Link] or None [Link].intersect_line_sphere_2d(line_a, line_b, sphere_co, sphere_radius, clip=True) Takes a lines (as 2 vectors), a sphere as a point and a radius and returns the intersection Parameters line_a ([Link]) First point of the rst line line_b ([Link]) Second point of the rst line sphere_co ([Link]) The center of the sphere sphere_radius (sphere_radius) Radius of the sphere Returns The intersection points as a pair of vectors or None when there is no intersection Return type A tuple pair containing [Link] or None [Link].intersect_point_line(pt, line_p1, line_p2) Takes a point and a line and returns a tuple with the closest point on the line and its distance from the rst point of the line as a percentage of the length of the line. Parameters pt ([Link]) Point line_p1 ([Link]) First point of the line 1212 Chapter 3. Standalone Modules sphere_radius,

Blender Index, Release 2.59.2 - API

Chapter 3. Standalone Modules

1236

Chapter 3. Standalone Modules

Blender Index, Release 2.59.2 - API

glRenderMode(mode): Set rasterization mode See Also: OpenGL Docs Parameters mode (Enumerated constant) Species the rasterization mode. glRotate (angle, x, y, z): B{glRotated, glRotatef} Multiply the current matrix by a rotation matrix See Also: OpenGL Docs Parameters angle (Depends on function prototype.) Species the angle of rotation in degrees. y, z (x,) Specify the x, y, and z coordinates of a vector respectively. glScale (x,y,z): B{glScaled, glScalef} Multiply the current matrix by a general scaling matrix See Also: OpenGL Docs Parameters y, z (x,) Specify scale factors along the x, y, and z axes, respectively. glScissor(x,y,width,height): Dene the scissor box See Also: OpenGL Docs Parameters y (x,) Specify the lower left corner of the scissor box. Initially (0, 0). height (width) Specify the width and height of the scissor box. When a GL context is rst attached to a window, width and height are set to the dimensions of that window. glSelectBuffer(size, buffer): Establish a buffer for selection mode values See Also: OpenGL Docs Parameters size (int) Species the size of buffer buffer ([Link] I{type GL_INT}) Returns the selection data

3.3. OpenGL Wrapper (bgl)

1237

Blender Index, Release 2.59.2 - API

glShadeModel(mode): Select at or smooth shading See Also: OpenGL Docs Parameters mode (Enumerated constant) Species a symbolic value representing a shading technique. glStencilFuc(func, ref, mask): Set function and reference value for stencil testing See Also: OpenGL Docs Parameters func (Enumerated constant) Species the test function. ref (int) Species the reference value for the stencil test. ref is clamped to the range [0,2n-1], where n is the number of bitplanes in the stencil buffer. The initial value is 0. mask (unsigned int) Species a mask that is ANDed with both the reference value and the stored stencil value when the test is done. The initial value is all 1s. glStencilMask(mask): Control the writing of individual bits in the stencil planes See Also: OpenGL Docs Parameters mask (unsigned int) Species a bit mask to enable and disable writing of individual bits in the stencil planes. Initially, the mask is all 1s. glStencilOp(fail, zfail, zpass): Set stencil test actions See Also: OpenGL Docs Parameters fail (Enumerated constant) Species the action to take when the stencil test fails. The initial value is GL_KEEP. zfail (Enumerated constant) Species the stencil action when the stencil test passes, but the depth test fails. zfail accepts the same symbolic constants as fail. The initial value is GL_KEEP. zpass (Enumerated constant) Species the stencil action when both the stencil test and the depth test pass, or when the stencil test passes and either there is no depth buffer or depth testing is not enabled. zpass accepts the same symbolic constants as fail. The initial value is GL_KEEP. glTexCoord (s,t,r,q,v): B{glTexCoord1d, glTexCoord1f, glTexCoord1i, glTexCoord1s, glTexCoord2d, glTexCoord2f, glTexCoord2i, glTexCoord2s, glTexCoord3d, glTexCoord3f, glTexCoord3i, glTexCoord3s, glTexCoord4d, glTexCoord4f, glTexCoord4i, glTexCoord4s, glTexCoord1dv, glTexCoord1fv, glTexCoord1iv, glTexCoord1sv, glTexCoord2dv,

1238

Chapter 3. Standalone Modules

Blender Index, Release 2.59.2 - API

glTexCoord2fv, glTexCoord2iv, glTexCoord2sv, glTexCoord3dv, glTexCoord3fv, glTexCoord3iv, glTexCoord3sv, glTexCoord4dv, glTexCoord4fv, glTexCoord4iv, glTexCoord4sv} Set the current texture coordinates See Also: OpenGL Docs Parameters t, r, q (s,) Specify s, t, r, and q texture coordinates. Not all parameters are present in all forms of the command. v ([Link] object. Depends on function prototype. (for v prototypes only)) Species a pointer to an array of one, two, three, or four elements, which in turn specify the s, t, r, and q texture coordinates. glTexEnv (target, pname, param): B{glTextEnvf, glTextEnvi, glTextEnvfv, glTextEnviv} Set texture environment parameters See Also: OpenGL Docs Parameters target (Enumerated constant) Species a texture environment. GL_TEXTURE_ENV. Must be

pname (Enumerated constant) Species the symbolic name of a single-valued texture environment parameter. Must be GL_TEXTURE_ENV_MODE. param (Depends on function prototype.) Species a single symbolic constant. If function prototype ends in v species a pointer to a parameter array that contains either a single symbolic constant or an RGBA color glTexGen (coord, pname, param): B{glTexGend, glTexGenf, glTexGeni, glTexGendv, glTexGenfv, glTexGeniv} Control the generation of texture coordinates See Also: OpenGL Docs Parameters coord (Enumerated constant) Species a texture coordinate. pname (Enumerated constant) Species the symbolic name of the texture- coordinate generation function. param (Depends on function prototype.) Species a single-valued texture generation parameter. If function prototype ends in v species a pointer to an array of texture generation parameters. If pname is GL_TEXTURE_GEN_MODE, then the array must contain a single symbolic constant. Otherwise, params holds the coefcients for the texture-coordinate generation function specied by pname. glTexImage1D(target, level, internalformat, width, border, format, type, pixels): Specify a one-dimensional texture image

3.3. OpenGL Wrapper (bgl)

1239

Blender Index, Release 2.59.2 - API

See Also: OpenGL Docs Parameters target (Enumerated constant) Species the target texture. level (int) Species the level-of-detail number. Level 0 is the base image level. Level n is the nth mipmap reduction image. internalformat (int) Species the number of color components in the texture. width (int) Species the width of the texture image. Must be 2n+2(border) for some integer n. All implementations support texture images that are at least 64 texels wide. The height of the 1D texture image is 1. border (int) Species the width of the border. Must be either 0 or 1. format (Enumerated constant) Species the format of the pixel data. type (Enumerated constant) Species the data type of the pixel data. pixels ([Link] object.) Species a pointer to the image data in memory. glTexImage2D(target, level, internalformat, width, height, border, format, type, pixels): Specify a two-dimensional texture image See Also: OpenGL Docs Parameters target (Enumerated constant) Species the target texture. level (int) Species the level-of-detail number. Level 0 is the base image level. Level n is the nth mipmap reduction image. internalformat (int) Species the number of color components in the texture. width (int) Species the width of the texture image. Must be 2n+2(border) for some integer n. All implementations support texture images that are at least 64 texels wide. height (int) Species the height of the texture image. Must be 2m+2(border) for some integer m. All implementations support texture images that are at least 64 texels high. border (int) Species the width of the border. Must be either 0 or 1. format (Enumerated constant) Species the format of the pixel data. type (Enumerated constant) Species the data type of the pixel data. pixels ([Link] object.) Species a pointer to the image data in memory. glTexParameter (target, pname, param): B{glTexParameterf, glTexParameteri, glTexParameterfv, glTexParameteriv} Set texture parameters See Also: OpenGL Docs Parameters target (Enumerated constant) Species the target texture.

1240

Chapter 3. Standalone Modules

Blender Index, Release 2.59.2 - API

pname (Enumerated constant) Species the symbolic name of a single-valued texture parameter. param (Depends on function prototype.) Species the value of pname. If function prototype ends in v species a pointer to an array where the value or values of pname are stored. glTranslate (x, y, z): B{glTranslatef, glTranslated} Multiply the current matrix by a translation matrix See Also: OpenGL Docs Parameters y, z (x,) Specify the x, y, and z coordinates of a translation vector. glVertex (x,y,z,w,v): B{glVertex2d, glVertex2f, glVertex2i, glVertex2s, glVertex3d, glVertex3f, glVertex3i, glVertex3s, glVertex4d, glVertex4f, glVertex4i, glVertex4s, glVertex2dv, glVertex2fv, glVertex2iv, glVertex2sv, glVertex3dv, glVertex3fv, glVertex3iv, glVertex3sv, glVertex4dv, glVertex4fv, glVertex4iv, glVertex4sv} Specify a vertex See Also: OpenGL Docs Parameters y, z, w (x,) Specify x, y, z, and w coordinates of a vertex. Not all parameters are present in all forms of the command. v ([Link] object. Depends of function prototype (for v prototypes only)) Species a pointer to an array of two, three, or four elements. The elements of a two-element array are x and y; of a three-element array, x, y, and z; and of a four-element array, x, y, z, and w. glViewport(x,y,width,height): Set the viewport See Also: OpenGL Docs Parameters y (x,) Specify the lower left corner of the viewport rectangle, in pixels. The initial value is (0,0). height (width,) Specify the width and height of the viewport. When a GL context is rst attached to a window, width and height are set to the dimensions of that window. gluPerspective(fovY, aspect, zNear, zFar): Set up a perspective projection matrix. See Also:

U{[Link] Parameters fovY (double) Species the eld of view angle, in degrees, in the y direction.

3.3. OpenGL Wrapper (bgl)

1241

Blender Index, Release 2.59.2 - API

aspect (double) Species the aspect ratio that determines the eld of view in the x direction. The aspect ratio is the ratio of x (width) to y (height). zNear (double) Species the distance from the viewer to the near clipping plane (always positive). zFar (double) Species the distance from the viewer to the far clipping plane (always positive). gluLookAt(eyex, eyey, eyez, centerx, centery, centerz, upx, upy, upz): Dene a viewing transformation. See Also:

U{[Link] Parameters eyey, eyez (eyex,) Species the position of the eye point. centery, centerz (centerx,) Species the position of the reference point. upy, upz (upx,) Species the direction of the up vector. gluOrtho2D(left, right, bottom, top): Dene a 2-D orthographic projection matrix. See Also:

U{[Link] Parameters right (left,) Specify the coordinates for the left and right vertical clipping planes. top (bottom,) Specify the coordinates for the bottom and top horizontal clipping planes. gluPickMatrix(x, y, width, height, viewport): Dene a picking region. See Also:

U{[Link] Parameters y (x,) Specify the center of a picking region in window coordinates. height (width,) Specify the width and height, respectively, of the picking region in window coordinates. viewport ([Link] object. [int]) Species the current viewport. gluProject(objx, objy, objz, modelMatrix, projMatrix, viewport, winx, winy, winz): Map object coordinates to window coordinates. See Also:

U{[Link] Parameters objy, objz (objx,) Specify the object coordinates. modelMatrix ([Link] object. [double]) Species the current modelview matrix (as from a glGetDoublev call).

1242

Chapter 3. Standalone Modules

Blender Index, Release 2.59.2 - API

projMatrix ([Link] object. [double]) Species the current projection matrix (as from a glGetDoublev call). viewport ([Link] object. [int]) Species the current viewport (as from a glGetIntegerv call). winy, winz (winx,) Return the computed window coordinates. gluUnProject(winx, winy, winz, modelMatrix, projMatrix, viewport, objx, objy, objz): Map object coordinates to window coordinates. See Also:

U{[Link] Parameters winy, winz (winx,) Specify the window coordinates to be mapped. modelMatrix ([Link] object. [double]) Species the current modelview matrix (as from a glGetDoublev call). projMatrix ([Link] object. [double]) Species the current projection matrix (as from a glGetDoublev call). viewport ([Link] object. [int]) Species the current viewport (as from a glGetIntegerv call). objy, objz (objx,) Return the computed object coordinates. class Buffer: The Buffer object is simply a block of memory that is delineated and initialized by the user. Many OpenGL functions return data to a C-style pointer, however, because this is not possible in python the Buffer object can be used to this end. Wherever pointer notation is used in the OpenGL functions the Buffer object can be used in its bgl wrapper. In some instances the Buffer object will need to be initialized with the template parameter, while in other instances the user will want to create just a blank buffer which will be zeroed by default.
import bgl myByteBuffer = [Link](bgl.GL_BYTE, [32, 32]) [Link](myByteBuffer) print([Link]) print(myByteBuffer.to_list()) sliceBuffer = myByteBuffer[0:16] print(sliceBuffer)

[Link] The number of dimensions of the Buffer. bgl.to_list() The contents of the Buffer as a python list. __init__(type, dimensions, template = None): This will create a new Buffer object for use with other bgl OpenGL commands. Only the type of argument to store in the buffer and the dimensions of the buffer are necessary. Buffers are zeroed by default unless a template is supplied, in which case the buffer is initialized to the template. Parameters

3.3. OpenGL Wrapper (bgl)

1243

Blender Index, Release 2.59.2 - API

type (int) The format to store data in. The type should be one of GL_BYTE, GL_SHORT, GL_INT, or GL_FLOAT. dimensions (An int or sequence object specifying the dimensions of the buffer.) If the dimensions are specied as an int a linear array will be created for the buffer. If a sequence is passed for the dimensions, the buffer becomes n-Dimensional, where n is equal to the number of parameters passed in the sequence. Example: [256,2] is a two- dimensional buffer while [256,256,4] creates a three- dimensional buffer. You can think of each additional dimension as a sub-item of the dimension to the left. i.e. [10,2] is a 10 element array each with 2 sub-items. [(0,0), (0,1), (1,0), (1,1), (2,0), ...] etc. template (A python sequence object (optional)) A sequence of matching dimensions which will be used to initialize the Buffer. If a template is not passed in all elds will be initialized to 0. Return type Buffer object Returns The newly created buffer as a PyObject.

3.4 Font Drawing (blf)

This module provides access to blenders text drawing functions.

3.4.1 Hello World Text Example

Blender Game Engine example of using the blf module. For this module to work we need to use the OpenGL wrapper bgl as well.
# import game engine modules from bge import render from bge import logic # import stand alone modules import bgl import blf

def init(): """init function - runs once""" # create a new font object, use external ttf file font_path = [Link](//[Link]) # store the font indice - to use later logic.font_id = [Link](font_path) # set the font drawing routine to run every frame scene = [Link]() scene.post_draw = [write]

def write(): """write on screen""" width = [Link]() height = [Link]() # OpenGL setup [Link](bgl.GL_PROJECTION)

1244

Chapter 3. Standalone Modules

Blender Index, Release 2.59.2 - API

[Link]() bgl.gluOrtho2D(0, width, 0, height) [Link](bgl.GL_MODELVIEW) [Link]() # BLF drawing routine font_id = logic.font_id [Link](font_id, (width * 0.2), (height * 0.3), 0) [Link](font_id, 50, 72) [Link](font_id, "Hello World")

[Link] constant value 2 blf.KERNING_DEFAULT constant value 8 [Link] constant value 1 [Link] constant value 4 [Link](fontid, aspect) Set the aspect for drawing text. Parameters fontid (int) The id of the typeface as returned by [Link](), for default font use 0. aspect (oat) The aspect ratio for text drawing to use. [Link](fontid, radius) Set the blur radius for drawing text. Parameters fontid (int) The id of the typeface as returned by [Link](), for default font use 0. radius (int) The radius for blurring text (in pixels). [Link](fontid, xmin, ymin, xmax, ymax) Set the clipping, enable/disable using CLIPPING. Parameters fontid (int) The id of the typeface as returned by [Link](), for default font use 0. xmin (oat) Clip the drawing area by these bounds. ymin (oat) Clip the drawing area by these bounds. xmax (oat) Clip the drawing area by these bounds. ymax (oat) Clip the drawing area by these bounds. [Link](fontid, text) Return the width and height of the text. Parameters fontid (int) The id of the typeface as returned by [Link](), for default font use 0. text (string) the text to draw. Returns the width and height of the text.

3.4. Font Drawing (blf)

1245

Blender Index, Release 2.59.2 - API

Return type tuple of 2 oats [Link](fontid, option) Disable option. Parameters fontid (int) The id of the typeface as returned by [Link](), for default font use 0. option (int) One of ROTATION, CLIPPING, SHADOW or KERNING_DEFAULT. [Link](fontid, text) Draw text in the current context. Parameters fontid (int) The id of the typeface as returned by [Link](), for default font use 0. text (string) the text to draw. [Link](fontid, option) Enable option. Parameters fontid (int) The id of the typeface as returned by [Link](), for default font use 0. option (int) One of ROTATION, CLIPPING, SHADOW or KERNING_DEFAULT. [Link](lename) Load a new font. Parameters lename (string) the lename of the font. Returns the new fonts fontid or -1 if there was an error. Return type integer [Link](fontid, x, y, z) Set the position for drawing text. Parameters fontid (int) The id of the typeface as returned by [Link](), for default font use 0. x (oat) X axis position to draw the text. y (oat) Y axis position to draw the text. z (oat) Z axis position to draw the text. [Link](fontid, angle) Set the text rotation angle, enable/disable using ROTATION. Parameters fontid (int) The id of the typeface as returned by [Link](), for default font use 0. angle (oat) The angle for text drawing to use. [Link](fontid, level, r, g, b, a) Shadow options, enable/disable using SHADOW . Parameters fontid (int) The id of the typeface as returned by [Link](), for default font use 0. level (int) The blur level, can be 3, 5 or 0.

1246

Chapter 3. Standalone Modules

Blender Index, Release 2.59.2 - API

r (oat) Shadow color (red channel 0.0 - 1.0). g (oat) Shadow color (green channel 0.0 - 1.0). b (oat) Shadow color (blue channel 0.0 - 1.0). a (oat) Shadow color (alpha channel 0.0 - 1.0). blf.shadow_offset(fontid, x, y) Set the offset for shadow text. Parameters fontid (int) The id of the typeface as returned by [Link](), for default font use 0. x (oat) Vertical shadow offset value in pixels. y (oat) Horizontal shadow offset value in pixels. [Link](fontid, size, dpi) Set the size and dpi for drawing text. Parameters fontid (int) The id of the typeface as returned by [Link](), for default font use 0. size (int) Point size of the font. dpi (int) dots per inch value to use for drawing.

3.5 Audio System (aud)

This module provides access to the audaspace audio library.

3.5.1 Basic Sound Playback

This script shows how to use the classes: Device, Factory and Handle.
import aud device = [Link]() # load sound file (it can be a video file with audio) factory = [Link]([Link]) # play the audio, this return a handle to control play/pause handle = [Link](sound) # if the audio is not too big and will be used often you can buffer it factory_buffered = [Link](sound) handle_buffered = [Link](buffered) # stop the sounds (otherwise they play until their ends) [Link]() handle_buffered.stop()

aud.AUD_DEVICE_JACK constant value 3 aud.AUD_DEVICE_NULL constant value 0

3.5. Audio System (aud)

1247

Blender Index, Release 2.59.2 - API

aud.AUD_DEVICE_OPENAL constant value 1 aud.AUD_DEVICE_SDL constant value 2 aud.AUD_DISTANCE_MODEL_EXPONENT constant value 5 aud.AUD_DISTANCE_MODEL_EXPONENT_CLAMPED constant value 6 aud.AUD_DISTANCE_MODEL_INVALID constant value 0 aud.AUD_DISTANCE_MODEL_INVERSE constant value 1 aud.AUD_DISTANCE_MODEL_INVERSE_CLAMPED constant value 2 aud.AUD_DISTANCE_MODEL_LINEAR constant value 3 aud.AUD_DISTANCE_MODEL_LINEAR_CLAMPED constant value 4 aud.AUD_FORMAT_FLOAT32 constant value 36 aud.AUD_FORMAT_FLOAT64 constant value 40 aud.AUD_FORMAT_INVALID constant value 0 aud.AUD_FORMAT_S16 constant value 18 aud.AUD_FORMAT_S24 constant value 19 aud.AUD_FORMAT_S32 constant value 20 aud.AUD_FORMAT_U8 constant value 1 aud.AUD_STATUS_INVALID constant value 0 aud.AUD_STATUS_PAUSED constant value 2 aud.AUD_STATUS_PLAYING constant value 1 device() Returns the applications Device. return The applications Device. rtype Device

1248

Chapter 3. Standalone Modules

Blender Index, Release 2.59.2 - API

class [Link] Device objects represent an audio output backend like OpenAL or SDL, but might also represent a le output or RAM buffer output. lock() Locks the device so that its guaranteed, that no samples are read from the streams until unlock() is called. This is useful if you want to do start/stop/pause/resume some sounds at the same time. Note: The device has to be unlocked as often as locked to be able to continue playback. Warning: Make sure the time between locking and unlocking is as short as possible to avoid clicks. play(factory, keep=False) Plays a factory. Parameters factory (Factory) The factory to play. keep (bool) See [Link]. Returns The playback handle with which playback can be controlled with. Return type Handle stopAll() Stops all playing and paused sounds. unlock() Unlocks the device after a lock call, see lock() for details. channels The channel count of the device. distance_model The distance model of the device. See Also: [Link] doppler_factor The doppler factor of the device. This factor is a scaling factor for the velocity vectors in doppler calculation. So a value bigger than 1 will exaggerate the effect as it raises the velocity. format The native sample format of the device. listener_location The listenerss location in 3D space, a 3D tuple of oats. listener_orientation The listeners orientation in 3D space as quaternion, a 4 oat tuple. listener_velocity The listeners velocity in 3D space, a 3D tuple of oats. rate The sampling rate of the device in Hz.

3.5. Audio System (aud)

1249

Blender Index, Release 2.59.2 - API

speed_of_sound The speed of sound of the device. The speed of sound in air is typically 343 m/s. volume The overall volume of the device. class [Link] Factory objects are immutable and represent a sound that can be played simultaneously multiple times. They are called factories because they create reader objects internally that are used for playback. le(lename) Creates a factory object of a sound le. Parameters lename (string) Path of the le. Returns The created Factory object. Return type Factory Warning: If the le doesnt exist or cant be read you will not get an exception immediately, but when you try to start playback of that factory. sine(frequency, rate=44100) Creates a sine factory which plays a sine wave. Parameters frequency (oat) The frequency of the sine wave in Hz. rate (int) The sampling rate in Hz. Its recommended to set this value to the playback devices samling rate to avoid resamping. Returns The created Factory object. Return type Factory buffer() Buffers a factory into RAM. This saves CPU usage needed for decoding and le access if the underlying factory reads from a le on the harddisk, but it consumes a lot of memory. Returns The created Factory object. Return type Factory Note: Only known-length factories can be buffered. Warning: Raw PCM data needs a lot of space, only buffer short factories. delay(time) Delays by playing adding silence in front of the other factorys data. Parameters time (oat) How many seconds of silence should be added before the factory. Returns The created Factory object. Return type Factory fadein(start, length) Fades a factory in by raising the volume linearly in the given time interval. 1250 Chapter 3. Standalone Modules

Blender Index, Release 2.59.2 - API

Parameters start (oat) Time in seconds when the fading should start. length (oat) Time in seconds how long the fading should last. Returns The created Factory object. Return type Factory Note: Before the fade starts it plays silence. fadeout(start, length) Fades a factory in by lowering the volume linearly in the given time interval. Parameters start (oat) Time in seconds when the fading should start. length (oat) Time in seconds how long the fading should last. Returns The created Factory object. Return type Factory Note: After the fade this factory plays silence, so that the length of the factory is not altered. lter(b, a = (1)) Filters a factory with the supplied IIR lter coefcients. Without the second parameter youll get a FIR lter. If the rst value of the a sequence is 0 it will be set to 1 automatically. If the rst value of the a sequence is neither 0 nor 1, all lter coefcients will be scaled by this value so that it is 1 in the end, you dont have to scale yourself. Parameters b (sequence of oat) The nominator lter coefcients. a (sequence of oat) The denominator lter coefcients. Returns The created Factory object. Return type Factory highpass(frequency, Q=0.5) Creates a second order highpass lter based on the transfer function H(s) = s^2 / (s^2 + s/Q + 1) Parameters frequency (oat) The cut off trequency of the highpass. Q (oat) Q factor of the lowpass. Returns The created Factory object. Return type Factory join(factory) Plays two factories in sequence. Parameters factory (Factory) The factory to play second. Returns The created Factory object.

3.5. Audio System (aud)

1251

Blender Index, Release 2.59.2 - API

Return type Factory Note: The two factories have to have the same specications (channels and samplerate). limit(start, end) Limits a factory within a specic start and end time. Parameters start (oat) Start time in seconds. end (oat) End time in seconds. Returns The created Factory object. Return type Factory loop(count) Loops a factory. Parameters count (integer) How often the factory should be looped. Negative values mean endlessly. Returns The created Factory object. Return type Factory Note: This is a lter function, you might consider using Handle.loop_count instead. lowpass(frequency, Q=0.5) Creates a second order lowpass lter based on the transfer function H(s) = 1 / (s^2 + s/Q + 1) Parameters frequency (oat) The cut off trequency of the lowpass. Q (oat) Q factor of the lowpass. Returns The created Factory object. Return type Factory mix(factory) Mixes two factories. Parameters factory (Factory) The factory to mix over the other. Returns The created Factory object. Return type Factory Note: The two factories have to have the same specications (channels and samplerate). pingpong() Plays a factory forward and then backward. This is like joining a factory with its reverse. Returns The created Factory object. Return type Factory

1252

Chapter 3. Standalone Modules

Blender Index, Release 2.59.2 - API

pitch(factor) Changes the pitch of a factory with a specic factor. Parameters factor (oat) The factor to change the pitch with. Returns The created Factory object. Return type Factory Note: This is done by changing the sample rate of the underlying factory, which has to be an integer, so the factor value rounded and the factor may not be 100 % accurate.

Note: This is a lter function, you might consider using [Link] instead. reverse() Plays a factory reversed. Returns The created Factory object. Return type Factory Note: The factory has to have a nite length and has to be seekable. Its recommended to use this only with factories with fast and accurate seeking, which is not true for encoded audio les, such ones should be buffered using buffer() before being played reversed. Warning: If seeking is not accurate in the underlying factory youll likely hear skips/jumps/cracks. square(threshold = 0) Makes a square wave out of an audio wave by setting all samples with a amplitude >= threshold to 1, all <= -threshold to -1 and all between to 0. Parameters threshold (oat) Threshold value over which an amplitude counts non-zero. Returns The created Factory object. Return type Factory volume(volume) Changes the volume of a factory. Parameters volume (oat) The new volume.. Returns The created Factory object. Return type Factory Note: Should be in the range [0, 1] to avoid clipping.

Note: This is a lter function, you might consider using [Link] instead. class [Link] Handle objects are playback handles that can be used to control playback of a sound. If a sound is played back multiple times then there are as many handles.

3.5. Audio System (aud)

1253

Blender Index, Release 2.59.2 - API

pause() Pauses playback. Returns Whether the action succeeded. Return type bool resume() Resumes playback. Returns Whether the action succeeded. Return type bool stop() Stops playback. Returns Whether the action succeeded. Return type bool Note: This makes the handle invalid. attenuation This factor is used for distance based attenuation of the source. See Also: Device.distance_model cone_angle_inner The opening angle of the inner cone of the source. If the cone values of a source are set there are two (audible) cones with the apex at the location of the source and with innite height, heading in the direction of the sources orientation. In the inner cone the volume is normal. Outside the outer cone the volume will be cone_volume_outer and in the area between the volume will be interpolated linearly. cone_angle_outer The opening angle of the outer cone of the source. See Also: cone_angle_inner cone_volume_outer The volume outside the outer cone of the source. See Also: cone_angle_inner distance_maximum The maximum distance of the source. If the listener is further away the source volume will be 0. See Also: Device.distance_model distance_reference The reference distance of the source. At this distance the volume will be exactly volume. See Also:

1254

Chapter 3. Standalone Modules

Blender Index, Release 2.59.2 - API

Device.distance_model keep Whether the sound should be kept paused in the device when its end is reached. This can be used to seek the sound to some position and start playback again. Warning: If this is set to true and you forget stopping this equals a memory leak as the handle exists until the device is destroyed. location The sources location in 3D space, a 3D tuple of oats. loop_count The (remaining) loop count of the sound. A negative value indicates innity. orientation The sources orientation in 3D space as quaternion, a 4 oat tuple. pitch The pitch of the sound. position The playback position of the sound in seconds. relative Whether the sources location, velocity and orientation is relative or absolute to the listener. status Whether the sound is playing, paused or stopped (=invalid). velocity The sources velocity in 3D space, a 3D tuple of oats. volume The volume of the sound. volume_maximum The maximum volume of the source. See Also: Device.distance_model volume_minimum The minimum volume of the source. See Also: Device.distance_model class [Link]

3.6 Extra Utilities (bpy_extras)

Utility modules assosiated with the bpy module.

3.6. Extra Utilities (bpy_extras)

1255

Blender Index, Release 2.59.2 - API

3.6.1 bpy_extras submodule (bpy_extras.object_utils)

bpy_extras.object_utils.add_object_align_init(context, operator) Return a matrix using the operator settings and view context. Parameters context ([Link]) The context to use. operator ([Link]) The operator, checked for location and rotation properties. Returns the matrix from the context and settings. Return type [Link] bpy_extras.object_utils.object_data_add(context, obdata, operator=None) Add an object using the view context and preference to to initialize the location, rotation and layer. Parameters context ([Link]) The context to use. obdata (valid object data type or None.) the data used for the new object. operator ([Link]) The operator, checked for location and rotation properties. Returns the newly created object in the scene. Return type [Link]

3.6.2 bpy_extras submodule (bpy_extras.io_utils)

bpy_extras.io_utils.axis_conversion(from_forward=Y, from_up=Z, to_forward=Y, to_up=Z) Each argument us an axis in [X, Y, Z, -X, -Y, -Z] where the rst 2 are a source and the second 2 are the target. bpy_extras.io_utils.axis_conversion_ensure(operator, forward_attr, up_attr) Function to ensure an operator has valid axis conversion settings, intended to be used from [Link]. Parameters operator ([Link]) the operator to access axis attributes from. forward_attr (string) attribute storing the forward axis up_attr (string) attribute storing the up axis Returns True if the value was modied. Return type boolean bpy_extras.io_utils.create_derived_objects(scene, ob) bpy_extras.io_utils.free_derived_objects(ob) bpy_extras.io_utils.unpack_list(list_of_tuples) bpy_extras.io_utils.unpack_face_list(list_of_tuples)

1256

Chapter 3. Standalone Modules

Blender Index, Release 2.59.2 - API

bpy_extras.io_utils.path_reference(lepath, base_src, base_dst, copy_subdir=, copy_set=None) Return a lepath relative to a destination directory, for use with exporters. Parameters

mode=AUTO,

lepath (string) the le path to return, supporting blenders relative // prex. base_src (string) the directory the lepath is relative too (normally the blend le). base_dst (string) the directory the lepath will be referenced from (normally the export path). mode (string) the method used get the path in [AUTO, ABSOLUTE, RELATIVE, MATCH, STRIP, COPY] copy_subdir (string) the subdirectory of base_dst to use when mode=COPY. copy_set (set) collect from/to pairs when mode=COPY, pass to path_reference_copy when exportign is done. Returns the new lepath. Return type string bpy_extras.io_utils.path_reference_copy(copy_set, report=<built-in function print>) Execute copying les of path_reference Parameters copy_set (set) set of (from, to) pairs to copy. report (function) function used for reporting warnings, takes a string argument. bpy_extras.io_utils.path_reference_mode constant value (<built-in function EnumProperty>, {default: AUTO, items: ((AUTO, Auto, Use Relative paths with subdirectories only), (ABSOLUTE, Absolute, Always write absolute paths), (RELATIVE, Relative, Always write relative patsh (where possible)), (MATCH, Match, Match Absolute/Relative setting with input path), (STRIP, Strip Path, Filename only), (COPY, Copy, copy the le to the destination path (or subdirectory))), attr: path_mode, description: Method used to reference paths, name: Path Mode}) bpy_extras.io_utils.unique_name(key, name, name_dict, name_max=-1, clean_func=None, sep=.) Helper function for storing unique names which may have special characters stripped and restricted to a maximum length. Parameters key (any hashable object assosiated with the name.) unique item this name belongs to, name_dict[key] will be reused when available. This can be the object, mesh, material, etc instance its self. name (string) The name used to create a unique value in name_dict. name_dict (dict) This is used to cache namespace to ensure no collisions occur, this should be an empty dict initially and only modied by this function. clean_func (function) Function to call on name before creating a unique value. sep (string) Separator to use when between the name and a number when a duplicate name is found. class bpy_extras.io_utils.ExportHelper class bpy_extras.io_utils.ImportHelper 3.6. Extra Utilities (bpy_extras) 1257

Blender Index, Release 2.59.2 - API

3.6.3 bpy_extras submodule (bpy_extras.image_utils)

bpy_extras.image_utils.load_image(imagepath, dirname=, place_holder=False, recursive=False, ncase_cmp=True, convert_callback=None, verbose=False) Return an image from the le path with options to search multiple paths and return a placeholder if its not found. Parameters lepath (string) The image lename If a path precedes it, this will be searched as well. dirname (string) is the directory where the image may be located - any le at the end will be ignored. place_holder (bool) if True a new place holder image will be created. this is usefull so later you can relink the image to its original data. recursive (bool) If True, directories will be recursivly searched. Be carefull with this if you have les in your root directory because it may take a long time. ncase_cmp (bool) on non windows systems, nd the correct case for the le. convert_callback (function) a function that takes an existing path and returns a new one. Use this when loading image formats blender may not support, the CONVERT_CALLBACK can take the path for a GIF (for example), convert it to a PNG and return the PNGs path. For formats blender can read, simply return the path that is given. Returns an image or None Return type [Link]

3.6.4 bpy_extras submodule (bpy_extras.mesh_utils)

bpy_extras.mesh_utils.mesh_linked_faces(mesh) Splits the mesh into connected faces, use this for seperating cubes from other mesh elements within 1 mesh datablock. Parameters mesh ([Link]) the mesh used to group with. Returns lists of lists containing faces. Return type list bpy_extras.mesh_utils.edge_face_count_dict(mesh) Returns dict of edge keys with their value set to the number of faces using each edge. Return type dict bpy_extras.mesh_utils.edge_face_count(mesh) Returns list face users for each item in [Link]. Return type list bpy_extras.mesh_utils.edge_loops_from_faces(mesh, faces=None, seams=()) Edge loops dened by faces Takes [Link] or a list of faces and returns the edge loops These edge loops are the edges that sit between quads, so they dont touch 1 quad, note: not connected will make 2 edge loops, both only containing 2 edges. return a list of edge key lists [[(0, 1), (4, 8), (3, 8)], ...] Parameters

1258

Chapter 3. Standalone Modules

Blender Index, Release 2.59.2 - API

mesh ([Link]) the mesh used to get edge loops from. faces ([Link], sequence or or NoneType) optional face list to only use some of the meshes faces. Returns return a list of edge vertex index lists. Return type list bpy_extras.mesh_utils.edge_loops_from_edges(mesh, edges=None) Edge loops dened by edges Takes [Link] or a list of edges and returns the edge loops return a list of vertex indices. [ [1, 6, 7, 2], ...] closed loops have matching start and end values. bpy_extras.mesh_utils.ngon_tesselate(from_data, indices, x_loops=True) Takes a polyline of indices (fgon) and returns a list of face indicie lists. Designed to be used for importers that need indices for an fgon to create from existing verts. from_data: either a mesh, or a list/tuple of vectors. indices: a list of indices to use this list is the ordered closed polyline to ll, and can be a subset of the data given. x_loops: If this is enabled polylines that use loops to make multiple polylines are delt with correctly. bpy_extras.mesh_utils.face_random_points(num_points, faces) Generates a list of random points over mesh faces. Parameters num_points the number of random points to generate on each face. faces ([Link], sequence) list of the faces to generate points on. Returns list of random points over all faces. Return type list

3.6.5 bpy_extras submodule (bpy_extras.view3d_utils)

bpy_extras.view3d_utils.region_2d_to_vector_3d(region, rv3d, coord) Return a direction vector from the viewport at the spesic 2d region coordinate. Parameters region ([Link]) region of the 3D viewport, typically [Link]. rv3d ([Link].RegionView3D) [Link].space_data.region_3d. 3D region data, typically

coord (2d vector) 2d coordinates relative to the region: event.mouse_region_y) for example. Returns normalized 3d vector. Return type [Link]

(event.mouse_region_x,

bpy_extras.view3d_utils.region_2d_to_location_3d(region, rv3d, coord, depth_location) Return a 3d location from the region relative 2d coords, aligned with depth_location. Parameters 3.6. Extra Utilities (bpy_extras) 1259

Blender Index, Release 2.59.2 - API

region ([Link]) region of the 3D viewport, typically [Link]. rv3d ([Link].RegionView3D) [Link].space_data.region_3d. 3D region data, typically

coord (2d vector) 2d coordinates relative to the region; (event.mouse_region_x, event.mouse_region_y) for example. depth_location (3d vector) the returned vectors depth is aligned with this since there is no dened depth with a 2d region input. Returns normalized 3d vector. Return type [Link] bpy_extras.view3d_utils.location_3d_to_region_2d(region, rv3d, coord) Return the region relative 2d location of a 3d position. Parameters region ([Link]) region of the 3D viewport, typically [Link]. rv3d ([Link].RegionView3D) [Link].space_data.region_3d. coord (3d vector) 3d worldspace location. Returns 2d location Return type [Link] 3D region data, typically

1260

Chapter 3. Standalone Modules

CHAPTER

FOUR

GAME ENGINE MODULES

4.1 Game Types ([Link])
class [Link] PyObjectPlus base class of most other types in the Game Engine. invalid Test if the object has been freed by the game engine and is no longer valid. Normally this is not a problem but when storing game engine data in the GameLogic module, KX_Scenes or other KX_GameObjects its possible to hold a reference to invalid data. Calling an attribute or method on an invalid object will raise a SystemError. The invalid attribute allows testing for this case without exception handling. Type boolean class [Link](PyObjectPlus) This class is a basis for other classes. name The name of this CValue derived object (read-only). Type string class [Link](CValue) This class has no python functions class [Link].SCA_ILogicBrick(CValue) Base class for all logic bricks. executePriority This determines the order controllers are evaluated, and actuators are activated (lower priority is executed rst). Type executePriority: int owner The game object this logic brick is attached to (read-only). Type KX_GameObject or None in exceptional cases. name The name of this logic brick (read-only). Type string

1261

Blender Index, Release 2.59.2 - API

class [Link].SCA_PythonKeyboard(PyObjectPlus) The current keyboard. events A dictionary containing the status of each keyboard event or key. (read-only). Type dictionary {keycode:status, ...} class [Link].SCA_PythonMouse(PyObjectPlus) The current mouse. events a dictionary containing the status of each mouse event. (read-only). Type dictionary {keycode:status, ...} position The normalized x and y position of the mouse cursor. Type list [x, y] visible The visibility of the mouse cursor. Type boolean class [Link].SCA_IObject(CValue) This class has no python functions class [Link].SCA_ISensor(SCA_ILogicBrick) Base class for all sensor logic bricks. usePosPulseMode Flag to turn positive pulse mode on and off. Type boolean useNegPulseMode Flag to turn negative pulse mode on and off. Type boolean frequency The frequency for pulse mode sensors. Type integer level level Option whether to detect level or edge transition when entering a state. It makes a difference only in case of logic state transition (state actuator). A level detector will immediately generate a pulse, negative or positive depending on the sensor condition, as soon as the state is activated. A edge detector will wait for a state change before generating a pulse. note: mutually exclusive with tap, enabling will disable tap. Type boolean tap When enabled only sensors that are just activated will send a positive event, after this they will be detected as negative by the controllers. This will make a key thats held act as if its only tapped for an instant. note: mutually exclusive with level, enabling will disable level. Type boolean invert Flag to set if this sensor activates on positive or negative events.

1262

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

Type boolean triggered True if this sensor brick is in a positive state. (read-only). Type boolean positive True if this sensor brick is in a positive state. (read-only). Type boolean status The status of the sensor (read-only): can be one of these constants. Type int Note: This convenient attribute combines the values of triggered and positive attributes. reset() Reset sensor internal state, effect depends on the type of sensor and settings. The sensor is put in its initial state as if it was just activated. class [Link].SCA_IController(SCA_ILogicBrick) Base class for all controller logic bricks. state The controllers state bitmask. This can be used with the GameObjects state to test if the controller is active. Type int bitmask sensors A list of sensors linked to this controller. Type sequence supporting index/string lookups and iteration. Note: The sensors are not necessarily owned by the same object.

Note: When objects are instanced in dupligroups links may be lost from objects outside the dupligroup. actuators A list of actuators linked to this controller. Type sequence supporting index/string lookups and iteration. Note: The sensors are not necessarily owned by the same object.

Note: When objects are instanced in dupligroups links may be lost from objects outside the dupligroup. useHighPriority When set the controller executes always before all other controllers that dont have this set. Type boolen

4.1. Game Types ([Link])

1263

Blender Index, Release 2.59.2 - API

Note: Order of execution between high priority controllers is not guaranteed. class [Link].SCA_IActuator(SCA_ILogicBrick) Base class for all actuator logic bricks. class [Link].BL_ActionActuator(SCA_IActuator) Action Actuators apply an action to an actor. action The name of the action to set as the current action. Type string channelNames A list of channel names that may be used with setChannel and getChannel. Type list of strings frameStart Species the starting frame of the animation. Type oat frameEnd Species the ending frame of the animation. Type oat blendIn Species the number of frames of animation to generate when making transitions between actions. Type oat priority Sets the priority of this actuator. Actuators will lower priority numbers will override actuators with higher numbers. Type integer frame Sets the current frame for the animation. Type oat propName Sets the property to be used in FromProp playback mode. Type string blendTime Sets the internal frame timer. This property must be in the range from 0.0 to blendIn. Type oat mode The operation mode of the actuator. Can be one of these constants. Type integer useContinue The actions continue option, True or False. When True, the action will always play from where last left off, otherwise negative events to this actuator will reset it to its start frame. Type boolean 1264 Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

framePropName The name of the property that is set to the current frame number. Type string setChannel(channel, matrix) Alternative to the 2 arguments, 4 arguments (channel, matrix, loc, size, quat) are also supported. Parameters channel (string) A string specifying the name of the bone channel, error raised if not in channelNames. matrix A 4x4 matrix specifying the overriding transformation as an offset from the bones rest position. matrix list [[oat]] Note: These values are relative to the bones rest position, currently the api has no way to get this info (which is annoying), but can be worked around by using bones with a rest pose that has no translation. getChannel(channel) Parameters channel (string) A string specifying the name of the bone channel. error raised if not in channelNames. Returns (loc, size, quat) Return type tuple class [Link].BL_Shader(PyObjectPlus) BL_Shader GLSL shaders. TODO - Description setUniformfv(name, fList) Set a uniform with a list of oat values Parameters name (string) the uniform name fList (list[oat]) a list (2, 3 or 4 elements) of oat values delSource() Clear the shader. Use this method before the source is changed with setSource. getFragmentProg() Returns the fragment program. Returns The fragment program. Return type string getVertexProg() Get the vertex program. Returns The vertex program. Return type string isValid() Check if the shader is valid. Returns True if the shader is valid

4.1. Game Types ([Link])

1265

Blender Index, Release 2.59.2 - API

Return type boolean setAttrib(enum) Set attribute location. (The parameter is ignored a.t.m. and the value of tangent is always used.) Parameters enum (integer) attribute location value setNumberOfPasses(max_pass) Set the maximum number of passes. Not used a.t.m. Parameters max_pass (integer) the maximum number of passes setSampler(name, index) Set uniform texture sample index. Parameters name (string) Uniform name index (integer) Texture sample index. setSource(vertexProgram, fragmentProgram) Set the vertex and fragment programs Parameters vertexProgram (string) Vertex program fragmentProgram (string) Fragment program setUniform1f(name, fx) Set a uniform with 1 oat value. Parameters name (string) the uniform name fx (oat) Uniform value setUniform1i(name, ix) Set a uniform with an integer value. Parameters name (string) the uniform name ix (integer) the uniform value setUniform2f(name, fx, fy) Set a uniform with 2 oat values Parameters name (string) the uniform name fx (oat) rst oat value fy (oat) second oat value setUniform2i(name, ix, iy) Set a uniform with 2 integer values Parameters name (string) the uniform name ix (integer) rst integer value iy (integer) second integer value

1266

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

Note: A value of 0.0 disables this option (rather then setting it stationary). localInertia the objects inertia vector in local coordinates. Read only. Type list [ix, iy, iz] parent The objects parent object. (read-only). Type KX_GameObject or None visible visibility ag. Type boolean Note: Game logic will still run for invisible objects. color The object color of the object. [r, g, b, a] Type [Link] occlusion occlusion capability ag. Type boolean position The objects position. [x, y, z] On write: local position, on read: world position Deprecated since version use: localPosition and worldPosition. Type [Link] orientation The objects orientation. 3x3 Matrix. You can also write a Quaternion or Euler vector. On write: local orientation, on read: world orientation Deprecated since version use: localOrientation and worldOrientation. Type [Link] scaling The objects scaling factor. [sx, sy, sz] On write: local scaling, on read: world scaling Deprecated since version use: localScale and worldScale. Type [Link] localOrientation The objects local orientation. 3x3 Matrix. You can also write a Quaternion or Euler vector. Type [Link] worldOrientation The objects world orientation. 3x3 Matrix. Type [Link] localScale The objects local scaling factor. [sx, sy, sz] Type [Link] 4.1. Game Types ([Link]) 1273

Blender Index, Release 2.59.2 - API

worldScale The objects world scaling factor. Read-only. [sx, sy, sz] Type [Link] localPosition The objects local position. [x, y, z] Type [Link] worldPosition The objects world position. [x, y, z] Type [Link] localLinearVelocity The objects local linear velocity. [x, y, z] Type [Link] worldLinearVelocity The objects world linear velocity. [x, y, z] type [Link] localAngularVelocity The objects local angular velocity. [x, y, z] type [Link] worldAngularVelocity The objects world angular velocity. [x, y, z] type [Link] timeOffset adjust the slowparent delay at runtime. Type oat state the game objects state bitmask, using the rst 30 bits, one bit must always be set. Type int meshes a list meshes for this object. Type list of KX_MeshProxy Note: Most objects use only 1 mesh.

Returns (distance, globalVector(3), localVector(3)) Return type 3-tuple (oat, 3-tuple (x, y, z), 3-tuple (x, y, z)) rayCastTo(other, dist, prop) Look towards another point/object and nd rst object hit within dist that matches prop. The ray is always casted from the center of the object, ignoring the object itself. The ray is casted towards the center of another object or an explicit [x, y, z] point. Use rayCast() if you need to retrieve the hit point Parameters other (KX_GameObject or 3-tuple) [x, y, z] or object towards which the ray is casted dist (oat) max distance to look (can be negative => look behind); 0 or omitted => detect up to other prop (string) property name that object must have; can be omitted => detect any object Returns the rst object hit or None if no object or object does not match prop Return type KX_GameObject rayCast(objto, objfrom, dist, prop, face, xray, poly) Look from a point/object to another point/object and nd rst object hit within dist that matches prop. if poly is 0, returns a 3-tuple with object reference, hit point and hit normal or (None, None, None) if no hit. if poly is 1, returns a 4-tuple with in addition a KX_PolyProxy as 4th element. if poly is 2, returns a 5-tuple with in addition a 2D vector with the UV mapping of the hit point as 5th element.
# shoot along the axis gun-gunAim (gunAim should be collision-free) obj, point, normal = [Link](gunAim, None, 50) if obj: # do something pass

The face paremeter determines the orientation of the normal. 0 => hit normal is always oriented towards the ray origin (as if you casted the ray from outside) 1 => hit normal is the real face normal (only for mesh object, otherwise face has no effect) The ray has X-Ray capability if xray parameter is 1, otherwise the rst object hit (other than self object) stops the ray. The prop and xray parameters interact as follow. prop off, xray off: return closest hit or no hit if there is no object on the full extend of the ray. prop off, xray on : idem. prop on, xray off: return closest hit if it matches prop, no hit otherwise. prop on, xray on : return closest hit matching prop or no hit if there is no object matching prop on the full extend of the ray. The KX_PolyProxy 4th element of the return tuple when poly=1 allows to retrieve information on the polygon hit by the ray. If there is no hit or the hit object is not a static mesh, None is returned as 4th element. The ray ignores collision-free objects and faces that dont have the collision ag enabled, you can however use ghost objects. Parameters objto (KX_GameObject or 3-tuple) [x, y, z] or object to which the ray is casted objfrom (KX_GameObject or 3-tuple or None) [x, y, z] or object from which the ray is casted; None or omitted => use self object center 1280 Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

dist (oat) max distance to look (can be negative => look behind); 0 or omitted => detect up to to prop (string) property name that object must have; can be omitted or => detect any object face (integer) normal option: 1=>return face normal; 0 or omitted => normal is oriented towards origin xray (integer) X-ray option: 1=>skip objects that dont match prop; 0 or omitted => stop on rst object poly (integer) polygon option: 0, 1 or 2 to return a 3-, 4- or 5-tuple with information on the face hit. 0 or omitted: return value is a 3-tuple (object, hitpoint, hitnormal) or (None, None, None) if no hit 1: return value is a 4-tuple and the 4th element is a KX_PolyProxy or None if no hit or the object doesnt use a mesh collision shape. 2: return value is a 5-tuple and the 5th element is a 2-tuple (u, v) with the UV mapping of the hit point or None if no hit, or the object doesnt use a mesh collision shape, or doesnt have a UV mapping. Returns (object, hitpoint, hitnormal) or (object, hitpoint, hitnormal, polygon) or (object, hitpoint, hitnormal, polygon, hituv). object, hitpoint and hitnormal are None if no hit. polygon is valid only if the object is valid and is a static object, a dynamic object using mesh collision shape or a soft body object, otherwise it is None hituv is valid only if polygon is valid and the object has a UV mapping, otherwise it is None Return type 3-tuple (KX_GameObject, 3-tuple (x, y, z), 3-tuple (nx, ny, nz)) or 4-tuple (KX_GameObject, 3-tuple (x, y, z), 3-tuple (nx, ny, nz), PolyProxy) or 5-tuple (KX_GameObject, 3-tuple (x, y, z), 3-tuple (nx, ny, nz), PolyProxy, 2-tuple (u, v)) Note: The ray ignores the object on which the method is called. It is casted from/to object center or explicit [x, y, z] points. setCollisionMargin(margin) Set the objects collision margin. Parameters margin (oat) the collision margin distance in blender units. Note: If this object has no physics controller (a physics ID of zero), this function will raise RuntimeError. sendMessage(subject, body=, to=) Sends a message. Parameters

4.1. Game Types ([Link])

1281

Blender Index, Release 2.59.2 - API

1288

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

Parameters vertex index of the vertex in the polygon: 0->3 vertex integer Returns mesh vertex index Return type integer getMesh() Returns a mesh proxy Returns mesh proxy Return type MeshProxy class [Link].KX_PolygonMaterial(PyObjectPlus) This is the interface to materials in the game engine. Materials dene the render state to be applied to mesh objects. Warning: Some of the methods/variables are CObjects. If you mix these up, you will crash blender. This example requires PyOpenGL and GLEWPy
import GameLogic import OpenGL from [Link] import * from [Link] import * import glew from glew import * glewInit() vertex_shader = """ void main(void) { gl_Position = ftransform(); } """ fragment_shader =""" void main(void) { gl_FragColor = vec4(1.0, 0.0, 0.0, 1.0); } """ class MyMaterial: def __init__(self): self.pass_no = 0 # Create a shader self.m_program = glCreateProgramObjectARB() # Compile the vertex shader [Link](GL_VERTEX_SHADER_ARB, (vertex_shader)) # Compile the fragment shader [Link](GL_FRAGMENT_SHADER_ARB, (fragment_shader)) # Link the shaders together

1294

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

[Link]() def PrintInfoLog(self, tag, object): """ PrintInfoLog prints the GLSL compiler log """ print "Tag: def PrintGLError(self, tag = ""): def PrintGLError(self, tag = ""): """ Prints the current GL error status """ if len(tag): print tag err = glGetError() if err != GL_NO_ERROR: print "GL Error: %s\\n"%(gluErrorString(err)) def shader(self, type, shaders): """ shader compiles a GLSL shader and attaches it to the current program. type should be either GL_VERTEX_SHADER_ARB or GL_FRAGMENT_SHADER_ARB shaders should be a sequence of shader source to compile. """ # Create a shader object shader_object = glCreateShaderObjectARB(type) # Add the source code glShaderSourceARB(shader_object, len(shaders), shaders) # Compile the shader glCompileShaderARB(shader_object) # Print the compiler log [Link]("vertex shader", shader_object) # Check if compiled, and attach if it did compiled = glGetObjectParameterivARB(shader_object, GL_OBJECT_COMPILE_STATUS_ARB) if compiled: glAttachObjectARB(self.m_program, shader_object) # Delete the object (glAttachObjectARB makes a copy) glDeleteObjectARB(shader_object) # print the gl error log [Link]() def link(self): """ Links the shaders together. """ # clear error indicator glGetError() glLinkProgramARB(self.m_program)

4.1. Game Types ([Link])

1295

Blender Index, Release 2.59.2 - API

[Link]("link", self.m_program) linked = glGetObjectParameterivARB(self.m_program, GL_OBJECT_LINK_STATUS_ARB) if not linked: print "Shader failed to link" return glValidateProgramARB(self.m_program) valid = glGetObjectParameterivARB(self.m_program, GL_OBJECT_VALIDATE_STATUS_ARB) if not valid: print "Shader failed to validate" return def activate(self, rasty, cachingInfo, mat): self.pass_no+=1 if (self.pass_no == 1): glDisable(GL_COLOR_MATERIAL) glUseProgramObjectARB(self.m_program) return True glEnable(GL_COLOR_MATERIAL) glUseProgramObjectARB(0) self.pass_no = 0 return False obj = [Link]().owner mesh = [Link][0] for mat in [Link]: [Link](MyMaterial()) print [Link]

texture Texture name. Type string (read-only) gl_texture OpenGL texture handle (eg for glBindTexture(GL_TEXTURE_2D, gl_texture). Type integer (read-only) material Material name. Type string (read-only) tface Texture face properties. Type CObject (read-only) tile Texture is tiling. Type boolean tilexrep Number of tile repetitions in x direction. Type integer 1296 Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

tileyrep Number of tile repetitions in y direction. Type integer drawingmode Drawing mode for the material. - 2 (drawingmode & 4) Textured - 4 (drawingmode & 16) Light - 14 (drawingmode & 16384) 3d Polygon Text. Type biteld transparent This material is transparent. All meshes with this material will be rendered after non transparent meshes from back to front. Type boolean zsort Transparent polygons in meshes with this material will be sorted back to front before rendering. NonTransparent polygons will be sorted front to back before rendering. Type boolean lightlayer Light layers this material affects. Type biteld. triangle Mesh data with this material is triangles. Its probably not safe to change this. Type boolean diffuse The diffuse colour of the material. black = [0.0, 0.0, 0.0] white = [1.0, 1.0, 1.0]. Type list [r, g, b] specular The specular colour of the material. black = [0.0, 0.0, 0.0] white = [1.0, 1.0, 1.0]. Type list [r, g, b] shininess The shininess (specular exponent) of the material. 0.0 <= shininess <= 128.0. Type oat specularity The amount of specular of the material. 0.0 <= specularity <= 1.0. Type oat updateTexture(tface, rasty) Updates a realtime animation. Parameters tface (CObject) Texture face (eg [Link]) rasty (CObject) Rasterizer setTexture(tface) Sets texture render state. Parameters tface (CObject) Texture face

4.1. Game Types ([Link])

1297

Blender Index, Release 2.59.2 - API

[Link]([Link])

activate(rasty, cachingInfo) Sets material parameters for this object for rendering. Material Parameters set: [Link] [Link] culling [Link] drawing [Link] Colour [Link] [Link] Colour [Link] Offset. Parameters rasty (CObject) Rasterizer instance. cachingInfo (CObject) Material cache instance. setCustomMaterial(material) Sets the material state setup object. Using this method, you can extend or completely replace the gameengine material to do your own advanced multipass effects. Use this method to register your material class. Instead of the normal material, your classs activate method will be called just before rendering the mesh. This should setup the texture, material, and any other state you would like. It should return True to render the mesh, or False if you are nished. You should clean up any state Blender does not set before returning False. Activate Method Denition:
def activate(self, rasty, cachingInfo, material):

Parameters material (instance) The material object.

class PyMaterial: def __init__(self): self.pass_no = -1 def # # # # # # # # # # # activate(self, rasty, cachingInfo, material): Activate the material here. The activate method will be called until it returns False. Every time the activate method returns True the mesh will be rendered. rasty is a CObject for passing to [Link]() and [Link]() cachingInfo is a CObject for passing to [Link]() material is the KX_PolygonMaterial instance this material was added to

1298

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

# default material properties: self.pass_no += 1 if self.pass_no == 0: [Link](rasty, cachingInfo) # Return True to do this pass return True # clean up and return False to finish. self.pass_no = -1 return False # Create a new Python Material and pass it to the renderer. [Link](PyMaterial())

class [Link].KX_RadarSensor(KX_NearSensor) Radar sensor is a near sensor with a conical sensor object. coneOrigin The origin of the cone with which to test. The origin is in the middle of the cone. (read-only). Type list of oats [x, y, z] coneTarget The center of the bottom face of the cone with which to test. (read-only). Type list of oats [x, y, z] distance The height of the cone with which to test. Type oat angle The angle of the cone (in degrees) with which to test. Type oat from 0 to 360 axis The axis on which the radar cone is cast. Type integer from 0 to 5 KX_RADAR_AXIS_POS_X, KX_RADAR_AXIS_POS_Y, KX_RADAR_AXIS_POS_Z, KX_RADAR_AXIS_NEG_X, KX_RADAR_AXIS_NEG_Y, KX_RADAR_AXIS_NEG_Z getConeHeight() Returns The height of the cone with which to test. Return type oat class [Link].KX_RaySensor(SCA_ISensor) A ray sensor detects the rst object in a given direction. propName The property the ray is looking for. Type string range The distance of the ray. Type oat

4.1. Game Types ([Link])

1299

Blender Index, Release 2.59.2 - API

useMaterial Whether or not to look for a material (false = property). Type boolean useXRay Whether or not to use XRay. Type boolean hitObject The game object that was hit by the ray. (read-only). Type KX_GameObject hitPosition The position (in worldcoordinates) where the object was hit by the ray. (read-only). Type list [x, y, z] hitNormal The normal (in worldcoordinates) of the object at the location where the object was hit by the ray. (readonly). Type list [x, y, z] rayDirection The direction from the ray (in worldcoordinates). (read-only). Type list [x, y, z] axis The axis the ray is pointing on. Type integer from 0 to 5 KX_RAY_AXIS_POS_X KX_RAY_AXIS_POS_Y KX_RAY_AXIS_POS_Z KX_RAY_AXIS_NEG_X KX_RAY_AXIS_NEG_Y KX_RAY_AXIS_NEG_Z class [Link].KX_SCA_AddObjectActuator(SCA_IActuator) Edit Object Actuator (in Add Object Mode) Warning: An Add Object actuator will be ignored if at game start, the linked object doesnt exist (or is empty) or the linked object is in an active layer.
Error: GameObject Name has a AddObjectActuator ActuatorName without object (in nonactive

object the object this actuator adds. Type KX_GameObject or None objectLastCreated the last added object from this actuator (read-only).

1300

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

Type KX_GameObject or None time the lifetime of added objects, in frames. Set to 0 to disable automatic deletion. Type integer linearVelocity the initial linear velocity of added objects. Type list [vx, vy, vz] angularVelocity the initial angular velocity of added objects. Type list [vx, vy, vz] instantAddObject() adds the object without needing to calling SCA_PythonController.activate() Note: Use objectLastCreated to get the newly created object. class [Link].KX_SCA_DynamicActuator(SCA_IActuator) Dynamic Actuator. mode Type integer the type of operation of the actuator, 0-4 KX_DYN_RESTORE_DYNAMICS(0) KX_DYN_DISABLE_DYNAMICS(1) KX_DYN_ENABLE_RIGID_BODY(2) KX_DYN_DISABLE_RIGID_BODY(3) KX_DYN_SET_MASS(4) mass the mass value for the KX_DYN_SET_MASS operation. Type oat class [Link].KX_SCA_EndObjectActuator(SCA_IActuator) Edit Object Actuator (in End Object mode) This actuator has no python methods. class [Link].KX_SCA_ReplaceMeshActuator(SCA_IActuator) Edit Object actuator, in Replace Mesh mode. Warning: Replace mesh actuators will be ignored if at game start, the named mesh doesnt exist. This will generate a warning in the console
Error: GameObject Name ReplaceMeshActuator ActuatorName without object

# # # #

Level-of-detail Switch a game objects mesh based on its depth in the camera view. +----------+ +-----------+ +-------------------------------------+ | Always +-----+ Python +-----+ Edit Object (Replace Mesh) [Link] |

4.1. Game Types ([Link])

1301

Blender Index, Release 2.59.2 - API

# +----------+ import GameLogic

+-----------+

+-------------------------------------+

# List detail meshes here # Mesh (name, near, far) # Meshes overlap so that they dont pop when on the edge of the distance. meshes = ((".Hi", 0.0, -20.0), (".Med", -15.0, -50.0), (".Lo", -40.0, -100.0) ) co = [Link]() obj = [Link] act = [Link]["LOD." + [Link]] cam = [Link]().active_camera def Depth(pos, plane): return pos[0]*plane[0] + pos[1]*plane[1] + pos[2]*plane[2] + plane[3] # Depth is negative and decreasing further from the camera depth = Depth([Link], cam.world_to_camera[2]) newmesh = None curmesh = None # Find the lowest detail mesh for depth for mesh in meshes: if depth < mesh[1] and depth > mesh[2]: newmesh = mesh if "ME" + [Link] + mesh[0] == [Link](): curmesh = mesh if newmesh != None and "ME" + [Link] + newmesh[0] != [Link](): # The mesh is a different mesh - switch it. # Check the current mesh is not a better fit. if curmesh == None or curmesh[1] < depth or curmesh[2] > depth: [Link] = [Link]() + newmesh[0] [Link](act, True)

mesh MeshProxy or the name of the mesh that will replace the current one. Set to None to disable actuator. Type MeshProxy or None if no mesh is set useDisplayMesh when true the displayed mesh is replaced. Type boolean usePhysicsMesh when true the physics mesh is replaced. Type boolean instantReplaceMesh() Immediately replace mesh without delay. class [Link].KX_Scene(PyObjectPlus) An active scene that gives access to objects, cameras, lights and scene attributes.

1302

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

The activity culling stuff is supposed to disable logic bricks when their owner gets too far from the active camera. It was taken from some code lurking at the back of KX_Scene - who knows what it does!
import GameLogic # get the scene scene = [Link]() # print all the objects in the scene for obj in [Link]: print [Link] # get an object named Cube obj = [Link]["Cube"] # get the first object in the scene. obj = [Link][0] # Get the depth of an object in the camera view. import GameLogic obj = [Link]().owner cam = [Link]().active_camera # Depth is negative and decreasing further from the camera depth = [Link][0]*cam.world_to_camera[2][0] + [Link][1]*cam.world_to_camera[2][1] +

@bug: All attributes are read only at the moment. name The scenes name, (read-only). Type string objects A list of objects in the scene, (read-only). Type CListValue of KX_GameObject objectsInactive A list of objects on background layers (used for the addObject actuator), (read-only). Type CListValue of KX_GameObject lights A list of lights in the scene, (read-only). Type CListValue of KX_LightObject cameras A list of cameras in the scene, (read-only). Type CListValue of KX_Camera active_camera The current active camera. Type KX_Camera Note: This can be set directly from python to avoid using the KX_SceneActuator.

4.1. Game Types ([Link])

1303

Blender Index, Release 2.59.2 - API

suspended True if the scene is suspended, (read-only). Type boolean activity_culling True if the scene is activity culling. Type boolean activity_culling_radius The distance outside which to do activity culling. Measured in manhattan distance. Type oat dbvt_culling True when Dynamic Bounding box Volume Tree is set (read-only). Type boolean pre_draw A list of callables to be run before the render step. Type list post_draw A list of callables to be run after the render step. Type list addObject(object, other, time=0) Adds an object to the scene like the Add Object Actuator would. Parameters object (KX_GameObject or string) The object to add other (KX_GameObject or string) The objects center to use when adding the object time (integer) The lifetime of the added object, in frames. A time of 0 means the object will last forever. Returns The newly added object. Return type KX_GameObject end() Removes the scene from the game. restart() Restarts the scene. replace(scene) Replaces this scene with another one. Parameters scene (string) The name of the scene to replace this scene with. suspend() Suspends this scene. resume() Resume this scene. get(key, default=None) Return the value matching key, or the default value if its not found. :return: The key value or a default.

1304

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

class [Link].KX_SceneActuator(SCA_IActuator) Scene Actuator logic brick. Warning: Scene actuators that use a scene name will be ignored if at game start, the named scene doesnt exist or is empty This will generate a warning in the console:
Error: GameObject Name has a SceneActuator ActuatorName (SetScene) without scene

scene the name of the scene to change to/overlay/underlay/remove/suspend/resume. Type string camera the camera to change to. Type KX_Camera on read, string or KX_Camera on write Note: When setting the attribute, you can use either a KX_Camera or the name of the camera. useRestart Set ag to True to restart the sene. Type boolean mode The mode of the actuator. Type integer from 0 to 5. class [Link].KX_SoundActuator(SCA_IActuator) Sound Actuator. The startSound, pauseSound and stopSound do not requirethe actuator to be activated - they act instantly provided that the actuator has been activated once at least. fileName The lename of the sound this actuator plays. Type string volume The volume (gain) of the sound. Type oat pitch The pitch of the sound. Type oat rollOffFactor The roll off factor. Rolloff denes the rate of attenuation as the sound gets further away. Type oat looping The loop mode of the actuator. Type integer

4.1. Game Types ([Link])

1305

Blender Index, Release 2.59.2 - API

position The position of the sound as a list: [x, y, z]. Type oat array velocity The velocity of the emitter as a list: [x, y, z]. The relative velocity to the observer determines the pitch. List of 3 oats: [x, y, z]. Type oat array orientation The orientation of the sound. When setting the orientation you can also use quaternion [oat, oat, oat, oat] or euler angles [oat, oat, oat]. Type 3x3 matrix [[oat]] mode The operation mode of the actuator. Can be one of these constants Type integer class [Link].KX_StateActuator(SCA_IActuator) State actuator changes the state mask of parent object. operation Type of bit operation to be applied on object state mask. You can use one of these constants Type integer mask Value that denes the bits that will be modied by the operation. The bits that are 1 in the mask will be updated in the object state. The bits that are 0 are will be left unmodied expect for the Copy operation which copies the mask to the object state. Type integer class [Link].KX_TrackToActuator(SCA_IActuator) Edit Object actuator in Track To mode. Warning: Track To Actuators will be ignored if at game start, the object to track to is invalid. This will generate a warning in the console:
GameObject Name no object in EditObjectActuator ActuatorName

object the object this actuator tracks. Type KX_GameObject or None time the time in frames with which to delay the tracking motion. Type integer use3D the tracking motion to use 3D. Type boolean 1306 Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

The duration parameter denes the length of the ON period following the OFF period. There is a negative trigger at the end of the ON period. If duration is 0, the sensor stays ON and there is no negative trigger. The sensor runs the OFF-ON cycle once unless the repeat option is set: the OFF-ON cycle repeats indenately (or the OFF cycle if duration is 0). Use SCA_ISensor.reset at any time to restart sensor. delay length of the initial OFF period as number of frame, 0 for immediate trigger. Type integer. duration length of the ON period in number of frame after the initial OFF period. If duration is greater than 0, a negative trigger is sent at the end of the ON pulse. Type integer repeat 1 if the OFF-ON cycle should be repeated indenately, 0 if it should run once. Type integer class [Link].SCA_JoystickSensor(SCA_ISensor) This sensor detects player joystick events. axisValues The state of the joysticks axis as a list of values numAxis long. (read-only). Type list of ints. Each spesifying the value of an axis between -32767 and 32767 depending on how far the axis is pushed, 0 for nothing. The rst 2 values are used by most joysticks and gamepads for directional control. 3rd and 4th values are only on some joysticks and can be used for arbitary controls. left:[-32767, 0, ...] right:[32767, 0, ...] up:[0, -32767, ...] down:[0, 32767, ...] axisSingle like axisValues but returns a single axis value that is set by the sensor. (read-only). Type integer Note: Only use this for Single Axis type sensors otherwise it will raise an error. hatValues The state of the joysticks hats as a list of values numHats long. (read-only). Type list of ints Each spesifying the direction of the hat from 1 to 12, 0 when inactive. Hat directions are as follows... 0:None 1:Up 2:Right 4.1. Game Types ([Link]) 1313

Blender Index, Release 2.59.2 - API

4:Down 8:Left 3:Up - Right 6:Down - Right 12:Down - Left 9:Up - Left hatSingle Like hatValues but returns a single hat direction value that is set by the sensor. (read-only). Type integer numAxis The number of axes for the joystick at this index. (read-only). Type integer numButtons The number of buttons for the joystick at this index. (read-only). Type integer numHats The number of hats for the joystick at this index. (read-only). Type integer connected True if a joystick is connected at this joysticks index. (read-only). Type boolean index The joystick index to use (from 0 to 7). The rst joystick is always 0. Type integer threshold Axis threshold. Joystick axis motion below this threshold wont trigger an event. Use values between (0 and 32767), lower values are more sensitive. Type integer button The button index the sensor reacts to (rst button = 0). When the All Events toggle is set, this option has no effect. Type integer axis The axis this sensor reacts to, as a list of two values [axisIndex, axisDirection] axisIndex: the axis index to use when detecting axis movement, 1=primary directional control, 2=secondary directional control. axisDirection: 0=right, 1=up, 2=left, 3=down. Type [integer, integer] hat The hat the sensor reacts to, as a list of two values: [hatIndex, hatDirection]

1314

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

hatIndex: the hat index to use when detecting hat movement, 1=primary hat, 2=secondary hat (4 max). hatDirection: 1-12. Type [integer, integer] getButtonActiveList() Returns A list containing the indicies of the currently pressed buttons. Return type list getButtonStatus(buttonIndex) Parameters buttonIndex (integer) the button index, 0=rst button Returns The current pressed state of the specied button. Return type boolean class [Link].SCA_KeyboardSensor(SCA_ISensor) A keyboard sensor detects player key presses. See module [Link] for keycode values. key The key code this sensor is looking for. Type keycode from [Link] module hold1 The key code for the rst modier this sensor is looking for. Type keycode from [Link] module hold2 The key code for the second modier this sensor is looking for. Type keycode from [Link] module toggleProperty The name of the property that indicates whether or not to log keystrokes as a string. Type string targetProperty The name of the property that receives keystrokes in case in case a string is logged. Type string useAllKeys Flag to determine whether or not to accept all keys. Type boolean events a list of pressed keys that have either been pressed, or just released, or are active this frame. (read-only). Type list [[keycode, status], ...] getKeyStatus(keycode) Get the status of a key. Parameters keycode (integer) The code that represents the key you want to get the state of, use one of these constants Returns The state of the given key, can be one of these constants

4.1. Game Types ([Link])

1315

Blender Index, Release 2.59.2 - API

Return type int class [Link].SCA_NANDController(SCA_IController) An NAND controller activates when all linked sensors are not active. There are no special python methods for this controller. class [Link].SCA_NORController(SCA_IController) An NOR controller activates only when all linked sensors are de-activated. There are no special python methods for this controller. class [Link].SCA_ORController(SCA_IController) An OR controller activates when any connected sensor activates. There are no special python methods for this controller. class [Link].SCA_PropertyActuator(SCA_IActuator) Property Actuator propName the property on which to operate. Type string value the value with which the actuator operates. Type string mode TODO - add constants to game logic dict!. Type integer class [Link].SCA_PropertySensor(SCA_ISensor) Activates when the game object property matches. mode Type of check on the property. Can be one of these constants Type integer. propName the property the sensor operates. Type string value the value with which the sensor compares to the value of the property. Type string min the minimum value of the range used to evaluate the property when in interval mode. Type string max the maximum value of the range used to evaluate the property when in interval mode. Type string class [Link].SCA_PythonController(SCA_IController) A Python controller uses a Python script to activate its actuators, based on its sensors.

1316

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

script The value of this variable depends on the execution methid. When Script execution mode is set this value contains the entire python script as a single string (not the script name as you might expect) which can be modied to run different scripts. When Module execution mode is set this value will contain a single line string - module name and function [Link] or [Link] where the module names are python textblocks or external scripts. Type string Note: Once this is set the script name given for warnings will remain unchanged. mode the execution mode for this controller (read-only). Script: 0, Execite the script as a python code. Module: 1, Execite the script as a module and function. Type integer activate(actuator) Activates an actuator attached to this controller. Parameters actuator (actuator or the actuator name as a string) The actuator to operate on. deactivate(actuator) Deactivates an actuator attached to this controller. Parameters actuator (actuator or the actuator name as a string) The actuator to operate on. class [Link].SCA_RandomActuator(SCA_IActuator) Random Actuator seed Seed of the random number generator. Type integer. Equal seeds produce equal series. If the seed is 0, the generator will produce the same value on every call. para1 the rst parameter of the active distribution. Type oat, read-only. Refer to the documentation of the generator types for the meaning of this value. para2 the second parameter of the active distribution. Type oat, read-only Refer to the documentation of the generator types for the meaning of this value. distribution Distribution type. (read-only). Can be one of these constants Type integer

4.1. Game Types ([Link])

1317

Blender Index, Release 2.59.2 - API

propName the name of the property to set with the random value. Type string If the generator and property types do not match, the assignment is ignored. setBoolConst(value) Sets this generator to produce a constant boolean value. Parameters value (boolean) The value to return. setBoolUniform() Sets this generator to produce a uniform boolean distribution. The generator will generate True or False with 50% chance. setBoolBernouilli(value) Sets this generator to produce a Bernouilli distribution. Parameters value (oat) Species the proportion of False values to produce. 0.0: Always generate True 1.0: Always generate False setIntConst(value) Sets this generator to always produce the given value. Parameters value (integer) the value this generator produces. setIntUniform(lower_bound, upper_bound) Sets this generator to produce a random value between the given lower and upper bounds (inclusive).

setIntPoisson(value) Generate a Poisson-distributed number. This performs a series of Bernouilli tests with parameter value. It returns the number of tries needed to achieve succes.

setFloatConst(value) Always generate the given value.

setFloatUniform(lower_bound, upper_bound) Generates a random oat between lower_bound and upper_bound with a uniform distribution.

setFloatNormal(mean, standard_deviation) Generates a random oat from the given normal distribution. Parameters mean (oat) The mean (average) value of the generated numbers standard_deviation (oat) The standard deviation of the generated numbers. setFloatNegativeExponential(half_life) Generate negative-exponentially distributed numbers. The half-life time is characterized by half_life.

1318

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

class [Link].SCA_RandomSensor(SCA_ISensor) This sensor activates randomly. lastDraw The seed of the random number generator. Type integer seed The seed of the random number generator. Type integer setSeed(seed) Sets the seed of the random number generator. If the seed is 0, the generator will produce the same value on every call.

getSeed() Returns The initial seed of the generator. Equal seeds produce equal random series. Return type integer getLastDraw() Returns The last random number generated. Return type integer class [Link].SCA_XNORController(SCA_IController) An XNOR controller activates when all linked sensors are the same (activated or inative). There are no special python methods for this controller. class [Link].SCA_XORController(SCA_IController) An XOR controller activates when there is the input is mixed, but not when all are on or off. There are no special python methods for this controller. class [Link].KX_Camera(KX_GameObject) A Camera object. INSIDE See sphereInsideFrustum and boxInsideFrustum INTERSECT See sphereInsideFrustum and boxInsideFrustum OUTSIDE See sphereInsideFrustum and boxInsideFrustum lens The cameras lens value. Type oat ortho_scale The cameras view scale when in orthographic mode. Type oat

4.1. Game Types ([Link])

1319

Blender Index, Release 2.59.2 - API

near The cameras near clip distance. Type oat far The cameras far clip distance. Type oat perspective True if this camera has a perspective transform, False for an orthographic projection. Type boolean frustum_culling True if this camera is frustum culling. Type boolean projection_matrix This cameras 4x4 projection matrix. Type 4x4 Matrix [[oat]] modelview_matrix This cameras 4x4 model view matrix. (read-only). Type 4x4 Matrix [[oat]] Note: This matrix is regenerated every frame from the cameras position and orientation. camera_to_world This cameras camera to world transform. (read-only). Type 4x4 Matrix [[oat]] Note: This matrix is regenerated every frame from the cameras position and orientation. world_to_camera This cameras world to camera transform. (read-only). Type 4x4 Matrix [[oat]] Note: Regenerated every frame from the cameras position and orientation.

Note: This is camera_to_world inverted. useViewport True when the camera is used as a viewport, set True to enable a viewport for this camera. Type boolean sphereInsideFrustum(centre, radius) Tests the given sphere against the view frustum. Parameters centre (list [x, y, z]) The centre of the sphere (in world coordinates.)

1320

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

radius (oat) the radius of the sphere Returns INSIDE, OUTSIDE or INTERSECT Return type integer Note: When the camera is rst initialized the result will be invalid because the projection matrix has not been set.
import GameLogic co = [Link]() cam = [Link] # A sphere of radius 4.0 located at [x, y, z] = [1.0, 1.0, 1.0] if ([Link]([1.0, 1.0, 1.0], 4) != [Link]): # Sphere is inside frustum ! # Do something useful ! else: # Sphere is outside frustum

boxInsideFrustum(box) Tests the given box against the view frustum. Parameters box (list of lists) Eight (8) corner points of the box (in world coordinates.) Returns INSIDE, OUTSIDE or INTERSECT Note: When the camera is rst initialized the result will be invalid because the projection matrix has not been set.
import GameLogic co = [Link]() cam = [Link] # Box to test... box = [] [Link]([-1.0, [Link]([-1.0, [Link]([-1.0, [Link]([-1.0, [Link]([ 1.0, [Link]([ 1.0, [Link]([ 1.0, [Link]([ 1.0,

-1.0, -1.0, 1.0, 1.0, -1.0, -1.0, 1.0, 1.0,

-1.0]) 1.0]) -1.0]) 1.0]) -1.0]) 1.0]) -1.0]) 1.0])

if ([Link](box) != [Link]): # Box is inside/intersects frustum ! # Do something useful ! else: # Box is outside the frustum !

pointInsideFrustum(point) Tests the given point against the view frustum. Parameters point (3D Vector) The point to test (in world coordinates.) Returns True if the given point is inside this cameras viewing frustum. Return type boolean 4.1. Game Types ([Link]) 1321

Blender Index, Release 2.59.2 - API

Note: When the camera is rst initialized the result will be invalid because the projection matrix has not been set.
import GameLogic co = [Link]() cam = [Link] # Test point [0.0, 0.0, 0.0] if ([Link]([0.0, 0.0, 0.0])): # Point is inside frustum ! # Do something useful ! else: # Box is outside the frustum !

getCameraToWorld() Returns the camera-to-world transform. Returns the camera-to-world transform matrix. Return type matrix (4x4 list) getWorldToCamera() Returns the world-to-camera transform. This returns the inverse matrix of getCameraToWorld(). Returns the world-to-camera transform matrix. Return type matrix (4x4 list) setOnTop() Set this cameras viewport ontop of all other viewport. setViewport(left, bottom, right, top) Sets the region of this viewport on the screen in pixels. Use [Link] and [Link] to calculate values relative to the entire display. Parameters left (integer) left pixel coordinate of this viewport bottom (integer) bottom pixel coordinate of this viewport right (integer) right pixel coordinate of this viewport top (integer) top pixel coordinate of this viewport getScreenPosition(object) Gets the position of an object projected on screen space.
# For an object in the middle of the screen, coord = [0.5, 0.5] coord = [Link](object)

Parameters object (KX_GameObject or 3D Vector) object name or list [x, y, z] Returns the objects position in screen coordinates. Return type list [x, y]

1322

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

getScreenVect(x, y) Gets the vector from the camera position in the screen coordinate direction. Parameters x (oat) X Axis y (oat) Y Axis Return type 3D Vector Returns The vector from screen coordinate.
# Gets the vector of the camera front direction: m_vect = [Link](0.5, 0.5)

getScreenRay(x, y, dist=inf, property=None) Look towards a screen coordinate (x, y) and nd rst object hit within dist that matches prop. The ray is similar to KX_GameObject->rayCastTo. Parameters x (oat) X Axis y (oat) Y Axis dist (oat) max distance to look (can be negative => look behind); 0 or omitted => detect up to other property (string) property name that object must have; can be omitted => detect any object Return type KX_GameObject Returns the rst object hit or None if no object or object does not match prop
# Gets an object with a property "wall" in front of the camera within a distance of 100: target = [Link](0.5, 0.5, 100, "wall")

class [Link].BL_ArmatureObject(KX_GameObject) An armature object. constraints The list of armature constraint dened on this armature. Elements of the list can be accessed by index or string. The key format for string access is <bone_name>:<constraint_name>. Type list of BL_ArmatureConstraint channels The list of armature channels. Elements of the list can be accessed by index or name the bone. Type list of BL_ArmatureChannel update() Ensures that the armature will be updated on next graphic frame. This action is unecessary if a KX_ArmatureActuator with mode run is active or if an action is playing. Use this function in other cases. It must be called on each frame to ensure that the armature is updated continously. class [Link].BL_ArmatureActuator(SCA_IActuator) Armature Actuators change constraint condition on armatures. Constants related to type

4.1. Game Types ([Link])

1323

Blender Index, Release 2.59.2 - API

KX_ACT_ARMATURE_RUN Just make sure the armature will be updated on the next graphic frame. This is the only persistent mode of the actuator: it executes automatically once per frame until stopped by a controller Value 0 KX_ACT_ARMATURE_ENABLE Enable the constraint. Value 1 KX_ACT_ARMATURE_DISABLE Disable the constraint (runtime constraint values are not updated). Value 2 KX_ACT_ARMATURE_SETTARGET Change target and subtarget of constraint. Value 3 KX_ACT_ARMATURE_SETWEIGHT Change weight of (only for IK constraint). Value 4 type The type of action that the actuator executes when it is active. Can be one of these constants Type integer constraint The constraint object this actuator is controlling. Type BL_ArmatureConstraint target The object that this actuator will set as primary target to the constraint it controls. Type KX_GameObject subtarget The object that this actuator will set as secondary target to the constraint it controls. Type KX_GameObject. Note: Currently, the only secondary target is the pole target for IK constraint. weight The weight this actuator will set on the constraint it controls. Type oat. Note: Currently only the IK constraint has a weight. It must be a value between 0 and 1.

Note: A weight of 0 disables a constraint while still updating constraint runtime values (see BL_ArmatureConstraint)

1324

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

class [Link].KX_ArmatureSensor(SCA_ISensor) Armature sensor detect conditions on armatures. Constants related to type KX_ARMSENSOR_STATE_CHANGED Detect that the constraint is changing state (active/inactive) Value 0 KX_ARMSENSOR_LIN_ERROR_BELOW Detect that the constraint linear error is above a threshold Value 1 KX_ARMSENSOR_LIN_ERROR_ABOVE Detect that the constraint linear error is below a threshold Value 2 KX_ARMSENSOR_ROT_ERROR_BELOW Detect that the constraint rotation error is above a threshold Value 3 KX_ARMSENSOR_ROT_ERROR_ABOVE Detect that the constraint rotation error is below a threshold Value 4 type The type of measurement that the sensor make when it is active. Can be one of these constants Type integer. constraint The constraint object this sensor is watching. Type BL_ArmatureConstraint value The threshold used in the comparison with the constraint error The linear error is only updated on CopyPose/Distance IK constraint with iTaSC solver The rotation error is only updated on CopyPose+rotation IK constraint with iTaSC solver The linear error on CopyPose is always >= 0: it is the norm of the distance between the target and the bone The rotation error on CopyPose is always >= 0: it is the norm of the equivalent rotation vector between the bone and the target orientations The linear error on Distance can be positive if the distance between the bone and the target is greater than the desired distance, and negative if the distance is smaller. Type oat class [Link].BL_ArmatureConstraint(PyObjectPlus) Proxy to Armature Constraint. Allows to change constraint on the y. BL_ArmatureObject.constraints. Note: Not all armature constraints are supported in the GE. Constants related to type CONSTRAINT_TYPE_TRACKTO CONSTRAINT_TYPE_KINEMATIC CONSTRAINT_TYPE_ROTLIKE 4.1. Game Types ([Link]) 1325 Obtained through

Blender Index, Release 2.59.2 - API

CONSTRAINT_TYPE_LOCLIKE CONSTRAINT_TYPE_MINMAX CONSTRAINT_TYPE_SIZELIKE CONSTRAINT_TYPE_LOCKTRACK CONSTRAINT_TYPE_STRETCHTO CONSTRAINT_TYPE_CLAMPTO CONSTRAINT_TYPE_TRANSFORM CONSTRAINT_TYPE_DISTLIMIT Constants related to ik_type CONSTRAINT_IK_COPYPOSE constraint is trying to match the position and eventually the rotation of the target. Value 0 CONSTRAINT_IK_DISTANCE Constraint is maintaining a certain distance to target subject to ik_mode Value 1 Constants related to ik_flag CONSTRAINT_IK_FLAG_TIP Set when the constraint operates on the head of the bone and not the tail Value 1 CONSTRAINT_IK_FLAG_ROT Set when the constraint tries to match the orientation of the target Value 2 CONSTRAINT_IK_FLAG_STRETCH Set when the armature is allowed to stretch (only the bones with stretch factor > 0.0) Value 16 CONSTRAINT_IK_FLAG_POS Set when the constraint tries to match the position of the target. Value 32 Constants related to ik_mode CONSTRAINT_IK_MODE_INSIDE The constraint tries to keep the bone within ik_dist of target Value 0 CONSTRAINT_IK_MODE_OUTSIDE The constraint tries to keep the bone outside ik_dist of the target Value 1 CONSTRAINT_IK_MODE_ONSURFACE The constraint tries to keep the bone exactly at ik_dist of the target. Value 2

1326

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

type Type of constraint, (read-only). Use one of these constants. Type integer, one of CONSTRAINT_TYPE_* constants name Name of constraint constructed as <bone_name>:<constraint_name>. constraints list. Type string This name is also the key subscript on BL_ArmatureObject. enforce fraction of constraint effect that is enforced. Between 0 and 1. Type oat headtail Position of target between head and tail of the target bone: 0=head, 1=tail. Type oat. Note: Only used if the target is a bone (i.e target object is an armature. lin_error runtime linear error (in Blender units) on constraint at the current frame. This is a runtime value updated on each frame by the IK solver. Only available on IK constraint and iTaSC solver. Type oat rot_error Runtime rotation error (in radiant) on constraint at the current frame. Type oat. This is a runtime value updated on each frame by the IK solver. Only available on IK constraint and iTaSC solver. It is only set if the constraint has a rotation part, for example, a CopyPose+Rotation IK constraint. target Primary target object for the constraint. The position of this object in the GE will be used as target for the constraint. Type KX_GameObject. subtarget Secondary target object for the constraint. The position of this object in the GE will be used as secondary target for the constraint. Type KX_GameObject. Currently this is only used for pole target on IK constraint. active True if the constraint is active. Type boolean

4.1. Game Types ([Link])

1327

Blender Index, Release 2.59.2 - API

Note: An inactive constraint does not update lin_error and rot_error. ik_weight Weight of the IK constraint between 0 and 1. Only dened for IK constraint. Type oat ik_type Type of IK constraint, (read-only). Use one of these constants. Type integer. ik_flag Combination of IK constraint option ags, read-only. Use one of these constants. Type integer ik_dist Distance the constraint is trying ik_type=CONSTRAINT_IK_DISTANCE. Type oat ik_mode Use one of these constants. Additional mode for IK constraint. Currently only used for Distance constraint: Type integer class [Link].BL_ArmatureChannel(PyObjectPlus) Proxy to armature pose channel. Allows to read and set armature pose. The attributes are identical to RNA attributes, but mostly in read-only mode. See rotation_mode PCHAN_ROT_QUAT PCHAN_ROT_XYZ PCHAN_ROT_XZY PCHAN_ROT_YXZ PCHAN_ROT_YZX PCHAN_ROT_ZXY PCHAN_ROT_ZYX name channel name (=bone name), read-only. Type string bone return the bone object corresponding to this pose channel, read-only. Type BL_ArmatureBone to maintain with target, only used when

1328

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

parent return the parent channel object, None if root channel, read-only. Type BL_ArmatureChannel has_ik true if the bone is part of an active IK chain, read-only. This ag is not set when an IK constraint is dened but not enabled (miss target information for example). Type boolean ik_dof_x true if the bone is free to rotation in the X axis, read-only. Type boolean ik_dof_y true if the bone is free to rotation in the Y axis, read-only. Type boolean ik_dof_z true if the bone is free to rotation in the Z axis, read-only. Type boolean ik_limit_x true if a limit is imposed on X rotation, read-only. Type boolean ik_limit_y true if a limit is imposed on Y rotation, read-only. Type boolean ik_limit_z true if a limit is imposed on Z rotation, read-only. Type boolean ik_rot_control true if channel rotation should applied as IK constraint, read-only. Type boolean ik_lin_control true if channel size should applied as IK constraint, read-only. Type boolean location displacement of the bone head in armature local space, read-write. Type vector [X, Y, Z]. Note: You can only move a bone if it is unconnected to its parent. An action playing on the armature may change the value. An IK chain does not update this value, see joint_rotation.

Note: Changing this eld has no immediate effect, the pose is updated when the armature is updated during the graphic render (see BL_ArmatureObject.update).

4.1. Game Types ([Link])

1329

Blender Index, Release 2.59.2 - API

scale scale of the bone relative to its parent, read-write. Type vector [sizeX, sizeY, sizeZ]. Note: An action playing on the armature may change the value. An IK chain does not update this value, see joint_rotation.

Note: Changing this eld has no immediate effect, the pose is updated when the armature is updated during the graphic render (see BL_ArmatureObject.update) rotation_quaternion rotation of the bone relative to its parent expressed as a quaternion, read-write. Type vector [qr, qi, qj, qk]. Note: This eld is only used if rotation_mode is 0. An action playing on the armature may change the value. An IK chain does not update this value, see joint_rotation.

Note: Changing this eld has no immediate effect, the pose is updated when the armature is updated during the graphic render (see BL_ArmatureObject.update) rotation_euler rotation of the bone relative to its parent expressed as a set of euler angles, read-write. Type vector [X, Y, Z]. Note: This eld is only used if rotation_mode is > 0. You must always pass the angles in [X, Y, Z] order; the order of applying the angles to the bone depends on rotation_mode. An action playing on the armature may change this eld. An IK chain does not update this value, see joint_rotation.

Note: Changing this eld has no immediate effect, the pose is updated when the armature is updated during the graphic render (see BL_ArmatureObject.update) rotation_mode Method of updating the bone rotation, read-write. Type integer Use the following constants (euler mode are named as in Blender UI but the actual axis order is reversed). PCHAN_ROT_QUAT(0) : use quaternioin in rotation attribute to update bone rotation PCHAN_ROT_XYZ(1) : use euler_rotation and apply angles on bones Z, Y, X axis successively PCHAN_ROT_XZY(2) : use euler_rotation and apply angles on bones Y, Z, X axis successively PCHAN_ROT_YXZ(3) : use euler_rotation and apply angles on bones Z, X, Y axis successively PCHAN_ROT_YZX(4) : use euler_rotation and apply angles on bones X, Z, Y axis successively PCHAN_ROT_ZXY(5) : use euler_rotation and apply angles on bones Y, X, Z axis successively PCHAN_ROT_ZYX(6) : use euler_rotation and apply angles on bones X, Y, Z axis successively

1330

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

channel_matrix pose matrix in bone space (deformation of the bone due to action, constraint, etc), Read-only. This eld is updated after the graphic render, it represents the current pose. Type matrix [4][4] pose_matrix pose matrix in armature space, read-only, This eld is updated after the graphic render, it represents the current pose. Type matrix [4][4] pose_head position of bone head in armature space, read-only. Type vector [x, y, z] pose_tail position of bone tail in armature space, read-only. Type vector [x, y, z] ik_min_x minimum value of X rotation in degree (<= 0) when X rotation is limited (see ik_limit_x), read-only. Type oat ik_max_x maximum value of X rotation in degree (>= 0) when X rotation is limited (see ik_limit_x), read-only. Type oat ik_min_y minimum value of Y rotation in degree (<= 0) when Y rotation is limited (see ik_limit_y), read-only. Type oat ik_max_y maximum value of Y rotation in degree (>= 0) when Y rotation is limited (see ik_limit_y), read-only. Type oat ik_min_z minimum value of Z rotation in degree (<= 0) when Z rotation is limited (see ik_limit_z), read-only. Type oat ik_max_z maximum value of Z rotation in degree (>= 0) when Z rotation is limited (see ik_limit_z), read-only. Type oat ik_stiffness_x bone rotation stiffness in X axis, read-only. Type oat between 0 and 1 ik_stiffness_y bone rotation stiffness in Y axis, read-only. Type oat between 0 and 1 ik_stiffness_z bone rotation stiffness in Z axis, read-only. Type oat between 0 and 1

4.1. Game Types ([Link])

1331

Blender Index, Release 2.59.2 - API

ik_stretch ratio of scale change that is allowed, 0=bone cant change size, read-only. Type oat ik_rot_weight weight of rotation constraint when ik_rot_control is set, read-write. Type oat between 0 and 1 ik_lin_weight weight of size constraint when ik_lin_control is set, read-write. Type oat between 0 and 1 joint_rotation Control bone rotation in term of joint angle (for robotic applications), read-write. When writing to this attribute, you pass a [x, y, z] vector and an appropriate set of euler angles or quaternion is calculated according to the rotation_mode. When you read this attribute, the current pose matrix is converted into a [x, y, z] vector representing the joint angles. The value and the meaning of the x, y, z depends on the ik_dof_x/ik_dof_y/ik_dof_z attributes: 1DoF joint X, Y or Z: the corresponding x, y, or z value is used an a joint angle in radiant 2DoF joint X+Y or Z+Y: treated as 2 successive 1DoF joints: rst X or Z, then Y. The x or z value is used as a joint angle in radiant along the X or Z axis, followed by a rotation along the new Y axis of y radiants. 2DoF joint X+Z: treated as a 2DoF joint with rotation axis on the X/Z plane. The x and z values are used as the coordinates of the rotation vector in the X/Z plane. 3DoF joint X+Y+Z: treated as a revolute joint. The [x, y, z] vector represents the equivalent rotation vector to bring the joint from the rest pose to the new pose. Type vector [x, y, z] Note: The bone must be part of an IK chain if you want to set the ik_dof_x/ik_dof_y/ik_dof_z attributes via the UI, but this will interfere with this attribute since the IK solver will overwrite the pose. You can stay in control of the armature if you create an IK constraint but do not nalize it (e.g. dont set a target) the IK solver will not run but the IK panel will show up on the UI for each bone in the chain.

Note: [0, 0, 0] always corresponds to the rest pose.

Note: You must request the armature pose to update and wait for the next graphic frame to see the effect of setting this attribute (see BL_ArmatureObject.update).

Note: You can read the result of the calculation in rotation or euler_rotation attributes after setting this attribute. class [Link].BL_ArmatureBone(PyObjectPlus) Proxy to Blender bone structure. All elds are read-only and comply to RNA names. All space attribute correspond to the rest pose.

1332

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

name bone name. Type string connected true when the bone head is struck to the parents tail. Type boolean hinge true when bone doesnt inherit rotation or scale from parent bone. Type boolean inherit_scale true when bone inherits scaling from parent bone. Type boolean bbone_segments number of B-bone segments. Type integer roll bone rotation around head-tail axis. Type oat head location of head end of the bone in parent bone space. Type vector [x, y, z] tail location of head end of the bone in parent bone space. Type vector [x, y, z] length bone length. Type oat arm_head location of head end of the bone in armature space. Type vector [x, y, z] arm_tail location of tail end of the bone in armature space. Type vector [x, y, z] arm_mat matrix of the bone head in armature space. Type matrix [4][4] Note: This matrix has no scale part. bone_mat rotation matrix of the bone in parent bone space.

4.1. Game Types ([Link])

1333

Blender Index, Release 2.59.2 - API

Type matrix [3][3] parent parent bone, or None for root bone. Type BL_ArmatureBone children list of bones children. Type list of BL_ArmatureBone

4.2 Game Logic ([Link])

4.2.1 Intro
Module to access logic functions, imported automatically into the python controllers namespace.
# To get the controller thats running this python script: cont = [Link]() # [Link] is automatically imported # To get the game object this controller is on: obj = [Link]

KX_GameObject and KX_Camera or KX_LightObject methods are available depending on the type of object
# To get a sensor linked to this controller. # "sensorname" is the name of the sensor as defined in the Blender interface. # +---------------------+ +--------+ # | Sensor "sensorname" +--+ Python + # +---------------------+ +--------+ sens = [Link]["sensorname"] # To get a sequence of all sensors: sensors = [Link]

See the sensors reference for available methods: KX_MouseFocusSensor KX_NearSensor KX_NetworkMessageSensor KX_RadarSensor KX_RaySensor KX_TouchSensor SCA_DelaySensor SCA_JoystickSensor SCA_KeyboardSensor SCA_MouseSensor SCA_PropertySensor SCA_RandomSensor

You can also access actuators linked to the controller

# To get an actuator attached to the controller: # +--------+ +-------------------------+ # + Python +--+ Actuator "actuatorname" | # +--------+ +-------------------------+ actuator = [Link]["actuatorname"]

1334

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

# Activate an actuator [Link](actuator)

See the actuators reference for available methods BL_ActionActuator BL_ShapeActionActuator KX_CameraActuator KX_ConstraintActuator KX_GameActuator KX_IpoActuator KX_NetworkMessageActuator KX_ObjectActuator KX_ParentActuator KX_SCA_AddObjectActuator KX_SCA_DynamicActuator KX_SCA_EndObjectActuator KX_SCA_ReplaceMeshActuator KX_SceneActuator KX_SoundActuator KX_StateActuator KX_TrackToActuator KX_VisibilityActuator SCA_2DFilterActuator SCA_PropertyActuator SCA_RandomActuator

Most logic bricks methods are accessors for the properties available in the logic buttons. Consult the logic bricks documentation for more information on how each logic brick works. There are also methods to access the current [Link].KX_Scene
# Get the current scene scene = [Link]() # Get the current camera cam = scene.active_camera

Matricies as used by the game engine are row major matrix[row][col] = float [Link].KX_Camera has some examples using matricies.

4.2.2 Variables
[Link] A dictionary that is saved between loading blend les so you can use it to store inventory and other variables you want to store between scenes and blend les. It can also be written to a le and loaded later on with the game load/save actuators. Note: only python built in types such as int/string/bool/oat/tuples/lists can be saved, GameObjects, Actuators etc will not work as expected. [Link] The current keyboard wrapped in an SCA_PythonKeyboard object.

4.2. Game Logic ([Link])

1335

Blender Index, Release 2.59.2 - API

[Link] The current mouse wrapped in an SCA_PythonMouse object.

4.2.3 General functions

[Link]() Gets the Python controller associated with this Python script. Return type [Link].SCA_PythonController [Link]() Gets the current Scene. Return type [Link].KX_Scene [Link]() Gets a list of the current scenes loaded in the game engine. Return type list of [Link].KX_Scene Note: Scenes in your blend le that have not been converted wont be in this list. This list will only contain scenes such as overlays scenes. [Link]() Loads [Link] from a le. [Link]() Saves [Link] to a le. [Link](blend) Loads the blend le. Parameters blend (string) The name of the blend le [Link]() Ends the current game. [Link]() Restarts the current game by reloading the .blend le (the last saved version, not what is currently running). [Link](blend, type, data, load_actions=False, verbose=False) Converts the all of the datablocks of the given type from the given blend. Parameters blend (string) The path to the blend le (or the name to use for the library if data is supplied) type (string) The datablock type (currently only Action, Mesh and Scene are supported) data (bytes) Binary data from a blend le (optional) load_actions (bool) Search for and load all actions in a given Scene and not just the active actions (Scene type only) verbose (bool) Whether or not to print debugging information (e.g., SceneName: Scene) [Link](name, type, data) Uses existing datablock data and loads in as a new library. Parameters

1336

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

name (string) A unique library name used for removal later type (string) The datablock type (currently only Mesh is supported) data (list of strings) A list of names of the datablocks to load [Link](name) Frees a library, removing all objects and meshes from the currently active scenes. Parameters name (string) The name of the library to free (the name used in LibNew) [Link]() Returns a list of currently loaded libraries. Return type list [str] [Link](name, overlay=1) Loads a scene into the game engine. Note: This function is not effective immediately, the scene is queued and added on the next logic cycle where it will be available from getSceneList Parameters name (string) The name of the scene overlay (integer) Overlay or underlay (optional) [Link](subject, body=, to=, message_from=) Sends a message to sensors in any active scene. Parameters subject (string) The subject of the message body (string) The body of the message (optional) to (string) The name of the object to send the message to (optional) message_from (string) The name of the object that the message is coming from (optional) [Link](gravity) Sets the world gravity.

[Link]() Returns a 512 point list from the sound card. This only works if the fmod sound driver is being used. Return type list [oat], len(getSpectrum()) == 512 [Link]() Stops the sound driver using DSP effects. Only the fmod sound driver supports this. DSP can be computationally expensive. [Link]() Gets the maximum number of logic frames per render frame. Returns The maximum number of logic frames per render frame Return type integer

4.2. Game Logic ([Link])

1337

Blender Index, Release 2.59.2 - API

[Link](maxlogic) Sets the maximum number of logic frames that are executed per render frame. This does not affect the physic system that still runs at full frame rate. Parameters maxlogic (integer) The new maximum number of logic frames per render frame. Valid values: 1..5 [Link]() Gets the maximum number of physics frames per render frame. Returns The maximum number of physics frames per render frame Return type integer [Link](maxphysics) Sets the maximum number of physics timestep that are executed per render frame. Higher value allows physics to keep up with realtime even if graphics slows down the game. Physics timestep is xed and equal to 1/tickrate (see setLogicTicRate) maxphysics/ticrate is the maximum delay of the renderer that physics can compensate. Parameters maxphysics (integer) The new maximum number of physics timestep per render frame. Valid values: 1..5. [Link]() Gets the logic update frequency. Returns The logic frequency in Hz Return type oat [Link](ticrate) Sets the logic update frequency. The logic update frequency is the number of times logic bricks are executed every second. The default is 60 Hz. Parameters ticrate (oat) The new logic update frequency (in Hz). [Link]() Gets the physics update frequency Returns The physics update frequency in Hz Return type oat [Link](ticrate) Sets the physics update frequency The physics update frequency is the number of times the physics system is executed every second. The default is 60 Hz. Parameters ticrate (oat) The new update frequency (in Hz).

4.2.4 Utility functions

[Link](path) Converts a blender internal path into a proper le system path. Use / as directory separator in path You can use // at the start of the string to dene a relative path; Blender replaces that string by the directory of the startup .blend or runtime le to make a full path name (doesnt change during the game, even if you load other .blend). The function also converts the directory separator to the local le system format. Parameters path (string) The path string to be converted/expanded. Returns The converted string 1338 Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

Return type string [Link]() Gets the estimated/average framerate for all the active scenes, not only the current scene. Returns The estimated average framerate in frames per second Return type oat [Link](path = //) Returns a list of blend les in the same directory as the open blend le, or from using the option argument. Parameters path (string) Optional directory argument, will be expanded (like expandPath) into the full path. Returns A list of lenames, with no directory prex Return type list [Link]() Returns a random oating point value in the range [0 - 1) [Link]() Prints GL Extension Info into the console

4.2.5 Constants
[Link].KX_TRUE True value used by some modules. [Link].KX_FALSE False value used by some modules. Sensors
Sensor Status

[Link].KX_SENSOR_INACTIVE [Link].KX_SENSOR_JUST_ACTIVATED [Link].KX_SENSOR_ACTIVE [Link].KX_SENSOR_JUST_DEACTIVATED

Property Sensor

[Link].KX_PROPSENSOR_EQUAL Activate when the property is equal to the sensor value. Value 1 [Link].KX_PROPSENSOR_NOTEQUAL Activate when the property is not equal to the sensor value. Value 2 [Link].KX_PROPSENSOR_INTERVAL Activate when the property is between the specied limits.

4.2. Game Logic ([Link])

1339

Blender Index, Release 2.59.2 - API

Value 3 [Link].KX_PROPSENSOR_CHANGED Activate when the property changes Value 4 [Link].KX_PROPSENSOR_EXPRESSION Activate when the expression matches Value 5
Radar Sensor

See [Link].KX_RadarSensor [Link].KX_RADAR_AXIS_POS_X [Link].KX_RADAR_AXIS_POS_Y [Link].KX_RADAR_AXIS_POS_Z [Link].KX_RADAR_AXIS_NEG_X [Link].KX_RADAR_AXIS_NEG_Y [Link].KX_RADAR_AXIS_NEG_Z

Ray Sensor

See [Link].KX_RaySensor [Link].KX_RAY_AXIS_POS_X [Link].KX_RAY_AXIS_POS_Y [Link].KX_RAY_AXIS_POS_Z [Link].KX_RAY_AXIS_NEG_X [Link].KX_RAY_AXIS_NEG_Y [Link].KX_RAY_AXIS_NEG_Z Actuators

Action Actuator

See [Link].BL_ActionActuator [Link].KX_ACTIONACT_PLAY [Link].KX_ACTIONACT_FLIPPER [Link].KX_ACTIONACT_LOOPSTOP [Link].KX_ACTIONACT_LOOPEND [Link].KX_ACTIONACT_PROPERTY

1340

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

Constraint Actuator

See [Link].KX_ConstraintActuator.option Applicable to Distance constraint: [Link].KX_ACT_CONSTRAINT_NORMAL Activate alignment to surface [Link].KX_ACT_CONSTRAINT_DISTANCE Activate distance control [Link].KX_ACT_CONSTRAINT_LOCAL Direction of the ray is along the local axis Applicable to Force eld constraint: [Link].KX_ACT_CONSTRAINT_DOROTFH Force eld act on rotation as well Applicable to both: [Link].KX_ACT_CONSTRAINT_MATERIAL Detect material rather than property [Link].KX_ACT_CONSTRAINT_PERMANENT No deactivation if ray does not hit target See [Link].KX_ConstraintActuator.limit [Link].KX_CONSTRAINTACT_LOCX Limit X coord. [Link].KX_CONSTRAINTACT_LOCY Limit Y coord [Link].KX_CONSTRAINTACT_LOCZ Limit Z coord [Link].KX_CONSTRAINTACT_ROTX Limit X rotation [Link].KX_CONSTRAINTACT_ROTY Limit Y rotation [Link].KX_CONSTRAINTACT_ROTZ Limit Z rotation [Link].KX_CONSTRAINTACT_DIRNX Set distance along negative X axis [Link].KX_CONSTRAINTACT_DIRNY Set distance along negative Y axis [Link].KX_CONSTRAINTACT_DIRNZ Set distance along negative Z axis [Link].KX_CONSTRAINTACT_DIRPX Set distance along positive X axis [Link].KX_CONSTRAINTACT_DIRPY Set distance along positive Y axis [Link].KX_CONSTRAINTACT_DIRPZ Set distance along positive Z axis 4.2. Game Logic ([Link]) 1341

Blender Index, Release 2.59.2 - API

[Link].KX_CONSTRAINTACT_ORIX Set orientation of X axis [Link].KX_CONSTRAINTACT_ORIY Set orientation of Y axis [Link].KX_CONSTRAINTACT_ORIZ Set orientation of Z axis [Link].KX_ACT_CONSTRAINT_FHNX Set force eld along negative X axis [Link].KX_ACT_CONSTRAINT_FHNY Set force eld along negative Y axis [Link].KX_ACT_CONSTRAINT_FHNZ Set force eld along negative Z axis [Link].KX_ACT_CONSTRAINT_FHPX Set force eld along positive X axis [Link].KX_ACT_CONSTRAINT_FHPY Set force eld along positive Y axis [Link].KX_ACT_CONSTRAINT_FHPZ Set force eld along positive Z axis
Dynamic Actuator

See [Link].KX_SCA_DynamicActuator [Link].KX_DYN_RESTORE_DYNAMICS [Link].KX_DYN_DISABLE_DYNAMICS [Link].KX_DYN_ENABLE_RIGID_BODY [Link].KX_DYN_DISABLE_RIGID_BODY [Link].KX_DYN_SET_MASS

Game Actuator

See [Link].KX_GameActuator [Link].KX_GAME_LOAD [Link].KX_GAME_START [Link].KX_GAME_RESTART [Link].KX_GAME_QUIT [Link].KX_GAME_SAVECFG [Link].KX_GAME_LOADCFG

1342

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

IPO Actuator

See [Link].KX_IpoActuator [Link].KX_IPOACT_PLAY [Link].KX_IPOACT_PINGPONG [Link].KX_IPOACT_FLIPPER [Link].KX_IPOACT_LOOPSTOP [Link].KX_IPOACT_LOOPEND [Link].KX_IPOACT_FROM_PROP

Parent Actuator

[Link].KX_PARENT_REMOVE [Link].KX_PARENT_SET
Random Distributions

See [Link].SCA_RandomActuator [Link].KX_RANDOMACT_BOOL_CONST [Link].KX_RANDOMACT_BOOL_UNIFORM [Link].KX_RANDOMACT_BOOL_BERNOUILLI [Link].KX_RANDOMACT_INT_CONST [Link].KX_RANDOMACT_INT_UNIFORM [Link].KX_RANDOMACT_INT_POISSON [Link].KX_RANDOMACT_FLOAT_CONST [Link].KX_RANDOMACT_FLOAT_UNIFORM [Link].KX_RANDOMACT_FLOAT_NORMAL [Link].KX_RANDOMACT_FLOAT_NEGATIVE_EXPONENTIAL
Scene Actuator

See [Link].KX_SceneActuator [Link].KX_SCENE_RESTART [Link].KX_SCENE_SET_SCENE [Link].KX_SCENE_SET_CAMERA [Link].KX_SCENE_ADD_FRONT_SCENE [Link].KX_SCENE_ADD_BACK_SCENE [Link].KX_SCENE_REMOVE_SCENE [Link].KX_SCENE_SUSPEND 4.2. Game Logic ([Link]) 1343

Blender Index, Release 2.59.2 - API

[Link].KX_SCENE_RESUME
Shape Action Actuator

See [Link].BL_ActionActuator [Link].KX_ACTIONACT_PLAY [Link].KX_ACTIONACT_FLIPPER [Link].KX_ACTIONACT_LOOPSTOP [Link].KX_ACTIONACT_LOOPEND [Link].KX_ACTIONACT_PROPERTY

Sound Actuator

See [Link].KX_SoundActuator [Link].KX_SOUNDACT_PLAYSTOP Value 1 [Link].KX_SOUNDACT_PLAYEND Value 2 [Link].KX_SOUNDACT_LOOPSTOP Value 3 [Link].KX_SOUNDACT_LOOPEND Value 4 [Link].KX_SOUNDACT_LOOPBIDIRECTIONAL Value 5 [Link].KX_SOUNDACT_LOOPBIDIRECTIONAL_STOP Value 6 Various
Input Status

See [Link].SCA_PythonKeyboard, [Link].SCA_PythonMouse, [Link].SCA_MouseSensor, [Link].SCA_KeyboardSensor [Link].KX_INPUT_NONE [Link].KX_INPUT_JUST_ACTIVATED [Link].KX_INPUT_ACTIVE [Link].KX_INPUT_JUST_RELEASED

1344

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

Mouse Buttons

See [Link].SCA_MouseSensor [Link].KX_MOUSE_BUT_LEFT [Link].KX_MOUSE_BUT_MIDDLE [Link].KX_MOUSE_BUT_RIGHT

States

See [Link].KX_StateActuator [Link].KX_STATE1 [Link].KX_STATE2 [Link].KX_STATE3 [Link].KX_STATE4 [Link].KX_STATE5 [Link].KX_STATE6 [Link].KX_STATE7 [Link].KX_STATE8 [Link].KX_STATE9 [Link].KX_STATE10 [Link].KX_STATE11 [Link].KX_STATE12 [Link].KX_STATE13 [Link].KX_STATE14 [Link].KX_STATE15 [Link].KX_STATE16 [Link].KX_STATE17 [Link].KX_STATE18 [Link].KX_STATE19 [Link].KX_STATE20 [Link].KX_STATE21 [Link].KX_STATE22 [Link].KX_STATE23 [Link].KX_STATE24 [Link].KX_STATE25 [Link].KX_STATE26 [Link].KX_STATE27

4.2. Game Logic ([Link])

1345

Blender Index, Release 2.59.2 - API

[Link].KX_STATE28 [Link].KX_STATE29 [Link].KX_STATE30 See [Link].KX_StateActuator.operation [Link].KX_STATE_OP_CLR Substract bits to state mask Value 0 [Link].KX_STATE_OP_CPY Copy state mask Value 1 [Link].KX_STATE_OP_NEG Invert bits to state mask Value 2 [Link].KX_STATE_OP_SET Add bits to state mask Value 3
2D Filter

[Link].RAS_2DFILTER_BLUR Value 2 [Link].RAS_2DFILTER_CUSTOMFILTER Customer lter, the code code is set via shaderText property. Value 12 [Link].RAS_2DFILTER_DILATION Value 4 [Link].RAS_2DFILTER_DISABLED Disable the lter that is currently active Value -1 [Link].RAS_2DFILTER_ENABLED Enable the lter that was previously disabled Value -2 [Link].RAS_2DFILTER_EROSION Value 5 [Link].RAS_2DFILTER_GRAYSCALE Value 9 [Link].RAS_2DFILTER_INVERT Value 11 [Link].RAS_2DFILTER_LAPLACIAN

1346

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

Value 6 [Link].RAS_2DFILTER_MOTIONBLUR Create and enable preset lters Value 1 [Link].RAS_2DFILTER_NOFILTER Disable and destroy the lter that is currently active Value 0 [Link].RAS_2DFILTER_PREWITT Value 8 [Link].RAS_2DFILTER_SEPIA Value 10 [Link].RAS_2DFILTER_SHARPEN Value 3 [Link].RAS_2DFILTER_SOBEL Value 7
Shader

[Link] [Link].VIEWMATRIX_INVERSE [Link].VIEWMATRIX_INVERSETRANSPOSE [Link].VIEWMATRIX_TRANSPOSE [Link] [Link].MODELMATRIX_INVERSE [Link].MODELMATRIX_INVERSETRANSPOSE [Link].MODELMATRIX_TRANSPOSE [Link] [Link].MODELVIEWMATRIX_INVERSE [Link].MODELVIEWMATRIX_INVERSETRANSPOSE [Link].MODELVIEWMATRIX_TRANSPOSE [Link].CAM_POS Current camera position [Link].CONSTANT_TIMER User a timer for the uniform value. [Link].SHD_TANGENT

4.2. Game Logic ([Link])

1347

Blender Index, Release 2.59.2 - API

Blender Material

[Link].BL_DST_ALPHA [Link].BL_DST_COLOR [Link].BL_ONE [Link].BL_ONE_MINUS_DST_ALPHA [Link].BL_ONE_MINUS_DST_COLOR [Link].BL_ONE_MINUS_SRC_ALPHA [Link].BL_ONE_MINUS_SRC_COLOR [Link].BL_SRC_ALPHA [Link].BL_SRC_ALPHA_SATURATE [Link].BL_SRC_COLOR [Link].BL_ZERO

4.3 Rasterizer ([Link])

4.3.1 Intro
# Example Uses an L{SCA_MouseSensor}, and two L{KX_ObjectActuator}s to implement MouseLook:: # To use a mouse movement sensor "Mouse" and a # motion actuator to mouse look: import [Link] import [Link] # scale sets the speed of motion scale = 1.0, 0.5 co = [Link]() obj = [Link]() mouse = [Link]("Mouse") lmotion = [Link]("LMove") wmotion = [Link]("WMove") # Transform the mouse coordinates to see how far the mouse has moved. def mousePos(): x = ([Link]() / 2 - [Link]()) * scale[0] y = ([Link]() / 2 - [Link]()) * scale[1] return (x, y) pos = mousePos() # Set the amount of motion: X is applied in world coordinates... [Link](0.0, 0.0, pos[0], False) # ...Y is applied in local coordinates [Link](-pos[1], 0.0, 0.0, True) # Activate both actuators [Link](lmotion, True) [Link](wmotion, True)

1348

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

# Centre the mouse [Link]([Link]() / 2, [Link]() / 2)

4.3.2 Constants
[Link].KX_TEXFACE_MATERIAL Materials as dened by the texture face settings. [Link].KX_BLENDER_MULTITEX_MATERIAL Materials approximating blender materials with multitexturing. [Link].KX_BLENDER_GLSL_MATERIAL Materials approximating blender materials with GLSL.

4.3.3 Functions
[Link]() Gets the width of the window (in pixels) Return type integer [Link]() Gets the height of the window (in pixels) Return type integer [Link](lename) Writes a screenshot to the given lename. If lename starts with // the image will be saved relative to the current directory. If the lename contains # it will be replaced with the frame number. The standalone player saves .png les. It does not support colour space conversion or gamma correction. When run from Blender, makeScreenshot supports Iris, IrisZ, TGA, Raw TGA, PNG, HamX, and Jpeg. Gamma, Colourspace conversion and Jpeg compression are taken from the Render settings panels.

[Link](visible) Doesnt really do anything... [Link](visible) Enables or disables the operating system mouse cursor.

[Link](x, y) Sets the mouse cursor position.

[Link](rgba) Sets the window background colour.

[Link](rgb) Sets the mist colour.

4.3. Rasterizer ([Link])

1349

Blender Index, Release 2.59.2 - API

[Link](rgb) Sets the color of ambient light.

[Link](start) Sets the mist start value. Objects further away than start will have mist applied to them.

[Link](end) Sets the mist end value. Objects further away from this will be coloured solid with the colour set by setMistColor().

[Link]() Disables mist. Note: Set any of the mist properties to enable mist. [Link](eyesep) Sets the eye separation for stereo mode. Usually Focal Length/30 provides a confortable value. Parameters eyesep (oat) The distance between the left and right eye. [Link]() Gets the current eye separation for stereo mode. Return type oat [Link](focallength) Sets the focal length for stereo mode. It uses the current camera focal length as initial value. Parameters focallength (oat) The focal length. [Link]() Gets the current focal length for stereo mode. Return type oat [Link](mode) Set the material mode to use for OpenGL rendering.

Note: Changes will only affect newly created scenes. [Link](mode) Get the material mode to use for OpenGL rendering. Return type KX_TEXFACE_MATERIAL, KX_BLENDER_GLSL_MATERIAL [Link](setting, enable) Enables or disables a GLSL material setting. KX_BLENDER_MULTITEX_MATERIAL,

[Link](setting, enable) Get the state of a GLSL material setting. Return type boolean 1350 Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

[Link](level) Set the anisotropic ltering level for textures. Parameters level (integer (must be one of 1, 2, 4, 8, 16)) The new anisotropic ltering level to use [Link]() Get the anisotropic ltering level used for textures. Return type integer (one of 1, 2, 4, 8, 16) [Link](fromVec, toVec, color) Draw a line in the 3D scene. Parameters fromVec (list [x, y, z]) the origin of the line toVec (list [x, y, z]) the end of the line color (list [r, g, b]) the color of the line [Link](factor) Enable the motion blur effect. Parameters factor (oat [0.0 - 1.0]) the ammount of motion blur to display. [Link]() Disable the motion blur effect.

4.4 Video Texture ([Link])

4.4.1 Intro
The [Link] module allows you to manipulate textures during the game. Several sources for texture are possible: video les, image les, video capture, memory buffer, camera render or a mix of that. The video and image les can be loaded from the internet using an URL instead of a le name. In addition, you can apply lters on the images before sending them to the GPU, allowing video effect: blue screen, color band, gray, normal map. [Link] uses FFmpeg to load images and videos. All the formats and codecs that FFmpeg supports are supported by this module, including but not limited to:
* * * * * * * * AVI Ogg Xvid Theora dv1394 camera video4linux capture card (this includes many webcams) videoForWindows capture card (this includes many webcams) JPG

The principle is simple: rst you identify a texture on an existing object using the :materialID: function, then you create a new texture with dynamic content and swap the two textures in the GPU. The GE is not aware of the substitution and continues to display the object as always, except that you are now in control of the texture. When the texture object is deleted, the new texture is deleted and the old texture restored. 4.4. Video Texture ([Link]) 1351

Blender Index, Release 2.59.2 - API

""" Basic Video Playback ++++++++++++++++++++++ Example of how to replace a texture in game with a video. It needs to run everyframe """ import bge from bge import texture from bge import logic cont = [Link]() obj = [Link] # the creation of the texture must be done once: save the # texture object in an attribute of [Link] module makes it persistent if not hasattr(logic, video): # identify a static texture by name matID = [Link](obj, [Link]) # create a dynamic texture that will replace the static texture [Link] = [Link](obj, matID) # define a source of image for the texture, here a movie movie = [Link](//trailer_400p.ogg) [Link] = [Link](movie) [Link] = True # quick off the movie, but it wont play in the background [Link]() # you need to call this function every frame to ensure update of the texture. [Link](True) """ Texture replacement ++++++++++++++++++++++ Example of how to replace a texture in game with an external image. createTexture() and removeTexture() are to be called from a module Python Controller. """ from bge import logic from bge import texture

def createTexture(cont): """Create a new Dynamic Texture""" object = [Link] # get the reference pointer (ID) of the internal texture ID = [Link](object, [Link]) # create a texture object object_texture = [Link](object, ID) # create a new source with an external image url = [Link]("//[Link]") new_source = [Link](url)

1352

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

# the texture has to be stored in a permanent Python object [Link] = object_texture # update/replace the texture [Link] = new_source [Link](False)

Blender Index, Release 2.59.2 - API

4.5 Game Keys ([Link])

4.5.1 Intro
This module holds key constants for the SCA_KeyboardSensor.
# Set a connected keyboard sensor to accept F1 import bge co = [Link]() # Keyboard is a keyboard sensor sensor = [Link]["Keyboard"] [Link] = [Link].F1KEY # Do the all keys thing import bge co = [Link]() # Keyboard is a keyboard sensor sensor = [Link]["Keyboard"] for key,status in [Link]: # key[0] == [Link], key[1] = status if status == [Link].KX_INPUT_JUST_ACTIVATED: if key == [Link]: # Activate Forward! if key == [Link]: # Activate Backward! if key == [Link]: # Activate Left! if key == [Link]: # Activate Right! # The all keys thing without a keyboard sensor (but you will # need an always sensor with pulse mode on) import bge # Just shortening names here keyboard = [Link] JUST_ACTIVATED = [Link].KX_INPUT_JUST_ACTIVATED if [Link][[Link]] print("Activate Forward!") if [Link][[Link]] print("Activate Backward!") if [Link][[Link]] print("Activate Left!") if [Link][[Link]] print("Activate Right!") == JUST_ACTIVATED: == JUST_ACTIVATED: == JUST_ACTIVATED: == JUST_ACTIVATED:

4.5.2 Functions
[Link](event) Return the string name of a key event. Will raise a ValueError error if its invalid. Parameters event (int) key event from [Link] or the keyboard sensor.

4.5. Game Keys ([Link])

1359

Blender Index, Release 2.59.2 - API

Return type string [Link](event, shift) Return the string name of a key event. Returns an empty string if the event cant be represented as a character. Parameters event (int) key event from [Link] or the keyboard sensor. shift (bool) set to true if shift is held. Return type string

4.5.3 Keys (Constants)

Mouse Keys [Link] [Link] [Link] [Link] [Link] [Link] [Link] Keyboard Keys
Alphabet keys

[Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link]

1360

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

[Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link]
Number keys

[Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link]
Modiers Keys

[Link] [Link] [Link] [Link] [Link] [Link] [Link]

4.5. Game Keys ([Link])

1361

Blender Index, Release 2.59.2 - API

Arrow Keys

[Link] [Link] [Link] [Link]

Numberpad Keys

[Link].PAD0 [Link].PAD1 [Link].PAD2 [Link].PAD3 [Link].PAD4 [Link].PAD5 [Link].PAD6 [Link].PAD7 [Link].PAD8 [Link].PAD9 [Link] [Link] [Link] [Link] [Link] [Link]
Function Keys

[Link].F1KEY [Link].F2KEY [Link].F3KEY [Link].F4KEY [Link].F5KEY [Link].F6KEY [Link].F7KEY [Link].F8KEY [Link].F9KEY [Link].F10KEY

1362

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

[Link].F11KEY [Link].F12KEY [Link].F13KEY [Link].F14KEY [Link].F15KEY [Link].F16KEY [Link].F17KEY [Link].F18KEY [Link].F19KEY

Other Keys

[Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link] [Link](Deprecated: use [Link] ) [Link] [Link] [Link] [Link] [Link]

4.5. Game Keys ([Link])

1363

Blender Index, Release 2.59.2 - API

4.6 Physics Constraints ([Link])

""" Basic Physics Constraint ++++++++++++++++++++++ Example of how to create a hinge Physics Constraint between two objects. """ from bge import logic from bge import constraints # get object list objects = [Link]().objects # get object named Object1 and Object 2 object_1 = objects["Object1"] object_2 = objects["Object2"] # want to use Edge constraint type constraint_type = 2 # get Object1 and Object2 physics IDs physics_id_1 = object_1.getPhysicsId() physics_id_2 = object_2.getPhysicsId() # Use bottom right edge of Object1 for hinge position edge_position_x = 1.0 edge_position_y = 0.0 edge_position_z = -1.0 # use Object1 y axis for angle to point hinge edge_angle_x = 0.0 edge_angle_y = 1.0 edge_angle_z = 0.0 # create an edge constraint [Link](physics_id_1, physics_id_2, constraint_type, edge_position_x, edge_position_y, edge_position_z, edge_angle_x, edge_angle_y, edge_angle_z)

[Link](physicsid, physicsid2, constrainttype, [pivotX, pivotY, pivotZ, [axisX, axisY, axisZ, [ag]]]]) Creates a constraint. Parameters physicsid (int) the physics id of the rst object in constraint physicsid2 (int) the physics id of the second object in constraint constrainttype the type of the constraint. The constraint types are: POINTTOPOINT_CONSTRAINT LINEHINGE_CONSTRAINT ANGULAR_CONSTRAINT CONETWIST_CONSTRAINT VEHICLE_CONSTRAINT 1364 Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

Parameters pivotX (oat) pivot X position pivotY (oat) pivot Y position pivotZ (oat) pivot Z position axisX (oat) X axis axisY (oat) Y axis axisZ (oat) Z axis ag (int) [Link] Simbolic constant string that indicates error. [Link](lename) export a .bullet le Parameters lename (string) File name [Link](constraintId) Parameters constraintId (int) The id of the constraint. Returns the most recent applied impulse. Return type oat [Link](constraintId) Parameters constraintId (int) The id of the vehicle constraint. Returns a vehicle constraint object. Return type [Link].KX_VehicleWrapper [Link](constraintId) Removes a constraint. Parameters constraintId (int) The id of the constraint to be removed. [Link](ccdMode)

Note: Very experimental, not recommended Sets the CCD (Continous Colision Detection) mode in the Physics Environment. Parameters ccdMode (int) The new CCD mode. [Link](breakingTreshold)

Note: Reasonable default is 0.02 (if units are meters) Sets tresholds to do with contact point management. Parameters breakingTreshold (oat) The new contact breaking treshold. [Link](angularTreshold) Sets the angular velocity treshold. 4.6. Physics Constraints ([Link]) 1365

Blender Index, Release 2.59.2 - API

Parameters angularTreshold (oat) New deactivation angular treshold. [Link](linearTreshold) Sets the linear velocity treshold. Parameters linearTreshold (oat) New deactivation linear treshold. [Link](time) Sets the time after which a resting rigidbody gets deactived. Parameters time (oat) The deactivation time. [Link](mode) Sets the debug mode. Debug modes: DBG_NODEBUG DBG_DRAWWIREFRAME DBG_DRAWAABB DBG_DRAWFREATURESTEXT DBG_DRAWCONTACTPOINTS DBG_NOHELPTEXT DBG_DRAWTEXT DBG_PROFILETIMINGS DBG_ENABLESATCOMPARISION DBG_DISABLEBULLETLCP DBG_ENABLECCD DBG_DRAWCONSTRAINTS DBG_DRAWCONSTRAINTLIMITS DBG_FASTWIREFRAME Parameters mode (int) The new debug mode. [Link](x, y, z) Sets the gravity force. Parameters x (oat) Gravity X force. y (oat) Gravity Y force. z (oat) Gravity Z force. [Link](damping)

Note: Not implemented. Sets the linear air damping for rigidbodies.

1366

Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

[Link](numiter) Sets the number of iterations for an iterative constraint solver. Parameters numiter (int) New number of iterations. [Link](numsubstep) Sets the number of substeps for each physics proceed. Tradeoff quality for performance. Parameters numsubstep (int) New number of substeps. [Link](damping)

Note: Very experimental, not recommended Sets the damper constant of a penalty based solver. Parameters damping (oat) New damping for the solver. [Link](tau)

Note: Very experimental, not recommended Sets the spring constant of a penalty based solver. Parameters tau (oat) New tau for the solver. [Link](solverType)

Note: Very experimental, not recommended Sets the solver type. Parameters solverType (int) The new type of the solver. [Link](sor)

Note: Very experimental, not recommended Sets the successive overrelaxation constant. Parameters sor (oat) New sor value. [Link](epa) Not implemented. [Link].DBG_NODEBUG

Note: Debug mode to be used with function setDebugMode No debug.

4.6. Physics Constraints ([Link])

1367

Blender Index, Release 2.59.2 - API

[Link].DBG_DRAWWIREFRAME

Note: Debug mode to be used with function setDebugMode Draw wireframe in debug. [Link].DBG_DRAWAABB

Note: Debug mode to be used with function setDebugMode Draw Axis Aligned Bounding Box in debug. [Link].DBG_DRAWFREATURESTEXT

Note: Debug mode to be used with function setDebugMode Draw freatures text in debug. [Link].DBG_DRAWCONTACTPOINTS

Note: Debug mode to be used with function setDebugMode Draw contact points in debug. [Link].DBG_NOHELPTEXT

Note: Debug mode to be used with function setDebugMode Debug without help text. [Link].DBG_DRAWTEXT

Note: Debug mode to be used with function setDebugMode Draw text in debug. [Link].DBG_PROFILETIMINGS

Note: Debug mode to be used with function setDebugMode Draw prole timings in debug. [Link].DBG_ENABLESATCOMPARISION

Note: Debug mode to be used with function setDebugMode 1368 Chapter 4. Game Engine Modules

Blender Index, Release 2.59.2 - API

Enable sat comparision in debug. [Link].DBG_DISABLEBULLETLCP

Note: Debug mode to be used with function setDebugMode Disable Bullet LCP. [Link].DBG_ENABLECCD

Note: Debug mode to be used with function setDebugMode Enable Continous Colision Detection in debug. [Link].DBG_DRAWCONSTRAINTS

Note: Debug mode to be used with function setDebugMode Draw constraints in debug. [Link].DBG_DRAWCONSTRAINTLIMITS

Note: Debug mode to be used with function setDebugMode Draw constraint limits in debug. [Link].DBG_FASTWIREFRAME

Note: Debug mode to be used with function setDebugMode Draw a fast wireframe in debug. [Link].POINTTOPOINT_CONSTRAINT

Note: Constraint type to be used with function createConstraint [Link].LINEHINGE_CONSTRAINT

Note: Constraint type to be used with function createConstraint [Link].ANGULAR_CONSTRAINT

Note: Constraint type to be used with function createConstraint

4.6. Physics Constraints ([Link])

1369

Blender Index, Release 2.59.2 - API

[Link].CONETWIST_CONSTRAINT

Note: Constraint type to be used with function createConstraint [Link].VEHICLE_CONSTRAINT

Note: Constraint type to be used with function createConstraint

1370

Chapter 4. Game Engine Modules

CHAPTER

FIVE

API INFO
5.1 Blender API Change Log
5.1.1 2.56 to 2.57
[Link]
Function Arguments

[Link] (count), was (number) [Link]

Added

[Link].use_stamp_lens
Removed

use_backbuf [Link]
Added

[Link] [Link].active_index [Link]

Renamed

curves -> [Link]

1371

Blender Index, Release 2.59.2 - API

[Link]
Removed

network_render [Link]
Added

[Link].use_material_physics_fh
Removed

use_material_physics [Link]
Function Arguments

[Link].use_material_physics (count), was (number) [Link]

Added

[Link] [Link] [Link]

Added

[Link].material_offset [Link].material_offset_rim
Removed

use_rim_material [Link]
Removed

use_keyframe_insert_keyingset

1372

Chapter 5. API Info

Blender Index, Release 2.59.2 - API

[Link]
Added

[Link].bump_method [Link].bump_objectspace
Removed

use_old_bump [Link]
Added

[Link].particle_uv [Link].use_edge_cut
Removed

use_edge_split [Link]
Added

[Link] [Link]
Added

[Link].limit_angle_max_x [Link].limit_angle_max_y [Link].limit_angle_max_z [Link].limit_angle_min_x [Link].limit_angle_min_y [Link].limit_angle_min_z [Link].limit_max_x [Link].limit_max_y [Link].limit_max_z [Link].limit_min_x [Link].limit_min_y 5.1. Blender API Change Log 1373

Blender Index, Release 2.59.2 - API

[Link].limit_min_z
Removed

limit_cone_max limit_cone_min limit_generic_max limit_generic_min [Link]

Renamed

items -> [Link].keymap_items [Link]

Added

[Link].backdrop_channels [Link].backdrop_x [Link].backdrop_y [Link].backdrop_zoom [Link].use_auto_render [Link]

Added

[Link].factor_density [Link].factor_radius [Link].factor_repulsion [Link].factor_rest_length [Link].factor_stiff_viscosity [Link] [Link] [Link].spring_frames [Link].stiff_viscosity [Link].use_initial_rest_length [Link].use_viscoelastic_springs [Link].yield_ratio 1374 Chapter 5. API Info

Blender Index, Release 2.59.2 - API

Removed

stiffness_near viscosity_beta
Renamed

viscosity_omega -> [Link].linear_viscosity [Link]

Added

[Link].direction_axis_pos [Link].fh_force
Removed

spring [Link]
Renamed

operator_enums -> [Link].operator_enum [Link]

Added

[Link].show_pose_markers [Link]
Added

[Link].edge_path_live_unwrap [Link].proportional_size [Link].use_keyframe_insert_keyingset

5.1. Blender API Change Log

1375

Blender Index, Release 2.59.2 - API

[Link]
Added

[Link].bbone_x [Link].bbone_z
Function Arguments

[Link].bbone_z (self, matrix, scale, roll), was (self, matrix) [Link]

Renamed

update -> [Link].update_tag [Link]

Added

[Link].use_fancy_drawing [Link]
Added

[Link].child_seed [Link]
Removed

use_play_3d_editors use_play_animation_editors use_play_image_editors use_play_node_editors use_play_properties_editors use_play_sequence_editors use_play_top_left_3d_editor

1376

Chapter 5. API Info

Blender Index, Release 2.59.2 - API

[Link]
Added

[Link]
Renamed

show_extra_edge_angle -> [Link].show_extra_face_angle

Function Arguments

1378

Chapter 5. API Info

Blender Index, Release 2.59.2 - API

Removed

active [Link]
Renamed

noisebasis_2 -> [Link].noise_basis_2 [Link]

Removed

is_hair
Renamed

keys -> [Link].hair_keys keys -> [Link].particle_keys [Link]

Added

[Link].use_apply_on_spline [Link]
Added

[Link].is_enum_flag [Link]
Added

[Link].texture_context
Removed

show_brush_texture

5.1. Blender API Change Log

1379

Blender Index, Release 2.59.2 - API

[Link]
Added

[Link]
Removed

assign [Link]
Added

[Link].shadow_only_type [Link]
Function Arguments

[Link].shadow_only_type (lename, x, y), was (lename) [Link]

Added

[Link].is_modified
Renamed

create_dupli_list -> [Link].dupli_list_create create_mesh -> [Link].to_mesh free_dupli_list -> [Link].dupli_list_clear [Link]
Added

[Link] [Link]

1380

Chapter 5. API Info

Blender Index, Release 2.59.2 - API

[Link]
Added

[Link].filter_fcurve_name [Link].show_lattices [Link].show_only_matching_fcurves [Link]

Function Arguments

[Link].show_only_matching_fcurves (data_path, index, action_group), was (data_path, array_index, action_group) [Link]

Added

[Link].cull_face
Removed

use_cull_back_faces use_cull_front_faces [Link]

Added

[Link].addon_filter [Link].addon_search [Link].addon_support [Link].event_timer_add [Link].event_timer_remove [Link]

Renamed

noisebasis_2 -> [Link].noise_basis_2

5.1. Blender API Change Log

1381

Blender Index, Release 2.59.2 - API

[Link]
Added

[Link] [Link] [Link] [Link]

Added

[Link]
Function Arguments

[Link] (count), was (frame, value, replace, needed, fast) [Link].ThemeView3D

Added

[Link].ThemeView3D.outline_width [Link]
Added

[Link] [Link]
Added

[Link].bbone_x [Link].bbone_z [Link]

Removed

draw_entry draw_ltered draw_hierarchy

1382

Chapter 5. API Info

Blender Index, Release 2.59.2 - API

draw_keymaps draw_km draw_kmi draw_kmi_properties indented_layout [Link]

Added

[Link].active_texture [Link].active_texture_index [Link].child_parting_factor [Link].child_parting_max [Link].child_parting_min [Link].color_maximum [Link].create_long_hair_children [Link].draw_color [Link].effector_amount [Link].grid_random [Link].hair_length [Link].hexagonal_grid [Link].is_fluid [Link].kink_amplitude_clump [Link].kink_flat [Link].texture_slots [Link] [Link].use_advanced_hair
Removed

reaction_shape show_material_color use_animate_branching use_branching use_symmetric_branching

5.1. Blender API Change Log

1383

Blender Index, Release 2.59.2 - API

[Link]
Added

[Link].show_mouse [Link]
Renamed

damping -> [Link].fh_damping distance -> [Link].fh_distance force -> [Link].fh_force use_normal_align -> [Link].use_fh_normal

5.1.2 2.57 to 2.58

bpy_extras
Added

bpy_extras bpy_extras.view3d_utils
Moved

io_utils -> bpy_extras.io_utils image_utils -> bpy_extras.image_utils mesh_utils -> bpy_extras.mesh_utils object_utils -> bpy_extras.object_utils [Link]
Added

[Link].use_bake_lores_mesh [Link].use_bake_multires [Link]

Added

[Link].show_guide

1384

Chapter 5. API Info

Blender Index, Release 2.59.2 - API

[Link]
Added

[Link] [Link].SpaceView3D
Added

[Link].SpaceView3D.lock_camera [Link].RegionView3D
Added

[Link]
Added

[Link].falloff_curve [Link].falloff_speed_scale [Link].use_falloff_curve [Link]

Added

[Link].use_match_case [Link]
Added

[Link] [Link]
Added

[Link].is_skip_save [Link]
Added

[Link].anisotropic_filter [Link]
Added

[Link].empty_image_offset [Link]
Added

[Link]

5.1. Blender API Change Log

1387

Blender Index, Release 2.59.2 - API

[Link]
Added

[Link].use_glsl_color_management Note: The Blender Python API has areas which are still in development. The following areas are subject to change. operator behavior, names and arguments mesh creation and editing functions These parts of the API are relatively stable and are unlikely to change signicantly data API, access to attributes of blender data such as mesh verts, material color, timeline frames and scene objects user interface functions for dening buttons, creation of menus, headers, panels render engine integration modules: bgl, mathutils & game engine.

1388

Chapter 5. API Info

PYTHON MODULE INDEX

a
aud, 1247

b
[Link], 1364 [Link], 1359 [Link], 1334 [Link], 1348 [Link], 1351 [Link], 1261 bgl, 1214 blf, 1244 bpy, 35 [Link], 1173 [Link], 31 [Link], 36 [Link], 39 [Link], 43 [Link], 46 [Link], 46 [Link], 48 [Link], 49 [Link], 49 [Link], 50 [Link], 52 [Link], 56 [Link].export_anim, 56 [Link].export_mesh, 57 [Link].export_scene, 58 [Link], 61 [Link], 63 [Link], 63 [Link], 66 [Link], 66 [Link], 71 [Link], 71 [Link], 71 [Link].import_anim, 76 [Link].import_curve, 76 [Link].import_mesh, 76 [Link].import_scene, 77

[Link], 78 [Link], 79 [Link], 79 [Link], 79 [Link], 81 [Link], 82 [Link], 82 [Link], 83 [Link], 95 [Link], 98 [Link], 102 [Link], 121 [Link], 122 [Link], 124 [Link], 126 [Link], 132 [Link], 133 [Link], 133 [Link], 134 [Link], 135 [Link], 137 [Link], 138 [Link], 138 [Link], 147 [Link], 147 [Link], 150 [Link], 152 [Link], 156 [Link], 157 [Link], 157 [Link], 170 [Link], 171 [Link].view2d, 177 [Link].view3d, 178 [Link], 183 [Link], 195 [Link], 1172 [Link], 1174 [Link], 1165 [Link], 1170 bpy_extras, 1255

1389

Blender Index, Release 2.59.2 - API

bpy_extras.image_utils, 1258 bpy_extras.io_utils, 1256 bpy_extras.mesh_utils, 1258 bpy_extras.object_utils, 1256 bpy_extras.view3d_utils, 1259

m
mathutils, 1181 [Link], 1210

1390

Python Module Index

INDEX

activate() ([Link].SCA_PythonController method), 1317 a ([Link].KX_VertexProxy attribute), 1310 active ([Link].BL_ArmatureConstraint attribute), absorption ([Link] attribute), 317 1327 abspath() (in module [Link]), 1172 active ([Link] attribute), 203 acceleration ([Link] attribute), 971 active ([Link] attribute), 228 ACCENTGRAVEKEY (in module [Link]), 1363 active ([Link] attribute), 229 accuracy ([Link] attribute), 277 active ([Link] attribute), 286 accuracy ([Link] attribute), 862 active ([Link] attribute), 384 act_spline ([Link].ThemeView3D attribute), 1053 active ([Link] attribute), 409 action ([Link].BL_ActionActuator attribute), 1264 action ([Link].BL_ShapeActionActuator attribute), active ([Link] attribute), 452 active ([Link] attribute), 454 1268 active ([Link] attribute), 502 action ([Link] attribute), 197 active ([Link] attribute), 537 action ([Link] attribute), 198 active ([Link] attribute), 558 action ([Link] attribute), 212 active ([Link] attribute), 560 action ([Link] attribute), 670 active ([Link] attribute), 561 action ([Link] attribute), 900 active ([Link] attribute), 540 action ([Link] attribute), 929 active ([Link] attribute), 626 Action (class in [Link]), 195 active ([Link] attribute), 631 [Link] (in module [Link]), 195 active ([Link] attribute), 640 Action.frame_range (in module [Link]), 195 active ([Link] attribute), 675 [Link] (in module [Link]), 195 active ([Link] attribute), 717 Action.pose_markers (in module [Link]), 195 active ([Link] attribute), 797 action_blend_type ([Link] attribute), 212 action_extrapolation ([Link] attribute), 212 active ([Link] attribute), 822 active ([Link] attribute), 847 action_frame_end ([Link] attribute), 670 active ([Link] attribute), 855 action_frame_start ([Link] attribute), 670 active ([Link] attribute), 1021 action_inuence ([Link] attribute), 212 active ([Link] attribute), 1074 action_sanitise() (in module [Link]), 132 active ([Link] attribute), 1100 action_set() (in module [Link]), 121 active ([Link] attribute), 1123 action_sync_length() (in module [Link]), 95 active() ([Link] method), 539 ActionActuator (class in [Link]), 196 active_base (in module [Link]), 32, 33 actionclip_add() (in module [Link]), 95 active_boid_rule_index ([Link] attribute), ActionConstraint (class in [Link]), 198 280 ActionFCurves (class in [Link]), 200 active_boid_state_index ([Link] atActionGroup (class in [Link]), 201 tribute), 277 [Link] (in module [Link]), 201 active_bone (in module [Link]), 32 ActionGroups (class in [Link]), 202 active_camera ([Link].KX_Scene attribute), 1303 ActionPoseMarkers (class in [Link]), 203 active_channels_group ([Link] atactionzone() (in module [Link]), 135 tribute), 1024 activate() ([Link].KX_PolygonMaterial method), 1298

1391

Blender Index, Release 2.59.2 - API

active_channels_group ([Link] attribute), 1029 active_clone ([Link] attribute), 640 active_dupliweight_index ([Link] attribute), 752 active_le ([Link] attribute), 1026 active_le_text ([Link] attribute), 1026 active_frame_delete() (in module [Link]), 66 active_index ([Link] attribute), 203 active_index ([Link] attribute), 286 active_index ([Link] attribute), 558 active_index ([Link] attribute), 560 active_index ([Link] attribute), 561 active_index ([Link] attribute), 774 active_index ([Link] attribute), 782 active_index ([Link] attribute), 822 active_index ([Link] attribute), 1100 active_index ([Link] attribute), 1123 active_index ([Link] attribute), 1126 active_index_set() (in module [Link]), 46 active_keycong ([Link] attribute), 1110 active_material ([Link] attribute), 701 active_material_index ([Link] attribute), 701 active_node_material ([Link] attribute), 590 active_object (in module [Link]), 32, 33 active_particle_target_index ([Link] attribute), 769 active_pose_bone (in module [Link]), 32 active_render ([Link] attribute), 626 active_render ([Link] attribute), 640 active_section ([Link] attribute), 1102 active_shape_key_index ([Link] attribute), 701 active_strip ([Link] attribute), 875 active_textbox ([Link] attribute), 989 active_texture ([Link] attribute), 564 active_texture ([Link] attribute), 591 active_texture ([Link] attribute), 752 active_texture ([Link] attribute), 1153 active_texture_index ([Link] attribute), 564 active_texture_index ([Link] attribute), 591 active_texture_index ([Link] attribute), 752 active_texture_index ([Link] attribute), 1153 activity_culling ([Link].KX_Scene attribute), 1304 activity_culling_box_radius ([Link] attribute), 848 activity_culling_radius ([Link].KX_Scene attribute), 1304

actuator ([Link].SCA_ActuatorSensor attribute), 1312 actuator ([Link] attribute), 205 Actuator (class in [Link]), 204 actuator_add() (in module [Link]), 79 actuator_move() (in module [Link]), 79 actuator_remove() (in module [Link]), 79 actuators ([Link].KX_GameObject attribute), 1275 actuators ([Link].SCA_IController attribute), 1263 ActuatorSensor (class in [Link]), 205 adapt_to_speed ([Link] attribute), 1155 adaptation ([Link] attribute), 375 adaptive_angle ([Link] attribute), 752 adaptive_pixel ([Link] attribute), 752 add ([Link] attribute), 598 add() ([Link] method), 451 add() ([Link] method), 558 add() ([Link] class method), 570 add() ([Link] class method), 614 add() ([Link] method), 629 add() ([Link] method), 631 add() ([Link] method), 642 add() ([Link] class method), 768 add() ([Link] method), 962 add() ([Link] method), 965 add() ([Link] method), 1124 add() ([Link] class method), 1162 add() (in module [Link]), 47 add() (in module [Link]), 81 add() (in module [Link]), 102 add() (in module [Link]), 133 add_le() (in module [Link]), 98 add_named() (in module [Link]), 102 add_named_cursor() (in module [Link]), 102 add_object_align_init() (in module bpy_extras.object_utils), 1256 add_threshold ([Link] attribute), 1128 addObject() ([Link].KX_Scene method), 1304 Addon (class in [Link]), 206 addon_disable() (in module [Link]), 183 addon_enable() (in module [Link]), 183 addon_expand() (in module [Link]), 183 addon_lter ([Link] attribute), 1146 addon_install() (in module [Link]), 183 addon_remove() (in module [Link]), 183 addon_search ([Link] attribute), 1146 addon_support ([Link] attribute), 1146 Addons (class in [Link]), 207 addScene() (in module [Link]), 1337

1392

Index

Blender Index, Release 2.59.2 - API

addWheel() ([Link].KX_VehicleWrapper method), 1307 AdjustmentSequence (class in [Link]), 208 AdjustmentSequence.color_balance (in module [Link]), 208 [Link] (in module [Link]), 208 [Link] (in module [Link]), 208 [Link] (in module [Link]), 208 aero ([Link] attribute), 917 aerodynamics_type ([Link] attribute), 917 agent_height ([Link] attribute), 853 agent_radius ([Link] attribute), 853 aggression ([Link] attribute), 277 air_acc_max ([Link] attribute), 277 air_ave_max ([Link] attribute), 277 air_damping ([Link] attribute), 310 air_personal_space ([Link] attribute), 277 air_speed_max ([Link] attribute), 278 air_speed_min ([Link] attribute), 278 AKEY (in module [Link]), 1360 alert ([Link] attribute), 1074 align ([Link] attribute), 943 align ([Link] attribute), 989 align() (in module [Link]), 43 align() (in module [Link]), 102 align() (in module [Link]), 171 align_orientation() ([Link] method), 431 align_roll() ([Link] method), 431 alignAxisToVect() ([Link].KX_GameObject method), 1276 alignment ([Link] attribute), 1074 alive_state ([Link] attribute), 741 all ([Link] attribute), 436 alliance ([Link] attribute), 774 alpha ([Link] attribute), 1355 alpha ([Link] attribute), 1356 alpha ([Link] attribute), 1356 alpha ([Link] attribute), 358 alpha ([Link] attribute), 484 alpha ([Link] attribute), 591 alpha ([Link] attribute), 910 alpha_factor ([Link] attribute), 609 alpha_inuence ([Link] attribute), 747 alpha_mode ([Link] attribute), 825 alt ([Link] attribute), 540 AlwaysSensor (class in [Link]), 210 ambient ([Link] attribute), 591

ambient_color ([Link] attribute), 1153 ambient_factor ([Link] attribute), 609 amplify ([Link] attribute), 910 amplitude ([Link] attribute), 459 AndController (class in [Link]), 211 angle ([Link].KX_RadarSensor attribute), 1299 angle ([Link] attribute), 295 angle ([Link] attribute), 297 angle ([Link] attribute), 341 angle ([Link] attribute), 342 angle ([Link] attribute), 808 angle ([Link] attribute), 865 angle ([Link] attribute), 1149 angle ([Link] attribute), 1189 angle_limit ([Link] attribute), 236 angle_max ([Link] attribute), 387 angle_min ([Link] attribute), 387 angle_offset ([Link] attribute), 350 ANGULAR_CONSTRAINT (in module [Link]), 1369 angular_velocity ([Link] attribute), 432 angular_velocity ([Link] attribute), 713 angular_velocity ([Link] attribute), 741 angular_velocity ([Link] attribute), 751 angular_velocity_factor ([Link] attribute), 752 angular_velocity_mode ([Link] attribute), 752 angularVelocity ([Link].KX_SCA_AddObjectActuator attribute), 1301 angV ([Link].KX_ObjectActuator attribute), 1290 anim_transforms_to_deltas() (in module [Link]), 103 animation_cancel() (in module [Link]), 135 animation_data_clear() ([Link] method), 512 animation_data_create() ([Link] method), 512 animation_offset_end ([Link] attribute), 208 animation_offset_end ([Link] attribute), 521 animation_offset_end ([Link] attribute), 649 animation_offset_end ([Link] attribute), 658 animation_offset_end ([Link] attribute), 661 animation_offset_end ([Link] attribute), 859

Index

1393

bending_stiffness ([Link] attribute), 310 BL_ArmatureActuator.KX_ACT_ARMATURE_RUN bending_stiffness_max ([Link] at(in module [Link]), 1323 tribute), 310 BL_ArmatureActuator.KX_ACT_ARMATURE_SETTARGET beta ([Link] attribute), 910 (in module [Link]), 1324 bevel_depth ([Link] attribute), 401 BL_ArmatureActuator.KX_ACT_ARMATURE_SETWEIGHT bevel_object ([Link] attribute), 401 (in module [Link]), 1324 bevel_resolution ([Link] attribute), 401 BL_ArmatureBone (class in [Link]), 1332 bevel_weight ([Link] attribute), 628 BL_ArmatureChannel (class in [Link]), 1328 bevel_weight ([Link] attribute), 641 BL_ArmatureChannel.PCHAN_ROT_QUAT (in module BevelModier (class in [Link]), 236 [Link]), 1328 BezierSplinePoint (class in [Link]), 237 BL_ArmatureChannel.PCHAN_ROT_XYZ (in module [Link] (module), 1364 [Link]), 1328 [Link] (module), 1359 BL_ArmatureChannel.PCHAN_ROT_XZY (in module [Link] (module), 1334 [Link]), 1328 [Link] (module), 1348 BL_ArmatureChannel.PCHAN_ROT_YXZ (in module [Link] (module), 1351 [Link]), 1328 [Link] (module), 1261 BL_ArmatureChannel.PCHAN_ROT_YZX (in module bgl (module), 1214 [Link]), 1328 bias ([Link] attribute), 1155 BL_ArmatureChannel.PCHAN_ROT_ZXY (in module billboard_align ([Link] attribute), 752 [Link]), 1328 billboard_animation ([Link] at- BL_ArmatureChannel.PCHAN_ROT_ZYX (in module tribute), 752 [Link]), 1328 billboard_normal_uv ([Link] at- BL_ArmatureConstraint (class in [Link]), 1325 tribute), 769 BL_ArmatureConstraint.CONSTRAINT_IK_COPYPOSE billboard_object ([Link] attribute), (in module [Link]), 1326 753 BL_ArmatureConstraint.CONSTRAINT_IK_DISTANCE billboard_offset ([Link] attribute), 753 (in module [Link]), 1326 billboard_offset_split ([Link] at- BL_ArmatureConstraint.CONSTRAINT_IK_FLAG_POS tribute), 753 (in module [Link]), 1326 billboard_size ([Link] attribute), 753 BL_ArmatureConstraint.CONSTRAINT_IK_FLAG_ROT billboard_split_uv ([Link] attribute), (in module [Link]), 1326 769 BL_ArmatureConstraint.CONSTRAINT_IK_FLAG_STRETCH billboard_tilt ([Link] attribute), 753 (in module [Link]), 1326 billboard_tilt_random ([Link] at- BL_ArmatureConstraint.CONSTRAINT_IK_FLAG_TIP tribute), 753 (in module [Link]), 1326 billboard_time_index_uv ([Link] at- BL_ArmatureConstraint.CONSTRAINT_IK_MODE_INSIDE tribute), 769 (in module [Link]), 1326 billboard_uv_split ([Link] attribute), BL_ArmatureConstraint.CONSTRAINT_IK_MODE_ONSURFACE 753 (in module [Link]), 1326 billboard_velocity_head ([Link] at- BL_ArmatureConstraint.CONSTRAINT_IK_MODE_OUTSIDE tribute), 753 (in module [Link]), 1326 billboard_velocity_tail ([Link] at- BL_ArmatureConstraint.CONSTRAINT_TYPE_CLAMPTO tribute), 753 (in module [Link]), 1326 binary_path (in module [Link]), 1173 BL_ArmatureConstraint.CONSTRAINT_TYPE_DISTLIMIT bindId ([Link] attribute), 1357 (in module [Link]), 1326 birth_time ([Link] attribute), 741 BL_ArmatureConstraint.CONSTRAINT_TYPE_KINEMATIC BKEY (in module [Link]), 1360 (in module [Link]), 1325 BL_ActionActuator (class in [Link]), 1264 BL_ArmatureConstraint.CONSTRAINT_TYPE_LOCKTRACK BL_ArmatureActuator (class in [Link]), 1323 (in module [Link]), 1326 BL_ArmatureActuator.KX_ACT_ARMATURE_DISABLE BL_ArmatureConstraint.CONSTRAINT_TYPE_LOCLIKE (in module [Link]), 1324 (in module [Link]), 1325 BL_ArmatureActuator.KX_ACT_ARMATURE_ENABLE BL_ArmatureConstraint.CONSTRAINT_TYPE_MINMAX (in module [Link]), 1324 (in module [Link]), 1326

Index

1397

Blender Index, Release 2.59.2 - API

BL_ArmatureConstraint.CONSTRAINT_TYPE_ROTLIKEbl_use_postprocess ([Link] attribute), (in module [Link]), 1325 817 BL_ArmatureConstraint.CONSTRAINT_TYPE_SIZELIKE bl_use_preview ([Link] attribute), 817 (in module [Link]), 1326 BL_ZERO (in module [Link]), 1348 BL_ArmatureConstraint.CONSTRAINT_TYPE_STRETCHTO black_level ([Link] attribute), 406 (in module [Link]), 1326 blend ([Link] attribute), 289 BL_ArmatureConstraint.CONSTRAINT_TYPE_TRACKTO blend ([Link] attribute), (in module [Link]), 1325 1058 BL_ArmatureConstraint.CONSTRAINT_TYPE_TRANSFORM blend_alpha ([Link] attribute), 869 (in module [Link]), 1326 blend_distance ([Link] attribute), 606 BL_ArmatureObject (class in [Link]), 1323 blend_factor ([Link] attribute), bl_context ([Link] attribute), 738 1160 bl_description ([Link] attribute), 583 blend_from_shape() (in module [Link]), 83 bl_description ([Link] attribute), 726 blend_in ([Link] attribute), 454 BL_DST_ALPHA (in module [Link]), 1348 blend_in ([Link] attribute), 670 BL_DST_COLOR (in module [Link]), 1348 blend_out ([Link] attribute), 454 bl_idname ([Link] attribute), 507 blend_out ([Link] attribute), 670 bl_idname ([Link] attribute), 555 blend_paths() (in module [Link]), 1170 bl_idname ([Link] attribute), 583 blend_type ([Link] atbl_idname ([Link] attribute), 619 tribute), 361 bl_idname ([Link] attribute), 726 blend_type ([Link] attribute), 463 bl_idname ([Link] attribute), 738 blend_type ([Link] attribute), 638 bl_idname ([Link] attribute), 817 blend_type ([Link] attribute), 670 bl_label ([Link] attribute), 556 blend_type ([Link] attribute), 869 bl_label ([Link] attribute), 583 blend_type ([Link] attribute), bl_label ([Link] attribute), 619 888 bl_label ([Link] attribute), 726 blend_type ([Link] attribute), bl_label ([Link] attribute), 738 1007 bl_label ([Link] attribute), 817 blend_type ([Link] attribute), 1016 BL_ONE (in module [Link]), 1348 BlendData (class in [Link]), 239 BL_ONE_MINUS_DST_ALPHA (in module [Link]), [Link] (in module [Link]), 239 1348 [Link] (in module [Link]), 239 BL_ONE_MINUS_DST_COLOR (in module [Link]), [Link] (in module [Link]), 239 1348 [Link] (in module [Link]), 239 BL_ONE_MINUS_SRC_ALPHA (in module [Link]), [Link] (in module [Link]), 239 1348 [Link] (in module [Link]), 239 BL_ONE_MINUS_SRC_COLOR (in module [Link]), [Link] (in module [Link]), 239 1348 BlendData.grease_pencil (in module [Link]), 239 bl_options ([Link] attribute), 554 [Link] (in module [Link]), 239 bl_options ([Link] attribute), 556 [Link] (in module [Link]), 240 bl_options ([Link] attribute), 557 BlendData.is_dirty (in module [Link]), 240 bl_options ([Link] attribute), 583 BlendData.is_saved (in module [Link]), 240 bl_options ([Link] attribute), 726 [Link] (in module [Link]), 240 bl_options ([Link] attribute), 738 [Link] (in module [Link]), 240 bl_region_type ([Link] attribute), 738 [Link] (in module [Link]), 240 BL_Shader (class in [Link]), 1265 [Link] (in module [Link]), 240 BL_ShapeActionActuator (class in [Link]), 1268 [Link] (in module [Link]), 240 bl_space_type ([Link] attribute), 507 [Link] (in module [Link]), 240 bl_space_type ([Link] attribute), 738 BlendData.node_groups (in module [Link]), 240 BL_SRC_ALPHA (in module [Link]), 1348 [Link] (in module [Link]), 240 BL_SRC_ALPHA_SATURATE (in module [Link]), [Link] (in module [Link]), 240 1348 [Link] (in module [Link]), 240 BL_SRC_COLOR (in module [Link]), 1348 [Link] (in module [Link]), 241 [Link] (in module [Link]), 241

1398

Index

Blender Index, Release 2.59.2 - API

BlendData.shape_keys (in module [Link]), 241 [Link] (in module [Link]), 241 [Link] (in module [Link]), 241 [Link] (in module [Link]), 241 [Link] (in module [Link]), 241 BlendData.window_managers (in module [Link]), 241 [Link] (in module [Link]), 241 BlendDataActions (class in [Link]), 242 BlendDataArmatures (class in [Link]), 243 BlendDataBrushes (class in [Link]), 244 BlendDataCameras (class in [Link]), 245 BlendDataCurves (class in [Link]), 246 BlendDataFonts (class in [Link]), 247 BlendDataGreasePencils (class in [Link]), 248 BlendDataGroups (class in [Link]), 248 BlendDataImages (class in [Link]), 249 BlendDataLamps (class in [Link]), 251 BlendDataLattices (class in [Link]), 252 BlendDataLibraries (class in [Link]), 253 BlendDataMaterials (class in [Link]), 254 BlendDataMeshes (class in [Link]), 255 BlendDataMetaBalls (class in [Link]), 256 BlendDataNodeTrees (class in [Link]), 257 BlendDataObjects (class in [Link]), 258 BlendDataParticles (class in [Link]), 259 BlendDataScenes (class in [Link]), 260 BlendDataScreens (class in [Link]), 261 BlendDataSounds (class in [Link]), 262 BlendDataSpeakers (class in [Link]), 263 BlendDataTexts (class in [Link]), 264 BlendDataTextures (class in [Link]), 265 BlendDataWindowManagers (class in [Link]), 266 BlendDataWorlds (class in [Link]), 267 BlenderRNA (class in [Link]), 270 [Link] (in module [Link]), 270 blendIn ([Link].BL_ActionActuator attribute), 1264 blendIn ([Link].BL_ShapeActionActuator attribute), 1268 BlendTexture (class in [Link]), 268 BlendTexture.users_material (in module [Link]), 269 BlendTexture.users_object_modier (in module [Link]), 269 blendTime ([Link].BL_ActionActuator attribute), 1264 blendTime ([Link].BL_ShapeActionActuator attribute), 1269 blf (module), 1244 blur() (in module blf), 1245 blur_max ([Link] attribute), 342 blur_radius ([Link] attribute), 499 blur_width ([Link] attribute), 1149 bodies ([Link].KX_NetworkMessageSensor attribute), 1289

color_hue

([Link] attribute), 332 color_hue ([Link] attribute), 352 color_layer ([Link] attribute), 883 color_maximum ([Link] attribute), 754 color_mode ([Link] attribute), 449 color_mode ([Link] attribute), 827 color_mode ([Link] attribute), 1135 color_modulation ([Link] attribute), 350 color_multiply ([Link] attribute), 208 color_multiply ([Link] attribute), 434 color_multiply ([Link] attribute), 521 color_multiply ([Link] attribute), 649 color_multiply ([Link] attribute), 658 color_multiply ([Link] attribute), 661 color_multiply ([Link] attribute), 859 color_picker_type ([Link] attribute), 1114 color_random ([Link] attribute), 1159 color_range ([Link] attribute), 1153 color_saturation ([Link] attribute), 208 color_saturation ([Link] attribute), 332 color_saturation ([Link] attribute), 352 color_saturation ([Link] attribute), 434 color_saturation ([Link] attribute), 521 color_saturation ([Link] attribute), 649 color_saturation ([Link] attribute), 658 color_saturation ([Link] attribute), 661 color_saturation ([Link] attribute), 860 color_set ([Link] attribute), 285 color_source ([Link] attribute), 783 color_space ([Link] attribute), 328 color_value ([Link] attribute), 332 color_value ([Link] attribute), 352 colorIdx ([Link] attribute), 1358 ColorRamp (class in [Link]), 319

[Link] (in module [Link]), 319 ColorRampElement (class in [Link]), 320 ColorRampElements (class in [Link]), 321 colors_mirror() (in module [Link]), 83 colors_rotate() (in module [Link]), 83 ColorSequence (class in [Link]), 322 colour ([Link].KX_LightObject attribute), 1284 colour ([Link].KX_VertexProxy attribute), 1309 column() ([Link] method), 1075 column_ow() ([Link] method), 1075 COMMAKEY (in module [Link]), 1363 comment() (in module [Link]), 152 compare() ([Link] method), 543 CompositorNode (class in [Link]), 323 [Link] (in module [Link]), 324 CompositorNodeAlphaOver (class in [Link]), 324 CompositorNodeBilateralblur (class in [Link]), 325 CompositorNodeBlur (class in [Link]), 326 CompositorNodeBrightContrast (class in [Link]), 328 CompositorNodeChannelMatte (class in [Link]), 328 CompositorNodeChromaMatte (class in [Link]), 330 CompositorNodeColorBalance (class in [Link]), 331 CompositorNodeColorMatte (class in [Link]), 332 CompositorNodeColorSpill (class in [Link]), 333 CompositorNodeCombHSVA (class in [Link]), 334 CompositorNodeCombRGBA (class in [Link]), 335 CompositorNodeCombYCCA (class in [Link]), 336 CompositorNodeCombYUVA (class in [Link]), 337 CompositorNodeComposite (class in [Link]), 337 CompositorNodeCrop (class in [Link]), 338 CompositorNodeCurveRGB (class in [Link]), 339 [Link] (in module [Link]), 339 CompositorNodeCurveVec (class in [Link]), 340 [Link] (in module [Link]), 340 CompositorNodeDBlur (class in [Link]), 341 CompositorNodeDefocus (class in [Link]), 342 CompositorNodeDiffMatte (class in [Link]), 344 CompositorNodeDilateErode (class in [Link]), 345 CompositorNodeDisplace (class in [Link]), 346 CompositorNodeDistanceMatte (class in [Link]), 346 CompositorNodeFilter (class in [Link]), 347 CompositorNodeFlip (class in [Link]), 348 CompositorNodeGamma (class in [Link]), 349 CompositorNodeGlare (class in [Link]), 349 CompositorNodeHueCorrect (class in [Link]), 351 [Link] (in module [Link]), 351 CompositorNodeHueSat (class in [Link]), 352 CompositorNodeIDMask (class in [Link]), 353 CompositorNodeImage (class in [Link]), 353 CompositorNodeInvert (class in [Link]), 355 CompositorNodeLensdist (class in [Link]), 356

Index

1405

Blender Index, Release 2.59.2 - API

CompositorNodeLevels (class in [Link]), 356 CompositorNodeLumaMatte (class in [Link]), 357 CompositorNodeMapUV (class in [Link]), 358 CompositorNodeMapValue (class in [Link]), 359 CompositorNodeMath (class in [Link]), 360 CompositorNodeMixRGB (class in [Link]), 361 CompositorNodeNormal (class in [Link]), 362 CompositorNodeNormalize (class in [Link]), 363 CompositorNodeOutputFile (class in [Link]), 363 CompositorNodePremulKey (class in [Link]), 364 CompositorNodeRGB (class in [Link]), 365 CompositorNodeRGBToBW (class in [Link]), 366 CompositorNodeRLayers (class in [Link]), 367 CompositorNodeRotate (class in [Link]), 368 CompositorNodes (class in [Link]), 382 CompositorNodeScale (class in [Link]), 368 CompositorNodeSepHSVA (class in [Link]), 369 CompositorNodeSepRGBA (class in [Link]), 370 CompositorNodeSepYCCA (class in [Link]), 371 CompositorNodeSepYUVA (class in [Link]), 371 CompositorNodeSetAlpha (class in [Link]), 372 CompositorNodeSplitViewer (class in [Link]), 373 CompositorNodeTexture (class in [Link]), 374 CompositorNodeTime (class in [Link]), 374 [Link] (in module [Link]), 374 CompositorNodeTonemap (class in [Link]), 375 CompositorNodeTranslate (class in [Link]), 377 CompositorNodeTree (class in [Link]), 377 [Link] (in module [Link]), 377 CompositorNodeValToRGB (class in [Link]), 378 CompositorNodeValToRGB.color_ramp (in module [Link]), 378 CompositorNodeValue (class in [Link]), 379 CompositorNodeVecBlur (class in [Link]), 380 CompositorNodeViewer (class in [Link]), 381 CompositorNodeZcombine (class in [Link]), 381 compound ([Link].KX_ParentActuator attribute), 1291 compressibility ([Link] attribute), 417 compression ([Link] attribute), 780 compression_threshold ([Link] attribute), 966 cone_angle_inner ([Link] attribute), 1254 cone_angle_inner ([Link] attribute), 956 cone_angle_outer ([Link] attribute), 1254 cone_angle_outer ([Link] attribute), 956 cone_inner_angle_3d ([Link] attribute), 924 cone_outer_angle_3d ([Link] attribute), 924 cone_outer_gain_3d ([Link] attribute), 924 cone_volume_outer ([Link] attribute), 1254

cone_volume_outer ([Link] attribute), 956 coneOrigin ([Link].KX_RadarSensor attribute), 1299 coneTarget ([Link].KX_RadarSensor attribute), 1299 CONETWIST_CONSTRAINT (in module [Link]), 1370 connect_hair() (in module [Link]), 124 connected ([Link].BL_ArmatureBone attribute), 1333 connected ([Link].SCA_JoystickSensor attribute), 1314 ConsoleLine (class in [Link]), 383 constant_offset_displace ([Link] attribute), 233 CONSTANT_TIMER (in module [Link]), 1347 constraint ([Link].BL_ArmatureActuator attribute), 1324 constraint ([Link].KX_ArmatureSensor attribute), 1325 constraint ([Link] attribute), 227 constraint ([Link] attribute), 231 Constraint (class in [Link]), 384 Constraint.error_location (in module [Link]), 385 Constraint.error_rotation (in module [Link]), 385 Constraint.is_valid (in module [Link]), 385 [Link] (in module [Link]), 386 constraint_add() (in module [Link]), 103 constraint_add() (in module [Link]), 127 constraint_add_with_targets() (in module [Link]), 104 constraint_add_with_targets() (in module [Link]), 128 ConstraintActuator (class in [Link]), 387 constraints ([Link].BL_ArmatureObject attribute), 1323 constraints_clear() (in module [Link]), 105 constraints_clear() (in module [Link]), 129 constraints_copy() (in module [Link]), 105 constraints_copy() (in module [Link]), 129 ConstraintTarget (class in [Link]), 390 context ([Link] attribute), 943 Context (class in [Link]), 391 [Link] (in module [Link]), 391 Context.blend_data (in module [Link]), 391 [Link] (in module [Link]), 391 [Link] (in module [Link]), 391 Context.region_data (in module [Link]), 391 [Link] (in module [Link]), 391 [Link] (in module [Link]), 391 Context.space_data (in module [Link]), 391 Context.tool_settings (in module [Link]), 392 Context.user_preferences (in module [Link]), 392 [Link] (in module [Link]), 392 Context.window_manager (in module [Link]), 392 context_collection_boolean_set() (in module [Link]), 185

1406

Index

duplicate() (in module [Link]), 44 duplicate() (in module [Link]), 52 duplicate() (in module [Link]), 67 duplicate() (in module [Link]), 81 duplicate() (in module [Link]), 84 duplicate() (in module [Link]), 96 duplicate() (in module [Link]), 98 duplicate() (in module [Link]), 105 duplicate() (in module [Link]), 140 duplicate_metaelems() (in module [Link]), 82 duplicate_move() (in module [Link]), 37 duplicate_move() (in module [Link]), 44 duplicate_move() (in module [Link]), 67 duplicate_move() (in module [Link]), 84 duplicate_move() (in module [Link]), 99 duplicate_move() (in module [Link]), 106 duplicate_move_keep_inputs() (in module [Link]), 99 duplicate_move_linked() (in module [Link]), 106 duplicates_make_real() (in module [Link]), 106 dupliob_copy() (in module [Link]), 125 dupliob_move_down() (in module [Link]), 125 dupliob_move_up() (in module [Link]), 125 dupliob_remove() (in module [Link]), 125 DupliObject (class in [Link]), 426 [Link] (in module [Link]), 427 duration ([Link].SCA_DelaySensor attribute), 1313 duration ([Link] attribute), 412 duration ([Link] attribute), 774 dynamic_friction ([Link] attribute), 496 dynamic_operation ([Link] attribute), 432

fps ([Link] attribute), 849 fps_base ([Link] attribute), 829 frame ([Link].BL_ActionActuator attribute), 1264 frame ([Link].BL_ShapeActionActuator attribute), 1268 frame ([Link] attribute), 458 frame ([Link] attribute), 1059 frame_after ([Link] attribute), 215 frame_after ([Link] attribute), 217 frame_before ([Link] attribute), 216 frame_before ([Link] attribute), 217 frame_blend_in ([Link] attribute), 197 frame_blend_in ([Link] attribute), 900 frame_color ([Link] attribute), 849 frame_current ([Link] attribute), 843 frame_current ([Link] attribute), 1020 frame_current ([Link] attribute), 1025 frame_current ([Link] attribute), 1030 frame_current ([Link] attribute), 1037 frame_current ([Link] attribute), 1044 frame_current ([Link] attribute), 1048 frame_current ([Link].ThemeView3D attribute), 1054 frame_duration ([Link] attribute), 296 frame_duration ([Link] attribute), 354 frame_duration ([Link] attribute), 527 frame_end ([Link] attribute), 197 frame_end ([Link] attribute), 198 frame_end ([Link] attribute), 216 frame_end ([Link] attribute), 217 frame_end ([Link] attribute), 364 frame_end ([Link] attribute), 375 frame_end ([Link] attribute), 454 frame_end ([Link] attribute), 465 frame_end ([Link] attribute), 516 frame_end ([Link] attribute), 671 frame_end ([Link] attribute), 756 frame_end ([Link] attribute), 780 frame_end ([Link] attribute), 843

frame_end ([Link] attribute), 900 frame_end ([Link] attribute), 1002 frame_nal_duration ([Link] attribute), 870 frame_nal_end ([Link] attribute), 870 frame_nal_start ([Link] attribute), 870 frame_jump() (in module [Link]), 37 frame_jump() (in module [Link]), 68 frame_jump() (in module [Link]), 136 frame_map_new ([Link] attribute), 829 frame_map_old ([Link] attribute), 829 frame_number ([Link] attribute), 483 frame_offset ([Link] attribute), 354 frame_offset ([Link] attribute), 465 frame_offset ([Link] attribute), 528 frame_offset() (in module [Link]), 136 frame_path() ([Link] method), 836 frame_preview_end ([Link] attribute), 843 frame_preview_start ([Link] attribute), 843 frame_property ([Link] attribute), 197 frame_property ([Link] attribute), 900 frame_server_port ([Link] attribute), 1115 frame_set() ([Link] method), 845 frame_start ([Link] attribute), 197 frame_start ([Link] attribute), 198 frame_start ([Link] attribute), 216 frame_start ([Link] attribute), 217 frame_start ([Link] attribute), 296 frame_start ([Link] attribute), 354 frame_start ([Link] attribute), 364 frame_start ([Link] attribute), 375 frame_start ([Link] attribute), 454 frame_start ([Link] attribute), 465 frame_start ([Link] attribute), 516 frame_start ([Link] attribute), 528 frame_start ([Link] attribute), 671 frame_start ([Link] attribute), 756 frame_start ([Link] attribute), 780 frame_start ([Link] attribute), 843 frame_start ([Link] attribute), 870 frame_start ([Link] attribute), 900 frame_start ([Link] attribute), 1002

hook_remove() (in module [Link]), 108 hook_reset() (in module [Link]), 108 hook_select() (in module [Link]), 108 HookModier (class in [Link]), 510 horizon_brightness ([Link] attribute), 567 horizon_color ([Link] attribute), 1154 horizon_factor ([Link] attribute), 1160 hsv ([Link] attribute), 1182

I
icon_le ([Link] attribute), 1050 icon_lepath ([Link] attribute), 290 id ([Link] attribute), 424 id ([Link] attribute), 557 ID (class in [Link]), 511 [Link] (in module [Link]), 511 [Link] (in module [Link]), 512 id_data ([Link].bpy_struct attribute), 1170 id_operation() (in module [Link]), 121 id_root ([Link] attribute), 195 id_type ([Link] attribute), 424 id_type ([Link] attribute), 557 identity() ([Link] method), 1185 IDMaterials (class in [Link]), 513 idname ([Link] attribute), 541 ik_add() (in module [Link]), 129 ik_clear() (in module [Link]), 129 ik_dist ([Link].BL_ArmatureConstraint attribute), 1328 ik_dof_x ([Link].BL_ArmatureChannel attribute), 1329 ik_dof_y ([Link].BL_ArmatureChannel attribute), 1329 ik_dof_z ([Link].BL_ArmatureChannel attribute), 1329 ik_ag ([Link].BL_ArmatureConstraint attribute), 1328 ik_limit_x ([Link].BL_ArmatureChannel attribute), 1329 ik_limit_y ([Link].BL_ArmatureChannel attribute), 1329 ik_limit_z ([Link].BL_ArmatureChannel attribute), 1329 ik_lin_control ([Link].BL_ArmatureChannel attribute), 1329 ik_lin_weight ([Link].BL_ArmatureChannel attribute), 1332 ik_linear_weight ([Link] attribute), 792 ik_max_x ([Link].BL_ArmatureChannel attribute), 1331 ik_max_x ([Link] attribute), 792

ik_max_y ([Link].BL_ArmatureChannel attribute), 1331 ik_max_y ([Link] attribute), 792 ik_max_z ([Link].BL_ArmatureChannel attribute), 1331 ik_max_z ([Link] attribute), 792 ik_min_x ([Link].BL_ArmatureChannel attribute), 1331 ik_min_x ([Link] attribute), 792 ik_min_y ([Link].BL_ArmatureChannel attribute), 1331 ik_min_y ([Link] attribute), 792 ik_min_z ([Link].BL_ArmatureChannel attribute), 1331 ik_min_z ([Link] attribute), 792 ik_mode ([Link].BL_ArmatureConstraint attribute), 1328 ik_rot_control ([Link].BL_ArmatureChannel attribute), 1329 ik_rot_weight ([Link].BL_ArmatureChannel attribute), 1332 ik_rotation_weight ([Link] attribute), 792 ik_solver ([Link] attribute), 790 ik_stiffness_x ([Link].BL_ArmatureChannel attribute), 1331 ik_stiffness_x ([Link] attribute), 792 ik_stiffness_y ([Link].BL_ArmatureChannel attribute), 1331 ik_stiffness_y ([Link] attribute), 793 ik_stiffness_z ([Link].BL_ArmatureChannel attribute), 1331 ik_stiffness_z ([Link] attribute), 793 ik_stretch ([Link].BL_ArmatureChannel attribute), 1331 ik_stretch ([Link] attribute), 793 ik_type ([Link].BL_ArmatureConstraint attribute), 1328 ik_type ([Link] attribute), 562 ik_weight ([Link].BL_ArmatureConstraint attribute), 1328 IKEY (in module [Link]), 1360 IKParam (class in [Link]), 514 IKParam.ik_solver (in module [Link]), 514 image ([Link] attribute), 1354 image ([Link] attribute), 1354 image ([Link] attribute), 1355 image ([Link] attribute), 1355 image ([Link] attribute), 1356 image ([Link] attribute), 1357 image ([Link] attribute), 1353 image ([Link] attribute), 235 image ([Link] attribute), 354 image ([Link] attribute), 443 image ([Link] attribute), 525

Index

1425

Blender Index, Release 2.59.2 - API

image ([Link] attribute), 638 image ([Link] attribute), 934 image ([Link] attribute), 1005 image ([Link] attribute), 1098 image ([Link] attribute), 1139 Image (class in [Link]), 515 [Link] (in module [Link]), 515 [Link] (in module [Link]), 515 Image.has_data (in module [Link]), 517 Image.is_dirty (in module [Link]), 517 Image.packed_le (in module [Link]), 517 [Link] (in module [Link]), 517 [Link] (in module [Link]), 518 image_editor ([Link] attribute), 1108 image_from_view() (in module [Link]), 123 image_paint() (in module [Link]), 123 image_paint_object (in module [Link]), 32 image_strip ([Link] attribute), 1044 image_strip_add() (in module [Link]), 141 image_tool ([Link] attribute), 290 image_tool_set() (in module [Link]), 47 image_type ([Link] attribute), 364 ImageBuff (class in [Link]), 1354 ImageFFmpeg (class in [Link]), 1354 ImageMirror (class in [Link]), 1355 ImageMix (class in [Link]), 1355 ImagePaint (class in [Link]), 520 ImageRender (class in [Link]), 1356 images_separate() (in module [Link]), 142 ImageSequence (class in [Link]), 521 ImageSequence.color_balance (in module [Link]), 521 [Link] (in module [Link]), 522 [Link] (in module [Link]), 522 [Link] (in module [Link]), 522 [Link] (in module [Link]), 522 ImageTexture (class in [Link]), 524 ImageTexture.image_user (in module [Link]), 525 ImageTexture.users_material (in module [Link]), 526 ImageTexture.users_object_modier (in module [Link]), 526 imageToArray() (in module [Link]), 1358 ImageUser (class in [Link]), 527 ImageUser.multilayer_layer (in module [Link]), 528 ImageUser.multilayer_pass (in module [Link]), 528 ImageViewport (class in [Link]), 1356 impact_factor ([Link] attribute), 720 ImportHelper (class in bpy_extras.io_utils), 1257 in_out_node ([Link] attribute), 1039 indent() (in module [Link]), 153

index ([Link].SCA_JoystickSensor attribute), 1314 index ([Link] attribute), 353 index ([Link] attribute), 780 index() ([Link] method), 1269 indirect_bounces ([Link] attribute), 1156 indirect_factor ([Link] attribute), 1156 inow ([Link] attribute), 468 inow_velocity ([Link] attribute), 529 InowFluidSettings (class in [Link]), 529 inuence ([Link] attribute), 385 inuence ([Link] attribute), 454 inuence ([Link] attribute), 671 info ([Link] attribute), 485 inherit_scale ([Link].BL_ArmatureBone attribute), 1333 initial_velocity ([Link] attribute), 477 initial_velocity ([Link] attribute), 913 inner ([Link] attribute), 1056 inner_anim ([Link] attribute), 1058 inner_anim_sel ([Link] attribute), 1058 inner_driven ([Link] attribute), 1058 inner_driven_sel ([Link] attribute), 1058 inner_key ([Link] attribute), 1058 inner_key_sel ([Link] attribute), 1058 inner_sel ([Link] attribute), 1057 insert() ([Link] method), 451 insert() (in module [Link]), 50 insert() (in module [Link]), 153 insert_lorem() (in module [Link]), 64 INSERTKEY (in module [Link]), 1363 instantAddObject() ([Link].KX_SCA_AddObjectActuator method), 1301 instantReplaceMesh() ([Link].KX_SCA_ReplaceMeshActuator method), 1302 int ([Link] attribute), 803 int_array ([Link] attribute), 804 int_max ([Link] attribute), 809 int_mean ([Link] attribute), 809 int_min ([Link] attribute), 809 int_value ([Link] attribute), 810 integral_coefcient ([Link] attribute), 714 integrator ([Link] attribute), 756

1426

Index

Blender Index, Release 2.59.2 - API

intensity ([Link] attribute), 376 intensity ([Link] attribute), 994 intensity ([Link] attribute), 1138 intensity ([Link] attribute), 1158 interaction_preset_add() (in module [Link]), 188 internal_friction ([Link] attribute), 310 interpolate_bezier() (in module [Link]), 1211 interpolation ([Link] attribute), 319 interpolation ([Link] attribute), 553 interpolation ([Link] attribute), 901 interpolation ([Link] attribute), 1072 interpolation ([Link] attribute), 1138 interpolation_type() (in module [Link]), 38 interpolation_type() (in module [Link]), 68 interpolation_type_u ([Link] attribute), 571 interpolation_type_v ([Link] attribute), 571 interpolation_type_w ([Link] attribute), 571 intersect_line_line() (in module [Link]), 1211 intersect_line_line_2d() (in module [Link]), 1211 intersect_line_plane() (in module [Link]), 1212 intersect_line_sphere() (in module [Link]), 1212 intersect_line_sphere_2d() (in module [Link]), 1212 intersect_point_line() (in module [Link]), 1212 intersect_point_quad_2d() (in module [Link]), 1213 intersect_point_tri_2d() (in module [Link]), 1213 intersect_ray_tri() (in module [Link]), 1213 IntProperty (class in [Link]), 530 IntProperty() (in module [Link]), 1178 IntProperty.array_length (in module [Link]), 530 [Link] (in module [Link]), 530 IntProperty.default_array (in module [Link]), 530 IntProperty.hard_max (in module [Link]), 530 IntProperty.hard_min (in module [Link]), 530 IntProperty.soft_max (in module [Link]), 530 IntProperty.soft_min (in module [Link]), 530 [Link] (in module [Link]), 530 introspect() ([Link] method), 1097 IntVectorProperty() (in module [Link]), 1178 invalid ([Link] attribute), 1261 inverse_matrix ([Link] attribute), 304 invert ([Link].SCA_ISensor attribute), 1262 invert ([Link] attribute), 868

invert ([Link] attribute), 1017 invert() (in module [Link]), 72 invert() ([Link] method), 1185 invert_alpha ([Link] attribute), 355 invert_alpha ([Link] attribute), 525 invert_gain ([Link] attribute), 872 invert_gamma ([Link] attribute), 873 invert_grid ([Link] attribute), 756 invert_lift ([Link] attribute), 873 invert_mouse_zoom ([Link] attribute), 1110 invert_normal ([Link] attribute), 882 invert_normal ([Link] attribute), 886 invert_rgb ([Link] attribute), 355 invert_stencil ([Link] attribute), 520 invert_vertex_group ([Link] attribute), 230 invert_vertex_group ([Link] attribute), 589 invert_vertex_group ([Link] attribute), 627 invert_vertex_group ([Link] attribute), 921 invert_vertex_group_clump ([Link] attribute), 769 invert_vertex_group_density ([Link] attribute), 769 invert_vertex_group_eld ([Link] attribute), 769 invert_vertex_group_kink ([Link] attribute), 769 invert_vertex_group_length ([Link] attribute), 770 invert_vertex_group_rotation ([Link] attribute), 770 invert_vertex_group_roughness_1 ([Link] attribute), 770 invert_vertex_group_roughness_2 ([Link] attribute), 770 invert_vertex_group_roughness_end ([Link] attribute), 770 invert_vertex_group_size ([Link] attribute), 770 invert_vertex_group_tangent ([Link] attribute), 770 invert_vertex_group_velocity ([Link] attribute), 770

Index

1427

Blender Index, Release 2.59.2 - API

invert_x ([Link] attribute), 396 invert_x ([Link] attribute), 397 invert_y ([Link] attribute), 396 invert_y ([Link] attribute), 397 invert_z ([Link] attribute), 396 invert_z ([Link] attribute), 397 invert_z ([Link] attribute), 592 invert_zmask ([Link] attribute), 856 invert_zoom_wheel ([Link] attribute), 1110 inverted() ([Link] method), 1185 invoke() ([Link] method), 727 invoke_conrm() ([Link] class method), 1148 invoke_popup() ([Link] class method), 1147 invoke_props_dialog() ([Link] class method), 1147 invoke_props_popup() ([Link] class method), 1146 invoke_search_popup() ([Link] class method), 1147 ior ([Link] attribute), 604 ior ([Link] attribute), 608 is_edited ([Link] attribute), 483 is_fgon ([Link] attribute), 628 is_loose ([Link] attribute), 628 is_modied ([Link] attribute), 655 is_modied() ([Link] method), 710 is_negative ([Link] attribute), 1187 is_orthogonal ([Link] attribute), 1187 is_perspective ([Link].RegionView3D attribute), 814 is_property_hidden() ([Link].bpy_struct method), 1167 is_property_set() ([Link].bpy_struct method), 1167 is_proxy_local ([Link] attribute), 385 is_start ([Link] attribute), 731 is_subdir() (in module [Link]), 1172 is_user_modied ([Link] attribute), 539 is_valid ([Link] attribute), 423 is_valid ([Link] attribute), 449 is_valid ([Link] attribute), 775 is_visible() ([Link] method), 710 is_wrapped ([Link] attribute), 1182 is_wrapped ([Link] attribute), 1183

is_wrapped ([Link] attribute), 1187 is_wrapped ([Link] attribute), 1189 is_wrapped ([Link] attribute), 1194 isCollider() ([Link].KX_PolyProxy method), 1293 isolate_type_render() (in module [Link]), 108 isPlayingAction() ([Link].KX_GameObject method), 1283 isValid() ([Link].BL_Shader method), 1265 isVisible() ([Link].KX_PolyProxy method), 1293 Itasc (class in [Link]), 531 item ([Link] attribute), 1057 item_activate() (in module [Link]), 121 item_openclose() (in module [Link]), 121 item_rename() (in module [Link]), 121 items() ([Link].bpy_prop_collection method), 1165 items() ([Link].bpy_struct method), 1168 iterations ([Link] attribute), 325 iterations ([Link] attribute), 341 iterations ([Link] attribute), 350 iterations ([Link] attribute), 532 iterations ([Link] attribute), 562 iterations ([Link] attribute), 865 iterations ([Link] attribute), 915 iterator() ([Link] method), 556

J
jitter ([Link] attribute), 290 jitter_factor ([Link] attribute), 757 JKEY (in module [Link]), 1360 join() (in module [Link]), 108 join_shapes() (in module [Link]), 108 join_uvs() (in module [Link]), 108 joint_bindings ([Link] attribute), 963 joint_rotation ([Link].BL_ArmatureChannel attribute), 1332 joystick_index ([Link] attribute), 534 JoystickSensor (class in [Link]), 533 jump() (in module [Link]), 153

K
keep ([Link] attribute), 1255 keep_axis ([Link] attribute), 973 KERNING_DEFAULT (in module blf), 1245 key ([Link].SCA_KeyboardSensor attribute), 1315 key ([Link] attribute), 376 key ([Link] attribute), 549 Key (class in [Link]), 535 Key.animation_data (in module [Link]), 535 Key.key_blocks (in module [Link]), 535 Key.reference_key (in module [Link]), 535 Index

1428

Blender Index, Release 2.59.2 - API

[Link] (in module [Link]), 535 key_modier ([Link] attribute), 541 keyboard (in module [Link]), 1335 KeyboardSensor (class in [Link]), 549 KeyCong (class in [Link]), 536 KeyCong.is_user_dened (in module [Link]), 536 [Link] (in module [Link]), 536 keycong_activate() (in module [Link]), 188 keycong_export() (in module [Link]), 188 keycong_import() (in module [Link]), 188 keycong_preset_add() (in module [Link]), 189 keycong_remove() (in module [Link]), 189 keycong_set() (in module [Link]), 1170 keycong_test() (in module [Link]), 189 KeyCongurations (class in [Link]), 537 [Link] (in module [Link]), 537 [Link] (in module [Link]), 537 [Link] (in module [Link]), 538 keyed_loops ([Link] attribute), 757 keyframe ([Link] attribute), 1044 Keyframe (class in [Link]), 552 keyframe_delete() ([Link].bpy_struct method), 1168 keyframe_delete() (in module [Link]), 41 keyframe_delete_button() (in module [Link]), 41 keyframe_delete_v3d() (in module [Link]), 41 keyframe_insert() ([Link].bpy_struct method), 1168 keyframe_insert() (in module [Link]), 38 keyframe_insert() (in module [Link]), 41 keyframe_insert() (in module [Link]), 68 keyframe_insert_button() (in module [Link]), 42 keyframe_insert_menu() (in module [Link]), 42 keyframe_jump() (in module [Link]), 136 keyframe_new_handle_type ([Link] attribute), 1104 keyframe_new_interpolation_type ([Link] attribute), 1104 keyframe_type() (in module [Link]), 38 keying_set_active_set() (in module [Link]), 42 keying_set_add() (in module [Link]), 42 keying_set_export() (in module [Link]), 42 keying_set_path_add() (in module [Link]), 42 keying_set_path_remove() (in module [Link]), 42 keying_set_remove() (in module [Link]), 42 KeyingSet (class in [Link]), 554 KeyingSet.is_path_absolute (in module [Link]), 554 [Link] (in module [Link]), 554 KeyingSet.type_info (in module [Link]), 555 keyingset_add_selected() (in module [Link]), 121 keyingset_button_add() (in module [Link]), 42 keyingset_button_remove() (in module [Link]), 42

keyingset_remove_selected() (in module [Link]), 122 KeyingSetInfo (class in [Link]), 555 KeyingSetPath (class in [Link]), 557 KeyingSetPaths (class in [Link]), 558 KeyingSets (class in [Link]), 560 KeyingSetsAll (class in [Link]), 561 keyitem_add() (in module [Link]), 189 keyitem_remove() (in module [Link]), 189 keyitem_restore() (in module [Link]), 189 KeyMap (class in [Link]), 538 KeyMap.is_modal (in module [Link]), 538 KeyMap.keymap_items (in module [Link]), 539 [Link] (in module [Link]), 539 KeyMap.region_type (in module [Link]), 539 KeyMap.space_type (in module [Link]), 539 keymap_restore() (in module [Link]), 189 KeyMapItem (class in [Link]), 540 [Link] (in module [Link]), 540 KeyMapItem.is_user_dened (in module [Link]), 541 KeyMapItem.is_user_modied (in module [Link]), 541 [Link] (in module [Link]), 541 [Link] (in module [Link]), 542 KeyMapItems (class in [Link]), 544 KeyMaps (class in [Link]), 548 keys() ([Link].bpy_prop_collection method), 1165 keys() ([Link].bpy_struct method), 1169 keys_step ([Link] attribute), 757 KinematicConstraint (class in [Link]), 561 kink ([Link] attribute), 757 kink_amplitude ([Link] attribute), 757 kink_amplitude_clump ([Link] attribute), 757 kink_axis ([Link] attribute), 757 kink_factor ([Link] attribute), 764 kink_at ([Link] attribute), 757 kink_frequency ([Link] attribute), 757 kink_shape ([Link] attribute), 757 KKEY (in module [Link]), 1360 knife_cut() (in module [Link]), 86 KX_ACT_CONSTRAINT_DISTANCE (in module [Link]), 1341 KX_ACT_CONSTRAINT_DOROTFH (in module [Link]), 1341 KX_ACT_CONSTRAINT_FHNX (in module [Link]), 1342 KX_ACT_CONSTRAINT_FHNY (in module [Link]), 1342 KX_ACT_CONSTRAINT_FHNZ (in module [Link]), 1342 KX_ACT_CONSTRAINT_FHPX (in module [Link]), 1342

Index

1429

Blender Index, Release 2.59.2 - API

KX_ACT_CONSTRAINT_FHPY (in module [Link]), KX_CONSTRAINTACT_DIRPZ (in module [Link]), 1342 1341 KX_ACT_CONSTRAINT_FHPZ (in module [Link]), KX_CONSTRAINTACT_LOCX (in module [Link]), 1342 1341 KX_ACT_CONSTRAINT_LOCAL (in module KX_CONSTRAINTACT_LOCY (in module [Link]), [Link]), 1341 1341 KX_ACT_CONSTRAINT_MATERIAL (in module KX_CONSTRAINTACT_LOCZ (in module [Link]), [Link]), 1341 1341 KX_ACT_CONSTRAINT_NORMAL (in module KX_CONSTRAINTACT_ORIX (in module [Link]), [Link]), 1341 1342 KX_ACT_CONSTRAINT_PERMANENT (in module KX_CONSTRAINTACT_ORIY (in module [Link]), [Link]), 1341 1342 KX_ACTIONACT_FLIPPER (in module [Link]), KX_CONSTRAINTACT_ORIZ (in module [Link]), 1340, 1344 1342 KX_ACTIONACT_LOOPEND (in module [Link]), KX_CONSTRAINTACT_ROTX (in module [Link]), 1340, 1344 1341 KX_ACTIONACT_LOOPSTOP (in module [Link]), KX_CONSTRAINTACT_ROTY (in module [Link]), 1340, 1344 1341 KX_ACTIONACT_PLAY (in module [Link]), 1340, KX_CONSTRAINTACT_ROTZ (in module [Link]), 1344 1341 KX_ACTIONACT_PROPERTY (in module [Link]), KX_ConstraintActuator (class in [Link]), 1270 1340, 1344 KX_ConstraintWrapper (class in [Link]), 1271 KX_ArmatureSensor (class in [Link]), 1324 KX_DYN_DISABLE_DYNAMICS (in module KX_ArmatureSensor.KX_ARMSENSOR_LIN_ERROR_ABOVE [Link]), 1342 (in module [Link]), 1325 KX_DYN_DISABLE_RIGID_BODY (in module KX_ArmatureSensor.KX_ARMSENSOR_LIN_ERROR_BELOW [Link]), 1342 (in module [Link]), 1325 KX_DYN_ENABLE_RIGID_BODY (in module KX_ArmatureSensor.KX_ARMSENSOR_ROT_ERROR_ABOVE [Link]), 1342 (in module [Link]), 1325 KX_DYN_RESTORE_DYNAMICS (in module KX_ArmatureSensor.KX_ARMSENSOR_ROT_ERROR_BELOW [Link]), 1342 (in module [Link]), 1325 KX_DYN_SET_MASS (in module [Link]), 1342 KX_ArmatureSensor.KX_ARMSENSOR_STATE_CHANGED KX_FALSE (in module [Link]), 1339 (in module [Link]), 1325 KX_GAME_LOAD (in module [Link]), 1342 KX_BLENDER_GLSL_MATERIAL (in module KX_GAME_LOADCFG (in module [Link]), 1342 [Link]), 1349 KX_GAME_QUIT (in module [Link]), 1342 KX_BLENDER_MULTITEX_MATERIAL (in module KX_GAME_RESTART (in module [Link]), 1342 [Link]), 1349 KX_GAME_SAVECFG (in module [Link]), 1342 KX_BlenderMaterial (class in [Link]), 1270 KX_GAME_START (in module [Link]), 1342 KX_Camera (class in [Link]), 1319 KX_GameActuator (class in [Link]), 1272 KX_Camera.INSIDE (in module [Link]), 1319 KX_GameObject (class in [Link]), 1272 KX_Camera.INTERSECT (in module [Link]), 1319 KX_INPUT_ACTIVE (in module [Link]), 1344 KX_Camera.OUTSIDE (in module [Link]), 1319 KX_INPUT_JUST_ACTIVATED (in module [Link]), KX_CameraActuator (class in [Link]), 1270 1344 KX_CONSTRAINTACT_DIRNX (in module [Link]), KX_INPUT_JUST_RELEASED (in module [Link]), 1341 1344 KX_CONSTRAINTACT_DIRNY (in module [Link]), KX_INPUT_NONE (in module [Link]), 1344 1341 KX_IPOACT_FLIPPER (in module [Link]), 1343 KX_CONSTRAINTACT_DIRNZ (in module [Link]), KX_IPOACT_FROM_PROP (in module [Link]), 1343 1341 KX_IPOACT_LOOPEND (in module [Link]), 1343 KX_CONSTRAINTACT_DIRPX (in module [Link]), KX_IPOACT_LOOPSTOP (in module [Link]), 1343 1341 KX_IPOACT_PINGPONG (in module [Link]), 1343 KX_CONSTRAINTACT_DIRPY (in module [Link]), KX_IPOACT_PLAY (in module [Link]), 1343 1341 KX_IpoActuator (class in [Link]), 1283 KX_LightObject (class in [Link]), 1284

1430

Index

NavMeshModier (class in [Link]), 668 ndof_y_helicopter ([Link] atnabla ([Link] attribute), 312 tribute), 1110 nabla ([Link] attribute), 415 ndof_lock_horizon ([Link] atnabla ([Link] attribute), 587 tribute), 1110 nabla ([Link] attribute), 665 ndof_orbit() (in module [Link].view3d), 180 nabla ([Link] attribute), 1135 ndof_orbit_invert_axes ([Link] nabla ([Link] attribute), 1151 attribute), 1110 name ([Link].BL_ArmatureBone attribute), 1332 ndof_pan() (in module [Link].view3d), 180 name ([Link].BL_ArmatureChannel attribute), 1328 ndof_panx_invert_axis ([Link] name ([Link].BL_ArmatureConstraint attribute), 1327 attribute), 1111 name ([Link] attribute), 1261 ndof_pany_invert_axis ([Link] name ([Link].KX_GameObject attribute), 1272 attribute), 1111 name ([Link].KX_Scene attribute), 1303 ndof_panz_invert_axis ([Link] name ([Link].SCA_ILogicBrick attribute), 1261 attribute), 1111 name ([Link] attribute), 201 ndof_roll_invert_axis ([Link] name ([Link] attribute), 204 attribute), 1111 name ([Link] attribute), 271 ndof_rotate_invert_axis ([Link] name ([Link] attribute), 280 attribute), 1111 name ([Link] attribute), 282 ndof_sensitivity ([Link] atname ([Link] attribute), 285 tribute), 1111 name ([Link] attribute), 385 ndof_sensitivity_change() (in module [Link]), 190 name ([Link] attribute), 394 ndof_show_guide ([Link] atname ([Link] attribute), 425 tribute), 1111 name ([Link] attribute), 429 ndof_tilt_invert_axis ([Link] atname ([Link] attribute), 495 tribute), 1111 name ([Link] attribute), 511 ndof_zoom_invert ([Link] atname ([Link] attribute), 536 tribute), 1111 name ([Link] attribute), 554 ndof_zoom_updown ([Link] atname ([Link] attribute), 626 tribute), 1111 name ([Link] attribute), 633 near ([Link].KX_Camera attribute), 1319 name ([Link] attribute), 635 name ([Link] attribute), 637 NearSensor (class in [Link]), 669 negate() ([Link] method), 1192 name ([Link] attribute), 640 new() ([Link] method), 200 name ([Link] attribute), 653 new() ([Link] method), 202 name ([Link] attribute), 671 new() ([Link] method), 203 name ([Link] attribute), 674 new() ([Link] class method), 207 name ([Link] attribute), 676 new() ([Link] method), 229 name ([Link] attribute), 682 name ([Link] attribute), 729 new() ([Link] method), 242 new() ([Link] method), 243 name ([Link] attribute), 770 new() ([Link] method), 244 name ([Link] attribute), 781 new() ([Link] method), 245 name ([Link] attribute), 794 new() ([Link] method), 246 name ([Link] attribute), 802 new() ([Link] method), 249 name ([Link] attribute), 856 new() ([Link] method), 249 name ([Link] attribute), 868 new() ([Link] method), 251 name ([Link] attribute), 871 new() ([Link] method), 252 name ([Link] attribute), 902 new() ([Link] method), 254 name ([Link] attribute), 1019 new() ([Link] method), 255 name ([Link] attribute), 1059 new() ([Link] method), 256 name ([Link] attribute), 1071 new() ([Link] method), 257 name ([Link] attribute), 1124 new() ([Link] method), 258 NandController (class in [Link]), 667 new() ([Link] method), 259 narrowness ([Link] attribute), 1143 new() ([Link] method), 260 navmesh ([Link] attribute), 971 Index 1441

Blender Index, Release 2.59.2 - API

new() ([Link] method), 263 new() ([Link] method), 264 new() ([Link] method), 265 new() ([Link] method), 267 new() ([Link] method), 303 new() ([Link] method), 321 new() ([Link] method), 382 new() ([Link] method), 409 new() ([Link] method), 452 new() ([Link] method), 504 new() ([Link] method), 506 new() ([Link] method), 538 new() ([Link] method), 560 new() ([Link] method), 544 new() ([Link] method), 548 new() ([Link] method), 647 new() ([Link] method), 673 new() ([Link] method), 675 new() ([Link] method), 680 new() ([Link] method), 717 new() ([Link] method), 719 new() ([Link] method), 797 new() ([Link] method), 899 new() ([Link] method), 1015 new() ([Link] method), 1060 new() ([Link] method), 1100 new() ([Link] method), 1123 new() ([Link] method), 1126 new() (in module [Link]), 38 new() (in module [Link]), 72 new() (in module [Link]), 82 new() (in module [Link]), 125 new() (in module [Link]), 133 new() (in module [Link]), 134 new() (in module [Link]), 136 new() (in module [Link]), 153 new() (in module [Link]), 156 new() (in module [Link]), 195 new_modal() ([Link] method), 545 new_node_tree() (in module [Link]), 100 new_target() (in module [Link]), 125 next() (in module [Link]), 62 next_edit() (in module [Link]), 143 next_marker() (in module [Link]), 153 ngon_tesselate() (in module bpy_extras.mesh_utils), 1259 NINEKEY (in module [Link]), 1361 NKEY (in module [Link]), 1360 NlaStrip (class in [Link]), 670 [Link] (in module [Link]), 670 [Link] (in module [Link]), 671 [Link] (in module [Link]), 671 [Link] (in module [Link]), 671 [Link] (in module [Link]), 671 NlaStrips (class in [Link]), 673

NlaTrack (class in [Link]), 674 [Link] (in module [Link]), 674 NlaTrack.is_solo (in module [Link]), 674 [Link] (in module [Link]), 674 NlaTracks (class in [Link]), 675 Node (class in [Link]), 676 [Link] (in module [Link]), 676 [Link] (in module [Link]), 676 [Link] (in module [Link]), 676 node_backdrop ([Link] attribute), 1040 node_output ([Link] attribute), 374 node_output ([Link] attribute), 894 node_output ([Link] attribute), 1011 node_tree ([Link] attribute), 677 node_tree ([Link] attribute), 679 node_tree ([Link] attribute), 698 node_tree ([Link] attribute), 940 NodeForLoop (class in [Link]), 677 NodeFrame (class in [Link]), 678 NodeGroup (class in [Link]), 679 NodeLink (class in [Link]), 679 NodeLink.from_node (in module [Link]), 679 NodeLink.from_socket (in module [Link]), 680 NodeLink.to_node (in module [Link]), 680 NodeLink.to_socket (in module [Link]), 680 NodeLinks (class in [Link]), 680 NodeSocket (class in [Link]), 681 [Link] (in module [Link]), 682 NodeSocketBoolean (class in [Link]), 683 NodeSocketFloatAngle (class in [Link]), 683 NodeSocketFloatDistance (class in [Link]), 684 NodeSocketFloatFactor (class in [Link]), 685 NodeSocketFloatNone (class in [Link]), 686 NodeSocketFloatPercentage (class in [Link]), 686 NodeSocketFloatTime (class in [Link]), 687 NodeSocketFloatUnsigned (class in [Link]), 688 NodeSocketIntNone (class in [Link]), 689 NodeSocketIntUnsigned (class in [Link]), 690 NodeSocketRGBA (class in [Link]), 690 NodeSocketVectorAcceleration (class in [Link]), 691 NodeSocketVectorDirection (class in [Link]), 692 NodeSocketVectorEuler (class in [Link]), 693 NodeSocketVectorNone (class in [Link]), 694 NodeSocketVectorTranslation (class in [Link]), 694 NodeSocketVectorVelocity (class in [Link]), 695 NodeSocketVectorXYZ (class in [Link]), 696 NodeTree (class in [Link]), 697 NodeTree.animation_data (in module [Link]), 697 [Link] (in module [Link]), 697 [Link] (in module [Link]), 697

1442

Index

Blender Index, Release 2.59.2 - API

[Link] (in module [Link]), 697 [Link] (in module [Link]), 697 NodeWhileLoop (class in [Link]), 698 noise ([Link] attribute), 468 noise() (in module [Link]), 87 noise_basis ([Link] attribute), 312 noise_basis ([Link] attribute), 415 noise_basis ([Link] attribute), 587 noise_basis ([Link] attribute), 665 noise_basis ([Link] attribute), 783 noise_basis ([Link] attribute), 976 noise_basis ([Link] attribute), 1151 noise_basis_2 ([Link] attribute), 588 noise_basis_2 ([Link] attribute), 1151 noise_depth ([Link] attribute), 313 noise_depth ([Link] attribute), 585 noise_depth ([Link] attribute), 588 noise_distortion ([Link] attribute), 415 noise_intensity ([Link] attribute), 666 noise_intensity ([Link] attribute), 1136 noise_scale ([Link] attribute), 313 noise_scale ([Link] attribute), 416 noise_scale ([Link] attribute), 588 noise_scale ([Link] attribute), 666 noise_scale ([Link] attribute), 977 noise_scale ([Link] attribute), 1136 noise_scale ([Link] attribute), 1151 noise_type ([Link] attribute), 313 noise_type ([Link] attribute), 588 noise_type ([Link] attribute), 911 noise_type ([Link] attribute), 977 noise_type ([Link] attribute), 1151 NoiseTexture (class in [Link]), 699 NoiseTexture.users_material (in module [Link]), 699 NoiseTexture.users_object_modier (in module [Link]), 699 noodle_curving ([Link] attribute), 1040 NorController (class in [Link]), 700 normal ([Link].KX_VertexProxy attribute), 1309 normal ([Link] attribute), 641 normal ([Link] attribute), 1021 normal ([Link].ThemeView3D attribute), 1055 normal() (in module [Link]), 1213 normal_angle ([Link] attribute), 520 normal_factor ([Link] attribute), 610 normal_factor ([Link] attribute), 758

normal_map_space ([Link] attribute), 610 normal_size ([Link] attribute), 1063 normal_up ([Link] attribute), 971 normal_weight ([Link] attribute), 290 normalize() ([Link] method), 1192 normalized() ([Link] method), 1192 normals_make_consistent() (in module [Link]), 87 numAxis ([Link].SCA_JoystickSensor attribute), 1314 numButtons ([Link].SCA_JoystickSensor attribute), 1314 numHats ([Link].SCA_JoystickSensor attribute), 1314 numMaterials ([Link].KX_MeshProxy attribute), 1286 numPolygons ([Link].KX_MeshProxy attribute), 1286 nurb_sel_uline ([Link].ThemeView3D attribute), 1055 nurb_sel_vline ([Link].ThemeView3D attribute), 1055 nurb_uline ([Link].ThemeView3D attribute), 1055 nurb_vline ([Link].ThemeView3D attribute), 1055

O
obj() (in module [Link].export_scene), 59 obj() (in module [Link].import_scene), 77 object ([Link].KX_CameraActuator attribute), 1270 object ([Link].KX_ParentActuator attribute), 1291 object ([Link].KX_SCA_AddObjectActuator attribute), 1300 object ([Link].KX_TrackToActuator attribute), 1306 object ([Link] attribute), 230 object ([Link] attribute), 273 object ([Link] attribute), 275 object ([Link] attribute), 276 object ([Link] attribute), 287 object ([Link] attribute), 300 object ([Link] attribute), 301 object ([Link] attribute), 408 object ([Link] attribute), 433 object ([Link] attribute), 510 object ([Link] attribute), 568 object ([Link] attribute), 572 object ([Link] attribute), 610 object ([Link] attribute), 627 object ([Link] attribute), 740 object ([Link] attribute), 749 object ([Link] attribute), 765 object ([Link] attribute), 775 object ([Link] attribute), 784 object ([Link] attribute), 801 object ([Link] attribute), 865 object ([Link] attribute), 1099 object ([Link] attribute), 1160 Object (class in [Link]), 701 object (in module [Link]), 32, 33 Object.active_shape_key (in module [Link]), 701 1443

Index

Property.is_never_none (in module [Link]), 799 puff_mode ([Link] attribute), 742 Property.is_output (in module [Link]), 799 pull ([Link] attribute), 919 Property.is_readonly (in module [Link]), 799 push ([Link] attribute), 919 Property.is_registered (in module [Link]), 799 push() (in module [Link]), 130 Property.is_registered_optional (in module [Link]), push_pull() (in module [Link]), 159 799 PyObjectPlus (class in [Link]), 1261 Property.is_required (in module [Link]), 799 python_le_run() (in module [Link]), 138 Property.is_runtime (in module [Link]), 799 PythonConstraint (class in [Link]), 805 Property.is_skip_save (in module [Link]), 799 PythonConstraint.has_script_error (in module [Link]), [Link] (in module [Link]), 799 805 [Link] (in module [Link]), 799 [Link] (in module [Link]), 806 [Link] (in module [Link]), 799 PythonController (class in [Link]), 807 [Link] (in module [Link]), 800 Q [Link] (in module [Link]), 800 PropertyActuator (class in [Link]), 800 QKEY (in module [Link]), 1361 PropertyGroup (class in [Link]), 802 quad_attenuation ([Link].KX_LightObject attribute), PropertyGroupItem (class in [Link]), 803 1285 [Link] (in module [Link]), 803 quadratic_attenuation ([Link] attribute), [Link] (in module [Link]), 803 787 PropertyGroupItem.idp_array (in module [Link]), 803 quadratic_attenuation ([Link] attribute), PropertySensor (class in [Link]), 804 967 propName ([Link].BL_ActionActuator attribute), quadratic_drag ([Link] attribute), 468 1264 quads_convert_to_tris() (in module [Link]), 91 propName ([Link].BL_ShapeActionActuator at- quality ([Link] attribute), 311 tribute), 1268 quality ([Link] attribute), 350 propName ([Link].KX_ConstraintActuator attribute), quality ([Link] attribute), 1271 364 propName ([Link].KX_IpoActuator attribute), 1283 quality ([Link] attribute), 393 propName ([Link].KX_NetworkMessageActuator at- quality ([Link] attribute), 499 tribute), 1289 quality ([Link] attribute), 877 propName ([Link].KX_RaySensor attribute), 1299 Quaternion (class in mathutils), 1187 propName ([Link].KX_TouchSensor attribute), 1288 [Link]() (in module mathutils), 1187 propName ([Link].SCA_PropertyActuator attribute), [Link]() (in module mathutils), 1187 1316 [Link]() (in module mathutils), 1187 propName ([Link].SCA_PropertySensor attribute), [Link]() (in module mathutils), 1188 1316 [Link]() (in module mathutils), 1188 propName ([Link].SCA_RandomActuator attribute), [Link]() (in module mathutils), 1188 1317 [Link]() (in module mathutils), 1188 proportional_coefcient ([Link] at- [Link]() (in module mathutils), 1188 tribute), 714 [Link]() (in module mathutils), 1188 proportional_edit ([Link] attribute), 1063 [Link]() (in module mathutils), 1188 proportional_edit_falloff ([Link] at- [Link]() (in module mathutils), 1189 tribute), 1063 quaternions_ip() (in module [Link]), 130 proportional_size ([Link] attribute), 1064 queue_count ([Link] atprops_enum() ([Link] method), 1078 tribute), 275 propvalue ([Link] attribute), 542 quick_explode() (in module [Link]), 113 protect ([Link] attribute), 447 quick_uid() (in module [Link]), 114 proximity_geometry ([Link] quick_fur() (in module [Link]), 114 attribute), 1133 quick_smoke() (in module [Link]), 114 proximity_mode ([Link].VertexWeightProximityModierquit_blender() (in module [Link]), 192 attribute), 1133 QUOTEKEY (in module [Link]), 1363 proxy_make() (in module [Link]), 113 proxy_render_size ([Link] at- R tribute), 944 r ([Link].KX_VertexProxy attribute), 1310 1450 Index

Blender Index, Release 2.59.2 - API

r ([Link] attribute), 1182 RadarSensor (class in [Link]), 808 radial_control() (in module [Link]), 192 radial_falloff ([Link] attribute), 468 radial_max ([Link] attribute), 468 radial_min ([Link] attribute), 468 radial_symmetry ([Link] attribute), 866 radius ([Link] attribute), 238 radius ([Link] attribute), 301 radius ([Link] attribute), 492 radius ([Link] attribute), 608 radius ([Link] attribute), 648 radius ([Link] attribute), 784 radius ([Link] attribute), 964 radius_interpolation ([Link] attribute), 960 radius_set() (in module [Link]), 54 random_position ([Link] attribute), 749 RandomActuator (class in [Link]), 809 randomize_transform() (in module [Link]), 114 RandomSensor (class in [Link]), 811 range ([Link] attribute), 1353 range ([Link].KX_RaySensor attribute), 1299 range ([Link] attribute), 279 range ([Link] attribute), 389 range ([Link] attribute), 812 range() ([Link] method), 450 RAS_2DFILTER_BLUR (in module [Link]), 1346 RAS_2DFILTER_CUSTOMFILTER (in module [Link]), 1346 RAS_2DFILTER_DILATION (in module [Link]), 1346 RAS_2DFILTER_DISABLED (in module [Link]), 1346 RAS_2DFILTER_ENABLED (in module [Link]), 1346 RAS_2DFILTER_EROSION (in module [Link]), 1346 RAS_2DFILTER_GRAYSCALE (in module [Link]), 1346 RAS_2DFILTER_INVERT (in module [Link]), 1346 RAS_2DFILTER_LAPLACIAN (in module [Link]), 1346 RAS_2DFILTER_MOTIONBLUR (in module [Link]), 1347 RAS_2DFILTER_NOFILTER (in module [Link]), 1347 RAS_2DFILTER_PREWITT (in module [Link]), 1347 RAS_2DFILTER_SEPIA (in module [Link]), 1347 RAS_2DFILTER_SHARPEN (in module [Link]), 1347 RAS_2DFILTER_SOBEL (in module [Link]), 1347 rate ([Link] attribute), 1249 rate ([Link] attribute), 290

ratio ([Link] attribute), 333 ratio ([Link] attribute), 411 ray_cast() ([Link] method), 710 ray_type ([Link] attribute), 812 rayCast() ([Link].KX_GameObject method), 1280 rayCastTo() ([Link].KX_GameObject method), 1280 rayDirection ([Link].KX_MouseFocusSensor attribute), 1288 rayDirection ([Link].KX_RaySensor attribute), 1300 rayLength ([Link].KX_ConstraintActuator attribute), 1271 raymir_factor ([Link] attribute), 610 RaySensor (class in [Link]), 811 raySource ([Link].KX_MouseFocusSensor attribute), 1287 rayTarget ([Link].KX_MouseFocusSensor attribute), 1288 raytrace_method ([Link] attribute), 830 react_event ([Link] attribute), 759 reactor_factor ([Link] attribute), 759 reactor_target_object ([Link] attribute), 771 reactor_target_particle_system ([Link] attribute), 771 read_factory_settings() (in module [Link]), 192 read_fullsamplelayers() (in module [Link]), 100 read_homele() (in module [Link]), 192 read_renderlayers() (in module [Link]), 100 reassign_inputs() (in module [Link]), 144 rebuild_proxy() (in module [Link]), 144 recent_les ([Link] attribute), 1108 record_composite() (in module [Link]), 73 recover_auto_save() (in module [Link]), 192 recover_last_session() (in module [Link]), 193 rect ([Link] attribute), 819 rect ([Link] attribute), 823 redo() (in module [Link]), 56 redo_last() (in module [Link]), 136 redraw_timer() (in module [Link]), 193 reference ([Link].KX_ObjectActuator attribute), 1291 reference_axis ([Link] attribute), 563 reference_object ([Link] attribute), 714 reference_value ([Link] attribute), 457 reect() ([Link] method), 1192 reect_factor ([Link] attribute), 603 reection ([Link] attribute), 616

Index

1451

Blender Index, Release 2.59.2 - API

reection_color ([Link] attribute), 616 reection_color_factor ([Link] attribute), 610 reection_factor ([Link] attribute), 610 refresh() ([Link] method), 1354 refresh() ([Link] method), 1355 refresh() ([Link] method), 1355 refresh() ([Link] method), 1356 refresh() ([Link] method), 1357 refresh() ([Link] method), 1357 refresh() ([Link] method), 1354 refresh() ([Link] method), 555 refresh() (in module [Link]), 63 refresh_all() (in module [Link]), 144 refresh_pyconstraints() (in module [Link]), 154 refresh_script_paths() (in module [Link]), 1171 Region (class in [Link]), 813 [Link] (in module [Link]), 813 [Link] (in module [Link]), 813 [Link] (in module [Link]), 813 [Link] (in module [Link]), 813 region_2d_to_location_3d() (in module bpy_extras.view3d_utils), 1259 region_2d_to_vector_3d() (in module bpy_extras.view3d_utils), 1259 region_ip() (in module [Link]), 136 region_merge_size ([Link] attribute), 854 region_min_size ([Link] attribute), 854 region_quadview() (in module [Link]), 136 region_scale() (in module [Link]), 136 region_to_loop() (in module [Link]), 91 RegionView3D (class in [Link]), 814 RegionView3D.perspective_matrix (in module [Link]), 814 register_class() (in module [Link]), 1171 register_module() (in module [Link]), 1171 regrow_hair ([Link] attribute), 759 reinstancePhysicsMesh() ([Link].KX_GameObject method), 1282 reiteration_method ([Link] attribute), 532 rekey() (in module [Link]), 125 rel_max_x ([Link] attribute), 338 rel_max_y ([Link] attribute), 338 rel_min_x ([Link] attribute), 338 rel_min_y ([Link] attribute), 338 relative ([Link] attribute), 1255

relative ([Link] attribute), 339 relative_key ([Link] attribute), 902 relative_offset_displace ([Link] attribute), 233 relax() (in module [Link]), 131 reload() ([Link] method), 1354 reload() ([Link] method), 518 reload() (in module [Link]), 73 reload() (in module [Link]), 138 reload() (in module [Link]), 144 reload() (in module [Link]), 154 relpath() (in module [Link]), 1173 remove() ([Link] method), 200 remove() ([Link] method), 202 remove() ([Link] method), 203 remove() ([Link] class method), 207 remove() ([Link] method), 229 remove() ([Link] method), 242 remove() ([Link] method), 243 remove() ([Link] method), 244 remove() ([Link] method), 245 remove() ([Link] method), 246 remove() ([Link] method), 247 remove() ([Link] method), 249 remove() ([Link] method), 250 remove() ([Link] method), 251 remove() ([Link] method), 252 remove() ([Link] method), 255 remove() ([Link] method), 255 remove() ([Link] method), 256 remove() ([Link] method), 257 remove() ([Link] method), 258 remove() ([Link] method), 259 remove() ([Link] method), 260 remove() ([Link] method), 263 remove() ([Link] method), 264 remove() ([Link] method), 266 remove() ([Link] method), 267 remove() ([Link] method), 303 remove() ([Link] method), 321 remove() ([Link] method), 383 remove() ([Link] method), 409 remove() ([Link] method), 451 remove() ([Link] method), 452 remove() ([Link] class method), 508 remove() ([Link] method), 538 remove() ([Link] method), 559 remove() ([Link] method), 547 remove() ([Link] class method), 620 remove() ([Link] method), 647 remove() ([Link] method), 673 remove() ([Link] method), 675

1452

Index

subdivide() (in module [Link]), 46 subdivide() (in module [Link]), 56 subdivide() (in module [Link]), 94 subdivide() (in module [Link]), 126 subdivision_set() (in module [Link]), 118 subdivision_type ([Link] attribute), 664 subdivision_type ([Link] attribute), 979 subframes ([Link] attribute), 761 subject ([Link].KX_NetworkMessageActuator attribute), 1289 subject ([Link].KX_NetworkMessageSensor attribute), 1289 subject ([Link] attribute), 643 subject ([Link] attribute), 644 subjects ([Link].KX_NetworkMessageSensor attribute), 1289 subsurf_levels ([Link] attribute), 907 SubsurfModier (class in [Link]), 979 subtarget ([Link].BL_ArmatureActuator attribute), 1324 subtarget ([Link].BL_ArmatureConstraint attribute), 1327 subtarget ([Link] attribute), 199 subtarget ([Link] attribute), 304 subtarget ([Link] attribute), 390 subtarget ([Link] attribute), 396 subtarget ([Link] attribute), 398 subtarget ([Link] attribute), 399 subtarget ([Link] attribute), 400 subtarget ([Link] attribute), 410 subtarget ([Link] attribute), 476 subtarget ([Link] attribute), 510 subtarget ([Link] attribute), 563 subtarget ([Link] attribute), 576 subtarget ([Link] attribute), 582 subtarget ([Link] attribute), 776 subtarget ([Link] attribute), 973 subtarget ([Link] attribute), 1068 subtarget ([Link] attribute), 1070 subtype ([Link] attribute), 683 subtype ([Link] attribute), 684 subtype ([Link] attribute), 685 subtype ([Link] attribute), 686

subtype

([Link] attribute), 687 subtype ([Link] attribute), 687 subtype ([Link] attribute), 688 subtype ([Link] attribute), 689 subtype ([Link] attribute), 690 subtype ([Link] attribute), 691 subtype ([Link] attribute), 692 subtype ([Link] attribute), 693 subtype ([Link] attribute), 694 subtype ([Link] attribute), 694 subtype ([Link] attribute), 695 subtype ([Link] attribute), 696 sun_brightness ([Link] attribute), 567 sun_intensity ([Link] attribute), 567 sun_size ([Link] attribute), 567 SunLamp (class in [Link]), 980 [Link] (in module [Link]), 980 sunsky_preset_add() (in module [Link]), 79 surface_noobs ([Link] attribute), 418 surface_smooth ([Link] attribute), 418 surface_subdivisions ([Link] attribute), 419 SurfaceCurve (class in [Link]), 981 SurfaceModier (class in [Link]), 983 suspend() ([Link].KX_Scene method), 1304 suspendDynamics() ([Link].KX_GameObject method), 1278 suspended ([Link].KX_Scene attribute), 1303 svg() (in module [Link].import_curve), 76 swap() ([Link] method), 871 swap() (in module [Link]), 97 swap() (in module [Link]), 146 swap_data() (in module [Link]), 146 swap_inputs() (in module [Link]), 146 switch_direction() (in module [Link]), 46 switch_direction() (in module [Link]), 56 sync_mode ([Link] attribute), 844 syntax_builtin ([Link] attribute), 1047 syntax_comment ([Link] attribute), 1047

Index

use_entire_array ([Link] attribute), 557 use_envelope_multiply ([Link] attribute), 283 use_envelope_multiply ([Link] attribute), 430 use_environment_light ([Link] attribute), 1157 use_envmaps ([Link] attribute), 833 use_estimate_matrix ([Link] attribute), 920 use_etch_autoname ([Link] attribute), 1065 use_etch_overdraw ([Link] attribute), 1065 use_etch_quick ([Link] attribute), 1065 use_even_distribution ([Link] attribute), 762 use_even_divisions ([Link] attribute), 963 use_even_offset ([Link] attribute), 922 use_exr_half ([Link] attribute), 364 use_external ([Link] attribute), 781 use_external_shadows ([Link] attribute), 617 use_extreme_alpha ([Link] attribute), 599 use_face_collision ([Link] attribute), 920 use_face_texture ([Link] attribute), 596 use_face_texture_alpha ([Link] attribute), 596 use_fade_time ([Link] attribute), 746 use_fake_user ([Link] attribute), 512 use_falloff ([Link] attribute), 1157 use_falloff_curve ([Link] attribute), 785 use_fast_edit ([Link] attribute), 990 use_fh_normal ([Link] attribute), 389 use_fh_normal ([Link] attribute), 601 use_fh_paralel_axis ([Link] attribute), 389 use_elds ([Link] attribute), 518 use_elds ([Link] attribute), 833 use_elds_still ([Link] attribute), 833 use_le_compression ([Link] attribute), 1109 use_le_extension ([Link] attribute), 833 use_ll_back ([Link] attribute), 403 use_ll_deform ([Link] attribute), 403 use_ll_front ([Link] attribute), 403 use_lter ([Link] attribute), 472

use_lter_blender ([Link] attribute), 472 use_lter_case_sensitive ([Link] attribute), 942 use_lter_complete ([Link] attribute), 942 use_lter_les ([Link] attribute), 1109 use_lter_folder ([Link] attribute), 472 use_lter_font ([Link] attribute), 472 use_lter_image ([Link] attribute), 472 use_lter_movie ([Link] attribute), 472 use_lter_script ([Link] attribute), 472 use_lter_size_min ([Link] attribute), 443 use_lter_size_min ([Link] attribute), 526 use_lter_sound ([Link] attribute), 472 use_lter_text ([Link] attribute), 472 use_nd_all ([Link] attribute), 947 use_nd_wrap ([Link] attribute), 947 use_t ([Link] attribute), 356 use_xed_location ([Link] attribute), 481 use_xed_texture ([Link] attribute), 292 use_are_mode ([Link] attribute), 599 use_ight ([Link] attribute), 279 use_ip_axis ([Link] attribute), 268 use_ip_axis ([Link] attribute), 526 use_ip_x ([Link] attribute), 208 use_ip_x ([Link] attribute), 435 use_ip_x ([Link] attribute), 522 use_ip_x ([Link] attribute), 650 use_ip_x ([Link] attribute), 659 use_ip_x ([Link] attribute), 661 use_ip_x ([Link] attribute), 860 use_ip_y ([Link] attribute), 209 use_ip_y ([Link] attribute), 435 use_ip_y ([Link] attribute), 522 use_ip_y ([Link] attribute), 650 use_ip_y ([Link] attribute), 659 use_ip_y ([Link] attribute), 662 use_ip_y ([Link] attribute), 860 use_oat ([Link] attribute), 209 use_oat ([Link] attribute), 435

1480

Index

use_symmetry_y ([Link] attribute), 867 use_symmetry_z ([Link] attribute), 867 use_tabs_as_spaces ([Link] attribute), 986 use_tabs_as_spaces ([Link] attribute), 1116 use_tail ([Link] attribute), 563 use_tangent_shading ([Link] attribute), 597 use_tangent_shading ([Link] attribute), 606 use_tap ([Link] attribute), 868 use_target ([Link] attribute), 563 use_target_z ([Link] attribute), 1068 use_targets ([Link] attribute), 806 use_text_antialiasing ([Link] attribute), 1116 use_texture ([Link] attribute), 600 use_texture_overlay ([Link] attribute), 294 use_textured_fonts ([Link] attribute), 1116 use_textures ([Link] attribute), 597 use_textures ([Link] attribute), 836 use_threaded ([Link] attribute), 867 use_tiff_16bit ([Link] attribute), 836 use_tiles ([Link] attribute), 518 use_time_offset ([Link] attribute), 404 use_time_offset_add_parent ([Link] attribute), 709 use_time_offset_edit ([Link] attribute), 709 use_time_offset_parent ([Link] attribute), 709 use_time_offset_particle ([Link] attribute), 709 use_time_override ([Link] attribute), 419 use_transform ([Link] attribute), 302 use_transform_limit ([Link] attribute), 576 use_transform_limit ([Link] attribute), 577 use_transform_limit ([Link] attribute), 579 use_transform_limit ([Link] attribute), 581 use_translate_buttons ([Link] attribute), 1116 use_translate_toolbox ([Link] attribute), 1116 use_translate_tooltips ([Link] attribute), 1116 use_translation ([Link] attribute), 209 use_translation ([Link] attribute), 435 use_translation ([Link] attribute), 523 use_translation ([Link] attribute), 651 use_translation ([Link] attribute), 659

use_translation ([Link] attribute), 662 use_translation ([Link] attribute), 861 use_transparency ([Link] attribute), 597 use_transparent_shadows ([Link] attribute), 597 use_turbulence ([Link] attribute), 785 use_twoside ([Link] attribute), 639 use_umbra ([Link] attribute), 222 use_underline ([Link] attribute), 988 use_uniform_scale ([Link] attribute), 1073 use_unspill ([Link] attribute), 334 use_uv_as_generated ([Link] attribute), 404 use_uv_as_generated ([Link] attribute), 981 use_uv_as_generated ([Link] attribute), 990 use_uv_select_sync ([Link] attribute), 1066 use_velocity_length ([Link] attribute), 763 use_vertex_buffer_objects ([Link] attribute), 1116 use_vertex_color_light ([Link] attribute), 597 use_vertex_color_paint ([Link] attribute), 597 use_vertex_groups ([Link] attribute), 231 use_vertex_normal ([Link] attribute), 600 use_viscoelastic_springs ([Link] attribute), 841 use_visible ([Link] attribute), 1134 use_visual_keying ([Link] attribute), 1107 use_volume_preserve ([Link] attribute), 1141 use_weight_color_range ([Link] attribute), 1116 use_whole_group ([Link] attribute), 763 use_wrap ([Link] attribute), 294 use_wrap ([Link] attribute), 341 use_x ([Link] attribute), 302 use_x ([Link] attribute), 396 use_x ([Link] attribute), 398 use_x ([Link] attribute), 399 use_x ([Link] attribute), 652 use_x ([Link] attribute), 905

Index

1489

Blender Index, Release 2.59.2 - API

use_x ([Link] attribute), 915 useNegPulseMode ([Link].SCA_ISensor attribute), use_x ([Link] attribute), 1144 1262 use_x_ray ([Link] attribute), 812 useOcclusion ([Link].KX_VisibilityActuator atuse_y ([Link] attribute), 302 tribute), 1311 use_y ([Link] attribute), 396 usePhysicsMesh ([Link].KX_SCA_ReplaceMeshActuator use_y ([Link] attribute), 398 attribute), 1302 use_y ([Link] attribute), 399 usePosPulseMode ([Link].SCA_ISensor attribute), use_y ([Link] attribute), 652 1262 use_y ([Link] attribute), 905 usePropBody ([Link].KX_NetworkMessageActuator use_y ([Link] attribute), 915 attribute), 1289 use_y ([Link] attribute), 1144 usePulseCollision ([Link].KX_TouchSensor attribute), use_y_stretch ([Link] attribute), 1288 963 usePulseFocus ([Link].KX_MouseFocusSensor use_z ([Link] attribute), 302 attribute), 1288 use_z ([Link] attribute), 396 user_clear() ([Link] method), 512 use_z ([Link] attribute), 398 user_resource() (in module [Link]), 1171 use_z ([Link] attribute), 399 user_script_path() (in module [Link]), 1172 use_z ([Link] attribute), 652 user_transforms_clear() (in module [Link]), 132 use_z ([Link] attribute), 905 useRecursion ([Link].KX_VisibilityActuator atuse_z ([Link] attribute), 915 tribute), 1312 use_zbuffer ([Link] at- useRestart ([Link].KX_SceneActuator attribute), 1305 tribute), 343 userjit ([Link] attribute), 763 use_zmask ([Link] attribute), 858 userpref_show() (in module [Link]), 137 use_zoom_to_mouse ([Link] at- UserPreferences (class in [Link]), 1102 tribute), 1120 [Link] (in module [Link]), 1102 use_ztransp ([Link] attribute), 858 [Link] (in module [Link]), 1103 useAllKeys ([Link].SCA_KeyboardSensor attribute), [Link] (in module [Link]), 1103 1315 [Link] (in module [Link]), 1103 useChildren ([Link].KX_IpoActuator attribute), 1284 [Link] (in module [Link]), 1103 useContinue ([Link].BL_ActionActuator attribute), [Link] (in module [Link]), 1103 1264 UserPreferences.ui_styles (in module [Link]), 1103 useDisplayMesh ([Link].KX_SCA_ReplaceMeshActuator [Link] (in module [Link]), 1103 attribute), 1302 UserPreferencesEdit (class in [Link]), 1104 useHighPriority ([Link].SCA_IController attribute), UserPreferencesFilePaths (class in [Link]), 1107 1263 UserPreferencesInput (class in [Link]), 1110 useIpoAdd ([Link].KX_IpoActuator attribute), 1284 UserPreferencesSystem (class in [Link]), 1113 useIpoAsForce ([Link].KX_IpoActuator attribute), UserPreferencesSystem.solid_lights (in module 1284 [Link]), 1115 useIpoLocal ([Link].KX_IpoActuator attribute), 1284 UserPreferencesSystem.weight_color_range (in module useLocalAngV ([Link].KX_ObjectActuator attribute), [Link]), 1117 1291 UserPreferencesView (class in [Link]), 1117 useLocalDLoc ([Link].KX_ObjectActuator attribute), UserSolidLight (class in [Link]), 1121 1290 useViewport ([Link].KX_Camera attribute), 1320 useLocalDRot ([Link].KX_ObjectActuator attribute), useXRay ([Link].KX_RaySensor attribute), 1300 1290 useXY ([Link].KX_CameraActuator attribute), 1270 useLocalForce ([Link].KX_ObjectActuator attribute), UV ([Link].KX_VertexProxy attribute), 1309 1290 uv ([Link] attribute), 639 useLocalLinV ([Link].KX_ObjectActuator attribute), uv1 ([Link] attribute), 639 1290 uv2 ([Link] attribute), 639 useLocalTorque ([Link].KX_ObjectActuator at- uv3 ([Link] attribute), 639 tribute), 1290 uv4 ([Link] attribute), 639 useMaterial ([Link].KX_RaySensor attribute), 1299 uv_layer ([Link] attribute), 414 useMaterial ([Link].KX_TouchSensor attribute), 1288 uv_layer ([Link] attribute), 606 uv_layer ([Link] attribute), 613

1490

Index

Blender Index, Release 2.59.2 - API

uv_layer

([Link] attribute), 766 uv_layer ([Link] attribute), 883 uv_layer ([Link] attribute), 1098 uv_layer ([Link] attribute), 1141 uv_layer ([Link] attribute), 1144 uv_raw ([Link] attribute), 639 uv_select_mode ([Link] attribute), 1066 uv_texture_add() (in module [Link]), 94 uv_texture_clone ([Link] attribute), 623 uv_texture_clone_index ([Link] attribute), 623 uv_texture_remove() (in module [Link]), 94 uv_texture_stencil ([Link] attribute), 623 uv_texture_stencil_index ([Link] attribute), 623 UVProjectModier (class in [Link]), 1097 [Link] (in module [Link]), 1098 UVProjector (class in [Link]), 1099 uvs_mirror() (in module [Link]), 95 uvs_rotate() (in module [Link]), 95 UVTextures (class in [Link]), 1100

V
v ([Link].KX_VertexProxy attribute), 1309 v ([Link] attribute), 1182 v1 ([Link].KX_PolyProxy attribute), 1292 v2 ([Link].KX_PolyProxy attribute), 1292 v2 ([Link].KX_VertexProxy attribute), 1310 v3 ([Link].KX_PolyProxy attribute), 1292 v4 ([Link].KX_PolyProxy attribute), 1292 valid ([Link] attribute), 1355 valid ([Link] attribute), 1354 valid ([Link] attribute), 1355 valid ([Link] attribute), 1356 valid ([Link] attribute), 1356 valid ([Link] attribute), 1357 valid ([Link] attribute), 1353 validate() ([Link].BL_Shader method), 1268 validate() ([Link] method), 623 value ([Link].KX_ArmatureSensor attribute), 1325 value ([Link].SCA_2DFilterActuator attribute), 1312 value ([Link].SCA_PropertyActuator attribute), 1316 value ([Link].SCA_PropertySensor attribute), 1316 value ([Link] attribute), 232 value ([Link] attribute), 488 value ([Link] attribute), 489 value ([Link] attribute), 490 value ([Link] attribute), 497 value ([Link] attribute), 498 value ([Link] attribute), 543 value ([Link] attribute), 632 value ([Link] attribute), 634 value ([Link] attribute), 636 value ([Link] attribute), 801 Index

value ([Link] attribute), 804 value ([Link] attribute), 902 value_max ([Link] attribute), 804 value_min ([Link] attribute), 805 value_offset ([Link] attribute), 460 value_sliders ([Link] attribute), 1025 values() ([Link].bpy_prop_collection method), 1165 values() ([Link].bpy_struct method), 1170 Vector (class in mathutils), 1190 [Link]() (in module mathutils), 1191 [Link]() (in module mathutils), 1191 [Link]() (in module mathutils), 1193 [Link]() (in module mathutils), 1191 [Link]() (in module mathutils), 1192 [Link]() (in module mathutils), 1193 VectorFont (class in [Link]), 1122 [Link] (in module [Link]), 1122 VectorFont.packed_le (in module [Link]), 1122 vectorscope_alpha ([Link] attribute), 862 VEHICLE_CONSTRAINT (in module [Link]), 1370 velocity ([Link] attribute), 1255 velocity ([Link].KX_SoundActuator attribute), 1306 velocity ([Link] attribute), 741 velocity ([Link] attribute), 751 velocity ([Link] attribute), 972 velocity_factor ([Link] attribute), 767 velocity_factor ([Link] attribute), 913 velocity_max ([Link] attribute), 494 velocity_max ([Link] attribute), 533 velocity_min ([Link] attribute), 494 velocity_radius ([Link] attribute), 393 velocity_strength ([Link] attribute), 393 version (in module [Link]), 1173 version_char (in module [Link]), 1174 version_cycle (in module [Link]), 1174 version_string (in module [Link]), 1174 vert_deformer ([Link] attribute), 226 vertex ([Link] attribute), 1031 vertex ([Link] attribute), 1033 vertex ([Link].ThemeView3D attribute), 1055 vertex_add() (in module [Link]), 56 vertex_cache_space ([Link] attribute), 785 vertex_color_add() (in module [Link]), 95 vertex_color_dirt() (in module [Link]), 123

1491

Blender Index, Release 2.59.2 - API

vertex_color_remove() (in module [Link]), 95 vertex_color_set() (in module [Link]), 124 vertex_group ([Link] attribute), 231 vertex_group ([Link] attribute), 302 vertex_group ([Link] attribute), 408 vertex_group ([Link] attribute), 414 vertex_group ([Link] attribute), 447 vertex_group ([Link] attribute), 510 vertex_group ([Link] attribute), 571 vertex_group ([Link] attribute), 572 vertex_group ([Link] attribute), 590 vertex_group ([Link] attribute), 627 vertex_group ([Link] attribute), 902 vertex_group ([Link] attribute), 907 vertex_group ([Link] attribute), 909 vertex_group ([Link] attribute), 915 vertex_group ([Link] attribute), 922 vertex_group ([Link] attribute), 1129 vertex_group ([Link] attribute), 1133 vertex_group ([Link] attribute), 1141 vertex_group ([Link] attribute), 1144 vertex_group_a ([Link] attribute), 1131 vertex_group_add() (in module [Link]), 119 vertex_group_assign() (in module [Link]), 119 vertex_group_b ([Link] attribute), 1131 vertex_group_bending ([Link] attribute), 311 vertex_group_blend() (in module [Link]), 119 vertex_group_clean() (in module [Link]), 119 vertex_group_clump ([Link] attribute), 771 vertex_group_copy() (in module [Link]), 119 vertex_group_copy_to_linked() (in module [Link]), 119 vertex_group_copy_to_selected() (in module [Link]), 119 vertex_group_density ([Link] attribute), 771 vertex_group_deselect() (in module [Link]), 119 vertex_group_eld ([Link] attribute), 771 vertex_group_goal ([Link] attribute), 920 vertex_group_invert() (in module [Link]), 119 vertex_group_kink ([Link] attribute), 771

vertex_group_length ([Link] attribute), 771 vertex_group_levels() (in module [Link]), 120 vertex_group_mass ([Link] attribute), 311 vertex_group_mass ([Link] attribute), 920 vertex_group_mirror() (in module [Link]), 120 vertex_group_move() (in module [Link]), 120 vertex_group_normalize() (in module [Link]), 120 vertex_group_normalize_all() (in module [Link]), 120 vertex_group_remove() (in module [Link]), 120 vertex_group_remove_from() (in module [Link]), 120 vertex_group_rotation ([Link] attribute), 772 vertex_group_roughness_1 ([Link] attribute), 772 vertex_group_roughness_2 ([Link] attribute), 772 vertex_group_roughness_end ([Link] attribute), 772 vertex_group_select() (in module [Link]), 120 vertex_group_set_active() (in module [Link]), 120 vertex_group_size ([Link] attribute), 772 vertex_group_sort() (in module [Link]), 120 vertex_group_spring ([Link] attribute), 920 vertex_group_structural_stiffness ([Link] attribute), 311 vertex_group_tangent ([Link] attribute), 772 vertex_group_velocity ([Link] attribute), 772 vertex_group_weight ([Link] attribute), 1066 vertex_normal ([Link].ThemeView3D attribute), 1056 vertex_paint() (in module [Link]), 124 vertex_paint_object (in module [Link]), 32 vertex_paint_toggle() (in module [Link]), 124 vertex_parent_set() (in module [Link]), 120 vertex_select ([Link] attribute), 1031 vertex_select ([Link] attribute), 1033 vertex_select ([Link].ThemeView3D attribute), 1056 vertex_size ([Link] attribute), 1032 vertex_size ([Link] attribute), 1033

1492

Index

Blender Index, Release 2.59.2 - API

vertex_size ([Link].ThemeView3D attribute), 1056 vertex_tool ([Link] attribute), 294 vertex_tool_set() (in module [Link]), 47 VertexColors (class in [Link]), 1123 VertexGroup (class in [Link]), 1124 [Link] (in module [Link]), 1124 VertexGroupElement (class in [Link]), 1125 [Link] (in module [Link]), 1125 VertexGroups (class in [Link]), 1126 [Link] (in module [Link]), 1126 VertexPaint (class in [Link]), 1127 VertexWeightEditModier (class in [Link]), 1128 VertexWeightEditModier.map_curve (in module [Link]), 1128 VertexWeightMixModier (class in [Link]), 1130 VertexWeightProximityModier (class in [Link]), 1132 vertices ([Link] attribute), 628 vertices ([Link] attribute), 630 vertices_randomize() (in module [Link]), 95 vertices_raw ([Link] attribute), 631 vertices_smooth() (in module [Link]), 95 vertices_sort() (in module [Link]), 95 verts_per_poly ([Link] attribute), 854 VideoFFmpeg (class in [Link]), 1353 view2d_grid_spacing_min ([Link] attribute), 1120 view_all() (in module [Link]), 39 view_all() (in module [Link]), 71 view_all() (in module [Link]), 75 view_all() (in module [Link]), 98 view_all() (in module [Link]), 101 view_all() (in module [Link]), 146 view_all() (in module [Link]), 157 view_all() (in module [Link].view3d), 181 view_all_preview() (in module [Link]), 146 view_axis ([Link] attribute), 235 view_cancel() (in module [Link]), 134 view_center_camera() (in module [Link].view3d), 181 view_center_cursor() (in module [Link].view3d), 181 view_distance ([Link].RegionView3D attribute), 814 view_ghost_border() (in module [Link]), 146 view_location ([Link].RegionView3D attribute), 814 view_matrix ([Link].RegionView3D attribute), 814 view_ndof() (in module [Link]), 75 view_orbit() (in module [Link].view3d), 181 view_pan() (in module [Link]), 75 view_pan() (in module [Link].view3d), 182 view_perspective ([Link].RegionView3D attribute), 815 view_persportho() (in module [Link].view3d), 182

view_rotate_method ([Link] attribute), 1112 view_rotation ([Link].RegionView3D attribute), 815 view_selected() (in module [Link]), 39 view_selected() (in module [Link]), 71 view_selected() (in module [Link]), 75 view_selected() (in module [Link]), 98 view_selected() (in module [Link]), 146 view_selected() (in module [Link].view3d), 182 view_show() (in module [Link]), 134 view_sliders ([Link] attribute), 1025 view_sliders ([Link] attribute), 1038 view_toggle() (in module [Link]), 146 view_type ([Link] attribute), 945 view_zoom() (in module [Link]), 75 view_zoom_axis ([Link] attribute), 1112 view_zoom_in() (in module [Link]), 75 view_zoom_method ([Link] attribute), 1112 view_zoom_out() (in module [Link]), 75 view_zoom_ratio() (in module [Link]), 75 view_zoom_ratio() (in module [Link]), 146 VIEWMATRIX (in module [Link]), 1347 VIEWMATRIX_INVERSE (in module [Link]), 1347 VIEWMATRIX_INVERSETRANSPOSE (in module [Link]), 1347 VIEWMATRIX_TRANSPOSE (in module [Link]), 1347 viewnumpad() (in module [Link].view3d), 182 viewpoint_object ([Link] attribute), 441 viewport_display_mode ([Link] attribute), 419 viewport_shade ([Link].SpaceView3D attribute), 955 virtual_parents ([Link] attribute), 763 viscosity_base ([Link] attribute), 419 viscosity_exponent ([Link] attribute), 419 viscosity_preset ([Link] attribute), 419 visibility ([Link].KX_VisibilityActuator attribute), 1311 visibility_toggle() (in module [Link]), 101 visibility_toggle() (in module [Link]), 122 VisibilityActuator (class in [Link]), 1134 visible ([Link].KX_GameObject attribute), 1273 visible ([Link].KX_PolyProxy attribute), 1293 visible ([Link].SCA_PythonMouse attribute), 1262 visible_bases (in module [Link]), 31, 33

Index

1493

Blender Index, Release 2.59.2 - API

Best practices for writing Python scripts in Blender are grounded in adherence to PEP 8, the Python style guide. Scripts should feature camel caps for class names, use all-lowercase with underscores for module names, and maintain 4-space indentation . Other guidelines include using spaces around operators and avoiding single-line if statements . In addition to PEP 8, Blender scripts follow specific conventions like using single quotes for enums and double quotes for general strings. While PEP 8 limits line length to 79 characters, Blender allows flexibility depending on the script's context . These practices ensure readability, consistency, maintainability, and seamless integration with Blender's existing codebase .

'bpy.context' plays a critical role in Blender scripting by providing access to the current state and selection within the Blender environment. It is primarily used to access active objects, scenes, and tool settings, allowing scripts to operate contextually based on the user's current state. For instance, one can retrieve the active object using bpy.context.object or get a list of all selected objects with bpy.context.selected_objects . The context is read-only, which prevents scripts from directly modifying its properties. However, scripts can invoke API functions and manipulate data through the data API to change Blender's state .

In Blender's Python API, operator poll functions serve as preconditions that must be satisfied for an operator to be executed successfully. These functions check various conditions like the validity of the working area or if the object is in the correct mode, such as Edit Mode or Weight Paint. If the poll conditions are not met, the operator cannot run, thus preventing runtime errors and ensuring the script operates within the correct context . For example, attempting to call bpy.ops.view3d.render_border() from an invalid context raises a RuntimeError, indicating that the poll function failed . Poll functions are crucial in scripting as they help avoid unnecessary try/except clauses by allowing a script to check operator feasibility beforehand .

Pydev Blender en
No ratings yet
Pydev Blender en
168 pages
Blender Script Types and Usage
No ratings yet
Blender Script Types and Usage
9 pages
Nuxeo Platform 5.8 Administration Documentation
No ratings yet
Nuxeo Platform 5.8 Administration Documentation
256 pages
Blender: Evolution and Key Features
No ratings yet
Blender: Evolution and Key Features
13 pages
150 More Blender Tips!: Command Recorder
No ratings yet
150 More Blender Tips!: Command Recorder
8 pages
NURBS Modeling for Maya Users
No ratings yet
NURBS Modeling for Maya Users
166 pages
Initiation To Python in Blender
100% (1)
Initiation To Python in Blender
22 pages
Maya 2016 Parallel Evaluation Guide
No ratings yet
Maya 2016 Parallel Evaluation Guide
22 pages
3d Environments Handbook
No ratings yet
3d Environments Handbook
208 pages
Maya 3D Animation Lab Experiments
No ratings yet
Maya 3D Animation Lab Experiments
11 pages
Blender NPR Cel Shading GuilltyGearXrd Shader
No ratings yet
Blender NPR Cel Shading GuilltyGearXrd Shader
4 pages
Adam Mechtley - Maya Python For Games and Film - 2012
No ratings yet
Adam Mechtley - Maya Python For Games and Film - 2012
383 pages
PIRATE KING Resume - Dark
No ratings yet
PIRATE KING Resume - Dark
2 pages
Blender Shortcuts
No ratings yet
Blender Shortcuts
4 pages
Learn Game Programming With Ruby Bring Your Ideas ... - (Cover)
No ratings yet
Learn Game Programming With Ruby Bring Your Ideas ... - (Cover)
6 pages
Blender 3D Shortcuts Guide
No ratings yet
Blender 3D Shortcuts Guide
3 pages
Blender Scripting With Python (Sample)
0% (1)
Blender Scripting With Python (Sample)
24 pages
Dev - Mag - 08
100% (2)
Dev - Mag - 08
40 pages
Game Programming With Godot
No ratings yet
Game Programming With Godot
40 pages
Nuke
No ratings yet
Nuke
2,025 pages
Create Your Own 3D Games With B - Gossellin de Benicourt Gregory
No ratings yet
Create Your Own 3D Games With B - Gossellin de Benicourt Gregory
488 pages
Unity 5.x Game Development Blueprints - Sample Chapter
No ratings yet
Unity 5.x Game Development Blueprints - Sample Chapter
57 pages
Current Trends
No ratings yet
Current Trends
13 pages
Anime Cell-Shading in Blender 2.5
100% (2)
Anime Cell-Shading in Blender 2.5
8 pages
Blender Modifier Encyclopedia Guide
No ratings yet
Blender Modifier Encyclopedia Guide
47 pages
Blender Character Animation Guide
100% (3)
Blender Character Animation Guide
5 pages
Male Anatomy Renders
No ratings yet
Male Anatomy Renders
5 pages
Procedural Wear From A To Z in Blender PDF
No ratings yet
Procedural Wear From A To Z in Blender PDF
198 pages
Blender 3D Software Guide for Beginners
100% (1)
Blender 3D Software Guide for Beginners
122 pages
Dynamic Character Animation in Blender
No ratings yet
Dynamic Character Animation in Blender
2 pages
Blender Shortcuts
No ratings yet
Blender Shortcuts
1 page
Step by Step Godot Docs 3 0 Branch Intro
No ratings yet
Step by Step Godot Docs 3 0 Branch Intro
125 pages
Blender Game Engine For Rapid Game Development Pycon 2010 Final
No ratings yet
Blender Game Engine For Rapid Game Development Pycon 2010 Final
51 pages
Blender 3D Environment Creation Course
No ratings yet
Blender 3D Environment Creation Course
3 pages
ImpulZ Documentation
No ratings yet
ImpulZ Documentation
9 pages
3D Animation with Blender Guide
No ratings yet
3D Animation with Blender Guide
22 pages
Deadline 7.1.0.35 User Manual
No ratings yet
Deadline 7.1.0.35 User Manual
969 pages
MayaHotKeys 2
No ratings yet
MayaHotKeys 2
6 pages
Unreal Engine Guide Teknack 2022
No ratings yet
Unreal Engine Guide Teknack 2022
7 pages
Shader Programming Guide for Unity
No ratings yet
Shader Programming Guide for Unity
72 pages
The C Playerx27s Guide 5th Edition 500
No ratings yet
The C Playerx27s Guide 5th Edition 500
400 pages
Ofbook-0 4 0
No ratings yet
Ofbook-0 4 0
492 pages
Cocos2d-X Cookbook - Sample Chapter
No ratings yet
Cocos2d-X Cookbook - Sample Chapter
30 pages
Blender Hotkeys
No ratings yet
Blender Hotkeys
12 pages
Windows Command Prompt Basics
No ratings yet
Windows Command Prompt Basics
5 pages
Blender 3D Basics Beginner's Guide: Second Edition
No ratings yet
Blender 3D Basics Beginner's Guide: Second Edition
34 pages
Unity Character Animation With Mecanim - Sample Chapter
No ratings yet
Unity Character Animation With Mecanim - Sample Chapter
29 pages
Blender
50% (2)
Blender
33 pages
Learning NGUI For Unity Sample Chapter
No ratings yet
Learning NGUI For Unity Sample Chapter
36 pages
Roblox Game Delelopment in 24 Hour
No ratings yet
Roblox Game Delelopment in 24 Hour
20 pages
Blender Shape Keys Animation Guide
No ratings yet
Blender Shape Keys Animation Guide
35 pages
All Maya Hotkeys
No ratings yet
All Maya Hotkeys
8 pages
Ten Steps To Linux Survival
100% (1)
Ten Steps To Linux Survival
74 pages
Software Engineering 2 Cheatsheet
No ratings yet
Software Engineering 2 Cheatsheet
12 pages
Blender Clothes Rigging Guide
No ratings yet
Blender Clothes Rigging Guide
4 pages
Blender Python Reference 2 59 2
No ratings yet
Blender Python Reference 2 59 2
1,440 pages
Blender Python Reference 2 57 Release
No ratings yet
Blender Python Reference 2 57 Release
1,306 pages
Blender 2.54 API Reference
No ratings yet
Blender 2.54 API Reference
1,250 pages
Blender Python Reference 2 61 0
No ratings yet
Blender Python Reference 2 61 0
1,528 pages
Blender 2.61.0 API Reference Guide
No ratings yet
Blender 2.61.0 API Reference Guide
1,518 pages
Font Design for Creators
0% (1)
Font Design for Creators
14 pages
Freeciv Game Guide
No ratings yet
Freeciv Game Guide
44 pages
Raymond Lull - The New Geometry
No ratings yet
Raymond Lull - The New Geometry
131 pages
Blender 3D - Noob To Pro - Miscellaneous Tutorials
No ratings yet
Blender 3D - Noob To Pro - Miscellaneous Tutorials
74 pages
Blender 3D - Noob To Pro - Advanced Tutorials
100% (1)
Blender 3D - Noob To Pro - Advanced Tutorials
82 pages
Euclid Elements
100% (8)
Euclid Elements
546 pages
Blender 3D Noob To Pro - Beginner Tutorials PDF
100% (2)
Blender 3D Noob To Pro - Beginner Tutorials PDF
140 pages
Programming Fundamentals in IT
No ratings yet
Programming Fundamentals in IT
6 pages
Overview of Programming Languages
No ratings yet
Overview of Programming Languages
22 pages
Java Programming Concepts Explained
No ratings yet
Java Programming Concepts Explained
28 pages
Java Program
No ratings yet
Java Program
367 pages
OS Lab - Week 6
No ratings yet
OS Lab - Week 6
31 pages
Python Programming Notes
No ratings yet
Python Programming Notes
144 pages
Intership Report Final VK
No ratings yet
Intership Report Final VK
39 pages
Class 9th Computer Notes
33% (6)
Class 9th Computer Notes
106 pages
JDK Jre JVM
No ratings yet
JDK Jre JVM
47 pages
Benefits of Programming Language Study
No ratings yet
Benefits of Programming Language Study
36 pages
Mado CSC 434 Sol Compil 2021
No ratings yet
Mado CSC 434 Sol Compil 2021
9 pages
SPOS Question Bank
No ratings yet
SPOS Question Bank
3 pages
Computer Architecture, Languages and Operating Systems: - Ramiro Advincula, LPT, MSIT
No ratings yet
Computer Architecture, Languages and Operating Systems: - Ramiro Advincula, LPT, MSIT
31 pages
Banking
100% (1)
Banking
52 pages
Cisco Notes
No ratings yet
Cisco Notes
8 pages
Python Programming Basics Guide
No ratings yet
Python Programming Basics Guide
19 pages
8051 Microcontroller Basics Guide
No ratings yet
8051 Microcontroller Basics Guide
12 pages
1.5 Computer Languages, Compiler, Interpreter & Assembler
No ratings yet
1.5 Computer Languages, Compiler, Interpreter & Assembler
15 pages
Exam Model Hansa
100% (1)
Exam Model Hansa
2 pages
PL - Unit 1
No ratings yet
PL - Unit 1
25 pages
25 Must Know Python IQ
No ratings yet
25 Must Know Python IQ
28 pages
Unit I Java Notes
No ratings yet
Unit I Java Notes
20 pages
01 C++ STL Strings
No ratings yet
01 C++ STL Strings
8 pages
Sumit Kumar Mishra Report
No ratings yet
Sumit Kumar Mishra Report
43 pages
Categories of Computer and Computer Languages Class 6
No ratings yet
Categories of Computer and Computer Languages Class 6
5 pages
Chapter 1-Introduction To JAVA
No ratings yet
Chapter 1-Introduction To JAVA
81 pages
Hardware Categories 4
No ratings yet
Hardware Categories 4
48 pages
Comparison of Compiler
No ratings yet
Comparison of Compiler
4 pages
CSC 222 New
No ratings yet
CSC 222 New
14 pages
Types of Computers Mainframes
No ratings yet
Types of Computers Mainframes
11 pages

Blender Python Reference 2 59 2

Uploaded by

Blender Python Reference 2 59 2

Uploaded by

Blender Index

Release 2.59.2 - API

September 15, 2011

Python Module Index Index

Blender Index, Release 2.59.2 - API

Blender Index, Release 2.59.2 - API

1.1.2 Before Starting

Blender Index, Release 2.59.2 - API

1.1.3 Key Concepts

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.59.2 - API

>>> [Link]["Scene"] [Link][Scene] >>> [Link]("MyMaterial") [Link][MyMaterial]

1.1. Quickstart Introduction

Blender Index, Release 2.59.2 - API

>>> [Link] >>> [Link].selected_objects >>> [Link].visible_bones

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.59.2 - API

def main(context): for ob in [Link]: print(ob)

def register(): [Link].register_class(SimpleOperator)

def unregister(): [Link].unregister_class(SimpleOperator)

if __name__ == "__main__": register() # test call [Link].simple_operator()

1.1. Quickstart Introduction

Blender Index, Release 2.59.2 - API

def register(): [Link].register_class(HelloWorldPanel)

def unregister(): [Link].unregister_class(HelloWorldPanel)

if __name__ == "__main__": register()

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.59.2 - API

blender enumerator (multiple) -> set of strings

1.1. Quickstart Introduction

Blender Index, Release 2.59.2 - API

Using Low-Level Functions:

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.59.2 - 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.59.2 - API

1.2.4 Integration through Classes

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.59.2 - API

1.2. Python API Overview

Blender Index, Release 2.59.2 - API

[Link].unregister_class(SimpleOperator) if __name__ == "__main__": register()

Operator.bl_idname expected a string

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.59.2 - API

def register(): [Link].register_module(__name__) def unregister(): [Link].unregister_module(__name__)

1.2. Python API Overview

Blender Index, Release 2.59.2 - API

...this is equivalent to:

Dynamic Dened-Classes (Advanced)

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.59.2 - API

1.3 Best Practice

1.3.1 Style Conventions

1.3. Best Practice

Blender Index, Release 2.59.2 - API

1.3.2 User Interface Layout

1.3.3 Script Efciency

1.4 Tips and Tricks

1.4.1 Use The Terminal

1.4.2 Show All Operators

1.4.3 Use an External Editor

Blender Index, Release 2.59.2 - API

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

1.4.4 Dont Use Blender!

1.4. Tips and Tricks

Blender Index, Release 2.59.2 - API

blender --background --python [Link]

1.4.5 Use External Tools

1.4.6 Bundled Python & Extensions

Chapter 1. Blender/Python Documentation

Blender Index, Release 2.59.2 - API

1.4.7 Drop Into a Python Interpreter in Youre Script

if name == "main": register() # test call [Link].simple_operator()

if name == "main": register()

[Link].unregister_class(SimpleOperator) if name == "main": register()

def register(): [Link].register_module(name) def unregister(): [Link].unregister_module(name)