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