Blender V5.3
FX_ui_common.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 "BLI_listbase.hh"
10#include "BLI_string_utf8.hh"
11
12#include "MEM_guardedalloc.h"
13
14#include "BKE_context.hh"
15#include "BKE_library.hh"
16#include "BKE_screen.hh"
17#include "BKE_shader_fx.hh"
18
19#include "DNA_object_types.h"
20#include "DNA_screen_types.h"
21#include "DNA_shader_fx_types.h"
22
23#include "ED_object.hh"
24
25#include "BLT_translation.hh"
26
27#include "UI_interface.hh"
29#include "UI_resources.hh"
30
31#include "RNA_access.hh"
32#include "RNA_prototypes.hh"
33
34#include "WM_api.hh"
35#include "WM_types.hh"
36
37#include "FX_ui_common.hh" /* Self include */
38
39namespace blender {
40
41/* -------------------------------------------------------------------- */
44
48static void shaderfx_reorder(bContext *C, Panel *panel, int new_index)
49{
51 ShaderFxData *fx = static_cast<ShaderFxData *>(fx_ptr->data);
52
53 wmOperatorType *ot = WM_operatortype_find("OBJECT_OT_shaderfx_move_to_index", false);
55 RNA_string_set(&props_ptr, "shaderfx", fx->name);
56 RNA_int_set(&props_ptr, "index", new_index);
59}
60
64static short get_shaderfx_expand_flag(const bContext * /*C*/, Panel *panel)
65{
67 ShaderFxData *fx = static_cast<ShaderFxData *>(fx_ptr->data);
68 return fx->ui_expand_flag;
69}
70
74static void set_shaderfx_expand_flag(const bContext * /*C*/, Panel *panel, short expand_flag)
75{
77 ShaderFxData *fx = static_cast<ShaderFxData *>(fx_ptr->data);
78 fx->ui_expand_flag = expand_flag;
79}
80
82
83/* -------------------------------------------------------------------- */
86
88{
89 ShaderFxData *fx = static_cast<ShaderFxData *>(ptr->data);
90 if (fx->error) {
91 ui::Layout &row = layout.row(false);
92 row.label(RPT_(fx->error), ICON_STATUS_ERROR);
93 }
94}
95
97{
99 BLI_assert(RNA_struct_is_a(ptr->type, RNA_ShaderFx));
100
101 if (r_ob_ptr != nullptr) {
102 *r_ob_ptr = RNA_pointer_create_discrete(ptr->owner_id, RNA_Object, ptr->owner_id);
103 }
104
105 ui::panel_context_pointer_set(panel, "shaderfx", ptr);
106
107 return ptr;
108}
109
110#define ERROR_LIBDATA_MESSAGE N_("External library data")
111
112static void gpencil_shaderfx_ops_extra_draw(bContext *C, ui::Layout *layout, void *fx_v)
113{
114 ShaderFxData *fx = static_cast<ShaderFxData *>(fx_v);
115
117 PointerRNA ptr = RNA_pointer_create_discrete(&ob->id, RNA_ShaderFx, fx);
118 layout->context_ptr_set("shaderfx", &ptr);
120
121 layout->ui_units_x_set(4.0f);
122
123 /* Duplicate. */
124 layout->op("OBJECT_OT_shaderfx_copy",
126 ICON_DUPLICATE);
127
128 layout->separator();
129
130 /* Move to first. */
131 ui::Layout *col = &layout->column(false);
132 PointerRNA op_ptr = col->op("OBJECT_OT_shaderfx_move_to_index",
133 IFACE_("Move to First"),
134 ICON_TRIA_UP,
137 RNA_int_set(&op_ptr, "index", 0);
138 if (!fx->prev) {
139 col->enabled_set(false);
140 }
141
142 /* Move to last. */
143 col = &layout->column(false);
144 op_ptr = col->op("OBJECT_OT_shaderfx_move_to_index",
145 IFACE_("Move to Last"),
146 ICON_TRIA_DOWN,
149 RNA_int_set(&op_ptr, "index", ob->shader_fx.count() - 1);
150 if (!fx->next) {
151 col->enabled_set(false);
152 }
153}
154
155static void shaderfx_panel_header(const bContext * /*C*/, Panel *panel)
156{
157 ui::Layout &layout = *panel->layout;
158 bool narrow_panel = (panel->sizex < UI_UNIT_X * 7 && panel->sizex != 0);
159
161 Object *ob = id_cast<Object *>(ptr->owner_id);
162 ShaderFxData *fx = static_cast<ShaderFxData *>(ptr->data);
163
165
166 block_lock_set(layout.block(), (ob && !ID_IS_EDITABLE(ob)), ERROR_LIBDATA_MESSAGE);
167
168 /* Effect type icon. */
169 ui::Layout *row = &layout.row(false);
170 if (fxti->is_disabled && fxti->is_disabled(fx, false)) {
171 row->red_alert_set(true);
172 }
173 row->label("", RNA_struct_ui_icon(ptr->type));
174
175 /* Effect name. */
176 row = &layout.row(true);
177 if (!narrow_panel) {
178 row->prop(ptr, "name", UI_ITEM_NONE, "", ICON_NONE);
179 }
180
181 /* Mode enabling buttons. */
183 ui::Layout &sub = row->row(true);
184 sub.active_set(false);
185 sub.prop(ptr, "show_in_editmode", UI_ITEM_NONE, "", ICON_NONE);
186 }
187 row->prop(ptr, "show_viewport", UI_ITEM_NONE, "", ICON_NONE);
188 row->prop(ptr, "show_render", UI_ITEM_NONE, "", ICON_NONE);
189
190 /* Extra operators. */
191 row->menu_fn("", ICON_DOWNARROW_HLT, gpencil_shaderfx_ops_extra_draw, fx);
192
193 ui::Layout &sub = row->row(false);
195 sub.op("OBJECT_OT_shaderfx_remove", "", ICON_X);
196
197 /* Some padding so the X isn't too close to the drag icon. */
198 layout.separator();
199}
200
202
203/* -------------------------------------------------------------------- */
206
207static bool shaderfx_ui_poll(const bContext *C, PanelType * /*pt*/)
208{
210
211 return (ob != nullptr) && ob->type == OB_GREASE_PENCIL;
212}
213
215{
216 PanelType *panel_type = MEM_new_zeroed<PanelType>(__func__);
217
218 BKE_shaderfxType_panel_id(type, panel_type->idname);
219 STRNCPY_UTF8(panel_type->label, "");
220 STRNCPY_UTF8(panel_type->context, "shaderfx");
222
224 panel_type->draw = draw;
225 panel_type->poll = shaderfx_ui_poll;
226
227 /* Give the panel the special flag that says it was built here and corresponds to a
228 * shader effect rather than a PanelType. */
230 panel_type->reorder = shaderfx_reorder;
233
234 BLI_addtail(&region_type->paneltypes, panel_type);
235
236 return panel_type;
237}
238
240 const char *name,
241 const char *label,
242 PanelDrawFn draw_header,
244 PanelType *parent)
245{
246 PanelType *panel_type = MEM_new_zeroed<PanelType>(__func__);
247
248 BLI_assert(parent != nullptr);
249 SNPRINTF_UTF8(panel_type->idname, "%s_%s", parent->idname, name);
250 STRNCPY_UTF8(panel_type->label, label);
251 STRNCPY_UTF8(panel_type->context, "shaderfx");
253
254 panel_type->draw_header = draw_header;
255 panel_type->draw = draw;
256 panel_type->poll = shaderfx_ui_poll;
257 panel_type->flag = PANEL_TYPE_DEFAULT_CLOSED;
258
259 STRNCPY_UTF8(panel_type->parent_id, parent->idname);
260 panel_type->parent = parent;
261 BLI_addtail(&parent->children, BLI_genericNodeN(panel_type));
262 BLI_addtail(&region_type->paneltypes, panel_type);
263
264 return panel_type;
265}
266
268
269} // namespace blender
#define SNPRINTF_UTF8(dst, format,...)
#define STRNCPY_UTF8(dst, src)
#define RPT_(msgid)
#define CTX_IFACE_(context, msgid)
#define BLT_I18NCONTEXT_OPERATOR_DEFAULT
#define IFACE_(msgid)
#define BLT_I18NCONTEXT_DEFAULT_BPYRNA
#define ID_IS_EDITABLE(_id)
Definition DNA_ID.h:708
Object is a sort of wrapper for general info.
Read Blender memory allocation and freeing.
#define C
Definition RandGen.cpp:29
#define UI_UNIT_X
#define UI_ITEM_NONE
#define ERROR_LIBDATA_MESSAGE
Object * context_active_object(const bContext *C)
void panel_context_pointer_set(Panel *panel, const char *name, PointerRNA *ptr)
PointerRNA * panel_custom_data_get(const Panel *panel)
BMesh Iterators.
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
bool RNA_struct_is_a(const StructRNA *type, const StructRNA *srna)
void WM_operator_properties_free(PointerRNA *ptr)
void RNA_string_set(PointerRNA *ptr, const char *name, const char *value)
void RNA_int_set(PointerRNA *ptr, const char *name, int value)
PanelType * shaderfx_panel_register(ARegionType *region_type, ShaderFxType type, PanelDrawFn draw)
PointerRNA WM_operator_properties_create_ptr(wmOperatorType *ot)
static bool shaderfx_ui_poll(const bContext *C, PanelType *)
void * MEM_new_zeroed(size_t len, const char *str) ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2)
PanelType * shaderfx_subpanel_register(ARegionType *region_type, const char *name, const char *label, PanelDrawFn draw_header, PanelDrawFn draw, PanelType *parent)
static void gpencil_shaderfx_ops_extra_draw(bContext *C, ui::Layout *layout, void *fx_v)
LinkData * BLI_genericNodeN(void *data)
Definition listbase.cc:936
void shaderfx_panel_end(ui::Layout &layout, PointerRNA *ptr)
void(*)(const bContext *, Panel *) PanelDrawFn
PointerRNA RNA_pointer_create_discrete(ID *id, StructRNA *type, void *data)
static short get_shaderfx_expand_flag(const bContext *, Panel *panel)
static void shaderfx_reorder(bContext *C, Panel *panel, int new_index)
int RNA_struct_ui_icon(const StructRNA *type)
PointerRNA * shaderfx_panel_get_property_pointers(Panel *panel, PointerRNA *r_ob_ptr)
wmOperatorType * WM_operatortype_find(const char *idname, bool quiet)
static void set_shaderfx_expand_flag(const bContext *, Panel *panel, short expand_flag)
void BLI_addtail(ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition listbase.cc:118
@ PANEL_TYPE_HEADER_EXPAND
@ PANEL_TYPE_DEFAULT_CLOSED
@ PANEL_TYPE_INSTANCED
@ eShaderFxTypeFlag_SupportsEditmode
static void shaderfx_panel_header(const bContext *, Panel *panel)
wmOperatorStatus WM_operator_name_call_ptr(bContext *C, wmOperatorType *ot, wm::OpCallContext context, PointerRNA *properties, const wmEvent *event)
void BKE_shaderfxType_panel_id(ShaderFxType type, char *r_idname)
Definition shader_fx.cc:150
const ShaderFxTypeInfo * BKE_shaderfx_get_info(ShaderFxType type)
Definition shader_fx.cc:134
ListBaseT< PanelType > paneltypes
ListBaseT< ShaderFxData > shader_fx
void(*) reorder(bContext *C, Panel *pa, int new_index)
char translation_context[BKE_ST_MAXNAME]
short(*) get_list_data_expand_flag(const bContext *C, Panel *pa)
PanelType * parent
ListBaseT< LinkData > children
char parent_id[BKE_ST_MAXNAME]
char context[BKE_ST_MAXNAME]
void(*) draw(const bContext *C, Panel *panel)
void(*) set_list_data_expand_flag(const bContext *C, Panel *pa, short expand_flag)
bool(*) poll(const bContext *C, PanelType *pt)
void(*) draw_header(const bContext *C, Panel *panel)
char idname[BKE_ST_MAXNAME]
char label[BKE_ST_MAXNAME]
ui::Layout * layout
StructRNA * type
Definition RNA_types.hh:63
struct ShaderFxData * prev
struct ShaderFxData * next
bool(*) is_disabled(ShaderFxData *fx, bool use_render_params)
void enabled_set(bool enabled)
void operator_context_set(wm::OpCallContext opcontext)
void label(StringRef name, int icon)
void ui_units_x_set(float width)
PointerRNA op(wmOperatorType *ot, std::optional< StringRef > name, int icon, wm::OpCallContext context, eUI_Item_Flag flag)
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 red_alert_set(bool red_alert)
void active_set(bool active)
Layout & column(bool align)
void separator(float factor=1.0f, LayoutSeparatorType type=LayoutSeparatorType::Auto)
Layout & row(bool align)
void context_ptr_set(StringRef name, const PointerRNA *ptr)
void menu_fn(StringRefNull name, int icon, MenuCreateFunc func, void *arg)
void emboss_set(EmbossType emboss)