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