Merging r45936 through r46042 from trunk into soc-2011-tomato
[blender-staging.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 "RNA_define.h"
38
39 #include "DNA_object_types.h"
40 #include "DNA_modifier_types.h"
41
42 #ifdef RNA_RUNTIME
43 #include "BLI_math.h"
44
45 #include "BKE_main.h"
46 #include "BKE_global.h"
47 #include "BKE_context.h"
48 #include "BKE_report.h"
49 #include "BKE_object.h"
50 #include "BKE_mesh.h"
51 #include "BKE_DerivedMesh.h"
52 #include "BKE_bvhutils.h"
53
54 #include "BKE_customdata.h"
55 #include "BKE_anim.h"
56 #include "BKE_depsgraph.h"
57 #include "BKE_displist.h"
58 #include "BKE_font.h"
59 #include "BKE_mball.h"
60 #include "BKE_modifier.h"
61 #include "BKE_cdderivedmesh.h"
62
63 #include "DNA_mesh_types.h"
64 #include "DNA_scene_types.h"
65 #include "DNA_meshdata_types.h"
66 #include "DNA_curve_types.h"
67 #include "DNA_modifier_types.h"
68 #include "DNA_constraint_types.h"
69 #include "DNA_view3d_types.h"
70
71 #include "MEM_guardedalloc.h"
72
73 /* copied from Mesh_getFromObject and adapted to RNA interface */
74 /* settings: 0 - preview, 1 - render */
75 Mesh *rna_Object_to_mesh(Object *ob, ReportList *reports, Scene *sce, int apply_modifiers, int settings)
76 {
77         Mesh *tmpmesh;
78         Curve *tmpcu = NULL, *copycu;
79         Object *tmpobj = NULL;
80         int render = settings == eModifierMode_Render, i;
81         int cage = !apply_modifiers;
82
83         /* perform the mesh extraction based on type */
84         switch (ob->type) {
85         case OB_FONT:
86         case OB_CURVE:
87         case OB_SURF:
88
89                 /* copies object and modifiers (but not the data) */
90                 tmpobj = copy_object(ob);
91                 tmpcu = (Curve *)tmpobj->data;
92                 tmpcu->id.us--;
93
94                 /* if getting the original caged mesh, delete object modifiers */
95                 if ( cage )
96                         object_free_modifiers(tmpobj);
97
98                 /* copies the data */
99                 copycu = tmpobj->data = BKE_curve_copy( (Curve *) ob->data );
100
101                 /* temporarily set edit so we get updates from edit mode, but
102                  * also because for text datablocks copying it while in edit
103                  * mode gives invalid data structures */
104                 copycu->editfont = tmpcu->editfont;
105                 copycu->editnurb = tmpcu->editnurb;
106
107                 /* get updated display list, and convert to a mesh */
108                 makeDispListCurveTypes( sce, tmpobj, 0 );
109
110                 copycu->editfont = NULL;
111                 copycu->editnurb = NULL;
112
113                 nurbs_to_mesh( tmpobj );
114
115                 /* nurbs_to_mesh changes the type to a mesh, check it worked */
116                 if (tmpobj->type != OB_MESH) {
117                         free_libblock_us( &(G.main->object), tmpobj );
118                         BKE_report(reports, RPT_ERROR, "cant convert curve to mesh. Does the curve have any segments?");
119                         return NULL;
120                 }
121                 tmpmesh = tmpobj->data;
122                 free_libblock_us( &G.main->object, tmpobj );
123                 break;
124
125         case OB_MBALL: {
126                 /* metaballs don't have modifiers, so just convert to mesh */
127                 Object *basis_ob = BKE_metaball_basis_find(sce, ob);
128                 /* todo, re-generatre for render-res */
129                 /* metaball_polygonize(scene, ob) */
130
131                 if (ob != basis_ob)
132                         return NULL; /* only do basis metaball */
133
134                 tmpmesh = add_mesh("Mesh");
135                         
136                 if (render) {
137                         ListBase disp = {NULL, NULL};
138                         makeDispListMBall_forRender(sce, ob, &disp);
139                         mball_to_mesh(&disp, tmpmesh);
140                         freedisplist(&disp);
141                 }
142                 else
143                         mball_to_mesh(&ob->disp, tmpmesh);
144                 break;
145
146         }
147         case OB_MESH:
148                 /* copies object and modifiers (but not the data) */
149                 if (cage) {
150                         /* copies the data */
151                         tmpmesh = copy_mesh( ob->data );
152                 /* if not getting the original caged mesh, get final derived mesh */
153                 }
154                 else {
155                         /* Make a dummy mesh, saves copying */
156                         DerivedMesh *dm;
157                         /* CustomDataMask mask = CD_MASK_BAREMESH|CD_MASK_MTFACE|CD_MASK_MCOL; */
158                         CustomDataMask mask = CD_MASK_MESH; /* this seems more suitable, exporter,
159                                                                                                  * for example, needs CD_MASK_MDEFORMVERT */
160                         
161                         /* Write the display mesh into the dummy mesh */
162                         if (render)
163                                 dm = mesh_create_derived_render(sce, ob, mask);
164                         else
165                                 dm = mesh_create_derived_view(sce, ob, mask);
166                         
167                         tmpmesh = add_mesh("Mesh");
168                         DM_to_mesh(dm, tmpmesh, ob);
169                         dm->release(dm);
170                 }
171                 
172                 break;
173         default:
174                 BKE_report(reports, RPT_ERROR, "Object does not have geometry data");
175                 return NULL;
176         }
177
178         /* Copy materials to new mesh */
179         switch (ob->type) {
180         case OB_SURF:
181         case OB_FONT:
182         case OB_CURVE:
183                 tmpmesh->totcol = tmpcu->totcol;
184                 
185                 /* free old material list (if it exists) and adjust user counts */
186                 if ( tmpcu->mat ) {
187                         for ( i = tmpcu->totcol; i-- > 0; ) {
188                                 /* are we an object material or data based? */
189
190                                 tmpmesh->mat[i] = ob->matbits[i] ? ob->mat[i] : tmpcu->mat[i];
191
192                                 if (tmpmesh->mat[i]) {
193                                         tmpmesh->mat[i]->id.us++;
194                                 }
195                         }
196                 }
197                 break;
198
199 #if 0
200         /* Crashes when assigning the new material, not sure why */
201         case OB_MBALL:
202                 tmpmb = (MetaBall *)ob->data;
203                 tmpmesh->totcol = tmpmb->totcol;
204                 
205                 /* free old material list (if it exists) and adjust user counts */
206                 if ( tmpmb->mat ) {
207                         for ( i = tmpmb->totcol; i-- > 0; ) {
208                                 tmpmesh->mat[i] = tmpmb->mat[i]; /* CRASH HERE ??? */
209                                 if (tmpmesh->mat[i]) {
210                                         tmpmb->mat[i]->id.us++;
211                                 }
212                         }
213                 }
214                 break;
215 #endif
216
217         case OB_MESH:
218                 if (!cage) {
219                         Mesh *origmesh = ob->data;
220                         tmpmesh->flag = origmesh->flag;
221                         tmpmesh->mat = MEM_dupallocN(origmesh->mat);
222                         tmpmesh->totcol = origmesh->totcol;
223                         tmpmesh->smoothresh = origmesh->smoothresh;
224                         if ( origmesh->mat ) {
225                                 for ( i = origmesh->totcol; i-- > 0; ) {
226                                         /* are we an object material or data based? */
227                                         tmpmesh->mat[i] = ob->matbits[i] ? ob->mat[i] : origmesh->mat[i];
228
229                                         if (tmpmesh->mat[i]) {
230                                                 tmpmesh->mat[i]->id.us++;
231                                         }
232                                 }
233                         }
234                 }
235                 break;
236         } /* end copy materials */
237
238         /* cycles and exporters rely on this still */
239         BKE_mesh_tessface_ensure(tmpmesh);
240
241         /* we don't assign it to anything */
242         tmpmesh->id.us--;
243         
244         /* make sure materials get updated in objects */
245         test_object_materials(&tmpmesh->id);
246
247         return tmpmesh;
248 }
249
250 /* mostly a copy from convertblender.c */
251 static void dupli_render_particle_set(Scene *scene, Object *ob, int level, int enable)
252 {
253         /* ugly function, but we need to set particle systems to their render
254          * settings before calling object_duplilist, to get render level duplis */
255         Group *group;
256         GroupObject *go;
257         ParticleSystem *psys;
258         DerivedMesh *dm;
259         float mat[4][4];
260
261         unit_m4(mat);
262
263         if (level >= MAX_DUPLI_RECUR)
264                 return;
265         
266         if (ob->transflag & OB_DUPLIPARTS) {
267                 for (psys = ob->particlesystem.first; psys; psys = psys->next) {
268                         if (ELEM(psys->part->ren_as, PART_DRAW_OB, PART_DRAW_GR)) {
269                                 if (enable)
270                                         psys_render_set(ob, psys, mat, mat, 1, 1, 0.f);
271                                 else
272                                         psys_render_restore(ob, psys);
273                         }
274                 }
275
276                 if (level == 0 && enable) {
277                         /* this is to make sure we get render level duplis in groups:
278                          * the derivedmesh must be created before init_render_mesh,
279                          * since object_duplilist does dupliparticles before that */
280                         dm = mesh_create_derived_render(scene, ob, CD_MASK_BAREMESH|CD_MASK_MTFACE|CD_MASK_MCOL);
281                         dm->release(dm);
282
283                         for (psys = ob->particlesystem.first; psys; psys = psys->next)
284                                 psys_get_modifier(ob, psys)->flag &= ~eParticleSystemFlag_psys_updated;
285                 }
286         }
287
288         if (ob->dup_group == NULL) return;
289         group = ob->dup_group;
290
291         for (go = group->gobject.first; go; go = go->next)
292                 dupli_render_particle_set(scene, go->ob, level+1, enable);
293 }
294 /* When no longer needed, duplilist should be freed with Object.free_duplilist */
295 void rna_Object_create_duplilist(Object *ob, ReportList *reports, Scene *sce)
296 {
297         if (!(ob->transflag & OB_DUPLI)) {
298                 BKE_report(reports, RPT_ERROR, "Object does not have duplis");
299                 return;
300         }
301
302         /* free duplilist if a user forgets to */
303         if (ob->duplilist) {
304                 BKE_reportf(reports, RPT_WARNING, "Object.dupli_list has not been freed");
305
306                 free_object_duplilist(ob->duplilist);
307                 ob->duplilist = NULL;
308         }
309         if (G.rendering)
310                 dupli_render_particle_set(sce, ob, 0, 1);
311         ob->duplilist = object_duplilist(sce, ob);
312         if (G.rendering)
313                 dupli_render_particle_set(sce, ob, 0, 0);
314         /* ob->duplilist should now be freed with Object.free_duplilist */
315 }
316
317 void rna_Object_free_duplilist(Object *ob)
318 {
319         if (ob->duplilist) {
320                 free_object_duplilist(ob->duplilist);
321                 ob->duplilist = NULL;
322         }
323 }
324
325 static PointerRNA rna_Object_shape_key_add(Object *ob, bContext *C, ReportList *reports,
326                                            const char *name, int from_mix)
327 {
328         Scene *scene = CTX_data_scene(C);
329         KeyBlock *kb = NULL;
330
331         if ((kb = object_insert_shape_key(scene, ob, name, from_mix))) {
332                 PointerRNA keyptr;
333
334                 RNA_pointer_create((ID *)ob->data, &RNA_ShapeKey, kb, &keyptr);
335                 WM_event_add_notifier(C, NC_OBJECT|ND_DRAW, ob);
336                 
337                 return keyptr;
338         }
339         else {
340                 BKE_reportf(reports, RPT_ERROR, "Object \"%s\"does not support shapes", ob->id.name+2);
341                 return PointerRNA_NULL;
342         }
343 }
344
345 int rna_Object_is_visible(Object *ob, Scene *sce)
346 {
347         return !(ob->restrictflag & OB_RESTRICT_VIEW) && (ob->lay & sce->lay);
348 }
349
350 #if 0
351 static void rna_Mesh_assign_verts_to_group(Object *ob, bDeformGroup *group, int *indices, int totindex,
352                                            float weight, int assignmode)
353 {
354         if (ob->type != OB_MESH) {
355                 BKE_report(reports, RPT_ERROR, "Object should be of MESH type");
356                 return;
357         }
358
359         Mesh *me = (Mesh*)ob->data;
360         int group_index = BLI_findlink(&ob->defbase, group);
361         if (group_index == -1) {
362                 BKE_report(reports, RPT_ERROR, "No deform groups assigned to mesh");
363                 return;
364         }
365
366         if (assignmode != WEIGHT_REPLACE && assignmode != WEIGHT_ADD && assignmode != WEIGHT_SUBTRACT) {
367                 BKE_report(reports, RPT_ERROR, "Bad assignment mode" );
368                 return;
369         }
370
371         /* makes a set of dVerts corresponding to the mVerts */
372         if (!me->dvert)
373                 create_dverts(&me->id);
374
375         /* loop list adding verts to group  */
376         for (i = 0; i < totindex; i++) {
377                 if (i < 0 || i >= me->totvert) {
378                         BKE_report(reports, RPT_ERROR, "Bad vertex index in list");
379                         return;
380                 }
381
382                 add_vert_defnr(ob, group_index, i, weight, assignmode);
383         }
384 }
385 #endif
386
387 /* BMESH_TODO, return polygon index, not tessface */
388 void rna_Object_ray_cast(Object *ob, ReportList *reports, float ray_start[3], float ray_end[3],
389                          float r_location[3], float r_normal[3], int *index)
390 {
391         BVHTreeFromMesh treeData = {NULL};
392         
393         if (ob->derivedFinal == NULL) {
394                 BKE_reportf(reports, RPT_ERROR, "object \"%s\" has no mesh data to be used for ray casting", ob->id.name+2);
395                 return;
396         }
397
398         /* no need to managing allocation or freeing of the BVH data. this is generated and freed as needed */
399         bvhtree_from_mesh_faces(&treeData, ob->derivedFinal, 0.0f, 4, 6);
400
401         if (treeData.tree == NULL) {
402                 BKE_reportf(reports, RPT_ERROR, "object \"%s\" could not create internal data for ray casting", ob->id.name+2);
403                 return;
404         }
405         else {
406                 BVHTreeRayHit hit;
407                 float ray_nor[3], dist;
408                 sub_v3_v3v3(ray_nor, ray_end, ray_start);
409
410                 dist = hit.dist = normalize_v3(ray_nor);
411                 hit.index = -1;
412                 
413                 if (BLI_bvhtree_ray_cast(treeData.tree, ray_start, ray_nor, 0.0f, &hit,
414                                          treeData.raycast_callback, &treeData) != -1) {
415                         if (hit.dist <= dist) {
416                                 copy_v3_v3(r_location, hit.co);
417                                 copy_v3_v3(r_normal, hit.no);
418                                 *index = hit.index;
419                                 return;
420                         }
421                 }
422         }
423
424         zero_v3(r_location);
425         zero_v3(r_normal);
426         *index = -1;
427 }
428
429 void rna_Object_closest_point_on_mesh(Object *ob, ReportList *reports, float point_co[3], float max_dist,
430                                       float n_location[3], float n_normal[3], int *index)
431 {
432         BVHTreeFromMesh treeData = {NULL};
433         
434         if (ob->derivedFinal == NULL) {
435                 BKE_reportf(reports, RPT_ERROR, "object \"%s\" has no mesh data to be used for finding nearest point",
436                             ob->id.name+2);
437                 return;
438         }
439
440         /* no need to managing allocation or freeing of the BVH data. this is generated and freed as needed */
441         bvhtree_from_mesh_faces(&treeData, ob->derivedFinal, 0.0f, 4, 6);
442
443         if (treeData.tree == NULL) {
444                 BKE_reportf(reports, RPT_ERROR, "object \"%s\" could not create internal data for finding nearest point",
445                             ob->id.name+2);
446                 return;
447         }
448         else {
449                 BVHTreeNearest nearest;
450
451                 nearest.index = -1;
452                 nearest.dist = max_dist * max_dist;
453
454                 if (BLI_bvhtree_find_nearest(treeData.tree, point_co, &nearest, treeData.nearest_callback, &treeData) != -1) {
455                         copy_v3_v3(n_location, nearest.co);
456                         copy_v3_v3(n_normal, nearest.no);
457                         *index = nearest.index;
458                         return;
459                 }
460         }
461
462         zero_v3(n_location);
463         zero_v3(n_normal);
464         *index = -1;
465 }
466
467 /* ObjectBase */
468
469 void rna_ObjectBase_layers_from_view(Base *base, View3D *v3d)
470 {
471         base->lay = base->object->lay = v3d->lay;
472 }
473
474 int rna_Object_is_modified(Object *ob, Scene *scene, int settings)
475 {
476         return object_is_modified(scene, ob) & settings;
477 }
478
479 #ifndef NDEBUG
480 void rna_Object_dm_info(struct Object *ob, int type, char *result)
481 {
482         DerivedMesh *dm = NULL;
483         int dm_release = FALSE;
484         char *ret = NULL;
485
486         result[0] = '\0';
487
488         switch (type) {
489                 case 0:
490                         if (ob->type == OB_MESH) {
491                                 dm = CDDM_from_mesh(ob->data, ob);
492                                 ret = DM_debug_info(dm);
493                                 dm_release = TRUE;
494                         }
495                         break;
496                 case 1:
497                         dm = ob->derivedDeform;
498                         break;
499                 case 2:
500                         dm = ob->derivedFinal;
501                         break;
502         }
503
504         if (dm) {
505                 ret = DM_debug_info(dm);
506                 if (dm_release) {
507                         dm->release(dm);
508                 }
509                 if (ret) {
510                         strcpy(result, ret);
511                         MEM_freeN(ret);
512                 }
513         }
514 }
515 #endif /* NDEBUG */
516
517 #else
518
519 void RNA_api_object(StructRNA *srna)
520 {
521         FunctionRNA *func;
522         PropertyRNA *parm;
523
524         static EnumPropertyItem mesh_type_items[] = {
525                 {eModifierMode_Realtime, "PREVIEW", 0, "Preview", "Apply modifier preview settings"},
526                 {eModifierMode_Render, "RENDER", 0, "Render", "Apply modifier render settings"},
527                 {0, NULL, 0, NULL, NULL}
528         };
529
530 #ifndef NDEBUG
531         static EnumPropertyItem mesh_dm_info_items[] = {
532                 {0, "SOURCE", 0, "Source", "Source mesh"},
533                 {1, "DEFORM", 0, "Deform", "Objects deform mesh"},
534                 {2, "FINAL", 0, "Final", "Objects final mesh"},
535                 {0, NULL, 0, NULL, NULL}
536         };
537 #endif
538
539         /* mesh */
540         func = RNA_def_function(srna, "to_mesh", "rna_Object_to_mesh");
541         RNA_def_function_ui_description(func, "Create a Mesh datablock with modifiers applied");
542         RNA_def_function_flag(func, FUNC_USE_REPORTS);
543         parm = RNA_def_pointer(func, "scene", "Scene", "", "Scene within which to evaluate modifiers");
544         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
545         parm = RNA_def_boolean(func, "apply_modifiers", 0, "", "Apply modifiers");
546         RNA_def_property_flag(parm, PROP_REQUIRED);
547         parm = RNA_def_enum(func, "settings", mesh_type_items, 0, "", "Modifier settings to apply");
548         RNA_def_property_flag(parm, PROP_REQUIRED);
549         parm = RNA_def_pointer(func, "mesh", "Mesh", "",
550                                "Mesh created from object, remove it if it is only used for export");
551         RNA_def_function_return(func, parm);
552
553         /* duplis */
554         func = RNA_def_function(srna, "dupli_list_create", "rna_Object_create_duplilist");
555         RNA_def_function_ui_description(func, "Create a list of dupli objects for this object, needs to "
556                                               "be freed manually with free_dupli_list to restore the "
557                                               "objects real matrix and layers");
558         parm = RNA_def_pointer(func, "scene", "Scene", "", "Scene within which to evaluate duplis");
559         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
560         RNA_def_function_flag(func, FUNC_USE_REPORTS);
561
562         func = RNA_def_function(srna, "dupli_list_clear", "rna_Object_free_duplilist");
563         RNA_def_function_ui_description(func, "Free the list of dupli objects");
564
565         /* Armature */
566         func = RNA_def_function(srna, "find_armature", "modifiers_isDeformedByArmature");
567         RNA_def_function_ui_description(func, "Find armature influencing this object as a parent or via a modifier");
568         parm = RNA_def_pointer(func, "ob_arm", "Object", "", "Armature object influencing this object or NULL");
569         RNA_def_function_return(func, parm);
570
571         /* Shape key */
572         func = RNA_def_function(srna, "shape_key_add", "rna_Object_shape_key_add");
573         RNA_def_function_ui_description(func, "Add shape key to an object");
574         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
575         RNA_def_string(func, "name", "Key", 0, "", "Unique name for the new keylock"); /* optional */
576         RNA_def_boolean(func, "from_mix", 1, "", "Create new shape from existing mix of shapes");
577         parm = RNA_def_pointer(func, "key", "ShapeKey", "", "New shape keyblock");
578         RNA_def_property_flag(parm, PROP_RNAPTR);
579         RNA_def_function_return(func, parm);
580
581         /* Ray Cast */
582         func = RNA_def_function(srna, "ray_cast", "rna_Object_ray_cast");
583         RNA_def_function_ui_description(func, "Cast a ray onto in object space");
584         RNA_def_function_flag(func, FUNC_USE_REPORTS);
585         
586         /* ray start and end */
587         parm = RNA_def_float_vector(func, "start", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
588         RNA_def_property_flag(parm, PROP_REQUIRED);
589         parm = RNA_def_float_vector(func, "end", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
590         RNA_def_property_flag(parm, PROP_REQUIRED);
591
592         /* return location and normal */
593         parm = RNA_def_float_vector(func, "location", 3, NULL, -FLT_MAX, FLT_MAX, "Location",
594                                     "The hit location of this ray cast", -1e4, 1e4);
595         RNA_def_property_flag(parm, PROP_THICK_WRAP);
596         RNA_def_function_output(func, parm);
597         parm = RNA_def_float_vector(func, "normal", 3, NULL, -FLT_MAX, FLT_MAX, "Normal",
598                                     "The face normal at the ray cast hit location", -1e4, 1e4);
599         RNA_def_property_flag(parm, PROP_THICK_WRAP);
600         RNA_def_function_output(func, parm);
601         
602         parm = RNA_def_int(func, "index", 0, 0, 0, "", "The face index, -1 when no intersection is found", 0, 0);
603         RNA_def_function_output(func, parm);
604
605         /* Nearest Point */
606         func = RNA_def_function(srna, "closest_point_on_mesh", "rna_Object_closest_point_on_mesh");
607         RNA_def_function_ui_description(func, "Find the nearest point on the object");
608         RNA_def_function_flag(func, FUNC_USE_REPORTS);
609
610         /* location of point for test and max distance */
611         parm = RNA_def_float_vector(func, "point", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
612         RNA_def_property_flag(parm, PROP_REQUIRED);
613         /* default is sqrt(FLT_MAX) */
614         RNA_def_float(func, "max_dist", 1.844674352395373e+19, 0.0, FLT_MAX, "", "", 0.0, FLT_MAX);
615
616         /* return location and normal */
617         parm = RNA_def_float_vector(func, "location", 3, NULL, -FLT_MAX, FLT_MAX, "Location",
618                                     "The location on the object closest to the point", -1e4, 1e4);
619         RNA_def_property_flag(parm, PROP_THICK_WRAP);
620         RNA_def_function_output(func, parm);
621         parm = RNA_def_float_vector(func, "normal", 3, NULL, -FLT_MAX, FLT_MAX, "Normal",
622                                     "The face normal at the closest point", -1e4, 1e4);
623         RNA_def_property_flag(parm, PROP_THICK_WRAP);
624         RNA_def_function_output(func, parm);
625
626         parm = RNA_def_int(func, "index", 0, 0, 0, "", "The face index, -1 when no closest point is found", 0, 0);
627         RNA_def_function_output(func, parm);
628
629         /* View */
630         func = RNA_def_function(srna, "is_visible", "rna_Object_is_visible");
631         RNA_def_function_ui_description(func, "Determine if object is visible in a given scene");
632         parm = RNA_def_pointer(func, "scene", "Scene", "", "");
633         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
634         parm = RNA_def_boolean(func, "result", 0, "", "Object visibility");
635         RNA_def_function_return(func, parm);
636
637         /* utility function for checking if the object is modified */
638         func = RNA_def_function(srna, "is_modified", "rna_Object_is_modified");
639         RNA_def_function_ui_description(func, "Determine if this object is modified from the base mesh data");
640         parm = RNA_def_pointer(func, "scene", "Scene", "", "");
641         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
642         parm = RNA_def_enum(func, "settings", mesh_type_items, 0, "", "Modifier settings to apply");
643         RNA_def_property_flag(parm, PROP_REQUIRED);
644         parm = RNA_def_boolean(func, "result", 0, "", "Object visibility");
645         RNA_def_function_return(func, parm);
646
647
648 #ifndef NDEBUG
649         /* mesh */
650         func = RNA_def_function(srna, "dm_info", "rna_Object_dm_info");
651         RNA_def_function_ui_description(func, "Returns a string for derived mesh data");
652
653         parm = RNA_def_enum(func, "type", mesh_dm_info_items, 0, "", "Modifier settings to apply");
654         RNA_def_property_flag(parm, PROP_REQUIRED);
655         /* weak!, no way to return dynamic string type */
656         parm = RNA_def_string(func, "result", "", 16384, "result", "");
657         RNA_def_property_flag(parm, PROP_THICK_WRAP); /* needed for string return value */
658         RNA_def_function_output(func, parm);
659 #endif /* NDEBUG */
660 }
661
662
663 void RNA_api_object_base(StructRNA *srna)
664 {
665         FunctionRNA *func;
666         PropertyRNA *parm;
667
668         func = RNA_def_function(srna, "layers_from_view", "rna_ObjectBase_layers_from_view");
669         RNA_def_function_ui_description(func,
670                                         "Sets the object layers from a 3D View (use when adding an object in local view)");
671         parm = RNA_def_pointer(func, "view", "SpaceView3D", "", "");
672         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
673 }
674
675 #endif
676