Blender V5.3
interface_template_constraint.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2024 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
10
11#include "BKE_constraint.h"
12#include "BKE_context.hh"
13#include "BKE_library.hh"
14#include "BKE_screen.hh"
15
16#include "BLI_listbase.hh"
17#include "BLI_string_utils.hh"
18
19#include "BLT_translation.hh"
20
22
23#include "ED_object.hh"
24
25#include "RNA_access.hh"
26#include "RNA_prototypes.hh"
27
28#include "WM_api.hh"
29
31#include "interface_intern.hh"
33
34namespace blender::ui {
35
36static void constraint_active_func(bContext * /*C*/, void *ob_v, void *con_v)
37{
38 ed::object::constraint_active_set(static_cast<Object *>(ob_v),
39 static_cast<bConstraint *>(con_v));
40}
41
42static void constraint_ops_extra_draw(bContext *C, Layout *layout, void *con_v)
43{
44 PointerRNA op_ptr;
45 bConstraint *con = static_cast<bConstraint *>(con_v);
46
48
49 PointerRNA ptr = RNA_pointer_create_discrete(&ob->id, RNA_Constraint, con);
50 layout->context_ptr_set("constraint", &ptr);
52
53 layout->ui_units_x_set(4.0f);
54
55 /* Apply. */
56 layout->op("CONSTRAINT_OT_apply",
58 ICON_CHECKMARK);
59
60 /* Duplicate. */
61 layout->op("CONSTRAINT_OT_copy",
63 ICON_DUPLICATE);
64
65 layout->op("CONSTRAINT_OT_copy_to_selected",
67 0);
68
69 layout->separator();
70
71 /* Move to first. */
72 Layout *row = &layout->column(false);
73 op_ptr = row->op("CONSTRAINT_OT_move_to_index",
74 IFACE_("Move to First"),
75 ICON_TRIA_UP,
78 RNA_int_set(&op_ptr, "index", 0);
79 if (!con->prev) {
80 row->enabled_set(false);
81 }
82
83 /* Move to last. */
84 row = &layout->column(false);
85 op_ptr = row->op("CONSTRAINT_OT_move_to_index",
86 IFACE_("Move to Last"),
87 ICON_TRIA_DOWN,
90 ListBaseT<bConstraint> *constraint_list = ed::object::constraint_list_from_constraint(
91 ob, con, nullptr);
92 RNA_int_set(&op_ptr, "index", constraint_list->count() - 1);
93 if (!con->next) {
94 row->enabled_set(false);
95 }
96}
97
98/* -------------------------------------------------------------------- */
101
102static void draw_constraint_header(Layout &layout, Object *ob, bConstraint *con)
103{
104 /* unless button has its own callback, it adds this callback to button */
105 Block *block = layout.block();
106 block_func_set(block, constraint_active_func, ob, con);
107
108 PointerRNA ptr = RNA_pointer_create_discrete(&ob->id, RNA_Constraint, con);
109
110 if (block->panel) {
111 panel_context_pointer_set(block->panel, "constraint", &ptr);
112 }
113 else {
114 layout.context_ptr_set("constraint", &ptr);
115 }
116
117 /* Constraint type icon. */
118 Layout *row = &layout.row(false);
121 row->label("", RNA_struct_ui_icon(ptr.type));
122
124
125 row = &layout.row(true);
126
127 row->prop(&ptr, "name", UI_ITEM_NONE, "", ICON_NONE);
128
129 /* Enabled eye icon. */
130 row->prop(&ptr, "enabled", UI_ITEM_NONE, "", ICON_NONE);
131
132 /* Extra operators menu. */
133 row->menu_fn("", ICON_DOWNARROW_HLT, constraint_ops_extra_draw, con);
134
135 /* Close 'button' - emboss calls here disable drawing of 'button' behind X */
136 Layout &sub = row->row(false);
139 sub.op("CONSTRAINT_OT_delete", "", ICON_X);
140
141 /* Some extra padding at the end, so the 'x' icon isn't too close to drag button. */
142 layout.separator();
143
144 /* clear any locks set up for proxies/lib-linking */
145 block_lock_clear(block);
146}
147
149{
150 /* verify we have valid data */
151 if (!RNA_struct_is_a(ptr->type, RNA_Constraint)) {
152 RNA_warning("Expected constraint on object");
153 return;
154 }
155
156 Object *ob = id_cast<Object *>(ptr->owner_id);
157 bConstraint *con = static_cast<bConstraint *>(ptr->data);
158
159 if (!ob || !(GS(ob->id.name) == ID_OB)) {
160 RNA_warning("Expected constraint on object");
161 return;
162 }
163
165
166 draw_constraint_header(*layout, ob, con);
167}
168
170
171/* -------------------------------------------------------------------- */
176
178#define CONSTRAINT_TYPE_PANEL_PREFIX "OBJECT_PT_"
179#define CONSTRAINT_BONE_TYPE_PANEL_PREFIX "BONE_PT_"
180
185{
186 return (panel->panelname[0] == 'B') && (panel->panelname[1] == 'O') &&
187 (panel->panelname[2] == 'N') && (panel->panelname[3] == 'E');
188}
189
193static void constraint_reorder(bContext *C, Panel *panel, int new_index)
194{
195 const bool constraint_from_bone = constraint_panel_is_bone(panel);
196
197 PointerRNA *con_ptr = panel_custom_data_get(panel);
198 bConstraint *con = static_cast<bConstraint *>(con_ptr->data);
199
200 wmOperatorType *ot = WM_operatortype_find("CONSTRAINT_OT_move_to_index", false);
202 RNA_string_set(&props_ptr, "constraint", con->name);
203 RNA_int_set(&props_ptr, "index", new_index);
204 /* Set owner to #EDIT_CONSTRAINT_OWNER_OBJECT or #EDIT_CONSTRAINT_OWNER_BONE. */
205 RNA_enum_set(&props_ptr, "owner", constraint_from_bone ? 1 : 0);
207 WM_operator_properties_free(&props_ptr);
208}
209
213static short get_constraint_expand_flag(const bContext * /*C*/, Panel *panel)
214{
215 PointerRNA *con_ptr = panel_custom_data_get(panel);
216 bConstraint *con = static_cast<bConstraint *>(con_ptr->data);
217
218 return con->ui_expand_flag;
219}
220
224static void set_constraint_expand_flag(const bContext * /*C*/, Panel *panel, short expand_flag)
225{
226 PointerRNA *con_ptr = panel_custom_data_get(panel);
227 bConstraint *con = static_cast<bConstraint *>(con_ptr->data);
228 con->ui_expand_flag = expand_flag;
229}
230
237static void object_constraint_panel_id(void *md_link, char *r_idname)
238{
239 bConstraint *con = static_cast<bConstraint *>(md_link);
241
242 /* Cannot get TypeInfo for invalid/legacy constraints. */
243 if (cti == nullptr) {
244 return;
245 }
247}
248
249static void bone_constraint_panel_id(void *md_link, char *r_idname)
250{
251 bConstraint *con = static_cast<bConstraint *>(md_link);
253
254 /* Cannot get TypeInfo for invalid/legacy constraints. */
255 if (cti == nullptr) {
256 return;
257 }
259}
260
261void template_constraints(Layout * /*layout*/, bContext *C, bool use_bone_constraints)
262{
263 ARegion *region = CTX_wm_region(C);
264
266 ListBaseT<bConstraint> *constraints = {nullptr};
267 if (use_bone_constraints) {
269 }
270 else if (ob != nullptr) {
272 }
273
274 /* Switch between the bone panel ID function and the object panel ID function. */
275 ListPanelIDFromDataFunc panel_id_func = use_bone_constraints ? bone_constraint_panel_id :
277
278 const bool panels_match = panel_list_matches_data(region, constraints, panel_id_func);
279
280 if (!panels_match) {
281 panels_free_instanced(C, region);
282 for (bConstraint *con = (constraints == nullptr) ? nullptr : constraints->first(); con;
283 con = con->next)
284 {
285 /* Don't show invalid/legacy constraints. */
286 if (con->type == CONSTRAINT_TYPE_NULL) {
287 continue;
288 }
289 /* Don't show temporary constraints (AutoIK and target-less IK constraints). */
290 if (con->type == CONSTRAINT_TYPE_KINEMATIC) {
291 bKinematicConstraint *data = static_cast<bKinematicConstraint *>(con->data);
292 if (data->flag & CONSTRAINT_IK_TEMP) {
293 continue;
294 }
295 }
296
297 char panel_idname[MAX_NAME];
298 panel_id_func(con, panel_idname);
299
300 /* Create custom data RNA pointer. */
301 PointerRNA *con_ptr = MEM_new<PointerRNA>(__func__);
302 *con_ptr = RNA_pointer_create_discrete(&ob->id, RNA_Constraint, con);
303
304 Panel *new_panel = panel_add_instanced(C, region, &region->panels, panel_idname, con_ptr);
305
306 if (new_panel) {
307 /* Set the list panel functionality function pointers since we don't do it with python. */
310 new_panel->type->reorder = constraint_reorder;
311 }
312 }
313 }
314 else {
315 /* Assuming there's only one group of instanced panels, update the custom data pointers. */
316 Panel *panel = region->panels.first();
317 for (bConstraint &con : *constraints) {
318 /* Don't show invalid/legacy constraints. */
319 if (con.type == CONSTRAINT_TYPE_NULL) {
320 continue;
321 }
322 /* Don't show temporary constraints (AutoIK and target-less IK constraints). */
323 if (con.type == CONSTRAINT_TYPE_KINEMATIC) {
324 bKinematicConstraint *data = static_cast<bKinematicConstraint *>(con.data);
325 if (data->flag & CONSTRAINT_IK_TEMP) {
326 continue;
327 }
328 }
329
330 /* Move to the next instanced panel corresponding to the next constraint. */
331 while ((panel->type == nullptr) || !(panel->type->flag & PANEL_TYPE_INSTANCED)) {
332 panel = panel->next;
333 BLI_assert(panel != nullptr); /* There shouldn't be fewer panels than constraint panels. */
334 }
335
336 PointerRNA *con_ptr = MEM_new<PointerRNA>(__func__);
337 *con_ptr = RNA_pointer_create_discrete(&ob->id, RNA_Constraint, &con);
338 panel_custom_data_set(panel, con_ptr);
339
340 panel = panel->next;
341 }
342 }
343}
344
345#undef CONSTRAINT_TYPE_PANEL_PREFIX
346#undef CONSTRAINT_BONE_TYPE_PANEL_PREFIX
347
349
350} // namespace blender::ui
#define BKE_ST_MAXNAME
Definition BKE_screen.hh:91
#define BLI_string_join(...)
#define CTX_IFACE_(context, msgid)
#define BLT_I18NCONTEXT_OPERATOR_DEFAULT
#define IFACE_(msgid)
#define ID_IS_EDITABLE(_id)
Definition DNA_ID.h:708
#define MAX_NAME
Definition DNA_defs.h:63
#define RNA_warning(format,...)
#define C
Definition RandGen.cpp:29
#define UI_ITEM_NONE
btSequentialImpulseConstraintSolverMt int btPersistentManifold int btTypedConstraint ** constraints
#define CONSTRAINT_BONE_TYPE_PANEL_PREFIX
#define CONSTRAINT_TYPE_PANEL_PREFIX
#define ERROR_LIBDATA_MESSAGE
void constraint_active_set(Object *ob, bConstraint *con)
ListBaseT< bConstraint > * constraint_list_from_constraint(Object *ob, bConstraint *con, bPoseChannel **r_pchan)
Object * context_active_object(const bContext *C)
ListBaseT< bConstraint > * pose_constraint_list(const bContext *C)
void block_lock_set(Block *block, bool val, const char *lockstr)
void panel_context_pointer_set(Panel *panel, const char *name, PointerRNA *ptr)
void template_constraint_header(Layout *layout, PointerRNA *ptr)
static void bone_constraint_panel_id(void *md_link, char *r_idname)
void block_lock_clear(Block *block)
bool panel_list_matches_data(ARegion *region, ListBase *data, ListPanelIDFromDataFunc panel_idname_func)
static void draw_constraint_header(Layout &layout, Object *ob, bConstraint *con)
void(*)(void *data_link, char *r_idname) ListPanelIDFromDataFunc
static void constraint_reorder(bContext *C, Panel *panel, int new_index)
void panels_free_instanced(const bContext *C, ARegion *region)
void template_constraints(Layout *layout, bContext *C, bool use_bone_constraints)
void block_emboss_set(Block *block, EmbossType emboss)
void block_func_set(Block *block, ButtonHandleFunc func, void *arg1, void *arg2)
static void constraint_ops_extra_draw(bContext *C, Layout *layout, void *con_v)
static short get_constraint_expand_flag(const bContext *, Panel *panel)
void panel_custom_data_set(Panel *panel, PointerRNA *custom_data)
Panel * panel_add_instanced(const bContext *C, ARegion *region, ListBaseT< Panel > *panels, const char *panel_idname, PointerRNA *custom_data)
static bool constraint_panel_is_bone(Panel *panel)
static void constraint_active_func(bContext *, void *ob_v, void *con_v)
PointerRNA * panel_custom_data_get(const Panel *panel)
static void object_constraint_panel_id(void *md_link, char *r_idname)
static void set_constraint_expand_flag(const bContext *, Panel *panel, short expand_flag)
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
bool RNA_struct_is_a(const StructRNA *type, const StructRNA *srna)
const bConstraintTypeInfo * BKE_constraint_typeinfo_from_type(int type)
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)
PointerRNA WM_operator_properties_create_ptr(wmOperatorType *ot)
void RNA_enum_set(PointerRNA *ptr, const char *name, int value)
BMesh const char void * data
PointerRNA RNA_pointer_create_discrete(ID *id, StructRNA *type, void *data)
int RNA_struct_ui_icon(const StructRNA *type)
wmOperatorType * WM_operatortype_find(const char *idname, bool quiet)
@ PANEL_TYPE_INSTANCED
wmOperatorStatus WM_operator_name_call_ptr(bContext *C, wmOperatorType *ot, wm::OpCallContext context, PointerRNA *properties, const wmEvent *event)
ID_Type GS(const char *name)
Definition DNA_ID.h:410
ARegion * CTX_wm_region(const bContext *C)
ListBaseT< Panel > panels
char name[258]
Definition DNA_ID.h:433
ListBaseT< bConstraint > constraints
void(*) reorder(bContext *C, Panel *pa, int new_index)
short(*) get_list_data_expand_flag(const bContext *C, Panel *pa)
void(*) set_list_data_expand_flag(const bContext *C, Panel *pa, short expand_flag)
struct PanelType * type
struct Panel * next
StructRNA * type
Definition RNA_types.hh:63
struct bConstraint * prev
struct bConstraint * next
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)
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)