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