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