Blender V5.3
grease_pencil_modifiers.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2017 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include "BLI_assert.hh"
10#include "BLI_listbase.hh"
11
12#include "MEM_guardedalloc.h"
13
14#include "DNA_colorband_types.h"
16#include "DNA_modifier_types.h"
17#include "DNA_object_types.h"
18#include "DNA_texture_types.h"
19
20#include "BKE_colortools.hh"
21#include "BKE_deform.hh"
23#include "BKE_lattice.hh"
24#include "BKE_lib_id.hh"
25#include "BKE_lib_query.hh"
26#include "BKE_modifier.hh"
27#include "BKE_screen.hh"
28#include "BKE_shrinkwrap.hh"
29
30#include "BLO_read_write.hh"
31
32namespace blender {
33
34/* Check if the type value is valid. */
35static bool gpencil_modifier_type_valid(const int type)
36{
37 return type > 0 && type < NUM_GREASEPENCIL_MODIFIER_TYPES;
38}
39
41{
42 switch (type) {
44 return sizeof(GpencilModifierData);
46 return sizeof(NoiseGpencilModifierData);
48 return sizeof(SubdivGpencilModifierData);
50 return sizeof(ThickGpencilModifierData);
52 return sizeof(TintGpencilModifierData);
54 return sizeof(ArrayGpencilModifierData);
56 return sizeof(BuildGpencilModifierData);
58 return sizeof(OpacityGpencilModifierData);
60 return sizeof(ColorGpencilModifierData);
62 return sizeof(LatticeGpencilModifierData);
64 return sizeof(SimplifyGpencilModifierData);
66 return sizeof(SmoothGpencilModifierData);
68 return sizeof(HookGpencilModifierData);
70 return sizeof(OffsetGpencilModifierData);
72 return sizeof(MirrorGpencilModifierData);
74 return sizeof(ArmatureGpencilModifierData);
76 return sizeof(TimeGpencilModifierData);
78 return sizeof(MultiplyGpencilModifierData);
80 return sizeof(TextureGpencilModifierData);
82 return sizeof(LineartGpencilModifierData);
84 return sizeof(LengthGpencilModifierData);
86 return sizeof(WeightProxGpencilModifierData);
88 return sizeof(DashGpencilModifierData);
90 return sizeof(WeightAngleGpencilModifierData);
92 return sizeof(ShrinkwrapGpencilModifierData);
94 return sizeof(EnvelopeGpencilModifierData);
96 return sizeof(OutlineGpencilModifierData);
98 break;
99 }
100 return sizeof(GpencilModifierData);
101}
102
108{
109 switch (md->type) {
111 NoiseGpencilModifierData *gpmd = reinterpret_cast<NoiseGpencilModifierData *>(md);
112
113 if (gpmd->curve_intensity) {
115 }
116 break;
117 }
119 ThickGpencilModifierData *gpmd = reinterpret_cast<ThickGpencilModifierData *>(md);
120
121 if (gpmd->curve_thickness) {
123 }
124 break;
125 }
127 TintGpencilModifierData *mmd = reinterpret_cast<TintGpencilModifierData *>(md);
128
129 MEM_SAFE_DELETE(mmd->colorband);
130 if (mmd->curve_intensity) {
132 }
133 break;
134 }
136 OpacityGpencilModifierData *gpmd = reinterpret_cast<OpacityGpencilModifierData *>(md);
137
138 if (gpmd->curve_intensity) {
140 }
141 break;
142 }
144 ColorGpencilModifierData *gpmd = reinterpret_cast<ColorGpencilModifierData *>(md);
145
146 if (gpmd->curve_intensity) {
148 }
149 break;
150 }
152 LatticeGpencilModifierData *mmd = reinterpret_cast<LatticeGpencilModifierData *>(md);
153 LatticeDeformData *ldata = static_cast<LatticeDeformData *>(mmd->cache_data);
154
155 /* free deform data */
156 if (ldata) {
158 }
159 break;
160 }
162 SmoothGpencilModifierData *gpmd = reinterpret_cast<SmoothGpencilModifierData *>(md);
163
164 if (gpmd->curve_intensity) {
166 }
167 break;
168 }
170 HookGpencilModifierData *mmd = reinterpret_cast<HookGpencilModifierData *>(md);
171
172 if (mmd->curfalloff) {
174 }
175 break;
176 }
178 TimeGpencilModifierData *gpmd = reinterpret_cast<TimeGpencilModifierData *>(md);
179
180 MEM_SAFE_DELETE(gpmd->segments);
181 break;
182 }
184 DashGpencilModifierData *dmd = reinterpret_cast<DashGpencilModifierData *>(md);
185
186 MEM_SAFE_DELETE(dmd->segments);
187 break;
188 }
191
192 if (mmd->cache_data) {
194 MEM_delete(mmd->cache_data);
195 }
196 break;
197 }
198
215 break;
218 break;
219 }
220}
221
229 Object *ob,
231 void *user_data)
232{
233 switch (md->type) {
235 break;
236 }
238 NoiseGpencilModifierData *mmd = reinterpret_cast<NoiseGpencilModifierData *>(md);
239
240 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->material), IDWALK_CB_USER);
241 break;
242 }
244 SubdivGpencilModifierData *mmd = reinterpret_cast<SubdivGpencilModifierData *>(md);
245
246 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->material), IDWALK_CB_USER);
247 break;
248 }
250 ThickGpencilModifierData *mmd = reinterpret_cast<ThickGpencilModifierData *>(md);
251
252 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->material), IDWALK_CB_USER);
253 break;
254 }
256 TintGpencilModifierData *mmd = reinterpret_cast<TintGpencilModifierData *>(md);
257
258 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->material), IDWALK_CB_USER);
259 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->object), IDWALK_CB_NOP);
260 break;
261 }
263 ArrayGpencilModifierData *mmd = reinterpret_cast<ArrayGpencilModifierData *>(md);
264
265 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->material), IDWALK_CB_USER);
266 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->object), IDWALK_CB_NOP);
267 break;
268 }
270 BuildGpencilModifierData *mmd = reinterpret_cast<BuildGpencilModifierData *>(md);
271
272 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->object), IDWALK_CB_NOP);
273 break;
274 }
276 OpacityGpencilModifierData *mmd = reinterpret_cast<OpacityGpencilModifierData *>(md);
277
278 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->material), IDWALK_CB_USER);
279 break;
280 }
282 ColorGpencilModifierData *mmd = reinterpret_cast<ColorGpencilModifierData *>(md);
283
284 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->material), IDWALK_CB_USER);
285 break;
286 }
288 LatticeGpencilModifierData *mmd = reinterpret_cast<LatticeGpencilModifierData *>(md);
289
290 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->material), IDWALK_CB_USER);
291 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->object), IDWALK_CB_NOP);
292 break;
293 }
295 SimplifyGpencilModifierData *mmd = reinterpret_cast<SimplifyGpencilModifierData *>(md);
296
297 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->material), IDWALK_CB_USER);
298 break;
299 }
301 SmoothGpencilModifierData *mmd = reinterpret_cast<SmoothGpencilModifierData *>(md);
302
303 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->material), IDWALK_CB_USER);
304 break;
305 }
307 HookGpencilModifierData *mmd = reinterpret_cast<HookGpencilModifierData *>(md);
308
309 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->material), IDWALK_CB_USER);
310 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->object), IDWALK_CB_NOP);
311 break;
312 }
314 OffsetGpencilModifierData *mmd = reinterpret_cast<OffsetGpencilModifierData *>(md);
315
316 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->material), IDWALK_CB_USER);
317 break;
318 }
320 MirrorGpencilModifierData *mmd = reinterpret_cast<MirrorGpencilModifierData *>(md);
321
322 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->material), IDWALK_CB_USER);
323 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->object), IDWALK_CB_NOP);
324 break;
325 }
327 ArmatureGpencilModifierData *mmd = reinterpret_cast<ArmatureGpencilModifierData *>(md);
328
329 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->object), IDWALK_CB_NOP);
330 break;
331 }
333 TimeGpencilModifierData *mmd = reinterpret_cast<TimeGpencilModifierData *>(md);
334
335 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->material), IDWALK_CB_USER);
336 break;
337 }
339 MultiplyGpencilModifierData *mmd = reinterpret_cast<MultiplyGpencilModifierData *>(md);
340
341 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->material), IDWALK_CB_USER);
342 break;
343 }
345 TextureGpencilModifierData *mmd = reinterpret_cast<TextureGpencilModifierData *>(md);
346
347 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->material), IDWALK_CB_USER);
348 break;
349 }
351 LineartGpencilModifierData *lmd = reinterpret_cast<LineartGpencilModifierData *>(md);
352
353 walk(user_data, ob, reinterpret_cast<ID **>(&lmd->target_material), IDWALK_CB_USER);
354 walk(user_data, ob, reinterpret_cast<ID **>(&lmd->source_collection), IDWALK_CB_NOP);
355
356 walk(user_data, ob, reinterpret_cast<ID **>(&lmd->source_object), IDWALK_CB_NOP);
357 walk(user_data, ob, reinterpret_cast<ID **>(&lmd->source_camera), IDWALK_CB_NOP);
358 walk(user_data, ob, reinterpret_cast<ID **>(&lmd->light_contour_object), IDWALK_CB_NOP);
359 break;
360 }
362 LengthGpencilModifierData *mmd = reinterpret_cast<LengthGpencilModifierData *>(md);
363
364 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->material), IDWALK_CB_USER);
365 break;
366 }
369
370 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->material), IDWALK_CB_USER);
371 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->object), IDWALK_CB_NOP);
372 break;
373 }
375 DashGpencilModifierData *mmd = reinterpret_cast<DashGpencilModifierData *>(md);
376
377 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->material), IDWALK_CB_USER);
378 break;
379 }
382
383 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->material), IDWALK_CB_USER);
384 break;
385 }
388
389 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->target), IDWALK_CB_NOP);
390 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->aux_target), IDWALK_CB_NOP);
391 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->material), IDWALK_CB_USER);
392 break;
393 }
395 EnvelopeGpencilModifierData *mmd = reinterpret_cast<EnvelopeGpencilModifierData *>(md);
396
397 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->material), IDWALK_CB_USER);
398 break;
399 }
401 OutlineGpencilModifierData *mmd = reinterpret_cast<OutlineGpencilModifierData *>(md);
402
403 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->material), IDWALK_CB_USER);
404 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->outline_material), IDWALK_CB_USER);
405 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->object), IDWALK_CB_NOP);
406 break;
407 }
410 break;
411 }
412}
413
414/* *************************************************** */
415/* Modifier Methods - Evaluation Loops, etc. */
416
417static void modifier_free_data_id_us_cb(void * /*user_data*/,
418 Object * /*ob*/,
419 ID **idpoin,
420 const LibraryForeachIDCallbackFlag cb_flag)
421{
422 ID *id = *idpoin;
423 if (id != nullptr && (cb_flag & IDWALK_CB_USER) != 0) {
424 id_us_min(id);
425 }
426}
427
429{
430 if ((flag & LIB_ID_CREATE_NO_USER_REFCOUNT) == 0) {
432 }
433
435 if (md->error) {
436 MEM_delete(md->error);
437 }
438
439 MEM_delete(md);
440}
441
446
449 void *user_data)
450{
452
453 for (; md; md = md->next) {
454 gpencil_modifier_foreach_ID_link(md, ob, walk, user_data);
455 }
456}
457
459 ListBaseT<GpencilModifierData> *lb,
460 Object *ob)
461{
463 reader, lb, [](const GpencilModifierData &md) {
465 });
466
467 for (GpencilModifierData &md : *lb) {
468 md.error = nullptr;
469
470 /* if modifiers disappear, or for upward compatibility */
473 }
474
475 /* If linking from a library, clear 'local' library override flag. */
476 if (ID_IS_LINKED(ob)) {
478 }
479
481 LatticeGpencilModifierData *gpmd = reinterpret_cast<LatticeGpencilModifierData *>(&md);
482 gpmd->cache_data = nullptr;
483 }
484 else if (md.type == eGpencilModifierType_Hook) {
485 HookGpencilModifierData *hmd = reinterpret_cast<HookGpencilModifierData *>(&md);
486
488 if (hmd->curfalloff) {
491 }
492 }
493 else if (md.type == eGpencilModifierType_Noise) {
494 NoiseGpencilModifierData *gpmd = reinterpret_cast<NoiseGpencilModifierData *>(&md);
495
497 if (gpmd->curve_intensity) {
499 /* Initialize the curve. Maybe this could be moved to modifier logic. */
501 }
502 }
503 else if (md.type == eGpencilModifierType_Thick) {
504 ThickGpencilModifierData *gpmd = reinterpret_cast<ThickGpencilModifierData *>(&md);
505
507 if (gpmd->curve_thickness) {
510 }
511 }
512 else if (md.type == eGpencilModifierType_Tint) {
513 TintGpencilModifierData *gpmd = reinterpret_cast<TintGpencilModifierData *>(&md);
514 BLO_read_struct(reader, ColorBand, &gpmd->colorband);
516 if (gpmd->curve_intensity) {
519 }
520 }
521 else if (md.type == eGpencilModifierType_Smooth) {
522 SmoothGpencilModifierData *gpmd = reinterpret_cast<SmoothGpencilModifierData *>(&md);
524 if (gpmd->curve_intensity) {
527 }
528 }
529 else if (md.type == eGpencilModifierType_Color) {
530 ColorGpencilModifierData *gpmd = reinterpret_cast<ColorGpencilModifierData *>(&md);
532 if (gpmd->curve_intensity) {
535 }
536 }
537 else if (md.type == eGpencilModifierType_Opacity) {
538 OpacityGpencilModifierData *gpmd = reinterpret_cast<OpacityGpencilModifierData *>(&md);
540 if (gpmd->curve_intensity) {
543 }
544 }
545 else if (md.type == eGpencilModifierType_Dash) {
546 DashGpencilModifierData *gpmd = reinterpret_cast<DashGpencilModifierData *>(&md);
548 for (int i = 0; i < gpmd->segments_len; i++) {
549 gpmd->segments[i].dmd = gpmd;
550 }
551 }
552 else if (md.type == eGpencilModifierType_Time) {
553 TimeGpencilModifierData *gpmd = reinterpret_cast<TimeGpencilModifierData *>(&md);
555 for (int i = 0; i < gpmd->segments_len; i++) {
556 gpmd->segments[i].gpmd = gpmd;
557 }
558 }
560 ShrinkwrapGpencilModifierData *gpmd = reinterpret_cast<ShrinkwrapGpencilModifierData *>(&md);
561 gpmd->cache_data = nullptr;
562 }
563 }
564}
565
566} // namespace blender
support for deformation groups and hooks.
#define BLO_read_struct(reader, struct_name, ptr_p)
#define ID_IS_LINKED(_id)
Definition DNA_ID.h:697
Object is a sort of wrapper for general info.
Read Blender memory allocation and freeing.
#define BLI_assert_unreachable()
BMesh Iterators.
void BKE_grease_pencil_modifier_free(struct GpencilModifierData *md)
static size_t gpencil_modifier_struct_size(const GpencilModifierType type)
void BKE_shrinkwrap_free_tree(ShrinkwrapTreeData *data)
void BKE_curvemapping_free(CurveMapping *cumap)
@ LIB_ID_CREATE_NO_USER_REFCOUNT
static void modifier_free_data_id_us_cb(void *, Object *, ID **idpoin, const LibraryForeachIDCallbackFlag cb_flag)
void BKE_curvemapping_init(CurveMapping *cumap)
void BKE_curvemapping_blend_read(BlendDataReader *reader, CurveMapping *cumap)
void BKE_grease_pencil_modifier_blend_read_data(struct BlendDataReader *reader, ListBaseT< GpencilModifierData > *lb, struct Object *ob)
void BLO_read_struct_list_with_type_size(BlendDataReader *reader, size_t base_size, ListBase *list, FunctionRef< size_t(const void *data)> type_size_fn)
Definition readfile.cc:6591
static void gpencil_modifier_free_data(GpencilModifierData *md)
void(*) GreasePencilIDWalkFunc(void *user_data, struct Object *ob, struct ID **idpoin, LibraryForeachIDCallbackFlag cb_flag)
void BKE_grease_pencil_modifier_free_ex(struct GpencilModifierData *md, int flag)
void BLO_read_array_and_validate_size(BlendDataReader *reader, T **ptr_p, SizeT *array_size, const int elems=1)
void BKE_lattice_deform_data_destroy(LatticeDeformData *lattice_deform_data)
static void gpencil_modifier_foreach_ID_link(GpencilModifierData *md, Object *ob, GreasePencilIDWalkFunc walk, void *user_data)
static bool gpencil_modifier_type_valid(const int type)
void BKE_grease_pencil_modifiers_foreach_ID_link(struct Object *ob, GreasePencilIDWalkFunc walk, void *user_data)
LibraryForeachIDCallbackFlag
void id_us_min(ID *id)
Definition lib_id.cc:441
ListBaseT< GpencilModifierData > greasepencil_modifiers