Blender V5.3
MOD_wireframe.cc
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#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_deform.hh"
20#include "BKE_mesh.hh"
21
23#include "UI_resources.hh"
24
25#include "RNA_access.hh"
26#include "RNA_prototypes.hh"
27
28#include "MOD_modifiertypes.hh"
29#include "MOD_ui_common.hh"
30
31#include "bmesh.hh"
33
34namespace blender {
35
36static void init_data(ModifierData *md)
37{
38 WireframeModifierData *wmd = reinterpret_cast<WireframeModifierData *>(md);
40}
41
42static void required_data_mask(ModifierData *md, CustomData_MeshMasks *r_cddata_masks)
43{
44 WireframeModifierData *wmd = reinterpret_cast<WireframeModifierData *>(md);
45
46 /* Ask for vertex-groups if we need them. */
47 if (wmd->defgrp_name[0] != '\0') {
48 r_cddata_masks->vmask |= CD_MASK_MDEFORMVERT;
49 }
50}
51
53{
54 Mesh *result;
55 BMesh *bm;
56
57 const int defgrp_index = BKE_id_defgroup_name_index(&mesh->id, wmd->defgrp_name);
58
59 BMeshCreateParams create_params{};
60 BMeshFromMeshParams convert_params{};
61 convert_params.calc_face_normal = true;
62 convert_params.calc_vert_normal = true;
63 convert_params.add_key_index = false;
64 convert_params.use_shapekey = false;
65 convert_params.active_shapekey = 0;
66 convert_params.cd_mask_extra.vmask = CD_MASK_ORIGINDEX;
67 convert_params.cd_mask_extra.emask = CD_MASK_ORIGINDEX;
68 convert_params.cd_mask_extra.pmask = CD_MASK_ORIGINDEX;
69
70 bm = BKE_mesh_to_bmesh_ex(mesh, &create_params, &convert_params);
71
73 wmd->offset,
74 wmd->offset_fac,
75 wmd->offset_fac_vg,
76 (wmd->flag & MOD_WIREFRAME_REPLACE) != 0,
77 (wmd->flag & MOD_WIREFRAME_BOUNDARY) != 0,
78 (wmd->flag & MOD_WIREFRAME_OFS_EVEN) != 0,
79 (wmd->flag & MOD_WIREFRAME_OFS_RELATIVE) != 0,
80 (wmd->flag & MOD_WIREFRAME_CREASE) != 0,
81 wmd->crease_weight,
82 defgrp_index,
84 wmd->mat_ofs,
85 std::max(ob->totcol - 1, 0),
86 false);
87
90
91 return result;
92}
93
95{
96 return WireframeModifier_do(reinterpret_cast<WireframeModifierData *>(md), ctx->object, mesh);
97}
98
99static void panel_draw(const bContext * /*C*/, Panel *panel)
100{
101 ui::Layout &layout = *panel->layout;
102
103 PointerRNA ob_ptr;
105
106 layout.use_property_split_set(true);
107
108 layout.prop(ptr, "thickness", UI_ITEM_NONE, IFACE_("Thickness"), ICON_NONE);
109 layout.prop(ptr, "offset", UI_ITEM_NONE, std::nullopt, ICON_NONE);
110
111 ui::Layout *col = &layout.column(true);
112 col->prop(ptr, "use_boundary", UI_ITEM_NONE, IFACE_("Boundary"), ICON_NONE);
113 col->prop(ptr, "use_replace", UI_ITEM_NONE, IFACE_("Replace Original"), ICON_NONE);
114
115 col = &layout.column(true, IFACE_("Thickness"));
116 col->prop(ptr, "use_even_offset", UI_ITEM_NONE, IFACE_("Even"), ICON_NONE);
117 col->prop(ptr, "use_relative_offset", UI_ITEM_NONE, IFACE_("Relative"), ICON_NONE);
118
119 ui::Layout &row = layout.row(true, IFACE_("Crease Edges"));
120 row.prop(ptr, "use_crease", UI_ITEM_NONE, "", ICON_NONE);
121 ui::Layout &sub = row.row(true);
122 sub.active_set(RNA_boolean_get(ptr, "use_crease"));
123 sub.prop(ptr, "crease_weight", ui::ITEM_R_SLIDER, "", ICON_NONE);
124
125 layout.prop(ptr, "material_offset", UI_ITEM_NONE, IFACE_("Material Offset"), ICON_NONE);
126
127 modifier_error_message_draw(layout, ptr);
128}
129
130static void vertex_group_panel_draw(const bContext * /*C*/, Panel *panel)
131{
132 ui::Layout &layout = *panel->layout;
133
134 PointerRNA ob_ptr;
136
137 bool has_vertex_group = RNA_string_length(ptr, "vertex_group") != 0;
138
139 layout.use_property_split_set(true);
140
141 modifier_vgroup_ui(layout, ptr, &ob_ptr, "vertex_group", "invert_vertex_group", std::nullopt);
142
143 ui::Layout &row = layout.row(true);
144 row.active_set(has_vertex_group);
145 row.prop(ptr, "thickness_vertex_group", UI_ITEM_NONE, IFACE_("Factor"), ICON_NONE);
146}
147
148static void panel_register(ARegionType *region_type)
149{
151 region_type, eModifierType_Wireframe, panel_draw);
153 region_type, "vertex_group", "Vertex Group", nullptr, vertex_group_panel_draw, panel_type);
154}
155
157 /*idname*/ "Wireframe",
158 /*name*/ N_("Wireframe"),
159 /*struct_name*/ "WireframeModifierData",
160 /*struct_size*/ sizeof(WireframeModifierData),
161 /*srna*/ &RNA_WireframeModifier,
164 /*icon*/ ICON_MOD_WIREFRAME,
165
166 /*copy_data*/ BKE_modifier_copydata_generic,
167
168 /*deform_verts*/ nullptr,
169 /*deform_matrices*/ nullptr,
170 /*deform_verts_EM*/ nullptr,
171 /*deform_matrices_EM*/ nullptr,
172 /*modify_mesh*/ modify_mesh,
173 /*modify_geometry_set*/ nullptr,
174
175 /*init_data*/ init_data,
176 /*required_data_mask*/ required_data_mask,
177 /*free_data*/ nullptr,
178 /*is_disabled*/ nullptr,
179 /*update_depsgraph*/ nullptr,
180 /*depends_on_time*/ nullptr,
181 /*depends_on_normals*/ nullptr,
182 /*foreach_ID_link*/ nullptr,
183 /*foreach_tex_link*/ nullptr,
184 /*free_runtime_data*/ nullptr,
185 /*panel_register*/ panel_register,
186 /*blend_write*/ nullptr,
187 /*blend_read*/ nullptr,
188 /*foreach_cache*/ nullptr,
189 /*foreach_working_space_color*/ nullptr,
190};
191
192} // 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_ORIGINDEX
#define CD_MASK_MDEFORMVERT
BMesh Iterators.
PointerRNA * modifier_panel_get_property_pointers(Panel *panel, PointerRNA *r_ob_ptr)
void BM_mesh_free(BMesh *bm)
BMesh Free Mesh.
static void vertex_group_panel_draw(const bContext *, Panel *panel)
static void init_data(ModifierData *md)
static Mesh * WireframeModifier_do(WireframeModifierData *wmd, Object *ob, Mesh *mesh)
int BKE_id_defgroup_name_index(const ID *id, StringRef name)
Definition deform.cc:557
static void required_data_mask(ModifierData *, CustomData_MeshMasks *r_cddata_masks)
void modifier_error_message_draw(ui::Layout &layout, PointerRNA *ptr)
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)
BMesh * BKE_mesh_to_bmesh_ex(const Mesh *mesh, const BMeshCreateParams *create_params, const BMeshFromMeshParams *convert_params)
static void panel_register(ARegionType *region_type)
bool RNA_boolean_get(PointerRNA *ptr, const char *name)
static Mesh * modify_mesh(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh)
Definition MOD_array.cc:873
void BM_mesh_wireframe(BMesh *bm, const float offset, const float offset_fac, const float offset_fac_vg, const bool use_replace, const bool use_boundary, const bool use_even_offset, const bool use_relative_offset, const bool use_crease, const float crease_weight, const int defgrp_index, const bool defgrp_invert, const short mat_offset, const int mat_max, const bool use_tag)
@ eModifierTypeFlag_SupportsEditmode
@ eModifierTypeFlag_AcceptsMesh
int RNA_string_length(PointerRNA *ptr, const char *name)
ModifierTypeInfo modifierType_Wireframe
Mesh * BKE_mesh_from_bmesh_for_eval_nomain(BMesh *bm, const CustomData_MeshMasks *cd_mask_extra, const Mesh *me_settings)
PanelType * modifier_panel_register(ARegionType *region_type, ModifierType type, PanelDrawFn draw)
static void panel_draw(const bContext *, Panel *panel)
PanelType * modifier_subpanel_register(ARegionType *region_type, const char *name, const char *label, PanelDrawFn draw_header, PanelDrawFn draw, PanelType *parent)
void BKE_modifier_copydata_generic(const ModifierData *md, ModifierData *md_dst, int flag)
struct CustomData_MeshMasks cd_mask_extra
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)
void active_set(bool active)
Layout & column(bool align)
Layout & row(bool align)
#define N_(msgid)