Blender V5.3
BKE_modifier.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4#pragma once
5
10#include "BLI_enum_flags.hh"
11#include "BLI_function_ref.hh"
13#include "BLI_span.hh"
14
15#include "BKE_lib_query.hh" /* For LibraryForeachIDCallbackFlag. */
16
18#include "DNA_listBase.h"
19#include "DNA_modifier_types.h" /* Needed for all enum type definitions. */
20
21namespace blender {
22
23namespace bke {
24struct GeometrySet;
25}
26struct ARegionType;
27struct bArmature;
28struct BMEditMesh;
29struct BlendDataReader;
30struct BlendWriter;
32struct DepsNodeHandle;
33struct Depsgraph;
34struct ID;
36struct Main;
37struct Mesh;
38struct ModifierData;
39struct Object;
40struct PointerRNA;
41struct PropertyRNA;
42struct Scene;
43struct StructRNA;
44struct IDCacheKey;
45
77
136
137using IDWalkFunc = void (*)(void *user_data,
138 Object *ob,
139 ID **idpoin,
141using TexWalkFunc = void (*)(void *user_data,
142 Object *ob,
143 ModifierData *md,
144 const PointerRNA *ptr,
145 PropertyRNA *texture_prop);
146
171
177
187
193 char idname[64];
194
196 char name[64];
197
202 char struct_name[64];
203
206
213
216
218 int icon;
219
220 /********************* Non-optional functions *********************/
221
228 void (*copy_data)(const ModifierData *md, ModifierData *target, int flag);
229
230 /********************* Deform modifier functions *********************/
231
238 const ModifierEvalContext *ctx,
239 Mesh *mesh,
240 MutableSpan<float3> positions);
241
246 const ModifierEvalContext *ctx,
247 Mesh *mesh,
248 MutableSpan<float3> positions,
249 MutableSpan<float3x3> matrices);
255 const ModifierEvalContext *ctx,
256 Mesh *mesh,
257 MutableSpan<float3> positions);
258
261 const ModifierEvalContext *ctx,
262 Mesh *mesh,
263 MutableSpan<float3> positions,
264 MutableSpan<float3x3> matrices);
265
266 /********************* Non-deform modifier functions *********************/
267
279 Mesh *(*modify_mesh)(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh);
280
287 const ModifierEvalContext *ctx,
288 bke::GeometrySet *geometry_set);
289
290 /********************* Optional functions *********************/
291
299
315
325
335 bool (*is_disabled)(const Scene *scene, ModifierData *md, bool use_render_params);
336
343
350 bool (*depends_on_time)(Scene *scene, ModifierData *md);
351
358
367 void (*foreach_ID_link)(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data);
368
377 void (*foreach_tex_link)(ModifierData *md, Object *ob, TexWalkFunc walk, void *user_data);
378
390 void (*free_runtime_data)(void *runtime_data);
391
393 void (*panel_register)(ARegionType *region_type);
394
402 void (*blend_write)(BlendWriter *writer, const ID *id_owner, const ModifierData *md);
403
411
416 Object *object,
417 ModifierData *md,
418 FunctionRef<void(const IDCacheKey &cache_key, void **cache_p, uint flags)> fn);
419
425};
426
428#define MODIFIER_TYPE_PANEL_PREFIX "MOD_PT_"
429
431void BKE_modifier_init();
432
433const ModifierTypeInfo *BKE_modifier_get_info(ModifierType type);
434
435/* For modifier UI panels. */
436
440void BKE_modifier_type_panel_id(ModifierType type, char *r_idname);
441void BKE_modifier_panel_expand(ModifierData *md);
442
447ModifierData *BKE_modifier_new(int type);
448
449void BKE_modifier_free_ex(ModifierData *md, int flag);
450void BKE_modifier_free(ModifierData *md);
454void BKE_modifier_remove_from_list(Object *ob, ModifierData *md);
455
456void BKE_modifier_unique_name(ListBaseT<ModifierData> *modifiers, ModifierData *md);
457
458ModifierData *BKE_modifier_copy_ex(const ModifierData *md, int flag);
459
463void BKE_modifier_copydata_generic(const ModifierData *md, ModifierData *md_dst, int flag);
464void BKE_modifier_copydata(const ModifierData *md, ModifierData *target);
465void BKE_modifier_copydata_ex(const ModifierData *md, ModifierData *target, int flag);
466bool BKE_modifier_depends_ontime(Scene *scene, ModifierData *md);
467bool BKE_modifier_supports_mapping(ModifierData *md);
468bool BKE_modifier_supports_cage(Scene *scene, ModifierData *md);
469bool BKE_modifier_couldbe_cage(Scene *scene, ModifierData *md);
470bool BKE_modifier_is_correctable_deformed(ModifierData *md);
471bool BKE_modifier_is_same_topology(ModifierData *md);
472bool BKE_modifier_is_non_geometrical(ModifierData *md);
479bool BKE_modifier_is_enabled(const Scene *scene, ModifierData *md, int required_mode);
486bool BKE_modifier_is_nonlocal_in_liboverride(const Object *ob, const ModifierData *md);
487
492void BKE_modifier_set_error(const Object *ob, ModifierData *md, const char *format, ...)
493 ATTR_PRINTF_FORMAT(3, 4);
494
500void BKE_modifier_set_warning(const Object *ob, ModifierData *md, const char *format, ...)
501 ATTR_PRINTF_FORMAT(3, 4);
502
503void BKE_modifiers_foreach_ID_link(Object *ob, IDWalkFunc walk, void *user_data);
504void BKE_modifiers_foreach_tex_link(Object *ob, TexWalkFunc walk, void *user_data);
505
506ModifierData *BKE_modifiers_findby_type(const Object *ob, ModifierType type);
507ModifierData *BKE_modifiers_findby_name(const Object *ob, const char *name);
508ModifierData *BKE_modifiers_findby_persistent_uid(const Object *ob, int persistent_uid);
509
511
515void BKE_modifiers_persistent_uid_init(const Object &object, ModifierData &md);
521
528int BKE_modifiers_get_cage_index(const Scene *scene,
529 Object *ob,
530 int *r_lastPossibleCageIndex,
531 bool is_virtual);
532
550bool BKE_modifiers_uses_armature(Object *ob, bArmature *arm);
552void BKE_modifier_free_temporary_data(ModifierData *md);
559void BKE_modifiers_add_at_end_if_possible(Object *ob, ModifierData *new_md);
560
565
573 ModifierData *md,
574 CustomData_MeshMasks *final_datamask,
575 int required_mode);
576
583
589
594
599
603void BKE_modifier_path_init(char *path, int path_maxncpy, const char *name);
604const char *BKE_modifier_path_relbase(Main *bmain, Object *ob);
606
607/* Accessors of original/evaluated modifiers. */
608
614ModifierData *BKE_modifier_get_evaluated(Depsgraph *depsgraph, Object *object, ModifierData *md);
615
616/* wrappers for modifier callbacks that ensure valid normals */
617
619
624 const ModifierEvalContext *ctx,
625 Mesh *mesh,
626 MutableSpan<float3> positions);
627
629 const ModifierEvalContext *ctx,
630 Mesh *mesh,
631 MutableSpan<float3> positions);
632
640
642 const ID *id_owner,
643 ListBaseT<ModifierData> *modbase);
645 ListBaseT<ModifierData> *lb,
646 Object *ob);
647
648namespace bke {
649
655 private:
656 ModifierData &md_;
657 double start_time_;
658
659 public:
662};
663
664} // namespace bke
665} // namespace blender
#define ATTR_PRINTF_FORMAT(format_param, dots_param)
#define ENUM_OPERATORS(_enum_type)
These structs are the foundation for all linked lists in the library system.
Definition scene.h:133
ENUM_OPERATORS(Layer::Flags)
BMesh Iterators.
void BKE_modifier_copydata(const ModifierData *md, ModifierData *target)
void BKE_modifier_copydata_ex(const ModifierData *md, ModifierData *target, int flag)
CDMaskLink * BKE_modifier_calc_data_masks(const Scene *scene, ModifierData *md, CustomData_MeshMasks *final_datamask, int required_mode)
ModifierData * BKE_modifiers_findby_name(const Object *ob, const char *name)
void BKE_modifier_set_error(const Object *ob, ModifierData *md, const char *format,...) ATTR_PRINTF_FORMAT(3
void void BKE_modifier_set_warning(const Object *ob, ModifierData *md, const char *format,...) ATTR_PRINTF_FORMAT(3
bool BKE_modifier_is_nonlocal_in_liboverride(const Object *ob, const ModifierData *md)
unsigned int uint
Definition BKE_text.h:55
void BKE_modifier_blend_read_data(BlendDataReader *reader, ListBaseT< ModifierData > *lb, Object *ob)
bool BKE_modifiers_is_correctable_deformed(const Scene *scene, Object *ob)
bool BKE_modifier_is_non_geometrical(ModifierData *md)
Object * BKE_modifiers_is_deformed_by_curve(Object *ob)
void(*)(void *user_data, Object *ob, ID **idpoin, LibraryForeachIDCallbackFlag cb_flag) IDWalkFunc
Object * BKE_modifiers_is_deformed_by_armature(Object *ob)
void void void BKE_modifiers_foreach_ID_link(Object *ob, IDWalkFunc walk, void *user_data)
bool BKE_modifier_supports_mapping(ModifierData *md)
void BKE_modifier_blend_write(BlendWriter *writer, const ID *id_owner, ListBaseT< ModifierData > *modbase)
ModifierData * BKE_modifier_get_evaluated(Depsgraph *depsgraph, Object *object, ModifierData *md)
bool BKE_modifier_supports_cage(Scene *scene, ModifierData *md)
void BKE_modifiers_persistent_uid_init(const Object &object, ModifierData &md)
void BKE_modifier_panel_expand(ModifierData *md)
ModifierData * BKE_modifiers_findby_persistent_uid(const Object *ob, int persistent_uid)
void BKE_modifier_free_temporary_data(ModifierData *md)
void BKE_modifier_unique_name(ListBaseT< ModifierData > *modifiers, ModifierData *md)
ModifierData * BKE_modifier_copy_ex(const ModifierData *md, int flag)
const char * BKE_modifier_path_relbase(Main *bmain, Object *ob)
Mesh * BKE_modifier_get_evaluated_mesh_from_evaluated_object(Object *ob_eval)
bool BKE_modifier_deform_verts(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh, MutableSpan< float3 > positions)
BMesh const char void * data
void BKE_modifiers_add_at_end_if_possible(Object *ob, ModifierData *new_md)
@ MOD_APPLY_TO_ORIGINAL
@ MOD_APPLY_IGNORE_SIMPLIFY
@ MOD_APPLY_USECACHE
ModifierData * BKE_modifier_new(int type)
ModifierData * BKE_modifiers_get_virtual_modifierlist(const Object *ob, VirtualModifierData *data)
void BKE_modifier_free(ModifierData *md)
int BKE_modifiers_get_cage_index(const Scene *scene, Object *ob, int *r_lastPossibleCageIndex, bool is_virtual)
void BKE_modifiers_clear_errors(Object *ob)
void BKE_modifier_remove_from_list(Object *ob, ModifierData *md)
@ eModifierTypeFlag_SupportsMapping
@ eModifierTypeFlag_AcceptsGreasePencil
@ eModifierTypeFlag_NoUserAdd
@ eModifierTypeFlag_AcceptsCVs
@ eModifierTypeFlag_EnableInEditmode
@ eModifierTypeFlag_SupportsEditmode
@ eModifierTypeFlag_UsesPointCache
@ eModifierTypeFlag_AcceptsBMesh
@ eModifierTypeFlag_AcceptsMesh
@ eModifierTypeFlag_RequiresOriginalData
@ eModifierTypeFlag_Single
@ eModifierTypeFlag_AcceptsVertexCosOnly
bool BKE_modifiers_uses_multires(Object *ob)
void BKE_modifier_free_ex(ModifierData *md, int flag)
ModifierData * BKE_modifiers_findby_type(const Object *ob, ModifierType type)
Mesh * BKE_modifier_modify_mesh(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh)
bool BKE_modifiers_uses_armature(Object *ob, bArmature *arm)
void BKE_modifiers_test_object(Object *ob)
void BKE_modifier_deform_vertsEM(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh, MutableSpan< float3 > positions)
bool BKE_modifier_is_correctable_deformed(ModifierData *md)
bool BKE_modifier_is_same_topology(ModifierData *md)
void BKE_modifier_type_panel_id(ModifierType type, char *r_idname)
bool BKE_modifier_couldbe_cage(Scene *scene, ModifierData *md)
LibraryForeachIDCallbackFlag
bool BKE_modifiers_persistent_uids_are_valid(const Object &object)
Object * BKE_modifiers_is_deformed_by_meshdeform(Object *ob)
bool BKE_modifier_is_enabled(const Scene *scene, ModifierData *md, int required_mode)
const char * BKE_modifier_path_relbase_from_global(Object *ob)
ModifierData * BKE_modifier_get_original(const Object *object, ModifierData *md)
void(*)(void *user_data, Object *ob, ModifierData *md, const PointerRNA *ptr, PropertyRNA *texture_prop) TexWalkFunc
void BKE_modifiers_foreach_tex_link(Object *ob, TexWalkFunc walk, void *user_data)
void BKE_modifier_path_init(char *path, int path_maxncpy, const char *name)
const ModifierTypeInfo * BKE_modifier_get_info(ModifierType type)
bool BKE_modifier_depends_ontime(Scene *scene, ModifierData *md)
void BKE_modifier_mdef_compact_influences(ModifierData *md)
Object * BKE_modifiers_is_deformed_by_lattice(Object *ob)
void BKE_modifier_copydata_generic(const ModifierData *md, ModifierData *md_dst, int flag)
void(*) foreach_tex_link(ModifierData *md, Object *ob, TexWalkFunc walk, void *user_data)
void(*) init_data(ModifierData *md)
void(*) required_data_mask(ModifierData *md, CustomData_MeshMasks *r_cddata_masks)
void(*) deform_verts(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh, MutableSpan< float3 > positions)
bool(*) depends_on_time(Scene *scene, ModifierData *md)
void(*) free_data(ModifierData *md)
void(*) copy_data(const ModifierData *md, ModifierData *target, int flag)
void(*) update_depsgraph(ModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
void(*) blend_read(BlendDataReader *reader, ModifierData *md)
void(*) free_runtime_data(void *runtime_data)
void(*) deform_verts_EM(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh, MutableSpan< float3 > positions)
void(*) deform_matrices_EM(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh, MutableSpan< float3 > positions, MutableSpan< float3x3 > matrices)
void(*) foreach_cache(Object *object, ModifierData *md, FunctionRef< void(const IDCacheKey &cache_key, void **cache_p, uint flags)> fn)
void(*) foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
bool(*) depends_on_normals(ModifierData *md)
void(*) deform_matrices(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh, MutableSpan< float3 > positions, MutableSpan< float3x3 > matrices)
bool(*) is_disabled(const Scene *scene, ModifierData *md, bool use_render_params)
void(*) modify_geometry_set(ModifierData *md, const ModifierEvalContext *ctx, bke::GeometrySet *geometry_set)
void(*) panel_register(ARegionType *region_type)
void(*) foreach_working_space_color(ModifierData *md, const IDTypeForeachColorFunctionCallback &fn)
void(*) blend_write(BlendWriter *writer, const ID *id_owner, const ModifierData *md)
ShapeKeyModifierData smd
ArmatureModifierData amd