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