Blender V5.3
NOD_rna_define.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 <optional>
12
13#include "BLI_function_ref.hh"
14
15#include "DNA_node_types.h"
16
17#include "RNA_define.hh"
18
19#include "WM_types.hh" /* For notifier defines */
20
21namespace blender {
22
23void rna_Node_update(Main *bmain, Scene *scene, PointerRNA *ptr);
24void rna_Node_socket_update(Main *bmain, Scene *scene, PointerRNA *ptr);
28 const bNodeTree *ntree, const eNodeSocketDatatype socket_type, bool *r_free);
29
30namespace nodes {
31
41
46#define NOD_inline_enum_accessors(member) \
47 EnumRNAAccessors( \
48 [](PointerRNA *ptr, PropertyRNA * /*prop*/) -> int { \
49 const bNode &node = *static_cast<const bNode *>(ptr->data); \
50 return node.member; \
51 }, \
52 [](PointerRNA *ptr, PropertyRNA * /*prop*/, const int value) { \
53 bNode &node = *static_cast<bNode *>(ptr->data); \
54 node.member = static_cast<std::remove_reference_t<decltype(node.member)>>(value); \
55 })
56
61#define NOD_storage_enum_accessors(member) \
62 EnumRNAAccessors( \
63 [](PointerRNA *ptr, PropertyRNA * /*prop*/) -> int { \
64 const bNode &node = *static_cast<const bNode *>(ptr->data); \
65 return int(node_storage(node).member); \
66 }, \
67 [](PointerRNA *ptr, PropertyRNA * /*prop*/, const int value) { \
68 bNode &node = *static_cast<bNode *>(ptr->data); \
69 node_storage(node).member = \
70 static_cast<std::remove_reference_t<decltype(node_storage(node).member)>>(value); \
71 })
72
82
87#define NOD_inline_boolean_accessors(member, flag) \
88 BooleanRNAAccessors( \
89 [](PointerRNA *ptr, PropertyRNA * /*prop*/) -> bool { \
90 const bNode &node = *static_cast<const bNode *>(ptr->data); \
91 return node.member & (flag); \
92 }, \
93 [](PointerRNA *ptr, PropertyRNA * /*prop*/, const bool value) { \
94 bNode &node = *static_cast<bNode *>(ptr->data); \
95 SET_FLAG_FROM_TEST(node.member, value, (flag)); \
96 })
97
102#define NOD_storage_boolean_accessors(member, flag) \
103 BooleanRNAAccessors( \
104 [](PointerRNA *ptr, PropertyRNA * /*prop*/) -> bool { \
105 const bNode &node = *static_cast<const bNode *>(ptr->data); \
106 return node_storage(node).member & (flag); \
107 }, \
108 [](PointerRNA *ptr, PropertyRNA * /*prop*/, const bool value) { \
109 bNode &node = *static_cast<bNode *>(ptr->data); \
110 SET_FLAG_FROM_TEST(node_storage(node).member, value, (flag)); \
111 })
112
113const EnumPropertyItem *enum_items_filter(const EnumPropertyItem *original_item_array,
114 FunctionRef<bool(const EnumPropertyItem &item)> fn);
115
116PropertyRNA *RNA_def_node_enum(StructRNA *srna,
117 const char *identifier,
118 const char *ui_name,
119 const char *ui_description,
120 const EnumPropertyItem *static_items,
121 const EnumRNAAccessors accessors,
122 std::optional<int> default_value = std::nullopt,
123 const EnumPropertyItemFunc item_func = nullptr,
124 bool allow_animation = false);
125
126PropertyRNA *RNA_def_node_boolean(StructRNA *srna,
127 const char *identifier,
128 const char *ui_name,
129 const char *ui_description,
130 const BooleanRNAAccessors accessors,
131 std::optional<bool> default_value = std::nullopt,
132 bool allow_animation = false);
133
134} // namespace nodes
135} // namespace blender
PropertyRNA * RNA_def_node_enum(StructRNA *srna, const char *identifier, const char *ui_name, const char *ui_description, const EnumPropertyItem *static_items, const EnumRNAAccessors accessors, std::optional< int > default_value, const EnumPropertyItemFunc item_func, const bool allow_animation)
PropertyRNA * RNA_def_node_boolean(StructRNA *srna, const char *identifier, const char *ui_name, const char *ui_description, const BooleanRNAAccessors accessors, std::optional< bool > default_value, bool allow_animation)
const EnumPropertyItem * enum_items_filter(const EnumPropertyItem *original_item_array, FunctionRef< bool(const EnumPropertyItem &item)> fn)
BMesh Iterators.
void rna_Node_Viewer_shortcut_node_set(PointerRNA *ptr, PropertyRNA *prop, int value)
void(*)(PointerRNA *ptr, PropertyRNA *prop, int value) EnumPropertySetFunc
Definition RNA_types.hh:913
const EnumPropertyItem * rna_NodeSocket_structure_type_item_filter(const bNodeTree *ntree, const eNodeSocketDatatype socket_type, bool *r_free)
int(*)(PointerRNA *ptr, PropertyRNA *prop) EnumPropertyGetFunc
Definition RNA_types.hh:912
void(*)(PointerRNA *ptr, PropertyRNA *prop, bool value) BooleanPropertySetFunc
Definition RNA_types.hh:775
void rna_Node_socket_update(Main *bmain, Scene *scene, PointerRNA *ptr)
void rna_Node_update_relations(Main *bmain, Scene *scne, PointerRNA *ptr)
bool(*)(PointerRNA *ptr, PropertyRNA *prop) BooleanPropertyGetFunc
Definition RNA_types.hh:774
const EnumPropertyItem *(*)(bContext *C, PointerRNA *ptr, PropertyRNA *prop, bool *r_free) EnumPropertyItemFunc
Definition RNA_types.hh:921
void rna_Node_update(Main *bmain, Scene *scene, PointerRNA *ptr)
BooleanRNAAccessors(BooleanPropertyGetFunc getter, BooleanPropertySetFunc setter)
EnumRNAAccessors(EnumPropertyGetFunc getter, EnumPropertySetFunc setter)