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