Blender V5.3
blenkernel/intern/curves.cc
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#include <cstring>
10#include <optional>
11
12#include "MEM_guardedalloc.h"
13
14#include "DNA_curves_types.h"
15#include "DNA_material_types.h"
16#include "DNA_object_types.h"
17
18#include "BLI_index_range.hh"
19#include "BLI_math_matrix.hh"
20#include "BLI_rand.hh"
21#include "BLI_resource_scope.hh"
22#include "BLI_span.hh"
23#include "BLI_string.hh"
24#include "BLI_utildefines.hh"
25#include "BLI_vector.hh"
26
27#include "BKE_anim_data.hh"
29#include "BKE_curves.hh"
30#include "BKE_customdata.hh"
32#include "BKE_geometry_set.hh"
33#include "BKE_idtype.hh"
34#include "BKE_lib_id.hh"
35#include "BKE_lib_query.hh"
36#include "BKE_material.hh"
37#include "BKE_modifier.hh"
38#include "BKE_object.hh"
39#include "BKE_object_types.hh"
40
41#include "BLT_translation.hh"
42
44
45#include "BLO_read_write.hh"
46
48
49namespace blender {
50
51static const char *ATTR_POSITION = "position";
52
53static void curves_init_data(ID *id)
54{
55 Curves *curves = id_cast<Curves *>(id);
57
58 new (&curves->geometry) bke::CurvesGeometry();
59}
60
61static void curves_copy_data(Main * /*bmain*/,
62 std::optional<Library *> /*owner_library*/,
63 ID *id_dst,
64 const ID *id_src,
65 const int /*flag*/)
66{
67 Curves *curves_dst = id_cast<Curves *>(id_dst);
68 const Curves *curves_src = id_cast<const Curves *>(id_src);
69 curves_dst->mat = MEM_dupalloc(curves_src->mat);
70
71 new (&curves_dst->geometry) bke::CurvesGeometry(curves_src->geometry.wrap());
72
73 if (curves_src->surface_uv_map != nullptr) {
74 curves_dst->surface_uv_map = BLI_strdup(curves_src->surface_uv_map);
75 }
76
77 curves_dst->batch_cache = nullptr;
78}
79
80static void curves_free_data(ID *id)
81{
82 Curves *curves = id_cast<Curves *>(id);
83 BKE_animdata_free(&curves->id, false);
84
85 curves->geometry.wrap().~CurvesGeometry();
86
88
89 MEM_SAFE_DELETE(curves->mat);
90 MEM_SAFE_DELETE(curves->surface_uv_map);
91}
92
94{
95 Curves *curves = id_cast<Curves *>(id);
96 for (int i = 0; i < curves->totcol; i++) {
98 }
100}
101
104{
105 Curves *curves = reinterpret_cast<Curves *>(id);
106 curves->geometry.wrap().attribute_storage.wrap().foreach_working_space_color(fn);
107}
108
109static void curves_blend_write(BlendWriter *writer, ID *id, const void *id_address)
110{
111 Curves *curves = id_cast<Curves *>(id);
112
113 /* Only for forward compatibility. */
114 curves->attributes_active_index_legacy = curves->geometry.attributes_active_index;
115
116 ResourceScope scope;
117 bke::CurvesGeometry::BlendWriteData write_data(writer, scope);
118 curves->geometry.wrap().blend_write_prepare(write_data, !writer->is_undo());
119
120 /* Write LibData */
121 writer->write_id_struct(id_address, curves, [](BlendStructWriter<Curves> &struct_writer) {
122 struct_writer.generated_ptr(offsetof(Curves, geometry.attribute_storage.dna_attributes));
123 });
124 BKE_id_blend_write(writer, &curves->id);
125
126 /* Direct data */
127 curves->geometry.wrap().blend_write(*writer, curves->id, write_data);
128
129 writer->write_string(curves->surface_uv_map);
130
131 writer->write_pointer_array(curves->totcol, curves->mat);
132}
133
135{
136 Curves *curves = id_cast<Curves *>(id);
137
138 /* Geometry */
139 curves->geometry.wrap().blend_read(*reader);
140
141 BLO_read_string(reader, &curves->surface_uv_map);
142
143 /* Materials */
145}
146
148 .id_code = Curves::id_type,
149 .id_filter = FILTER_ID_CV,
150 .dependencies_id_types = FILTER_ID_MA | FILTER_ID_OB,
151 .main_listbase_index = INDEX_ID_CV,
152 .struct_size = sizeof(Curves),
153 .name = "Curves",
154 .name_plural = N_("hair_curves"),
155 .translation_context = BLT_I18NCONTEXT_ID_CURVES,
157 .asset_type_info = nullptr,
158
159 .init_data = curves_init_data,
160 .copy_data = curves_copy_data,
161 .free_data = curves_free_data,
162 .make_local = nullptr,
163 .foreach_id = curves_foreach_id,
164 .foreach_cache = nullptr,
165 .foreach_path = nullptr,
166 .foreach_working_space_color = curves_foreach_working_space_color,
167 .foreach_asset_weak_reference = nullptr,
168 .owner_pointer_get = nullptr,
169
170 .blend_write = curves_blend_write,
171 .blend_read_data = curves_blend_read_data,
172 .blend_read_after_liblink = nullptr,
173
174 .blend_read_undo_preserve = nullptr,
175
176 .lib_override_apply_post = nullptr,
177};
178
179Curves *BKE_curves_add(Main *bmain, const char *name)
180{
181 Curves *curves = BKE_id_new<Curves>(bmain, name);
182
183 return curves;
184}
185
186bool BKE_curves_attribute_required(const Curves * /*curves*/, const StringRef name)
187{
188 return name == ATTR_POSITION;
189}
190
191void BKE_curves_material_remap(Curves *curves_id, const uint *remap, const int remap_num)
192{
194 curves_id->geometry.wrap().attributes_for_write(), remap, remap_num);
195}
196
198{
199 return reinterpret_cast<Curves *>(
200 BKE_id_copy_ex(nullptr, &curves_src->id, nullptr, LIB_ID_COPY_LOCALIZE));
201}
202
203static void curves_evaluate_modifiers(Depsgraph *depsgraph,
204 Scene *scene,
205 Object *object,
206 bke::GeometrySet &geometry_set)
207{
208 /* Modifier evaluation modes. */
209 const bool use_render = (DEG_get_mode(depsgraph) == DAG_EVAL_RENDER);
210 int required_mode = use_render ? eModifierMode_Render : eModifierMode_Realtime;
211 if (BKE_object_is_in_editmode(object)) {
212 required_mode = ModifierMode(required_mode | eModifierMode_Editmode);
213 }
214 ModifierApplyFlag apply_flag = use_render ? MOD_APPLY_RENDER : MOD_APPLY_USECACHE;
215 const ModifierEvalContext mectx = {depsgraph, object, apply_flag};
216
218
219 /* Get effective list of modifiers to execute. Some effects like shape keys
220 * are added as virtual modifiers before the user created modifiers. */
221 VirtualModifierData virtual_modifier_data;
222 ModifierData *md = BKE_modifiers_get_virtual_modifierlist(object, &virtual_modifier_data);
223
224 /* Evaluate modifiers. */
225 for (; md; md = md->next) {
227
228 if (!BKE_modifier_is_enabled(scene, md, required_mode)) {
229 continue;
230 }
231
232 bke::ScopedModifierTimer modifier_timer{*md};
233
234 if (mti->modify_geometry_set != nullptr) {
235 mti->modify_geometry_set(md, &mectx, &geometry_set);
236 }
237 }
238}
239
240void BKE_curves_data_update(Depsgraph *depsgraph, Scene *scene, Object *object)
241{
242 using namespace blender::bke;
243 /* Free any evaluated data and restore original data. */
245
246 /* Evaluate modifiers. */
247 Curves *curves = id_cast<Curves *>(object->data);
250 /* Try to propagate deformation data through modifier evaluation, so that sculpt mode can work
251 * on evaluated curves. */
252 GeometryComponentEditData &edit_component =
254 edit_component.curves_edit_hints_ = std::make_unique<CurvesEditHints>(
255 *id_cast<const Curves *>(DEG_get_original(object)->data));
256 }
257 bke::curves_store_surface_in_geometry_bundle(*depsgraph, *curves, geometry_set);
258 curves_evaluate_modifiers(depsgraph, scene, object, geometry_set);
259
260 /* Assign evaluated object. */
261 Curves *curves_eval = const_cast<Curves *>(geometry_set.get_curves());
262 if (curves_eval == nullptr) {
263 curves_eval = curves_new_nomain(0, 0);
264 BKE_object_eval_assign_data(object, &curves_eval->id, true);
265 }
266 else {
267 BKE_object_eval_assign_data(object, &curves_eval->id, false);
268 }
269 object->runtime->geometry_set_eval = new GeometrySet(std::move(geometry_set));
270}
271
272/* Draw Cache */
273
276
278{
279 if (curves->batch_cache) {
281 }
282}
283
285{
286 if (curves->batch_cache) {
288 }
289}
290
291namespace bke {
292
293Curves *curves_new_nomain(const int points_num, const int curves_num)
294{
295 BLI_assert(points_num >= 0);
296 BLI_assert(curves_num >= 0);
297 Curves *curves_id = BKE_id_new_nomain<Curves>(nullptr);
298 CurvesGeometry &curves = curves_id->geometry.wrap();
299 curves.resize(points_num, curves_num);
300 return curves_id;
301}
302
303Curves *curves_new_nomain_single(const int points_num, const CurveType type)
304{
305 Curves *curves_id = curves_new_nomain(points_num, 1);
306 CurvesGeometry &curves = curves_id->geometry.wrap();
307 curves.offsets_for_write().last() = points_num;
308 curves.fill_curve_types(type);
309 return curves_id;
310}
311
313{
314 Curves *curves_id = BKE_id_new_nomain<Curves>(nullptr);
315 curves_id->geometry.wrap() = std::move(curves);
316 return curves_id;
317}
318
320{
321 dst.flag = src.flag;
322 MEM_SAFE_DELETE(dst.mat);
323 dst.mat = MEM_new_array_uninitialized<Material *>(size_t(src.totcol), __func__);
324 dst.totcol = src.totcol;
325 MutableSpan(dst.mat, dst.totcol).copy_from(Span(src.mat, src.totcol));
326 dst.symmetry = src.symmetry;
327 dst.selection_domain = src.selection_domain;
328 dst.surface = src.surface;
329 MEM_SAFE_DELETE(dst.surface_uv_map);
330 if (src.surface_uv_map != nullptr) {
331 dst.surface_uv_map = BLI_strdup(src.surface_uv_map);
332 }
333 dst.surface_collision_distance = src.surface_collision_distance;
334}
335
336void curves_store_surface_in_geometry_bundle(const Depsgraph &depsgraph,
337 const Curves &curves_id,
338 GeometrySet &geometry_set)
339{
340 if (!curves_id.surface) {
341 return;
342 }
343 if (!curves_id.surface_uv_map) {
344 return;
345 }
346 nodes::Bundle &bundle = geometry_set.bundle_for_write();
347 bundle.add(*nodes::BundleKey::from_ustr("surface_object"_ustr),
348 DEG_get_evaluated(&depsgraph, curves_id.surface));
349 bundle.add(*nodes::BundleKey::from_ustr("surface_uv_map_name"_ustr),
350 std::string(curves_id.surface_uv_map));
351}
352
354{
355 this->curves_to_world = curves_ob.object_to_world();
357
358 if (surface_ob != nullptr) {
359 this->surface_to_world = surface_ob->object_to_world();
364 }
365}
366
368{
369 const int point_num = this->curves_id_orig.geometry.point_num;
370 if (this->positions().has_value()) {
371 if (this->positions()->size() != point_num) {
372 return false;
373 }
374 }
375 if (this->deform_mats.has_value()) {
376 if (this->deform_mats->size() != point_num) {
377 return false;
378 }
379 }
380 return true;
381}
382
383std::optional<Span<float3>> CurvesEditHints::positions() const
384{
385 if (!this->positions_data.has_value()) {
386 return std::nullopt;
387 }
388 const int points_num = this->curves_id_orig.geometry.wrap().points_num();
389 return Span(static_cast<const float3 *>(this->positions_data.data), points_num);
390}
391
392std::optional<MutableSpan<float3>> CurvesEditHints::positions_for_write()
393{
394 if (!this->positions_data.has_value()) {
395 return std::nullopt;
396 }
397
398 const int points_num = this->curves_id_orig.geometry.wrap().points_num();
400 if (data.sharing_info->is_mutable()) {
401 data.sharing_info->tag_ensured_mutable();
402 }
403 else {
404 auto *new_sharing_info = new ImplicitSharedValue<Array<float3>>(*this->positions());
405 data.sharing_info = ImplicitSharingPtr<>(new_sharing_info);
406 data.data = new_sharing_info->data.data();
407 }
408
409 return MutableSpan(const_cast<float3 *>(static_cast<const float3 *>(data.data)), points_num);
410}
411
413{
415 fn::FieldEvaluator evaluator(context, curves.points_num());
417 evaluator.evaluate();
418}
419
420} // namespace bke
421} // namespace blender
Low-level operations for curves.
CustomData interface, see also DNA_customdata_types.h.
#define BKE_LIB_FOREACHID_PROCESS_IDSUPER(data_, id_super_, cb_flag_)
General operations, lookup, etc. for materials.
General operations, lookup, etc. for blender objects.
#define BLT_I18NCONTEXT_ID_CURVES
#define FILTER_ID_OB
Definition DNA_ID.h:1216
#define FILTER_ID_MA
Definition DNA_ID.h:1210
#define FILTER_ID_CV
Definition DNA_ID.h:1230
Object is a sort of wrapper for general info.
Read Blender memory allocation and freeing.
#define INIT_DEFAULT_STRUCT_AFTER(struct_dst, member)
#define ELEM(...)
void generated_ptr(int64_t offset)
Definition writefile.cc:986
constexpr MutableSpan()=default
constexpr Span()=default
std::optional< MutableSpan< float3 > > positions_for_write()
ImplicitSharingPtrAndData positions_data
std::optional< Span< float3 > > positions() const
std::optional< Array< float3x3 > > deform_mats
std::unique_ptr< CurvesEditHints > curves_edit_hints_
static const fn::Field< float3 > & get_field()
int add_with_destination(GField field, GVMutableArray dst)
static std::optional< BundleKey > from_ustr(UString key)
bool add(BundleKey key, const BundleItemValue &value)
#define offsetof(t, d)
void curves_copy_parameters(const Curves &src, Curves &dst)
void curves_store_surface_in_geometry_bundle(const Depsgraph &depsgraph, const Curves &curves, GeometrySet &geometry)
Curves * curves_new_nomain_single(int points_num, CurveType type)
Curves * curves_new_nomain(int points_num, int curves_num)
void curves_normals_point_domain_calc(const CurvesGeometry &curves, MutableSpan< float3 > normals)
MatBase< T, NumCol, NumRow > transpose(const MatBase< T, NumRow, NumCol > &mat)
CartesianBasis invert(const CartesianBasis &basis)
BMesh Iterators.
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
struct Curves * BKE_curves_add(struct Main *bmain, const char *name)
unsigned int uint
Definition BKE_text.h:55
void * MEM_new_array_uninitialized(size_t len, size_t size, const char *str) ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1
void BLO_read_pointer_array_and_validate_size(BlendDataReader *reader, T **ptr_p, SizeT *array_size)
struct Curves * BKE_curves_copy_for_eval(const struct Curves *curves_src)
void(*) BKE_curves_batch_cache_free_cb(struct Curves *curves)
void BKE_object_eval_assign_data(Object *object, ID *data, bool is_owned)
Definition object.cc:1786
void BKE_curves_material_remap(struct Curves *curves, const unsigned int *remap, int remap_num)
void BKE_id_blend_write(BlendWriter *writer, ID *id)
Definition lib_id.cc:2890
@ LIB_ID_COPY_LOCALIZE
static void curves_foreach_working_space_color(ID *id, const IDTypeForeachColorFunctionCallback &fn)
void BKE_curves_batch_cache_free(struct Curves *curves)
static void curves_init_data(ID *id)
void(*) BKE_curves_batch_cache_dirty_tag_cb(struct Curves *curves, int mode)
void BKE_object_free_derived_caches(Object *ob)
Definition object.cc:1810
static void curves_evaluate_modifiers(Depsgraph *depsgraph, Scene *scene, Object *object, bke::GeometrySet &geometry_set)
@ OB_MODE_SCULPT_CURVES
BMesh const char void * data
T * DEG_get_evaluated(const Depsgraph *depsgraph, T *id)
void BKE_animdata_free(ID *id, bool do_id_user)
Definition anim_data.cc:174
@ MOD_APPLY_USECACHE
void BKE_curves_data_update(struct Depsgraph *depsgraph, struct Scene *scene, struct Object *object)
ModifierData * BKE_modifiers_get_virtual_modifierlist(const Object *ob, VirtualModifierData *data)
void BKE_modifiers_clear_errors(Object *ob)
bool BKE_curves_attribute_required(const struct Curves *curves, StringRef name)
eEvaluationMode DEG_get_mode(const Depsgraph *graph)
static void curves_blend_write(BlendWriter *writer, ID *id, const void *id_address)
bool BKE_object_is_in_editmode(const Object *ob)
Definition object.cc:1898
void * BKE_id_new_nomain(short type, const char *name)
Definition lib_id.cc:1617
T * DEG_get_original(T *id)
char * BLI_strdup(const char *str) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1) ATTR_MALLOC
@ INDEX_ID_CV
Definition DNA_ID.h:1330
static void curves_copy_data(Main *, std::optional< Library * >, ID *id_dst, const ID *id_src, const int)
void BKE_material_attr_indices_remap(bke::MutableAttributeAccessor attributes, const unsigned int *remap, int remap_num)
static const char * ATTR_POSITION
ID * BKE_id_copy_ex(Main *bmain, const ID *id, ID **new_id_p, int flag)
Definition lib_id.cc:851
VecBase< float, 3 > float3
void BKE_curves_batch_cache_dirty_tag(struct Curves *curves, int mode)
bool BKE_modifier_is_enabled(const Scene *scene, ModifierData *md, int required_mode)
static void curves_free_data(ID *id)
const ModifierTypeInfo * BKE_modifier_get_info(ModifierType type)
void * BKE_id_new(Main *bmain, short type, const char *name)
Definition lib_id.cc:1612
static void curves_blend_read_data(BlendDataReader *reader, ID *id)
void BLO_read_string(BlendDataReader *reader, char **ptr_p)
Definition readfile.cc:6653
static void curves_foreach_id(ID *id, LibraryForeachIDData *data)
@ IDTYPE_FLAGS_APPEND_IS_REUSABLE
Definition BKE_idtype.hh:50
void write_pointer_array(int64_t num, const void *data)
void write_string(const char *data)
void write_id_struct(const void *id_address, const T *id, BlendStructWriterTypedFn< T > fn=nullptr)
bool is_undo() const
static GeometrySet from_curves(Curves *curves, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)
struct ModifierData * next
void(*) modify_geometry_set(ModifierData *md, const ModifierEvalContext *ctx, bke::GeometrySet *geometry_set)
GeometryComponent & get_component_for_write(GeometryComponent::Type component_type)
nodes::Bundle & bundle_for_write()
const Curves * get_curves() const
#define N_(msgid)