Blender V5.3
MOD_curve.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2005 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include <cstring>
10
11#include "BLI_utildefines.hh"
12
13#include "BLT_translation.hh"
14
15#include "DNA_mesh_types.h"
16#include "DNA_object_types.h"
17#include "DNA_screen_types.h"
18
19#include "BKE_curve.hh"
20#include "BKE_deform.hh"
21#include "BKE_editmesh.hh"
22#include "BKE_lib_query.hh"
23#include "BKE_mesh.hh"
24#include "BKE_modifier.hh"
25
27#include "UI_resources.hh"
28
29#include "RNA_prototypes.hh"
30#include "RNA_types.hh"
31
32#include "DEG_depsgraph.hh"
34
35#include "MOD_ui_common.hh"
36#include "MOD_util.hh"
37
38namespace blender {
39
40static void init_data(ModifierData *md)
41{
42 CurveModifierData *cmd = reinterpret_cast<CurveModifierData *>(md);
44}
45
46static void required_data_mask(ModifierData *md, CustomData_MeshMasks *r_cddata_masks)
47{
48 CurveModifierData *cmd = reinterpret_cast<CurveModifierData *>(md);
49
50 /* Ask for vertex-groups if we need them. */
51 if (cmd->name[0] != '\0') {
52 r_cddata_masks->vmask |= CD_MASK_MDEFORMVERT;
53 }
54}
55
56static bool is_disabled(const Scene * /*scene*/, ModifierData *md, bool /*use_render_params*/)
57{
58 CurveModifierData *cmd = reinterpret_cast<CurveModifierData *>(md);
59
60 /* The object type check is only needed here in case we have a placeholder
61 * object assigned (because the library containing the curve is missing).
62 *
63 * In other cases it should be impossible to have a type mismatch.
64 */
65 return !cmd->object || cmd->object->type != OB_CURVES_LEGACY;
66}
67
68static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
69{
70 CurveModifierData *cmd = reinterpret_cast<CurveModifierData *>(md);
71
72 walk(user_data, ob, reinterpret_cast<ID **>(&cmd->object), IDWALK_CB_NOP);
73}
74
76{
77 CurveModifierData *cmd = reinterpret_cast<CurveModifierData *>(md);
78 if (cmd->object != nullptr) {
79 /* TODO(sergey): Need to do the same eval_flags trick for path
80 * as happening in legacy depsgraph callback.
81 */
82 /* TODO(sergey): Currently path is evaluated as a part of modifier stack,
83 * might be changed in the future.
84 */
85 DEG_add_object_relation(ctx->node, cmd->object, DEG_OB_COMP_TRANSFORM, "Curve Modifier");
86 DEG_add_object_relation(ctx->node, cmd->object, DEG_OB_COMP_GEOMETRY, "Curve Modifier");
88 }
89
90 DEG_add_depends_on_transform_relation(ctx->node, "Curve Modifier");
91}
92
93static void deform_verts(ModifierData *md,
94 const ModifierEvalContext *ctx,
95 Mesh *mesh,
96 MutableSpan<float3> positions)
97{
98 CurveModifierData *cmd = reinterpret_cast<CurveModifierData *>(md);
99
100 const MDeformVert *dvert = nullptr;
101 int defgrp_index = -1;
102 MOD_get_vgroup(ctx->object, mesh, cmd->name, &dvert, &defgrp_index);
103
104 /* Silly that defaxis and BKE_curve_deform_coords are off by 1
105 * but leave for now to save having to call do_versions */
106 const int defaxis = std::clamp(cmd->defaxis - 1, 0, 5);
108 ctx->object,
109 reinterpret_cast<float (*)[3]>(positions.data()),
110 positions.size(),
111 dvert,
112 defgrp_index,
113 cmd->flag,
114 defaxis);
115}
116
118 const ModifierEvalContext *ctx,
119 Mesh *mesh,
120 MutableSpan<float3> positions)
121{
122 if (mesh->runtime->wrapper_type == ME_WRAPPER_TYPE_MDATA) {
123 deform_verts(md, ctx, mesh, positions);
124 return;
125 }
126
127 CurveModifierData *cmd = reinterpret_cast<CurveModifierData *>(md);
128 bool use_dverts = false;
129 int defgrp_index = -1;
130
131 if (ctx->object->type == OB_MESH && cmd->name[0] != '\0') {
132 defgrp_index = BKE_object_defgroup_name_index(ctx->object, cmd->name);
133 if (defgrp_index != -1) {
134 use_dverts = true;
135 }
136 }
137
138 const int defaxis = std::clamp(cmd->defaxis - 1, 0, 5);
139 if (use_dverts) {
141 ctx->object,
142 reinterpret_cast<float (*)[3]>(positions.data()),
143 positions.size(),
144 defgrp_index,
145 cmd->flag,
146 defaxis,
148 }
149 else {
151 ctx->object,
152 reinterpret_cast<float (*)[3]>(positions.data()),
153 positions.size(),
154 nullptr,
155 defgrp_index,
156 cmd->flag,
157 defaxis);
158 }
159}
160
161static void panel_draw(const bContext * /*C*/, Panel *panel)
162{
163 ui::Layout &layout = *panel->layout;
164
165 PointerRNA ob_ptr;
167
168 layout.use_property_split_set(true);
169
170 layout.prop(ptr, "object", UI_ITEM_NONE, IFACE_("Curve Object"), ICON_NONE);
171 layout.prop(ptr, "deform_axis", UI_ITEM_NONE, std::nullopt, ICON_NONE);
172
173 modifier_vgroup_ui(layout, ptr, &ob_ptr, "vertex_group", "invert_vertex_group", std::nullopt);
174
175 modifier_error_message_draw(layout, ptr);
176}
177
178static void panel_register(ARegionType *region_type)
179{
181}
182
184 /*idname*/ "Curve",
185 /*name*/ N_("Curve"),
186 /*struct_name*/ "CurveModifierData",
187 /*struct_size*/ sizeof(CurveModifierData),
188 /*srna*/ &RNA_CurveModifier,
192 /*icon*/ ICON_MOD_CURVE,
193
194 /*copy_data*/ BKE_modifier_copydata_generic,
195
196 /*deform_verts*/ deform_verts,
197 /*deform_matrices*/ nullptr,
198 /*deform_verts_EM*/ deform_verts_EM,
199 /*deform_matrices_EM*/ nullptr,
200 /*modify_mesh*/ nullptr,
201 /*modify_geometry_set*/ nullptr,
202
203 /*init_data*/ init_data,
204 /*required_data_mask*/ required_data_mask,
205 /*free_data*/ nullptr,
206 /*is_disabled*/ is_disabled,
207 /*update_depsgraph*/ update_depsgraph,
208 /*depends_on_time*/ nullptr,
209 /*depends_on_normals*/ nullptr,
210 /*foreach_ID_link*/ foreach_ID_link,
211 /*foreach_tex_link*/ nullptr,
212 /*free_runtime_data*/ nullptr,
213 /*panel_register*/ panel_register,
214 /*blend_write*/ nullptr,
215 /*blend_read*/ nullptr,
216 /*foreach_cache*/ nullptr,
217 /*foreach_working_space_color*/ nullptr,
218};
219
220} // namespace blender
support for deformation groups and hooks.
#define IFACE_(msgid)
Object is a sort of wrapper for general info.
#define UI_ITEM_NONE
#define INIT_DEFAULT_STRUCT_AFTER(struct_dst, member)
#define CD_MASK_MDEFORMVERT
constexpr int64_t size() const
Definition BLI_span.hh:499
constexpr T * data() const
Definition BLI_span.hh:545
BMesh Iterators.
PointerRNA * modifier_panel_get_property_pointers(Panel *panel, PointerRNA *r_ob_ptr)
void DEG_add_special_eval_flag(DepsNodeHandle *handle, ID *id, uint32_t flag)
void MOD_get_vgroup(const Object *ob, const Mesh *mesh, const char *name, const MDeformVert **dvert, int *defgrp_index)
Definition MOD_util.cc:158
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)
ModifierTypeInfo modifierType_Curve
Definition MOD_curve.cc:183
void DEG_add_object_relation(DepsNodeHandle *node_handle, Object *object, eDepsObjectComponentType component, const char *description)
void DEG_add_depends_on_transform_relation(DepsNodeHandle *node_handle, const char *description)
static void required_data_mask(ModifierData *, CustomData_MeshMasks *r_cddata_masks)
void modifier_error_message_draw(ui::Layout &layout, PointerRNA *ptr)
void BKE_curve_deform_coords(const Object *ob_curve, const Object *ob_target, float(*vert_coords)[3], int vert_coords_len, const MDeformVert *dvert, int defgrp_index, short flag, short defaxis)
void modifier_vgroup_ui(ui::Layout &layout, PointerRNA *ptr, PointerRNA *ob_ptr, const StringRefNull vgroup_prop, const std::optional< StringRefNull > invert_vgroup_prop, const std::optional< StringRefNull > text)
static void deform_verts_EM(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh, MutableSpan< float3 > positions)
static void panel_register(ARegionType *region_type)
void BKE_curve_deform_coords_with_editmesh(const Object *ob_curve, const Object *ob_target, float(*vert_coords)[3], int vert_coords_len, int defgrp_index, short flag, short defaxis, const BMesh &bm_target)
int BKE_object_defgroup_name_index(const Object *ob, StringRef name)
Definition deform.cc:597
@ eModifierTypeFlag_AcceptsCVs
@ eModifierTypeFlag_SupportsEditmode
@ eModifierTypeFlag_AcceptsVertexCosOnly
@ DAG_EVAL_NEED_CURVE_PATH
PanelType * modifier_panel_register(ARegionType *region_type, ModifierType type, PanelDrawFn draw)
const BMesh * BKE_editmesh_bmesh_get(const Object *ob)
Definition editmesh.cc:65
static void panel_draw(const bContext *, Panel *panel)
static void deform_verts(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh, MutableSpan< float3 > positions)
@ ME_WRAPPER_TYPE_MDATA
static bool is_disabled(const Scene *, ModifierData *md, bool)
void BKE_modifier_copydata_generic(const ModifierData *md, ModifierData *md_dst, int flag)
CurveModifierDefaultAxis defaxis
ui::Layout * layout
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)
#define N_(msgid)