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