Blender V5.3
idprop_py_api.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include <Python.h>
12
13namespace blender {
14
15struct BPy_IDGroup_Iter;
16struct ID;
17struct IDProperty;
18
19extern PyTypeObject BPy_IDArray_Type;
20extern PyTypeObject BPy_IDGroup_Type;
21
22extern PyTypeObject BPy_IDGroup_ViewKeys_Type;
23extern PyTypeObject BPy_IDGroup_ViewValues_Type;
24extern PyTypeObject BPy_IDGroup_ViewItems_Type;
25
26extern PyTypeObject BPy_IDGroup_IterKeys_Type;
27extern PyTypeObject BPy_IDGroup_IterValues_Type;
28extern PyTypeObject BPy_IDGroup_IterItems_Type;
29
30#define BPy_IDArray_Check(v) (PyObject_TypeCheck(v, &BPy_IDArray_Type))
31#define BPy_IDArray_CheckExact(v) (Py_TYPE(v) == &BPy_IDArray_Type)
32#define BPy_IDGroup_Check(v) (PyObject_TypeCheck(v, &BPy_IDGroup_Type))
33#define BPy_IDGroup_CheckExact(v) (Py_TYPE(v) == &BPy_IDGroup_Type)
34
35#define BPy_IDGroup_ViewKeys_Check(v) (PyObject_TypeCheck(v, &BPy_IDGroup_ViewKeys_Type))
36#define BPy_IDGroup_ViewKeys_CheckExact(v) (Py_TYPE(v) == &BPy_IDGroup_ViewKeys_Type)
37#define BPy_IDGroup_ViewValues_Check(v) (PyObject_TypeCheck(v, &BPy_IDGroup_ViewValues_Type))
38#define BPy_IDGroup_ViewValues_CheckExact(v) (Py_TYPE(v) == &BPy_IDGroup_ViewValues_Type)
39#define BPy_IDGroup_ViewItems_Check(v) (PyObject_TypeCheck(v, &BPy_IDGroup_ViewItems_Type))
40#define BPy_IDGroup_ViewItems_CheckExact(v) (Py_TYPE(v) == &BPy_IDGroup_ViewItems_Type)
41
42#define BPy_IDGroup_IterKeys_Check(v) (PyObject_TypeCheck(v, &BPy_IDGroup_IterKeys_Type))
43#define BPy_IDGroup_IterKeys_CheckExact(v) (Py_TYPE(v) == &BPy_IDGroup_IterKeys_Type)
44#define BPy_IDGroup_IterValues_Check(v) (PyObject_TypeCheck(v, &BPy_IDGroup_IterValues_Type))
45#define BPy_IDGroup_IterValues_CheckExact(v) (Py_TYPE(v) == &BPy_IDGroup_IterValues_Type)
46#define BPy_IDGroup_IterItems_Check(v) (PyObject_TypeCheck(v, &BPy_IDGroup_IterItems_Type))
47#define BPy_IDGroup_IterItems_CheckExact(v) (Py_TYPE(v) == &BPy_IDGroup_IterItems_Type)
48
50 PyObject_HEAD
51 struct ID *owner_id; /* can be NULL */
52 struct IDProperty *prop; /* must be second member */
54};
55
57 PyObject_HEAD
58 struct ID *owner_id; /* can be NULL */
59 struct IDProperty *prop; /* must be second member */
60};
61
63 PyObject_HEAD
65 struct IDProperty *cur;
70};
71
74 PyObject_HEAD
78};
79
80[[nodiscard]] PyObject *BPy_Wrap_GetKeys(IDProperty *prop);
81[[nodiscard]] PyObject *BPy_Wrap_GetValues(ID *id, IDProperty *prop);
82[[nodiscard]] PyObject *BPy_Wrap_GetItems(ID *id, IDProperty *prop);
83
84[[nodiscard]] PyObject *BPy_Wrap_GetKeys_View_WithID(ID *id, IDProperty *prop);
85[[nodiscard]] PyObject *BPy_Wrap_GetValues_View_WithID(ID *id, IDProperty *prop);
86[[nodiscard]] PyObject *BPy_Wrap_GetItems_View_WithID(ID *id, IDProperty *prop);
87
88[[nodiscard]] int BPy_Wrap_SetMapItem(IDProperty *prop, PyObject *key, PyObject *val);
89
93[[nodiscard]] PyObject *BPy_IDGroup_MapDataToPy(IDProperty *prop);
94[[nodiscard]] PyObject *BPy_IDGroup_WrapData(ID *id, IDProperty *prop, IDProperty *parent);
101[[nodiscard]] bool BPy_IDProperty_Map_ValidateAndCreate(PyObject *key,
102 IDProperty *group,
103 PyObject *ob);
104void IDProp_Init_Types();
105
106[[nodiscard]] PyObject *BPyInit_idprop();
107
123 IDProperty *prop_exist, const char *name, PyObject *ob, bool do_conversion, bool can_create);
124
125} // namespace blender
BMesh Iterators.
bool BPy_IDProperty_Map_ValidateAndCreate(PyObject *key, IDProperty *group, PyObject *ob)
PyObject * BPyInit_idprop()
void IDProp_Init_Types()
PyTypeObject BPy_IDGroup_IterValues_Type
PyObject * BPy_IDGroup_MapDataToPy(IDProperty *prop)
PyTypeObject BPy_IDArray_Type
PyObject * BPy_Wrap_GetItems_View_WithID(ID *id, IDProperty *prop)
PyTypeObject BPy_IDGroup_ViewValues_Type
PyObject * BPy_Wrap_GetKeys_View_WithID(ID *id, IDProperty *prop)
PyTypeObject BPy_IDGroup_IterItems_Type
PyObject * BPy_Wrap_GetItems(ID *id, IDProperty *prop)
PyObject * BPy_Wrap_GetKeys(IDProperty *prop)
PyTypeObject BPy_IDGroup_IterKeys_Type
PyTypeObject BPy_IDGroup_Type
PyObject * BPy_IDGroup_WrapData(ID *id, IDProperty *prop, IDProperty *parent)
PyObject * BPy_Wrap_GetValues_View_WithID(ID *id, IDProperty *prop)
PyTypeObject BPy_IDGroup_ViewItems_Type
IDProperty * BPy_IDProperty_FromPyObject(IDProperty *prop_exist, const char *name, PyObject *ob, const bool do_conversion, const bool can_create)
PyObject * BPy_Wrap_GetValues(ID *id, IDProperty *prop)
PyTypeObject BPy_IDGroup_ViewKeys_Type
int BPy_Wrap_SetMapItem(IDProperty *prop, PyObject *key, PyObject *val)
struct IDProperty * prop
PyObject_HEAD struct ID * owner_id
PyObject_HEAD BPy_IDProperty * group
struct IDProperty * cur
PyObject_HEAD BPy_IDProperty * group
struct IDProperty * parent
struct IDProperty * prop
PyObject_HEAD struct ID * owner_id