Blender  V3.3
rna_space_api.c
Go to the documentation of this file.
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 
7 #include "DNA_object_types.h"
8 
9 #include "RNA_access.h"
10 #include "RNA_define.h"
11 
12 #include "rna_internal.h"
13 
14 #ifdef RNA_RUNTIME
15 
16 # include "BKE_global.h"
17 
18 # include "ED_fileselect.h"
19 # include "ED_screen.h"
20 # include "ED_text.h"
21 
22 int rna_object_type_visibility_icon_get_common(int object_type_exclude_viewport,
23  const int *object_type_exclude_select)
24 {
25  const int view_value = (object_type_exclude_viewport != 0);
26 
27  if (object_type_exclude_select) {
28  /* Ignore selection values when view is off,
29  * intent is to show if visible objects aren't selectable. */
30  const int select_value = (*object_type_exclude_select & ~object_type_exclude_viewport) != 0;
31  return ICON_VIS_SEL_11 + (view_value << 1) + select_value;
32  }
33 
34  return view_value ? ICON_HIDE_ON : ICON_HIDE_OFF;
35 }
36 
37 static void rna_RegionView3D_update(ID *id, RegionView3D *rv3d, bContext *C)
38 {
39  bScreen *screen = (bScreen *)id;
40 
41  ScrArea *area;
42  ARegion *region;
43 
44  area_region_from_regiondata(screen, rv3d, &area, &region);
45 
46  if (area && region && area->spacetype == SPACE_VIEW3D) {
47  Main *bmain = CTX_data_main(C);
48  View3D *v3d = area->spacedata.first;
50  wmWindow *win;
51 
52  for (win = wm->windows.first; win; win = win->next) {
53  if (WM_window_get_active_screen(win) == screen) {
55  ViewLayer *view_layer = WM_window_get_active_view_layer(win);
56  Depsgraph *depsgraph = BKE_scene_ensure_depsgraph(bmain, scene, view_layer);
57 
58  ED_view3d_update_viewmat(depsgraph, scene, v3d, region, NULL, NULL, NULL, false);
59  break;
60  }
61  }
62  }
63 }
64 
65 static void rna_SpaceTextEditor_region_location_from_cursor(
66  ID *id, SpaceText *st, int line, int column, int r_pixel_pos[2])
67 {
68  bScreen *screen = (bScreen *)id;
70  if (area) {
72  const int cursor_co[2] = {line, column};
73  ED_text_region_location_from_cursor(st, region, cursor_co, r_pixel_pos);
74  }
75 }
76 
77 #else
78 
80 {
81  FunctionRNA *func;
82 
83  func = RNA_def_function(srna, "update", "rna_RegionView3D_update");
85  RNA_def_function_ui_description(func, "Recalculate the view matrices");
86 }
87 
89 {
90  FunctionRNA *func;
91  PropertyRNA *parm;
92 
93  func = RNA_def_function(
94  srna, "cursor_location_from_region", "rna_SpaceNodeEditor_cursor_location_from_region");
95  RNA_def_function_ui_description(func, "Set the cursor location using region coordinates");
97  parm = RNA_def_int(func, "x", 0, INT_MIN, INT_MAX, "x", "Region x coordinate", -10000, 10000);
99  parm = RNA_def_int(func, "y", 0, INT_MIN, INT_MAX, "y", "Region y coordinate", -10000, 10000);
101 }
102 
104 {
105  FunctionRNA *func;
106  PropertyRNA *parm;
107 
108  func = RNA_def_function(
109  srna, "region_location_from_cursor", "rna_SpaceTextEditor_region_location_from_cursor");
111  func, "Retrieve the region position from the given line and character position");
113  parm = RNA_def_int(func, "line", 0, INT_MIN, INT_MAX, "Line", "Line index", 0, INT_MAX);
115  parm = RNA_def_int(func, "column", 0, INT_MIN, INT_MAX, "Column", "Column index", 0, INT_MAX);
117  parm = RNA_def_int_array(
118  func, "result", 2, NULL, -1, INT_MAX, "", "Region coordinates", -1, INT_MAX);
119  RNA_def_function_output(func, parm);
120 }
121 
123 {
124  PropertyRNA *prop;
125 
126  struct {
127  const char *name;
128  int type_mask;
129  const char *identifier[2];
130  } info[] = {
131  {"Mesh", (1 << OB_MESH), {"show_object_viewport_mesh", "show_object_select_mesh"}},
132  {"Curve",
133  (1 << OB_CURVES_LEGACY),
134  {"show_object_viewport_curve", "show_object_select_curve"}},
135  {"Surface", (1 << OB_SURF), {"show_object_viewport_surf", "show_object_select_surf"}},
136  {"Meta", (1 << OB_MBALL), {"show_object_viewport_meta", "show_object_select_meta"}},
137  {"Font", (1 << OB_FONT), {"show_object_viewport_font", "show_object_select_font"}},
138  {"Hair Curves",
139  (1 << OB_CURVES),
140  {"show_object_viewport_curves", "show_object_select_curves"}},
141  {"Point Cloud",
142  (1 << OB_POINTCLOUD),
143  {"show_object_viewport_pointcloud", "show_object_select_pointcloud"}},
144  {"Volume", (1 << OB_VOLUME), {"show_object_viewport_volume", "show_object_select_volume"}},
145  {"Armature",
146  (1 << OB_ARMATURE),
147  {"show_object_viewport_armature", "show_object_select_armature"}},
148  {"Lattice",
149  (1 << OB_LATTICE),
150  {"show_object_viewport_lattice", "show_object_select_lattice"}},
151  {"Empty", (1 << OB_EMPTY), {"show_object_viewport_empty", "show_object_select_empty"}},
152  {"Grease Pencil",
153  (1 << OB_GPENCIL),
154  {"show_object_viewport_grease_pencil", "show_object_select_grease_pencil"}},
155  {"Camera", (1 << OB_CAMERA), {"show_object_viewport_camera", "show_object_select_camera"}},
156  {"Light", (1 << OB_LAMP), {"show_object_viewport_light", "show_object_select_light"}},
157  {"Speaker",
158  (1 << OB_SPEAKER),
159  {"show_object_viewport_speaker", "show_object_select_speaker"}},
160  {"Light Probe",
161  (1 << OB_LIGHTPROBE),
162  {"show_object_viewport_light_probe", "show_object_select_light_probe"}},
163  };
164 
165  const char *view_mask_member[2] = {
166  "object_type_exclude_viewport",
167  "object_type_exclude_select",
168  };
169  for (int mask_index = 0; mask_index < 2; mask_index++) {
170  for (int type_index = 0; type_index < ARRAY_SIZE(info); type_index++) {
171  prop = RNA_def_property(
172  srna, info[type_index].identifier[mask_index], PROP_BOOLEAN, PROP_NONE);
174  prop, NULL, view_mask_member[mask_index], info[type_index].type_mask);
175  RNA_def_property_ui_text(prop, info[type_index].name, "");
176  RNA_def_property_update(prop, noteflag, NULL);
177  }
178  }
179 }
180 
182 {
183  FunctionRNA *func;
184  PropertyRNA *parm;
185 
186  func = RNA_def_function(srna, "activate_asset_by_id", "ED_fileselect_activate_by_id");
188  func, "Activate and select the asset entry that represents the given ID");
189 
190  parm = RNA_def_property(func, "id_to_activate", PROP_POINTER, PROP_NONE);
191  RNA_def_property_struct_type(parm, "ID");
193 
194  parm = RNA_def_boolean(
195  func,
196  "deferred",
197  0,
198  "",
199  "Whether to activate the ID immediately (false) or after the file browser refreshes (true)");
200 
201  /* Select file by relative path. */
202  func = RNA_def_function(
203  srna, "activate_file_by_relative_path", "ED_fileselect_activate_by_relpath");
205  "Set active file and add to selection based on relative path to "
206  "current File Browser directory");
207  RNA_def_property(func, "relative_path", PROP_STRING, PROP_FILEPATH);
208 
209  /* Deselect all files. */
210  func = RNA_def_function(srna, "deselect_all", "ED_fileselect_deselect_all");
211  RNA_def_function_ui_description(func, "Deselect all files");
212 }
213 
214 #endif
struct wmWindowManager * CTX_wm_manager(const bContext *C)
Definition: context.c:713
struct Main * CTX_data_main(const bContext *C)
Definition: context.c:1074
struct Depsgraph * BKE_scene_ensure_depsgraph(struct Main *bmain, struct Scene *scene, struct ViewLayer *view_layer)
Definition: scene.cc:3456
struct ARegion * BKE_area_find_region_type(const struct ScrArea *area, int type)
struct ARegion struct ARegion struct ScrArea * BKE_screen_find_area_from_space(struct bScreen *screen, struct SpaceLink *sl) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1
#define ARRAY_SIZE(arr)
struct Depsgraph Depsgraph
Definition: DEG_depsgraph.h:35
Object is a sort of wrapper for general info.
@ OB_SPEAKER
@ OB_LATTICE
@ OB_MBALL
@ OB_EMPTY
@ OB_SURF
@ OB_CAMERA
@ OB_FONT
@ OB_ARMATURE
@ OB_LAMP
@ OB_MESH
@ OB_POINTCLOUD
@ OB_VOLUME
@ OB_CURVES_LEGACY
@ OB_CURVES
@ OB_GPENCIL
@ OB_LIGHTPROBE
@ RGN_TYPE_WINDOW
@ SPACE_VIEW3D
bool ED_text_region_location_from_cursor(struct SpaceText *st, struct ARegion *region, const int cursor_co[2], int r_pixel_co[2])
void ED_view3d_update_viewmat(struct Depsgraph *depsgraph, const struct Scene *scene, struct View3D *v3d, struct ARegion *region, const float viewmat[4][4], const float winmat[4][4], const struct rcti *rect, bool offscreen)
@ PARM_REQUIRED
Definition: RNA_types.h:352
@ FUNC_USE_CONTEXT
Definition: RNA_types.h:662
@ FUNC_USE_SELF_ID
Definition: RNA_types.h:650
@ PROP_BOOLEAN
Definition: RNA_types.h:59
@ PROP_STRING
Definition: RNA_types.h:62
@ PROP_POINTER
Definition: RNA_types.h:64
@ PROP_NONE
Definition: RNA_types.h:126
@ PROP_FILEPATH
Definition: RNA_types.h:129
#define C
Definition: RandGen.cpp:25
Scene scene
const Depsgraph * depsgraph
static void area(int d1, int d2, int e1, int e2, float weights[2])
static const pxr::TfToken st("st", pxr::TfToken::Immortal)
PropertyRNA * RNA_def_boolean(StructOrFunctionRNA *cont_, const char *identifier, bool default_value, const char *ui_name, const char *ui_description)
Definition: rna_define.c:3493
PropertyRNA * RNA_def_int_array(StructOrFunctionRNA *cont_, const char *identifier, int len, const int *default_value, int hardmin, int hardmax, const char *ui_name, const char *ui_description, int softmin, int softmax)
Definition: rna_define.c:3655
void RNA_def_property_ui_text(PropertyRNA *prop, const char *name, const char *description)
Definition: rna_define.c:1645
FunctionRNA * RNA_def_function(StructRNA *srna, const char *identifier, const char *call)
Definition: rna_define.c:4273
void RNA_def_function_output(FunctionRNA *UNUSED(func), PropertyRNA *ret)
Definition: rna_define.c:4337
void RNA_def_property_struct_type(PropertyRNA *prop, const char *type)
Definition: rna_define.c:1772
void RNA_def_function_ui_description(FunctionRNA *func, const char *description)
Definition: rna_define.c:4347
void RNA_def_property_update(PropertyRNA *prop, int noteflag, const char *func)
Definition: rna_define.c:2900
PropertyRNA * RNA_def_property(StructOrFunctionRNA *cont_, const char *identifier, int type, int subtype)
Definition: rna_define.c:1257
void RNA_def_function_flag(FunctionRNA *func, int flag)
Definition: rna_define.c:4342
PropertyRNA * RNA_def_int(StructOrFunctionRNA *cont_, const char *identifier, int default_value, int hardmin, int hardmax, const char *ui_name, const char *ui_description, int softmin, int softmax)
Definition: rna_define.c:3597
void RNA_def_property_boolean_negative_sdna(PropertyRNA *prop, const char *structname, const char *propname, int64_t booleanbit)
Definition: rna_define.c:2327
void RNA_def_parameter_flags(PropertyRNA *prop, PropertyFlag flag_property, ParameterFlag flag_parameter)
Definition: rna_define.c:1518
int rna_object_type_visibility_icon_get_common(int object_type_exclude_viewport, const int *object_type_exclude_select)
void RNA_api_region_view3d(StructRNA *srna)
Definition: rna_space_api.c:79
void rna_def_object_type_visibility_flags_common(StructRNA *srna, int noteflag)
void RNA_api_space_filebrowser(StructRNA *srna)
void RNA_api_space_node(StructRNA *srna)
Definition: rna_space_api.c:88
void RNA_api_space_text(StructRNA *srna)
Definition: DNA_ID.h:368
void * first
Definition: DNA_listBase.h:31
Definition: BKE_main.h:121
struct wmWindow * next
bScreen * WM_window_get_active_screen(const wmWindow *win)
Definition: wm_window.c:2300
ViewLayer * WM_window_get_active_view_layer(const wmWindow *win)
Definition: wm_window.c:2217
Scene * WM_window_get_active_scene(const wmWindow *win)
Definition: wm_window.c:2183