Fix misleading image color space and alpha tooltips
[blender.git] / source / blender / makesrna / intern / rna_workspace.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file
18  * \ingroup RNA
19  */
20
21 #include "RNA_define.h"
22 #include "RNA_enum_types.h"
23 #include "RNA_types.h"
24
25 #include "BKE_workspace.h"
26
27 #include "ED_render.h"
28
29 #include "RE_engine.h"
30
31 #include "WM_api.h"
32 #include "WM_types.h"
33
34 #include "rna_internal.h"
35
36 #include "DNA_workspace_types.h"
37
38 #ifdef RNA_RUNTIME
39
40 #  include "BLI_listbase.h"
41
42 #  include "BKE_global.h"
43
44 #  include "DNA_object_types.h"
45 #  include "DNA_screen_types.h"
46 #  include "DNA_space_types.h"
47
48 #  include "RNA_access.h"
49
50 #  include "WM_toolsystem.h"
51
52 static void rna_window_update_all(Main *UNUSED(bmain),
53                                   Scene *UNUSED(scene),
54                                   PointerRNA *UNUSED(ptr))
55 {
56   WM_main_add_notifier(NC_WINDOW, NULL);
57 }
58
59 void rna_workspace_screens_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
60 {
61   WorkSpace *workspace = ptr->id.data;
62   rna_iterator_listbase_begin(iter, BKE_workspace_layouts_get(workspace), NULL);
63 }
64
65 static PointerRNA rna_workspace_screens_item_get(CollectionPropertyIterator *iter)
66 {
67   WorkSpaceLayout *layout = rna_iterator_listbase_get(iter);
68   bScreen *screen = BKE_workspace_layout_screen_get(layout);
69
70   return rna_pointer_inherit_refine(&iter->parent, &RNA_Screen, screen);
71 }
72
73 /* workspace.owner_ids */
74
75 static wmOwnerID *rna_WorkSpace_owner_ids_new(WorkSpace *workspace, const char *name)
76 {
77   wmOwnerID *owner_id = MEM_callocN(sizeof(*owner_id), __func__);
78   BLI_addtail(&workspace->owner_ids, owner_id);
79   BLI_strncpy(owner_id->name, name, sizeof(owner_id->name));
80   WM_main_add_notifier(NC_WINDOW, NULL);
81   return owner_id;
82 }
83
84 static void rna_WorkSpace_owner_ids_remove(WorkSpace *workspace,
85                                            ReportList *reports,
86                                            PointerRNA *wstag_ptr)
87 {
88   wmOwnerID *owner_id = wstag_ptr->data;
89   if (BLI_remlink_safe(&workspace->owner_ids, owner_id) == false) {
90     BKE_reportf(reports,
91                 RPT_ERROR,
92                 "wmOwnerID '%s' not in workspace '%s'",
93                 owner_id->name,
94                 workspace->id.name + 2);
95     return;
96   }
97
98   MEM_freeN(owner_id);
99   RNA_POINTER_INVALIDATE(wstag_ptr);
100
101   WM_main_add_notifier(NC_WINDOW, NULL);
102 }
103
104 static void rna_WorkSpace_owner_ids_clear(WorkSpace *workspace)
105 {
106   BLI_freelistN(&workspace->owner_ids);
107   WM_main_add_notifier(NC_OBJECT | ND_MODIFIER | NA_REMOVED, workspace);
108 }
109
110 static bToolRef *rna_WorkSpace_tools_from_tkey(WorkSpace *workspace,
111                                                const bToolKey *tkey,
112                                                bool create)
113 {
114   if (create) {
115     bToolRef *tref;
116     WM_toolsystem_ref_ensure(workspace, tkey, &tref);
117     return tref;
118   }
119   return WM_toolsystem_ref_find(workspace, tkey);
120 }
121
122 static bToolRef *rna_WorkSpace_tools_from_space_view3d_mode(WorkSpace *workspace,
123                                                             int mode,
124                                                             bool create)
125 {
126   return rna_WorkSpace_tools_from_tkey(workspace,
127                                        &(bToolKey){
128                                            .space_type = SPACE_VIEW3D,
129                                            .mode = mode,
130                                        },
131                                        create);
132 }
133
134 static bToolRef *rna_WorkSpace_tools_from_space_image_mode(WorkSpace *workspace,
135                                                            int mode,
136                                                            bool create)
137 {
138   return rna_WorkSpace_tools_from_tkey(workspace,
139                                        &(bToolKey){
140                                            .space_type = SPACE_IMAGE,
141                                            .mode = mode,
142                                        },
143                                        create);
144 }
145
146 static bToolRef *rna_WorkSpace_tools_from_space_node(WorkSpace *workspace, bool create)
147 {
148   return rna_WorkSpace_tools_from_tkey(workspace,
149                                        &(bToolKey){
150                                            .space_type = SPACE_NODE,
151                                            .mode = 0,
152                                        },
153                                        create);
154 }
155
156 const EnumPropertyItem *rna_WorkSpace_tools_mode_itemf(bContext *UNUSED(C),
157                                                        PointerRNA *ptr,
158                                                        PropertyRNA *UNUSED(prop),
159                                                        bool *UNUSED(r_free))
160 {
161   bToolRef *tref = ptr->data;
162   switch (tref->space_type) {
163     case SPACE_VIEW3D:
164       return rna_enum_context_mode_items;
165     case SPACE_IMAGE:
166       return rna_enum_space_image_mode_all_items;
167   }
168   return DummyRNA_DEFAULT_items;
169 }
170
171 static int rna_WorkSpaceTool_index_get(PointerRNA *ptr)
172 {
173   bToolRef *tref = ptr->data;
174   return (tref->runtime) ? tref->runtime->index : 0;
175 }
176
177 static int rna_WorkSpaceTool_has_datablock_get(PointerRNA *ptr)
178 {
179   bToolRef *tref = ptr->data;
180   return (tref->runtime) ? (tref->runtime->data_block[0] != '\0') : false;
181 }
182
183 static void rna_WorkSpaceTool_widget_get(PointerRNA *ptr, char *value)
184 {
185   bToolRef *tref = ptr->data;
186   strcpy(value, tref->runtime ? tref->runtime->gizmo_group : "");
187 }
188
189 static int rna_WorkSpaceTool_widget_length(PointerRNA *ptr)
190 {
191   bToolRef *tref = ptr->data;
192   return tref->runtime ? strlen(tref->runtime->gizmo_group) : 0;
193 }
194
195 #else /* RNA_RUNTIME */
196
197 static void rna_def_workspace_owner(BlenderRNA *brna)
198 {
199   StructRNA *srna;
200   PropertyRNA *prop;
201
202   srna = RNA_def_struct(brna, "wmOwnerID", NULL);
203   RNA_def_struct_sdna(srna, "wmOwnerID");
204   RNA_def_struct_clear_flag(srna, STRUCT_UNDO);
205   RNA_def_struct_ui_text(srna, "Work Space UI Tag", "");
206
207   prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
208   RNA_def_property_ui_text(prop, "Name", "");
209   RNA_def_struct_name_property(srna, prop);
210 }
211
212 static void rna_def_workspace_owner_ids(BlenderRNA *brna, PropertyRNA *cprop)
213 {
214   StructRNA *srna;
215
216   FunctionRNA *func;
217   PropertyRNA *parm;
218
219   RNA_def_property_srna(cprop, "wmOwnerIDs");
220   srna = RNA_def_struct(brna, "wmOwnerIDs", NULL);
221   RNA_def_struct_sdna(srna, "WorkSpace");
222   RNA_def_struct_ui_text(srna, "WorkSpace UI Tags", "");
223
224   /* add owner_id */
225   func = RNA_def_function(srna, "new", "rna_WorkSpace_owner_ids_new");
226   RNA_def_function_ui_description(func, "Add ui tag");
227   parm = RNA_def_string(func, "name", "Name", 0, "", "New name for the tag");
228   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
229   /* return type */
230   parm = RNA_def_pointer(func, "owner_id", "wmOwnerID", "", "");
231   RNA_def_function_return(func, parm);
232
233   /* remove owner_id */
234   func = RNA_def_function(srna, "remove", "rna_WorkSpace_owner_ids_remove");
235   RNA_def_function_flag(func, FUNC_USE_REPORTS);
236   RNA_def_function_ui_description(func, "Remove ui tag");
237   /* owner_id to remove */
238   parm = RNA_def_pointer(func, "owner_id", "wmOwnerID", "", "Tag to remove");
239   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
240   RNA_def_parameter_clear_flags(parm, PROP_THICK_WRAP, 0);
241
242   /* clear all modifiers */
243   func = RNA_def_function(srna, "clear", "rna_WorkSpace_owner_ids_clear");
244   RNA_def_function_ui_description(func, "Remove all tags");
245 }
246
247 static void rna_def_workspace_tool(BlenderRNA *brna)
248 {
249   StructRNA *srna;
250   PropertyRNA *prop;
251
252   srna = RNA_def_struct(brna, "WorkSpaceTool", NULL);
253   RNA_def_struct_sdna(srna, "bToolRef");
254   RNA_def_struct_clear_flag(srna, STRUCT_UNDO);
255   RNA_def_struct_ui_text(srna, "Work Space Tool", "");
256
257   prop = RNA_def_property(srna, "idname", PROP_STRING, PROP_NONE);
258   RNA_def_property_ui_text(prop, "Identifier", "");
259   RNA_def_struct_name_property(srna, prop);
260
261   prop = RNA_def_property(srna, "index", PROP_INT, PROP_NONE);
262   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
263   RNA_def_property_ui_text(prop, "Index", "");
264   RNA_def_property_int_funcs(prop, "rna_WorkSpaceTool_index_get", NULL, NULL);
265
266   prop = RNA_def_property(srna, "space_type", PROP_ENUM, PROP_NONE);
267   RNA_def_property_enum_sdna(prop, NULL, "space_type");
268   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
269   RNA_def_property_enum_items(prop, rna_enum_space_type_items);
270   RNA_def_property_ui_text(prop, "Space Type", "");
271
272   prop = RNA_def_property(srna, "mode", PROP_ENUM, PROP_NONE);
273   RNA_def_property_enum_sdna(prop, NULL, "mode");
274   RNA_def_property_enum_items(prop, DummyRNA_DEFAULT_items);
275   RNA_def_property_enum_funcs(prop, NULL, NULL, "rna_WorkSpace_tools_mode_itemf");
276   RNA_def_property_ui_text(prop, "Tool Mode", "");
277   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
278
279   RNA_define_verify_sdna(0);
280   prop = RNA_def_property(srna, "has_datablock", PROP_BOOLEAN, PROP_NONE);
281   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
282   RNA_def_property_ui_text(prop, "Has Datablock", "");
283   RNA_def_property_boolean_funcs(prop, "rna_WorkSpaceTool_has_datablock_get", NULL);
284   RNA_define_verify_sdna(1);
285
286   prop = RNA_def_property(srna, "widget", PROP_STRING, PROP_NONE);
287   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
288   RNA_def_property_ui_text(prop, "Widget", "");
289   RNA_def_property_string_funcs(
290       prop, "rna_WorkSpaceTool_widget_get", "rna_WorkSpaceTool_widget_length", NULL);
291   RNA_define_verify_sdna(1);
292
293   RNA_api_workspace_tool(srna);
294 }
295
296 static void rna_def_workspace_tools(BlenderRNA *brna, PropertyRNA *cprop)
297 {
298   StructRNA *srna;
299
300   FunctionRNA *func;
301   PropertyRNA *parm;
302
303   RNA_def_property_srna(cprop, "wmTools");
304   srna = RNA_def_struct(brna, "wmTools", NULL);
305   RNA_def_struct_sdna(srna, "WorkSpace");
306   RNA_def_struct_ui_text(srna, "WorkSpace UI Tags", "");
307
308   /* add owner_id */
309   func = RNA_def_function(
310       srna, "from_space_view3d_mode", "rna_WorkSpace_tools_from_space_view3d_mode");
311   RNA_def_function_ui_description(func, "");
312   parm = RNA_def_enum(func, "mode", rna_enum_context_mode_items, 0, "", "");
313   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
314   RNA_def_boolean(func, "create", false, "Create", "");
315   /* return type */
316   parm = RNA_def_pointer(func, "result", "WorkSpaceTool", "", "");
317   RNA_def_function_return(func, parm);
318
319   func = RNA_def_function(
320       srna, "from_space_image_mode", "rna_WorkSpace_tools_from_space_image_mode");
321   RNA_def_function_ui_description(func, "");
322   parm = RNA_def_enum(func, "mode", rna_enum_space_image_mode_all_items, 0, "", "");
323   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
324   RNA_def_boolean(func, "create", false, "Create", "");
325   /* return type */
326   parm = RNA_def_pointer(func, "result", "WorkSpaceTool", "", "");
327   RNA_def_function_return(func, parm);
328
329   func = RNA_def_function(srna, "from_space_node", "rna_WorkSpace_tools_from_space_node");
330   RNA_def_function_ui_description(func, "");
331   RNA_def_boolean(func, "create", false, "Create", "");
332   /* return type */
333   parm = RNA_def_pointer(func, "result", "WorkSpaceTool", "", "");
334   RNA_def_function_return(func, parm);
335 }
336
337 static void rna_def_workspace(BlenderRNA *brna)
338 {
339   StructRNA *srna;
340   PropertyRNA *prop;
341
342   srna = RNA_def_struct(brna, "WorkSpace", "ID");
343   RNA_def_struct_sdna(srna, "WorkSpace");
344   RNA_def_struct_ui_text(
345       srna, "Workspace", "Workspace data-block, defining the working environment for the user");
346   /* TODO: real icon, just to show something */
347   RNA_def_struct_ui_icon(srna, ICON_WORKSPACE);
348
349   prop = RNA_def_property(srna, "screens", PROP_COLLECTION, PROP_NONE);
350   RNA_def_property_collection_sdna(prop, NULL, "layouts", NULL);
351   RNA_def_property_struct_type(prop, "Screen");
352   RNA_def_property_collection_funcs(prop,
353                                     "rna_workspace_screens_begin",
354                                     NULL,
355                                     NULL,
356                                     "rna_workspace_screens_item_get",
357                                     NULL,
358                                     NULL,
359                                     NULL,
360                                     NULL);
361   RNA_def_property_ui_text(prop, "Screens", "Screen layouts of a workspace");
362
363   prop = RNA_def_property(srna, "owner_ids", PROP_COLLECTION, PROP_NONE);
364   RNA_def_property_struct_type(prop, "wmOwnerID");
365   RNA_def_property_ui_text(prop, "UI Tags", "");
366   rna_def_workspace_owner_ids(brna, prop);
367
368   prop = RNA_def_property(srna, "tools", PROP_COLLECTION, PROP_NONE);
369   RNA_def_property_collection_sdna(prop, NULL, "tools", NULL);
370   RNA_def_property_struct_type(prop, "WorkSpaceTool");
371   RNA_def_property_ui_text(prop, "Tools", "");
372   rna_def_workspace_tools(brna, prop);
373
374   prop = RNA_def_property(srna, "object_mode", PROP_ENUM, PROP_NONE);
375   RNA_def_property_enum_items(prop, rna_enum_workspace_object_mode_items);
376   RNA_def_property_ui_text(
377       prop, "Object Mode", "Switch to this object mode when activating the workspace");
378
379   /* Flags */
380   prop = RNA_def_property(srna, "use_filter_by_owner", PROP_BOOLEAN, PROP_NONE);
381   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
382   RNA_def_property_boolean_sdna(prop, NULL, "flags", WORKSPACE_USE_FILTER_BY_ORIGIN);
383   RNA_def_property_ui_text(prop, "Use UI Tags", "Filter the UI by tags");
384   RNA_def_property_update(prop, 0, "rna_window_update_all");
385
386   RNA_api_workspace(srna);
387 }
388
389 void RNA_def_workspace(BlenderRNA *brna)
390 {
391   rna_def_workspace_owner(brna);
392   rna_def_workspace_tool(brna);
393
394   rna_def_workspace(brna);
395 }
396
397 #endif /* RNA_RUNTIME */