Blender V5.3
DNA_grease_pencil_modifier_types.h
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 "BLI_enum_flags.hh"
12#include "BLI_math_constants.hh"
13
14#include "DNA_armature_types.h"
15#include "DNA_brush_enums.h"
16#include "DNA_defs.h"
17#include "DNA_lineart_types.h"
18#include "DNA_modifier_enums.h"
19#include "DNA_vec_defaults.h"
20
21namespace blender {
22
25
31 eGpencilModifierMode_Expanded_DEPRECATED = (1 << 3),
32#endif
34};
36
37enum GpencilModifierFlag : short {
38 /* This modifier has been inserted in local override, and hence can be fully edited. */
40};
42
47
48/* WARNING ALERT! TYPEDEF VALUES ARE WRITTEN IN FILES! SO DO NOT CHANGE!
49 * (ONLY ADD NEW ITEMS AT THE END)
50 */
51
83
85 struct GpencilModifierData *next = nullptr, *prev = nullptr;
86
89 char _pad0[4] = {};
91 /* An "expand" bit for each of the modifier's (sub)panels (uiPanelDataExpansion). */
92 short ui_expand_flag = 0;
93 char name[/*MAX_NAME*/ 64] = "";
94
95 char *error = nullptr;
96};
97
101 struct Material *material = nullptr;
103 char layername[64] = "";
107 char vgname[/*MAX_VGROUP_NAME*/ 64] = "";
109 int pass_index = 0;
113 float factor = 0.5f;
114 float factor_strength = 0.0f;
115 float factor_thickness = 0.0f;
116 float factor_uvs = 0.0f;
118 float noise_scale = 0.0f;
119 float noise_offset = 0.0f;
120 short noise_mode = 0;
121 char _pad[2] = {};
123 int step = 4;
125 int layer_pass = 0;
127 int seed = 1;
128 struct CurveMapping *curve_intensity = nullptr;
129};
130
138
143
164
176
180 struct Material *material = nullptr;
182 char layername[64] = "";
186 char vgname[/*MAX_VGROUP_NAME*/ 64] = "";
188 int pass_index = 0;
192 float thickness_fac = 1.0f;
194 int thickness = 30;
196 int layer_pass = 0;
197 char _pad[4] = {};
198 struct CurveMapping *curve_thickness = nullptr;
199};
200
208
216
222
224 char name[64] = "";
225 /* For path reference. */
226 struct TimeGpencilModifierData *gpmd = nullptr;
227 int seg_start = 1;
228 int seg_end = 2;
230 int seg_repeat = 1;
231};
232
255
262
267
276
288
292 struct Material *material = nullptr;
294 char layername[64] = "";
298 int pass_index = 0;
302 float hsv[3] = {0.5f, 1.0f, 1.0f};
305 char _pad[3] = {};
307 int layer_pass = 0;
308
309 char _pad1[4] = {};
310 struct CurveMapping *curve_intensity = nullptr;
311};
312
316 struct Material *material = nullptr;
318 char layername[64] = "";
322 char vgname[/*MAX_VGROUP_NAME*/ 64] = "";
324 int pass_index = 0;
328 float factor = 1.0f;
331 char _pad[3] = {};
333 int layer_pass = 0;
334
335 float hardness = 1.0f;
336 struct CurveMapping *curve_intensity = nullptr;
337};
338
347
371
374 struct Object *object = nullptr;
376 struct Material *material = nullptr;
378 int count = 2;
382 float offset[3] = {0.0f, 0.0f, 0.0f};
384 float shift[3] = {1.0f, 0.0f, 0.0f};
386 float rnd_offset[3] = {0.0f, 0.0f, 0.0f};
388 float rnd_rot[3] = {0.0f, 0.0f, 0.0f};
390 float rnd_scale[3] = {0.0f, 0.0f, 0.0f};
391
392 char _pad[4] = {};
394 int seed = 1;
395
397 int pass_index = 0;
399 char layername[64] = "";
403 int mat_rpl = 0;
405 int layer_pass = 0;
406};
407
408enum eBuildGpencil_Mode : short {
409 /* Strokes are shown one by one until all have appeared */
411 /* All strokes start at the same time */
413 /* Only the new strokes are built */
415};
416
418 /* Show in forward order */
420 /* Hide in reverse order */
422 /* Hide in forward order */
424};
425
427 /* All strokes start at same time */
429 /* All strokes end at same time */
431
432 /* TODO: Random Offsets, Stretch-to-Fill */
433};
434
443
444enum eBuildGpencil_Flag : short {
445 /* Restrict modifier to particular layer/passes? */
448
449 /* Restrict modifier to only operating between the nominated frames */
453};
455
518
527
530 struct Object *object = nullptr;
532 struct Material *material = nullptr;
534 char layername[64] = "";
538 char vgname[64] = "";
540 int pass_index = 0;
543 float strength = 1.0f;
545 int layer_pass = 0;
547 struct LatticeDeformData *cache_data = nullptr;
548};
549
553 struct Material *material = nullptr;
555 char layername[64] = "";
557 int pass_index = 0;
561 int layer_pass = 0;
563 float start_fac = 0.1f, end_fac = 0.1f;
565 float rand_start_fac = 0.0f, rand_end_fac = 0.0f, rand_offset = 0.0f;
567 float overshoot_fac = 0.1f;
569 int seed = 0;
571 int step = 4;
573 int mode = 0;
574 char _pad[4] = {};
575 /* Curvature parameters. */
576 float point_density = 30.0f;
577 float segment_influence = 0.0f;
578 float max_angle = DEG2RAD(170.0f);
579};
580
589
591 char name[64] = "";
592 /* For path reference. */
593 struct DashGpencilModifierData *dmd = nullptr;
594 int dash = 2;
595 int gap = 1;
596 float radius = 1.0f;
597 float opacity = 1.0f;
598 int mat_nr = -1;
599 int flag = 0;
600};
601
621
633
651
661
673
676
677 struct Object *object = nullptr;
679 struct Material *material = nullptr;
681 char subtarget[/*MAX_NAME*/ 64] = "";
683 char layername[/*MAX_NAME*/ 64] = "";
688 DNA_DEPRECATED char materialname[/*MAX_ID_NAME - 194*/ 64] = "";
690 char vgname[/*MAX_VGROUP_NAME*/ 64] = "";
692 int pass_index = 0;
694 int layer_pass = 0;
695 char _pad[4] = {};
696
699 char _pad1[3] = {};
703 float cent[3] = {0.0f, 0.0f, 0.0f};
705 float falloff = 0.0f;
706 float force = 0.5f;
707 struct CurveMapping *curfalloff = nullptr;
708};
709
717
719 /* Keep only one vertex every n vertices */
721 /* Use RDP algorithm */
723 /* Sample the stroke using a fixed length */
725 /* Sample the stroke doing vertex merge */
727};
728
756
763
773
777 struct Material *material = nullptr;
779 char layername[64] = "";
783 char vgname[/*MAX_VGROUP_NAME*/ 64] = "";
785 int pass_index = 0;
788 float loc[3] = {0.0f, 0.0f, 0.0f};
789 float rot[3] = {0.0f, 0.0f, 0.0f};
790 float scale[3] = {0.0f, 0.0f, 0.0f};
792 float rnd_offset[3] = {};
794 float rnd_rot[3] = {};
796 float rnd_scale[3] = {};
798 int seed = 0;
800 int stroke_step = 1;
802 int layer_pass = 0;
803 char _pad[4] = {};
804};
805
820
824 struct Material *material = nullptr;
826 char layername[64] = "";
830 char vgname[/*MAX_VGROUP_NAME*/ 64] = "";
832 int pass_index = 0;
836 float factor = 1.0f;
838 int step = 1;
840 int layer_pass = 0;
841
842 char _pad1[4] = {};
843 struct CurveMapping *curve_intensity = nullptr;
844};
845
850 int _pad = {};
851 struct Object *object = nullptr;
853 float (*vert_coords_prev)[3] = nullptr;
854 char vgname[/*MAX_VGROUP_NAME*/ 64] = "";
855};
856
858 /* GP_MULTIPLY_ENABLE_ANGLE_SPLITTING = (1 << 1), Deprecated. */
860};
862
866 struct Material *material = nullptr;
868 char layername[64] = "";
872 int pass_index = 0;
874 int flag = 0;
876 int layer_pass = 0;
877
879
881 float distance = 0.1f;
882 /* -1:inner 0:middle 1:outer */
883 float offset = 0.0f;
884
885 float fading_center = 0.5f;
886 float fading_thickness = 0.5f;
887 float fading_opacity = 0.5f;
888};
889
894
905
908
909 struct Object *object = nullptr;
911 struct Material *material = nullptr;
913 char layername[64] = "";
917 char vgname[/*MAX_VGROUP_NAME*/ 64] = "";
919 int pass_index = 0;
921 int layer_pass = 0;
926
927 float factor = 0.5f;
928 float radius = 1.0f;
930 float rgb[3] = {1.0f, 1.0f, 1.0f};
933
934 struct CurveMapping *curve_intensity = nullptr;
935
936 struct ColorBand *colorband = nullptr;
937};
938
947
948/* Texture->mode */
954
958 struct Material *material = nullptr;
960 char layername[64] = "";
964 char vgname[/*MAX_VGROUP_NAME*/ 64] = "";
966 int pass_index = 0;
970 float uv_offset = 0.0f;
971 float uv_scale = 1.0f;
972 float fill_rotation = 0.0f;
973 float fill_offset[2] = {0.0f, 0.0f};
974 float fill_scale = 1.0f;
976 int layer_pass = 0;
982 char _pad[4] = {};
983};
984
995
999 char target_vgname[/*MAX_VGROUP_NAME*/ 64] = "";
1001 struct Material *material = nullptr;
1003 char layername[64] = "";
1005 char vgname[/*MAX_VGROUP_NAME*/ 64] = "";
1007 int pass_index = 0;
1011 float min_weight = 0;
1013 int layer_pass = 0;
1015 float dist_start = 0.0f;
1016 float dist_end = 20.0f;
1017
1019 struct Object *object = nullptr;
1020};
1021
1025 char target_vgname[/*MAX_VGROUP_NAME*/ 64] = "";
1027 struct Material *material = nullptr;
1029 char layername[64] = "";
1031 char vgname[/*MAX_VGROUP_NAME*/ 64] = "";
1033 int pass_index = 0;
1037 float min_weight = 0;
1039 int layer_pass = 0;
1041 short axis = 1;
1043 short space = 0;
1045 float angle = 0;
1046};
1047
1048/* This enum is for modifier internal state only. */
1050 /* These two moved to #eLineartMainFlags to keep consistent with flag variable purpose. */
1051 /* MOD_LINEART_INVERT_SOURCE_VGROUP = (1 << 0), */
1052 /* MOD_LINEART_MATCH_OUTPUT_VGROUP = (1 << 1), */
1053 MOD_LINEART_BINARY_WEIGHTS = (1 << 2) /* Deprecated, this is removed for lack of use case. */,
1059};
1061
1062struct LineartCache;
1063
1066
1068 MOD_LINEART_EDGE_FLAG_INIT_TYPE; /* line type enable flags, bits in eLineartEdgeFlag */
1069
1071 char source_type = 0;
1072
1074 short level_start = 0;
1075 short level_end = 0;
1076
1077 struct Object *source_camera = nullptr;
1078 struct Object *light_contour_object = nullptr;
1079
1080 struct Object *source_object = nullptr;
1082
1083 struct Material *target_material = nullptr;
1084 char target_layer[64] = "";
1085
1090 char source_vertex_group[64] = "";
1091 char vgname[64] = "";
1092
1093 /* Camera focal length is divided by (1 + over-scan), before calculation, which give a wider FOV,
1094 * this doesn't change coordinates range internally (-1, 1), but makes the calculated frame
1095 * bigger than actual output. This is for the easier shifting calculation. A value of 0.5 means
1096 * the "internal" focal length become 2/3 of the actual camera. */
1097 float overscan = 0.1f;
1098
1099 /* Values for point light and directional (sun) light. */
1100 /* For point light, fov always gonna be 120 deg horizontal, with 3 "cameras" covering 360 deg. */
1102 float shadow_camera_size = 200.0f;
1104 float shadow_camera_far = 200.0f;
1105
1106 float opacity = 1.0f;
1107 short thickness = 25;
1108
1109 unsigned char mask_switches = 0; /* #GreasePencilLineartMaskSwitches */
1110 unsigned char material_mask_bits = 0;
1111 unsigned char intersection_mask = 0;
1112
1113 unsigned char shadow_selection = 0;
1114 unsigned char silhouette_selection = 0;
1115 char _pad[1] = {};
1116
1118 float crease_threshold = DEG2RAD(140.0f);
1119
1122
1125
1126 /* CPU mode */
1128
1129 /* For one time calculation. */
1135
1136 /* Modifier internal state. */
1138
1139 /* Move strokes towards camera to avoid clipping while preserve depth for the viewport. */
1141
1142 /* Runtime data. */
1143
1144 /* Because we can potentially only compute features lines once per modifier stack (Use Cache), we
1145 * need to have these override values to ensure that we have the data we need is computed and
1146 * stored in the cache. */
1152
1153 char _pad2[6] = {};
1154
1155 struct LineartCache *cache = nullptr;
1157 struct LineartData *la_data_ptr = nullptr;
1158};
1159
1165 /* Keep next bit as is to be equals to mesh modifier flag to reuse functions. */
1167};
1169
1173 struct Object *target = nullptr;
1175 struct Object *aux_target = nullptr;
1177 struct Material *material = nullptr;
1179 char layername[64] = "";
1181 char vgname[/*MAX_VGROUP_NAME*/ 64] = "";
1183 int pass_index = 0;
1187 int layer_pass = 0;
1189 float keep_dist = 0.05f;
1195 char shrink_mode = 0;
1197 float proj_limit = 0.0f;
1199 char proj_axis = 0;
1200
1206 char _pad[6] = {};
1208 float smooth_factor = 0.05f;
1211
1214};
1215
1224
1230
1234 struct Material *material = nullptr;
1236 char layername[64] = "";
1238 char vgname[/*MAX_VGROUP_NAME*/ 64] = "";
1240 int pass_index = 0;
1245 int mat_nr = -1;
1247 float thickness = 1.0f;
1249 float strength = 1.0f;
1251 int skip = 0;
1253 int layer_pass = 0;
1254 /* Length of the envelope effect. */
1255 int spread = 10;
1256
1257 char _pad[4] = {};
1258};
1259
1260} // namespace blender
#define ENUM_OPERATORS(_enum_type)
#define DEG2RAD(_deg)
#define DNA_DEPRECATED
Definition DNA_defs.h:21
#define MOD_LINEART_EDGE_FLAG_INIT_TYPE
#define _DNA_DEFAULT_UNIT_M4
ENUM_OPERATORS(Layer::Flags)
BMesh Iterators.
unsigned short uint16_t
Definition BKE_text.h:80
@ MOD_SHRINKWRAP_NEAREST_SURFACE
@ MOD_SHRINKWRAP_PROJECT_ALLOW_POS_DIR
@ MOD_LINEART_ALLOW_CLIPPING_BOUNDARIES
@ MOD_LINEART_USE_CREASE_ON_SHARP_EDGES
@ MOD_LINEART_ALLOW_DUPLI_OBJECTS
@ MOD_LINEART_MATCH_OUTPUT_VGROUP
@ MOD_LINEART_FILTER_FACE_MARK_KEEP_CONTOUR
KERNEL_FEATURE_LIGHT_PASSES KERNEL_FEATURE_PATH_GUIDING float
#define DNA_DEPRECATED_ALLOW
Definition versioning.cc:11