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