c1bc70b711
A lot of files were missing copyright field in the header and
the Blender Foundation contributed to them in a sense of bug
fixing and general maintenance.
This change makes it explicit that those files are at least
partially copyrighted by the Blender Foundation.
Note that this does not make it so the Blender Foundation is
the only holder of the copyright in those files, and developers
who do not have a signed contract with the foundation still
hold the copyright as well.
Another aspect of this change is using SPDX format for the
header. We already used it for the license specification,
and now we state it for the copyright as well, following the
FAQ:
https://reuse.software/faq/
512 lines
16 KiB
C++
512 lines
16 KiB
C++
/* SPDX-FileCopyrightText: 2023 Blender Foundation
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/** \file
|
|
* \ingroup modifiers
|
|
*/
|
|
|
|
#include "BLI_listbase.h"
|
|
#include "BLI_string.h"
|
|
|
|
#include "MEM_guardedalloc.h"
|
|
|
|
#include "BKE_context.h"
|
|
#include "BKE_modifier.h"
|
|
#include "BKE_object.h"
|
|
#include "BKE_screen.h"
|
|
|
|
#include "DNA_object_force_types.h"
|
|
#include "DNA_object_types.h"
|
|
#include "DNA_particle_types.h"
|
|
#include "DNA_scene_types.h"
|
|
#include "DNA_screen_types.h"
|
|
|
|
#include "ED_object.h"
|
|
|
|
#include "BLT_translation.h"
|
|
|
|
#include "UI_interface.h"
|
|
#include "UI_resources.h"
|
|
|
|
#include "RNA_access.h"
|
|
#include "RNA_prototypes.h"
|
|
|
|
#include "WM_api.h"
|
|
#include "WM_types.h"
|
|
|
|
#include "MOD_modifiertypes.hh"
|
|
#include "MOD_ui_common.hh" /* Self include */
|
|
|
|
/**
|
|
* Poll function so these modifier panels don't show for other object types with modifiers (only
|
|
* grease pencil currently).
|
|
*/
|
|
static bool modifier_ui_poll(const bContext *C, PanelType * /*pt*/)
|
|
{
|
|
Object *ob = ED_object_active_context(C);
|
|
|
|
return (ob != nullptr) && (ob->type != OB_GPENCIL_LEGACY);
|
|
}
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Panel Drag and Drop, Expansion Saving
|
|
* \{ */
|
|
|
|
/**
|
|
* Move a modifier to the index it's moved to after a drag and drop.
|
|
*/
|
|
static void modifier_reorder(bContext *C, Panel *panel, int new_index)
|
|
{
|
|
PointerRNA *md_ptr = UI_panel_custom_data_get(panel);
|
|
ModifierData *md = (ModifierData *)md_ptr->data;
|
|
|
|
PointerRNA props_ptr;
|
|
wmOperatorType *ot = WM_operatortype_find("OBJECT_OT_modifier_move_to_index", false);
|
|
WM_operator_properties_create_ptr(&props_ptr, ot);
|
|
RNA_string_set(&props_ptr, "modifier", md->name);
|
|
RNA_int_set(&props_ptr, "index", new_index);
|
|
WM_operator_name_call_ptr(C, ot, WM_OP_INVOKE_DEFAULT, &props_ptr, nullptr);
|
|
WM_operator_properties_free(&props_ptr);
|
|
}
|
|
|
|
static short get_modifier_expand_flag(const bContext * /*C*/, Panel *panel)
|
|
{
|
|
PointerRNA *md_ptr = UI_panel_custom_data_get(panel);
|
|
ModifierData *md = (ModifierData *)md_ptr->data;
|
|
return md->ui_expand_flag;
|
|
}
|
|
|
|
static void set_modifier_expand_flag(const bContext * /*C*/, Panel *panel, short expand_flag)
|
|
{
|
|
PointerRNA *md_ptr = UI_panel_custom_data_get(panel);
|
|
ModifierData *md = (ModifierData *)md_ptr->data;
|
|
md->ui_expand_flag = expand_flag;
|
|
}
|
|
|
|
/** \} */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Modifier Panel Layouts
|
|
* \{ */
|
|
|
|
void modifier_panel_end(uiLayout *layout, PointerRNA *ptr)
|
|
{
|
|
ModifierData *md = static_cast<ModifierData *>(ptr->data);
|
|
if (md->error) {
|
|
uiLayout *row = uiLayoutRow(layout, false);
|
|
uiItemL(row, TIP_(md->error), ICON_ERROR);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Gets RNA pointers for the active object and the panel's modifier data. Also locks
|
|
* the layout if the modifier is from a linked object, and sets the context pointer.
|
|
*
|
|
* \note The modifier #PointerRNA is owned by the panel so we only need a pointer to it.
|
|
*/
|
|
#define ERROR_LIBDATA_MESSAGE TIP_("External library data")
|
|
PointerRNA *modifier_panel_get_property_pointers(Panel *panel, PointerRNA *r_ob_ptr)
|
|
{
|
|
PointerRNA *ptr = UI_panel_custom_data_get(panel);
|
|
BLI_assert(!RNA_pointer_is_null(ptr));
|
|
BLI_assert(RNA_struct_is_a(ptr->type, &RNA_Modifier));
|
|
|
|
if (r_ob_ptr != nullptr) {
|
|
RNA_pointer_create(ptr->owner_id, &RNA_Object, ptr->owner_id, r_ob_ptr);
|
|
}
|
|
|
|
uiBlock *block = uiLayoutGetBlock(panel->layout);
|
|
UI_block_lock_set(block, ID_IS_LINKED((Object *)ptr->owner_id), ERROR_LIBDATA_MESSAGE);
|
|
|
|
UI_panel_context_pointer_set(panel, "modifier", ptr);
|
|
|
|
return ptr;
|
|
}
|
|
|
|
void modifier_vgroup_ui(uiLayout *layout,
|
|
PointerRNA *ptr,
|
|
PointerRNA *ob_ptr,
|
|
const char *vgroup_prop,
|
|
const char *invert_vgroup_prop,
|
|
const char *text)
|
|
{
|
|
bool has_vertex_group = RNA_string_length(ptr, vgroup_prop) != 0;
|
|
|
|
uiLayout *row = uiLayoutRow(layout, true);
|
|
uiItemPointerR(row, ptr, vgroup_prop, ob_ptr, "vertex_groups", text, ICON_NONE);
|
|
if (invert_vgroup_prop != nullptr) {
|
|
uiLayout *sub = uiLayoutRow(row, true);
|
|
uiLayoutSetActive(sub, has_vertex_group);
|
|
uiLayoutSetPropDecorate(sub, false);
|
|
uiItemR(sub, ptr, invert_vgroup_prop, 0, "", ICON_ARROW_LEFTRIGHT);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check whether Modifier is a simulation or not. Used for switching to the
|
|
* physics/particles context tab.
|
|
*/
|
|
static int modifier_is_simulation(const ModifierData *md)
|
|
{
|
|
/* Physic Tab */
|
|
if (ELEM(md->type,
|
|
eModifierType_Cloth,
|
|
eModifierType_Collision,
|
|
eModifierType_Fluidsim,
|
|
eModifierType_Fluid,
|
|
eModifierType_Softbody,
|
|
eModifierType_Surface,
|
|
eModifierType_DynamicPaint))
|
|
{
|
|
return 1;
|
|
}
|
|
/* Particle Tab */
|
|
if (md->type == eModifierType_ParticleSystem) {
|
|
return 2;
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
static bool modifier_can_delete(ModifierData *md)
|
|
{
|
|
/* fluid particle modifier can't be deleted here */
|
|
if (md->type == eModifierType_ParticleSystem) {
|
|
short particle_type = ((ParticleSystemModifierData *)md)->psys->part->type;
|
|
if (ELEM(particle_type,
|
|
PART_FLUID,
|
|
PART_FLUID_FLIP,
|
|
PART_FLUID_FOAM,
|
|
PART_FLUID_SPRAY,
|
|
PART_FLUID_BUBBLE,
|
|
PART_FLUID_TRACER,
|
|
PART_FLUID_SPRAYFOAM,
|
|
PART_FLUID_SPRAYBUBBLE,
|
|
PART_FLUID_FOAMBUBBLE,
|
|
PART_FLUID_SPRAYFOAMBUBBLE))
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
static void modifier_ops_extra_draw(bContext *C, uiLayout *layout, void *md_v)
|
|
{
|
|
PointerRNA op_ptr;
|
|
uiLayout *row;
|
|
ModifierData *md = (ModifierData *)md_v;
|
|
|
|
PointerRNA ptr;
|
|
Object *ob = ED_object_active_context(C);
|
|
RNA_pointer_create(&ob->id, &RNA_Modifier, md, &ptr);
|
|
uiLayoutSetContextPointer(layout, "modifier", &ptr);
|
|
uiLayoutSetOperatorContext(layout, WM_OP_INVOKE_DEFAULT);
|
|
|
|
uiLayoutSetUnitsX(layout, 4.0f);
|
|
|
|
/* Apply. */
|
|
uiItemO(layout,
|
|
CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Apply"),
|
|
ICON_CHECKMARK,
|
|
"OBJECT_OT_modifier_apply");
|
|
|
|
/* Apply as shapekey. */
|
|
if (BKE_modifier_is_same_topology(md) && !BKE_modifier_is_non_geometrical(md)) {
|
|
uiItemBooleanO(layout,
|
|
CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Apply as Shape Key"),
|
|
ICON_SHAPEKEY_DATA,
|
|
"OBJECT_OT_modifier_apply_as_shapekey",
|
|
"keep_modifier",
|
|
false);
|
|
|
|
uiItemBooleanO(layout,
|
|
CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Save as Shape Key"),
|
|
ICON_SHAPEKEY_DATA,
|
|
"OBJECT_OT_modifier_apply_as_shapekey",
|
|
"keep_modifier",
|
|
true);
|
|
}
|
|
|
|
/* Duplicate. */
|
|
if (!ELEM(md->type,
|
|
eModifierType_Fluidsim,
|
|
eModifierType_Softbody,
|
|
eModifierType_ParticleSystem,
|
|
eModifierType_Cloth,
|
|
eModifierType_Fluid))
|
|
{
|
|
uiItemO(layout,
|
|
CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Duplicate"),
|
|
ICON_DUPLICATE,
|
|
"OBJECT_OT_modifier_copy");
|
|
}
|
|
|
|
uiItemO(layout,
|
|
CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Copy to Selected"),
|
|
0,
|
|
"OBJECT_OT_modifier_copy_to_selected");
|
|
|
|
uiItemS(layout);
|
|
|
|
/* Move to first. */
|
|
row = uiLayoutColumn(layout, false);
|
|
uiItemFullO(row,
|
|
"OBJECT_OT_modifier_move_to_index",
|
|
IFACE_("Move to First"),
|
|
ICON_TRIA_UP,
|
|
nullptr,
|
|
WM_OP_INVOKE_DEFAULT,
|
|
0,
|
|
&op_ptr);
|
|
RNA_int_set(&op_ptr, "index", 0);
|
|
if (!md->prev) {
|
|
uiLayoutSetEnabled(row, false);
|
|
}
|
|
|
|
/* Move to last. */
|
|
row = uiLayoutColumn(layout, false);
|
|
uiItemFullO(row,
|
|
"OBJECT_OT_modifier_move_to_index",
|
|
IFACE_("Move to Last"),
|
|
ICON_TRIA_DOWN,
|
|
nullptr,
|
|
WM_OP_INVOKE_DEFAULT,
|
|
0,
|
|
&op_ptr);
|
|
RNA_int_set(&op_ptr, "index", BLI_listbase_count(&ob->modifiers) - 1);
|
|
if (!md->next) {
|
|
uiLayoutSetEnabled(row, false);
|
|
}
|
|
|
|
if (md->type == eModifierType_Nodes) {
|
|
uiItemFullO(layout,
|
|
"OBJECT_OT_geometry_nodes_move_to_nodes",
|
|
nullptr,
|
|
ICON_NONE,
|
|
nullptr,
|
|
WM_OP_INVOKE_DEFAULT,
|
|
0,
|
|
&op_ptr);
|
|
}
|
|
}
|
|
|
|
static void modifier_panel_header(const bContext *C, Panel *panel)
|
|
{
|
|
uiLayout *row, *sub, *name_row;
|
|
uiLayout *layout = panel->layout;
|
|
|
|
/* Don't use #modifier_panel_get_property_pointers, we don't want to lock the header. */
|
|
PointerRNA *ptr = UI_panel_custom_data_get(panel);
|
|
ModifierData *md = (ModifierData *)ptr->data;
|
|
Object *ob = (Object *)ptr->owner_id;
|
|
|
|
UI_panel_context_pointer_set(panel, "modifier", ptr);
|
|
|
|
const ModifierTypeInfo *mti = BKE_modifier_get_info(ModifierType(md->type));
|
|
Scene *scene = CTX_data_scene(C);
|
|
int index = BLI_findindex(&ob->modifiers, md);
|
|
|
|
/* Modifier Icon. */
|
|
sub = uiLayoutRow(layout, true);
|
|
uiLayoutSetEmboss(sub, UI_EMBOSS_NONE);
|
|
if (mti->isDisabled && mti->isDisabled(scene, md, 0)) {
|
|
uiLayoutSetRedAlert(sub, true);
|
|
}
|
|
uiItemStringO(sub,
|
|
"",
|
|
RNA_struct_ui_icon(ptr->type),
|
|
"OBJECT_OT_modifier_set_active",
|
|
"modifier",
|
|
md->name);
|
|
|
|
row = uiLayoutRow(layout, true);
|
|
|
|
/* Modifier Name.
|
|
* Count how many buttons are added to the header to check if there is enough space. */
|
|
int buttons_number = 0;
|
|
name_row = uiLayoutRow(row, true);
|
|
|
|
/* Display mode switching buttons. */
|
|
if (ob->type == OB_MESH) {
|
|
int last_cage_index;
|
|
int cage_index = BKE_modifiers_get_cage_index(scene, ob, &last_cage_index, 0);
|
|
if (BKE_modifier_supports_cage(scene, md) && (index <= last_cage_index)) {
|
|
sub = uiLayoutRow(row, true);
|
|
if (index < cage_index || !BKE_modifier_couldbe_cage(scene, md)) {
|
|
uiLayoutSetActive(sub, false);
|
|
}
|
|
uiItemR(sub, ptr, "show_on_cage", 0, "", ICON_NONE);
|
|
buttons_number++;
|
|
}
|
|
} /* Tessellation point for curve-typed objects. */
|
|
else if (ELEM(ob->type, OB_CURVES_LEGACY, OB_SURF, OB_FONT)) {
|
|
/* Smooth modifier can work with tessellated curves only (works on mesh edges explicitly). */
|
|
if (md->type == eModifierType_Smooth) {
|
|
/* Add button (appearing to be OFF) and add tip why this can't be changed. */
|
|
sub = uiLayoutRow(row, true);
|
|
uiBlock *block = uiLayoutGetBlock(sub);
|
|
static int apply_on_spline_always_off_hack = 0;
|
|
uiBut *but = uiDefIconButBitI(block,
|
|
UI_BTYPE_TOGGLE,
|
|
eModifierMode_ApplyOnSpline,
|
|
0,
|
|
ICON_SURFACE_DATA,
|
|
0,
|
|
0,
|
|
UI_UNIT_X - 2,
|
|
UI_UNIT_Y,
|
|
&apply_on_spline_always_off_hack,
|
|
0.0,
|
|
0.0,
|
|
0.0,
|
|
0.0,
|
|
TIP_("Apply on Spline"));
|
|
UI_but_disable(
|
|
but, TIP_("This modifier can only deform filled curve/surface, not the control points"));
|
|
buttons_number++;
|
|
}
|
|
/* Some modifiers can work with pre-tessellated curves only. */
|
|
else if (ELEM(md->type, eModifierType_Hook, eModifierType_Softbody, eModifierType_MeshDeform))
|
|
{
|
|
/* Add button (appearing to be ON) and add tip why this can't be changed. */
|
|
sub = uiLayoutRow(row, true);
|
|
uiBlock *block = uiLayoutGetBlock(sub);
|
|
static int apply_on_spline_always_on_hack = eModifierMode_ApplyOnSpline;
|
|
uiBut *but = uiDefIconButBitI(block,
|
|
UI_BTYPE_TOGGLE,
|
|
eModifierMode_ApplyOnSpline,
|
|
0,
|
|
ICON_SURFACE_DATA,
|
|
0,
|
|
0,
|
|
UI_UNIT_X - 2,
|
|
UI_UNIT_Y,
|
|
&apply_on_spline_always_on_hack,
|
|
0.0,
|
|
0.0,
|
|
0.0,
|
|
0.0,
|
|
TIP_("Apply on Spline"));
|
|
UI_but_disable(
|
|
but, TIP_("This modifier can only deform control points, not the filled curve/surface"));
|
|
buttons_number++;
|
|
}
|
|
else if (mti->type != eModifierTypeType_Constructive) {
|
|
/* Constructive modifiers tessellates curve before applying. */
|
|
uiItemR(row, ptr, "use_apply_on_spline", 0, "", ICON_NONE);
|
|
buttons_number++;
|
|
}
|
|
}
|
|
/* Collision and Surface are always enabled, hide buttons. */
|
|
if (!ELEM(md->type, eModifierType_Collision, eModifierType_Surface)) {
|
|
if (mti->flags & eModifierTypeFlag_SupportsEditmode) {
|
|
sub = uiLayoutRow(row, true);
|
|
uiLayoutSetActive(sub, (md->mode & eModifierMode_Realtime));
|
|
uiItemR(sub, ptr, "show_in_editmode", 0, "", ICON_NONE);
|
|
buttons_number++;
|
|
}
|
|
uiItemR(row, ptr, "show_viewport", 0, "", ICON_NONE);
|
|
uiItemR(row, ptr, "show_render", 0, "", ICON_NONE);
|
|
buttons_number += 2;
|
|
}
|
|
|
|
/* Extra operators menu. */
|
|
uiItemMenuF(row, "", ICON_DOWNARROW_HLT, modifier_ops_extra_draw, md);
|
|
|
|
/* Delete button. */
|
|
if (modifier_can_delete(md) && !modifier_is_simulation(md)) {
|
|
sub = uiLayoutRow(row, false);
|
|
uiLayoutSetEmboss(sub, UI_EMBOSS_NONE);
|
|
uiItemO(sub, "", ICON_X, "OBJECT_OT_modifier_remove");
|
|
buttons_number++;
|
|
}
|
|
|
|
/* Switch context buttons. */
|
|
if (modifier_is_simulation(md) == 1) {
|
|
uiItemStringO(
|
|
row, "", ICON_PROPERTIES, "WM_OT_properties_context_change", "context", "PHYSICS");
|
|
buttons_number++;
|
|
}
|
|
else if (modifier_is_simulation(md) == 2) {
|
|
uiItemStringO(
|
|
row, "", ICON_PROPERTIES, "WM_OT_properties_context_change", "context", "PARTICLES");
|
|
buttons_number++;
|
|
}
|
|
|
|
bool display_name = (panel->sizex / UI_UNIT_X - buttons_number > 5) || (panel->sizex == 0);
|
|
if (display_name) {
|
|
uiItemR(name_row, ptr, "name", 0, "", ICON_NONE);
|
|
}
|
|
else {
|
|
uiLayoutSetAlignment(row, UI_LAYOUT_ALIGN_RIGHT);
|
|
}
|
|
|
|
/* Extra padding for delete button. */
|
|
uiItemS(layout);
|
|
}
|
|
|
|
/** \} */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Modifier Registration Helpers
|
|
* \{ */
|
|
|
|
PanelType *modifier_panel_register(ARegionType *region_type, ModifierType type, PanelDrawFn draw)
|
|
{
|
|
PanelType *panel_type = MEM_cnew<PanelType>(__func__);
|
|
|
|
BKE_modifier_type_panel_id(type, panel_type->idname);
|
|
STRNCPY(panel_type->label, "");
|
|
STRNCPY(panel_type->context, "modifier");
|
|
STRNCPY(panel_type->translation_context, BLT_I18NCONTEXT_DEFAULT_BPYRNA);
|
|
STRNCPY(panel_type->active_property, "is_active");
|
|
|
|
panel_type->draw_header = modifier_panel_header;
|
|
panel_type->draw = draw;
|
|
panel_type->poll = modifier_ui_poll;
|
|
|
|
/* Give the panel the special flag that says it was built here and corresponds to a
|
|
* modifier rather than a #PanelType. */
|
|
panel_type->flag = PANEL_TYPE_HEADER_EXPAND | PANEL_TYPE_INSTANCED;
|
|
panel_type->reorder = modifier_reorder;
|
|
panel_type->get_list_data_expand_flag = get_modifier_expand_flag;
|
|
panel_type->set_list_data_expand_flag = set_modifier_expand_flag;
|
|
|
|
BLI_addtail(®ion_type->paneltypes, panel_type);
|
|
|
|
return panel_type;
|
|
}
|
|
|
|
PanelType *modifier_subpanel_register(ARegionType *region_type,
|
|
const char *name,
|
|
const char *label,
|
|
PanelDrawFn draw_header,
|
|
PanelDrawFn draw,
|
|
PanelType *parent)
|
|
{
|
|
PanelType *panel_type = MEM_cnew<PanelType>(__func__);
|
|
|
|
SNPRINTF(panel_type->idname, "%s_%s", parent->idname, name);
|
|
STRNCPY(panel_type->label, label);
|
|
STRNCPY(panel_type->context, "modifier");
|
|
STRNCPY(panel_type->translation_context, BLT_I18NCONTEXT_DEFAULT_BPYRNA);
|
|
STRNCPY(panel_type->active_property, "is_active");
|
|
|
|
panel_type->draw_header = draw_header;
|
|
panel_type->draw = draw;
|
|
panel_type->poll = modifier_ui_poll;
|
|
panel_type->flag = PANEL_TYPE_DEFAULT_CLOSED;
|
|
|
|
BLI_assert(parent != nullptr);
|
|
STRNCPY(panel_type->parent_id, parent->idname);
|
|
panel_type->parent = parent;
|
|
BLI_addtail(&parent->children, BLI_genericNodeN(panel_type));
|
|
BLI_addtail(®ion_type->paneltypes, panel_type);
|
|
|
|
return panel_type;
|
|
}
|
|
|
|
/** \} */
|