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