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