Blender  V3.3
MOD_lattice.c
Go to the documentation of this file.
1 /* SPDX-License-Identifier: GPL-2.0-or-later
2  * Copyright 2005 Blender Foundation. All rights reserved. */
3 
8 #include <string.h>
9 
10 #include "BLI_utildefines.h"
11 
12 #include "BLT_translation.h"
13 
14 #include "DNA_defaults.h"
15 #include "DNA_object_types.h"
16 #include "DNA_screen_types.h"
17 
18 #include "BKE_context.h"
19 #include "BKE_editmesh.h"
20 #include "BKE_lattice.h"
21 #include "BKE_lib_id.h"
22 #include "BKE_lib_query.h"
23 #include "BKE_mesh.h"
24 #include "BKE_mesh_wrapper.h"
25 #include "BKE_modifier.h"
26 #include "BKE_screen.h"
27 
28 #include "UI_interface.h"
29 #include "UI_resources.h"
30 
31 #include "RNA_access.h"
32 #include "RNA_prototypes.h"
33 
34 #include "DEG_depsgraph_query.h"
35 
36 #include "MEM_guardedalloc.h"
37 
38 #include "MOD_ui_common.h"
39 #include "MOD_util.h"
40 
41 static void initData(ModifierData *md)
42 {
44 
46 
48 }
49 
50 static void requiredDataMask(Object *UNUSED(ob),
51  ModifierData *md,
52  CustomData_MeshMasks *r_cddata_masks)
53 {
55 
56  /* ask for vertexgroups if we need them */
57  if (lmd->name[0] != '\0') {
58  r_cddata_masks->vmask |= CD_MASK_MDEFORMVERT;
59  }
60 }
61 
62 static bool isDisabled(const struct Scene *UNUSED(scene),
63  ModifierData *md,
64  bool UNUSED(userRenderParams))
65 {
67 
68  /* The object type check is only needed here in case we have a placeholder
69  * object assigned (because the library containing the lattice is missing).
70  *
71  * In other cases it should be impossible to have a type mismatch.
72  */
73  return !lmd->object || lmd->object->type != OB_LATTICE;
74 }
75 
76 static void foreachIDLink(ModifierData *md, Object *ob, IDWalkFunc walk, void *userData)
77 {
79 
80  walk(userData, ob, (ID **)&lmd->object, IDWALK_CB_NOP);
81 }
82 
84 {
86  if (lmd->object != NULL) {
87  DEG_add_object_relation(ctx->node, lmd->object, DEG_OB_COMP_GEOMETRY, "Lattice Modifier");
88  DEG_add_object_relation(ctx->node, lmd->object, DEG_OB_COMP_TRANSFORM, "Lattice Modifier");
89  }
90  DEG_add_modifier_to_transform_relation(ctx->node, "Lattice Modifier");
91 }
92 
93 static void deformVerts(ModifierData *md,
94  const ModifierEvalContext *ctx,
95  struct Mesh *mesh,
96  float (*vertexCos)[3],
97  int verts_num)
98 {
100  struct Mesh *mesh_src = MOD_deform_mesh_eval_get(
101  ctx->object, NULL, mesh, NULL, verts_num, false, false);
102 
103  MOD_previous_vcos_store(md, vertexCos); /* if next modifier needs original vertices */
104 
106  ctx->object,
107  vertexCos,
108  verts_num,
109  lmd->flag,
110  lmd->name,
111  lmd->strength,
112  mesh_src);
113 
114  if (!ELEM(mesh_src, NULL, mesh)) {
115  BKE_id_free(NULL, mesh_src);
116  }
117 }
118 
119 static void deformVertsEM(ModifierData *md,
120  const ModifierEvalContext *ctx,
121  struct BMEditMesh *em,
122  struct Mesh *mesh,
123  float (*vertexCos)[3],
124  int verts_num)
125 {
126  if (mesh != NULL) {
127  deformVerts(md, ctx, mesh, vertexCos, verts_num);
128  return;
129  }
130 
132 
133  MOD_previous_vcos_store(md, vertexCos); /* if next modifier needs original vertices */
134 
136  lmd->object, ctx->object, vertexCos, verts_num, lmd->flag, lmd->name, lmd->strength, em);
137 }
138 
139 static void panel_draw(const bContext *UNUSED(C), Panel *panel)
140 {
141  uiLayout *layout = panel->layout;
142 
143  PointerRNA ob_ptr;
145 
146  uiLayoutSetPropSep(layout, true);
147 
148  uiItemR(layout, ptr, "object", 0, NULL, ICON_NONE);
149 
150  modifier_vgroup_ui(layout, ptr, &ob_ptr, "vertex_group", "invert_vertex_group", NULL);
151 
152  uiItemR(layout, ptr, "strength", UI_ITEM_R_SLIDER, NULL, ICON_NONE);
153 
154  modifier_panel_end(layout, ptr);
155 }
156 
157 static void panelRegister(ARegionType *region_type)
158 {
160 }
161 
163  /* name */ N_("Lattice"),
164  /* structName */ "LatticeModifierData",
165  /* structSize */ sizeof(LatticeModifierData),
166  /* srna */ &RNA_LatticeModifier,
167  /* type */ eModifierTypeType_OnlyDeform,
170  /* icon */ ICON_MOD_LATTICE,
171 
172  /* copyData */ BKE_modifier_copydata_generic,
173 
174  /* deformVerts */ deformVerts,
175  /* deformMatrices */ NULL,
176  /* deformVertsEM */ deformVertsEM,
177  /* deformMatricesEM */ NULL,
178  /* modifyMesh */ NULL,
179  /* modifyGeometrySet */ NULL,
180 
181  /* initData */ initData,
182  /* requiredDataMask */ requiredDataMask,
183  /* freeData */ NULL,
184  /* isDisabled */ isDisabled,
185  /* updateDepsgraph */ updateDepsgraph,
186  /* dependsOnTime */ NULL,
187  /* dependsOnNormals */ NULL,
188  /* foreachIDLink */ foreachIDLink,
189  /* foreachTexLink */ NULL,
190  /* freeRuntimeData */ NULL,
191  /* panelRegister */ panelRegister,
192  /* blendWrite */ NULL,
193  /* blendRead */ NULL,
194 };
void BKE_lattice_deform_coords_with_mesh(const struct Object *ob_lattice, const struct Object *ob_target, float(*vert_coords)[3], int vert_coords_len, short flag, const char *defgrp_name, float fac, const struct Mesh *me_target)
void BKE_lattice_deform_coords_with_editmesh(const struct Object *ob_lattice, const struct Object *ob_target, float(*vert_coords)[3], int vert_coords_len, short flag, const char *defgrp_name, float fac, struct BMEditMesh *em_target)
void BKE_id_free(struct Main *bmain, void *idv)
@ IDWALK_CB_NOP
Definition: BKE_lib_query.h:33
void(* IDWalkFunc)(void *userData, struct Object *ob, struct ID **idpoin, int cb_flag)
Definition: BKE_modifier.h:107
@ eModifierTypeFlag_AcceptsCVs
Definition: BKE_modifier.h:67
@ eModifierTypeFlag_SupportsEditmode
Definition: BKE_modifier.h:69
@ eModifierTypeFlag_AcceptsVertexCosOnly
Definition: BKE_modifier.h:100
void BKE_modifier_copydata_generic(const struct ModifierData *md, struct ModifierData *md_dst, int flag)
@ eModifierTypeType_OnlyDeform
Definition: BKE_modifier.h:44
#define BLI_assert(a)
Definition: BLI_assert.h:46
#define UNUSED(x)
#define ELEM(...)
#define MEMCMP_STRUCT_AFTER_IS_ZERO(struct_var, member)
#define MEMCPY_STRUCT_AFTER(struct_dst, struct_src, member)
void DEG_add_object_relation(struct DepsNodeHandle *node_handle, struct Object *object, eDepsObjectComponentType component, const char *description)
void DEG_add_modifier_to_transform_relation(struct DepsNodeHandle *node_handle, const char *description)
@ DEG_OB_COMP_GEOMETRY
@ DEG_OB_COMP_TRANSFORM
#define CD_MASK_MDEFORMVERT
#define DNA_struct_default_get(struct_name)
Definition: DNA_defaults.h:29
@ eModifierType_Lattice
struct LatticeModifierData LatticeModifierData
Object is a sort of wrapper for general info.
@ OB_LATTICE
Read Guarded memory(de)allocation.
static bool isDisabled(const struct Scene *UNUSED(scene), ModifierData *md, bool UNUSED(userRenderParams))
Definition: MOD_lattice.c:62
static void updateDepsgraph(ModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
Definition: MOD_lattice.c:83
static void deformVertsEM(ModifierData *md, const ModifierEvalContext *ctx, struct BMEditMesh *em, struct Mesh *mesh, float(*vertexCos)[3], int verts_num)
Definition: MOD_lattice.c:119
static void deformVerts(ModifierData *md, const ModifierEvalContext *ctx, struct Mesh *mesh, float(*vertexCos)[3], int verts_num)
Definition: MOD_lattice.c:93
static void foreachIDLink(ModifierData *md, Object *ob, IDWalkFunc walk, void *userData)
Definition: MOD_lattice.c:76
ModifierTypeInfo modifierType_Lattice
Definition: MOD_lattice.c:162
static void panel_draw(const bContext *UNUSED(C), Panel *panel)
Definition: MOD_lattice.c:139
static void initData(ModifierData *md)
Definition: MOD_lattice.c:41
static void panelRegister(ARegionType *region_type)
Definition: MOD_lattice.c:157
static void requiredDataMask(Object *UNUSED(ob), ModifierData *md, CustomData_MeshMasks *r_cddata_masks)
Definition: MOD_lattice.c:50
PointerRNA * modifier_panel_get_property_pointers(Panel *panel, PointerRNA *r_ob_ptr)
void modifier_panel_end(uiLayout *layout, PointerRNA *ptr)
Definition: MOD_ui_common.c:91
PanelType * modifier_panel_register(ARegionType *region_type, ModifierType type, PanelDrawFn draw)
void modifier_vgroup_ui(uiLayout *layout, PointerRNA *ptr, PointerRNA *ob_ptr, const char *vgroup_prop, const char *invert_vgroup_prop, const char *text)
Mesh * MOD_deform_mesh_eval_get(Object *ob, struct BMEditMesh *em, Mesh *mesh, const float(*vertexCos)[3], const int verts_num, const bool use_normals, const bool use_orco)
Definition: MOD_util.c:167
void MOD_previous_vcos_store(ModifierData *md, const float(*vert_coords)[3])
Definition: MOD_util.c:153
#define C
Definition: RandGen.cpp:25
void uiLayoutSetPropSep(uiLayout *layout, bool is_sep)
@ UI_ITEM_R_SLIDER
void uiItemR(uiLayout *layout, struct PointerRNA *ptr, const char *propname, int flag, const char *name, int icon)
Scene scene
Definition: DNA_ID.h:368
struct Object * object
struct Object * object
Definition: BKE_modifier.h:141
struct DepsNodeHandle * node
Definition: BKE_modifier.h:134
struct uiLayout * layout
#define N_(msgid)
PointerRNA * ptr
Definition: wm_files.c:3480