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