Merge branch 'master' into blender2.8
[blender.git] / source / blender / makesrna / intern / rna_object_api.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2009 Blender Foundation.
19  * All rights reserved.
20  *
21  *
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/makesrna/intern/rna_object_api.c
28  *  \ingroup RNA
29  */
30
31
32 #include <stdlib.h>
33 #include <stdio.h>
34 #include <string.h>
35 #include <time.h>
36
37 #include "BLI_utildefines.h"
38 #include "BLI_kdopbvh.h"
39
40 #include "RNA_define.h"
41
42 #include "DNA_constraint_types.h"
43 #include "DNA_layer_types.h"
44 #include "DNA_modifier_types.h"
45 #include "DNA_object_types.h"
46
47 #include "BKE_layer.h"
48
49 #include "DEG_depsgraph.h"
50
51 #include "rna_internal.h"  /* own include */
52
53 static const EnumPropertyItem space_items[] = {
54         {CONSTRAINT_SPACE_WORLD,    "WORLD", 0, "World Space",
55                                     "The most gobal space in Blender"},
56         {CONSTRAINT_SPACE_POSE,     "POSE", 0, "Pose Space",
57                                     "The pose space of a bone (its armature's object space)"},
58         {CONSTRAINT_SPACE_PARLOCAL, "LOCAL_WITH_PARENT", 0, "Local With Parent",
59                                     "The local space of a bone's parent bone"},
60         {CONSTRAINT_SPACE_LOCAL,    "LOCAL", 0, "Local Space",
61                                     "The local space of an object/bone"},
62         {0, NULL, 0, NULL, NULL}
63 };
64
65 #ifdef RNA_RUNTIME
66
67 #include "BLI_math.h"
68
69 #include "BKE_anim.h"
70 #include "BKE_bvhutils.h"
71 #include "BKE_constraint.h"
72 #include "BKE_context.h"
73 #include "BKE_customdata.h"
74 #include "BKE_font.h"
75 #include "BKE_global.h"
76 #include "BKE_main.h"
77 #include "BKE_mesh.h"
78 #include "BKE_mball.h"
79 #include "BKE_modifier.h"
80 #include "BKE_object.h"
81 #include "BKE_report.h"
82
83 #include "ED_object.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(Object *ob, bContext *C, ReportList *reports, int action)
96 {
97         ViewLayer *view_layer = CTX_data_view_layer(C);
98         Base *base = BKE_view_layer_base_find(view_layer, ob);
99
100         if (!base) {
101                 BKE_reportf(reports, RPT_ERROR, "Object '%s' not in View Layer '%s'!", ob->id.name + 2, view_layer->name);
102                 return;
103         }
104
105         if (action == 2) { /* TOGGLE */
106                 if ((base->flag & BASE_SELECTED) != 0) {
107                         action = 1; /* DESELECT */
108                 }
109                 else {
110                         action = 0; /* SELECT */
111                 }
112         }
113
114         switch (action) {
115                 case 1: /* DESELECT */
116                         base->flag &= ~BASE_SELECTED;
117                         break;
118                 case 0: /* SELECT */
119                 default:
120                         BKE_view_layer_base_select(view_layer, base);
121                         break;
122         }
123 }
124
125 static bool rna_Object_select_get(Object *ob, bContext *C, ReportList *reports)
126 {
127         ViewLayer *view_layer = CTX_data_view_layer(C);
128         Base *base = BKE_view_layer_base_find(view_layer, ob);
129
130         if (!base) {
131                 BKE_reportf(reports, RPT_ERROR, "Object '%s' not in View Layer '%s'!", ob->id.name + 2, view_layer->name);
132                 return false;
133         }
134
135         return ((base->flag & BASE_SELECTED) != 0);
136 }
137
138 static bool rna_Object_visible_get(Object *ob, bContext *C, ReportList *reports)
139 {
140         ViewLayer *view_layer = CTX_data_view_layer(C);
141         Base *base = BKE_view_layer_base_find(view_layer, ob);
142
143         if (!base) {
144                 BKE_reportf(reports, RPT_ERROR, "Object '%s' not in View Layer '%s'!", ob->id.name + 2, view_layer->name);
145                 return false;
146         }
147
148         return ((base->flag & BASE_VISIBLE) != 0);
149 }
150
151 static bool rna_Object_holdout_get(Object *ob, ReportList *reports, ViewLayer *view_layer)
152 {
153         Base *base = BKE_view_layer_base_find(view_layer, ob);
154
155         if (!base) {
156                 BKE_reportf(reports, RPT_ERROR, "Object '%s' not in View Layer '%s'!", ob->id.name + 2, view_layer->name);
157                 return false;
158         }
159
160         return ((base->flag & BASE_HOLDOUT) != 0);
161 }
162
163 static bool rna_Object_indirect_only_get(Object *ob, ReportList *reports, ViewLayer *view_layer)
164 {
165         Base *base = BKE_view_layer_base_find(view_layer, ob);
166
167         if (!base) {
168                 BKE_reportf(reports, RPT_ERROR, "Object '%s' not in View Layer '%s'!", ob->id.name + 2, view_layer->name);
169                 return false;
170         }
171
172         return ((base->flag & BASE_INDIRECT_ONLY) != 0);
173 }
174
175 /* Convert a given matrix from a space to another (using the object and/or a bone as reference). */
176 static void rna_Object_mat_convert_space(Object *ob, ReportList *reports, bPoseChannel *pchan,
177                                         float *mat, float *mat_ret, int from, int to)
178 {
179         copy_m4_m4((float (*)[4])mat_ret, (float (*)[4])mat);
180
181         /* Error in case of invalid from/to values when pchan is NULL */
182         if (pchan == NULL) {
183                 if (ELEM(from, CONSTRAINT_SPACE_POSE, CONSTRAINT_SPACE_PARLOCAL)) {
184                         const char *identifier = NULL;
185                         RNA_enum_identifier(space_items, from, &identifier);
186                         BKE_reportf(reports, RPT_ERROR, "'from_space' '%s' is invalid when no pose bone is given!", identifier);
187                         return;
188                 }
189                 if (ELEM(to, CONSTRAINT_SPACE_POSE, CONSTRAINT_SPACE_PARLOCAL)) {
190                         const char *identifier = NULL;
191                         RNA_enum_identifier(space_items, to, &identifier);
192                         BKE_reportf(reports, RPT_ERROR, "'to_space' '%s' is invalid when no pose bone is given!", identifier);
193                         return;
194                 }
195         }
196
197         BKE_constraint_mat_convertspace(ob, pchan, (float (*)[4])mat_ret, from, to, false);
198 }
199
200 static void rna_Object_calc_matrix_camera(
201         Object *ob, Depsgraph *depsgraph, float mat_ret[16], int width, int height, float scalex, float scaley)
202 {
203         const Object *ob_eval = DEG_get_evaluated_object(depsgraph, ob);
204         CameraParams params;
205
206         /* setup parameters */
207         BKE_camera_params_init(&params);
208         BKE_camera_params_from_object(&params, ob_eval);
209
210         /* compute matrix, viewplane, .. */
211         BKE_camera_params_compute_viewplane(&params, width, height, scalex, scaley);
212         BKE_camera_params_compute_matrix(&params);
213
214         copy_m4_m4((float (*)[4])mat_ret, params.winmat);
215 }
216
217 static void rna_Object_camera_fit_coords(
218         Object *ob, Depsgraph *depsgraph, int num_cos, float *cos, float co_ret[3], float *scale_ret)
219 {
220         BKE_camera_view_frame_fit_to_coords(depsgraph, (const float (*)[3])cos, num_cos / 3, ob, co_ret, scale_ret);
221 }
222
223 /* copied from Mesh_getFromObject and adapted to RNA interface */
224 /* settings: 0 - preview, 1 - render */
225 static Mesh *rna_Object_to_mesh(
226         Object *ob, bContext *C, ReportList *reports, Depsgraph *depsgraph,
227         bool apply_modifiers, bool calc_tessface, bool calc_undeformed)
228 {
229         Main *bmain = CTX_data_main(C);
230
231         return rna_Main_meshes_new_from_object(bmain, reports, depsgraph, ob, apply_modifiers, calc_tessface, calc_undeformed);
232 }
233
234 static PointerRNA rna_Object_shape_key_add(Object *ob, bContext *C, ReportList *reports,
235                                            const char *name, bool from_mix)
236 {
237         Main *bmain = CTX_data_main(C);
238         KeyBlock *kb = NULL;
239
240         if ((kb = BKE_object_shapekey_insert(bmain, ob, name, from_mix))) {
241                 PointerRNA keyptr;
242
243                 RNA_pointer_create((ID *)ob->data, &RNA_ShapeKey, kb, &keyptr);
244                 WM_event_add_notifier(C, NC_OBJECT | ND_DRAW, ob);
245
246                 return keyptr;
247         }
248         else {
249                 BKE_reportf(reports, RPT_ERROR, "Object '%s' does not support shapes", ob->id.name + 2);
250                 return PointerRNA_NULL;
251         }
252 }
253
254 static void rna_Object_shape_key_remove(
255         Object *ob, Main *bmain, ReportList *reports,
256         PointerRNA *kb_ptr)
257 {
258         KeyBlock *kb = kb_ptr->data;
259         Key *key = BKE_key_from_object(ob);
260
261         if ((key == NULL) || BLI_findindex(&key->block, kb) == -1) {
262                 BKE_reportf(reports, RPT_ERROR, "ShapeKey not found");
263                 return;
264         }
265
266         if (!BKE_object_shapekey_remove(bmain, ob, kb)) {
267                 BKE_reportf(reports, RPT_ERROR, "Could not remove ShapeKey");
268                 return;
269         }
270
271         DEG_id_tag_update(&ob->id, OB_RECALC_DATA);
272         WM_main_add_notifier(NC_OBJECT | ND_DRAW, ob);
273
274         RNA_POINTER_INVALIDATE(kb_ptr);
275 }
276
277 #if 0
278 static void rna_Mesh_assign_verts_to_group(Object *ob, bDeformGroup *group, int *indices, int totindex,
279                                            float weight, int assignmode)
280 {
281         if (ob->type != OB_MESH) {
282                 BKE_report(reports, RPT_ERROR, "Object should be of mesh type");
283                 return;
284         }
285
286         Mesh *me = (Mesh *)ob->data;
287         int group_index = BLI_findlink(&ob->defbase, group);
288         if (group_index == -1) {
289                 BKE_report(reports, RPT_ERROR, "No vertex groups assigned to mesh");
290                 return;
291         }
292
293         if (assignmode != WEIGHT_REPLACE && assignmode != WEIGHT_ADD && assignmode != WEIGHT_SUBTRACT) {
294                 BKE_report(reports, RPT_ERROR, "Bad assignment mode");
295                 return;
296         }
297
298         /* makes a set of dVerts corresponding to the mVerts */
299         if (!me->dvert)
300                 create_dverts(&me->id);
301
302         /* loop list adding verts to group  */
303         for (i = 0; i < totindex; i++) {
304                 if (i < 0 || i >= me->totvert) {
305                         BKE_report(reports, RPT_ERROR, "Bad vertex index in list");
306                         return;
307                 }
308
309                 add_vert_defnr(ob, group_index, i, weight, assignmode);
310         }
311 }
312 #endif
313
314 /* don't call inside a loop */
315 static int mesh_looptri_to_poly_index(Mesh *me_eval, const MLoopTri *lt)
316 {
317         const int *index_mp_to_orig = CustomData_get_layer(&me_eval->pdata, CD_ORIGINDEX);
318         return index_mp_to_orig ? index_mp_to_orig[lt->poly] : lt->poly;
319 }
320
321 static void rna_Object_ray_cast(
322         Object *ob, ReportList *reports,
323         float origin[3], float direction[3], float distance,
324         bool *r_success, float r_location[3], float r_normal[3], int *r_index)
325 {
326         bool success = false;
327
328         if (ob->runtime.mesh_eval == NULL) {
329                 BKE_reportf(reports, RPT_ERROR, "Object '%s' has no mesh data to be used for ray casting", ob->id.name + 2);
330                 return;
331         }
332
333         /* Test BoundBox first (efficiency) */
334         BoundBox *bb = BKE_object_boundbox_get(ob);
335         float distmin;
336         normalize_v3(direction);  /* Needed for valid distance check from isect_ray_aabb_v3_simple() call. */
337         if (!bb ||
338             (isect_ray_aabb_v3_simple(origin, direction, bb->vec[0], bb->vec[6], &distmin, NULL) && distmin <= distance))
339         {
340                 BVHTreeFromMesh treeData = {NULL};
341
342                 /* no need to managing allocation or freeing of the BVH data. this is generated and freed as needed */
343                 BKE_bvhtree_from_mesh_get(&treeData, ob->runtime.mesh_eval, BVHTREE_FROM_LOOPTRI, 4);
344
345                 /* may fail if the mesh has no faces, in that case the ray-cast misses */
346                 if (treeData.tree != NULL) {
347                         BVHTreeRayHit hit;
348
349                         hit.index = -1;
350                         hit.dist = distance;
351
352                         if (BLI_bvhtree_ray_cast(treeData.tree, origin, direction, 0.0f, &hit,
353                                                  treeData.raycast_callback, &treeData) != -1)
354                         {
355                                 if (hit.dist <= distance) {
356                                         *r_success = success = true;
357
358                                         copy_v3_v3(r_location, hit.co);
359                                         copy_v3_v3(r_normal, hit.no);
360                                         *r_index = mesh_looptri_to_poly_index(ob->runtime.mesh_eval, &treeData.looptri[hit.index]);
361                                 }
362                         }
363
364                         free_bvhtree_from_mesh(&treeData);
365                 }
366         }
367         if (success == false) {
368                 *r_success = false;
369
370                 zero_v3(r_location);
371                 zero_v3(r_normal);
372                 *r_index = -1;
373         }
374 }
375
376 static void rna_Object_closest_point_on_mesh(
377         Object *ob, ReportList *reports, float origin[3], float distance,
378         bool *r_success, float r_location[3], float r_normal[3], int *r_index)
379 {
380         BVHTreeFromMesh treeData = {NULL};
381
382         if (ob->runtime.mesh_eval == NULL) {
383                 BKE_reportf(reports, RPT_ERROR, "Object '%s' has no mesh data to be used for finding nearest point",
384                             ob->id.name + 2);
385                 return;
386         }
387
388         /* no need to managing allocation or freeing of the BVH data. this is generated and freed as needed */
389         BKE_bvhtree_from_mesh_get(&treeData, ob->runtime.mesh_eval, BVHTREE_FROM_LOOPTRI, 4);
390
391         if (treeData.tree == NULL) {
392                 BKE_reportf(reports, RPT_ERROR, "Object '%s' could not create internal data for finding nearest point",
393                             ob->id.name + 2);
394                 return;
395         }
396         else {
397                 BVHTreeNearest nearest;
398
399                 nearest.index = -1;
400                 nearest.dist_sq = distance * distance;
401
402                 if (BLI_bvhtree_find_nearest(treeData.tree, origin, &nearest, treeData.nearest_callback, &treeData) != -1) {
403                         *r_success = true;
404
405                         copy_v3_v3(r_location, nearest.co);
406                         copy_v3_v3(r_normal, nearest.no);
407                         *r_index = mesh_looptri_to_poly_index(ob->runtime.mesh_eval, &treeData.looptri[nearest.index]);
408
409                         goto finally;
410                 }
411         }
412
413         *r_success = false;
414
415         zero_v3(r_location);
416         zero_v3(r_normal);
417         *r_index = -1;
418
419 finally:
420         free_bvhtree_from_mesh(&treeData);
421 }
422
423 static bool rna_Object_is_modified(Object *ob, Scene *scene, int settings)
424 {
425         return BKE_object_is_modified(scene, ob) & settings;
426 }
427
428 static bool rna_Object_is_deform_modified(Object *ob, Scene *scene, int settings)
429 {
430         return BKE_object_is_deform_modified(scene, ob) & settings;
431 }
432
433 #ifndef NDEBUG
434
435 #include "BKE_mesh_runtime.h"
436
437 void rna_Object_me_eval_info(struct Object *ob, int type, char *result)
438 {
439         Mesh *me_eval = NULL;
440         char *ret = NULL;
441
442         result[0] = '\0';
443
444         switch (type) {
445                 case 0:
446                         if (ob->type == OB_MESH) {
447                                 me_eval = ob->data;
448                         }
449                         break;
450                 case 1:
451                         me_eval = ob->runtime.mesh_deform_eval;
452                         break;
453                 case 2:
454                         me_eval = ob->runtime.mesh_eval;
455                         break;
456         }
457
458         if (me_eval) {
459                 ret = BKE_mesh_runtime_debug_info(me_eval);
460                 if (ret) {
461                         strcpy(result, ret);
462                         MEM_freeN(ret);
463                 }
464         }
465 }
466 #endif /* NDEBUG */
467
468 static bool rna_Object_update_from_editmode(Object *ob, Main *bmain)
469 {
470         /* fail gracefully if we aren't in edit-mode. */
471         return ED_object_editmode_load(bmain, ob);
472 }
473 #else /* RNA_RUNTIME */
474
475 void RNA_api_object(StructRNA *srna)
476 {
477         FunctionRNA *func;
478         PropertyRNA *parm;
479
480         static const EnumPropertyItem mesh_type_items[] = {
481                 {eModifierMode_Realtime, "PREVIEW", 0, "Preview", "Apply modifier preview settings"},
482                 {eModifierMode_Render, "RENDER", 0, "Render", "Apply modifier render settings"},
483                 {0, NULL, 0, NULL, NULL}
484         };
485
486 #ifndef NDEBUG
487         static const EnumPropertyItem mesh_dm_info_items[] = {
488                 {0, "SOURCE", 0, "Source", "Source mesh"},
489                 {1, "DEFORM", 0, "Deform", "Objects deform mesh"},
490                 {2, "FINAL", 0, "Final", "Objects final mesh"},
491                 {0, NULL, 0, NULL, NULL}
492         };
493 #endif
494
495         static EnumPropertyItem object_select_items[] = {
496             {0, "SELECT", 0, "Select", "Select object from the active view layer"},
497             {1, "DESELECT", 0, "Deselect", "Deselect object from the active view layer"},
498             {2, "TOGGLE", 0, "Toggle", "Toggle object selection from the active view layer"},
499             {0, NULL, 0, NULL, NULL}
500         };
501
502         /* Special wrapper to access the base selection value */
503         func = RNA_def_function(srna, "select_set", "rna_Object_select_set");
504         RNA_def_function_ui_description(func, "Select the object (for the active view layer)");
505         RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
506         parm = RNA_def_enum(func, "action", object_select_items, 0, "Action", "Select mode");
507         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
508
509         func = RNA_def_function(srna, "select_get", "rna_Object_select_get");
510         RNA_def_function_ui_description(func, "Get the object selection for the active view layer");
511         RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
512         parm = RNA_def_boolean(func, "result", 0, "", "Object selected");
513         RNA_def_function_return(func, parm);
514
515         func = RNA_def_function(srna, "visible_get", "rna_Object_visible_get");
516         RNA_def_function_ui_description(func, "Get the object visibility for the active view layer");
517         RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
518         parm = RNA_def_boolean(func, "result", 0, "", "Object visible");
519         RNA_def_function_return(func, parm);
520
521         func = RNA_def_function(srna, "holdout_get", "rna_Object_holdout_get");
522         RNA_def_function_ui_description(func, "Test if object is masked in the view layer");
523         RNA_def_function_flag(func, FUNC_USE_REPORTS);
524         parm = RNA_def_pointer(func, "view_layer", "ViewLayer", "", "");
525         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
526         parm = RNA_def_boolean(func, "result", 0, "", "Object holdout");
527         RNA_def_function_return(func, parm);
528
529         func = RNA_def_function(srna, "indirect_only_get", "rna_Object_indirect_only_get");
530         RNA_def_function_ui_description(func, "Test if object is set to contribute only indirectly (through shadows and reflections) in the view layer");
531         RNA_def_function_flag(func, FUNC_USE_REPORTS);
532         parm = RNA_def_pointer(func, "view_layer", "ViewLayer", "", "");
533         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
534         parm = RNA_def_boolean(func, "result", 0, "", "Object indirect only");
535         RNA_def_function_return(func, parm);
536
537         /* Matrix space conversion */
538         func = RNA_def_function(srna, "convert_space", "rna_Object_mat_convert_space");
539         RNA_def_function_ui_description(func, "Convert (transform) the given matrix from one space to another");
540         RNA_def_function_flag(func, FUNC_USE_REPORTS);
541         parm = RNA_def_pointer(func, "pose_bone", "PoseBone", "",
542                                "Bone to use to define spaces (may be None, in which case only the two 'WORLD' and "
543                                "'LOCAL' spaces are usable)");
544         parm = RNA_def_property(func, "matrix", PROP_FLOAT, PROP_MATRIX);
545         RNA_def_property_multi_array(parm, 2, rna_matrix_dimsize_4x4);
546         RNA_def_property_ui_text(parm, "", "The matrix to transform");
547         parm = RNA_def_property(func, "matrix_return", PROP_FLOAT, PROP_MATRIX);
548         RNA_def_property_multi_array(parm, 2, rna_matrix_dimsize_4x4);
549         RNA_def_property_ui_text(parm, "", "The transformed matrix");
550         RNA_def_function_output(func, parm);
551         parm = RNA_def_enum(func, "from_space", space_items, CONSTRAINT_SPACE_WORLD, "",
552                             "The space in which 'matrix' is currently");
553         parm = RNA_def_enum(func, "to_space", space_items, CONSTRAINT_SPACE_WORLD, "",
554                             "The space to which you want to transform 'matrix'");
555
556         /* Camera-related operations */
557         func = RNA_def_function(srna, "calc_matrix_camera", "rna_Object_calc_matrix_camera");
558         RNA_def_function_ui_description(func, "Generate the camera projection matrix of this object "
559                                               "(mostly useful for Camera and Light types)");
560         parm = RNA_def_pointer(func, "depsgraph", "Depsgraph", "",
561                                "Depsgraph to get evaluated data from");
562         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
563         parm = RNA_def_property(func, "result", PROP_FLOAT, PROP_MATRIX);
564         RNA_def_property_multi_array(parm, 2, rna_matrix_dimsize_4x4);
565         RNA_def_property_ui_text(parm, "", "The camera projection matrix");
566         RNA_def_function_output(func, parm);
567         parm = RNA_def_int(func, "x", 1, 0, INT_MAX, "", "Width of the render area", 0, 10000);
568         parm = RNA_def_int(func, "y", 1, 0, INT_MAX, "", "Height of the render area", 0, 10000);
569         parm = RNA_def_float(func, "scale_x", 1.0f, 1.0e-6f, FLT_MAX, "", "Width scaling factor", 1.0e-2f, 100.0f);
570         parm = RNA_def_float(func, "scale_y", 1.0f, 1.0e-6f, FLT_MAX, "", "height scaling factor", 1.0e-2f, 100.0f);
571
572         func = RNA_def_function(srna, "camera_fit_coords", "rna_Object_camera_fit_coords");
573         RNA_def_function_ui_description(func, "Compute the coordinate (and scale for ortho cameras) "
574                                               "given object should be to 'see' all given coordinates");
575         parm = RNA_def_pointer(func, "depsgraph", "Depsgraph", "",
576                                "Depsgraph to get evaluated data from");
577         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
578         parm = RNA_def_float_array(func, "coordinates", 1, NULL, -FLT_MAX, FLT_MAX, "", "Coordinates to fit in",
579                                    -FLT_MAX, FLT_MAX);
580         RNA_def_parameter_flags(parm, PROP_NEVER_NULL | PROP_DYNAMIC, PARM_REQUIRED);
581         parm = RNA_def_property(func, "co_return", PROP_FLOAT, PROP_XYZ);
582         RNA_def_property_array(parm, 3);
583         RNA_def_property_ui_text(parm, "", "The location to aim to be able to see all given points");
584         RNA_def_parameter_flags(parm, 0, PARM_OUTPUT);
585         parm = RNA_def_property(func, "scale_return", PROP_FLOAT, PROP_NONE);
586         RNA_def_property_ui_text(parm, "", "The ortho scale to aim to be able to see all given points (if relevant)");
587         RNA_def_parameter_flags(parm, 0, PARM_OUTPUT);
588
589         /* mesh */
590         func = RNA_def_function(srna, "to_mesh", "rna_Object_to_mesh");
591         RNA_def_function_ui_description(func, "Create a Mesh data-block with modifiers applied");
592         RNA_def_function_flag(func, FUNC_USE_REPORTS | FUNC_USE_CONTEXT);
593         parm = RNA_def_pointer(func, "depsgraph", "Depsgraph", "Dependency Graph", "Evaluated dependency graph within wich to evaluate modifiers");
594         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
595         parm = RNA_def_boolean(func, "apply_modifiers", 0, "", "Apply modifiers");
596         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
597         RNA_def_boolean(func, "calc_tessface", true, "Calculate Tessellation", "Calculate tessellation faces");
598         RNA_def_boolean(func, "calc_undeformed", false, "Calculate Undeformed", "Calculate undeformed vertex coordinates");
599         parm = RNA_def_pointer(func, "mesh", "Mesh", "",
600                                "Mesh created from object, remove it if it is only used for export");
601         RNA_def_function_return(func, parm);
602
603         /* Armature */
604         func = RNA_def_function(srna, "find_armature", "modifiers_isDeformedByArmature");
605         RNA_def_function_ui_description(func, "Find armature influencing this object as a parent or via a modifier");
606         parm = RNA_def_pointer(func, "ob_arm", "Object", "", "Armature object influencing this object or NULL");
607         RNA_def_function_return(func, parm);
608
609         /* Shape key */
610         func = RNA_def_function(srna, "shape_key_add", "rna_Object_shape_key_add");
611         RNA_def_function_ui_description(func, "Add shape key to this object");
612         RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
613         RNA_def_string(func, "name", "Key", 0, "", "Unique name for the new keyblock"); /* optional */
614         RNA_def_boolean(func, "from_mix", 1, "", "Create new shape from existing mix of shapes");
615         parm = RNA_def_pointer(func, "key", "ShapeKey", "", "New shape keyblock");
616         RNA_def_parameter_flags(parm, 0, PARM_RNAPTR);
617         RNA_def_function_return(func, parm);
618
619         func = RNA_def_function(srna, "shape_key_remove", "rna_Object_shape_key_remove");
620         RNA_def_function_ui_description(func, "Remove a Shape Key from this object");
621         RNA_def_function_flag(func, FUNC_USE_MAIN | FUNC_USE_REPORTS);
622         parm = RNA_def_pointer(func, "key", "ShapeKey", "", "Keyblock to be removed");
623         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
624         RNA_def_parameter_clear_flags(parm, PROP_THICK_WRAP, 0);
625
626         /* Ray Cast */
627         func = RNA_def_function(srna, "ray_cast", "rna_Object_ray_cast");
628         RNA_def_function_ui_description(func, "Cast a ray onto in object space");
629         RNA_def_function_flag(func, FUNC_USE_REPORTS);
630
631         /* ray start and end */
632         parm = RNA_def_float_vector(func, "origin", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
633         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
634         parm = RNA_def_float_vector(func, "direction", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
635         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
636         RNA_def_float(func, "distance", BVH_RAYCAST_DIST_MAX, 0.0, BVH_RAYCAST_DIST_MAX,
637                       "", "Maximum distance", 0.0, BVH_RAYCAST_DIST_MAX);
638
639         /* return location and normal */
640         parm = RNA_def_boolean(func, "result", 0, "", "");
641         RNA_def_function_output(func, parm);
642         parm = RNA_def_float_vector(func, "location", 3, NULL, -FLT_MAX, FLT_MAX, "Location",
643                                     "The hit location of this ray cast", -1e4, 1e4);
644         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
645         RNA_def_function_output(func, parm);
646         parm = RNA_def_float_vector(func, "normal", 3, NULL, -FLT_MAX, FLT_MAX, "Normal",
647                                     "The face normal at the ray cast hit location", -1e4, 1e4);
648         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
649         RNA_def_function_output(func, parm);
650         parm = RNA_def_int(func, "index", 0, 0, 0, "", "The face index, -1 when original data isn't available", 0, 0);
651         RNA_def_function_output(func, parm);
652
653         /* Nearest Point */
654         func = RNA_def_function(srna, "closest_point_on_mesh", "rna_Object_closest_point_on_mesh");
655         RNA_def_function_ui_description(func, "Find the nearest point in object space");
656         RNA_def_function_flag(func, FUNC_USE_REPORTS);
657
658         /* location of point for test and max distance */
659         parm = RNA_def_float_vector(func, "origin", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
660         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
661         /* default is sqrt(FLT_MAX) */
662         RNA_def_float(func, "distance", 1.844674352395373e+19, 0.0, FLT_MAX, "", "Maximum distance", 0.0, FLT_MAX);
663
664         /* return location and normal */
665         parm = RNA_def_boolean(func, "result", 0, "", "");
666         RNA_def_function_output(func, parm);
667         parm = RNA_def_float_vector(func, "location", 3, NULL, -FLT_MAX, FLT_MAX, "Location",
668                                     "The location on the object closest to the point", -1e4, 1e4);
669         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
670         RNA_def_function_output(func, parm);
671         parm = RNA_def_float_vector(func, "normal", 3, NULL, -FLT_MAX, FLT_MAX, "Normal",
672                                     "The face normal at the closest point", -1e4, 1e4);
673         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
674         RNA_def_function_output(func, parm);
675
676         parm = RNA_def_int(func, "index", 0, 0, 0, "", "The face index, -1 when original data isn't available", 0, 0);
677         RNA_def_function_output(func, parm);
678
679         /* View */
680
681         /* utility function for checking if the object is modified */
682         func = RNA_def_function(srna, "is_modified", "rna_Object_is_modified");
683         RNA_def_function_ui_description(func, "Determine if this object is modified from the base mesh data");
684         parm = RNA_def_pointer(func, "scene", "Scene", "", "");
685         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
686         parm = RNA_def_enum(func, "settings", mesh_type_items, 0, "", "Modifier settings to apply");
687         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
688         parm = RNA_def_boolean(func, "result", 0, "", "Object visibility");
689         RNA_def_function_return(func, parm);
690
691         func = RNA_def_function(srna, "is_deform_modified", "rna_Object_is_deform_modified");
692         RNA_def_function_ui_description(func, "Determine if this object is modified by a deformation from the base mesh data");
693         parm = RNA_def_pointer(func, "scene", "Scene", "", "");
694         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
695         parm = RNA_def_enum(func, "settings", mesh_type_items, 0, "", "Modifier settings to apply");
696         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
697         parm = RNA_def_boolean(func, "result", 0, "", "Object visibility");
698         RNA_def_function_return(func, parm);
699
700 #ifndef NDEBUG
701         /* mesh */
702         func = RNA_def_function(srna, "dm_info", "rna_Object_me_eval_info");
703         RNA_def_function_ui_description(func, "Returns a string for derived mesh data");
704
705         parm = RNA_def_enum(func, "type", mesh_dm_info_items, 0, "", "Modifier settings to apply");
706         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
707         /* weak!, no way to return dynamic string type */
708         parm = RNA_def_string(func, "result", NULL, 16384, "result", "");
709         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0); /* needed for string return value */
710         RNA_def_function_output(func, parm);
711 #endif /* NDEBUG */
712
713         func = RNA_def_function(srna, "update_from_editmode", "rna_Object_update_from_editmode");
714         RNA_def_function_ui_description(func, "Load the objects edit-mode data into the object data");
715         RNA_def_function_flag(func, FUNC_USE_MAIN);
716         parm = RNA_def_boolean(func, "result", 0, "", "Success");
717         RNA_def_function_return(func, parm);
718
719         func = RNA_def_function(srna, "cache_release", "BKE_object_free_caches");
720         RNA_def_function_ui_description(func, "Release memory used by caches associated with this object. Intended to be used by render engines only");
721 }
722
723 #endif /* RNA_RUNTIME */