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