spaces -> tabs, (4 spaces == 1 tab, only for white space preceding text)
[blender.git] / source / blender / makesrna / intern / rna_object_api.c
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2009 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #include <stdlib.h>
30 #include <stdio.h>
31 #include <string.h>
32 #include <time.h>
33
34 #include "RNA_define.h"
35 #include "RNA_types.h"
36
37 #include "DNA_object_types.h"
38
39 #include "BLO_sys_types.h" /* needed for intptr_t used in ED_mesh.h */
40
41 #include "ED_mesh.h"
42
43 #ifdef RNA_RUNTIME
44
45 #include "BKE_main.h"
46 #include "BKE_global.h"
47 #include "BKE_context.h"
48 #include "BKE_report.h"
49 #include "BKE_object.h"
50 #include "BKE_mesh.h"
51 #include "BKE_DerivedMesh.h"
52 #include "BKE_bvhutils.h"
53
54 #include "BKE_customdata.h"
55 #include "BKE_anim.h"
56 #include "BKE_depsgraph.h"
57 #include "BKE_displist.h"
58 #include "BKE_font.h"
59 #include "BKE_mball.h"
60
61 #include "BLI_math.h"
62
63 #include "DNA_mesh_types.h"
64 #include "DNA_scene_types.h"
65 #include "DNA_meshdata_types.h"
66 #include "DNA_curve_types.h"
67 #include "DNA_modifier_types.h"
68 #include "DNA_constraint_types.h"
69
70 #include "MEM_guardedalloc.h"
71
72 /* copied from Mesh_getFromObject and adapted to RNA interface */
73 /* settings: 0 - preview, 1 - render */
74 static Mesh *rna_Object_create_mesh(Object *ob, bContext *C, ReportList *reports, int apply_modifiers, int settings)
75 {
76         Mesh *tmpmesh;
77         Curve *tmpcu = NULL;
78         Object *tmpobj = NULL;
79         int render = settings, i;
80         int cage = !apply_modifiers;
81         Scene *sce = CTX_data_scene(C);
82
83         /* perform the mesh extraction based on type */
84          switch (ob->type) {
85          case OB_FONT:
86          case OB_CURVE:
87          case OB_SURF:
88
89                 /* copies object and modifiers (but not the data) */
90                 tmpobj= copy_object(ob);
91                 tmpcu = (Curve *)tmpobj->data;
92                 tmpcu->id.us--;
93
94                 /* if getting the original caged mesh, delete object modifiers */
95                 if( cage )
96                         object_free_modifiers(tmpobj);
97
98                 /* copies the data */
99                 tmpobj->data = copy_curve( (Curve *) ob->data );
100
101 #if 0
102                 /* copy_curve() sets disp.first null, so currently not need */
103                 {
104                         Curve *cu;
105                         cu = (Curve *)tmpobj->data;
106                         if( cu->disp.first )
107                                 MEM_freeN( cu->disp.first );
108                         cu->disp.first = NULL;
109                 }
110         
111 #endif
112
113                 /* get updated display list, and convert to a mesh */
114                 makeDispListCurveTypes( sce, tmpobj, 0 );
115                 nurbs_to_mesh( tmpobj );
116                 
117                 /* nurbs_to_mesh changes the type to a mesh, check it worked */
118                 if (tmpobj->type != OB_MESH) {
119                         free_libblock_us( &(CTX_data_main(C)->object), tmpobj );
120                         BKE_report(reports, RPT_ERROR, "cant convert curve to mesh. Does the curve have any segments?");
121                         return NULL;
122                 }
123                 tmpmesh = tmpobj->data;
124                 free_libblock_us( &G.main->object, tmpobj );
125                 break;
126
127          case OB_MBALL:
128                 /* metaballs don't have modifiers, so just convert to mesh */
129                 ob = find_basis_mball( sce, ob );
130                 /* todo, re-generatre for render-res */
131                 /* metaball_polygonize(scene, ob) */
132
133                 tmpmesh = add_mesh("Mesh");
134                 mball_to_mesh( &ob->disp, tmpmesh );
135                  break;
136
137          case OB_MESH:
138                 /* copies object and modifiers (but not the data) */
139                 if (cage) {
140                         /* copies the data */
141                         tmpmesh = copy_mesh( ob->data );
142                 /* if not getting the original caged mesh, get final derived mesh */
143                 } else {
144                         /* Make a dummy mesh, saves copying */
145                         DerivedMesh *dm;
146                         /* CustomDataMask mask = CD_MASK_BAREMESH|CD_MASK_MTFACE|CD_MASK_MCOL; */
147                         CustomDataMask mask = CD_MASK_MESH; /* this seems more suitable, exporter,
148                                                                                                    for example, needs CD_MASK_MDEFORMVERT */
149                         
150                         /* Write the display mesh into the dummy mesh */
151                         if (render)
152                                 dm = mesh_create_derived_render( sce, ob, mask );
153                         else
154                                 dm = mesh_create_derived_view( sce, ob, mask );
155                         
156                         tmpmesh = add_mesh( "Mesh" );
157                         DM_to_mesh( dm, tmpmesh );
158                         dm->release( dm );
159                 }
160                 
161                 break;
162          default:
163                 BKE_report(reports, RPT_ERROR, "Object does not have geometry data");
164                  return NULL;
165           }
166
167         /* Copy materials to new mesh */
168         switch (ob->type) {
169         case OB_SURF:
170                 tmpmesh->totcol = tmpcu->totcol;                
171                 
172                 /* free old material list (if it exists) and adjust user counts */
173                 if( tmpcu->mat ) {
174                         for( i = tmpcu->totcol; i-- > 0; ) {
175                                 /* are we an object material or data based? */
176                                 if (ob->colbits & 1<<i) 
177                                         tmpmesh->mat[i] = ob->mat[i];
178                                 else 
179                                         tmpmesh->mat[i] = tmpcu->mat[i];
180
181                                 if (tmpmesh->mat[i]) 
182                                         tmpmesh->mat[i]->id.us++;
183                         }
184                 }
185                 break;
186
187 #if 0
188         /* Crashes when assigning the new material, not sure why */
189         case OB_MBALL:
190                 tmpmb = (MetaBall *)ob->data;
191                 tmpmesh->totcol = tmpmb->totcol;
192                 
193                 /* free old material list (if it exists) and adjust user counts */
194                 if( tmpmb->mat ) {
195                         for( i = tmpmb->totcol; i-- > 0; ) {
196                                 tmpmesh->mat[i] = tmpmb->mat[i]; /* CRASH HERE ??? */
197                                 if (tmpmesh->mat[i]) {
198                                         tmpmb->mat[i]->id.us++;
199                                 }
200                         }
201                 }
202                 break;
203 #endif
204
205         case OB_MESH:
206                 if (!cage) {
207                         Mesh *origmesh= ob->data;
208                         tmpmesh->flag= origmesh->flag;
209                         tmpmesh->mat = MEM_dupallocN(origmesh->mat);
210                         tmpmesh->totcol = origmesh->totcol;
211                         tmpmesh->smoothresh= origmesh->smoothresh;
212                         if( origmesh->mat ) {
213                                 for( i = origmesh->totcol; i-- > 0; ) {
214                                         /* are we an object material or data based? */
215                                         if (ob->colbits & 1<<i)
216                                                 tmpmesh->mat[i] = ob->mat[i];
217                                         else
218                                                 tmpmesh->mat[i] = origmesh->mat[i];
219                                         if (tmpmesh->mat[i])
220                                                 tmpmesh->mat[i]->id.us++;
221                                 }
222                         }
223                 }
224                 break;
225         } /* end copy materials */
226
227         /* we don't assign it to anything */
228         tmpmesh->id.us--;
229         
230         /* make sure materials get updated in objects */
231         test_object_materials( ( ID * ) tmpmesh );
232
233         return tmpmesh;
234 }
235
236 /* When no longer needed, duplilist should be freed with Object.free_duplilist */
237 static void rna_Object_create_duplilist(Object *ob, bContext *C, ReportList *reports)
238 {
239         if (!(ob->transflag & OB_DUPLI)) {
240                 BKE_report(reports, RPT_ERROR, "Object does not have duplis.");
241                 return;
242         }
243
244         /* free duplilist if a user forgets to */
245         if (ob->duplilist) {
246                 BKE_reportf(reports, RPT_WARNING, "Object.dupli_list has not been freed.");
247
248                 free_object_duplilist(ob->duplilist);
249                 ob->duplilist= NULL;
250         }
251
252         ob->duplilist= object_duplilist(CTX_data_scene(C), ob);
253
254         /* ob->duplilist should now be freed with Object.free_duplilist */
255 }
256
257 static void rna_Object_free_duplilist(Object *ob, ReportList *reports)
258 {
259         if (ob->duplilist) {
260                 free_object_duplilist(ob->duplilist);
261                 ob->duplilist= NULL;
262         }
263 }
264
265 static bDeformGroup *rna_Object_add_vertex_group(Object *ob, char *group_name)
266 {
267         return ED_vgroup_add_name(ob, group_name);
268 }
269
270 static void rna_Object_add_vertex_to_group(Object *ob, int vertex_index, bDeformGroup *def, float weight, int assignmode)
271 {
272         /* creates dverts if needed */
273         ED_vgroup_vert_add(ob, def, vertex_index, weight, assignmode);
274 }
275
276 /* copied from old API Object.makeDisplayList (Object.c) */
277 static void rna_Object_make_display_list(Object *ob, bContext *C)
278 {
279         Scene *sce= CTX_data_scene(C);
280
281         if (ob->type == OB_FONT) {
282                 Curve *cu = ob->data;
283                 freedisplist(&cu->disp);
284                 BKE_text_to_curve(sce, ob, CU_LEFT);
285         }
286
287         DAG_id_flush_update(&ob->id, OB_RECALC_DATA);
288 }
289
290 static Object *rna_Object_find_armature(Object *ob)
291 {
292         Object *ob_arm = NULL;
293
294         if (ob->type != OB_MESH) return NULL;
295
296         if (ob->parent && ob->partype == PARSKEL && ob->parent->type == OB_ARMATURE) {
297                 ob_arm = ob->parent;
298         }
299         else {
300                 ModifierData *mod = (ModifierData*)ob->modifiers.first;
301                 while (mod) {
302                         if (mod->type == eModifierType_Armature) {
303                                 ob_arm = ((ArmatureModifierData*)mod)->object;
304                         }
305
306                         mod = mod->next;
307                 }
308         }
309
310         return ob_arm;
311 }
312
313 static PointerRNA rna_Object_add_shape_key(Object *ob, bContext *C, ReportList *reports, char *name, int from_mix)
314 {
315         Scene *scene= CTX_data_scene(C);
316         KeyBlock *kb= NULL;
317
318         if((kb=object_insert_shape_key(scene, ob, name, from_mix))) {
319                 PointerRNA keyptr;
320
321                 RNA_pointer_create((ID *)ob->data, &RNA_ShapeKey, kb, &keyptr);
322                 WM_event_add_notifier(C, NC_OBJECT|ND_DRAW, ob);
323                 
324                 return keyptr;
325         }
326         else {
327                 BKE_reportf(reports, RPT_ERROR, "Object \"%s\"does not support shapes.", ob->id.name+2);
328                 return PointerRNA_NULL;
329         }
330 }
331
332 int rna_Object_is_visible(Object *ob, bContext *C)
333 {
334         return !(ob->restrictflag & OB_RESTRICT_VIEW) && ob->lay & CTX_data_scene(C)->lay;
335 }
336
337 /*
338 static void rna_Mesh_assign_verts_to_group(Object *ob, bDeformGroup *group, int *indices, int totindex, float weight, int assignmode)
339 {
340         if (ob->type != OB_MESH) {
341                 BKE_report(reports, RPT_ERROR, "Object should be of MESH type.");
342                 return;
343         }
344
345         Mesh *me = (Mesh*)ob->data;
346         int group_index = defgroup_find_index(ob, group);
347         if (group_index == -1) {
348                 BKE_report(reports, RPT_ERROR, "No deform groups assigned to mesh.");
349                 return;
350         }
351
352         if (assignmode != WEIGHT_REPLACE && assignmode != WEIGHT_ADD && assignmode != WEIGHT_SUBTRACT) {
353                 BKE_report(reports, RPT_ERROR, "Bad assignment mode." );
354                 return;
355         }
356
357         // makes a set of dVerts corresponding to the mVerts
358         if (!me->dvert) 
359                 create_dverts(&me->id);
360
361         // loop list adding verts to group 
362         for (i= 0; i < totindex; i++) {
363                 if(i < 0 || i >= me->totvert) {
364                         BKE_report(reports, RPT_ERROR, "Bad vertex index in list.");
365                         return;
366                 }
367
368                 add_vert_defnr(ob, group_index, i, weight, assignmode);
369         }
370 }
371 */
372
373 void rna_Object_ray_cast(Object *ob, ReportList *reports, float ray_start[3], float ray_end[3], float r_location[3], float r_normal[3], int *index)
374 {
375         BVHTreeFromMesh treeData;
376         
377         if(ob->derivedFinal==NULL) {
378                 BKE_reportf(reports, RPT_ERROR, "object \"%s\" has no mesh data to be used for ray casting.", ob->id.name+2);
379                 return;
380         }
381
382         /* no need to managing allocation or freeing of the BVH data. this is generated and freed as needed */
383         bvhtree_from_mesh_faces(&treeData, ob->derivedFinal, 0.0f, 4, 6);
384
385         if(treeData.tree==NULL) {
386                 BKE_reportf(reports, RPT_ERROR, "object \"%s\" could not create internal data for ray casting.", ob->id.name+2);
387                 return;
388         }
389         else {
390                 BVHTreeRayHit hit;
391                 float ray_nor[3], dist;
392                 sub_v3_v3v3(ray_nor, ray_end, ray_start);
393
394                 dist= hit.dist = normalize_v3(ray_nor);
395                 hit.index = -1;
396                 
397                 if(BLI_bvhtree_ray_cast(treeData.tree, ray_start, ray_nor, 0.0f, &hit, treeData.raycast_callback, &treeData) != -1) {
398                         if(hit.dist<=dist) {
399                                 copy_v3_v3(r_location, hit.co);
400                                 copy_v3_v3(r_normal, hit.no);
401                                 *index= hit.index;
402                                 return;
403                         }
404                 }
405         }
406
407         zero_v3(r_location);
408         zero_v3(r_normal);
409         *index= -1;
410 }
411
412 #else
413
414 void RNA_api_object(StructRNA *srna)
415 {
416         FunctionRNA *func;
417         PropertyRNA *parm;
418
419         static EnumPropertyItem mesh_type_items[] = {
420                 {0, "PREVIEW", 0, "Preview", "Apply modifier preview settings"},
421                 {1, "RENDER", 0, "Render", "Apply modifier render settings"},
422                 {0, NULL, 0, NULL, NULL}
423         };
424
425         static EnumPropertyItem assign_mode_items[] = {
426                 {WEIGHT_REPLACE, "REPLACE", 0, "Replace", "Replace"}, /* TODO: more meaningful descriptions */
427                 {WEIGHT_ADD, "ADD", 0, "Add", "Add"},
428                 {WEIGHT_SUBTRACT, "SUBTRACT", 0, "Subtract", "Subtract"},
429                 {0, NULL, 0, NULL, NULL}
430         };
431
432         /* mesh */
433         func= RNA_def_function(srna, "create_mesh", "rna_Object_create_mesh");
434         RNA_def_function_ui_description(func, "Create a Mesh datablock with modifiers applied.");
435         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
436         parm= RNA_def_boolean(func, "apply_modifiers", 0, "", "Apply modifiers.");
437         RNA_def_property_flag(parm, PROP_REQUIRED);
438         parm= RNA_def_enum(func, "settings", mesh_type_items, 0, "", "Modifier settings to apply.");
439         RNA_def_property_flag(parm, PROP_REQUIRED);
440         parm= RNA_def_pointer(func, "mesh", "Mesh", "", "Mesh created from object, remove it if it is only used for export.");
441         RNA_def_function_return(func, parm);
442
443         /* duplis */
444         func= RNA_def_function(srna, "create_dupli_list", "rna_Object_create_duplilist");
445         RNA_def_function_ui_description(func, "Create a list of dupli objects for this object, needs to be freed manually with free_dupli_list.");
446         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
447
448         func= RNA_def_function(srna, "free_dupli_list", "rna_Object_free_duplilist");
449         RNA_def_function_ui_description(func, "Free the list of dupli objects.");
450         RNA_def_function_flag(func, FUNC_USE_REPORTS);
451
452         /* vertex groups */
453         func= RNA_def_function(srna, "add_vertex_group", "rna_Object_add_vertex_group");
454         RNA_def_function_ui_description(func, "Add vertex group to object.");
455         parm= RNA_def_string(func, "name", "Group", 0, "", "Vertex group name."); /* optional */
456         parm= RNA_def_pointer(func, "group", "VertexGroup", "", "New vertex group.");
457         RNA_def_function_return(func, parm);
458
459         func= RNA_def_function(srna, "add_vertex_to_group", "rna_Object_add_vertex_to_group");
460         RNA_def_function_ui_description(func, "Add vertex to a vertex group.");
461         parm= RNA_def_int(func, "vertex_index", 0, 0, 0, "", "Vertex index.", 0, 0);
462         RNA_def_property_flag(parm, PROP_REQUIRED);
463         parm= RNA_def_pointer(func, "group", "VertexGroup", "", "Vertex group to add vertex to.");
464         RNA_def_property_flag(parm, PROP_REQUIRED);
465         parm= RNA_def_float(func, "weight", 0, 0.0f, 1.0f, "", "Vertex weight.", 0.0f, 1.0f);
466         RNA_def_property_flag(parm, PROP_REQUIRED);
467         parm= RNA_def_enum(func, "type", assign_mode_items, 0, "", "Vertex assign mode.");
468         RNA_def_property_flag(parm, PROP_REQUIRED);
469
470         /* Armature */
471         func= RNA_def_function(srna, "find_armature", "rna_Object_find_armature");
472         RNA_def_function_ui_description(func, "Find armature influencing this object as a parent or via a modifier.");
473         parm= RNA_def_pointer(func, "ob_arm", "Object", "", "Armature object influencing this object or NULL.");
474         RNA_def_function_return(func, parm);
475
476         /* Shape key */
477         func= RNA_def_function(srna, "add_shape_key", "rna_Object_add_shape_key");
478         RNA_def_function_ui_description(func, "Add shape key to an object.");
479         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
480         parm= RNA_def_string(func, "name", "Key", 0, "", "Unique name for the new keylock."); /* optional */
481         parm= RNA_def_boolean(func, "from_mix", 1, "", "Create new shape from existing mix of shapes.");
482         parm= RNA_def_pointer(func, "key", "ShapeKey", "", "New shape keyblock.");
483         RNA_def_property_flag(parm, PROP_RNAPTR);
484         RNA_def_function_return(func, parm);
485
486         /* Ray Cast */
487         func= RNA_def_function(srna, "ray_cast", "rna_Object_ray_cast");
488         RNA_def_function_ui_description(func, "Cast a ray onto in object space.");
489         RNA_def_function_flag(func, FUNC_USE_REPORTS);
490         
491         /* ray start and end */
492         parm= RNA_def_float_vector(func, "start", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
493         RNA_def_property_flag(parm, PROP_REQUIRED);
494         parm= RNA_def_float_vector(func, "end", 3, NULL, -FLT_MAX, FLT_MAX, "", "", -1e4, 1e4);
495         RNA_def_property_flag(parm, PROP_REQUIRED);
496
497         /* return location and normal */
498         parm= RNA_def_float_vector(func, "location", 3, NULL, -FLT_MAX, FLT_MAX, "Location", "The hit location of this ray cast", -1e4, 1e4);
499         RNA_def_property_flag(parm, PROP_THICK_WRAP);
500         RNA_def_function_output(func, parm);
501         parm= RNA_def_float_vector(func, "normal", 3, NULL, -FLT_MAX, FLT_MAX, "Normal", "The face normal at the ray cast hit location", -1e4, 1e4);
502         RNA_def_property_flag(parm, PROP_THICK_WRAP);
503         RNA_def_function_output(func, parm);
504         
505         parm= RNA_def_int(func, "index", 0, 0, 0, "", "The face index, -1 when no intersection is found.", 0, 0);
506         RNA_def_function_output(func, parm);
507
508         
509         /* DAG */
510         func= RNA_def_function(srna, "make_display_list", "rna_Object_make_display_list");
511         RNA_def_function_ui_description(func, "Update object's display data."); /* XXX describe better */
512         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
513
514         /* View */
515         func= RNA_def_function(srna, "is_visible", "rna_Object_is_visible");
516         RNA_def_function_ui_description(func, "Determine if object is visible in active scene.");
517         RNA_def_function_flag(func, FUNC_USE_CONTEXT);
518         parm= RNA_def_boolean(func, "is_visible", 0, "", "Object visibility.");
519         RNA_def_function_return(func, parm);
520 }
521
522 #endif
523