Merge remote-tracking branch 'origin/master' into blender2.8
[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 "BLI_utildefines.h"
38 #include "BLI_kdopbvh.h"
39
40 #include "RNA_define.h"
41
42 #include "DNA_constraint_types.h"
43 #include "DNA_layer_types.h"
44 #include "DNA_modifier_types.h"
45 #include "DNA_object_types.h"
46
47 #include "BKE_layer.h"
48
49 #include "DEG_depsgraph.h"
50
51 #include "rna_internal.h"  /* own include */
52
53 static EnumPropertyItem space_items[] = {
54         {CONSTRAINT_SPACE_WORLD,    "WORLD", 0, "World Space",
55                                     "The most gobal space in Blender"},
56         {CONSTRAINT_SPACE_POSE,     "POSE", 0, "Pose Space",
57                                     "The pose space of a bone (its armature's object space)"},
58         {CONSTRAINT_SPACE_PARLOCAL, "LOCAL_WITH_PARENT", 0, "Local With Parent",
59                                     "The local space of a bone's parent bone"},
60         {CONSTRAINT_SPACE_LOCAL,    "LOCAL", 0, "Local Space",
61                                     "The local space of an object/bone"},
62         {0, NULL, 0, NULL, NULL}
63 };
64
65 #ifdef RNA_RUNTIME
66
67 #include "BLI_math.h"
68
69 #include "BKE_anim.h"
70 #include "BKE_bvhutils.h"
71 #include "BKE_cdderivedmesh.h"
72 #include "BKE_constraint.h"
73 #include "BKE_context.h"
74 #include "BKE_customdata.h"
75 #include "BKE_font.h"
76 #include "BKE_global.h"
77 #include "BKE_main.h"
78 #include "BKE_mesh.h"
79 #include "BKE_mball.h"
80 #include "BKE_modifier.h"
81 #include "BKE_object.h"
82 #include "BKE_report.h"
83
84 #include "ED_object.h"
85
86 #include "DNA_curve_types.h"
87 #include "DNA_mesh_types.h"
88 #include "DNA_meshdata_types.h"
89 #include "DNA_scene_types.h"
90 #include "DNA_view3d_types.h"
91
92 #include "MEM_guardedalloc.h"
93
94 static void rna_Object_select_set(Object *ob, bContext *C, ReportList *reports, int action)
95 {
96         SceneLayer *sl = CTX_data_scene_layer(C);
97         Base *base = BKE_scene_layer_base_find(sl, ob);
98
99         if (!base) {
100                 BKE_reportf(reports, RPT_ERROR, "Object '%s' not in Render Layer '%s'!", ob->id.name + 2, sl->name);
101                 return;
102         }
103
104         if (action == 2) { /* TOGGLE */
105                 if ((base->flag & BASE_SELECTED) != 0) {
106                         action = 1; /* DESELECT */
107                 }
108                 else {
109                         action = 0; /* SELECT */
110                 }
111         }
112
113         switch (action) {
114             case 1: /* DESELECT */
115                     base->flag &= ~BASE_SELECTED;
116                     break;
117             case 0: /* SELECT */
118             default:
119                     BKE_scene_layer_base_select(sl, base);
120                     break;
121         }
122 }
123
124 static int rna_Object_select_get(Object *ob, bContext *C, ReportList *reports)
125 {
126         SceneLayer *sl = CTX_data_scene_layer(C);
127         Base *base = BKE_scene_layer_base_find(sl, ob);
128
129         if (!base) {
130                 BKE_reportf(reports, RPT_ERROR, "Object '%s' not in Render Layer '%s'!", ob->id.name + 2, sl->name);
131                 return -1;
132         }
133
134         return ((base->flag & BASE_SELECTED) != 0) ? 1 : 0;
135 }
136
137 static int rna_Object_visible_get(Object *ob, bContext *C, ReportList *reports)
138 {
139         SceneLayer *sl = CTX_data_scene_layer(C);
140         Base *base = BKE_scene_layer_base_find(sl, ob);
141
142         if (!base) {
143                 BKE_reportf(reports, RPT_ERROR, "Object '%s' not in Render Layer '%s'!", ob->id.name + 2, sl->name);
144                 return -1;
145         }
146
147         return ((base->flag & BASE_VISIBLED) != 0) ? 1 : 0;
148 }
149
150 /* Convert a given matrix from a space to another (using the object and/or a bone as reference). */
151 static void rna_Scene_mat_convert_space(Object *ob, ReportList *reports, bPoseChannel *pchan,
152                                         float *mat, float *mat_ret, int from, int to)
153 {
154         copy_m4_m4((float (*)[4])mat_ret, (float (*)[4])mat);
155
156         /* Error in case of invalid from/to values when pchan is NULL */
157         if (pchan == NULL) {
158                 if (ELEM(from, CONSTRAINT_SPACE_POSE, CONSTRAINT_SPACE_PARLOCAL)) {
159                         const char *identifier = NULL;
160                         RNA_enum_identifier(space_items, from, &identifier);
161                         BKE_reportf(reports, RPT_ERROR, "'from_space' '%s' is invalid when no pose bone is given!", identifier);
162                         return;
163                 }
164                 if (ELEM(to, CONSTRAINT_SPACE_POSE, CONSTRAINT_SPACE_PARLOCAL)) {
165                         const char *identifier = NULL;
166                         RNA_enum_identifier(space_items, to, &identifier);
167                         BKE_reportf(reports, RPT_ERROR, "'to_space' '%s' is invalid when no pose bone is given!", identifier);
168                         return;
169                 }
170         }
171
172         BKE_constraint_mat_convertspace(ob, pchan, (float (*)[4])mat_ret, from, to, false);
173 }
174
175 static void rna_Object_calc_matrix_camera(
176         Object *ob, float mat_ret[16], int width, int height, float scalex, float scaley)
177 {
178         CameraParams params;
179
180         /* setup parameters */
181         BKE_camera_params_init(&params);
182         BKE_camera_params_from_object(&params, ob);
183
184         /* compute matrix, viewplane, .. */
185         BKE_camera_params_compute_viewplane(&params, width, height, scalex, scaley);
186         BKE_camera_params_compute_matrix(&params);
187
188         copy_m4_m4((float (*)[4])mat_ret, params.winmat);
189 }
190
191 static void rna_Object_camera_fit_coords(
192         Object *ob, Scene *scene, int num_cos, float *cos, float co_ret[3], float *scale_ret)
193 {
194         BKE_camera_view_frame_fit_to_coords(scene, (const float (*)[3])cos, num_cos / 3, ob, co_ret, scale_ret);
195 }
196
197 /* copied from Mesh_getFromObject and adapted to RNA interface */
198 /* settings: 0 - preview, 1 - render */
199 static Mesh *rna_Object_to_mesh(
200         Object *ob, bContext *C, ReportList *reports, Scene *sce, SceneLayer *sl,
201         int apply_modifiers, int settings, int calc_tessface, int calc_undeformed)
202 {
203         Main *bmain = CTX_data_main(C);
204
205         return rna_Main_meshes_new_from_object(bmain, reports, sce, sl, ob, apply_modifiers, settings, calc_tessface, calc_undeformed);
206 }
207
208 /* mostly a copy from convertblender.c */
209 static void dupli_render_particle_set(EvaluationContext *eval_ctx, Scene *scene, Object *ob, int level, int enable)
210 {
211         /* ugly function, but we need to set particle systems to their render
212          * settings before calling object_duplilist, to get render level duplis */
213         Group *group;
214         GroupObject *go;
215         ParticleSystem *psys;
216         DerivedMesh *dm;
217         float mat[4][4];
218
219         unit_m4(mat);
220
221         if (level >= MAX_DUPLI_RECUR)
222                 return;
223         
224         if (ob->transflag & OB_DUPLIPARTS) {
225                 for (psys = ob->particlesystem.first; psys; psys = psys->next) {
226                         if (ELEM(psys->part->ren_as, PART_DRAW_OB, PART_DRAW_GR)) {
227                                 if (enable)
228                                         psys_render_set(ob, psys, mat, mat, 1, 1, 0.f);
229                                 else
230                                         psys_render_restore(ob, psys);
231                         }
232                 }
233
234                 if (enable) {
235                         /* this is to make sure we get render level duplis in groups:
236                          * the derivedmesh must be created before init_render_mesh,
237                          * since object_duplilist does dupliparticles before that */
238                         dm = mesh_create_derived_render(eval_ctx, scene, ob, CD_MASK_BAREMESH | CD_MASK_MLOOPUV | CD_MASK_MLOOPCOL);
239                         dm->release(dm);
240
241                         for (psys = ob->particlesystem.first; psys; psys = psys->next)
242                                 psys_get_modifier(ob, psys)->flag &= ~eParticleSystemFlag_psys_updated;
243                 }
244         }
245
246         if (ob->dup_group == NULL) return;
247         group = ob->dup_group;
248
249         for (go = group->gobject.first; go; go = go->next)
250                 dupli_render_particle_set(eval_ctx, scene, go->ob, level + 1, enable);
251 }
252 /* When no longer needed, duplilist should be freed with Object.free_duplilist */
253 static void rna_Object_create_duplilist(Object *ob, bContext *C, ReportList *reports, Scene *sce, int settings)
254 {
255         bool for_render = (settings == DAG_EVAL_RENDER);
256         EvaluationContext eval_ctx;
257
258         CTX_data_eval_ctx(C, &eval_ctx);
259
260         eval_ctx.mode = settings;
261
262         if (!(ob->transflag & OB_DUPLI)) {
263                 BKE_report(reports, RPT_ERROR, "Object does not have duplis");
264                 return;
265         }
266
267         /* free duplilist if a user forgets to */
268         if (ob->duplilist) {
269                 BKE_report(reports, RPT_WARNING, "Object.dupli_list has not been freed");
270
271                 free_object_duplilist(ob->duplilist);
272                 ob->duplilist = NULL;
273         }
274         if (for_render)
275                 dupli_render_particle_set(&eval_ctx, sce, ob, 0, 1);
276         ob->duplilist = object_duplilist(&eval_ctx, sce, ob);
277         if (for_render)
278                 dupli_render_particle_set(&eval_ctx, sce, ob, 0, 0);
279         /* ob->duplilist should now be freed with Object.free_duplilist */
280 }
281
282 static void rna_Object_free_duplilist(Object *ob)
283 {
284         if (ob->duplilist) {
285                 free_object_duplilist(ob->duplilist);
286                 ob->duplilist = NULL;
287         }
288 }
289
290 static PointerRNA rna_Object_shape_key_add(Object *ob, bContext *C, ReportList *reports,
291                                            const char *name, int from_mix)
292 {
293         KeyBlock *kb = NULL;
294
295         if ((kb = BKE_object_shapekey_insert(ob, name, from_mix))) {
296                 PointerRNA keyptr;
297
298                 RNA_pointer_create((ID *)ob->data, &RNA_ShapeKey, kb, &keyptr);
299                 WM_event_add_notifier(C, NC_OBJECT | ND_DRAW, ob);
300                 
301                 return keyptr;
302         }
303         else {
304                 BKE_reportf(reports, RPT_ERROR, "Object '%s' does not support shapes", ob->id.name + 2);
305                 return PointerRNA_NULL;
306         }
307 }
308
309 static void rna_Object_shape_key_remove(
310         Object *ob, Main *bmain, ReportList *reports,
311         PointerRNA *kb_ptr)
312 {
313         KeyBlock *kb = kb_ptr->data;
314         Key *key = BKE_key_from_object(ob);
315
316         if ((key == NULL) || BLI_findindex(&key->block, kb) == -1) {
317                 BKE_reportf(reports, RPT_ERROR, "ShapeKey not found");
318                 return;
319         }
320
321         if (!BKE_object_shapekey_remove(bmain, ob, kb)) {
322                 BKE_reportf(reports, RPT_ERROR, "Could not remove ShapeKey");
323                 return;
324         }
325
326         DEG_id_tag_update(&ob->id, OB_RECALC_DATA);
327         WM_main_add_notifier(NC_OBJECT | ND_DRAW, ob);
328
329         RNA_POINTER_INVALIDATE(kb_ptr);
330 }
331
332 static int rna_Object_is_visible(Object *ob, Scene *sce)
333 {
334         return !(ob->restrictflag & OB_RESTRICT_VIEW) && (ob->lay & sce->lay);
335 }
336
337 #if 0
338 static void rna_Mesh_assign_verts_to_group(Object *ob, bDeformGroup *group, int *indices, int totindex,
339                                            float weight, int assignmode)
340 {
341         if (ob->type != OB_MESH) {
342                 BKE_report(reports, RPT_ERROR, "Object should be of mesh type");
343                 return;
344         }
345
346         Mesh *me = (Mesh *)ob->data;
347         int group_index = BLI_findlink(&ob->defbase, group);
348         if (group_index == -1) {
349                 BKE_report(reports, RPT_ERROR, "No vertex groups assigned to mesh");
350                 return;
351         }
352
353         if (assignmode != WEIGHT_REPLACE && assignmode != WEIGHT_ADD && assignmode != WEIGHT_SUBTRACT) {
354                 BKE_report(reports, RPT_ERROR, "Bad assignment mode");
355                 return;
356         }
357
358         /* makes a set of dVerts corresponding to the mVerts */
359         if (!me->dvert)
360                 create_dverts(&me->id);
361
362         /* loop list adding verts to group  */
363         for (i = 0; i < totindex; i++) {
364                 if (i < 0 || i >= me->totvert) {
365                         BKE_report(reports, RPT_ERROR, "Bad vertex index in list");
366                         return;
367                 }
368
369                 add_vert_defnr(ob, group_index, i, weight, assignmode);
370         }
371 }
372 #endif
373
374 /* don't call inside a loop */
375 static int dm_looptri_to_poly_index(DerivedMesh *dm, const MLoopTri *lt)
376 {
377         const int *index_mp_to_orig = dm->getPolyDataArray(dm, CD_ORIGINDEX);
378         return index_mp_to_orig ? index_mp_to_orig[lt->poly] : lt->poly;
379 }
380
381 static void rna_Object_ray_cast(
382         Object *ob, ReportList *reports,
383         float origin[3], float direction[3], float distance,
384         int *r_success, float r_location[3], float r_normal[3], int *r_index)
385 {
386         bool success = false;
387
388         if (ob->derivedFinal == NULL) {
389                 BKE_reportf(reports, RPT_ERROR, "Object '%s' has no mesh data to be used for ray casting", ob->id.name + 2);
390                 return;
391         }
392
393         /* Test BoundBox first (efficiency) */
394         BoundBox *bb = BKE_object_boundbox_get(ob);
395         float distmin;
396         if (!bb || (isect_ray_aabb_v3_simple(origin, direction, bb->vec[0], bb->vec[6], &distmin, NULL) && distmin <= distance)) {
397
398                 BVHTreeFromMesh treeData = {NULL};
399
400                 /* no need to managing allocation or freeing of the BVH data. this is generated and freed as needed */
401                 bvhtree_from_mesh_looptri(&treeData, ob->derivedFinal, 0.0f, 4, 6);
402
403                 /* may fail if the mesh has no faces, in that case the ray-cast misses */
404                 if (treeData.tree != NULL) {
405                         BVHTreeRayHit hit;
406
407                         hit.index = -1;
408                         hit.dist = distance;
409
410                         normalize_v3(direction);
411
412
413                         if (BLI_bvhtree_ray_cast(treeData.tree, origin, direction, 0.0f, &hit,
414                                                  treeData.raycast_callback, &treeData) != -1)
415                         {
416                                 if (hit.dist <= distance) {
417                                         *r_success = success = true;
418
419                                         copy_v3_v3(r_location, hit.co);
420                                         copy_v3_v3(r_normal, hit.no);
421                                         *r_index = dm_looptri_to_poly_index(ob->derivedFinal, &treeData.looptri[hit.index]);
422                                 }
423                         }
424
425                         free_bvhtree_from_mesh(&treeData);
426                 }
427         }
428         if (success == false) {
429                 *r_success = false;
430
431                 zero_v3(r_location);
432                 zero_v3(r_normal);
433                 *r_index = -1;
434         }
435 }
436
437 static void rna_Object_closest_point_on_mesh(
438         Object *ob, ReportList *reports, float origin[3], float distance,
439         int *r_success, float r_location[3], float r_normal[3], int *r_index)
440 {
441         BVHTreeFromMesh treeData = {NULL};
442         
443         if (ob->derivedFinal == NULL) {
444                 BKE_reportf(reports, RPT_ERROR, "Object '%s' has no mesh data to be used for finding nearest point",
445                             ob->id.name + 2);
446                 return;
447         }
448
449         /* no need to managing allocation or freeing of the BVH data. this is generated and freed as needed */
450         bvhtree_from_mesh_looptri(&treeData, ob->derivedFinal, 0.0f, 4, 6);
451
452         if (treeData.tree == NULL) {
453                 BKE_reportf(reports, RPT_ERROR, "Object '%s' could not create internal data for finding nearest point",
454                             ob->id.name + 2);
455                 return;
456         }
457         else {
458                 BVHTreeNearest nearest;
459
460                 nearest.index = -1;
461                 nearest.dist_sq = distance * distance;
462
463                 if (BLI_bvhtree_find_nearest(treeData.tree, origin, &nearest, treeData.nearest_callback, &treeData) != -1) {
464                         *r_success = true;
465
466                         copy_v3_v3(r_location, nearest.co);
467                         copy_v3_v3(r_normal, nearest.no);
468                         *r_index = dm_looptri_to_poly_index(ob->derivedFinal, &treeData.looptri[nearest.index]);
469
470                         goto finally;
471                 }
472         }
473
474         *r_success = false;
475
476         zero_v3(r_location);
477         zero_v3(r_normal);
478         *r_index = -1;
479
480 finally:
481         free_bvhtree_from_mesh(&treeData);
482 }
483
484 /* ObjectBaseLegacy */
485
486 static void rna_ObjectBaseLegacy_layers_from_view(BaseLegacy *base, View3D *v3d)
487 {
488         base->lay = base->object->lay = v3d->lay;
489 }
490
491 static int rna_Object_is_modified(Object *ob, Scene *scene, int settings)
492 {
493         return BKE_object_is_modified(scene, ob) & settings;
494 }
495
496 static int rna_Object_is_deform_modified(Object *ob, Scene *scene, int settings)
497 {
498         return BKE_object_is_deform_modified(scene, ob) & settings;
499 }
500
501 #ifndef NDEBUG
502 void rna_Object_dm_info(struct Object *ob, int type, char *result)
503 {
504         DerivedMesh *dm = NULL;
505         bool dm_release = false;
506         char *ret = NULL;
507
508         result[0] = '\0';
509
510         switch (type) {
511                 case 0:
512                         if (ob->type == OB_MESH) {
513                                 dm = CDDM_from_mesh(ob->data);
514                                 ret = DM_debug_info(dm);
515                                 dm_release = true;
516                         }
517                         break;
518                 case 1:
519                         dm = ob->derivedDeform;
520                         break;
521                 case 2:
522                         dm = ob->derivedFinal;
523                         break;
524         }
525
526         if (dm) {
527                 ret = DM_debug_info(dm);
528                 if (dm_release) {
529                         dm->release(dm);
530                 }
531                 if (ret) {
532                         strcpy(result, ret);
533                         MEM_freeN(ret);
534                 }
535         }
536 }
537 #endif /* NDEBUG */
538
539 static int rna_Object_update_from_editmode(Object *ob)
540 {
541         if (ob->mode & OB_MODE_EDIT) {
542                 return ED_object_editmode_load(ob);
543         }
544         return false;
545 }
546 #else /* RNA_RUNTIME */
547
548 void RNA_api_object(StructRNA *srna)
549 {
550         FunctionRNA *func;
551         PropertyRNA *parm;
552
553         static EnumPropertyItem mesh_type_items[] = {
554                 {eModifierMode_Realtime, "PREVIEW", 0, "Preview", "Apply modifier preview settings"},
555                 {eModifierMode_Render, "RENDER", 0, "Render", "Apply modifier render settings"},
556                 {0, NULL, 0, NULL, NULL}
557         };
558
559         static EnumPropertyItem dupli_eval_mode_items[] = {
560                 {DAG_EVAL_VIEWPORT, "VIEWPORT", 0, "Viewport", "Generate duplis using viewport settings"},
561                 {DAG_EVAL_PREVIEW, "PREVIEW", 0, "Preview", "Generate duplis using preview settings"},
562                 {DAG_EVAL_RENDER, "RENDER", 0, "Render", "Generate duplis using render settings"},
563                 {0, NULL, 0, NULL, NULL}
564         };
565
566 #ifndef NDEBUG
567         static EnumPropertyItem mesh_dm_info_items[] = {
568                 {0, "SOURCE", 0, "Source", "Source mesh"},
569                 {1, "DEFORM", 0, "Deform", "Objects deform mesh"},
570                 {2, "FINAL", 0, "Final", "Objects final mesh"},
571                 {0, NULL, 0, NULL, NULL}
572         };
573 #endif
574
575         static EnumPropertyItem object_select_items[] = {
576             {0, "SELECT", 0, "Select", "Select object from the active render layer"},
577             {1, "DESELECT", 0, "Deselect", "Deselect object from the active render layer"},
578             {2, "TOGGLE", 0, "Toggle", "Toggle object selection from the active render layer"},
579             {0, NULL, 0, NULL, NULL}
580         };
581
582         /* Special wrapper to access the base selection value */
583         func = RNA_def_function(srna, "select_set", "rna_Object_select_set");
584         RNA_def_function_ui_description(func, "Select the object (for the active render layer)");
585         RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
586         parm = RNA_def_enum(func, "action", object_select_items, 0, "Action", "Select mode");
587         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
588
589         func = RNA_def_function(srna, "select_get", "rna_Object_select_get");
590         RNA_def_function_ui_description(func, "Get the object selection for the active render layer");
591         RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
592         parm = RNA_def_boolean(func, "result", 0, "", "Object selected");
593         RNA_def_function_return(func, parm);
594
595         func = RNA_def_function(srna, "visible_get", "rna_Object_visible_get");
596         RNA_def_function_ui_description(func, "Get the object visibility for the active render layer");
597         RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
598         parm = RNA_def_boolean(func, "result", 0, "", "Object visible");
599         RNA_def_function_return(func, parm);
600
601         /* Matrix space conversion */
602         func = RNA_def_function(srna, "convert_space", "rna_Scene_mat_convert_space");
603         RNA_def_function_ui_description(func, "Convert (transform) the given matrix from one space to another");
604         RNA_def_function_flag(func, FUNC_USE_REPORTS);
605         parm = RNA_def_pointer(func, "pose_bone", "PoseBone", "",
606                                "Bone to use to define spaces (may be None, in which case only the two 'WORLD' and "
607                                "'LOCAL' spaces are usable)");
608         parm = RNA_def_property(func, "matrix", PROP_FLOAT, PROP_MATRIX);
609         RNA_def_property_multi_array(parm, 2, rna_matrix_dimsize_4x4);
610         RNA_def_property_ui_text(parm, "", "The matrix to transform");
611         parm = RNA_def_property(func, "matrix_return", PROP_FLOAT, PROP_MATRIX);
612         RNA_def_property_multi_array(parm, 2, rna_matrix_dimsize_4x4);
613         RNA_def_property_ui_text(parm, "", "The transformed matrix");
614         RNA_def_function_output(func, parm);
615         parm = RNA_def_enum(func, "from_space", space_items, CONSTRAINT_SPACE_WORLD, "",
616                             "The space in which 'matrix' is currently");
617         parm = RNA_def_enum(func, "to_space", space_items, CONSTRAINT_SPACE_WORLD, "",
618                             "The space to which you want to transform 'matrix'");
619
620         /* Camera-related operations */
621         func = RNA_def_function(srna, "calc_matrix_camera", "rna_Object_calc_matrix_camera");
622         RNA_def_function_ui_description(func, "Generate the camera projection matrix of this object "
623                                               "(mostly useful for Camera and Lamp types)");
624         parm = RNA_def_property(func, "result", PROP_FLOAT, PROP_MATRIX);
625         RNA_def_property_multi_array(parm, 2, rna_matrix_dimsize_4x4);
626         RNA_def_property_ui_text(parm, "", "The camera projection matrix");
627         RNA_def_function_output(func, parm);
628         parm = RNA_def_int(func, "x", 1, 0, INT_MAX, "", "Width of the render area", 0, 10000);
629         parm = RNA_def_int(func, "y", 1, 0, INT_MAX, "", "Height of the render area", 0, 10000);
630         parm = RNA_def_float(func, "scale_x", 1.0f, 1.0e-6f, FLT_MAX, "", "Width scaling factor", 1.0e-2f, 100.0f);
631         parm = RNA_def_float(func, "scale_y", 1.0f, 1.0e-6f, FLT_MAX, "", "height scaling factor", 1.0e-2f, 100.0f);
632
633         func = RNA_def_function(srna, "camera_fit_coords", "rna_Object_camera_fit_coords");
634         RNA_def_function_ui_description(func, "Compute the coordinate (and scale for ortho cameras) "
635                                               "given object should be to 'see' all given coordinates");
636         parm = RNA_def_pointer(func, "scene", "Scene", "", "Scene to get render size information from, if available");
637         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
638         parm = RNA_def_float_array(func, "coordinates", 1, NULL, -FLT_MAX, FLT_MAX, "", "Coordinates to fit in",
639                                    -FLT_MAX, FLT_MAX);
640         RNA_def_parameter_flags(parm, PROP_NEVER_NULL | PROP_DYNAMIC, PARM_REQUIRED);
641         parm = RNA_def_property(func, "co_return", PROP_FLOAT, PROP_XYZ);
642         RNA_def_property_array(parm, 3);
643         RNA_def_property_ui_text(parm, "", "The location to aim to be able to see all given points");
644         RNA_def_parameter_flags(parm, 0, PARM_OUTPUT);
645         parm = RNA_def_property(func, "scale_return", PROP_FLOAT, PROP_NONE);
646         RNA_def_property_ui_text(parm, "", "The ortho scale to aim to be able to see all given points (if relevant)");
647         RNA_def_parameter_flags(parm, 0, PARM_OUTPUT);
648
649         /* mesh */
650         func = RNA_def_function(srna, "to_mesh", "rna_Object_to_mesh");
651         RNA_def_function_ui_description(func, "Create a Mesh data-block with modifiers applied");
652         RNA_def_function_flag(func, FUNC_USE_REPORTS | FUNC_USE_CONTEXT);
653         parm = RNA_def_pointer(func, "scene", "Scene", "", "Scene within which to evaluate modifiers");
654         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
655         parm = RNA_def_pointer(func, "scene_layer", "SceneLayer", "", "Scene layer within which to evaluate modifiers");
656         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
657         parm = RNA_def_boolean(func, "apply_modifiers", 0, "", "Apply modifiers");
658         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
659         parm = RNA_def_enum(func, "settings", mesh_type_items, 0, "", "Modifier settings to apply");
660         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
661         RNA_def_boolean(func, "calc_tessface", true, "Calculate Tessellation", "Calculate tessellation faces");
662         RNA_def_boolean(func, "calc_undeformed", false, "Calculate Undeformed", "Calculate undeformed vertex coordinates");
663         parm = RNA_def_pointer(func, "mesh", "Mesh", "",
664                                "Mesh created from object, remove it if it is only used for export");
665         RNA_def_function_return(func, parm);
666
667         /* duplis */
668         func = RNA_def_function(srna, "dupli_list_create", "rna_Object_create_duplilist");
669         RNA_def_function_ui_description(func, "Create a list of dupli objects for this object, needs to "
670                                         "be freed manually with free_dupli_list to restore the "
671                                         "objects real matrix and layers");
672         parm = RNA_def_pointer(func, "scene", "Scene", "", "Scene within which to evaluate duplis");
673         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
674         RNA_def_enum(func, "settings", dupli_eval_mode_items, 0, "", "Generate texture coordinates for rendering");
675         RNA_def_function_flag(func, FUNC_USE_REPORTS | FUNC_USE_CONTEXT);
676
677         func = RNA_def_function(srna, "dupli_list_clear", "rna_Object_free_duplilist");
678         RNA_def_function_ui_description(func, "Free the list of dupli objects");
679
680         /* Armature */
681         func = RNA_def_function(srna, "find_armature", "modifiers_isDeformedByArmature");
682         RNA_def_function_ui_description(func, "Find armature influencing this object as a parent or via a modifier");
683         parm = RNA_def_pointer(func, "ob_arm", "Object", "", "Armature object influencing this object or NULL");
684         RNA_def_function_return(func, parm);
685
686         /* Shape key */
687         func = RNA_def_function(srna, "shape_key_add", "rna_Object_shape_key_add");
688         RNA_def_function_ui_description(func, "Add shape key to this object");
689         RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
690         RNA_def_string(func, "name", "Key", 0, "", "Unique name for the new keyblock"); /* optional */
691         RNA_def_boolean(func, "from_mix", 1, "", "Create new shape from existing mix of shapes");
692         parm = RNA_def_pointer(func, "key", "ShapeKey", "", "New shape keyblock");
693         RNA_def_parameter_flags(parm, 0, PARM_RNAPTR);
694         RNA_def_function_return(func, parm);
695
696         func = RNA_def_function(srna, "shape_key_remove", "rna_Object_shape_key_remove");
697         RNA_def_function_ui_description(func, "Remove a Shape Key from this object");
698         RNA_def_function_flag(func, FUNC_USE_MAIN | FUNC_USE_REPORTS);
699         parm = RNA_def_pointer(func, "key", "ShapeKey", "", "Keyblock to be removed");
700         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
701         RNA_def_parameter_clear_flags(parm, PROP_THICK_WRAP, 0);
702
703         /* Ray Cast */
704         func = RNA_def_function(srna, "ray_cast", "rna_Object_ray_cast");
705         RNA_def_function_ui_description(func, "Cast a ray onto in object space");
706         RNA_def_function_flag(func, FUNC_USE_REPORTS);
707         
708         /* ray start and end */
709         parm = RNA_def_float_vector(func, "origin", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
710         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
711         parm = RNA_def_float_vector(func, "direction", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
712         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
713         RNA_def_float(func, "distance", BVH_RAYCAST_DIST_MAX, 0.0, BVH_RAYCAST_DIST_MAX,
714                       "", "Maximum distance", 0.0, BVH_RAYCAST_DIST_MAX);
715
716         /* return location and normal */
717         parm = RNA_def_boolean(func, "result", 0, "", "");
718         RNA_def_function_output(func, parm);
719         parm = RNA_def_float_vector(func, "location", 3, NULL, -FLT_MAX, FLT_MAX, "Location",
720                                     "The hit location of this ray cast", -1e4, 1e4);
721         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
722         RNA_def_function_output(func, parm);
723         parm = RNA_def_float_vector(func, "normal", 3, NULL, -FLT_MAX, FLT_MAX, "Normal",
724                                     "The face normal at the ray cast hit location", -1e4, 1e4);
725         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
726         RNA_def_function_output(func, parm);
727         parm = RNA_def_int(func, "index", 0, 0, 0, "", "The face index, -1 when original data isn't available", 0, 0);
728         RNA_def_function_output(func, parm);
729
730         /* Nearest Point */
731         func = RNA_def_function(srna, "closest_point_on_mesh", "rna_Object_closest_point_on_mesh");
732         RNA_def_function_ui_description(func, "Find the nearest point in object space");
733         RNA_def_function_flag(func, FUNC_USE_REPORTS);
734
735         /* location of point for test and max distance */
736         parm = RNA_def_float_vector(func, "origin", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
737         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
738         /* default is sqrt(FLT_MAX) */
739         RNA_def_float(func, "distance", 1.844674352395373e+19, 0.0, FLT_MAX, "", "Maximum distance", 0.0, FLT_MAX);
740
741         /* return location and normal */
742         parm = RNA_def_boolean(func, "result", 0, "", "");
743         RNA_def_function_output(func, parm);
744         parm = RNA_def_float_vector(func, "location", 3, NULL, -FLT_MAX, FLT_MAX, "Location",
745                                     "The location on the object closest to the point", -1e4, 1e4);
746         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
747         RNA_def_function_output(func, parm);
748         parm = RNA_def_float_vector(func, "normal", 3, NULL, -FLT_MAX, FLT_MAX, "Normal",
749                                     "The face normal at the closest point", -1e4, 1e4);
750         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0);
751         RNA_def_function_output(func, parm);
752
753         parm = RNA_def_int(func, "index", 0, 0, 0, "", "The face index, -1 when original data isn't available", 0, 0);
754         RNA_def_function_output(func, parm);
755
756         /* View */
757         func = RNA_def_function(srna, "is_visible", "rna_Object_is_visible");
758         RNA_def_function_ui_description(func, "Determine if object is visible in a given scene");
759         parm = RNA_def_pointer(func, "scene", "Scene", "", "");
760         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
761         parm = RNA_def_boolean(func, "result", 0, "", "Object visibility");
762         RNA_def_function_return(func, parm);
763
764         /* utility function for checking if the object is modified */
765         func = RNA_def_function(srna, "is_modified", "rna_Object_is_modified");
766         RNA_def_function_ui_description(func, "Determine if this object is modified from the base mesh data");
767         parm = RNA_def_pointer(func, "scene", "Scene", "", "");
768         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
769         parm = RNA_def_enum(func, "settings", mesh_type_items, 0, "", "Modifier settings to apply");
770         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
771         parm = RNA_def_boolean(func, "result", 0, "", "Object visibility");
772         RNA_def_function_return(func, parm);
773
774         func = RNA_def_function(srna, "is_deform_modified", "rna_Object_is_deform_modified");
775         RNA_def_function_ui_description(func, "Determine if this object is modified by a deformation from the base mesh data");
776         parm = RNA_def_pointer(func, "scene", "Scene", "", "");
777         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
778         parm = RNA_def_enum(func, "settings", mesh_type_items, 0, "", "Modifier settings to apply");
779         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
780         parm = RNA_def_boolean(func, "result", 0, "", "Object visibility");
781         RNA_def_function_return(func, parm);
782
783 #ifndef NDEBUG
784         /* mesh */
785         func = RNA_def_function(srna, "dm_info", "rna_Object_dm_info");
786         RNA_def_function_ui_description(func, "Returns a string for derived mesh data");
787
788         parm = RNA_def_enum(func, "type", mesh_dm_info_items, 0, "", "Modifier settings to apply");
789         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
790         /* weak!, no way to return dynamic string type */
791         parm = RNA_def_string(func, "result", NULL, 16384, "result", "");
792         RNA_def_parameter_flags(parm, PROP_THICK_WRAP, 0); /* needed for string return value */
793         RNA_def_function_output(func, parm);
794 #endif /* NDEBUG */
795
796         func = RNA_def_function(srna, "update_from_editmode", "rna_Object_update_from_editmode");
797         RNA_def_function_ui_description(func, "Load the objects edit-mode data into the object data");
798         parm = RNA_def_boolean(func, "result", 0, "", "Success");
799         RNA_def_function_return(func, parm);
800
801         func = RNA_def_function(srna, "cache_release", "BKE_object_free_caches");
802         RNA_def_function_ui_description(func, "Release memory used by caches associated with this object. Intended to be used by render engines only");
803 }
804
805
806 void RNA_api_object_base_legacy(StructRNA *srna)
807 {
808         FunctionRNA *func;
809         PropertyRNA *parm;
810
811         func = RNA_def_function(srna, "layers_from_view", "rna_ObjectBaseLegacy_layers_from_view");
812         RNA_def_function_ui_description(func,
813                                         "Sets the object layers from a 3D View (use when adding an object in local view)");
814         parm = RNA_def_pointer(func, "view", "SpaceView3D", "", "");
815         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED);
816 }
817
818 #endif /* RNA_RUNTIME */