misc changes from trunk (avoid confusion since these were not intentional differences)
[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         /* we don't assign it to anything */
243         tmpmesh->id.us--;
244         
245         /* make sure materials get updated in objects */
246         test_object_materials( ( ID * ) tmpmesh );
247
248         return tmpmesh;
249 }
250
251 /* mostly a copy from convertblender.c */
252 static void dupli_render_particle_set(Scene *scene, Object *ob, int level, int enable)
253 {
254         /* ugly function, but we need to set particle systems to their render
255          * settings before calling object_duplilist, to get render level duplis */
256         Group *group;
257         GroupObject *go;
258         ParticleSystem *psys;
259         DerivedMesh *dm;
260         float mat[4][4];
261
262         unit_m4(mat);
263
264         if(level >= MAX_DUPLI_RECUR)
265                 return;
266         
267         if(ob->transflag & OB_DUPLIPARTS) {
268                 for(psys=ob->particlesystem.first; psys; psys=psys->next) {
269                         if(ELEM(psys->part->ren_as, PART_DRAW_OB, PART_DRAW_GR)) {
270                                 if(enable)
271                                         psys_render_set(ob, psys, mat, mat, 1, 1, 0.f);
272                                 else
273                                         psys_render_restore(ob, psys);
274                         }
275                 }
276
277                 if(level == 0 && enable) {
278                         /* this is to make sure we get render level duplis in groups:
279                         * the derivedmesh must be created before init_render_mesh,
280                         * since object_duplilist does dupliparticles before that */
281                         dm = mesh_create_derived_render(scene, ob, CD_MASK_BAREMESH|CD_MASK_MTFACE|CD_MASK_MCOL);
282                         dm->release(dm);
283
284                         for(psys=ob->particlesystem.first; psys; psys=psys->next)
285                                 psys_get_modifier(ob, psys)->flag &= ~eParticleSystemFlag_psys_updated;
286                 }
287         }
288
289         if(ob->dup_group==NULL) return;
290         group= ob->dup_group;
291
292         for(go= group->gobject.first; go; go= go->next)
293                 dupli_render_particle_set(scene, go->ob, level+1, enable);
294 }
295 /* When no longer needed, duplilist should be freed with Object.free_duplilist */
296 void rna_Object_create_duplilist(Object *ob, ReportList *reports, Scene *sce)
297 {
298         if (!(ob->transflag & OB_DUPLI)) {
299                 BKE_report(reports, RPT_ERROR, "Object does not have duplis");
300                 return;
301         }
302
303         /* free duplilist if a user forgets to */
304         if (ob->duplilist) {
305                 BKE_reportf(reports, RPT_WARNING, "Object.dupli_list has not been freed");
306
307                 free_object_duplilist(ob->duplilist);
308                 ob->duplilist= NULL;
309         }
310         if(G.rendering)
311                 dupli_render_particle_set(sce, ob, 0, 1);
312         ob->duplilist= object_duplilist(sce, ob);
313         if(G.rendering)
314                 dupli_render_particle_set(sce, ob, 0, 0);
315         /* ob->duplilist should now be freed with Object.free_duplilist */
316 }
317
318 void rna_Object_free_duplilist(Object *ob)
319 {
320         if (ob->duplilist) {
321                 free_object_duplilist(ob->duplilist);
322                 ob->duplilist= NULL;
323         }
324 }
325
326 static PointerRNA rna_Object_shape_key_add(Object *ob, bContext *C, ReportList *reports, 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 /*
351 static void rna_Mesh_assign_verts_to_group(Object *ob, bDeformGroup *group, int *indices, int totindex, float weight, int assignmode)
352 {
353         if (ob->type != OB_MESH) {
354                 BKE_report(reports, RPT_ERROR, "Object should be of MESH type");
355                 return;
356         }
357
358         Mesh *me = (Mesh*)ob->data;
359         int group_index = BLI_findlink(&ob->defbase, group);
360         if (group_index == -1) {
361                 BKE_report(reports, RPT_ERROR, "No deform groups assigned to mesh");
362                 return;
363         }
364
365         if (assignmode != WEIGHT_REPLACE && assignmode != WEIGHT_ADD && assignmode != WEIGHT_SUBTRACT) {
366                 BKE_report(reports, RPT_ERROR, "Bad assignment mode" );
367                 return;
368         }
369
370         // makes a set of dVerts corresponding to the mVerts
371         if (!me->dvert) 
372                 create_dverts(&me->id);
373
374         // loop list adding verts to group 
375         for (i= 0; i < totindex; i++) {
376                 if(i < 0 || i >= me->totvert) {
377                         BKE_report(reports, RPT_ERROR, "Bad vertex index in list");
378                         return;
379                 }
380
381                 add_vert_defnr(ob, group_index, i, weight, assignmode);
382         }
383 }
384 */
385
386 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)
387 {
388         BVHTreeFromMesh treeData= {NULL};
389         
390         if(ob->derivedFinal==NULL) {
391                 BKE_reportf(reports, RPT_ERROR, "object \"%s\" has no mesh data to be used for ray casting", ob->id.name+2);
392                 return;
393         }
394
395         /* no need to managing allocation or freeing of the BVH data. this is generated and freed as needed */
396         bvhtree_from_mesh_faces(&treeData, ob->derivedFinal, 0.0f, 4, 6);
397
398         if(treeData.tree==NULL) {
399                 BKE_reportf(reports, RPT_ERROR, "object \"%s\" could not create internal data for ray casting", ob->id.name+2);
400                 return;
401         }
402         else {
403                 BVHTreeRayHit hit;
404                 float ray_nor[3], dist;
405                 sub_v3_v3v3(ray_nor, ray_end, ray_start);
406
407                 dist= hit.dist = normalize_v3(ray_nor);
408                 hit.index = -1;
409                 
410                 if(BLI_bvhtree_ray_cast(treeData.tree, ray_start, ray_nor, 0.0f, &hit, treeData.raycast_callback, &treeData) != -1) {
411                         if(hit.dist<=dist) {
412                                 copy_v3_v3(r_location, hit.co);
413                                 copy_v3_v3(r_normal, hit.no);
414                                 *index= hit.index;
415                                 return;
416                         }
417                 }
418         }
419
420         zero_v3(r_location);
421         zero_v3(r_normal);
422         *index= -1;
423 }
424
425 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)
426 {
427         BVHTreeFromMesh treeData= {NULL};
428         
429         if(ob->derivedFinal==NULL) {
430                 BKE_reportf(reports, RPT_ERROR, "object \"%s\" has no mesh data to be used for finding nearest point", ob->id.name+2);
431                 return;
432         }
433
434         /* no need to managing allocation or freeing of the BVH data. this is generated and freed as needed */
435         bvhtree_from_mesh_faces(&treeData, ob->derivedFinal, 0.0f, 4, 6);
436
437         if(treeData.tree==NULL) {
438                 BKE_reportf(reports, RPT_ERROR, "object \"%s\" could not create internal data for finding nearest point", ob->id.name+2);
439                 return;
440         }
441         else {
442                 BVHTreeNearest nearest;
443
444                 nearest.index = -1;
445                 nearest.dist = max_dist * max_dist;
446
447                 if(BLI_bvhtree_find_nearest(treeData.tree, point_co, &nearest, treeData.nearest_callback, &treeData) != -1) {
448                         copy_v3_v3(n_location, nearest.co);
449                         copy_v3_v3(n_normal, nearest.no);
450                         *index= nearest.index;
451                         return;
452                 }
453         }
454
455         zero_v3(n_location);
456         zero_v3(n_normal);
457         *index= -1;
458 }
459
460 /* ObjectBase */
461
462 void rna_ObjectBase_layers_from_view(Base *base, View3D *v3d)
463 {
464         base->lay= base->object->lay= v3d->lay;
465 }
466
467 int rna_Object_is_modified(Object *ob, Scene *scene, int settings)
468 {
469         return object_is_modified(scene, ob) & settings;
470 }
471
472 #ifndef NDEBUG
473 void rna_Object_dm_info(struct Object *ob, int type, char *result)
474 {
475         DerivedMesh *dm = NULL;
476         int dm_release = FALSE;
477         char *ret = NULL;
478
479         result[0] = '\0';
480
481         switch(type) {
482                 case 0:
483                         if (ob->type == OB_MESH) {
484                                 dm = CDDM_from_mesh(ob->data, ob);
485                                 ret = DM_debug_info(dm);
486                                 dm_release = TRUE;
487                         }
488                         break;
489                 case 1:
490                         dm = ob->derivedDeform;
491                         break;
492                 case 2:
493                         dm = ob->derivedFinal;
494                         break;
495         }
496
497         if (dm) {
498                 ret = DM_debug_info(dm);
499                 if (dm_release) {
500                         dm->release(dm);
501                 }
502                 if (ret) {
503                         strcpy(result, ret);
504                         MEM_freeN(ret);
505                 }
506         }
507 }
508 #endif /* NDEBUG */
509
510 #else
511
512 void RNA_api_object(StructRNA *srna)
513 {
514         FunctionRNA *func;
515         PropertyRNA *parm;
516
517         static EnumPropertyItem mesh_type_items[] = {
518                 {eModifierMode_Realtime, "PREVIEW", 0, "Preview", "Apply modifier preview settings"},
519                 {eModifierMode_Render, "RENDER", 0, "Render", "Apply modifier render settings"},
520                 {0, NULL, 0, NULL, NULL}
521         };
522
523 #ifndef NDEBUG
524         static EnumPropertyItem mesh_dm_info_items[] = {
525                 {0, "SOURCE", 0, "Source", "Source mesh"},
526                 {1, "DEFORM", 0, "Deform", "Objects deform mesh"},
527             {2, "FINAL", 0, "Final", "Objects final mesh"},
528                 {0, NULL, 0, NULL, NULL}
529         };
530 #endif
531
532         /* mesh */
533         func= RNA_def_function(srna, "to_mesh", "rna_Object_to_mesh");
534         RNA_def_function_ui_description(func, "Create a Mesh datablock with modifiers applied");
535         RNA_def_function_flag(func, FUNC_USE_REPORTS);
536         parm= RNA_def_pointer(func, "scene", "Scene", "", "Scene within which to evaluate modifiers");
537         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
538         parm= RNA_def_boolean(func, "apply_modifiers", 0, "", "Apply modifiers");
539         RNA_def_property_flag(parm, PROP_REQUIRED);
540         parm= RNA_def_enum(func, "settings", mesh_type_items, 0, "", "Modifier settings to apply");
541         RNA_def_property_flag(parm, PROP_REQUIRED);
542         parm= RNA_def_pointer(func, "mesh", "Mesh", "", "Mesh created from object, remove it if it is only used for export");
543         RNA_def_function_return(func, parm);
544
545         /* duplis */
546         func= RNA_def_function(srna, "dupli_list_create", "rna_Object_create_duplilist");
547         RNA_def_function_ui_description(func, "Create a list of dupli objects for this object, needs to "
548                                               "be freed manually with free_dupli_list to restore the "
549                                               "objects real matrix and layers");
550         parm= RNA_def_pointer(func, "scene", "Scene", "", "Scene within which to evaluate duplis");
551         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
552         RNA_def_function_flag(func, FUNC_USE_REPORTS);
553
554         func= RNA_def_function(srna, "dupli_list_clear", "rna_Object_free_duplilist");
555         RNA_def_function_ui_description(func, "Free the list of dupli objects");
556
557         /* Armature */
558         func= RNA_def_function(srna, "find_armature", "modifiers_isDeformedByArmature");
559         RNA_def_function_ui_description(func, "Find armature influencing this object as a parent or via a modifier");
560         parm= RNA_def_pointer(func, "ob_arm", "Object", "", "Armature object influencing this object or NULL");
561         RNA_def_function_return(func, parm);
562
563         /* Shape key */
564         func= RNA_def_function(srna, "shape_key_add", "rna_Object_shape_key_add");
565         RNA_def_function_ui_description(func, "Add shape key to an object");
566         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
567         RNA_def_string(func, "name", "Key", 0, "", "Unique name for the new keylock"); /* optional */
568         RNA_def_boolean(func, "from_mix", 1, "", "Create new shape from existing mix of shapes");
569         parm= RNA_def_pointer(func, "key", "ShapeKey", "", "New shape keyblock");
570         RNA_def_property_flag(parm, PROP_RNAPTR);
571         RNA_def_function_return(func, parm);
572
573         /* Ray Cast */
574         func= RNA_def_function(srna, "ray_cast", "rna_Object_ray_cast");
575         RNA_def_function_ui_description(func, "Cast a ray onto in object space");
576         RNA_def_function_flag(func, FUNC_USE_REPORTS);
577         
578         /* ray start and end */
579         parm= RNA_def_float_vector(func, "start", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
580         RNA_def_property_flag(parm, PROP_REQUIRED);
581         parm= RNA_def_float_vector(func, "end", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
582         RNA_def_property_flag(parm, PROP_REQUIRED);
583
584         /* return location and normal */
585         parm= RNA_def_float_vector(func, "location", 3, NULL, -FLT_MAX, FLT_MAX, "Location", "The hit location of this ray cast", -1e4, 1e4);
586         RNA_def_property_flag(parm, PROP_THICK_WRAP);
587         RNA_def_function_output(func, parm);
588         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);
589         RNA_def_property_flag(parm, PROP_THICK_WRAP);
590         RNA_def_function_output(func, parm);
591         
592         parm= RNA_def_int(func, "index", 0, 0, 0, "", "The face index, -1 when no intersection is found", 0, 0);
593         RNA_def_function_output(func, parm);
594
595         /* Nearest Point */
596         func= RNA_def_function(srna, "closest_point_on_mesh", "rna_Object_closest_point_on_mesh");
597         RNA_def_function_ui_description(func, "Find the nearest point on the object");
598         RNA_def_function_flag(func, FUNC_USE_REPORTS);
599
600         /* location of point for test and max distance */
601         parm= RNA_def_float_vector(func, "point", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
602         RNA_def_property_flag(parm, PROP_REQUIRED);
603         /* default is sqrt(FLT_MAX) */
604         RNA_def_float(func, "max_dist", 1.844674352395373e+19, 0.0, FLT_MAX, "", "", 0.0, FLT_MAX);
605
606         /* return location and normal */
607         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);
608         RNA_def_property_flag(parm, PROP_THICK_WRAP);
609         RNA_def_function_output(func, parm);
610         parm= RNA_def_float_vector(func, "normal", 3, NULL, -FLT_MAX, FLT_MAX, "Normal", "The face normal at the closest point", -1e4, 1e4);
611         RNA_def_property_flag(parm, PROP_THICK_WRAP);
612         RNA_def_function_output(func, parm);
613
614         parm= RNA_def_int(func, "index", 0, 0, 0, "", "The face index, -1 when no closest point is found", 0, 0);
615         RNA_def_function_output(func, parm);
616
617         /* View */
618         func= RNA_def_function(srna, "is_visible", "rna_Object_is_visible");
619         RNA_def_function_ui_description(func, "Determine if object is visible in a given scene");
620         parm= RNA_def_pointer(func, "scene", "Scene", "", "");
621         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
622         parm= RNA_def_boolean(func, "result", 0, "", "Object visibility");
623         RNA_def_function_return(func, parm);
624
625         /* utility function for checking if the object is modified */
626         func= RNA_def_function(srna, "is_modified", "rna_Object_is_modified");
627         RNA_def_function_ui_description(func, "Determine if this object is modified from the base mesh data");
628         parm= RNA_def_pointer(func, "scene", "Scene", "", "");
629         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
630         parm= RNA_def_enum(func, "settings", mesh_type_items, 0, "", "Modifier settings to apply");
631         RNA_def_property_flag(parm, PROP_REQUIRED);
632         parm= RNA_def_boolean(func, "result", 0, "", "Object visibility");
633         RNA_def_function_return(func, parm);
634
635
636 #ifndef NDEBUG
637         /* mesh */
638         func= RNA_def_function(srna, "dm_info", "rna_Object_dm_info");
639         RNA_def_function_ui_description(func, "Returns a string for derived mesh data");
640
641         parm= RNA_def_enum(func, "type", mesh_dm_info_items, 0, "", "Modifier settings to apply");
642         RNA_def_property_flag(parm, PROP_REQUIRED);
643         /* weak!, no way to return dynamic string type */
644         parm= RNA_def_string(func, "result", "", 16384, "result", "");
645         RNA_def_property_flag(parm, PROP_THICK_WRAP); /* needed for string return value */
646         RNA_def_function_output(func, parm);
647 #endif /* NDEBUG */
648 }
649
650
651 void RNA_api_object_base(StructRNA *srna)
652 {
653         FunctionRNA *func;
654         PropertyRNA *parm;
655
656         func= RNA_def_function(srna, "layers_from_view", "rna_ObjectBase_layers_from_view");
657         RNA_def_function_ui_description(func, "Sets the object layers from a 3D View (use when adding an object in local view)");
658         parm= RNA_def_pointer(func, "view", "SpaceView3D", "", "");
659         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
660 }
661
662 #endif
663