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