Blender文档翻译-Blender库数据的通用属性

 Blender库数据的通用属性

引言

Blender现在支持在所有库数据中存储自定义数据（如对象、材料、纹理、几何体，如网格、曲线，元球，场景和更多）。现在渲染导出、游戏导出和需要它的任何脚本类型都可以将数据存储到.blend附加到库数据中。

称之为ID属性系统，因为所有的属性存储在所有库数据都有的唯一ID结构中。

它是如何工作的

属性由以下基本类型组成：

• Array:简单一维float或int型数组 a simple one-dimensional array of either floats or ints
• String: 字符串
• Group: 一组属性
• Float: 浮点数
• Int: 整数

另外，属性都有（明显地）一个名字。

标准

有一个专用的ID属性标准页在BlenderDev/PropertyStandards这里。请与其他作者一起工作形成自己脚本标准，这个想法是为了避免每个脚本都有一套独特的属性。

 Python教程

从python的角度看使用ID属性是很容易的。下面示例代码展示了它的简单性：

import Blender
from Blender import Material
mat = Material.Get("Material")
 
# get a property
try:
    TranslucencyFactor = mat.properties['SomeRenderer']['TransFac']
except:
    TranslucencyFactor = 0.0
    mat.properties['SomeRenderer']={}
    mat.properties['SomeRenderer']['TransFac'] = 0.0
 
# some more code to demonstrate how to make groups, arrays, etc.
mat.properties['a float array'] = [0.0, 1.0, 2.0]
mat.properties['a group'] = {"IntArray": [1, 2, 3], "AnotherGroup": {"int": 1}}
mat.properties['a string'] = "Sdfdsfsd"
mat.properties['a float'] = 0.0
mat.properties['an int'] = 0
 
# to get a properties type, use type()
if type(mat.properties['a float array']) is Blender.Types.IDArrayType:
    print "It's an array!"
if type(mat.properties['an int']) is int:
    print "It's an int!"
 
# iterate over a group
for property in mat.properties['a group']:
    print property
    print type(property)
 
theint = mat.properties['an int']
thestring = mat.properties['a string']

正如您所看到的，属性可以通过简单的python类型创建，比如int、float、dict和List。从属性中获取数据就像访问它的.data成员一样简单。

C API

ID属性的C API是在头文件原文source/Blender/makesdna/DNA_ID.h中原型化的。与使用pythonAPI相比，使用C API有很大不同；它的级别很低。最终会建立一种类似于XML的ID验证系统。现在，还只是低级别的函数。

下面是IDProperty结构和ID结构： （译者：以下代码摘自Blender2.8）

typedef struct IDPropertyData {
    void *pointer;
    ListBase group;
    int val, val2;  /* note, we actually fit a double into these two ints */
} IDPropertyData;

typedef struct IDProperty {
    struct IDProperty *next, *prev;
    char type, subtype;
    short flag;
    char name[64];  /* MAX_IDPROP_NAME */

    /* saved is used to indicate if this struct has been saved yet.
     * seemed like a good idea as a pad var was needed anyway :) */
    int saved;
    IDPropertyData data;  /* note, alignment for 64 bits */

    /* array length, also (this is important!) string length + 1.
     * the idea is to be able to reuse array realloc functions on strings.*/
    int len;

    /* Strings and arrays are both buffered, though the buffer isn't saved. */
    /* totallen is total length of allocated array/string, including a buffer.
     * Note that the buffering is mild; the code comes from python's list implementation. */
    int totallen;
} IDProperty;

typedef struct ID {
    void *next, *prev;
    struct ID *newid;
    struct Library *lib;
    char name[66]; /* MAX_ID_NAME */
    /**
     * LIB_... flags report on status of the datablock this ID belongs to (persistent, saved to and read from .blend).
     */
    short flag;
    /**
     * LIB_TAG_... tags (runtime only, cleared at read time).
     */
    int tag;
    int us;
    int icon_id;
    int recalc;
    int pad;
    IDProperty *properties;

    IDOverrideStatic *override_static;  /* Reference linked ID which this one overrides. */
    void *pad1;

    void *py_instance;
} ID;

由ID获取ID属性

由ID获取ID属性（具体说，是一个连接于ID的Group类型属性）用下面的函数：

 struct IDProperty *IDP_GetProperties(struct ID *id, int create_if_needed); 

 如果传入值为1的create_if_needed，将会自动创建并连接Group类型的IDProperty到ID，否则若ID中没有Group类型属性结构时将返回NULL。

创建一个ID属性

创建ID属性很容易；首先创建IDPropertyTemplate并设置适当的值。IDPropertyTemplate是一个联合体，这非常容易。若要设置float属性的数据，只需设置.f为浮点数；.i为整数；.str为字符串；数组的.array.len和.array.type(IDP_Float或IDP_int)；对于新建group属性什么都不需要。

一旦你创建了模板联合体，就可以将它与ID属性类型及其名称一起提供给IDP_New函数。下面是一个例子：

IDPropertyTemplate val;
IDProperty *group, *idgroup, *color;
group = IDP_New(IDP_GROUP, val, "group1"); //groups don't need a template.
 
val.array.len = 4
val.array.type = IDP_FLOAT;
color = IDP_New(IDP_ARRAY, val, "color1");
 
idgroup = IDP_GetProperties(some_id, 1);
IDP_AddToGroup(group, color);
IDP_AddToGroup(idgroup, group);

在组中查找ID属性

查找ID属性使用下面的函数：

 IDProperty *IDP_GetPropertyFromGroup(struct IDProperty *prop, char *name); 

下面这部分内容在Blender2.8版中已不存在了

迭代组中的ID属性

若要迭代组属性中的id属性，请分配一个void*指针，并使用此函数将其设置为迭代器：

 void *IDP_GetGroupIterator(struct IDProperty *prop); 

然后你可用下面函数迭代：

 void *IDP_GroupIterNext(void *vself); 

注意迭代器在迭代结束时自动释放，但如果停止迭代初期就可以释放它：

 void IDP_FreeIterBeforeEnd(void *vself); 

使用它的一个例子：

1 IDProperty *prop;
2 void *iter = IDP_GetGroupIterator(some_group);
3 for (prop=GroupIterNext(iter);prop;prop=GroupIterNext(iter)) {
4    . . .
5 }

原文（Blender官方文档）：https://wiki.blender.org/index.php/Dev:Source/Data_System/ID_Property，由于原文是基于Blender2.5的，译者结合2.8版代码作了修改。