Blender V5.3
MOD_grease_pencil_mirror.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2024 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include "BLI_math_matrix.hh"
10
11#include "DNA_modifier_types.h"
12
13#include "BKE_curves.hh"
14#include "BKE_geometry_set.hh"
15#include "BKE_grease_pencil.hh"
16#include "BKE_instances.hh"
17#include "BKE_lib_query.hh"
18#include "BKE_modifier.hh"
19
20#include "BLO_read_write.hh"
21
23
25#include "UI_resources.hh"
26
27#include "BLT_translation.hh"
28
29#include "WM_types.hh"
30
31#include "RNA_prototypes.hh"
32
34#include "MOD_ui_common.hh"
35
36namespace blender {
37
38static void init_data(ModifierData *md)
39{
40 auto *mmd = reinterpret_cast<GreasePencilMirrorModifierData *>(md);
42 modifier::greasepencil::init_influence_data(&mmd->influence, false);
43}
44
45static void copy_data(const ModifierData *md, ModifierData *target, const int flag)
46{
47 const auto *mmd = reinterpret_cast<const GreasePencilMirrorModifierData *>(md);
48 auto *tmmd = reinterpret_cast<GreasePencilMirrorModifierData *>(target);
49
51
52 BKE_modifier_copydata_generic(md, target, flag);
53 modifier::greasepencil::copy_influence_data(&mmd->influence, &tmmd->influence, flag);
54}
55
56static void free_data(ModifierData *md)
57{
58 auto *mmd = reinterpret_cast<GreasePencilMirrorModifierData *>(md);
60}
61
62static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
63{
64 auto *mmd = reinterpret_cast<GreasePencilMirrorModifierData *>(md);
65 walk(user_data, ob, reinterpret_cast<ID **>(&mmd->object), IDWALK_CB_NOP);
66 modifier::greasepencil::foreach_influence_ID_link(&mmd->influence, ob, walk, user_data);
67}
68
70{
71 auto *mmd = reinterpret_cast<GreasePencilMirrorModifierData *>(md);
72 if (mmd->object != nullptr) {
74 ctx->node, mmd->object, DEG_OB_COMP_TRANSFORM, "Grease Pencil Mirror Modifier");
75 DEG_add_depends_on_transform_relation(ctx->node, "Grease Pencil Mirror Modifier");
76 }
77}
78
81 const bool mirror_x,
82 const bool mirror_y,
83 const bool mirror_z)
84{
86 float3(mirror_x ? -1.0f : 1.0f, mirror_y ? -1.0f : 1.0f, mirror_z ? -1.0f : 1.0f));
87
88 if (mmd.object) {
89 /* Transforms from parent object space to target object space. */
90 const float4x4 to_target = math::invert(mmd.object->object_to_world()) * ob.object_to_world();
91 /* Mirror points in the target object space. */
92 matrix = math::invert(to_target) * matrix * to_target;
93 }
94 return matrix;
95}
96
99 const bke::CurvesGeometry &base_curves,
100 const bke::CurvesGeometry &mirror_curves)
101{
102 const bool use_mirror_x = (mmd.flag & MOD_GREASE_PENCIL_MIRROR_AXIS_X);
103 const bool use_mirror_y = (mmd.flag & MOD_GREASE_PENCIL_MIRROR_AXIS_Y);
104 const bool use_mirror_z = (mmd.flag & MOD_GREASE_PENCIL_MIRROR_AXIS_Z);
105
106 Curves *base_curves_id = bke::curves_new_nomain(base_curves);
107 Curves *mirror_curves_id = bke::curves_new_nomain(mirror_curves);
108 bke::GeometrySet base_geo = bke::GeometrySet::from_curves(base_curves_id);
109 bke::GeometrySet mirror_geo = bke::GeometrySet::from_curves(mirror_curves_id);
110
111 std::unique_ptr<bke::Instances> instances = std::make_unique<bke::Instances>();
112 const int base_handle = instances->add_reference(bke::InstanceReference{base_geo});
113 const int mirror_handle = instances->add_reference(bke::InstanceReference{mirror_geo});
114
115 Vector<int> handles;
116 Vector<float4x4> transforms;
117 for (const int mirror_x : IndexRange(use_mirror_x ? 2 : 1)) {
118 for (const int mirror_y : IndexRange(use_mirror_y ? 2 : 1)) {
119 for (const int mirror_z : IndexRange(use_mirror_z ? 2 : 1)) {
120 if (mirror_x == 0 && mirror_y == 0 && mirror_z == 0) {
121 handles.append(base_handle);
122 transforms.append(float4x4::identity());
123 }
124 else {
125 const float4x4 matrix = get_mirror_matrix(
126 ob, mmd, bool(mirror_x), bool(mirror_y), bool(mirror_z));
127 handles.append(mirror_handle);
128 transforms.append(matrix);
129 }
130 }
131 }
132 }
133
134 instances->resize(handles.size());
135 instances->reference_handles_for_write().copy_from(handles);
136 instances->transforms_for_write().copy_from(transforms);
137
139 options.keep_original_ids = true;
140 options.realize_instance_attributes = false;
142 bke::GeometrySet::from_instances(std::move(instances)),
143 options)
144 .geometry;
145 return std::move(result_geo.get_curves_for_write()->geometry.wrap());
146}
147
149 const ModifierEvalContext &ctx,
151{
152 const bool use_mirror_x = (mmd.flag & MOD_GREASE_PENCIL_MIRROR_AXIS_X);
153 const bool use_mirror_y = (mmd.flag & MOD_GREASE_PENCIL_MIRROR_AXIS_Y);
154 const bool use_mirror_z = (mmd.flag & MOD_GREASE_PENCIL_MIRROR_AXIS_Z);
155 if (!use_mirror_x && !use_mirror_y && !use_mirror_z) {
156 return;
157 }
158
159 const bke::CurvesGeometry &src_curves = drawing.strokes();
160 if (src_curves.curve_num == 0) {
161 return;
162 }
163 /* Selected source curves. */
164 IndexMaskMemory curve_mask_memory;
166 ctx.object, src_curves, mmd.influence, curve_mask_memory);
167
168 if (curves_mask.size() == src_curves.curve_num) {
169 /* All geometry gets mirrored. */
170 drawing.strokes_for_write() = create_mirror_copies(*ctx.object, mmd, src_curves, src_curves);
171 }
172 else {
173 /* Create masked geometry, then mirror it. */
175 src_curves, curves_mask, {});
176
178 *ctx.object, mmd, src_curves, masked_curves);
179 }
180
181 drawing.tag_topology_changed();
182}
183
185 const ModifierEvalContext *ctx,
186 bke::GeometrySet *geometry_set)
187{
189
190 auto *mmd = reinterpret_cast<GreasePencilMirrorModifierData *>(md);
191
192 if (!geometry_set->has_grease_pencil()) {
193 return;
194 }
196 const int frame = grease_pencil.runtime->eval_frame;
197
198 IndexMaskMemory mask_memory;
200 grease_pencil, mmd->influence, mask_memory);
201
203 grease_pencil, layer_mask, frame);
205 [&](Drawing *drawing) { modify_drawing(*mmd, *ctx, *drawing); });
206}
207
208static void panel_draw(const bContext *C, Panel *panel)
209{
210 ui::Layout &layout = *panel->layout;
211
212 PointerRNA ob_ptr;
215
216 layout.use_property_split_set(true);
217
218 ui::Layout &row = layout.row(true, IFACE_("Axis"));
219 row.prop(ptr, "use_axis_x", toggles_flag, std::nullopt, ICON_NONE);
220 row.prop(ptr, "use_axis_y", toggles_flag, std::nullopt, ICON_NONE);
221 row.prop(ptr, "use_axis_z", toggles_flag, std::nullopt, ICON_NONE);
222
223 layout.prop(ptr, "object", UI_ITEM_NONE, std::nullopt, ICON_NONE);
224
225 if (ui::Layout *influence_panel = layout.panel_prop(
226 C, ptr, "open_influence_panel", IFACE_("Influence")))
227 {
230 }
231
232 modifier_error_message_draw(layout, ptr);
233}
234
239
240static void blend_write(BlendWriter *writer, const ID * /*id_owner*/, const ModifierData *md)
241{
242 const auto *mmd = reinterpret_cast<const GreasePencilMirrorModifierData *>(md);
243
244 writer->write_struct(mmd);
245 modifier::greasepencil::write_influence_data(writer, &mmd->influence);
246}
247
248static void blend_read(BlendDataReader *reader, ModifierData *md)
249{
250 auto *mmd = reinterpret_cast<GreasePencilMirrorModifierData *>(md);
251
252 modifier::greasepencil::read_influence_data(reader, &mmd->influence);
253}
254
256 /*idname*/ "GreasePencilMirror",
257 /*name*/ N_("Mirror"),
258 /*struct_name*/ "GreasePencilMirrorModifierData",
259 /*struct_size*/ sizeof(GreasePencilMirrorModifierData),
260 /*srna*/ &RNA_GreasePencilMirrorModifier,
264 /*icon*/ ICON_MOD_MIRROR,
265
266 /*copy_data*/ copy_data,
267
268 /*deform_verts*/ nullptr,
269 /*deform_matrices*/ nullptr,
270 /*deform_verts_EM*/ nullptr,
271 /*deform_matrices_EM*/ nullptr,
272 /*modify_mesh*/ nullptr,
273 /*modify_geometry_set*/ modify_geometry_set,
274
275 /*init_data*/ init_data,
276 /*required_data_mask*/ nullptr,
277 /*free_data*/ free_data,
278 /*is_disabled*/ nullptr,
279 /*update_depsgraph*/ update_depsgraph,
280 /*depends_on_time*/ nullptr,
281 /*depends_on_normals*/ nullptr,
282 /*foreach_ID_link*/ foreach_ID_link,
283 /*foreach_tex_link*/ nullptr,
284 /*free_runtime_data*/ nullptr,
285 /*panel_register*/ panel_register,
286 /*blend_write*/ blend_write,
287 /*blend_read*/ blend_read,
288};
289
290} // namespace blender
Low-level operations for curves.
Low-level operations for grease pencil.
#define IFACE_(msgid)
#define C
Definition RandGen.cpp:29
#define UI_ITEM_NONE
#define INIT_DEFAULT_STRUCT_AFTER(struct_dst, member)
constexpr IndexRange()=default
int64_t size() const
void append(const T &value)
bke::CurvesGeometry & strokes_for_write()
const bke::CurvesGeometry & strokes() const
CCL_NAMESPACE_BEGIN struct Options options
CurvesGeometry curves_copy_curve_selection(const CurvesGeometry &curves, const IndexMask &curves_to_copy, const AttributeFilter &attribute_filter)
Curves * curves_new_nomain(int points_num, int curves_num)
RealizeInstancesResult realize_instances(bke::GeometrySet geometry_set, const RealizeInstancesOptions &options)
CartesianBasis invert(const CartesianBasis &basis)
MatT from_scale(const VecBase< typename MatT::base_type, ScaleDim > &scale)
void read_influence_data(BlendDataReader *reader, GreasePencilModifierInfluenceData *influence_data)
void draw_material_filter_settings(const bContext *, ui::Layout &layout, PointerRNA *ptr)
void init_influence_data(GreasePencilModifierInfluenceData *influence_data, const bool has_custom_curve)
void write_influence_data(BlendWriter *writer, const GreasePencilModifierInfluenceData *influence_data)
void draw_layer_filter_settings(const bContext *, ui::Layout &layout, PointerRNA *ptr)
IndexMask get_filtered_layer_mask(const GreasePencil &grease_pencil, const GreasePencilModifierInfluenceData &influence_data, IndexMaskMemory &memory)
Vector< bke::greasepencil::Drawing * > get_drawings_for_write(GreasePencil &grease_pencil, const IndexMask &layer_mask, const int frame)
IndexMask get_filtered_stroke_mask(const Object *ob, const bke::CurvesGeometry &curves, const GreasePencilModifierInfluenceData &influence_data, IndexMaskMemory &memory)
void free_influence_data(GreasePencilModifierInfluenceData *influence_data)
void foreach_influence_ID_link(GreasePencilModifierInfluenceData *influence_data, Object *ob, IDWalkFunc walk, void *user_data)
void copy_influence_data(const GreasePencilModifierInfluenceData *influence_data_src, GreasePencilModifierInfluenceData *influence_data_dst, const int)
void parallel_for_each(Range &&range, const Function &function)
Definition BLI_task.hh:31
BMesh Iterators.
static void copy_data(const ModifierData *md, ModifierData *target, const int flag)
static void blend_write(BlendWriter *writer, const ID *, const ModifierData *md)
Definition MOD_bevel.cc:454
PointerRNA * modifier_panel_get_property_pointers(Panel *panel, PointerRNA *r_ob_ptr)
static bke::CurvesGeometry create_mirror_copies(const Object &ob, const GreasePencilMirrorModifierData &mmd, const bke::CurvesGeometry &base_curves, const bke::CurvesGeometry &mirror_curves)
@ eModifierType_GreasePencilMirror
static void init_data(ModifierData *md)
void(*)(void *user_data, Object *ob, ID **idpoin, LibraryForeachIDCallbackFlag cb_flag) IDWalkFunc
static void update_depsgraph(tGraphSliderOp *gso)
static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
void DEG_add_object_relation(DepsNodeHandle *node_handle, Object *object, eDepsObjectComponentType component, const char *description)
MatBase< float, 4, 4 > float4x4
void DEG_add_depends_on_transform_relation(DepsNodeHandle *node_handle, const char *description)
static void modify_geometry_set(ModifierData *md, const ModifierEvalContext *ctx, bke::GeometrySet *geometry_set)
void modifier_error_message_draw(ui::Layout &layout, PointerRNA *ptr)
static float4x4 get_mirror_matrix(const Object &ob, const GreasePencilMirrorModifierData &mmd, const bool mirror_x, const bool mirror_y, const bool mirror_z)
static void free_data(ModifierData *md)
static void panel_register(ARegionType *region_type)
@ eModifierTypeFlag_SupportsMapping
@ eModifierTypeFlag_AcceptsGreasePencil
@ eModifierTypeFlag_EnableInEditmode
@ eModifierTypeFlag_SupportsEditmode
static void modify_drawing(const GreasePencilArrayModifierData &mmd, const ModifierEvalContext &ctx, bke::greasepencil::Drawing &drawing)
static void blend_read(BlendDataReader *, ModifierData *md)
@ MOD_GREASE_PENCIL_MIRROR_AXIS_X
@ MOD_GREASE_PENCIL_MIRROR_AXIS_Z
@ MOD_GREASE_PENCIL_MIRROR_AXIS_Y
PanelType * modifier_panel_register(ARegionType *region_type, ModifierType type, PanelDrawFn draw)
static void panel_draw(const bContext *, Panel *panel)
VecBase< float, 3 > float3
ModifierTypeInfo modifierType_GreasePencilMirror
void BKE_modifier_copydata_generic(const ModifierData *md, ModifierData *md_dst, int flag)
void write_struct(const T *data, BlendStructWriterTypedFn< T > fn=nullptr)
GreasePencilModifierInfluenceData influence
ui::Layout * layout
static GeometrySet from_curves(Curves *curves, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)
static GeometrySet from_instances(std::unique_ptr< Instances > instances)
GreasePencil * get_grease_pencil_for_write()
void use_property_split_set(bool is_sep)
void prop(PointerRNA *ptr, PropertyRNA *prop, int index, int value, eUI_Item_Flag flag, std::optional< StringRef > name_opt, int icon, std::optional< StringRef > placeholder=std::nullopt)
PanelLayout panel_prop(const bContext *C, PointerRNA *open_prop_owner, StringRefNull open_prop_name)
Layout & row(bool align)
#define N_(msgid)