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