Blender 2.59.2 Python API详解与最佳实践

4星 · 超过85%的资源需积分: 50 78 浏览量更新于2024-07-30 1 收藏 3.25MB PDF 举报

Blender Python API 2.59.2 是Blender Foundation于2011年9月10日发布的官方文档，旨在提供详细的编程接口指导，让开发者能够更有效地利用Blender的强大功能进行扩展和自动化工作流程。该文档分为五个主要部分： 1. **Blender/Python Documentation**: 这部分是入门指南，包括快速启动介绍，帮助新用户了解如何通过Python与Blender交互。它概述了API的主要概念，以便用户能快速上手。 - **Quickstart Introduction**：提供了一个简短的教程，介绍了如何在Blender环境中启用和编写Python脚本。 - **Python API Overview**：详细解释了API的整体结构和组成部分，包括数据访问、操作员、类型定义等。 2. **Application Modules**: 这部分着重于各个应用模块，涵盖了核心的Blender对象操作和管理，如场景上下文（bpy.context）、数据结构（bpy.data）、操作执行（bpy.ops）、内置类型（bpy.types）以及实用工具函数（bpy.utils、bpy.path 和 bpy.app）。 - **Context Access (bpy.context)**：允许开发者根据当前工作环境（如场景、对象或视图）执行特定操作。 - **Data Access (bpy.data)**：提供了对Blender内置数据类型（如材质、纹理、形状键等）的访问和管理。 - **Operators (bpy.ops)**：涉及直接执行Blender内部操作，如变换、渲染或导入导出。 - **Types (bpy.types)**：定义了Blender对象的类型，如Mesh、Material、Camera等。 - **Utilities (bpy.utils)**：包含各种辅助函数，用于简化常见任务，如文件系统操作、字符串处理等。 3. **Standalone Modules**: 包含非Blender特定的模块，如数学工具（mathutils）、几何操作（mathutils.geometry）、OpenGL渲染接口（bgl）、字体绘制（blf）、音频系统（aud），以及额外的扩展工具（bpy_extras）。 4. **Game Engine Modules**: 如果你正在开发游戏相关的插件或扩展，这部分非常重要。它涵盖了游戏类型定义（bge.types）、逻辑引擎（bge.logic）、渲染器（bge.render）、纹理处理（bge.texture）、事件处理（bge.events）和物理约束（bge.constraints）。 5. **API Info**: 提供API的变更历史，帮助开发者跟踪新版本的功能增删以及可能的影响，确保代码兼容性。 Blender Python API 2.59.2文档是开发人员的宝贵资源，它为构建扩展、脚本和交互式工具提供了全面的基础。无论是对Blender的初学者还是高级开发者，这个文档都是学习和利用Blender功能的强大工具。通过深入理解这些模块和其提供的功能，你可以定制Blender以满足你的独特需求。

Blender Index, Release 2.59.2 - API

• copy into one of the directories scripts/startup, where they will be automatically imported on startup.

• deﬁne 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 you’ll want to extend blender to make tools accessible

like other built-in functionality.

The blender python api allows integration for:

• bpy.types.Panel

• bpy.types.Menu

• bpy.types.Operator

• bpy.types.PropertyGroup

• bpy.types.KeyingSet

• bpy.types.RenderEngine

This is intentionally limited. Currently, for more advanced features such as mesh modiﬁers, object types, or shader

nodes, C/C++ must be used.

For python intergration Blender deﬁnes methods which are common to all types. This works by creating a python

subclass of a Blender class which contains variables and functions speciﬁed by the parent class which are pre-deﬁned

to interface with Blender.

For example:

import bpy

class SimpleOperator(bpy.types.Operator):

bl_idname = "object.simple_operator"

bl_label = "Tool Name"

def execute(self, context):

print("Hello World")

return {’FINISHED’}

bpy.utils.register_class(SimpleOperator)

First note that we subclass a member of bpy.types, this is common for all classes which can be integrated with

blender and used so we know if this is an Operator and not a Panel when registering.

Both class properties start with a bl_ preﬁx. This is a convention used to distinguish blender properties from those you

add yourself.

12 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 preﬁx 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 doesn’t impose restrictions on the kinds of class inheritance used, the registration

checks will use attributes and functions deﬁned in parent classes.

class mix-in example:

import bpy

class BaseOperator:

def execute(self, context):

print("Hello World BaseClass")

return {’FINISHED’}

class SimpleOperator(bpy.types.Operator, BaseOperator):

bl_idname = "object.simple_operator"

bl_label = "Tool Name"

bpy.utils.register_class(SimpleOperator)

Notice these classes don’t deﬁne an __init__(self) function. While __init__() and __del__() will be

called if deﬁned, 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 API’s.

To run operators you can call them through the operator api, eg:

import bpy

bpy.ops.object.simple_operator()

User interface classes are given a context in which to draw, buttons window, ﬁle header, toolbar etc, then they are

drawn when that area is displayed so they are never called by python scripts directly.

1.2.5 Registration

Module Registration

Blender modules loaded at startup require register() and unregister() functions. These are the only func-

tions that blender calls from your code, which is otherwise a regular python module.

A simple blender/python module can look like this:

import bpy

class SimpleOperator(bpy.types.Operator):

""" See example above """

def register():

bpy.utils.register_class(SimpleOperator)

def unregister():

1.2. Python API Overview 13

Blender Index, Release 2.59.2 - API

bpy.utils.unregister_class(SimpleOperator)

if __name__ == "__main__":

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 won’t re-run

when a new blend ﬁle is loaded.

The register/unregister calls are used so it’s possible to toggle addons and reload scripts while blender runs. If the

distinction between importing a module or loading its classes into blender.

This becomes problematic when a script imports classes from another module making it difﬁcult to manage which

classes are being loaded and when.

The last 2 lines are only for testing:

if __name__ == "__main__":

This allows the script to be run directly in the text editor to test changes. This register() call won’t 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 deﬁnition being loaded into blender, where it becomes available

alongside existing functionality.

Once this class is loaded you can access it from bpy.types, using the bl_idname rather than the classes original

name.

When loading a class, blender performs sanity checks making sure all required properties and functions are found, that

properties have the correct type, and that functions have the right number of arguments.

Mostly you will not need concern yourself with this but if there is a problem with the class deﬁnition 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: Operator.bl_idname expected a string

type, not int

Multiple-Classes

Loading classes into blender is described above, for simple cases calling bpy.utils.register_class (Some-

Class) is sufﬁcient, but when there are many classes or a packages submodule has its own classes it can be tedious to

list them all for registration.

For more convenient loading/unloading bpy.utils.register_module (module) and

bpy.utils.unregister_module (module) functions exist.

A script which deﬁnes many of its own operators, panels menus etc. you only need to write:

14 Chapter 1. Blender/Python Documentation

剩余1445页未读，继续阅读

Spiritring

粉丝: 155
资源: 39

Blender 2.59.2 Python API详解与最佳实践

Blender中文手册入门版（公开预览版）.pdf

The Blender Python API epub

bpy：Blender python脚本

blender python api

The Blender Python API.pdf

EasyBPY:简化Blender Python API使用的模块

fake-bpy-module:Fake Blender Python API模块集合以完成代码

Blender Python API 指南：建模与应用模块详解

blender python api官方文档

怎么使用Blender Python API导入背景图像

最新资源