Blender V5.3
idprop_create.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2021 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include <type_traits>
10
11#include "DNA_ID.h"
12
13#include "BKE_idprop.hh"
14
15namespace blender::bke::idprop {
16
17/* -------------------------------------------------------------------- */
20
21std::unique_ptr<IDProperty, IDPropertyDeleter> create(const StringRef prop_name,
22 int32_t value,
23 const eIDPropertyFlag flags)
24{
25 IDPropertyTemplate prop_template{0};
26 prop_template.i = value;
27 IDProperty *property = IDP_New(IDP_INT, &prop_template, prop_name, flags);
28 return std::unique_ptr<IDProperty, IDPropertyDeleter>(property);
29}
30
31std::unique_ptr<IDProperty, IDPropertyDeleter> create_bool(const StringRef prop_name,
32 bool value,
33 const eIDPropertyFlag flags)
34{
35 IDPropertyTemplate prop_template{0};
36 prop_template.i = value;
37 IDProperty *property = IDP_New(IDP_BOOLEAN, &prop_template, prop_name, flags);
38 return std::unique_ptr<IDProperty, IDPropertyDeleter>(property);
39}
40
41std::unique_ptr<IDProperty, IDPropertyDeleter> create(const StringRef prop_name,
42 float value,
43 const eIDPropertyFlag flags)
44{
45 IDPropertyTemplate prop_template{0};
46 prop_template.f = value;
47 IDProperty *property = IDP_New(IDP_FLOAT, &prop_template, prop_name, flags);
48 return std::unique_ptr<IDProperty, IDPropertyDeleter>(property);
49}
50
51std::unique_ptr<IDProperty, IDPropertyDeleter> create(const StringRef prop_name,
52 double value,
53 const eIDPropertyFlag flags)
54{
55 IDPropertyTemplate prop_template{0};
56 prop_template.d = value;
57 IDProperty *property = IDP_New(IDP_DOUBLE, &prop_template, prop_name, flags);
58 return std::unique_ptr<IDProperty, IDPropertyDeleter>(property);
59}
60
61std::unique_ptr<IDProperty, IDPropertyDeleter> create(const StringRef prop_name,
62 const StringRefNull value,
63 const eIDPropertyFlag flags)
64{
65 IDProperty *property = IDP_NewString(value.c_str(), prop_name, flags);
66 return std::unique_ptr<IDProperty, IDPropertyDeleter>(property);
67}
68
69std::unique_ptr<IDProperty, IDPropertyDeleter> create(const StringRef prop_name,
70 ID *value,
71 const eIDPropertyFlag flags)
72{
73 /* Do not assign embedded IDs to IDProperties. */
74 BLI_assert(!value || (value->flag & ID_FLAG_EMBEDDED_DATA) == 0);
75
76 IDPropertyTemplate prop_template{0};
77 prop_template.id = value;
78 IDProperty *property = IDP_New(IDP_ID, &prop_template, prop_name, flags);
79 return std::unique_ptr<IDProperty, IDPropertyDeleter>(property);
80}
81
82static std::unique_ptr<IDProperty, IDPropertyDeleter> array_create(const StringRef prop_name,
83 eIDPropertyType subtype,
84 size_t array_len,
85 const eIDPropertyFlag flags)
86{
87 IDPropertyTemplate prop_template{0};
88 prop_template.array.len = array_len;
89 prop_template.array.type = subtype;
90 IDProperty *property = IDP_New(IDP_ARRAY, &prop_template, prop_name, flags);
91 return std::unique_ptr<IDProperty, IDPropertyDeleter>(property);
92}
93
94static void array_values_set(IDProperty *property,
95 const void *values,
96 size_t values_len,
97 size_t value_size)
98{
99 BLI_assert(values);
100 BLI_assert(property->len == values_len);
101 memcpy(IDP_array_voidp_get(property), values, values_len * value_size);
102}
103
107template<
109 typename PrimitiveType,
111 eIDPropertyType id_property_subtype>
112std::unique_ptr<IDProperty, IDPropertyDeleter> create_array(StringRef prop_name,
113 Span<PrimitiveType> values,
114 const eIDPropertyFlag flags)
115{
117 "Allowed values for PrimitiveType are int32_t, float and double.");
118 static_assert(!std::is_same_v<PrimitiveType, int32_t> || id_property_subtype == IDP_INT,
119 "PrimitiveType and id_property_type do not match (int32_t).");
120 static_assert(!std::is_same_v<PrimitiveType, float> || id_property_subtype == IDP_FLOAT,
121 "PrimitiveType and id_property_type do not match (float).");
122 static_assert(!std::is_same_v<PrimitiveType, double> || id_property_subtype == IDP_DOUBLE,
123 "PrimitiveType and id_property_type do not match (double).");
124
125 const int64_t values_len = values.size();
126 BLI_assert(values_len > 0);
127 std::unique_ptr<IDProperty, IDPropertyDeleter> property = array_create(
128 prop_name, id_property_subtype, values_len, flags);
130 property.get(), static_cast<const void *>(values.data()), values_len, sizeof(PrimitiveType));
131 return property;
132}
133
134std::unique_ptr<IDProperty, IDPropertyDeleter> create(const StringRef prop_name,
135 Span<int32_t> values,
136 const eIDPropertyFlag flags)
137{
138 return create_array<int32_t, IDP_INT>(prop_name, values, flags);
139}
140
141std::unique_ptr<IDProperty, IDPropertyDeleter> create(const StringRef prop_name,
142 Span<float> values,
143 const eIDPropertyFlag flags)
144{
145 return create_array<float, IDP_FLOAT>(prop_name, values, flags);
146}
147
148std::unique_ptr<IDProperty, IDPropertyDeleter> create(const StringRef prop_name,
149 Span<double> values,
150 const eIDPropertyFlag flags)
151{
152 return create_array<double, IDP_DOUBLE>(prop_name, values, flags);
153}
154
155std::unique_ptr<IDProperty, IDPropertyDeleter> create_group(const StringRef prop_name,
156 const eIDPropertyFlag flags)
157{
158 IDPropertyTemplate prop_template{0};
159 IDProperty *property = IDP_New(IDP_GROUP, &prop_template, prop_name, flags);
160 return std::unique_ptr<IDProperty, IDPropertyDeleter>(property);
161}
162
164
165} // namespace blender::bke::idprop
#define IDP_array_voidp_get(prop)
ID and Library types, which are fundamental for SDNA.
constexpr const T * data() const
Definition BLI_span.hh:219
constexpr int64_t size() const
Definition BLI_span.hh:256
constexpr const char * c_str() const
PrimitiveType
std::unique_ptr< IDProperty, IDPropertyDeleter > create_array(StringRef prop_name, Span< PrimitiveType > values, const eIDPropertyFlag flags)
std::unique_ptr< IDProperty, IDPropertyDeleter > create_bool(StringRef prop_name, bool value, eIDPropertyFlag flags={})
Allocate a new IDProperty of type IDP_BOOLEAN, set its name and value.
static void array_values_set(IDProperty *property, const void *values, size_t values_len, size_t value_size)
std::unique_ptr< IDProperty, IDPropertyDeleter > create(StringRef prop_name, int32_t value, eIDPropertyFlag flags={})
Allocate a new IDProperty of type IDP_INT, set its name and value.
static std::unique_ptr< IDProperty, IDPropertyDeleter > array_create(const StringRef prop_name, eIDPropertyType subtype, size_t array_len, const eIDPropertyFlag flags)
std::unique_ptr< IDProperty, IDPropertyDeleter > create_group(StringRef prop_name, eIDPropertyFlag flags={})
Allocate a new IDProperty of type IDP_GROUP.
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
__int64 int64_t
Definition BKE_text.h:90
constexpr bool is_same_any_v
IDProperty * IDP_NewString(const char *st, StringRef name, eIDPropertyFlag flags={}) ATTR_WARN_UNUSED_RESULT
Definition idprop.cc:443
signed int int32_t
Definition BKE_text.h:78
IDProperty * IDP_New(char type, const IDPropertyTemplate *val, StringRef name, eIDPropertyFlag flags={}) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
Definition idprop.cc:1132
@ ID_FLAG_EMBEDDED_DATA
Definition DNA_ID.h:775
short flag
Definition DNA_ID.h:439
struct blender::IDPropertyTemplate::@100215251242210352227251277016155305041022127377 array