Cleanup: Remove unused enum
[blender.git] / source / blender / makesrna / intern / rna_object_api.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  * The Original Code is Copyright (C) 2009 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup RNA
22  */
23
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #include <time.h>
28
29 #include "BLI_kdopbvh.h"
30 #include "BLI_utildefines.h"
31
32 #include "RNA_define.h"
33
34 #include "DNA_constraint_types.h"
35 #include "DNA_layer_types.h"
36 #include "DNA_modifier_types.h"
37 #include "DNA_object_types.h"
38
39 #include "BKE_gpencil_curve.h"
40 #include "BKE_layer.h"
41
42 #include "DEG_depsgraph.h"
43
44 #include "ED_outliner.h"
45
46 #include "rna_internal.h" /* own include */
47
48 static const EnumPropertyItem space_items[] = {
49     {CONSTRAINT_SPACE_WORLD, "WORLD", 0, "World Space", "The most global space in Blender"},
50     {CONSTRAINT_SPACE_POSE,
51      "POSE",
52      0,
53      "Pose Space",
54      "The pose space of a bone (its armature's object space)"},
55     {CONSTRAINT_SPACE_PARLOCAL,
56      "LOCAL_WITH_PARENT",
57      0,
58      "Local With Parent",
59      "The rest pose local space of a bone (thus matrix includes parent transforms)"},
60     {CONSTRAINT_SPACE_LOCAL, "LOCAL", 0, "Local Space", "The local space of an object/bone"},
61     {0, NULL, 0, NULL, NULL},
62 };
63
64 #ifdef RNA_RUNTIME
65
66 #  include "BLI_math.h"
67
68 #  include "BKE_bvhutils.h"
69 #  include "BKE_constraint.h"
70 #  include "BKE_context.h"
71 #  include "BKE_customdata.h"
72 #  include "BKE_global.h"
73 #  include "BKE_layer.h"
74 #  include "BKE_main.h"
75 #  include "BKE_mball.h"
76 #  include "BKE_mesh.h"
77 #  include "BKE_modifier.h"
78 #  include "BKE_object.h"
79 #  include "BKE_report.h"
80 #  include "BKE_vfont.h"
81
82 #  include "ED_object.h"
83 #  include "ED_screen.h"
84
85 #  include "DNA_curve_types.h"
86 #  include "DNA_mesh_types.h"
87 #  include "DNA_meshdata_types.h"
88 #  include "DNA_scene_types.h"
89 #  include "DNA_view3d_types.h"
90
91 #  include "DEG_depsgraph_query.h"
92
93 #  include "MEM_guardedalloc.h"
94
95 static void rna_Object_select_set(
96     Object *ob, bContext *C, ReportList *reports, bool select, ViewLayer *view_layer)
97 {
98   if (view_layer == NULL) {
99     view_layer = CTX_data_view_layer(C);
100   }
101   Base *base = BKE_view_layer_base_find(view_layer, ob);
102
103   if (!base) {
104     if (select) {
105       BKE_reportf(reports,
106                   RPT_ERROR,
107                   "Object '%s' can't be selected because it is not in View Layer '%s'!",
108                   ob->id.name + 2,
109                   view_layer->name);
110     }
111     return;
112   }
113
114   ED_object_base_select(base, select ? BA_SELECT : BA_DESELECT);
115
116   Scene *scene = CTX_data_scene(C);
117   DEG_id_tag_update(&scene->id, ID_RECALC_SELECT);
118   WM_main_add_notifier(NC_SCENE | ND_OB_SELECT, scene);
119   ED_outliner_select_sync_from_object_tag(C);
120 }
121
122 static bool rna_Object_select_get(Object *ob, bContext *C, ViewLayer *view_layer)
123 {
124   if (view_layer == NULL) {
125     view_layer = CTX_data_view_layer(C);
126   }
127   Base *base = BKE_view_layer_base_find(view_layer, ob);
128
129   if (!base) {
130     return false;
131   }
132
133   return ((base->flag & BASE_SELECTED) != 0);
134 }
135
136 static void rna_Object_hide_set(
137     Object *ob, bContext *C, ReportList *reports, bool hide, ViewLayer *view_layer)
138 {
139   if (view_layer == NULL) {
140     view_layer = CTX_data_view_layer(C);
141   }
142   Base *base = BKE_view_layer_base_find(view_layer, ob);
143
144   if (!base) {
145     if (hide) {
146       BKE_reportf(reports,
147                   RPT_ERROR,
148                   "Object '%s' can't be hidden because it is not in View Layer '%s'!",
149                   ob->id.name + 2,
150                   view_layer->name);
151     }
152     return;
153   }
154
155   if (hide) {
156     base->flag |= BASE_HIDDEN;
157   }
158   else {
159     base->flag &= ~BASE_HIDDEN;
160   }
161
162   Scene *scene = CTX_data_scene(C);
163   BKE_layer_collection_sync(scene, view_layer);
164   DEG_id_tag_update(&scene->id, ID_RECALC_BASE_FLAGS);
165   WM_event_add_notifier(C, NC_SCENE | ND_OB_SELECT, scene);
166 }
167
168 static bool rna_Object_hide_get(Object *ob, bContext *C, ViewLayer *view_layer)
169 {
170   if (view_layer == NULL) {
171     view_layer = CTX_data_view_layer(C);
172   }
173   Base *base = BKE_view_layer_base_find(view_layer, ob);
174
175   if (!base) {
176     return false;
177   }
178
179   return ((base->flag & BASE_HIDDEN) != 0);
180 }
181
182 static bool rna_Object_visible_get(Object *ob, bContext *C, ViewLayer *view_layer, View3D *v3d)
183 {
184   if (view_layer == NULL) {
185     view_layer = CTX_data_view_layer(C);
186   }
187   if (v3d == NULL) {
188     v3d = CTX_wm_view3d(C);
189   }
190   Base *base = BKE_view_layer_base_find(view_layer, ob);
191
192   if (!base) {
193     return false;
194   }
195
196   return BASE_VISIBLE(v3d, base);
197 }
198
199 static bool rna_Object_holdout_get(Object *ob, bContext *C, ViewLayer *view_layer)
200 {
201   if (view_layer == NULL) {
202     view_layer = CTX_data_view_layer(C);
203   }
204   Base *base = BKE_view_layer_base_find(view_layer, ob);
205
206   if (!base) {
207     return false;
208   }
209
210   return ((base->flag & BASE_HOLDOUT) != 0);
211 }
212
213 static bool rna_Object_indirect_only_get(Object *ob, bContext *C, ViewLayer *view_layer)
214 {
215   if (view_layer == NULL) {
216     view_layer = CTX_data_view_layer(C);
217   }
218   Base *base = BKE_view_layer_base_find(view_layer, ob);
219
220   if (!base) {
221     return false;
222   }
223
224   return ((base->flag & BASE_INDIRECT_ONLY) != 0);
225 }
226
227 static Base *rna_Object_local_view_property_helper(bScreen *screen,
228                                                    View3D *v3d,
229                                                    ViewLayer *view_layer,
230                                                    Object *ob,
231                                                    ReportList *reports,
232                                                    Scene **r_scene)
233 {
234   wmWindow *win = NULL;
235   if (v3d->localvd == NULL) {
236     BKE_report(reports, RPT_ERROR, "Viewport not in local view");
237     return NULL;
238   }
239
240   if (view_layer == NULL) {
241     win = ED_screen_window_find(screen, G_MAIN->wm.first);
242     view_layer = WM_window_get_active_view_layer(win);
243   }
244
245   Base *base = BKE_view_layer_base_find(view_layer, ob);
246   if (base == NULL) {
247     BKE_reportf(
248         reports, RPT_WARNING, "Object %s not in view layer %s", ob->id.name + 2, view_layer->name);
249   }
250   if (r_scene != NULL && win != NULL) {
251     *r_scene = win->scene;
252   }
253   return base;
254 }
255
256 static bool rna_Object_local_view_get(Object *ob, ReportList *reports, View3D *v3d)
257 {
258   if (v3d->localvd == NULL) {
259     BKE_report(reports, RPT_ERROR, "Viewport not in local view");
260     return false;
261   }
262
263   return ((ob->base_local_view_bits & v3d->local_view_uuid) != 0);
264 }
265
266 static void rna_Object_local_view_set(Object *ob,
267                                       ReportList *reports,
268                                       PointerRNA *v3d_ptr,
269                                       bool state)
270 {
271   bScreen *screen = (bScreen *)v3d_ptr->owner_id;
272   View3D *v3d = v3d_ptr->data;
273   Scene *scene;
274   Base *base = rna_Object_local_view_property_helper(screen, v3d, NULL, ob, reports, &scene);
275   if (base == NULL) {
276     return; /* Error reported. */
277   }
278   const short local_view_bits_prev = base->local_view_bits;
279   SET_FLAG_FROM_TEST(base->local_view_bits, state, v3d->local_view_uuid);
280   if (local_view_bits_prev != base->local_view_bits) {
281     DEG_id_tag_update(&scene->id, ID_RECALC_BASE_FLAGS);
282     ScrArea *area = ED_screen_area_find_with_spacedata(screen, (SpaceLink *)v3d, true);
283     if (area) {
284       ED_area_tag_redraw(area);
285     }
286   }
287 }
288
289 static bool rna_Object_visible_in_viewport_get(Object *ob, View3D *v3d)
290 {
291   return BKE_object_is_visible_in_viewport(v3d, ob);
292 }
293
294 /* Convert a given matrix from a space to another (using the object and/or a bone as
295  * reference). */
296 static void rna_Object_mat_convert_space(Object *ob,
297                                          ReportList *reports,
298                                          bPoseChannel *pchan,
299                                          float mat[16],
300                                          float mat_ret[16],
301                                          int from,
302                                          int to)
303 {
304   copy_m4_m4((float(*)[4])mat_ret, (float(*)[4])mat);
305
306   BLI_assert(!ELEM(from, CONSTRAINT_SPACE_OWNLOCAL));
307   BLI_assert(!ELEM(to, CONSTRAINT_SPACE_OWNLOCAL));
308
309   /* Error in case of invalid from/to values when pchan is NULL */
310   if (pchan == NULL) {
311     if (ELEM(from, CONSTRAINT_SPACE_POSE, CONSTRAINT_SPACE_PARLOCAL)) {
312       const char *identifier = NULL;
313       RNA_enum_identifier(space_items, from, &identifier);
314       BKE_reportf(reports,
315                   RPT_ERROR,
316                   "'from_space' '%s' is invalid when no pose bone is given!",
317                   identifier);
318       return;
319     }
320     if (ELEM(to, CONSTRAINT_SPACE_POSE, CONSTRAINT_SPACE_PARLOCAL)) {
321       const char *identifier = NULL;
322       RNA_enum_identifier(space_items, to, &identifier);
323       BKE_reportf(reports,
324                   RPT_ERROR,
325                   "'to_space' '%s' is invalid when no pose bone is given!",
326                   identifier);
327       return;
328     }
329   }
330   /* These checks are extra security, they should never occur. */
331   if (from == CONSTRAINT_SPACE_CUSTOM) {
332     const char *identifier = NULL;
333     RNA_enum_identifier(space_items, from, &identifier);
334     BKE_reportf(reports,
335                 RPT_ERROR,
336                 "'from_space' '%s' is invalid when no custom space is given!",
337                 identifier);
338     return;
339   }
340   if (to == CONSTRAINT_SPACE_CUSTOM) {
341     const char *identifier = NULL;
342     RNA_enum_identifier(space_items, to, &identifier);
343     BKE_reportf(reports,
344                 RPT_ERROR,
345                 "'to_space' '%s' is invalid when no custom space is given!",
346                 identifier);
347     return;
348   }
349
350   BKE_constraint_mat_convertspace(ob, pchan, NULL, (float(*)[4])mat_ret, from, to, false);
351 }
352
353 static void rna_Object_calc_matrix_camera(Object *ob,
354                                           Depsgraph *depsgraph,
355                                           float mat_ret[16],
356                                           int width,
357                                           int height,
358                                           float scalex,
359                                           float scaley)
360 {
361   const Object *ob_eval = DEG_get_evaluated_object(depsgraph, ob);
362   CameraParams params;
363
364   /* setup parameters */
365   BKE_camera_params_init(&params);
366   BKE_camera_params_from_object(&params, ob_eval);
367
368   /* Compute matrix, view-plane, etc. */
369   BKE_camera_params_compute_viewplane(&params, width, height, scalex, scaley);
370   BKE_camera_params_compute_matrix(&params);
371
372   copy_m4_m4((float(*)[4])mat_ret, params.winmat);
373 }
374
375 static void rna_Object_camera_fit_coords(
376     Object *ob, Depsgraph *depsgraph, int num_cos, float *cos, float co_ret[3], float *scale_ret)
377 {
378   BKE_camera_view_frame_fit_to_coords(
379       depsgraph, (const float(*)[3])cos, num_cos / 3, ob, co_ret, scale_ret);
380 }
381
382 /* copied from Mesh_getFromObject and adapted to RNA interface */
383 static Mesh *rna_Object_to_mesh(Object *object,
384                                 ReportList *reports,
385                                 bool preserve_all_data_layers,
386                                 Depsgraph *depsgraph)
387 {
388   /* TODO(sergey): Make it more re-usable function, de-duplicate with
389    * rna_Main_meshes_new_from_object. */
390   switch (object->type) {
391     case OB_FONT:
392     case OB_CURVE:
393     case OB_SURF:
394     case OB_MBALL:
395     case OB_MESH:
396       break;
397     default:
398       BKE_report(reports, RPT_ERROR, "Object does not have geometry data");
399       return NULL;
400   }
401
402   return BKE_object_to_mesh(depsgraph, object, preserve_all_data_layers);
403 }
404
405 static void rna_Object_to_mesh_clear(Object *object)
406 {
407   BKE_object_to_mesh_clear(object);
408 }
409
410 static Curve *rna_Object_to_curve(Object *object,
411                                   ReportList *reports,
412                                   Depsgraph *depsgraph,
413                                   bool apply_modifiers)
414 {
415   if (!ELEM(object->type, OB_FONT, OB_CURVE)) {
416     BKE_report(reports, RPT_ERROR, "Object is not a curve or a text");
417     return NULL;
418   }
419
420   if (depsgraph == NULL) {
421     BKE_report(reports, RPT_ERROR, "Invalid depsgraph");
422     return NULL;
423   }
424
425   return BKE_object_to_curve(object, depsgraph, apply_modifiers);
426 }
427
428 static void rna_Object_to_curve_clear(Object *object)
429 {
430   BKE_object_to_curve_clear(object);
431 }
432
433 static PointerRNA rna_Object_shape_key_add(
434     Object *ob, bContext *C, ReportList *reports, const char *name, bool from_mix)
435 {
436   Main *bmain = CTX_data_main(C);
437   KeyBlock *kb = NULL;
438
439   if ((kb = BKE_object_shapekey_insert(bmain, ob, name, from_mix))) {
440     PointerRNA keyptr;
441
442     RNA_pointer_create((ID *)BKE_key_from_object(ob), &RNA_ShapeKey, kb, &keyptr);
443     WM_event_add_notifier(C, NC_OBJECT | ND_DRAW, ob);
444
445     DEG_id_tag_update(&ob->id, ID_RECALC_GEOMETRY);
446     DEG_relations_tag_update(bmain);
447
448     return keyptr;
449   }
450   else {
451     BKE_reportf(reports, RPT_ERROR, "Object '%s' does not support shapes", ob->id.name + 2);
452     return PointerRNA_NULL;
453   }
454 }
455
456 static void rna_Object_shape_key_remove(Object *ob,
457                                         Main *bmain,
458                                         ReportList *reports,
459                                         PointerRNA *kb_ptr)
460 {
461   KeyBlock *kb = kb_ptr->data;
462   Key *key = BKE_key_from_object(ob);
463
464   if ((key == NULL) || BLI_findindex(&key->block, kb) == -1) {
465     BKE_report(reports, RPT_ERROR, "ShapeKey not found");
466     return;
467   }
468
469   if (!BKE_object_shapekey_remove(bmain, ob, kb)) {
470     BKE_report(reports, RPT_ERROR, "Could not remove ShapeKey");
471     return;
472   }
473
474   DEG_id_tag_update(&ob->id, ID_RECALC_GEOMETRY);
475   WM_main_add_notifier(NC_OBJECT | ND_DRAW, ob);
476
477   RNA_POINTER_INVALIDATE(kb_ptr);
478 }
479
480 static void rna_Object_shape_key_clear(Object *ob, Main *bmain)
481 {
482   BKE_object_shapekey_free(bmain, ob);
483
484   DEG_id_tag_update(&ob->id, ID_RECALC_GEOMETRY);
485   WM_main_add_notifier(NC_OBJECT | ND_DRAW, ob);
486 }
487
488 #  if 0
489 static void rna_Mesh_assign_verts_to_group(
490     Object *ob, bDeformGroup *group, int *indices, int totindex, float weight, int assignmode)
491 {
492   if (ob->type != OB_MESH) {
493     BKE_report(reports, RPT_ERROR, "Object should be of mesh type");
494     return;
495   }
496
497   Mesh *me = (Mesh *)ob->data;
498   int group_index = BLI_findlink(&ob->defbase, group);
499   if (group_index == -1) {
500     BKE_report(reports, RPT_ERROR, "No vertex groups assigned to mesh");
501     return;
502   }
503
504   if (assignmode != WEIGHT_REPLACE && assignmode != WEIGHT_ADD && assignmode != WEIGHT_SUBTRACT) {
505     BKE_report(reports, RPT_ERROR, "Bad assignment mode");
506     return;
507   }
508
509   /* makes a set of dVerts corresponding to the mVerts */
510   if (!me->dvert) {
511     create_dverts(&me->id);
512   }
513
514   /* Loop list adding verts to group. */
515   for (i = 0; i < totindex; i++) {
516     if (i < 0 || i >= me->totvert) {
517       BKE_report(reports, RPT_ERROR, "Bad vertex index in list");
518       return;
519     }
520
521     add_vert_defnr(ob, group_index, i, weight, assignmode);
522   }
523 }
524 #  endif
525
526 /* don't call inside a loop */
527 static int mesh_looptri_to_poly_index(Mesh *me_eval, const MLoopTri *lt)
528 {
529   const int *index_mp_to_orig = CustomData_get_layer(&me_eval->pdata, CD_ORIGINDEX);
530   return index_mp_to_orig ? index_mp_to_orig[lt->poly] : lt->poly;
531 }
532
533 /* TODO(sergey): Make the Python API more clear that evaluation might happen, or require
534  * passing fully evaluated depsgraph. */
535 static Object *eval_object_ensure(Object *ob,
536                                   bContext *C,
537                                   ReportList *reports,
538                                   PointerRNA *rnaptr_depsgraph)
539 {
540   if (ob->runtime.data_eval == NULL) {
541     Object *ob_orig = ob;
542     Depsgraph *depsgraph = rnaptr_depsgraph != NULL ? rnaptr_depsgraph->data : NULL;
543     if (depsgraph == NULL) {
544       depsgraph = CTX_data_ensure_evaluated_depsgraph(C);
545     }
546     if (depsgraph != NULL) {
547       ob = DEG_get_evaluated_object(depsgraph, ob);
548     }
549     if (ob == NULL || BKE_object_get_evaluated_mesh(ob) == NULL) {
550       BKE_reportf(
551           reports, RPT_ERROR, "Object '%s' has no evaluated mesh data", ob_orig->id.name + 2);
552       return NULL;
553     }
554   }
555   return ob;
556 }
557
558 static void rna_Object_ray_cast(Object *ob,
559                                 bContext *C,
560                                 ReportList *reports,
561                                 float origin[3],
562                                 float direction[3],
563                                 float distance,
564                                 PointerRNA *rnaptr_depsgraph,
565                                 bool *r_success,
566                                 float r_location[3],
567                                 float r_normal[3],
568                                 int *r_index)
569 {
570   bool success = false;
571
572   /* TODO(sergey): This isn't very reliable check. It is possible to have non-NULL pointer
573    * but which is out of date, and possibly dangling one. */
574   if ((ob = eval_object_ensure(ob, C, reports, rnaptr_depsgraph)) == NULL) {
575     return;
576   }
577
578   /* Test BoundBox first (efficiency) */
579   BoundBox *bb = BKE_object_boundbox_get(ob);
580   float distmin;
581
582   /* Needed for valid distance check from #isect_ray_aabb_v3_simple() call. */
583   normalize_v3(direction);
584
585   if (!bb ||
586       (isect_ray_aabb_v3_simple(origin, direction, bb->vec[0], bb->vec[6], &distmin, NULL) &&
587        distmin <= distance)) {
588     BVHTreeFromMesh treeData = {NULL};
589
590     /* No need to managing allocation or freeing of the BVH data.
591      * This is generated and freed as needed. */
592     Mesh *mesh_eval = BKE_object_get_evaluated_mesh(ob);
593     BKE_bvhtree_from_mesh_get(&treeData, mesh_eval, BVHTREE_FROM_LOOPTRI, 4);
594
595     /* may fail if the mesh has no faces, in that case the ray-cast misses */
596     if (treeData.tree != NULL) {
597       BVHTreeRayHit hit;
598
599       hit.index = -1;
600       hit.dist = distance;
601
602       if (BLI_bvhtree_ray_cast(treeData.tree,
603                                origin,
604                                direction,
605                                0.0f,
606                                &hit,
607                                treeData.raycast_callback,
608                                &treeData) != -1) {
609         if (hit.dist <= distance) {
610           *r_success = success = true;
611
612           copy_v3_v3(r_location, hit.co);
613           copy_v3_v3(r_normal, hit.no);
614           *r_index = mesh_looptri_to_poly_index(mesh_eval, &treeData.looptri[hit.index]);
615         }
616       }
617
618       free_bvhtree_from_mesh(&treeData);
619     }
620   }
621   if (success == false) {
622     *r_success = false;
623
624     zero_v3(r_location);
625     zero_v3(r_normal);
626     *r_index = -1;
627   }
628 }
629
630 static void rna_Object_closest_point_on_mesh(Object *ob,
631                                              bContext *C,
632                                              ReportList *reports,
633                                              float origin[3],
634                                              float distance,
635                                              PointerRNA *rnaptr_depsgraph,
636                                              bool *r_success,
637                                              float r_location[3],
638                                              float r_normal[3],
639                                              int *r_index)
640 {
641   BVHTreeFromMesh treeData = {NULL};
642
643   if ((ob = eval_object_ensure(ob, C, reports, rnaptr_depsgraph)) == NULL) {
644     return;
645   }
646
647   /* No need to managing allocation or freeing of the BVH data.
648    * this is generated and freed as needed. */
649   Mesh *mesh_eval = BKE_object_get_evaluated_mesh(ob);
650   BKE_bvhtree_from_mesh_get(&treeData, mesh_eval, BVHTREE_FROM_LOOPTRI, 4);
651
652   if (treeData.tree == NULL) {
653     BKE_reportf(reports,
654                 RPT_ERROR,
655                 "Object '%s' could not create internal data for finding nearest point",
656                 ob->id.name + 2);
657     return;
658   }
659   else {
660     BVHTreeNearest nearest;
661
662     nearest.index = -1;
663     nearest.dist_sq = distance * distance;
664
665     if (BLI_bvhtree_find_nearest(
666             treeData.tree, origin, &nearest, treeData.nearest_callback, &treeData) != -1) {
667       *r_success = true;
668
669       copy_v3_v3(r_location, nearest.co);
670       copy_v3_v3(r_normal, nearest.no);
671       *r_index = mesh_looptri_to_poly_index(mesh_eval, &treeData.looptri[nearest.index]);
672
673       goto finally;
674     }
675   }
676
677   *r_success = false;
678
679   zero_v3(r_location);
680   zero_v3(r_normal);
681   *r_index = -1;
682
683 finally:
684   free_bvhtree_from_mesh(&treeData);
685 }
686
687 static bool rna_Object_is_modified(Object *ob, Scene *scene, int settings)
688 {
689   return BKE_object_is_modified(scene, ob) & settings;
690 }
691
692 static bool rna_Object_is_deform_modified(Object *ob, Scene *scene, int settings)
693 {
694   return BKE_object_is_deform_modified(scene, ob) & settings;
695 }
696
697 #  ifndef NDEBUG
698
699 #    include "BKE_mesh_runtime.h"
700
701 void rna_Object_me_eval_info(
702     struct Object *ob, bContext *C, int type, PointerRNA *rnaptr_depsgraph, char *result)
703 {
704   Mesh *me_eval = NULL;
705   char *ret = NULL;
706
707   result[0] = '\0';
708
709   switch (type) {
710     case 1:
711     case 2:
712       if ((ob = eval_object_ensure(ob, C, NULL, rnaptr_depsgraph)) == NULL) {
713         return;
714       }
715   }
716
717   switch (type) {
718     case 0:
719       if (ob->type == OB_MESH) {
720         me_eval = ob->data;
721       }
722       break;
723     case 1:
724       me_eval = ob->runtime.mesh_deform_eval;
725       break;
726     case 2:
727       me_eval = BKE_object_get_evaluated_mesh(ob);
728       break;
729   }
730
731   if (me_eval) {
732     ret = BKE_mesh_debug_info(me_eval);
733     if (ret) {
734       strcpy(result, ret);
735       MEM_freeN(ret);
736     }
737   }
738 }
739 #  else
740 void rna_Object_me_eval_info(struct Object *UNUSED(ob),
741                              bContext *UNUSED(C),
742                              int UNUSED(type),
743                              PointerRNA *UNUSED(rnaptr_depsgraph),
744                              char *result)
745 {
746   result[0] = '\0';
747 }
748 #  endif /* NDEBUG */
749
750 static bool rna_Object_update_from_editmode(Object *ob, Main *bmain)
751 {
752   /* fail gracefully if we aren't in edit-mode. */
753   const bool result = ED_object_editmode_load(bmain, ob);
754   if (result) {
755     /* Loading edit mesh to mesh changes geometry, and scripts might expect it to be properly
756      * informed about changes. */
757     DEG_id_tag_update(&ob->id, ID_RECALC_GEOMETRY);
758   }
759   return result;
760 }
761
762 bool rna_Object_generate_gpencil_strokes(Object *ob,
763                                          bContext *C,
764                                          ReportList *reports,
765                                          Object *ob_gpencil,
766                                          bool use_collections,
767                                          float scale_thickness,
768                                          float sample)
769 {
770   if (ob->type != OB_CURVE) {
771     BKE_reportf(reports,
772                 RPT_ERROR,
773                 "Object '%s' is not valid for this operation! Only curves are supported",
774                 ob->id.name + 2);
775     return false;
776   }
777   Main *bmain = CTX_data_main(C);
778   Scene *scene = CTX_data_scene(C);
779
780   BKE_gpencil_convert_curve(
781       bmain, scene, ob_gpencil, ob, use_collections, scale_thickness, sample);
782
783   WM_main_add_notifier(NC_GPENCIL | ND_DATA, NULL);
784
785   return true;
786 }
787 #else /* RNA_RUNTIME */
788
789 void RNA_api_object(StructRNA *srna)
790 {
791   FunctionRNA *func;
792   PropertyRNA *parm;
793
794   static const EnumPropertyItem mesh_type_items[] = {
795       {eModifierMode_Realtime, "PREVIEW", 0, "Preview", "Apply modifier preview settings"},
796       {eModifierMode_Render, "RENDER", 0, "Render", "Apply modifier render settings"},
797       {0, NULL, 0, NULL, NULL},
798   };
799
800 #  ifndef NDEBUG
801   static const EnumPropertyItem mesh_dm_info_items[] = {
802       {0, "SOURCE", 0, "Source", "Source mesh"},
803       {1, "DEFORM", 0, "Deform", "Objects deform mesh"},
804       {2, "FINAL", 0, "Final", "Objects final mesh"},
805       {0, NULL, 0, NULL, NULL},
806   };
807 #  endif
808
809   /* Special wrapper to access the base selection value */
810   func = RNA_def_function(srna, "select_get", "rna_Object_select_get");
811   RNA_def_function_ui_description(
812       func, "Test if the object is selected. The selection state is per view layer");
813   RNA_def_function_flag(func, FUNC_USE_CONTEXT);
814   parm = RNA_def_pointer(
815       func, "view_layer", "ViewLayer", "", "Use this instead of the active view layer");
816   parm = RNA_def_boolean(func, "result", 0, "", "Object selected");
817   RNA_def_function_return(func, parm);
818
819   func = RNA_def_function(srna, "select_set", "rna_Object_select_set");
820   RNA_def_function_ui_description(
821       func, "Select or deselect the object. The selection state is per view layer");
822   RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
823   parm = RNA_def_boolean(func, "state", 0, "", "Selection state to define");
824   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
825   parm = RNA_def_pointer(
826       func, "view_layer", "ViewLayer", "", "Use this instead of the active view layer");
827
828   func = RNA_def_function(srna, "hide_get", "rna_Object_hide_get");
829   RNA_def_function_ui_description(
830       func,
831       "Test if the object is hidden for viewport editing. This hiding state is per view layer");
832   RNA_def_function_flag(func, FUNC_USE_CONTEXT);
833   parm = RNA_def_pointer(
834       func, "view_layer", "ViewLayer", "", "Use this instead of the active view layer");
835   parm = RNA_def_boolean(func, "result", 0, "", "Object hidden");
836   RNA_def_function_return(func, parm);
837
838   func = RNA_def_function(srna, "hide_set", "rna_Object_hide_set");
839   RNA_def_function_ui_description(
840       func, "Hide the object for viewport editing. This hiding state is per view layer");
841   RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
842   parm = RNA_def_boolean(func, "state", 0, "", "Hide state to define");
843   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
844   parm = RNA_def_pointer(
845       func, "view_layer", "ViewLayer", "", "Use this instead of the active view layer");
846
847   func = RNA_def_function(srna, "visible_get", "rna_Object_visible_get");
848   RNA_def_function_ui_description(func,
849                                   "Test if the object is visible in the 3D viewport, taking into "
850                                   "account all visibility settings");
851   RNA_def_function_flag(func, FUNC_USE_CONTEXT);
852   parm = RNA_def_pointer(
853       func, "view_layer", "ViewLayer", "", "Use this instead of the active view layer");
854   parm = RNA_def_pointer(
855       func, "viewport", "SpaceView3D", "", "Use this instead of the active 3D viewport");
856   parm = RNA_def_boolean(func, "result", 0, "", "Object visible");
857   RNA_def_function_return(func, parm);
858
859   func = RNA_def_function(srna, "holdout_get", "rna_Object_holdout_get");
860   RNA_def_function_ui_description(func, "Test if object is masked in the view layer");
861   RNA_def_function_flag(func, FUNC_USE_CONTEXT);
862   parm = RNA_def_pointer(
863       func, "view_layer", "ViewLayer", "", "Use this instead of the active view layer");
864   parm = RNA_def_boolean(func, "result", 0, "", "Object holdout");
865   RNA_def_function_return(func, parm);
866
867   func = RNA_def_function(srna, "indirect_only_get", "rna_Object_indirect_only_get");
868   RNA_def_function_ui_description(func,
869                                   "Test if object is set to contribute only indirectly (through "
870                                   "shadows and reflections) in the view layer");
871   RNA_def_function_flag(func, FUNC_USE_CONTEXT);
872   parm = RNA_def_pointer(
873       func, "view_layer", "ViewLayer", "", "Use this instead of the active view layer");
874   parm = RNA_def_boolean(func, "result", 0, "", "Object indirect only");
875   RNA_def_function_return(func, parm);
876
877   /* Local View */
878   func = RNA_def_function(srna, "local_view_get", "rna_Object_local_view_get");
879   RNA_def_function_ui_description(func, "Get the local view state for this object");
880   RNA_def_function_flag(func, FUNC_USE_REPORTS);
881   parm = RNA_def_pointer(func, "viewport", "SpaceView3D", "", "Viewport in local view");
882   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
883   parm = RNA_def_boolean(func, "result", 0, "", "Object local view state");
884   RNA_def_function_return(func, parm);
885
886   func = RNA_def_function(srna, "local_view_set", "rna_Object_local_view_set");
887   RNA_def_function_ui_description(func, "Set the local view state for this object");
888   RNA_def_function_flag(func, FUNC_USE_REPORTS);
889   parm = RNA_def_pointer(func, "viewport", "SpaceView3D", "", "Viewport in local view");
890   RNA_def_parameter_flags(parm, 0, PARM_RNAPTR | PARM_REQUIRED);
891   parm = RNA_def_boolean(func, "state", 0, "", "Local view state to define");
892   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
893
894   /* Viewport */
895   func = RNA_def_function(srna, "visible_in_viewport_get", "rna_Object_visible_in_viewport_get");
896   RNA_def_function_ui_description(
897       func, "Check for local view and local collections for this viewport and object");
898   parm = RNA_def_pointer(func, "viewport", "SpaceView3D", "", "Viewport in local collections");
899   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
900   parm = RNA_def_boolean(func, "result", 0, "", "Object viewport visibility");
901   RNA_def_function_return(func, parm);
902
903   /* Matrix space conversion */
904   func = RNA_def_function(srna, "convert_space", "rna_Object_mat_convert_space");
905   RNA_def_function_ui_description(
906       func, "Convert (transform) the given matrix from one space to another");
907   RNA_def_function_flag(func, FUNC_USE_REPORTS);
908   parm = RNA_def_pointer(
909       func,
910       "pose_bone",
911       "PoseBone",
912       "",
913       "Bone to use to define spaces (may be None, in which case only the two 'WORLD' and "
914       "'LOCAL' spaces are usable)");
915   parm = RNA_def_property(func, "matrix", PROP_FLOAT, PROP_MATRIX);
916   RNA_def_property_multi_array(parm, 2, rna_matrix_dimsize_4x4);
917   RNA_def_property_ui_text(parm, "", "The matrix to transform");
918   parm = RNA_def_property(func, "matrix_return", PROP_FLOAT, PROP_MATRIX);
919   RNA_def_property_multi_array(parm, 2, rna_matrix_dimsize_4x4);
920   RNA_def_property_ui_text(parm, "", "The transformed matrix");
921   RNA_def_function_output(func, parm);
922   parm = RNA_def_enum(func,
923                       "from_space",
924                       space_items,
925                       CONSTRAINT_SPACE_WORLD,
926                       "",
927                       "The space in which 'matrix' is currently");
928   parm = RNA_def_enum(func,
929                       "to_space",
930                       space_items,
931                       CONSTRAINT_SPACE_WORLD,
932                       "",
933                       "The space to which you want to transform 'matrix'");
934
935   /* Camera-related operations */
936   func = RNA_def_function(srna, "calc_matrix_camera", "rna_Object_calc_matrix_camera");
937   RNA_def_function_ui_description(func,
938                                   "Generate the camera projection matrix of this object "
939                                   "(mostly useful for Camera and Light types)");
940   parm = RNA_def_pointer(
941       func, "depsgraph", "Depsgraph", "", "Depsgraph to get evaluated data from");
942   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
943   parm = RNA_def_property(func, "result", PROP_FLOAT, PROP_MATRIX);
944   RNA_def_property_multi_array(parm, 2, rna_matrix_dimsize_4x4);
945   RNA_def_property_ui_text(parm, "", "The camera projection matrix");
946   RNA_def_function_output(func, parm);
947   parm = RNA_def_int(func, "x", 1, 0, INT_MAX, "", "Width of the render area", 0, 10000);
948   parm = RNA_def_int(func, "y", 1, 0, INT_MAX, "", "Height of the render area", 0, 10000);
949   parm = RNA_def_float(
950       func, "scale_x", 1.0f, 1.0e-6f, FLT_MAX, "", "Width scaling factor", 1.0e-2f, 100.0f);
951   parm = RNA_def_float(
952       func, "scale_y", 1.0f, 1.0e-6f, FLT_MAX, "", "Height scaling factor", 1.0e-2f, 100.0f);
953
954   func = RNA_def_function(srna, "camera_fit_coords", "rna_Object_camera_fit_coords");
955   RNA_def_function_ui_description(func,
956                                   "Compute the coordinate (and scale for ortho cameras) "
957                                   "given object should be to 'see' all given coordinates");
958   parm = RNA_def_pointer(
959       func, "depsgraph", "Depsgraph", "", "Depsgraph to get evaluated data from");
960   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
961   parm = RNA_def_float_array(func,
962                              "coordinates",
963                              1,
964                              NULL,
965                              -FLT_MAX,
966                              FLT_MAX,
967                              "",
968                              "Coordinates to fit in",
969                              -FLT_MAX,
970                              FLT_MAX);
971   RNA_def_parameter_flags(parm, PROP_NEVER_NULL | PROP_DYNAMIC, PARM_REQUIRED);
972   parm = RNA_def_property(func, "co_return", PROP_FLOAT, PROP_XYZ);
973   RNA_def_property_array(parm, 3);
974   RNA_def_property_ui_text(parm, "", "The location to aim to be able to see all given points");
975   RNA_def_parameter_flags(parm, 0, PARM_OUTPUT);
976   parm = RNA_def_property(func, "scale_return", PROP_FLOAT, PROP_NONE);
977   RNA_def_property_ui_text(
978       parm, "", "The ortho scale to aim to be able to see all given points (if relevant)");
979   RNA_def_parameter_flags(parm, 0, PARM_OUTPUT);
980
981   /* mesh */
982   func = RNA_def_function(srna, "to_mesh", "rna_Object_to_mesh");
983   RNA_def_function_ui_description(
984       func,
985       "Create a Mesh data-block from the current state of the object. The object owns the "
986       "data-block. To force free it use to_mesh_clear(). "
987       "The result is temporary and can not be used by objects from the main database");
988   RNA_def_function_flag(func, FUNC_USE_REPORTS);
989   RNA_def_boolean(func,
990                   "preserve_all_data_layers",
991                   false,
992                   "",
993                   "Preserve all data layers in the mesh, like UV maps and vertex groups. "
994                   "By default Blender only computes the subset of data layers needed for viewport "
995                   "display and rendering, for better performance");
996   RNA_def_pointer(
997       func,
998       "depsgraph",
999       "Depsgraph",
1000       "Dependency Graph",
1001       "Evaluated dependency graph which is required when preserve_all_data_layers is true");
1002   parm = RNA_def_pointer(func, "mesh", "Mesh", "", "Mesh created from object");
1003   RNA_def_function_return(func, parm);
1004
1005   func = RNA_def_function(srna, "to_mesh_clear", "rna_Object_to_mesh_clear");
1006   RNA_def_function_ui_description(func, "Clears mesh data-block created by to_mesh()");
1007
1008   /* curve */
1009   func = RNA_def_function(srna, "to_curve", "rna_Object_to_curve");
1010   RNA_def_function_ui_description(
1011       func,
1012       "Create a Curve data-block from the current state of the object. This only works for curve "
1013       "and text objects. The object owns the data-block. To force free it, use to_curve_clear(). "
1014       "The result is temporary and can not be used by objects from the main database");
1015   RNA_def_function_flag(func, FUNC_USE_REPORTS);
1016   parm = RNA_def_pointer(
1017       func, "depsgraph", "Depsgraph", "Dependency Graph", "Evaluated dependency graph");
1018   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1019   RNA_def_boolean(func,
1020                   "apply_modifiers",
1021                   false,
1022                   "",
1023                   "Apply the deform modifiers on the control points of the curve. This is only "
1024                   "supported for curve objects");
1025   parm = RNA_def_pointer(func, "curve", "Curve", "", "Curve created from object");
1026   RNA_def_function_return(func, parm);
1027
1028   func = RNA_def_function(srna, "to_curve_clear", "rna_Object_to_curve_clear");
1029   RNA_def_function_ui_description(func, "Clears curve data-block created by to_curve()");
1030
1031   /* Armature */
1032   func = RNA_def_function(srna, "find_armature", "BKE_modifiers_is_deformed_by_armature");
1033   RNA_def_function_ui_description(
1034       func, "Find armature influencing this object as a parent or via a modifier");
1035   parm = RNA_def_pointer(
1036       func, "ob_arm", "Object", "", "Armature object influencing this object or NULL");
1037   RNA_def_function_return(func, parm);
1038
1039   /* Shape key */
1040   func = RNA_def_function(srna, "shape_key_add", "rna_Object_shape_key_add");
1041   RNA_def_function_ui_description(func, "Add shape key to this object");
1042   RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
1043   RNA_def_string(func, "name", "Key", 0, "", "Unique name for the new keyblock"); /* optional */
1044   RNA_def_boolean(func, "from_mix", 1, "", "Create new shape from existing mix of shapes");
1045   parm = RNA_def_pointer(func, "key", "ShapeKey", "", "New shape keyblock");
1046   RNA_def_parameter_flags(parm, 0, PARM_RNAPTR);
1047   RNA_def_function_return(func, parm);
1048
1049   func = RNA_def_function(srna, "shape_key_remove", "rna_Object_shape_key_remove");
1050   RNA_def_function_ui_description(func, "Remove a Shape Key from this object");
1051   RNA_def_function_flag(func, FUNC_USE_MAIN | FUNC_USE_REPORTS);
1052   parm = RNA_def_pointer(func, "key", "ShapeKey", "", "Keyblock to be removed");
1053   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
1054   RNA_def_parameter_clear_flags(parm, PROP_THICK_WRAP, 0);
1055
1056   func = RNA_def_function(srna, "shape_key_clear", "rna_Object_shape_key_clear");
1057   RNA_def_function_ui_description(func, "Remove all Shape Keys from this object");
1058   RNA_def_function_flag(func, FUNC_USE_MAIN);
1059
1060   /* Ray Cast */
1061   func = RNA_def_function(srna, "ray_cast", "rna_Object_ray_cast");
1062   RNA_def_function_ui_description(
1063       func,
1064       "Cast a ray onto evaluated geometry, in object space "
1065       "(using context's or provided depsgraph to get evaluated mesh if needed)");
1066   RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
1067
1068   /* ray start and end */
1069   parm = RNA_def_float_vector(func,
1070                               "origin",
1071                               3,
1072                               NULL,
1073                               -FLT_MAX,
1074                               FLT_MAX,
1075                               "",
1076                               "Origin of the ray, in object space",
1077                               -1e4,
1078                               1e4);
1079   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1080   parm = RNA_def_float_vector(func,
1081                               "direction",
1082                               3,
1083                               NULL,
1084                               -FLT_MAX,
1085                               FLT_MAX,
1086                               "",
1087                               "Direction of the ray, in object space",
1088                               -1e4,
1089                               1e4);
1090   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1091   RNA_def_float(func,
1092                 "distance",
1093                 BVH_RAYCAST_DIST_MAX,
1094                 0.0,
1095                 BVH_RAYCAST_DIST_MAX,
1096                 "",
1097                 "Maximum distance",
1098                 0.0,
1099                 BVH_RAYCAST_DIST_MAX);
1100   parm = RNA_def_pointer(
1101       func,
1102       "depsgraph",
1103       "Depsgraph",
1104       "",
1105       "Depsgraph to use to get evaluated data, when called from original object "
1106       "(only needed if current Context's depsgraph is not suitable)");
1107   RNA_def_parameter_flags(parm, 0, PARM_RNAPTR);
1108
1109   /* return location and normal */
1110   parm = RNA_def_boolean(func, "result", 0, "", "Whether the ray successfully hit the geometry");
1111   RNA_def_function_output(func, parm);
1112   parm = RNA_def_float_vector(func,
1113                               "location",
1114                               3,
1115                               NULL,
1116                               -FLT_MAX,
1117                               FLT_MAX,
1118                               "Location",
1119                               "The hit location of this ray cast",
1120                               -1e4,
1121                               1e4);
1122   RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
1123   RNA_def_function_output(func, parm);
1124   parm = RNA_def_float_vector(func,
1125                               "normal",
1126                               3,
1127                               NULL,
1128                               -FLT_MAX,
1129                               FLT_MAX,
1130                               "Normal",
1131                               "The face normal at the ray cast hit location",
1132                               -1e4,
1133                               1e4);
1134   RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
1135   RNA_def_function_output(func, parm);
1136   parm = RNA_def_int(
1137       func, "index", 0, 0, 0, "", "The face index, -1 when original data isn't available", 0, 0);
1138   RNA_def_function_output(func, parm);
1139
1140   /* Nearest Point */
1141   func = RNA_def_function(srna, "closest_point_on_mesh", "rna_Object_closest_point_on_mesh");
1142   RNA_def_function_ui_description(
1143       func,
1144       "Find the nearest point on evaluated geometry, in object space "
1145       "(using context's or provided depsgraph to get evaluated mesh if needed)");
1146   RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
1147
1148   /* location of point for test and max distance */
1149   parm = RNA_def_float_vector(func,
1150                               "origin",
1151                               3,
1152                               NULL,
1153                               -FLT_MAX,
1154                               FLT_MAX,
1155                               "",
1156                               "Point to find closest geometry from (in object space)",
1157                               -1e4,
1158                               1e4);
1159   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1160   /* default is sqrt(FLT_MAX) */
1161   RNA_def_float(
1162       func, "distance", 1.844674352395373e+19, 0.0, FLT_MAX, "", "Maximum distance", 0.0, FLT_MAX);
1163   parm = RNA_def_pointer(
1164       func,
1165       "depsgraph",
1166       "Depsgraph",
1167       "",
1168       "Depsgraph to use to get evaluated data, when called from original object "
1169       "(only needed if current Context's depsgraph is not suitable)");
1170   RNA_def_parameter_flags(parm, 0, PARM_RNAPTR);
1171
1172   /* return location and normal */
1173   parm = RNA_def_boolean(func, "result", 0, "", "Whether closest point on geometry was found");
1174   RNA_def_function_output(func, parm);
1175   parm = RNA_def_float_vector(func,
1176                               "location",
1177                               3,
1178                               NULL,
1179                               -FLT_MAX,
1180                               FLT_MAX,
1181                               "Location",
1182                               "The location on the object closest to the point",
1183                               -1e4,
1184                               1e4);
1185   RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
1186   RNA_def_function_output(func, parm);
1187   parm = RNA_def_float_vector(func,
1188                               "normal",
1189                               3,
1190                               NULL,
1191                               -FLT_MAX,
1192                               FLT_MAX,
1193                               "Normal",
1194                               "The face normal at the closest point",
1195                               -1e4,
1196                               1e4);
1197   RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
1198   RNA_def_function_output(func, parm);
1199
1200   parm = RNA_def_int(
1201       func, "index", 0, 0, 0, "", "The face index, -1 when original data isn't available", 0, 0);
1202   RNA_def_function_output(func, parm);
1203
1204   /* View */
1205
1206   /* utility function for checking if the object is modified */
1207   func = RNA_def_function(srna, "is_modified", "rna_Object_is_modified");
1208   RNA_def_function_ui_description(func,
1209                                   "Determine if this object is modified from the base mesh data");
1210   parm = RNA_def_pointer(func, "scene", "Scene", "", "Scene in which to check the object");
1211   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
1212   parm = RNA_def_enum(func, "settings", mesh_type_items, 0, "", "Modifier settings to apply");
1213   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1214   parm = RNA_def_boolean(func, "result", 0, "", "Whether the object is modified");
1215   RNA_def_function_return(func, parm);
1216
1217   func = RNA_def_function(srna, "is_deform_modified", "rna_Object_is_deform_modified");
1218   RNA_def_function_ui_description(
1219       func, "Determine if this object is modified by a deformation from the base mesh data");
1220   parm = RNA_def_pointer(func, "scene", "Scene", "", "Scene in which to check the object");
1221   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
1222   parm = RNA_def_enum(func, "settings", mesh_type_items, 0, "", "Modifier settings to apply");
1223   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1224   parm = RNA_def_boolean(func, "result", 0, "", "Whether the object is deform-modified");
1225   RNA_def_function_return(func, parm);
1226
1227 #  ifndef NDEBUG
1228   /* mesh */
1229   func = RNA_def_function(srna, "dm_info", "rna_Object_me_eval_info");
1230   RNA_def_function_ui_description(
1231       func,
1232       "Returns a string for original/evaluated mesh data (debug builds only, "
1233       "using context's or provided depsgraph to get evaluated mesh if needed)");
1234   RNA_def_function_flag(func, FUNC_USE_CONTEXT);
1235
1236   parm = RNA_def_enum(func, "type", mesh_dm_info_items, 0, "", "Modifier settings to apply");
1237   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1238   parm = RNA_def_pointer(
1239       func,
1240       "depsgraph",
1241       "Depsgraph",
1242       "",
1243       "Depsgraph to use to get evaluated data, when called from original object "
1244       "(only needed if current Context's depsgraph is not suitable)");
1245   RNA_def_parameter_flags(parm, 0, PARM_RNAPTR);
1246   /* weak!, no way to return dynamic string type */
1247   parm = RNA_def_string(func, "result", NULL, 16384, "", "Requested information");
1248   RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0); /* needed for string return value */
1249   RNA_def_function_output(func, parm);
1250 #  endif /* NDEBUG */
1251
1252   func = RNA_def_function(srna, "update_from_editmode", "rna_Object_update_from_editmode");
1253   RNA_def_function_ui_description(func, "Load the objects edit-mode data into the object data");
1254   RNA_def_function_flag(func, FUNC_USE_MAIN);
1255   parm = RNA_def_boolean(func, "result", 0, "", "Success");
1256   RNA_def_function_return(func, parm);
1257
1258   func = RNA_def_function(srna, "cache_release", "BKE_object_free_caches");
1259   RNA_def_function_ui_description(func,
1260                                   "Release memory used by caches associated with this object. "
1261                                   "Intended to be used by render engines only");
1262
1263   /* Convert curve object to gpencil strokes. */
1264   func = RNA_def_function(srna, "generate_gpencil_strokes", "rna_Object_generate_gpencil_strokes");
1265   RNA_def_function_ui_description(func, "Convert a curve object to grease pencil strokes.");
1266   RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
1267
1268   parm = RNA_def_pointer(func,
1269                          "grease_pencil_object",
1270                          "Object",
1271                          "",
1272                          "Grease Pencil object used to create new strokes");
1273   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
1274   parm = RNA_def_boolean(func, "use_collections", true, "", "Use Collections");
1275   parm = RNA_def_float(
1276       func, "scale_thickness", 1.0f, 0.0f, FLT_MAX, "", "Thickness scaling factor", 0.0f, 100.0f);
1277   parm = RNA_def_float(
1278       func, "sample", 0.0f, 0.0f, FLT_MAX, "", "Sample distance, zero to disable", 0.0f, 100.0f);
1279   parm = RNA_def_boolean(func, "result", 0, "", "Result");
1280   RNA_def_function_return(func, parm);
1281 }
1282
1283 #endif /* RNA_RUNTIME */