Blender V4.5
gpencil_modifier_legacy.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
9#include "BLI_assert.h"
10#include "BLI_listbase.h"
11#include "MEM_guardedalloc.h"
12
13#include "DNA_colorband_types.h"
15#include "DNA_modifier_types.h"
16#include "DNA_object_types.h"
17#include "DNA_texture_types.h"
18
19#include "BKE_colortools.hh"
20#include "BKE_deform.hh"
21#include "BKE_gpencil_legacy.h"
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
32/* Check if the type value is valid. */
33static bool gpencil_modifier_type_valid(const int type)
34{
35 return type > 0 && type < NUM_GREASEPENCIL_MODIFIER_TYPES;
36}
37
39{
40 switch (type) {
42 return sizeof(GpencilModifierData);
44 return sizeof(NoiseGpencilModifierData);
46 return sizeof(SubdivGpencilModifierData);
48 return sizeof(ThickGpencilModifierData);
50 return sizeof(TintGpencilModifierData);
52 return sizeof(ArrayGpencilModifierData);
54 return sizeof(BuildGpencilModifierData);
56 return sizeof(OpacityGpencilModifierData);
58 return sizeof(ColorGpencilModifierData);
60 return sizeof(LatticeGpencilModifierData);
62 return sizeof(SimplifyGpencilModifierData);
64 return sizeof(SmoothGpencilModifierData);
66 return sizeof(HookGpencilModifierData);
68 return sizeof(OffsetGpencilModifierData);
70 return sizeof(MirrorGpencilModifierData);
72 return sizeof(ArmatureGpencilModifierData);
74 return sizeof(TimeGpencilModifierData);
76 return sizeof(MultiplyGpencilModifierData);
78 return sizeof(TextureGpencilModifierData);
80 return sizeof(LineartGpencilModifierData);
82 return sizeof(LengthGpencilModifierData);
84 return sizeof(WeightProxGpencilModifierData);
86 return sizeof(DashGpencilModifierData);
88 return sizeof(WeightAngleGpencilModifierData);
90 return sizeof(ShrinkwrapGpencilModifierData);
92 return sizeof(EnvelopeGpencilModifierData);
94 return sizeof(OutlineGpencilModifierData);
96 break;
97 }
98 return sizeof(GpencilModifierData);
99}
100
106{
107 switch (GpencilModifierType(md->type)) {
110
111 if (gpmd->curve_intensity) {
113 }
114 break;
115 }
118
119 if (gpmd->curve_thickness) {
121 }
122 break;
123 }
126
128 if (mmd->curve_intensity) {
130 }
131 break;
132 }
135
136 if (gpmd->curve_intensity) {
138 }
139 break;
140 }
143
144 if (gpmd->curve_intensity) {
146 }
147 break;
148 }
152
153 /* free deform data */
154 if (ldata) {
156 }
157 break;
158 }
161
162 if (gpmd->curve_intensity) {
164 }
165 break;
166 }
169
170 if (mmd->curfalloff) {
172 }
173 break;
174 }
177
178 MEM_SAFE_FREE(gpmd->segments);
179 break;
180 }
183
185 break;
186 }
189
190 if (mmd->cache_data) {
192 MEM_delete(mmd->cache_data);
193 }
194 break;
195 }
196
213 break;
216 break;
217 }
218}
219
227 Object *ob,
229 void *user_data)
230{
231 switch (GpencilModifierType(md->type)) {
233 break;
234 }
237
238 walk(user_data, ob, (ID **)&mmd->material, IDWALK_CB_USER);
239 break;
240 }
243
244 walk(user_data, ob, (ID **)&mmd->material, IDWALK_CB_USER);
245 break;
246 }
249
250 walk(user_data, ob, (ID **)&mmd->material, IDWALK_CB_USER);
251 break;
252 }
255
256 walk(user_data, ob, (ID **)&mmd->material, IDWALK_CB_USER);
257 walk(user_data, ob, (ID **)&mmd->object, IDWALK_CB_NOP);
258 break;
259 }
262
263 walk(user_data, ob, (ID **)&mmd->material, IDWALK_CB_USER);
264 walk(user_data, ob, (ID **)&mmd->object, IDWALK_CB_NOP);
265 break;
266 }
269
270 walk(user_data, ob, (ID **)&mmd->object, IDWALK_CB_NOP);
271 break;
272 }
275
276 walk(user_data, ob, (ID **)&mmd->material, IDWALK_CB_USER);
277 break;
278 }
281
282 walk(user_data, ob, (ID **)&mmd->material, IDWALK_CB_USER);
283 break;
284 }
287
288 walk(user_data, ob, (ID **)&mmd->material, IDWALK_CB_USER);
289 walk(user_data, ob, (ID **)&mmd->object, IDWALK_CB_NOP);
290 break;
291 }
294
295 walk(user_data, ob, (ID **)&mmd->material, IDWALK_CB_USER);
296 break;
297 }
300
301 walk(user_data, ob, (ID **)&mmd->material, IDWALK_CB_USER);
302 break;
303 }
306
307 walk(user_data, ob, (ID **)&mmd->material, IDWALK_CB_USER);
308 walk(user_data, ob, (ID **)&mmd->object, IDWALK_CB_NOP);
309 break;
310 }
313
314 walk(user_data, ob, (ID **)&mmd->material, IDWALK_CB_USER);
315 break;
316 }
319
320 walk(user_data, ob, (ID **)&mmd->material, IDWALK_CB_USER);
321 walk(user_data, ob, (ID **)&mmd->object, IDWALK_CB_NOP);
322 break;
323 }
326
327 walk(user_data, ob, (ID **)&mmd->object, IDWALK_CB_NOP);
328 break;
329 }
332
333 walk(user_data, ob, (ID **)&mmd->material, IDWALK_CB_USER);
334 break;
335 }
338
339 walk(user_data, ob, (ID **)&mmd->material, IDWALK_CB_USER);
340 break;
341 }
344
345 walk(user_data, ob, (ID **)&mmd->material, IDWALK_CB_USER);
346 break;
347 }
350
351 walk(user_data, ob, (ID **)&lmd->target_material, IDWALK_CB_USER);
352 walk(user_data, ob, (ID **)&lmd->source_collection, IDWALK_CB_NOP);
353
354 walk(user_data, ob, (ID **)&lmd->source_object, IDWALK_CB_NOP);
355 walk(user_data, ob, (ID **)&lmd->source_camera, IDWALK_CB_NOP);
356 walk(user_data, ob, (ID **)&lmd->light_contour_object, IDWALK_CB_NOP);
357 break;
358 }
361
362 walk(user_data, ob, (ID **)&mmd->material, IDWALK_CB_USER);
363 break;
364 }
367
368 walk(user_data, ob, (ID **)&mmd->material, IDWALK_CB_USER);
369 walk(user_data, ob, (ID **)&mmd->object, IDWALK_CB_NOP);
370 break;
371 }
374
375 walk(user_data, ob, (ID **)&mmd->material, IDWALK_CB_USER);
376 break;
377 }
380
381 walk(user_data, ob, (ID **)&mmd->material, IDWALK_CB_USER);
382 break;
383 }
386
387 walk(user_data, ob, (ID **)&mmd->target, IDWALK_CB_NOP);
388 walk(user_data, ob, (ID **)&mmd->aux_target, IDWALK_CB_NOP);
389 walk(user_data, ob, (ID **)&mmd->material, IDWALK_CB_USER);
390 break;
391 }
394
395 walk(user_data, ob, (ID **)&mmd->material, IDWALK_CB_USER);
396 break;
397 }
400
401 walk(user_data, ob, (ID **)&mmd->material, IDWALK_CB_USER);
402 walk(user_data, ob, (ID **)&mmd->outline_material, IDWALK_CB_USER);
403 walk(user_data, ob, (ID **)&mmd->object, IDWALK_CB_NOP);
404 break;
405 }
408 break;
409 }
410}
411
412/* *************************************************** */
413/* Modifier Methods - Evaluation Loops, etc. */
414
415static void modifier_free_data_id_us_cb(void * /*user_data*/,
416 Object * /*ob*/,
417 ID **idpoin,
418 const LibraryForeachIDCallbackFlag cb_flag)
419{
420 ID *id = *idpoin;
421 if (id != nullptr && (cb_flag & IDWALK_CB_USER) != 0) {
422 id_us_min(id);
423 }
424}
425
427{
430 }
431
433 if (md->error) {
434 MEM_freeN(md->error);
435 }
436
437 MEM_freeN(md);
438}
439
444
447 void *user_data)
448{
450
451 for (; md; md = md->next) {
452 gpencil_modifier_foreach_ID_link(md, ob, walk, user_data);
453 }
454}
455
457{
459 reader, lb, [](const GpencilModifierData &md) {
461 });
462
464 md->error = nullptr;
465
466 /* if modifiers disappear, or for upward compatibility */
469 }
470
471 /* If linking from a library, clear 'local' library override flag. */
472 if (ID_IS_LINKED(ob)) {
473 md->flag &= ~eGpencilModifierFlag_OverrideLibrary_Local;
474 }
475
478 gpmd->cache_data = nullptr;
479 }
480 else if (md->type == eGpencilModifierType_Hook) {
482
484 if (hmd->curfalloff) {
487 }
488 }
489 else if (md->type == eGpencilModifierType_Noise) {
491
493 if (gpmd->curve_intensity) {
495 /* Initialize the curve. Maybe this could be moved to modifier logic. */
497 }
498 }
499 else if (md->type == eGpencilModifierType_Thick) {
501
503 if (gpmd->curve_thickness) {
506 }
507 }
508 else if (md->type == eGpencilModifierType_Tint) {
510 BLO_read_struct(reader, ColorBand, &gpmd->colorband);
512 if (gpmd->curve_intensity) {
515 }
516 }
517 else if (md->type == eGpencilModifierType_Smooth) {
520 if (gpmd->curve_intensity) {
523 }
524 }
525 else if (md->type == eGpencilModifierType_Color) {
528 if (gpmd->curve_intensity) {
531 }
532 }
533 else if (md->type == eGpencilModifierType_Opacity) {
536 if (gpmd->curve_intensity) {
539 }
540 }
541 else if (md->type == eGpencilModifierType_Dash) {
544 reader, DashGpencilModifierSegment, gpmd->segments_len, &gpmd->segments);
545 for (int i = 0; i < gpmd->segments_len; i++) {
546 gpmd->segments[i].dmd = gpmd;
547 }
548 }
549 else if (md->type == eGpencilModifierType_Time) {
552 reader, TimeGpencilModifierSegment, gpmd->segments_len, &gpmd->segments);
553 for (int i = 0; i < gpmd->segments_len; i++) {
554 gpmd->segments[i].gpmd = gpmd;
555 }
556 }
559 gpmd->cache_data = nullptr;
560 }
561 }
562}
void BKE_curvemapping_blend_read(BlendDataReader *reader, CurveMapping *cumap)
void BKE_curvemapping_init(CurveMapping *cumap)
void BKE_curvemapping_free(CurveMapping *cumap)
support for deformation groups and hooks.
void(* GreasePencilIDWalkFunc)(void *user_data, struct Object *ob, struct ID **idpoin, LibraryForeachIDCallbackFlag cb_flag)
void BKE_lattice_deform_data_destroy(LatticeDeformData *lattice_deform_data)
@ LIB_ID_CREATE_NO_USER_REFCOUNT
void id_us_min(ID *id)
Definition lib_id.cc:361
LibraryForeachIDCallbackFlag
@ IDWALK_CB_USER
@ IDWALK_CB_NOP
void BKE_shrinkwrap_free_tree(ShrinkwrapTreeData *data)
#define BLI_assert_unreachable()
Definition BLI_assert.h:93
#define LISTBASE_FOREACH(type, var, list)
void BLO_read_struct_list_with_type_size(BlendDataReader *reader, size_t base_size, ListBase *list, blender::FunctionRef< size_t(const void *data)> type_size_fn)
Definition readfile.cc:5647
#define BLO_read_struct_array(reader, struct_name, array_size, ptr_p)
#define BLO_read_struct(reader, struct_name, ptr_p)
#define ID_IS_LINKED(_id)
Definition DNA_ID.h:615
struct SimplifyGpencilModifierData SimplifyGpencilModifierData
struct OffsetGpencilModifierData OffsetGpencilModifierData
struct BuildGpencilModifierData BuildGpencilModifierData
struct EnvelopeGpencilModifierData EnvelopeGpencilModifierData
struct ShrinkwrapGpencilModifierData ShrinkwrapGpencilModifierData
struct SmoothGpencilModifierData SmoothGpencilModifierData
struct ArmatureGpencilModifierData ArmatureGpencilModifierData
struct SubdivGpencilModifierData SubdivGpencilModifierData
struct GpencilModifierData GpencilModifierData
struct DashGpencilModifierData DashGpencilModifierData
struct TextureGpencilModifierData TextureGpencilModifierData
struct TintGpencilModifierData TintGpencilModifierData
struct MirrorGpencilModifierData MirrorGpencilModifierData
struct LatticeGpencilModifierData LatticeGpencilModifierData
struct ColorGpencilModifierData ColorGpencilModifierData
struct LineartGpencilModifierData LineartGpencilModifierData
struct WeightAngleGpencilModifierData WeightAngleGpencilModifierData
struct OpacityGpencilModifierData OpacityGpencilModifierData
struct HookGpencilModifierData HookGpencilModifierData
struct OutlineGpencilModifierData OutlineGpencilModifierData
struct MultiplyGpencilModifierData MultiplyGpencilModifierData
struct ThickGpencilModifierData ThickGpencilModifierData
struct LengthGpencilModifierData LengthGpencilModifierData
@ eGpencilModifierType_Dash
@ eGpencilModifierType_Array
@ eGpencilModifierType_Noise
@ eGpencilModifierType_Mirror
@ eGpencilModifierType_Color
@ eGpencilModifierType_Multiply
@ eGpencilModifierType_Texture
@ eGpencilModifierType_Subdiv
@ eGpencilModifierType_Length
@ eGpencilModifierType_Lattice
@ eGpencilModifierType_Opacity
@ eGpencilModifierType_Hook
@ eGpencilModifierType_Simplify
@ eGpencilModifierType_Shrinkwrap
@ eGpencilModifierType_WeightProximity
@ eGpencilModifierType_Armature
@ eGpencilModifierType_WeightAngle
@ eGpencilModifierType_Lineart
@ eGpencilModifierType_None
@ eGpencilModifierType_Smooth
@ eGpencilModifierType_Tint
@ eGpencilModifierType_Outline
@ eGpencilModifierType_Envelope
@ NUM_GREASEPENCIL_MODIFIER_TYPES
@ eGpencilModifierType_Time
@ eGpencilModifierType_Thick
@ eGpencilModifierType_Build
@ eGpencilModifierType_Offset
struct ArrayGpencilModifierData ArrayGpencilModifierData
struct TimeGpencilModifierData TimeGpencilModifierData
struct WeightProxGpencilModifierData WeightProxGpencilModifierData
struct NoiseGpencilModifierData NoiseGpencilModifierData
@ eModifierType_None
Object is a sort of wrapper for general info.
Read Guarded memory(de)allocation.
#define MEM_SAFE_FREE(v)
void BKE_gpencil_modifiers_foreach_ID_link(Object *ob, GreasePencilIDWalkFunc walk, void *user_data)
void BKE_gpencil_modifier_free_ex(GpencilModifierData *md, const int flag)
void BKE_gpencil_modifier_blend_read_data(BlendDataReader *reader, ListBase *lb, Object *ob)
static void modifier_free_data_id_us_cb(void *, Object *, ID **idpoin, const LibraryForeachIDCallbackFlag cb_flag)
static bool gpencil_modifier_type_valid(const int type)
static void gpencil_modifier_foreach_ID_link(GpencilModifierData *md, Object *ob, GreasePencilIDWalkFunc walk, void *user_data)
static void gpencil_modifier_free_data(GpencilModifierData *md)
static size_t gpencil_modifier_struct_size(const GpencilModifierType type)
void BKE_gpencil_modifier_free(GpencilModifierData *md)
void MEM_freeN(void *vmemh)
Definition mallocn.cc:113
DashGpencilModifierSegment * segments
struct DashGpencilModifierData * dmd
struct GpencilModifierData * next
Definition DNA_ID.h:404
struct LatticeDeformData * cache_data
void * first
ListBase greasepencil_modifiers
TimeGpencilModifierSegment * segments
struct TimeGpencilModifierData * gpmd
struct CurveMapping * curve_intensity