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