2 * ***** BEGIN GPL LICENSE BLOCK *****
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.
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.
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.
18 * Contributor(s): Blender Foundation (2008).
20 * ***** END GPL LICENSE BLOCK *****
23 /** \file blender/makesrna/intern/rna_object.c
30 #include "DNA_action_types.h"
31 #include "DNA_customdata_types.h"
32 #include "DNA_controller_types.h"
33 #include "DNA_group_types.h"
34 #include "DNA_material_types.h"
35 #include "DNA_mesh_types.h"
36 #include "DNA_object_force.h"
37 #include "DNA_object_types.h"
38 #include "DNA_property_types.h"
39 #include "DNA_scene_types.h"
40 #include "DNA_meta_types.h"
42 #include "BLI_utildefines.h"
43 #include "BLI_listbase.h"
45 #include "BKE_paint.h"
46 #include "BKE_editmesh.h"
47 #include "BKE_group.h" /* needed for BKE_group_object_exists() */
48 #include "BKE_object.h" /* Needed for BKE_object_matrix_local_get() */
49 #include "RNA_access.h"
50 #include "RNA_define.h"
51 #include "RNA_enum_types.h"
53 #include "rna_internal.h"
55 #include "BLI_sys_types.h" /* needed for intptr_t used in ED_mesh.h */
61 EnumPropertyItem object_mode_items[] = {
62 {OB_MODE_OBJECT, "OBJECT", ICON_OBJECT_DATAMODE, "Object Mode", ""},
63 {OB_MODE_EDIT, "EDIT", ICON_EDITMODE_HLT, "Edit Mode", ""},
64 {OB_MODE_POSE, "POSE", ICON_POSE_HLT, "Pose Mode", ""},
65 {OB_MODE_SCULPT, "SCULPT", ICON_SCULPTMODE_HLT, "Sculpt Mode", ""},
66 {OB_MODE_VERTEX_PAINT, "VERTEX_PAINT", ICON_VPAINT_HLT, "Vertex Paint", ""},
67 {OB_MODE_WEIGHT_PAINT, "WEIGHT_PAINT", ICON_WPAINT_HLT, "Weight Paint", ""},
68 {OB_MODE_TEXTURE_PAINT, "TEXTURE_PAINT", ICON_TPAINT_HLT, "Texture Paint", ""},
69 {OB_MODE_PARTICLE_EDIT, "PARTICLE_EDIT", ICON_PARTICLEMODE, "Particle Edit", ""},
70 {0, NULL, 0, NULL, NULL}
73 EnumPropertyItem object_empty_drawtype_items[] = {
74 {OB_PLAINAXES, "PLAIN_AXES", 0, "Plain Axes", ""},
75 {OB_ARROWS, "ARROWS", 0, "Arrows", ""},
76 {OB_SINGLE_ARROW, "SINGLE_ARROW", 0, "Single Arrow", ""},
77 {OB_CIRCLE, "CIRCLE", 0, "Circle", ""},
78 {OB_CUBE, "CUBE", 0, "Cube", ""},
79 {OB_EMPTY_SPHERE, "SPHERE", 0, "Sphere", ""},
80 {OB_EMPTY_CONE, "CONE", 0, "Cone", ""},
81 {OB_EMPTY_IMAGE, "IMAGE", 0, "Image", ""},
82 {0, NULL, 0, NULL, NULL}
86 static EnumPropertyItem parent_type_items[] = {
87 {PAROBJECT, "OBJECT", 0, "Object", "The object is parented to an object"},
88 {PARCURVE, "CURVE", 0, "Curve", "The object is parented to a curve"},
89 {PARKEY, "KEY", 0, "Key", ""},
90 {PARSKEL, "ARMATURE", 0, "Armature", ""},
91 {PARSKEL, "LATTICE", 0, "Lattice", "The object is parented to a lattice"}, /* PARSKEL reuse will give issues */
92 {PARVERT1, "VERTEX", 0, "Vertex", "The object is parented to a vertex"},
93 {PARVERT3, "VERTEX_3", 0, "3 Vertices", ""},
94 {PARBONE, "BONE", 0, "Bone", "The object is parented to a bone"},
95 {0, NULL, 0, NULL, NULL}
99 static EnumPropertyItem dupli_items[] = {
100 {0, "NONE", 0, "None", ""},
101 {OB_DUPLIFRAMES, "FRAMES", 0, "Frames", "Make copy of object for every frame"},
102 {OB_DUPLIVERTS, "VERTS", 0, "Verts", "Duplicate child objects on all vertices"},
103 {OB_DUPLIFACES, "FACES", 0, "Faces", "Duplicate child objects on all faces"},
104 {OB_DUPLIGROUP, "GROUP", 0, "Group", "Enable group instancing"},
105 {0, NULL, 0, NULL, NULL}
109 static EnumPropertyItem collision_bounds_items[] = {
110 {OB_BOUND_BOX, "BOX", 0, "Box", ""},
111 {OB_BOUND_SPHERE, "SPHERE", 0, "Sphere", ""},
112 {OB_BOUND_CYLINDER, "CYLINDER", 0, "Cylinder", ""},
113 {OB_BOUND_CONE, "CONE", 0, "Cone", ""},
114 {OB_BOUND_CONVEX_HULL, "CONVEX_HULL", 0, "Convex Hull", ""},
115 {OB_BOUND_TRIANGLE_MESH, "TRIANGLE_MESH", 0, "Triangle Mesh", ""},
116 {OB_BOUND_CAPSULE, "CAPSULE", 0, "Capsule", ""},
117 /*{OB_DYN_MESH, "DYNAMIC_MESH", 0, "Dynamic Mesh", ""}, */
118 {0, NULL, 0, NULL, NULL}
121 EnumPropertyItem metaelem_type_items[] = {
122 {MB_BALL, "BALL", ICON_META_BALL, "Ball", ""},
123 {MB_TUBE, "CAPSULE", ICON_META_CAPSULE, "Capsule", ""},
124 {MB_PLANE, "PLANE", ICON_META_PLANE, "Plane", ""},
125 {MB_ELIPSOID, "ELLIPSOID", ICON_META_ELLIPSOID, "Ellipsoid", ""}, /* NOTE: typo at original definition! */
126 {MB_CUBE, "CUBE", ICON_META_CUBE, "Cube", ""},
127 {0, NULL, 0, NULL, NULL}
130 /* used for 2 enums */
131 #define OBTYPE_CU_CURVE {OB_CURVE, "CURVE", 0, "Curve", ""}
132 #define OBTYPE_CU_SURF {OB_SURF, "SURFACE", 0, "Surface", ""}
133 #define OBTYPE_CU_FONT {OB_FONT, "FONT", 0, "Font", ""}
135 EnumPropertyItem object_type_items[] = {
136 {OB_MESH, "MESH", 0, "Mesh", ""},
139 {OB_MBALL, "META", 0, "Meta", ""},
141 {0, "", 0, NULL, NULL},
142 {OB_ARMATURE, "ARMATURE", 0, "Armature", ""},
143 {OB_LATTICE, "LATTICE", 0, "Lattice", ""},
144 {OB_EMPTY, "EMPTY", 0, "Empty", ""},
145 {0, "", 0, NULL, NULL},
146 {OB_CAMERA, "CAMERA", 0, "Camera", ""},
147 {OB_LAMP, "LAMP", 0, "Lamp", ""},
148 {OB_SPEAKER, "SPEAKER", 0, "Speaker", ""},
149 {0, NULL, 0, NULL, NULL}
152 EnumPropertyItem object_type_curve_items[] = {
156 {0, NULL, 0, NULL, NULL}
159 EnumPropertyItem object_axis_items[] = {
160 {OB_POSX, "POS_X", 0, "+X", ""},
161 {OB_POSY, "POS_Y", 0, "+Y", ""},
162 {OB_POSZ, "POS_Z", 0, "+Z", ""},
163 {OB_NEGX, "NEG_X", 0, "-X", ""},
164 {OB_NEGY, "NEG_Y", 0, "-Y", ""},
165 {OB_NEGZ, "NEG_Z", 0, "-Z", ""},
166 {0, NULL, 0, NULL, NULL}
169 /* for general use (not just object) */
170 EnumPropertyItem object_axis_unsigned_items[] = {
171 {0, "X", 0, "X", ""},
172 {1, "Y", 0, "Y", ""},
173 {2, "Z", 0, "Z", ""},
174 {0, NULL, 0, NULL, NULL}
179 #include "BLI_math.h"
181 #include "DNA_key_types.h"
182 #include "DNA_constraint_types.h"
183 #include "DNA_lattice_types.h"
184 #include "DNA_node_types.h"
186 #include "BKE_armature.h"
187 #include "BKE_bullet.h"
188 #include "BKE_constraint.h"
189 #include "BKE_context.h"
190 #include "BKE_curve.h"
191 #include "BKE_depsgraph.h"
192 #include "BKE_effect.h"
193 #include "BKE_global.h"
195 #include "BKE_object.h"
196 #include "BKE_material.h"
197 #include "BKE_mesh.h"
198 #include "BKE_particle.h"
199 #include "BKE_scene.h"
200 #include "BKE_deform.h"
203 #include "ED_object.h"
204 #include "ED_particle.h"
205 #include "ED_curve.h"
206 #include "ED_lattice.h"
208 static void rna_Object_internal_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
210 DAG_id_tag_update(ptr->id.data, OB_RECALC_OB);
213 static void rna_Object_matrix_world_update(Main *bmain, Scene *scene, PointerRNA *ptr)
215 /* don't use compat so we get predictable rotation */
216 BKE_object_apply_mat4(ptr->id.data, ((Object *)ptr->id.data)->obmat, false, true);
217 rna_Object_internal_update(bmain, scene, ptr);
220 static void rna_Object_hide_update(Main *bmain, Scene *UNUSED(scene), PointerRNA *UNUSED(ptr))
222 DAG_id_type_tag(bmain, ID_OB);
225 static void rna_Object_matrix_local_get(PointerRNA *ptr, float values[16])
227 Object *ob = ptr->id.data;
228 BKE_object_matrix_local_get(ob, (float(*)[4])values);
231 static void rna_Object_matrix_local_set(PointerRNA *ptr, const float values[16])
233 Object *ob = ptr->id.data;
235 /* localspace matrix is truly relative to the parent, but parameters
236 * stored in object are relative to parentinv matrix. Undo the parent
237 * inverse part before updating obmat and calling apply_obmat() */
240 invert_m4_m4(invmat, ob->parentinv);
241 mul_m4_m4m4(ob->obmat, invmat, (float(*)[4])values);
244 copy_m4_m4(ob->obmat, (float(*)[4])values);
247 /* don't use compat so we get predictable rotation */
248 BKE_object_apply_mat4(ob, ob->obmat, false, false);
251 static void rna_Object_matrix_basis_get(PointerRNA *ptr, float values[16])
253 Object *ob = ptr->id.data;
254 BKE_object_to_mat4(ob, (float(*)[4])values);
257 static void rna_Object_matrix_basis_set(PointerRNA *ptr, const float values[16])
259 Object *ob = ptr->id.data;
260 BKE_object_apply_mat4(ob, (float(*)[4])values, false, false);
263 void rna_Object_internal_update_data(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
265 DAG_id_tag_update(ptr->id.data, OB_RECALC_DATA);
266 WM_main_add_notifier(NC_OBJECT | ND_DRAW, ptr->id.data);
269 static void rna_Object_active_shape_update(Main *bmain, Scene *scene, PointerRNA *ptr)
271 Object *ob = ptr->id.data;
273 if (scene->obedit == ob) {
274 /* exit/enter editmode to get new shape */
278 EDBM_mesh_make(scene->toolsettings, ob);
279 EDBM_mesh_normals_update(((Mesh *)ob->data)->edit_btmesh);
280 BKE_editmesh_tessface_calc(((Mesh *)ob->data)->edit_btmesh);
294 rna_Object_internal_update_data(bmain, scene, ptr);
297 static void rna_Object_dependency_update(Main *bmain, Scene *UNUSED(scene), PointerRNA *ptr)
299 DAG_id_tag_update(ptr->id.data, OB_RECALC_OB);
300 DAG_relations_tag_update(bmain);
301 WM_main_add_notifier(NC_OBJECT | ND_PARENT, ptr->id.data);
304 /* when changing the selection flag the scene needs updating */
305 static void rna_Object_select_update(Main *UNUSED(bmain), Scene *scene, PointerRNA *ptr)
308 Object *ob = (Object *)ptr->id.data;
309 short mode = ob->flag & SELECT ? BA_SELECT : BA_DESELECT;
310 ED_base_object_select(BKE_scene_base_find(scene, ob), mode);
314 static void rna_Base_select_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
316 Base *base = (Base *)ptr->data;
317 short mode = base->flag & BA_SELECT ? BA_SELECT : BA_DESELECT;
318 ED_base_object_select(base, mode);
321 static void rna_Object_layer_update__internal(Main *bmain, Scene *scene, Base *base, Object *ob)
323 /* try to avoid scene sort */
325 /* pass - unlikely but when running scripts on startup it happens */
327 else if ((ob->lay & scene->lay) && (base->lay & scene->lay)) {
330 else if ((ob->lay & scene->lay) == 0 && (base->lay & scene->lay) == 0) {
334 DAG_relations_tag_update(bmain);
337 DAG_id_type_tag(bmain, ID_OB);
340 static void rna_Object_layer_update(Main *bmain, Scene *scene, PointerRNA *ptr)
342 Object *ob = (Object *)ptr->id.data;
345 base = scene ? BKE_scene_base_find(scene, ob) : NULL;
349 SWAP(unsigned int, base->lay, ob->lay);
351 rna_Object_layer_update__internal(bmain, scene, base, ob);
354 WM_main_add_notifier(NC_SCENE | ND_LAYER_CONTENT, scene);
357 static void rna_Base_layer_update(Main *bmain, Scene *scene, PointerRNA *ptr)
359 Base *base = (Base *)ptr->data;
360 Object *ob = (Object *)base->object;
362 rna_Object_layer_update__internal(bmain, scene, base, ob);
365 WM_main_add_notifier(NC_SCENE | ND_LAYER_CONTENT, scene);
368 static void rna_Object_data_set(PointerRNA *ptr, PointerRNA value)
370 Object *ob = (Object *)ptr->data;
373 if (ob->mode & OB_MODE_EDIT) {
377 /* assigning NULL only for empties */
378 if ((id == NULL) && (ob->type != OB_EMPTY)) {
382 if (ob->type == OB_EMPTY) {
384 id_us_min((ID *)ob->data);
388 if (!id || GS(id->name) == ID_IM) {
393 else if (ob->type == OB_MESH) {
394 BKE_mesh_assign_object(ob, (Mesh *)id);
398 id_us_min((ID *)ob->data);
401 /* no need to type-check here ID. this is done in the _typef() function */
402 BLI_assert(OB_DATA_SUPPORT_ID(GS(id->name)));
406 test_object_materials(G.main, id);
408 if (GS(id->name) == ID_CU)
409 BKE_curve_type_test(ob);
410 else if (ob->type == OB_ARMATURE)
411 BKE_pose_rebuild(ob, ob->data);
415 static StructRNA *rna_Object_data_typef(PointerRNA *ptr)
417 Object *ob = (Object *)ptr->data;
419 /* keep in sync with OB_DATA_SUPPORT_ID() macro */
421 case OB_EMPTY: return &RNA_Image;
422 case OB_MESH: return &RNA_Mesh;
423 case OB_CURVE: return &RNA_Curve;
424 case OB_SURF: return &RNA_Curve;
425 case OB_FONT: return &RNA_Curve;
426 case OB_MBALL: return &RNA_MetaBall;
427 case OB_LAMP: return &RNA_Lamp;
428 case OB_CAMERA: return &RNA_Camera;
429 case OB_LATTICE: return &RNA_Lattice;
430 case OB_ARMATURE: return &RNA_Armature;
431 case OB_SPEAKER: return &RNA_Speaker;
432 default: return &RNA_ID;
436 static void rna_Object_parent_set(PointerRNA *ptr, PointerRNA value)
438 Object *ob = (Object *)ptr->data;
439 Object *par = (Object *)value.data;
442 /* NOTE: this dummy check here prevents this method causing weird runtime errors on mingw 4.6.2 */
446 ED_object_parent(ob, par, ob->partype, ob->parsubstr);
450 static void rna_Object_parent_type_set(PointerRNA *ptr, int value)
452 Object *ob = (Object *)ptr->data;
454 ED_object_parent(ob, ob->parent, value, ob->parsubstr);
457 static EnumPropertyItem *rna_Object_parent_type_itemf(bContext *UNUSED(C), PointerRNA *ptr,
458 PropertyRNA *UNUSED(prop), bool *r_free)
460 Object *ob = (Object *)ptr->data;
461 EnumPropertyItem *item = NULL;
464 RNA_enum_items_add_value(&item, &totitem, parent_type_items, PAROBJECT);
467 Object *par = ob->parent;
469 if (par->type == OB_CURVE) {
470 RNA_enum_items_add_value(&item, &totitem, parent_type_items, PARCURVE);
472 else if (par->type == OB_LATTICE) {
473 /* special hack: prevents this overriding others */
474 RNA_enum_items_add_value(&item, &totitem, &parent_type_items[4], PARSKEL);
476 else if (par->type == OB_ARMATURE) {
477 /* special hack: prevents this being overrided */
478 RNA_enum_items_add_value(&item, &totitem, &parent_type_items[3], PARSKEL);
479 RNA_enum_items_add_value(&item, &totitem, parent_type_items, PARBONE);
482 if (OB_TYPE_SUPPORT_PARVERT(par->type)) {
483 RNA_enum_items_add_value(&item, &totitem, parent_type_items, PARVERT1);
484 RNA_enum_items_add_value(&item, &totitem, parent_type_items, PARVERT3);
488 RNA_enum_item_end(&item, &totitem);
494 static void rna_Object_empty_draw_type_set(PointerRNA *ptr, int value)
496 Object *ob = (Object *)ptr->data;
498 BKE_object_empty_draw_type_set(ob, value);
501 static EnumPropertyItem *rna_Object_collision_bounds_itemf(bContext *UNUSED(C), PointerRNA *ptr,
502 PropertyRNA *UNUSED(prop), bool *r_free)
504 Object *ob = (Object *)ptr->data;
505 EnumPropertyItem *item = NULL;
508 RNA_enum_items_add_value(&item, &totitem, collision_bounds_items, OB_BOUND_TRIANGLE_MESH);
509 RNA_enum_items_add_value(&item, &totitem, collision_bounds_items, OB_BOUND_CONVEX_HULL);
511 if (ob->body_type != OB_BODY_TYPE_SOFT) {
512 RNA_enum_items_add_value(&item, &totitem, collision_bounds_items, OB_BOUND_CONE);
513 RNA_enum_items_add_value(&item, &totitem, collision_bounds_items, OB_BOUND_CYLINDER);
514 RNA_enum_items_add_value(&item, &totitem, collision_bounds_items, OB_BOUND_SPHERE);
515 RNA_enum_items_add_value(&item, &totitem, collision_bounds_items, OB_BOUND_BOX);
516 RNA_enum_items_add_value(&item, &totitem, collision_bounds_items, OB_BOUND_CAPSULE);
519 RNA_enum_item_end(&item, &totitem);
525 static void rna_Object_parent_bone_set(PointerRNA *ptr, const char *value)
527 Object *ob = (Object *)ptr->data;
529 ED_object_parent(ob, ob->parent, ob->partype, value);
532 static void rna_Object_dup_group_set(PointerRNA *ptr, PointerRNA value)
534 Object *ob = (Object *)ptr->data;
535 Group *grp = (Group *)value.data;
537 /* must not let this be set if the object belongs in this group already,
538 * thus causing a cycle/infinite-recursion leading to crashes on load [#25298]
540 if (BKE_group_object_exists(grp, ob) == 0)
543 BKE_report(NULL, RPT_ERROR,
544 "Cannot set dupli-group as object belongs in group being instanced, thus causing a cycle");
547 static void rna_VertexGroup_name_set(PointerRNA *ptr, const char *value)
549 Object *ob = (Object *)ptr->id.data;
550 bDeformGroup *dg = (bDeformGroup *)ptr->data;
551 BLI_strncpy_utf8(dg->name, value, sizeof(dg->name));
552 defgroup_unique_name(dg, ob);
555 static int rna_VertexGroup_index_get(PointerRNA *ptr)
557 Object *ob = (Object *)ptr->id.data;
559 return BLI_findindex(&ob->defbase, ptr->data);
562 static PointerRNA rna_Object_active_vertex_group_get(PointerRNA *ptr)
564 Object *ob = (Object *)ptr->id.data;
565 return rna_pointer_inherit_refine(ptr, &RNA_VertexGroup, BLI_findlink(&ob->defbase, ob->actdef - 1));
568 static int rna_Object_active_vertex_group_index_get(PointerRNA *ptr)
570 Object *ob = (Object *)ptr->id.data;
571 return ob->actdef - 1;
574 static void rna_Object_active_vertex_group_index_set(PointerRNA *ptr, int value)
576 Object *ob = (Object *)ptr->id.data;
577 ob->actdef = value + 1;
580 static void rna_Object_active_vertex_group_index_range(PointerRNA *ptr, int *min, int *max,
581 int *UNUSED(softmin), int *UNUSED(softmax))
583 Object *ob = (Object *)ptr->id.data;
586 *max = max_ii(0, BLI_countlist(&ob->defbase) - 1);
589 void rna_object_vgroup_name_index_get(PointerRNA *ptr, char *value, int index)
591 Object *ob = (Object *)ptr->id.data;
594 dg = BLI_findlink(&ob->defbase, index - 1);
596 if (dg) BLI_strncpy(value, dg->name, sizeof(dg->name));
597 else value[0] = '\0';
600 int rna_object_vgroup_name_index_length(PointerRNA *ptr, int index)
602 Object *ob = (Object *)ptr->id.data;
605 dg = BLI_findlink(&ob->defbase, index - 1);
606 return (dg) ? strlen(dg->name) : 0;
609 void rna_object_vgroup_name_index_set(PointerRNA *ptr, const char *value, short *index)
611 Object *ob = (Object *)ptr->id.data;
612 *index = defgroup_name_index(ob, value) + 1;
615 void rna_object_vgroup_name_set(PointerRNA *ptr, const char *value, char *result, int maxlen)
617 Object *ob = (Object *)ptr->id.data;
618 bDeformGroup *dg = defgroup_find_name(ob, value);
620 BLI_strncpy(result, value, maxlen); /* no need for BLI_strncpy_utf8, since this matches an existing group */
627 void rna_object_uvlayer_name_set(PointerRNA *ptr, const char *value, char *result, int maxlen)
629 Object *ob = (Object *)ptr->id.data;
631 CustomDataLayer *layer;
634 if (ob->type == OB_MESH && ob->data) {
635 me = (Mesh *)ob->data;
637 for (a = 0; a < me->pdata.totlayer; a++) {
638 layer = &me->pdata.layers[a];
640 if (layer->type == CD_MTEXPOLY && strcmp(layer->name, value) == 0) {
641 BLI_strncpy(result, value, maxlen);
650 void rna_object_vcollayer_name_set(PointerRNA *ptr, const char *value, char *result, int maxlen)
652 Object *ob = (Object *)ptr->id.data;
654 CustomDataLayer *layer;
657 if (ob->type == OB_MESH && ob->data) {
658 me = (Mesh *)ob->data;
660 for (a = 0; a < me->fdata.totlayer; a++) {
661 layer = &me->fdata.layers[a];
663 if (layer->type == CD_MCOL && strcmp(layer->name, value) == 0) {
664 BLI_strncpy(result, value, maxlen);
673 static int rna_Object_active_material_index_get(PointerRNA *ptr)
675 Object *ob = (Object *)ptr->id.data;
676 return MAX2(ob->actcol - 1, 0);
679 static void rna_Object_active_material_index_set(PointerRNA *ptr, int value)
681 Object *ob = (Object *)ptr->id.data;
682 ob->actcol = value + 1;
684 if (ob->type == OB_MESH) {
688 me->edit_btmesh->mat_nr = value;
692 static void rna_Object_active_material_index_range(PointerRNA *ptr, int *min, int *max,
693 int *UNUSED(softmin), int *UNUSED(softmax))
695 Object *ob = (Object *)ptr->id.data;
697 *max = max_ii(ob->totcol - 1, 0);
700 /* returns active base material */
701 static PointerRNA rna_Object_active_material_get(PointerRNA *ptr)
703 Object *ob = (Object *)ptr->id.data;
706 ma = (ob->totcol) ? give_current_material(ob, ob->actcol) : NULL;
707 return rna_pointer_inherit_refine(ptr, &RNA_Material, ma);
710 static void rna_Object_active_material_set(PointerRNA *ptr, PointerRNA value)
712 Object *ob = (Object *)ptr->id.data;
714 DAG_id_tag_update(value.data, 0);
715 assign_material(ob, value.data, ob->actcol, BKE_MAT_ASSIGN_USERPREF);
718 static int rna_Object_active_material_editable(PointerRNA *ptr)
720 Object *ob = (Object *)ptr->id.data;
723 if ((ob->matbits == NULL) || (ob->actcol == 0) || ob->matbits[ob->actcol - 1]) {
724 is_editable = (ob->id.lib == NULL);
727 is_editable = ob->data ? (((ID *)ob->data)->lib == NULL) : false;
730 return is_editable ? PROP_EDITABLE : 0;
734 static void rna_Object_active_particle_system_index_range(PointerRNA *ptr, int *min, int *max,
735 int *UNUSED(softmin), int *UNUSED(softmax))
737 Object *ob = (Object *)ptr->id.data;
739 *max = max_ii(0, BLI_countlist(&ob->particlesystem) - 1);
742 static int rna_Object_active_particle_system_index_get(PointerRNA *ptr)
744 Object *ob = (Object *)ptr->id.data;
745 return psys_get_current_num(ob);
748 static void rna_Object_active_particle_system_index_set(PointerRNA *ptr, int value)
750 Object *ob = (Object *)ptr->id.data;
751 psys_set_current_num(ob, value);
754 static void rna_Object_particle_update(Main *UNUSED(bmain), Scene *scene, PointerRNA *ptr)
756 Object *ob = (Object *)ptr->id.data;
758 PE_current_changed(scene, ob);
761 /* rotation - axis-angle */
762 static void rna_Object_rotation_axis_angle_get(PointerRNA *ptr, float *value)
764 Object *ob = ptr->data;
766 /* for now, assume that rotation mode is axis-angle */
767 value[0] = ob->rotAngle;
768 copy_v3_v3(&value[1], ob->rotAxis);
771 /* rotation - axis-angle */
772 static void rna_Object_rotation_axis_angle_set(PointerRNA *ptr, const float *value)
774 Object *ob = ptr->data;
776 /* for now, assume that rotation mode is axis-angle */
777 ob->rotAngle = value[0];
778 copy_v3_v3(ob->rotAxis, (float *)&value[1]);
780 /* TODO: validate axis? */
783 static void rna_Object_rotation_mode_set(PointerRNA *ptr, int value)
785 Object *ob = ptr->data;
787 /* use API Method for conversions... */
788 BKE_rotMode_change_values(ob->quat, ob->rot, ob->rotAxis, &ob->rotAngle, ob->rotmode, (short)value);
790 /* finally, set the new rotation type */
794 static void rna_Object_dimensions_get(PointerRNA *ptr, float *value)
796 Object *ob = ptr->data;
797 BKE_object_dimensions_get(ob, value);
800 static void rna_Object_dimensions_set(PointerRNA *ptr, const float *value)
802 Object *ob = ptr->data;
803 BKE_object_dimensions_set(ob, value);
806 static int rna_Object_location_editable(PointerRNA *ptr, int index)
808 Object *ob = (Object *)ptr->data;
810 /* only if the axis in question is locked, not editable... */
811 if ((index == 0) && (ob->protectflag & OB_LOCK_LOCX))
813 else if ((index == 1) && (ob->protectflag & OB_LOCK_LOCY))
815 else if ((index == 2) && (ob->protectflag & OB_LOCK_LOCZ))
818 return PROP_EDITABLE;
821 static int rna_Object_scale_editable(PointerRNA *ptr, int index)
823 Object *ob = (Object *)ptr->data;
825 /* only if the axis in question is locked, not editable... */
826 if ((index == 0) && (ob->protectflag & OB_LOCK_SCALEX))
828 else if ((index == 1) && (ob->protectflag & OB_LOCK_SCALEY))
830 else if ((index == 2) && (ob->protectflag & OB_LOCK_SCALEZ))
833 return PROP_EDITABLE;
836 static int rna_Object_rotation_euler_editable(PointerRNA *ptr, int index)
838 Object *ob = (Object *)ptr->data;
840 /* only if the axis in question is locked, not editable... */
841 if ((index == 0) && (ob->protectflag & OB_LOCK_ROTX))
843 else if ((index == 1) && (ob->protectflag & OB_LOCK_ROTY))
845 else if ((index == 2) && (ob->protectflag & OB_LOCK_ROTZ))
848 return PROP_EDITABLE;
851 static int rna_Object_rotation_4d_editable(PointerRNA *ptr, int index)
853 Object *ob = (Object *)ptr->data;
855 /* only consider locks if locking components individually... */
856 if (ob->protectflag & OB_LOCK_ROT4D) {
857 /* only if the axis in question is locked, not editable... */
858 if ((index == 0) && (ob->protectflag & OB_LOCK_ROTW))
860 else if ((index == 1) && (ob->protectflag & OB_LOCK_ROTX))
862 else if ((index == 2) && (ob->protectflag & OB_LOCK_ROTY))
864 else if ((index == 3) && (ob->protectflag & OB_LOCK_ROTZ))
868 return PROP_EDITABLE;
872 static PointerRNA rna_MaterialSlot_material_get(PointerRNA *ptr)
874 Object *ob = (Object *)ptr->id.data;
876 int index = (Material **)ptr->data - ob->mat;
878 ma = give_current_material(ob, index + 1);
879 return rna_pointer_inherit_refine(ptr, &RNA_Material, ma);
882 static void rna_MaterialSlot_material_set(PointerRNA *ptr, PointerRNA value)
884 Object *ob = (Object *)ptr->id.data;
885 int index = (Material **)ptr->data - ob->mat;
887 assign_material(ob, value.data, index + 1, BKE_MAT_ASSIGN_USERPREF);
890 static int rna_MaterialSlot_link_get(PointerRNA *ptr)
892 Object *ob = (Object *)ptr->id.data;
893 int index = (Material **)ptr->data - ob->mat;
895 return ob->matbits[index] != 0;
898 static void rna_MaterialSlot_link_set(PointerRNA *ptr, int value)
900 Object *ob = (Object *)ptr->id.data;
901 int index = (Material **)ptr->data - ob->mat;
904 ob->matbits[index] = 1;
905 /* ob->colbits |= (1 << index); */ /* DEPRECATED */
908 ob->matbits[index] = 0;
909 /* ob->colbits &= ~(1 << index); */ /* DEPRECATED */
913 static int rna_MaterialSlot_name_length(PointerRNA *ptr)
915 Object *ob = (Object *)ptr->id.data;
917 int index = (Material **)ptr->data - ob->mat;
919 ma = give_current_material(ob, index + 1);
922 return strlen(ma->id.name + 2);
927 static void rna_MaterialSlot_name_get(PointerRNA *ptr, char *str)
929 Object *ob = (Object *)ptr->id.data;
931 int index = (Material **)ptr->data - ob->mat;
933 ma = give_current_material(ob, index + 1);
936 strcpy(str, ma->id.name + 2);
941 static void rna_MaterialSlot_update(Main *bmain, Scene *scene, PointerRNA *ptr)
943 rna_Object_internal_update(bmain, scene, ptr);
944 WM_main_add_notifier(NC_OBJECT | ND_OB_SHADING, ptr->id.data);
945 WM_main_add_notifier(NC_MATERIAL | ND_SHADING_LINKS, NULL);
948 static char *rna_MaterialSlot_path(PointerRNA *ptr)
950 Object *ob = (Object *)ptr->id.data;
951 int index = (Material **)ptr->data - ob->mat;
953 /* from armature... */
954 return BLI_sprintfN("material_slots[%d]", index);
957 /* why does this have to be so complicated?, can't all this crap be
958 * moved to in BGE conversion function? - Campbell *
960 * logic from check_body_type()
962 static int rna_GameObjectSettings_physics_type_get(PointerRNA *ptr)
964 Object *ob = (Object *)ptr->id.data;
966 /* determine the body_type setting based on flags */
967 if (!(ob->gameflag & OB_COLLISION)) {
968 if (ob->gameflag & OB_OCCLUDER) {
969 ob->body_type = OB_BODY_TYPE_OCCLUDER;
971 else if (ob->gameflag & OB_NAVMESH) {
972 ob->body_type = OB_BODY_TYPE_NAVMESH;
975 ob->body_type = OB_BODY_TYPE_NO_COLLISION;
978 else if (ob->gameflag & OB_CHARACTER) {
979 ob->body_type = OB_BODY_TYPE_CHARACTER;
981 else if (ob->gameflag & OB_SENSOR) {
982 ob->body_type = OB_BODY_TYPE_SENSOR;
984 else if (!(ob->gameflag & OB_DYNAMIC)) {
985 ob->body_type = OB_BODY_TYPE_STATIC;
987 else if (!(ob->gameflag & (OB_RIGID_BODY | OB_SOFT_BODY))) {
988 ob->body_type = OB_BODY_TYPE_DYNAMIC;
990 else if (ob->gameflag & OB_RIGID_BODY) {
991 ob->body_type = OB_BODY_TYPE_RIGID;
994 ob->body_type = OB_BODY_TYPE_SOFT;
995 /* create the structure here because we display soft body buttons in the main panel */
997 ob->bsoft = bsbNew();
1000 return ob->body_type;
1003 static void rna_GameObjectSettings_physics_type_set(PointerRNA *ptr, int value)
1005 Object *ob = (Object *)ptr->id.data;
1006 const int was_navmesh = (ob->gameflag & OB_NAVMESH);
1007 ob->body_type = value;
1009 switch (ob->body_type) {
1010 case OB_BODY_TYPE_SENSOR:
1011 ob->gameflag |= OB_SENSOR | OB_COLLISION;
1012 ob->gameflag &= ~(OB_OCCLUDER | OB_CHARACTER | OB_DYNAMIC | OB_RIGID_BODY | OB_SOFT_BODY | OB_ACTOR |
1013 OB_ANISOTROPIC_FRICTION | OB_DO_FH | OB_ROT_FH | OB_COLLISION_RESPONSE | OB_NAVMESH);
1015 case OB_BODY_TYPE_OCCLUDER:
1016 ob->gameflag |= OB_OCCLUDER;
1017 ob->gameflag &= ~(OB_SENSOR | OB_RIGID_BODY | OB_SOFT_BODY | OB_COLLISION | OB_CHARACTER | OB_DYNAMIC | OB_NAVMESH);
1019 case OB_BODY_TYPE_NAVMESH:
1020 ob->gameflag |= OB_NAVMESH;
1021 ob->gameflag &= ~(OB_SENSOR | OB_RIGID_BODY | OB_SOFT_BODY | OB_COLLISION | OB_CHARACTER | OB_DYNAMIC | OB_OCCLUDER);
1023 if (ob->type == OB_MESH) {
1024 /* could be moved into mesh UI but for now ensure mesh data layer */
1025 BKE_mesh_ensure_navmesh(ob->data);
1029 case OB_BODY_TYPE_NO_COLLISION:
1030 ob->gameflag &= ~(OB_SENSOR | OB_RIGID_BODY | OB_SOFT_BODY | OB_COLLISION | OB_CHARACTER | OB_OCCLUDER | OB_DYNAMIC | OB_NAVMESH);
1032 case OB_BODY_TYPE_CHARACTER:
1033 ob->gameflag |= OB_COLLISION | OB_CHARACTER;
1034 ob->gameflag &= ~(OB_SENSOR | OB_OCCLUDER | OB_DYNAMIC | OB_RIGID_BODY | OB_SOFT_BODY | OB_ACTOR |
1035 OB_ANISOTROPIC_FRICTION | OB_DO_FH | OB_ROT_FH | OB_COLLISION_RESPONSE | OB_NAVMESH);
1037 case OB_BODY_TYPE_STATIC:
1038 ob->gameflag |= OB_COLLISION;
1039 ob->gameflag &= ~(OB_DYNAMIC | OB_RIGID_BODY | OB_SOFT_BODY | OB_OCCLUDER | OB_CHARACTER | OB_SENSOR | OB_NAVMESH);
1041 case OB_BODY_TYPE_DYNAMIC:
1042 ob->gameflag |= OB_COLLISION | OB_DYNAMIC | OB_ACTOR;
1043 ob->gameflag &= ~(OB_RIGID_BODY | OB_SOFT_BODY | OB_OCCLUDER | OB_CHARACTER | OB_SENSOR | OB_NAVMESH);
1045 case OB_BODY_TYPE_RIGID:
1046 ob->gameflag |= OB_COLLISION | OB_DYNAMIC | OB_RIGID_BODY | OB_ACTOR;
1047 ob->gameflag &= ~(OB_SOFT_BODY | OB_OCCLUDER | OB_CHARACTER | OB_SENSOR | OB_NAVMESH);
1050 case OB_BODY_TYPE_SOFT:
1051 ob->gameflag |= OB_COLLISION | OB_DYNAMIC | OB_SOFT_BODY | OB_ACTOR;
1052 ob->gameflag &= ~(OB_RIGID_BODY | OB_OCCLUDER | OB_CHARACTER | OB_SENSOR | OB_NAVMESH);
1054 /* assume triangle mesh, if no bounds chosen for soft body */
1055 if ((ob->gameflag & OB_BOUNDS) && (ob->boundtype < OB_BOUND_TRIANGLE_MESH)) {
1056 ob->boundtype = OB_BOUND_TRIANGLE_MESH;
1058 /* create a BulletSoftBody structure if not already existing */
1060 ob->bsoft = bsbNew();
1064 if (was_navmesh != (ob->gameflag & OB_NAVMESH)) {
1065 if (ob->type == OB_MESH) {
1066 /* this is needed to refresh the derived meshes draw func */
1067 DAG_id_tag_update(ptr->id.data, OB_RECALC_DATA);
1071 WM_main_add_notifier(NC_OBJECT | ND_DRAW, ptr->id.data);
1074 static PointerRNA rna_Object_active_particle_system_get(PointerRNA *ptr)
1076 Object *ob = (Object *)ptr->id.data;
1077 ParticleSystem *psys = psys_get_current(ob);
1078 return rna_pointer_inherit_refine(ptr, &RNA_ParticleSystem, psys);
1081 static PointerRNA rna_Object_game_settings_get(PointerRNA *ptr)
1083 return rna_pointer_inherit_refine(ptr, &RNA_GameObjectSettings, ptr->id.data);
1087 static unsigned int rna_Object_layer_validate__internal(const int *values, unsigned int lay)
1091 /* ensure we always have some layer selected */
1092 for (i = 0; i < 20; i++)
1099 for (i = 0; i < 20; i++) {
1100 if (values[i]) lay |= (1 << i);
1101 else lay &= ~(1 << i);
1107 static void rna_Object_layer_set(PointerRNA *ptr, const int *values)
1109 Object *ob = (Object *)ptr->data;
1112 lay = rna_Object_layer_validate__internal(values, ob->lay);
1117 static void rna_Base_layer_set(PointerRNA *ptr, const int *values)
1119 Base *base = (Base *)ptr->data;
1122 lay = rna_Object_layer_validate__internal(values, base->lay);
1126 /* rna_Base_layer_update updates the objects layer */
1129 static void rna_GameObjectSettings_state_get(PointerRNA *ptr, int *values)
1131 Object *ob = (Object *)ptr->data;
1133 int all_states = (ob->scaflag & OB_ALLSTATE ? 1 : 0);
1135 memset(values, 0, sizeof(int) * OB_MAX_STATES);
1136 for (i = 0; i < OB_MAX_STATES; i++) {
1137 values[i] = (ob->state & (1 << i)) | all_states;
1141 static void rna_GameObjectSettings_state_set(PointerRNA *ptr, const int *values)
1143 Object *ob = (Object *)ptr->data;
1146 /* ensure we always have some state selected */
1147 for (i = 0; i < OB_MAX_STATES; i++)
1154 for (i = 0; i < OB_MAX_STATES; i++) {
1155 if (values[i]) ob->state |= (1 << i);
1156 else ob->state &= ~(1 << i);
1160 static void rna_GameObjectSettings_used_state_get(PointerRNA *ptr, int *values)
1162 Object *ob = (Object *)ptr->data;
1165 memset(values, 0, sizeof(int) * OB_MAX_STATES);
1166 for (cont = ob->controllers.first; cont; cont = cont->next) {
1169 for (i = 0; i < OB_MAX_STATES; i++) {
1170 if (cont->state_mask & (1 << i))
1176 static void rna_GameObjectSettings_col_group_get(PointerRNA *ptr, int *values)
1178 Object *ob = (Object *)ptr->data;
1181 for (i = 0; i < OB_MAX_COL_MASKS; i++) {
1182 values[i] = (ob->col_group & (1 << i));
1186 static void rna_GameObjectSettings_col_group_set(PointerRNA *ptr, const int *values)
1188 Object *ob = (Object *)ptr->data;
1191 /* ensure we always have some group selected */
1192 for (i = 0; i < OB_MAX_COL_MASKS; i++)
1199 for (i = 0; i < OB_MAX_COL_MASKS; i++) {
1200 if (values[i]) ob->col_group |= (1 << i);
1201 else ob->col_group &= ~(1 << i);
1205 static void rna_GameObjectSettings_col_mask_get(PointerRNA *ptr, int *values)
1207 Object *ob = (Object *)ptr->data;
1210 for (i = 0; i < OB_MAX_COL_MASKS; i++) {
1211 values[i] = (ob->col_mask & (1 << i));
1215 static void rna_GameObjectSettings_col_mask_set(PointerRNA *ptr, const int *values)
1217 Object *ob = (Object *)ptr->data;
1220 /* ensure we always have some mask selected */
1221 for (i = 0; i < OB_MAX_COL_MASKS; i++)
1228 for (i = 0; i < OB_MAX_COL_MASKS; i++) {
1229 if (values[i]) ob->col_mask |= (1 << i);
1230 else ob->col_mask &= ~(1 << i);
1235 static void rna_Object_active_shape_key_index_range(PointerRNA *ptr, int *min, int *max,
1236 int *UNUSED(softmin), int *UNUSED(softmax))
1238 Object *ob = (Object *)ptr->id.data;
1239 Key *key = BKE_key_from_object(ob);
1243 *max = BLI_countlist(&key->block) - 1;
1244 if (*max < 0) *max = 0;
1251 static int rna_Object_active_shape_key_index_get(PointerRNA *ptr)
1253 Object *ob = (Object *)ptr->id.data;
1255 return MAX2(ob->shapenr - 1, 0);
1258 static void rna_Object_active_shape_key_index_set(PointerRNA *ptr, int value)
1260 Object *ob = (Object *)ptr->id.data;
1262 ob->shapenr = value + 1;
1265 static PointerRNA rna_Object_active_shape_key_get(PointerRNA *ptr)
1267 Object *ob = (Object *)ptr->id.data;
1268 Key *key = BKE_key_from_object(ob);
1273 return PointerRNA_NULL;
1275 kb = BLI_findlink(&key->block, ob->shapenr - 1);
1276 RNA_pointer_create((ID *)key, &RNA_ShapeKey, kb, &keyptr);
1280 static PointerRNA rna_Object_field_get(PointerRNA *ptr)
1282 Object *ob = (Object *)ptr->id.data;
1286 ob->pd = object_add_collision_fields(0);
1288 return rna_pointer_inherit_refine(ptr, &RNA_FieldSettings, ob->pd);
1291 static PointerRNA rna_Object_collision_get(PointerRNA *ptr)
1293 Object *ob = (Object *)ptr->id.data;
1295 if (ob->type != OB_MESH)
1296 return PointerRNA_NULL;
1300 ob->pd = object_add_collision_fields(0);
1302 return rna_pointer_inherit_refine(ptr, &RNA_CollisionSettings, ob->pd);
1305 static PointerRNA rna_Object_active_constraint_get(PointerRNA *ptr)
1307 Object *ob = (Object *)ptr->id.data;
1308 bConstraint *con = BKE_constraints_active_get(&ob->constraints);
1309 return rna_pointer_inherit_refine(ptr, &RNA_Constraint, con);
1312 static void rna_Object_active_constraint_set(PointerRNA *ptr, PointerRNA value)
1314 Object *ob = (Object *)ptr->id.data;
1315 BKE_constraints_active_set(&ob->constraints, (bConstraint *)value.data);
1318 static bConstraint *rna_Object_constraints_new(Object *object, int type)
1320 WM_main_add_notifier(NC_OBJECT | ND_CONSTRAINT | NA_ADDED, object);
1321 return BKE_constraint_add_for_object(object, NULL, type);
1324 static void rna_Object_constraints_remove(Object *object, ReportList *reports, PointerRNA *con_ptr)
1326 bConstraint *con = con_ptr->data;
1327 if (BLI_findindex(&object->constraints, con) == -1) {
1328 BKE_reportf(reports, RPT_ERROR, "Constraint '%s' not found in object '%s'", con->name, object->id.name + 2);
1332 BKE_constraint_remove(&object->constraints, con);
1333 RNA_POINTER_INVALIDATE(con_ptr);
1335 ED_object_constraint_update(object);
1336 ED_object_constraint_set_active(object, NULL);
1337 WM_main_add_notifier(NC_OBJECT | ND_CONSTRAINT | NA_REMOVED, object);
1340 static void rna_Object_constraints_clear(Object *object)
1342 BKE_constraints_free(&object->constraints);
1344 ED_object_constraint_update(object);
1345 ED_object_constraint_set_active(object, NULL);
1347 WM_main_add_notifier(NC_OBJECT | ND_CONSTRAINT | NA_REMOVED, object);
1350 static ModifierData *rna_Object_modifier_new(Object *object, bContext *C, ReportList *reports,
1351 const char *name, int type)
1353 return ED_object_modifier_add(reports, CTX_data_main(C), CTX_data_scene(C), object, name, type);
1356 static void rna_Object_modifier_remove(Object *object, bContext *C, ReportList *reports, PointerRNA *md_ptr)
1358 ModifierData *md = md_ptr->data;
1359 if (ED_object_modifier_remove(reports, CTX_data_main(C), object, md) == false) {
1360 /* error is already set */
1364 RNA_POINTER_INVALIDATE(md_ptr);
1366 WM_main_add_notifier(NC_OBJECT | ND_MODIFIER | NA_REMOVED, object);
1369 static void rna_Object_modifier_clear(Object *object, bContext *C)
1371 ED_object_modifier_clear(CTX_data_main(C), object);
1373 WM_main_add_notifier(NC_OBJECT | ND_MODIFIER | NA_REMOVED, object);
1376 static void rna_Object_boundbox_get(PointerRNA *ptr, float *values)
1378 Object *ob = (Object *)ptr->id.data;
1379 BoundBox *bb = BKE_object_boundbox_get(ob);
1381 memcpy(values, bb->vec, sizeof(bb->vec));
1384 fill_vn_fl(values, sizeof(bb->vec) / sizeof(float), 0.0f);
1389 static bDeformGroup *rna_Object_vgroup_new(Object *ob, const char *name)
1391 bDeformGroup *defgroup = ED_vgroup_add_name(ob, name);
1393 WM_main_add_notifier(NC_OBJECT | ND_DRAW, ob);
1398 static void rna_Object_vgroup_remove(Object *ob, ReportList *reports, PointerRNA *defgroup_ptr)
1400 bDeformGroup *defgroup = defgroup_ptr->data;
1401 if (BLI_findindex(&ob->defbase, defgroup) == -1) {
1402 BKE_reportf(reports, RPT_ERROR, "DeformGroup '%s' not in object '%s'", defgroup->name, ob->id.name + 2);
1406 ED_vgroup_delete(ob, defgroup);
1407 RNA_POINTER_INVALIDATE(defgroup_ptr);
1409 WM_main_add_notifier(NC_OBJECT | ND_DRAW, ob);
1412 static void rna_Object_vgroup_clear(Object *ob)
1414 ED_vgroup_clear(ob);
1416 WM_main_add_notifier(NC_OBJECT | ND_DRAW, ob);
1419 static void rna_VertexGroup_vertex_add(ID *id, bDeformGroup *def, ReportList *reports, int index_len,
1420 int *index, float weight, int assignmode)
1422 Object *ob = (Object *)id;
1424 if (ED_vgroup_object_is_edit_mode(ob)) {
1425 BKE_report(reports, RPT_ERROR, "VertexGroup.add(): cannot be called while object is in edit mode");
1430 ED_vgroup_vert_add(ob, def, *index++, weight, assignmode); /* XXX, not efficient calling within loop*/
1432 WM_main_add_notifier(NC_GEOM | ND_DATA, (ID *)ob->data);
1435 static void rna_VertexGroup_vertex_remove(ID *id, bDeformGroup *dg, ReportList *reports, int index_len, int *index)
1437 Object *ob = (Object *)id;
1439 if (ED_vgroup_object_is_edit_mode(ob)) {
1440 BKE_report(reports, RPT_ERROR, "VertexGroup.remove(): cannot be called while object is in edit mode");
1445 ED_vgroup_vert_remove(ob, dg, *index++);
1447 WM_main_add_notifier(NC_GEOM | ND_DATA, (ID *)ob->data);
1450 static float rna_VertexGroup_weight(ID *id, bDeformGroup *dg, ReportList *reports, int index)
1452 float weight = ED_vgroup_vert_weight((Object *)id, dg, index);
1455 BKE_report(reports, RPT_ERROR, "Vertex not in group");
1460 /* generic poll functions */
1461 int rna_Lattice_object_poll(PointerRNA *UNUSED(ptr), PointerRNA value)
1463 return ((Object *)value.id.data)->type == OB_LATTICE;
1466 int rna_Curve_object_poll(PointerRNA *UNUSED(ptr), PointerRNA value)
1468 return ((Object *)value.id.data)->type == OB_CURVE;
1471 int rna_Armature_object_poll(PointerRNA *UNUSED(ptr), PointerRNA value)
1473 return ((Object *)value.id.data)->type == OB_ARMATURE;
1476 int rna_Mesh_object_poll(PointerRNA *UNUSED(ptr), PointerRNA value)
1478 return ((Object *)value.id.data)->type == OB_MESH;
1481 int rna_Camera_object_poll(PointerRNA *UNUSED(ptr), PointerRNA value)
1483 return ((Object *)value.id.data)->type == OB_CAMERA;
1486 int rna_Lamp_object_poll(PointerRNA *UNUSED(ptr), PointerRNA value)
1488 return ((Object *)value.id.data)->type == OB_LAMP;
1491 int rna_DupliObject_index_get(PointerRNA *ptr)
1493 DupliObject *dob = (DupliObject *)ptr->data;
1494 return dob->persistent_id[0];
1497 int rna_Object_use_dynamic_topology_sculpting_get(PointerRNA *ptr)
1499 SculptSession *ss = ((Object *)ptr->id.data)->sculpt;
1500 return (ss && ss->bm);
1503 static void rna_Object_lod_distance_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
1505 Object *ob = (Object *)ptr->id.data;
1507 #ifdef WITH_GAMEENGINE
1508 BKE_object_lod_sort(ob);
1515 static void rna_def_vertex_group(BlenderRNA *brna)
1521 static EnumPropertyItem assign_mode_items[] = {
1522 {WEIGHT_REPLACE, "REPLACE", 0, "Replace", "Replace"},
1523 {WEIGHT_ADD, "ADD", 0, "Add", "Add"},
1524 {WEIGHT_SUBTRACT, "SUBTRACT", 0, "Subtract", "Subtract"},
1525 {0, NULL, 0, NULL, NULL}
1528 srna = RNA_def_struct(brna, "VertexGroup", NULL);
1529 RNA_def_struct_sdna(srna, "bDeformGroup");
1530 RNA_def_struct_ui_text(srna, "Vertex Group", "Group of vertices, used for armature deform and other purposes");
1531 RNA_def_struct_ui_icon(srna, ICON_GROUP_VERTEX);
1533 prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
1534 RNA_def_property_ui_text(prop, "Name", "Vertex group name");
1535 RNA_def_struct_name_property(srna, prop);
1536 RNA_def_property_string_funcs(prop, NULL, NULL, "rna_VertexGroup_name_set");
1537 /* update data because modifiers may use [#24761] */
1538 RNA_def_property_update(prop, NC_GEOM | ND_DATA | NA_RENAME, "rna_Object_internal_update_data");
1540 prop = RNA_def_property(srna, "lock_weight", PROP_BOOLEAN, PROP_NONE);
1541 RNA_def_property_ui_text(prop, "", "Maintain the relative weights for the group");
1542 RNA_def_property_boolean_sdna(prop, NULL, "flag", 0);
1543 /* update data because modifiers may use [#24761] */
1544 RNA_def_property_update(prop, NC_GEOM | ND_DATA | NA_RENAME, "rna_Object_internal_update_data");
1546 prop = RNA_def_property(srna, "index", PROP_INT, PROP_UNSIGNED);
1547 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1548 RNA_def_property_int_funcs(prop, "rna_VertexGroup_index_get", NULL, NULL);
1549 RNA_def_property_ui_text(prop, "Index", "Index number of the vertex group");
1551 func = RNA_def_function(srna, "add", "rna_VertexGroup_vertex_add");
1552 RNA_def_function_ui_description(func, "Add vertices to the group");
1553 RNA_def_function_flag(func, FUNC_USE_REPORTS | FUNC_USE_SELF_ID);
1554 /* TODO, see how array size of 0 works, this shouldnt be used */
1555 prop = RNA_def_int_array(func, "index", 1, NULL, 0, 0, "", "Index List", 0, 0);
1556 RNA_def_property_flag(prop, PROP_DYNAMIC | PROP_REQUIRED);
1557 prop = RNA_def_float(func, "weight", 0, 0.0f, 1.0f, "", "Vertex weight", 0.0f, 1.0f);
1558 RNA_def_property_flag(prop, PROP_REQUIRED);
1559 prop = RNA_def_enum(func, "type", assign_mode_items, 0, "", "Vertex assign mode");
1560 RNA_def_property_flag(prop, PROP_REQUIRED);
1562 func = RNA_def_function(srna, "remove", "rna_VertexGroup_vertex_remove");
1563 RNA_def_function_ui_description(func, "Remove a vertex from the group");
1564 RNA_def_function_flag(func, FUNC_USE_REPORTS | FUNC_USE_SELF_ID);
1565 /* TODO, see how array size of 0 works, this shouldnt be used */
1566 prop = RNA_def_int_array(func, "index", 1, NULL, 0, 0, "", "Index List", 0, 0);
1567 RNA_def_property_flag(prop, PROP_DYNAMIC | PROP_REQUIRED);
1569 func = RNA_def_function(srna, "weight", "rna_VertexGroup_weight");
1570 RNA_def_function_ui_description(func, "Get a vertex weight from the group");
1571 RNA_def_function_flag(func, FUNC_USE_REPORTS | FUNC_USE_SELF_ID);
1572 prop = RNA_def_int(func, "index", 0, 0, INT_MAX, "Index", "The index of the vertex", 0, INT_MAX);
1573 RNA_def_property_flag(prop, PROP_REQUIRED);
1574 prop = RNA_def_float(func, "weight", 0, 0.0f, 1.0f, "", "Vertex weight", 0.0f, 1.0f);
1575 RNA_def_function_return(func, prop);
1578 static void rna_def_material_slot(BlenderRNA *brna)
1583 static EnumPropertyItem link_items[] = {
1584 {1, "OBJECT", 0, "Object", ""},
1585 {0, "DATA", 0, "Data", ""},
1586 {0, NULL, 0, NULL, NULL}
1589 /* NOTE: there is no MaterialSlot equivalent in DNA, so the internal
1590 * pointer data points to ob->mat + index, and we manually implement
1591 * get/set for the properties. */
1593 srna = RNA_def_struct(brna, "MaterialSlot", NULL);
1594 RNA_def_struct_ui_text(srna, "Material Slot", "Material slot in an object");
1595 RNA_def_struct_ui_icon(srna, ICON_MATERIAL_DATA);
1597 prop = RNA_def_property(srna, "material", PROP_POINTER, PROP_NONE);
1598 RNA_def_property_struct_type(prop, "Material");
1599 RNA_def_property_flag(prop, PROP_EDITABLE);
1600 RNA_def_property_pointer_funcs(prop, "rna_MaterialSlot_material_get", "rna_MaterialSlot_material_set", NULL, NULL);
1601 RNA_def_property_ui_text(prop, "Material", "Material datablock used by this material slot");
1602 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_MaterialSlot_update");
1604 prop = RNA_def_property(srna, "link", PROP_ENUM, PROP_NONE);
1605 RNA_def_property_enum_items(prop, link_items);
1606 RNA_def_property_enum_funcs(prop, "rna_MaterialSlot_link_get", "rna_MaterialSlot_link_set", NULL);
1607 RNA_def_property_ui_text(prop, "Link", "Link material to object or the object's data");
1608 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_MaterialSlot_update");
1610 prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
1611 RNA_def_property_string_funcs(prop, "rna_MaterialSlot_name_get", "rna_MaterialSlot_name_length", NULL);
1612 RNA_def_property_ui_text(prop, "Name", "Material slot name");
1613 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1614 RNA_def_struct_name_property(srna, prop);
1616 RNA_def_struct_path_func(srna, "rna_MaterialSlot_path");
1619 static void rna_def_object_game_settings(BlenderRNA *brna)
1624 static EnumPropertyItem body_type_items[] = {
1625 {OB_BODY_TYPE_NO_COLLISION, "NO_COLLISION", 0, "No Collision", "Disable collision for this object"},
1626 {OB_BODY_TYPE_STATIC, "STATIC", 0, "Static", "Stationary object"},
1627 {OB_BODY_TYPE_DYNAMIC, "DYNAMIC", 0, "Dynamic", "Linear physics"},
1628 {OB_BODY_TYPE_RIGID, "RIGID_BODY", 0, "Rigid Body", "Linear and angular physics"},
1629 {OB_BODY_TYPE_SOFT, "SOFT_BODY", 0, "Soft Body", "Soft body"},
1630 {OB_BODY_TYPE_OCCLUDER, "OCCLUDE", 0, "Occlude", "Occluder for optimizing scene rendering"},
1631 {OB_BODY_TYPE_SENSOR, "SENSOR", 0, "Sensor",
1632 "Collision Sensor, detects static and dynamic objects but not the other "
1633 "collision sensor objects"},
1634 {OB_BODY_TYPE_NAVMESH, "NAVMESH", 0, "Navigation Mesh", "Navigation mesh"},
1635 {OB_BODY_TYPE_CHARACTER, "CHARACTER", 0, "Character",
1636 "Simple kinematic physics appropriate for game characters"},
1637 {0, NULL, 0, NULL, NULL}
1640 srna = RNA_def_struct(brna, "GameObjectSettings", NULL);
1641 RNA_def_struct_sdna(srna, "Object");
1642 RNA_def_struct_nested(brna, srna, "Object");
1643 RNA_def_struct_ui_text(srna, "Game Object Settings", "Game engine related settings for the object");
1644 RNA_def_struct_ui_icon(srna, ICON_GAME);
1648 prop = RNA_def_property(srna, "sensors", PROP_COLLECTION, PROP_NONE);
1649 RNA_def_property_struct_type(prop, "Sensor");
1650 RNA_def_property_ui_text(prop, "Sensors", "Game engine sensor to detect events");
1652 prop = RNA_def_property(srna, "controllers", PROP_COLLECTION, PROP_NONE);
1653 RNA_def_property_struct_type(prop, "Controller");
1654 RNA_def_property_ui_text(prop, "Controllers",
1655 "Game engine controllers to process events, connecting sensors to actuators");
1657 prop = RNA_def_property(srna, "actuators", PROP_COLLECTION, PROP_NONE);
1658 RNA_def_property_struct_type(prop, "Actuator");
1659 RNA_def_property_ui_text(prop, "Actuators", "Game engine actuators to act on events");
1661 prop = RNA_def_property(srna, "properties", PROP_COLLECTION, PROP_NONE);
1662 RNA_def_property_collection_sdna(prop, NULL, "prop", NULL);
1663 RNA_def_property_struct_type(prop, "GameProperty"); /* rna_property.c */
1664 RNA_def_property_ui_text(prop, "Properties", "Game engine properties");
1666 prop = RNA_def_property(srna, "show_sensors", PROP_BOOLEAN, PROP_NONE);
1667 RNA_def_property_boolean_sdna(prop, NULL, "scaflag", OB_SHOWSENS);
1668 RNA_def_property_ui_text(prop, "Show Sensors", "Shows sensors for this object in the user interface");
1670 prop = RNA_def_property(srna, "show_controllers", PROP_BOOLEAN, PROP_NONE);
1671 RNA_def_property_boolean_sdna(prop, NULL, "scaflag", OB_SHOWCONT);
1672 RNA_def_property_ui_text(prop, "Show Controllers", "Shows controllers for this object in the user interface");
1674 prop = RNA_def_property(srna, "show_actuators", PROP_BOOLEAN, PROP_NONE);
1675 RNA_def_property_boolean_sdna(prop, NULL, "scaflag", OB_SHOWACT);
1676 RNA_def_property_ui_text(prop, "Show Actuators", "Shows actuators for this object in the user interface");
1680 prop = RNA_def_property(srna, "physics_type", PROP_ENUM, PROP_NONE);
1681 RNA_def_property_enum_sdna(prop, NULL, "body_type");
1682 RNA_def_property_enum_items(prop, body_type_items);
1683 RNA_def_property_enum_funcs(prop, "rna_GameObjectSettings_physics_type_get",
1684 "rna_GameObjectSettings_physics_type_set", NULL);
1685 RNA_def_property_ui_text(prop, "Physics Type", "Select the type of physical representation");
1686 RNA_def_property_update(prop, NC_LOGIC, NULL);
1688 prop = RNA_def_property(srna, "use_record_animation", PROP_BOOLEAN, PROP_NONE);
1689 RNA_def_property_boolean_sdna(prop, NULL, "gameflag", OB_RECORD_ANIMATION);
1690 RNA_def_property_ui_text(prop, "Record Animation", "Record animation objects without physics");
1692 prop = RNA_def_property(srna, "use_actor", PROP_BOOLEAN, PROP_NONE);
1693 RNA_def_property_boolean_sdna(prop, NULL, "gameflag", OB_ACTOR);
1694 RNA_def_property_ui_text(prop, "Actor", "Object is detected by the Near and Radar sensor");
1696 prop = RNA_def_property(srna, "use_ghost", PROP_BOOLEAN, PROP_NONE);
1697 RNA_def_property_boolean_sdna(prop, NULL, "gameflag", OB_GHOST);
1698 RNA_def_property_ui_text(prop, "Ghost", "Object does not react to collisions, like a ghost");
1700 prop = RNA_def_property(srna, "mass", PROP_FLOAT, PROP_NONE);
1701 RNA_def_property_range(prop, 0.01, 10000.0);
1702 RNA_def_property_ui_text(prop, "Mass", "Mass of the object");
1704 prop = RNA_def_property(srna, "radius", PROP_FLOAT, PROP_NONE | PROP_UNIT_LENGTH);
1705 RNA_def_property_float_sdna(prop, NULL, "inertia");
1706 RNA_def_property_range(prop, 0.01f, FLT_MAX);
1707 RNA_def_property_ui_range(prop, 0.01f, 10.0f, 1, 3);
1708 RNA_def_property_ui_text(prop, "Radius", "Radius of bounding sphere and material physics");
1709 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
1711 prop = RNA_def_property(srna, "use_sleep", PROP_BOOLEAN, PROP_NONE);
1712 RNA_def_property_boolean_sdna(prop, NULL, "gameflag", OB_COLLISION_RESPONSE);
1713 RNA_def_property_ui_text(prop, "No Sleeping", "Disable auto (de)activation in physics simulation");
1715 prop = RNA_def_property(srna, "damping", PROP_FLOAT, PROP_NONE);
1716 RNA_def_property_float_sdna(prop, NULL, "damping");
1717 RNA_def_property_range(prop, 0.0, 1.0);
1718 RNA_def_property_ui_text(prop, "Damping", "General movement damping");
1720 prop = RNA_def_property(srna, "rotation_damping", PROP_FLOAT, PROP_NONE);
1721 RNA_def_property_float_sdna(prop, NULL, "rdamping");
1722 RNA_def_property_range(prop, 0.0, 1.0);
1723 RNA_def_property_ui_text(prop, "Rotation Damping", "General rotation damping");
1725 prop = RNA_def_property(srna, "velocity_min", PROP_FLOAT, PROP_NONE);
1726 RNA_def_property_float_sdna(prop, NULL, "min_vel");
1727 RNA_def_property_range(prop, 0.0, 1000.0);
1728 RNA_def_property_ui_text(prop, "Velocity Min", "Clamp velocity to this minimum speed (except when totally still)");
1730 prop = RNA_def_property(srna, "velocity_max", PROP_FLOAT, PROP_NONE);
1731 RNA_def_property_float_sdna(prop, NULL, "max_vel");
1732 RNA_def_property_range(prop, 0.0, 1000.0);
1733 RNA_def_property_ui_text(prop, "Velocity Max", "Clamp velocity to this maximum speed");
1735 /* Character physics */
1736 prop = RNA_def_property(srna, "step_height", PROP_FLOAT, PROP_NONE);
1737 RNA_def_property_float_sdna(prop, NULL, "step_height");
1738 RNA_def_property_range(prop, 0.01, 1.0);
1739 RNA_def_property_ui_text(prop, "Step Height", "Maximum height of steps the character can run over");
1741 prop = RNA_def_property(srna, "jump_speed", PROP_FLOAT, PROP_NONE);
1742 RNA_def_property_float_sdna(prop, NULL, "jump_speed");
1743 RNA_def_property_range(prop, 0.0, 1000.0);
1744 RNA_def_property_ui_text(prop, "Jump Force", "Upward velocity applied to the character when jumping");
1746 prop = RNA_def_property(srna, "fall_speed", PROP_FLOAT, PROP_NONE);
1747 RNA_def_property_float_sdna(prop, NULL, "fall_speed");
1748 RNA_def_property_range(prop, 0.0, 1000.0);
1749 RNA_def_property_ui_text(prop, "Fall Speed Max", "Maximum speed at which the character will fall");
1751 /* Collision Masks */
1752 prop = RNA_def_property(srna, "collision_group", PROP_BOOLEAN, PROP_LAYER_MEMBER);
1753 RNA_def_property_boolean_sdna(prop, NULL, "col_group", 1);
1754 RNA_def_property_array(prop, OB_MAX_COL_MASKS);
1755 RNA_def_property_ui_text(prop, "Collision Group", "The collision group of the object");
1756 RNA_def_property_boolean_funcs(prop, "rna_GameObjectSettings_col_group_get", "rna_GameObjectSettings_col_group_set");
1758 prop = RNA_def_property(srna, "collision_mask", PROP_BOOLEAN, PROP_LAYER_MEMBER);
1759 RNA_def_property_boolean_sdna(prop, NULL, "col_mask", 1);
1760 RNA_def_property_array(prop, OB_MAX_COL_MASKS);
1761 RNA_def_property_ui_text(prop, "Collision Mask", "The groups this object can collide with");
1762 RNA_def_property_boolean_funcs(prop, "rna_GameObjectSettings_col_mask_get", "rna_GameObjectSettings_col_mask_set");
1765 prop = RNA_def_property(srna, "lock_location_x", PROP_BOOLEAN, PROP_NONE);
1766 RNA_def_property_boolean_sdna(prop, NULL, "gameflag2", OB_LOCK_RIGID_BODY_X_AXIS);
1767 RNA_def_property_ui_text(prop, "Lock X Axis", "Disable simulation of linear motion along the X axis");
1769 prop = RNA_def_property(srna, "lock_location_y", PROP_BOOLEAN, PROP_NONE);
1770 RNA_def_property_boolean_sdna(prop, NULL, "gameflag2", OB_LOCK_RIGID_BODY_Y_AXIS);
1771 RNA_def_property_ui_text(prop, "Lock Y Axis", "Disable simulation of linear motion along the Y axis");
1773 prop = RNA_def_property(srna, "lock_location_z", PROP_BOOLEAN, PROP_NONE);
1774 RNA_def_property_boolean_sdna(prop, NULL, "gameflag2", OB_LOCK_RIGID_BODY_Z_AXIS);
1775 RNA_def_property_ui_text(prop, "Lock Z Axis", "Disable simulation of linear motion along the Z axis");
1779 prop = RNA_def_property(srna, "lock_rotation_x", PROP_BOOLEAN, PROP_NONE);
1780 RNA_def_property_boolean_sdna(prop, NULL, "gameflag2", OB_LOCK_RIGID_BODY_X_ROT_AXIS);
1781 RNA_def_property_ui_text(prop, "Lock X Rotation Axis", "Disable simulation of angular motion along the X axis");
1783 prop = RNA_def_property(srna, "lock_rotation_y", PROP_BOOLEAN, PROP_NONE);
1784 RNA_def_property_boolean_sdna(prop, NULL, "gameflag2", OB_LOCK_RIGID_BODY_Y_ROT_AXIS);
1785 RNA_def_property_ui_text(prop, "Lock Y Rotation Axis", "Disable simulation of angular motion along the Y axis");
1787 prop = RNA_def_property(srna, "lock_rotation_z", PROP_BOOLEAN, PROP_NONE);
1788 RNA_def_property_boolean_sdna(prop, NULL, "gameflag2", OB_LOCK_RIGID_BODY_Z_ROT_AXIS);
1789 RNA_def_property_ui_text(prop, "Lock Z Rotation Axis", "Disable simulation of angular motion along the Z axis");
1791 /* is this used anywhere ? */
1792 prop = RNA_def_property(srna, "use_activity_culling", PROP_BOOLEAN, PROP_NONE);
1793 RNA_def_property_boolean_negative_sdna(prop, NULL, "gameflag2", OB_NEVER_DO_ACTIVITY_CULLING);
1794 RNA_def_property_ui_text(prop, "Lock Z Rotation Axis", "Disable simulation of angular motion along the Z axis");
1797 prop = RNA_def_property(srna, "use_material_physics_fh", PROP_BOOLEAN, PROP_NONE);
1798 RNA_def_property_boolean_sdna(prop, NULL, "gameflag", OB_DO_FH);
1799 RNA_def_property_ui_text(prop, "Use Material Force Field", "React to force field physics settings in materials");
1801 prop = RNA_def_property(srna, "use_rotate_from_normal", PROP_BOOLEAN, PROP_NONE);
1802 RNA_def_property_boolean_sdna(prop, NULL, "gameflag", OB_ROT_FH);
1803 RNA_def_property_ui_text(prop, "Rotate From Normal",
1804 "Use face normal to rotate object, so that it points away from the surface");
1806 prop = RNA_def_property(srna, "form_factor", PROP_FLOAT, PROP_NONE);
1807 RNA_def_property_float_sdna(prop, NULL, "formfactor");
1808 RNA_def_property_range(prop, 0.0, 1.0);
1809 RNA_def_property_ui_text(prop, "Form Factor", "Form factor scales the inertia tensor");
1811 prop = RNA_def_property(srna, "use_anisotropic_friction", PROP_BOOLEAN, PROP_NONE);
1812 RNA_def_property_boolean_sdna(prop, NULL, "gameflag", OB_ANISOTROPIC_FRICTION);
1813 RNA_def_property_ui_text(prop, "Anisotropic Friction", "Enable anisotropic friction");
1815 prop = RNA_def_property(srna, "friction_coefficients", PROP_FLOAT, PROP_NONE);
1816 RNA_def_property_float_sdna(prop, NULL, "anisotropicFriction");
1817 RNA_def_property_range(prop, 0.0, 1.0);
1818 RNA_def_property_ui_text(prop, "Friction Coefficients",
1819 "Relative friction coefficients in the in the X, Y and Z directions, "
1820 "when anisotropic friction is enabled");
1822 prop = RNA_def_property(srna, "use_collision_bounds", PROP_BOOLEAN, PROP_NONE);
1823 RNA_def_property_boolean_sdna(prop, NULL, "gameflag", OB_BOUNDS);
1824 RNA_def_property_ui_text(prop, "Use Collision Bounds", "Specify a collision bounds type other than the default");
1825 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
1827 prop = RNA_def_property(srna, "collision_bounds_type", PROP_ENUM, PROP_NONE);
1828 RNA_def_property_enum_sdna(prop, NULL, "collision_boundtype");
1829 RNA_def_property_enum_items(prop, collision_bounds_items);
1830 RNA_def_property_enum_funcs(prop, NULL, NULL, "rna_Object_collision_bounds_itemf");
1831 RNA_def_property_ui_text(prop, "Collision Bounds", "Select the collision type");
1832 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
1834 prop = RNA_def_property(srna, "use_collision_compound", PROP_BOOLEAN, PROP_NONE);
1835 RNA_def_property_boolean_sdna(prop, NULL, "gameflag", OB_CHILD);
1836 RNA_def_property_ui_text(prop, "Collision Compound", "Add children to form a compound collision object");
1838 prop = RNA_def_property(srna, "collision_margin", PROP_FLOAT, PROP_NONE | PROP_UNIT_LENGTH);
1839 RNA_def_property_float_sdna(prop, NULL, "margin");
1840 RNA_def_property_range(prop, 0.0, 1.0);
1841 RNA_def_property_ui_text(prop, "Collision Margin",
1842 "Extra margin around object for collision detection, small amount required "
1845 prop = RNA_def_property(srna, "soft_body", PROP_POINTER, PROP_NONE);
1846 RNA_def_property_pointer_sdna(prop, NULL, "bsoft");
1847 RNA_def_property_ui_text(prop, "Soft Body Settings", "Settings for Bullet soft body simulation");
1849 prop = RNA_def_property(srna, "use_obstacle_create", PROP_BOOLEAN, PROP_NONE);
1850 RNA_def_property_boolean_sdna(prop, NULL, "gameflag", OB_HASOBSTACLE);
1851 RNA_def_property_ui_text(prop, "Create obstacle", "Create representation for obstacle simulation");
1853 prop = RNA_def_property(srna, "obstacle_radius", PROP_FLOAT, PROP_NONE | PROP_UNIT_LENGTH);
1854 RNA_def_property_float_sdna(prop, NULL, "obstacleRad");
1855 RNA_def_property_range(prop, 0.0, 1000.0);
1856 RNA_def_property_ui_text(prop, "Obstacle Radius", "Radius of object representation in obstacle simulation");
1860 prop = RNA_def_property(srna, "states_visible", PROP_BOOLEAN, PROP_LAYER_MEMBER);
1861 RNA_def_property_boolean_sdna(prop, NULL, "state", 1);
1862 RNA_def_property_array(prop, OB_MAX_STATES);
1863 RNA_def_property_ui_text(prop, "State", "State determining which controllers are displayed");
1864 RNA_def_property_boolean_funcs(prop, "rna_GameObjectSettings_state_get", "rna_GameObjectSettings_state_set");
1866 prop = RNA_def_property(srna, "used_states", PROP_BOOLEAN, PROP_LAYER_MEMBER);
1867 RNA_def_property_array(prop, OB_MAX_STATES);
1868 RNA_def_property_ui_text(prop, "Used State", "States which are being used by controllers");
1869 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1870 RNA_def_property_boolean_funcs(prop, "rna_GameObjectSettings_used_state_get", NULL);
1872 prop = RNA_def_property(srna, "states_initial", PROP_BOOLEAN, PROP_NONE);
1873 RNA_def_property_boolean_sdna(prop, NULL, "init_state", 1);
1874 RNA_def_property_array(prop, OB_MAX_STATES);
1875 RNA_def_property_ui_text(prop, "Initial State", "Initial state when the game starts");
1877 prop = RNA_def_property(srna, "show_debug_state", PROP_BOOLEAN, PROP_NONE);
1878 RNA_def_property_boolean_sdna(prop, NULL, "scaflag", OB_DEBUGSTATE);
1879 RNA_def_property_ui_text(prop, "Debug State", "Print state debug info in the game engine");
1880 RNA_def_property_ui_icon(prop, ICON_INFO, 0);
1882 prop = RNA_def_property(srna, "use_all_states", PROP_BOOLEAN, PROP_NONE);
1883 RNA_def_property_boolean_sdna(prop, NULL, "scaflag", OB_ALLSTATE);
1884 RNA_def_property_ui_text(prop, "All", "Set all state bits");
1886 prop = RNA_def_property(srna, "show_state_panel", PROP_BOOLEAN, PROP_NONE);
1887 RNA_def_property_boolean_sdna(prop, NULL, "scaflag", OB_SHOWSTATE);
1888 RNA_def_property_ui_text(prop, "States", "Show state panel");
1889 RNA_def_property_ui_icon(prop, ICON_DISCLOSURE_TRI_RIGHT, 1);
1892 static void rna_def_object_constraints(BlenderRNA *brna, PropertyRNA *cprop)
1900 RNA_def_property_srna(cprop, "ObjectConstraints");
1901 srna = RNA_def_struct(brna, "ObjectConstraints", NULL);
1902 RNA_def_struct_sdna(srna, "Object");
1903 RNA_def_struct_ui_text(srna, "Object Constraints", "Collection of object constraints");
1906 /* Collection active property */
1907 prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
1908 RNA_def_property_struct_type(prop, "Constraint");
1909 RNA_def_property_pointer_funcs(prop, "rna_Object_active_constraint_get",
1910 "rna_Object_active_constraint_set", NULL, NULL);
1911 RNA_def_property_flag(prop, PROP_EDITABLE);
1912 RNA_def_property_ui_text(prop, "Active Constraint", "Active Object constraint");
1915 /* Constraint collection */
1916 func = RNA_def_function(srna, "new", "rna_Object_constraints_new");
1917 RNA_def_function_ui_description(func, "Add a new constraint to this object");
1919 parm = RNA_def_enum(func, "type", constraint_type_items, 1, "", "Constraint type to add");
1920 RNA_def_property_flag(parm, PROP_REQUIRED);
1922 parm = RNA_def_pointer(func, "constraint", "Constraint", "", "New constraint");
1923 RNA_def_function_return(func, parm);
1925 func = RNA_def_function(srna, "remove", "rna_Object_constraints_remove");
1926 RNA_def_function_ui_description(func, "Remove a constraint from this object");
1927 RNA_def_function_flag(func, FUNC_USE_REPORTS);
1928 /* constraint to remove */
1929 parm = RNA_def_pointer(func, "constraint", "Constraint", "", "Removed constraint");
1930 RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL | PROP_RNAPTR);
1931 RNA_def_property_clear_flag(parm, PROP_THICK_WRAP);
1933 func = RNA_def_function(srna, "clear", "rna_Object_constraints_clear");
1934 RNA_def_function_ui_description(func, "Remove all constraint from this object");
1937 /* object.modifiers */
1938 static void rna_def_object_modifiers(BlenderRNA *brna, PropertyRNA *cprop)
1945 RNA_def_property_srna(cprop, "ObjectModifiers");
1946 srna = RNA_def_struct(brna, "ObjectModifiers", NULL);
1947 RNA_def_struct_sdna(srna, "Object");
1948 RNA_def_struct_ui_text(srna, "Object Modifiers", "Collection of object modifiers");
1951 prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
1952 RNA_def_property_struct_type(prop, "EditBone");
1953 RNA_def_property_pointer_sdna(prop, NULL, "act_edbone");
1954 RNA_def_property_flag(prop, PROP_EDITABLE);
1955 RNA_def_property_ui_text(prop, "Active EditBone", "Armatures active edit bone");
1956 /*RNA_def_property_update(prop, 0, "rna_Armature_act_editbone_update"); */
1957 RNA_def_property_pointer_funcs(prop, NULL, "rna_Armature_act_edit_bone_set", NULL, NULL);
1960 /* RNA_def_property_collection_active(prop, prop_act); */
1964 func = RNA_def_function(srna, "new", "rna_Object_modifier_new");
1965 RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
1966 RNA_def_function_ui_description(func, "Add a new modifier");
1967 parm = RNA_def_string(func, "name", "Name", 0, "", "New name for the modifier");
1968 RNA_def_property_flag(parm, PROP_REQUIRED);
1969 /* modifier to add */
1970 parm = RNA_def_enum(func, "type", modifier_type_items, 1, "", "Modifier type to add");
1971 RNA_def_property_flag(parm, PROP_REQUIRED);
1973 parm = RNA_def_pointer(func, "modifier", "Modifier", "", "Newly created modifier");
1974 RNA_def_function_return(func, parm);
1976 /* remove modifier */
1977 func = RNA_def_function(srna, "remove", "rna_Object_modifier_remove");
1978 RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
1979 RNA_def_function_ui_description(func, "Remove an existing modifier from the object");
1980 /* modifier to remove */
1981 parm = RNA_def_pointer(func, "modifier", "Modifier", "", "Modifier to remove");
1982 RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL | PROP_RNAPTR);
1983 RNA_def_property_clear_flag(parm, PROP_THICK_WRAP);
1985 /* clear all modifiers */
1986 func = RNA_def_function(srna, "clear", "rna_Object_modifier_clear");
1987 RNA_def_function_flag(func, FUNC_USE_CONTEXT);
1988 RNA_def_function_ui_description(func, "Remove all modifiers from the object");
1991 /* object.particle_systems */
1992 static void rna_def_object_particle_systems(BlenderRNA *brna, PropertyRNA *cprop)
1998 /* FunctionRNA *func; */
1999 /* PropertyRNA *parm; */
2001 RNA_def_property_srna(cprop, "ParticleSystems");
2002 srna = RNA_def_struct(brna, "ParticleSystems", NULL);
2003 RNA_def_struct_sdna(srna, "Object");
2004 RNA_def_struct_ui_text(srna, "Particle Systems", "Collection of particle systems");
2006 prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
2007 RNA_def_property_struct_type(prop, "ParticleSystem");
2008 RNA_def_property_pointer_funcs(prop, "rna_Object_active_particle_system_get", NULL, NULL, NULL);
2009 RNA_def_property_ui_text(prop, "Active Particle System", "Active particle system being displayed");
2010 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
2012 prop = RNA_def_property(srna, "active_index", PROP_INT, PROP_UNSIGNED);
2013 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
2014 RNA_def_property_int_funcs(prop, "rna_Object_active_particle_system_index_get",
2015 "rna_Object_active_particle_system_index_set",
2016 "rna_Object_active_particle_system_index_range");
2017 RNA_def_property_ui_text(prop, "Active Particle System Index", "Index of active particle system slot");
2018 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Object_particle_update");
2022 /* object.vertex_groups */
2023 static void rna_def_object_vertex_groups(BlenderRNA *brna, PropertyRNA *cprop)
2032 RNA_def_property_srna(cprop, "VertexGroups");
2033 srna = RNA_def_struct(brna, "VertexGroups", NULL);
2034 RNA_def_struct_sdna(srna, "Object");
2035 RNA_def_struct_ui_text(srna, "Vertex Groups", "Collection of vertex groups");
2037 prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
2038 RNA_def_property_struct_type(prop, "VertexGroup");
2039 RNA_def_property_pointer_funcs(prop, "rna_Object_active_vertex_group_get",
2040 "rna_Object_active_vertex_group_set", NULL, NULL);
2041 RNA_def_property_ui_text(prop, "Active Vertex Group", "Vertex groups of the object");
2042 RNA_def_property_update(prop, NC_GEOM | ND_DATA, "rna_Object_internal_update_data");
2044 prop = RNA_def_property(srna, "active_index", PROP_INT, PROP_UNSIGNED);
2045 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
2046 RNA_def_property_int_sdna(prop, NULL, "actdef");
2047 RNA_def_property_int_funcs(prop, "rna_Object_active_vertex_group_index_get",
2048 "rna_Object_active_vertex_group_index_set",
2049 "rna_Object_active_vertex_group_index_range");
2050 RNA_def_property_ui_text(prop, "Active Vertex Group Index", "Active index in vertex group array");
2051 RNA_def_property_update(prop, NC_GEOM | ND_DATA, "rna_Object_internal_update_data");
2053 /* vertex groups */ /* add_vertex_group */
2054 func = RNA_def_function(srna, "new", "rna_Object_vgroup_new");
2055 RNA_def_function_ui_description(func, "Add vertex group to object");
2056 RNA_def_string(func, "name", "Group", 0, "", "Vertex group name"); /* optional */
2057 parm = RNA_def_pointer(func, "group", "VertexGroup", "", "New vertex group");
2058 RNA_def_function_return(func, parm);
2060 func = RNA_def_function(srna, "remove", "rna_Object_vgroup_remove");
2061 RNA_def_function_flag(func, FUNC_USE_REPORTS);
2062 RNA_def_function_ui_description(func, "Delete vertex group from object");
2063 parm = RNA_def_pointer(func, "group", "VertexGroup", "", "Vertex group to remove");
2064 RNA_def_property_flag(parm, PROP_REQUIRED | PROP_NEVER_NULL | PROP_RNAPTR);
2065 RNA_def_property_clear_flag(parm, PROP_THICK_WRAP);
2067 func = RNA_def_function(srna, "clear", "rna_Object_vgroup_clear");
2068 RNA_def_function_ui_description(func, "Delete all vertex groups from object");
2072 static void rna_def_object_lodlevel(BlenderRNA *brna)
2077 srna = RNA_def_struct(brna, "LodLevel", NULL);
2078 RNA_def_struct_sdna(srna, "LodLevel");
2080 prop = RNA_def_property(srna, "distance", PROP_FLOAT, PROP_DISTANCE);
2081 RNA_def_property_float_sdna(prop, NULL, "distance");
2082 RNA_def_property_range(prop, 0.0, FLT_MAX);
2083 RNA_def_property_ui_text(prop, "Distance", "Distance to begin using this level of detail");
2084 RNA_def_property_update(prop, NC_OBJECT | ND_LOD, "rna_Object_lod_distance_update");
2086 prop = RNA_def_property(srna, "object", PROP_POINTER, PROP_NONE);
2087 RNA_def_property_pointer_sdna(prop, NULL, "source");
2088 RNA_def_property_struct_type(prop, "Object");
2089 RNA_def_property_flag(prop, PROP_EDITABLE);
2090 RNA_def_property_ui_text(prop, "Object", "Object to use for this level of detail");
2091 RNA_def_property_update(prop, NC_OBJECT | ND_LOD, NULL);
2093 prop = RNA_def_property(srna, "use_mesh", PROP_BOOLEAN, PROP_NONE);
2094 RNA_def_property_boolean_sdna(prop, NULL, "flags", OB_LOD_USE_MESH);
2095 RNA_def_property_ui_text(prop, "Use Mesh", "Use the mesh from this object at this level of detail");
2096 RNA_def_property_ui_icon(prop, ICON_MESH_DATA, 0);
2097 RNA_def_property_update(prop, NC_OBJECT | ND_LOD, NULL);
2099 prop = RNA_def_property(srna, "use_material", PROP_BOOLEAN, PROP_NONE);
2100 RNA_def_property_boolean_sdna(prop, NULL, "flags", OB_LOD_USE_MAT);
2101 RNA_def_property_ui_text(prop, "Use Material", "Use the material from this object at this level of detail");
2102 RNA_def_property_ui_icon(prop, ICON_MATERIAL, 0);
2103 RNA_def_property_update(prop, NC_OBJECT | ND_LOD, NULL);
2107 static void rna_def_object(BlenderRNA *brna)
2112 static EnumPropertyItem up_items[] = {
2113 {OB_POSX, "X", 0, "X", ""},
2114 {OB_POSY, "Y", 0, "Y", ""},
2115 {OB_POSZ, "Z", 0, "Z", ""},
2116 {0, NULL, 0, NULL, NULL}
2119 static EnumPropertyItem drawtype_items[] = {
2120 {OB_BOUNDBOX, "BOUNDS", 0, "Bounds", "Draw the bounds of the object"},
2121 {OB_WIRE, "WIRE", 0, "Wire", "Draw the object as a wireframe"},
2122 {OB_SOLID, "SOLID", 0, "Solid", "Draw the object as a solid (if solid drawing is enabled in the viewport)"},
2123 {OB_TEXTURE, "TEXTURED", 0, "Textured",
2124 "Draw the object with textures (if textures are enabled in the viewport)"},
2125 {0, NULL, 0, NULL, NULL}
2128 static EnumPropertyItem boundtype_items[] = {
2129 {OB_BOUND_BOX, "BOX", 0, "Box", "Draw bounds as box"},
2130 {OB_BOUND_SPHERE, "SPHERE", 0, "Sphere", "Draw bounds as sphere"},
2131 {OB_BOUND_CYLINDER, "CYLINDER", 0, "Cylinder", "Draw bounds as cylinder"},
2132 {OB_BOUND_CONE, "CONE", 0, "Cone", "Draw bounds as cone"},
2133 {OB_BOUND_CAPSULE, "CAPSULE", 0, "Capsule", "Draw bounds as capsule"},
2134 {0, NULL, 0, NULL, NULL}
2138 /* XXX: this RNA enum define is currently duplicated for objects,
2139 * since there is some text here which is not applicable */
2140 static EnumPropertyItem prop_rotmode_items[] = {
2141 {ROT_MODE_QUAT, "QUATERNION", 0, "Quaternion (WXYZ)", "No Gimbal Lock"},
2142 {ROT_MODE_XYZ, "XYZ", 0, "XYZ Euler", "XYZ Rotation Order - prone to Gimbal Lock (default)"},
2143 {ROT_MODE_XZY, "XZY", 0, "XZY Euler", "XZY Rotation Order - prone to Gimbal Lock"},
2144 {ROT_MODE_YXZ, "YXZ", 0, "YXZ Euler", "YXZ Rotation Order - prone to Gimbal Lock"},
2145 {ROT_MODE_YZX, "YZX", 0, "YZX Euler", "YZX Rotation Order - prone to Gimbal Lock"},
2146 {ROT_MODE_ZXY, "ZXY", 0, "ZXY Euler", "ZXY Rotation Order - prone to Gimbal Lock"},
2147 {ROT_MODE_ZYX, "ZYX", 0, "ZYX Euler", "ZYX Rotation Order - prone to Gimbal Lock"},
2148 {ROT_MODE_AXISANGLE, "AXIS_ANGLE", 0, "Axis Angle",
2149 "Axis Angle (W+XYZ), defines a rotation around some axis defined by 3D-Vector"},
2150 {0, NULL, 0, NULL, NULL}
2153 static float default_quat[4] = {1, 0, 0, 0}; /* default quaternion values */
2154 static float default_axisAngle[4] = {0, 0, 1, 0}; /* default axis-angle rotation values */
2155 static float default_scale[3] = {1, 1, 1}; /* default scale values */
2156 static int boundbox_dimsize[] = {8, 3};
2158 srna = RNA_def_struct(brna, "Object", "ID");
2159 RNA_def_struct_ui_text(srna, "Object", "Object datablock defining an object in a scene");
2160 RNA_def_struct_clear_flag(srna, STRUCT_ID_REFCOUNT);
2161 RNA_def_struct_ui_icon(srna, ICON_OBJECT_DATA);
2163 prop = RNA_def_property(srna, "data", PROP_POINTER, PROP_NONE);
2164 RNA_def_property_struct_type(prop, "ID");
2165 RNA_def_property_pointer_funcs(prop, NULL, "rna_Object_data_set", "rna_Object_data_typef", NULL);
2166 RNA_def_property_flag(prop, PROP_EDITABLE | PROP_NEVER_UNLINK);
2167 RNA_def_property_ui_text(prop, "Data", "Object data");
2168 RNA_def_property_update(prop, 0, "rna_Object_internal_update_data");
2170 prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
2171 RNA_def_property_enum_sdna(prop, NULL, "type");
2172 RNA_def_property_enum_items(prop, object_type_items);
2173 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
2174 RNA_def_property_ui_text(prop, "Type", "Type of Object");
2176 prop = RNA_def_property(srna, "mode", PROP_ENUM, PROP_NONE);
2177 RNA_def_property_enum_sdna(prop, NULL, "mode");
2178 RNA_def_property_enum_items(prop, object_mode_items);
2179 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
2180 RNA_def_property_ui_text(prop, "Mode", "Object interaction mode");
2182 prop = RNA_def_property(srna, "layers", PROP_BOOLEAN, PROP_LAYER_MEMBER);
2183 RNA_def_property_boolean_sdna(prop, NULL, "lay", 1);
2184 RNA_def_property_array(prop, 20);
2185 RNA_def_property_ui_text(prop, "Layers", "Layers the object is on");
2186 RNA_def_property_boolean_funcs(prop, NULL, "rna_Object_layer_set");
2187 RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
2188 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Object_layer_update");
2189 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
2191 prop = RNA_def_property(srna, "layers_local_view", PROP_BOOLEAN, PROP_LAYER_MEMBER);
2192 RNA_def_property_boolean_sdna(prop, NULL, "lay", 0x01000000);
2193 RNA_def_property_array(prop, 8);
2194 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
2195 RNA_def_property_ui_text(prop, "Local View Layers", "3D local view layers the object is on");
2197 prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
2198 RNA_def_property_boolean_sdna(prop, NULL, "flag", SELECT);
2199 RNA_def_property_ui_text(prop, "Select", "Object selection state");
2200 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Object_select_update");
2202 /* for data access */
2203 prop = RNA_def_property(srna, "bound_box", PROP_FLOAT, PROP_NONE);
2204 RNA_def_property_multi_array(prop, 2, boundbox_dimsize);
2205 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
2206 RNA_def_property_float_funcs(prop, "rna_Object_boundbox_get", NULL, NULL);
2207 RNA_def_property_ui_text(prop, "Bounding Box",
2208 "Object's bounding box in object-space coordinates, all values are -1.0 when "
2212 prop = RNA_def_property(srna, "parent", PROP_POINTER, PROP_NONE);
2213 RNA_def_property_pointer_funcs(prop, NULL, "rna_Object_parent_set", NULL, NULL);
2214 RNA_def_property_flag(prop, PROP_EDITABLE | PROP_ID_SELF_CHECK);
2215 RNA_def_property_ui_text(prop, "Parent", "Parent Object");
2216 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Object_dependency_update");
2218 prop = RNA_def_property(srna, "parent_type", PROP_ENUM, PROP_NONE);
2219 RNA_def_property_enum_bitflag_sdna(prop, NULL, "partype");
2220 RNA_def_property_enum_items(prop, parent_type_items);
2221 RNA_def_property_enum_funcs(prop, NULL, "rna_Object_parent_type_set", "rna_Object_parent_type_itemf");
2222 RNA_def_property_ui_text(prop, "Parent Type", "Type of parent relation");
2223 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Object_dependency_update");
2225 prop = RNA_def_property(srna, "parent_vertices", PROP_INT, PROP_UNSIGNED);
2226 RNA_def_property_int_sdna(prop, NULL, "par1");
2227 RNA_def_property_array(prop, 3);
2228 RNA_def_property_ui_text(prop, "Parent Vertices", "Indices of vertices in case of a vertex parenting relation");
2229 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Object_internal_update");
2231 prop = RNA_def_property(srna, "parent_bone", PROP_STRING, PROP_NONE);
2232 RNA_def_property_string_sdna(prop, NULL, "parsubstr");
2233 RNA_def_property_string_funcs(prop, NULL, NULL, "rna_Object_parent_bone_set");
2234 RNA_def_property_ui_text(prop, "Parent Bone", "Name of parent bone in case of a bone parenting relation");
2235 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Object_dependency_update");
2237 /* Track and Up flags */
2238 /* XXX: these have been saved here for a bit longer (after old track was removed),
2239 * since some other tools still refer to this */
2240 prop = RNA_def_property(srna, "track_axis", PROP_ENUM, PROP_NONE);
2241 RNA_def_property_enum_sdna(prop, NULL, "trackflag");
2242 RNA_def_property_enum_items(prop, object_axis_items);
2243 RNA_def_property_ui_text(prop, "Track Axis",
2244 "Axis that points in 'forward' direction (applies to DupliFrame when "
2245 "parent 'Follow' is enabled)");
2246 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Object_internal_update");
2248 prop = RNA_def_property(srna, "up_axis", PROP_ENUM, PROP_NONE);
2249 RNA_def_property_enum_sdna(prop, NULL, "upflag");
2250 RNA_def_property_enum_items(prop, up_items);
2251 RNA_def_property_ui_text(prop, "Up Axis",
2252 "Axis that points in the upward direction (applies to DupliFrame when "
2253 "parent 'Follow' is enabled)");
2254 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Object_internal_update");
2257 prop = RNA_def_property(srna, "proxy", PROP_POINTER, PROP_NONE);
2258 RNA_def_property_ui_text(prop, "Proxy", "Library object this proxy object controls");
2260 prop = RNA_def_property(srna, "proxy_group", PROP_POINTER, PROP_NONE);
2261 RNA_def_property_ui_text(prop, "Proxy Group", "Library group duplicator object this proxy object controls");
2264 prop = RNA_def_property(srna, "material_slots", PROP_COLLECTION, PROP_NONE);
2265 RNA_def_property_collection_sdna(prop, NULL, "mat", "totcol");
2266 RNA_def_property_struct_type(prop, "MaterialSlot");
2267 /* don't dereference pointer! */
2268 RNA_def_property_collection_funcs(prop, NULL, NULL, NULL, "rna_iterator_array_get", NULL, NULL, NULL, NULL);
2269 RNA_def_property_ui_text(prop, "Material Slots", "Material slots in the object");
2271 prop = RNA_def_property(srna, "active_material", PROP_POINTER, PROP_NONE);
2272 RNA_def_property_struct_type(prop, "Material");
2273 RNA_def_property_pointer_funcs(prop, "rna_Object_active_material_get",
2274 "rna_Object_active_material_set", NULL, NULL);
2275 RNA_def_property_flag(prop, PROP_EDITABLE);
2276 RNA_def_property_editable_func(prop, "rna_Object_active_material_editable");
2277 RNA_def_property_ui_text(prop, "Active Material", "Active material being displayed");
2278 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_MaterialSlot_update");
2280 prop = RNA_def_property(srna, "active_material_index", PROP_INT, PROP_UNSIGNED);
2281 RNA_def_property_int_sdna(prop, NULL, "actcol");
2282 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
2283 RNA_def_property_int_funcs(prop, "rna_Object_active_material_index_get", "rna_Object_active_material_index_set",
2284 "rna_Object_active_material_index_range");
2285 RNA_def_property_ui_text(prop, "Active Material Index", "Index of active material slot");
2286 RNA_def_property_update(prop, NC_MATERIAL | ND_SHADING_LINKS, NULL);
2289 prop = RNA_def_property(srna, "location", PROP_FLOAT, PROP_TRANSLATION);
2290 RNA_def_property_float_sdna(prop, NULL, "loc");
2291 RNA_def_property_editable_array_func(prop, "rna_Object_location_editable");
2292 RNA_def_property_ui_text(prop, "Location", "Location of the object");
2293 RNA_def_property_ui_range(prop, -FLT_MAX, FLT_MAX, 1, RNA_TRANSLATION_PREC_DEFAULT);
2294 RNA_def_property_update(prop, NC_OBJECT | ND_TRANSFORM, "rna_Object_internal_update");
2296 prop = RNA_def_property(srna, "rotation_quaternion", PROP_FLOAT, PROP_QUATERNION);
2297 RNA_def_property_float_sdna(prop, NULL, "quat");
2298 RNA_def_property_editable_array_func(prop, "rna_Object_rotation_4d_editable");
2299 RNA_def_property_float_array_default(prop, default_quat);
2300 RNA_def_property_ui_text(prop, "Quaternion Rotation", "Rotation in Quaternions");
2301 RNA_def_property_update(prop, NC_OBJECT | ND_TRANSFORM, "rna_Object_internal_update");
2303 /* XXX: for axis-angle, it would have been nice to have 2 separate fields for UI purposes, but
2304 * having a single one is better for Keyframing and other property-management situations...
2306 prop = RNA_def_property(srna, "rotation_axis_angle", PROP_FLOAT, PROP_AXISANGLE);
2307 RNA_def_property_array(prop, 4);
2308 RNA_def_property_float_funcs(prop, "rna_Object_rotation_axis_angle_get",
2309 "rna_Object_rotation_axis_angle_set", NULL);
2310 RNA_def_property_editable_array_func(prop, "rna_Object_rotation_4d_editable");
2311 RNA_def_property_float_array_default(prop, default_axisAngle);
2312 RNA_def_property_ui_text(prop, "Axis-Angle Rotation", "Angle of Rotation for Axis-Angle rotation representation");
2313 RNA_def_property_update(prop, NC_OBJECT | ND_TRANSFORM, "rna_Object_internal_update");
2315 prop = RNA_def_property(srna, "rotation_euler", PROP_FLOAT, PROP_EULER);
2316 RNA_def_property_float_sdna(prop, NULL, "rot");
2317 RNA_def_property_editable_array_func(prop, "rna_Object_rotation_euler_editable");
2318 RNA_def_property_ui_text(prop, "Euler Rotation", "Rotation in Eulers");
2319 RNA_def_property_update(prop, NC_OBJECT | ND_TRANSFORM, "rna_Object_internal_update");
2321 prop = RNA_def_property(srna, "rotation_mode", PROP_ENUM, PROP_NONE);
2322 RNA_def_property_enum_sdna(prop, NULL, "rotmode");
2323 RNA_def_property_enum_items(prop, prop_rotmode_items); /* XXX move to using a single define of this someday */
2324 RNA_def_property_enum_funcs(prop, NULL, "rna_Object_rotation_mode_set", NULL);
2325 RNA_def_property_ui_text(prop, "Rotation Mode", "");
2326 RNA_def_property_update(prop, NC_OBJECT | ND_TRANSFORM, "rna_Object_internal_update");
2328 prop = RNA_def_property(srna, "scale", PROP_FLOAT, PROP_XYZ);
2329 RNA_def_property_float_sdna(prop, NULL, "size");
2330 RNA_def_property_flag(prop, PROP_PROPORTIONAL);
2331 RNA_def_property_editable_array_func(prop, "rna_Object_scale_editable");
2332 RNA_def_property_ui_range(prop, -FLT_MAX, FLT_MAX, 1, 3);
2333 RNA_def_property_float_array_default(prop, default_scale);
2334 RNA_def_property_ui_text(prop, "Scale", "Scaling of the object");
2335 RNA_def_property_update(prop, NC_OBJECT | ND_TRANSFORM, "rna_Object_internal_update");
2337 prop = RNA_def_property(srna, "dimensions", PROP_FLOAT, PROP_XYZ_LENGTH);
2338 RNA_def_property_array(prop, 3);
2339 RNA_def_property_float_funcs(prop, "rna_Object_dimensions_get", "rna_Object_dimensions_set", NULL);
2340 RNA_def_property_ui_range(prop, 0.0f, FLT_MAX, 1, 3);
2341 RNA_def_property_ui_text(prop, "Dimensions", "Absolute bounding box dimensions of the object");
2342 RNA_def_property_update(prop, NC_OBJECT | ND_TRANSFORM, "rna_Object_internal_update");
2345 /* delta transforms */
2346 prop = RNA_def_property(srna, "delta_location", PROP_FLOAT, PROP_TRANSLATION);
2347 RNA_def_property_float_sdna(prop, NULL, "dloc");
2348 RNA_def_property_ui_text(prop, "Delta Location", "Extra translation added to the location of the object");
2349 RNA_def_property_ui_range(prop, -FLT_MAX, FLT_MAX, 1, RNA_TRANSLATION_PREC_DEFAULT);
2350 RNA_def_property_update(prop, NC_OBJECT | ND_TRANSFORM, "rna_Object_internal_update");
2352 prop = RNA_def_property(srna, "delta_rotation_euler", PROP_FLOAT, PROP_EULER);
2353 RNA_def_property_float_sdna(prop, NULL, "drot");
2354 RNA_def_property_ui_text(prop, "Delta Rotation (Euler)",
2355 "Extra rotation added to the rotation of the object (when using Euler rotations)");
2356 RNA_def_property_update(prop, NC_OBJECT | ND_TRANSFORM, "rna_Object_internal_update");
2358 prop = RNA_def_property(srna, "delta_rotation_quaternion", PROP_FLOAT, PROP_QUATERNION);
2359 RNA_def_property_float_sdna(prop, NULL, "dquat");
2360 RNA_def_property_float_array_default(prop, default_quat);
2361 RNA_def_property_ui_text(prop, "Delta Rotation (Quaternion)",
2362 "Extra rotation added to the rotation of the object (when using Quaternion rotations)");
2363 RNA_def_property_update(prop, NC_OBJECT | ND_TRANSFORM, "rna_Object_internal_update");
2365 #if 0 /* XXX not supported well yet... */
2366 prop = RNA_def_property(srna, "delta_rotation_axis_angle", PROP_FLOAT, PROP_AXISANGLE);
2367 /* FIXME: this is not a single field any more! (drotAxis and drotAngle) */
2368 RNA_def_property_float_sdna(prop, NULL, "dquat");
2369 RNA_def_property_float_array_default(prop, default_axisAngle);
2370 RNA_def_property_ui_text(prop, "Delta Rotation (Axis Angle)",
2371 "Extra rotation added to the rotation of the object (when using Axis-Angle rotations)");
2372 RNA_def_property_update(prop, NC_OBJECT | ND_TRANSFORM, "rna_Object_internal_update");
2375 prop = RNA_def_property(srna, "delta_scale", PROP_FLOAT, PROP_XYZ);
2376 RNA_def_property_float_sdna(prop, NULL, "dscale");
2377 RNA_def_property_flag(prop, PROP_PROPORTIONAL);
2378 RNA_def_property_ui_range(prop, -FLT_MAX, FLT_MAX, 1, 3);
2379 RNA_def_property_float_array_default(prop, default_scale);
2380 RNA_def_property_ui_text(prop, "Delta Scale", "Extra scaling added to the scale of the object");
2381 RNA_def_property_update(prop, NC_OBJECT | ND_TRANSFORM, "rna_Object_internal_update");
2383 /* transform locks */
2384 prop = RNA_def_property(srna, "lock_location", PROP_BOOLEAN, PROP_NONE);
2385 RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_LOCX);
2386 RNA_def_property_array(prop, 3);
2387 RNA_def_property_ui_text(prop, "Lock Location", "Lock editing of location in the interface");
2388 RNA_def_property_ui_icon(prop, ICON_UNLOCKED, 1);
2389 RNA_def_property_update(prop, NC_OBJECT | ND_TRANSFORM, "rna_Object_internal_update");
2391 prop = RNA_def_property(srna, "lock_rotation", PROP_BOOLEAN, PROP_NONE);
2392 RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_ROTX);
2393 RNA_def_property_array(prop, 3);
2394 RNA_def_property_ui_text(prop, "Lock Rotation", "Lock editing of rotation in the interface");
2395 RNA_def_property_ui_icon(prop, ICON_UNLOCKED, 1);
2396 RNA_def_property_update(prop, NC_OBJECT | ND_TRANSFORM, "rna_Object_internal_update");
2398 /* XXX this is sub-optimal - it really should be included above,
2399 * but due to technical reasons we can't do this! */
2400 prop = RNA_def_property(srna, "lock_rotation_w", PROP_BOOLEAN, PROP_NONE);
2401 RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_ROTW);
2402 RNA_def_property_ui_icon(prop, ICON_UNLOCKED, 1);
2403 RNA_def_property_ui_text(prop, "Lock Rotation (4D Angle)",
2404 "Lock editing of 'angle' component of four-component rotations in the interface");
2405 /* XXX this needs a better name */
2406 prop = RNA_def_property(srna, "lock_rotations_4d", PROP_BOOLEAN, PROP_NONE);
2407 RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_ROT4D);
2408 RNA_def_property_ui_text(prop, "Lock Rotations (4D)",
2409 "Lock editing of four component rotations by components (instead of as Eulers)");
2411 prop = RNA_def_property(srna, "lock_scale", PROP_BOOLEAN, PROP_NONE);
2412 RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_SCALEX);
2413 RNA_def_property_array(prop, 3);
2414 RNA_def_property_ui_text(prop, "Lock Scale", "Lock editing of scale in the interface");
2415 RNA_def_property_ui_icon(prop, ICON_UNLOCKED, 1);
2416 RNA_def_property_update(prop, NC_OBJECT | ND_TRANSFORM, "rna_Object_internal_update");
2419 prop = RNA_def_property(srna, "matrix_world", PROP_FLOAT, PROP_MATRIX);
2420 RNA_def_property_float_sdna(prop, NULL, "obmat");
2421 RNA_def_property_multi_array(prop, 2, rna_matrix_dimsize_4x4);
2422 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
2423 RNA_def_property_ui_text(prop, "Matrix World", "Worldspace transformation matrix");
2424 RNA_def_property_update(prop, NC_OBJECT | ND_TRANSFORM, "rna_Object_matrix_world_update");
2426 prop = RNA_def_property(srna, "matrix_local", PROP_FLOAT, PROP_MATRIX);
2427 RNA_def_property_multi_array(prop, 2, rna_matrix_dimsize_4x4);
2428 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
2429 RNA_def_property_ui_text(prop, "Local Matrix", "Parent relative transformation matrix");
2430 RNA_def_property_float_funcs(prop, "rna_Object_matrix_local_get", "rna_Object_matrix_local_set", NULL);
2431 RNA_def_property_update(prop, NC_OBJECT | ND_TRANSFORM, NULL);
2433 prop = RNA_def_property(srna, "matrix_basis", PROP_FLOAT, PROP_MATRIX);
2434 RNA_def_property_multi_array(prop, 2, rna_matrix_dimsize_4x4);
2435 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
2436 RNA_def_property_ui_text(prop, "Input Matrix",
2437 "Matrix access to location, rotation and scale (including deltas), "
2438 "before constraints and parenting are applied");
2439 RNA_def_property_float_funcs(prop, "rna_Object_matrix_basis_get", "rna_Object_matrix_basis_set", NULL);
2440 RNA_def_property_update(prop, NC_OBJECT | ND_TRANSFORM, "rna_Object_internal_update");
2443 prop = RNA_def_property(srna, "matrix_parent_inverse", PROP_FLOAT, PROP_MATRIX);
2444 RNA_def_property_float_sdna(prop, NULL, "parentinv");
2445 RNA_def_property_multi_array(prop, 2, rna_matrix_dimsize_4x4);
2446 RNA_def_property_ui_text(prop, "Matrix", "Inverse of object's parent matrix at time of parenting");
2447 RNA_def_property_update(prop, NC_OBJECT | ND_TRANSFORM, "rna_Object_internal_update");
2450 prop = RNA_def_property(srna, "modifiers", PROP_COLLECTION, PROP_NONE);
2451 RNA_def_property_struct_type(prop, "Modifier");
2452 RNA_def_property_ui_text(prop, "Modifiers", "Modifiers affecting the geometric data of the object");
2453 rna_def_object_modifiers(brna, prop);
2456 prop = RNA_def_property(srna, "constraints", PROP_COLLECTION, PROP_NONE);
2457 RNA_def_property_struct_type(prop, "Constraint");
2458 RNA_def_property_ui_text(prop, "Constraints", "Constraints affecting the transformation of the object");
2459 /* RNA_def_property_collection_funcs(prop, NULL, NULL, NULL, NULL, NULL, NULL, NULL, "constraints__add", "constraints__remove"); */
2460 rna_def_object_constraints(brna, prop);
2463 prop = RNA_def_property(srna, "game", PROP_POINTER, PROP_NONE);
2464 RNA_def_property_flag(prop, PROP_NEVER_NULL);
2465 RNA_def_property_struct_type(prop, "GameObjectSettings");
2466 RNA_def_property_pointer_funcs(prop, "rna_Object_game_settings_get", NULL, NULL, NULL);
2467 RNA_def_property_ui_text(prop, "Game Settings", "Game engine related settings for the object");
2470 prop = RNA_def_property(srna, "vertex_groups", PROP_COLLECTION, PROP_NONE);
2471 RNA_def_property_collection_sdna(prop, NULL, "defbase", NULL);
2472 RNA_def_property_struct_type(prop, "VertexGroup");
2473 RNA_def_property_ui_text(prop, "Vertex Groups", "Vertex groups of the object");
2474 rna_def_object_vertex_groups(brna, prop);
2477 prop = RNA_def_property(srna, "empty_draw_type", PROP_ENUM, PROP_NONE);
2478 RNA_def_property_enum_sdna(prop, NULL, "empty_drawtype");
2479 RNA_def_property_enum_items(prop, object_empty_drawtype_items);
2480 RNA_def_property_enum_funcs(prop, NULL, "rna_Object_empty_draw_type_set", NULL);
2481 RNA_def_property_ui_text(prop, "Empty Display Type", "Viewport display style for empties");
2482 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
2484 prop = RNA_def_property(srna, "empty_draw_size", PROP_FLOAT, PROP_DISTANCE);
2485 RNA_def_property_float_sdna(prop, NULL, "empty_drawsize");
2486 RNA_def_property_range(prop, 0.0001f, 1000.0f);
2487 RNA_def_property_ui_range(prop, 0.01, 100, 1, 2);
2488 RNA_def_property_ui_text(prop, "Empty Display Size", "Size of display for empties in the viewport");
2489 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
2491 prop = RNA_def_property(srna, "empty_image_offset", PROP_FLOAT, PROP_NONE);
2492 RNA_def_property_float_sdna(prop, NULL, "ima_ofs");
2493 RNA_def_property_ui_text(prop, "Origin Offset", "Origin offset distance");
2494 RNA_def_property_ui_range(prop, -FLT_MAX, FLT_MAX, 0.1f, 2);
2495 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
2497 prop = RNA_def_property(srna, "image_user", PROP_POINTER, PROP_NONE);
2498 RNA_def_property_flag(prop, PROP_NEVER_NULL);
2499 RNA_def_property_pointer_sdna(prop, NULL, "iuser");
2500 RNA_def_property_ui_text(prop, "Image User",
2501 "Parameters defining which layer, pass and frame of the image is displayed");
2502 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
2505 prop = RNA_def_property(srna, "pass_index", PROP_INT, PROP_UNSIGNED);
2506 RNA_def_property_int_sdna(prop, NULL, "index");
2507 RNA_def_property_ui_text(prop, "Pass Index", "Index number for the IndexOB render pass");
2508 RNA_def_property_update(prop, NC_OBJECT, "rna_Object_internal_update");
2510 prop = RNA_def_property(srna, "color", PROP_FLOAT, PROP_COLOR);
2511 RNA_def_property_float_sdna(prop, NULL, "col");
2512 RNA_def_property_ui_text(prop, "Color", "Object color and alpha, used when faces have the ObColor mode enabled");
2513 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
2516 prop = RNA_def_property(srna, "field", PROP_POINTER, PROP_NONE);
2517 RNA_def_property_pointer_sdna(prop, NULL, "pd");
2518 RNA_def_property_struct_type(prop, "FieldSettings");
2519 RNA_def_property_pointer_funcs(prop, "rna_Object_field_get", NULL, NULL, NULL);
2520 RNA_def_property_ui_text(prop, "Field Settings", "Settings for using the object as a field in physics simulation");
2522 prop = RNA_def_property(srna, "collision", PROP_POINTER, PROP_NONE);
2523 RNA_def_property_pointer_sdna(prop, NULL, "pd");
2524 RNA_def_property_struct_type(prop, "CollisionSettings");
2525 RNA_def_property_pointer_funcs(prop, "rna_Object_collision_get", NULL, NULL, NULL);
2526 RNA_def_property_ui_text(prop, "Collision Settings",
2527 "Settings for using the object as a collider in physics simulation");
2529 prop = RNA_def_property(srna, "soft_body", PROP_POINTER, PROP_NONE);
2530 RNA_def_property_pointer_sdna(prop, NULL, "soft");
2531 RNA_def_property_struct_type(prop, "SoftBodySettings");
2532 RNA_def_property_ui_text(prop, "Soft Body Settings", "Settings for soft body simulation");
2534 prop = RNA_def_property(srna, "particle_systems", PROP_COLLECTION, PROP_NONE);
2535 RNA_def_property_collection_sdna(prop, NULL, "particlesystem", NULL);
2536 RNA_def_property_struct_type(prop, "ParticleSystem");
2537 RNA_def_property_ui_text(prop, "Particle Systems", "Particle systems emitted from the object");
2538 rna_def_object_particle_systems(brna, prop);
2541 prop = RNA_def_property(srna, "rigid_body", PROP_POINTER, PROP_NONE);
2542 RNA_def_property_pointer_sdna(prop, NULL, "rigidbody_object");
2543 RNA_def_property_struct_type(prop, "RigidBodyObject");
2544 RNA_def_property_ui_text(prop, "Rigid Body Settings", "Settings for rigid body simulation");
2546 prop = RNA_def_property(srna, "rigid_body_constraint", PROP_POINTER, PROP_NONE);
2547 RNA_def_property_pointer_sdna(prop, NULL, "rigidbody_constraint");
2548 RNA_def_property_struct_type(prop, "RigidBodyConstraint");
2549 RNA_def_property_ui_text(prop, "Rigid Body Constraint", "Constraint constraining rigid bodies");
2552 prop = RNA_def_property(srna, "hide", PROP_BOOLEAN, PROP_NONE);
2553 RNA_def_property_boolean_sdna(prop, NULL, "restrictflag", OB_RESTRICT_VIEW);
2554 RNA_def_property_ui_text(prop, "Restrict View", "Restrict visibility in the viewport");
2555 RNA_def_property_ui_icon(prop, ICON_RESTRICT_VIEW_OFF, 1);
2556 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Object_hide_update");
2558 prop = RNA_def_property(srna, "hide_select", PROP_BOOLEAN, PROP_NONE);
2559 RNA_def_property_boolean_sdna(prop, NULL, "restrictflag", OB_RESTRICT_SELECT);
2560 RNA_def_property_ui_text(prop, "Restrict Select", "Restrict selection in the viewport");
2561 RNA_def_property_ui_icon(prop, ICON_RESTRICT_SELECT_OFF, 1);
2562 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
2564 prop = RNA_def_property(srna, "hide_render", PROP_BOOLEAN, PROP_NONE);
2565 RNA_def_property_boolean_sdna(prop, NULL, "restrictflag", OB_RESTRICT_RENDER);
2566 RNA_def_property_ui_text(prop, "Restrict Render", "Restrict renderability");
2567 RNA_def_property_ui_icon(prop, ICON_RESTRICT_RENDER_OFF, 1);
2568 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Object_hide_update");
2571 rna_def_animdata_common(srna);
2573 rna_def_animviz_common(srna);
2574 rna_def_motionpath_common(srna);
2576 /* slow parenting */
2577 /* XXX: evil old crap */
2578 prop = RNA_def_property(srna, "use_slow_parent", PROP_BOOLEAN, PROP_NONE);
2579 RNA_def_property_boolean_sdna(prop, NULL, "partype", PARSLOW);
2580 RNA_def_property_ui_text(prop, "Slow Parent",
2581 "Create a delay in the parent relationship (beware: this isn't renderfarm "
2582 "safe and may be invalid after jumping around the timeline)");
2583 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Object_internal_update");
2585 prop = RNA_def_property(srna, "slow_parent_offset", PROP_FLOAT, PROP_NONE | PROP_UNIT_TIME);
2586 RNA_def_property_float_sdna(prop, NULL, "sf");
2587 RNA_def_property_range(prop, MINAFRAMEF, MAXFRAMEF);
2588 RNA_def_property_ui_text(prop, "Slow Parent Offset", "Delay in the parent relationship");
2589 RNA_def_property_update(prop, NC_OBJECT | ND_TRANSFORM, "rna_Object_internal_update");
2591 /* depsgraph hack */
2592 prop = RNA_def_property(srna, "use_extra_recalc_object", PROP_BOOLEAN, PROP_NONE);
2593 RNA_def_property_boolean_sdna(prop, NULL, "depsflag", OB_DEPS_EXTRA_OB_RECALC);
2594 RNA_def_property_ui_text(prop, "Extra Object Update", "Refresh this object again on frame changes, dependency graph hack");
2596 prop = RNA_def_property(srna, "use_extra_recalc_data", PROP_BOOLEAN, PROP_NONE);
2597 RNA_def_property_boolean_sdna(prop, NULL, "depsflag", OB_DEPS_EXTRA_DATA_RECALC);
2598 RNA_def_property_ui_text(prop, "Extra Data Update", "Refresh this object's data again on frame changes, dependency graph hack");
2601 prop = RNA_def_property(srna, "dupli_type", PROP_ENUM, PROP_NONE);
2602 RNA_def_property_enum_bitflag_sdna(prop, NULL, "transflag");
2603 RNA_def_property_enum_items(prop, dupli_items);
2604 RNA_def_property_ui_text(prop, "Dupli Type", "If not None, object duplication method to use");
2605 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Object_dependency_update");
2607 prop = RNA_def_property(srna, "use_dupli_frames_speed", PROP_BOOLEAN, PROP_NONE);
2608 RNA_def_property_boolean_negative_sdna(prop, NULL, "transflag", OB_DUPLINOSPEED);
2609 RNA_def_property_ui_text(prop, "Dupli Frames Speed",
2610 "Set dupliframes to use the current frame instead of parent curve's evaluation time");
2611 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Object_internal_update");
2613 prop = RNA_def_property(srna, "use_dupli_vertices_rotation", PROP_BOOLEAN, PROP_NONE);
2614 RNA_def_property_boolean_sdna(prop, NULL, "transflag", OB_DUPLIROT);
2615 RNA_def_property_ui_text(prop, "Dupli Verts Rotation", "Rotate dupli according to vertex normal");
2616 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
2618 prop = RNA_def_property(srna, "use_dupli_faces_scale", PROP_BOOLEAN, PROP_NONE);
2619 RNA_def_property_boolean_sdna(prop, NULL, "transflag", OB_DUPLIFACES_SCALE);
2620 RNA_def_property_ui_text(prop, "Dupli Faces Inherit Scale", "Scale dupli based on face size");
2621 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Object_internal_update");
2623 prop = RNA_def_property(srna, "dupli_faces_scale", PROP_FLOAT, PROP_NONE);
2624 RNA_def_property_float_sdna(prop, NULL, "dupfacesca");
2625 RNA_def_property_range(prop, 0.001f, 10000.0f);
2626 RNA_def_property_ui_text(prop, "Dupli Faces Scale", "Scale the DupliFace objects");
2627 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Object_internal_update");
2629 prop = RNA_def_property(srna, "dupli_group", PROP_POINTER, PROP_NONE);
2630 RNA_def_property_pointer_sdna(prop, NULL, "dup_group");
2631 RNA_def_property_flag(prop, PROP_EDITABLE);
2632 RNA_def_property_pointer_funcs(prop, NULL, "rna_Object_dup_group_set", NULL, NULL);
2633 RNA_def_property_ui_text(prop, "Dupli Group", "Instance an existing group");
2634 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Object_dependency_update");
2636 prop = RNA_def_property(srna, "dupli_frames_start", PROP_INT, PROP_NONE | PROP_UNIT_TIME);
2637 RNA_def_property_int_sdna(prop, NULL, "dupsta");
2638 RNA_def_property_range(prop, MINAFRAME, MAXFRAME);
2639 RNA_def_property_ui_text(prop, "Dupli Frames Start", "Start frame for DupliFrames");
2640 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Object_internal_update");
2642 prop = RNA_def_property(srna, "dupli_frames_end", PROP_INT, PROP_NONE | PROP_UNIT_TIME);
2643 RNA_def_property_int_sdna(prop, NULL, "dupend");
2644 RNA_def_property_range(prop, MINAFRAME, MAXFRAME);
2645 RNA_def_property_ui_text(prop, "Dupli Frames End", "End frame for DupliFrames");
2646 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Object_internal_update");
2648 prop = RNA_def_property(srna, "dupli_frames_on", PROP_INT, PROP_NONE | PROP_UNIT_TIME);
2649 RNA_def_property_int_sdna(prop, NULL, "dupon");
2650 RNA_def_property_range(prop, MINFRAME, MAXFRAME);
2651 RNA_def_property_ui_range(prop, 1, 1500, 1, -1);
2652 RNA_def_property_ui_text(prop, "Dupli Frames On", "Number of frames to use between DupOff frames");
2653 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Object_internal_update");
2655 prop = RNA_def_property(srna, "dupli_frames_off", PROP_INT, PROP_NONE | PROP_UNIT_TIME);
2656 RNA_def_property_int_sdna(prop, NULL, "dupoff");
2657 RNA_def_property_range(prop, 0, MAXFRAME);
2658 RNA_def_property_ui_range(prop, 0, 1500, 1, -1);
2659 RNA_def_property_ui_text(prop, "Dupli Frames Off", "Recurring frames to exclude from the Dupliframes");
2660 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Object_internal_update");
2662 prop = RNA_def_property(srna, "dupli_list", PROP_COLLECTION, PROP_NONE);
2663 RNA_def_property_collection_sdna(prop, NULL, "duplilist", NULL);
2664 RNA_def_property_struct_type(prop, "DupliObject");
2665 RNA_def_property_ui_text(prop, "Dupli list", "Object duplis");
2667 prop = RNA_def_property(srna, "is_duplicator", PROP_BOOLEAN, PROP_NONE);
2668 RNA_def_property_boolean_sdna(prop, NULL, "transflag", OB_DUPLI);
2669 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
2672 prop = RNA_def_property(srna, "draw_type", PROP_ENUM, PROP_NONE);
2673 RNA_def_property_enum_sdna(prop, NULL, "dt");
2674 RNA_def_property_enum_items(prop, drawtype_items);
2675 RNA_def_property_ui_text(prop, "Maximum Draw Type", "Maximum draw type to display object with in viewport");
2676 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Object_internal_update");
2678 prop = RNA_def_property(srna, "show_bounds", PROP_BOOLEAN, PROP_NONE);
2679 RNA_def_property_boolean_sdna(prop, NULL, "dtx", OB_DRAWBOUNDOX);
2680 RNA_def_property_ui_text(prop, "Draw Bounds", "Display the object's bounds");
2681 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
2683 prop = RNA_def_property(srna, "draw_bounds_type", PROP_ENUM, PROP_NONE);
2684 RNA_def_property_enum_sdna(prop, NULL, "boundtype");
2685 RNA_def_property_enum_items(prop, boundtype_items);
2686 RNA_def_property_ui_text(prop, "Draw Bounds Type", "Object boundary display type");
2687 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
2689 prop = RNA_def_property(srna, "show_name", PROP_BOOLEAN, PROP_NONE);
2690 RNA_def_property_boolean_sdna(prop, NULL, "dtx", OB_DRAWNAME);
2691 RNA_def_property_ui_text(prop, "Draw Name", "Display the object's name");
2692 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
2694 prop = RNA_def_property(srna, "show_axis", PROP_BOOLEAN, PROP_NONE);
2695 RNA_def_property_boolean_sdna(prop, NULL, "dtx", OB_AXIS);
2696 RNA_def_property_ui_text(prop, "Draw Axes", "Display the object's origin and axes");
2697 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
2699 prop = RNA_def_property(srna, "show_texture_space", PROP_BOOLEAN, PROP_NONE);
2700 RNA_def_property_boolean_sdna(prop, NULL, "dtx", OB_TEXSPACE);
2701 RNA_def_property_ui_text(prop, "Draw Texture Space", "Display the object's texture space");
2702 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
2704 prop = RNA_def_property(srna, "show_wire", PROP_BOOLEAN, PROP_NONE);
2705 RNA_def_property_boolean_sdna(prop, NULL, "dtx", OB_DRAWWIRE);
2706 RNA_def_property_ui_text(prop, "Draw Wire", "Add the object's wireframe over solid drawing");
2707 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
2709 prop = RNA_def_property(srna, "show_all_edges", PROP_BOOLEAN, PROP_NONE);
2710 RNA_def_property_boolean_sdna(prop, NULL, "dtx", OB_DRAW_ALL_EDGES);
2711 RNA_def_property_ui_text(prop, "Draw All Edges", "Display all edges for mesh objects");
2712 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
2714 prop = RNA_def_property(srna, "show_transparent", PROP_BOOLEAN, PROP_NONE);
2715 RNA_def_property_boolean_sdna(prop, NULL, "dtx", OB_DRAWTRANSP);
2716 RNA_def_property_ui_text(prop, "Draw Transparent",
2717 "Display material transparency in the object (unsupported for duplicator drawing)");
2718 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
2720 prop = RNA_def_property(srna, "show_x_ray", PROP_BOOLEAN, PROP_NONE);
2721 RNA_def_property_boolean_sdna(prop, NULL, "dtx", OB_DRAWXRAY);
2722 RNA_def_property_ui_text(prop, "X-Ray",
2723 "Make the object draw in front of others (unsupported for duplicator drawing)");
2724 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
2727 prop = RNA_def_property(srna, "grease_pencil", PROP_POINTER, PROP_NONE);
2728 RNA_def_property_pointer_sdna(prop, NULL, "gpd");
2729 RNA_def_property_flag(prop, PROP_EDITABLE);
2730 RNA_def_property_struct_type(prop, "GreasePencil");
2731 RNA_def_property_ui_text(prop, "Grease Pencil Data", "Grease Pencil datablock");
2732 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
2735 prop = RNA_def_property(srna, "pose_library", PROP_POINTER, PROP_NONE);
2736 RNA_def_property_pointer_sdna(prop, NULL, "poselib");
2737 RNA_def_property_flag(prop, PROP_EDITABLE);
2738 RNA_def_property_struct_type(prop, "Action");
2739 RNA_def_property_ui_text(prop, "Pose Library", "Action used as a pose library for armatures");
2741 prop = RNA_def_property(srna, "pose", PROP_POINTER, PROP_NONE);
2742 RNA_def_property_pointer_sdna(prop, NULL, "pose");
2743 RNA_def_property_struct_type(prop, "Pose");
2744 RNA_def_property_ui_text(prop, "Pose", "Current pose for armatures");
2747 prop = RNA_def_property(srna, "show_only_shape_key", PROP_BOOLEAN, PROP_NONE);
2748 RNA_def_property_boolean_sdna(prop, NULL, "shapeflag", OB_SHAPE_LOCK);
2749 RNA_def_property_ui_text(prop, "Shape Key Lock", "Always show the current Shape for this Object");
2750 RNA_def_property_ui_icon(prop, ICON_UNPINNED, 1);
2751 RNA_def_property_update(prop, 0, "rna_Object_internal_update_data");
2753 prop = RNA_def_property(srna, "use_shape_key_edit_mode", PROP_BOOLEAN, PROP_NONE);
2754 RNA_def_property_boolean_sdna(prop, NULL, "shapeflag", OB_SHAPE_EDIT_MODE);
2755 RNA_def_property_ui_text(prop, "Shape Key Edit Mode", "Apply shape keys in edit mode (for Meshes only)");
2756 RNA_def_property_ui_icon(prop, ICON_EDITMODE_HLT, 0);
2757 RNA_def_property_update(prop, 0, "rna_Object_internal_update_data");
2759 prop = RNA_def_property(srna, "active_shape_key", PROP_POINTER, PROP_NONE);
2760 RNA_def_property_struct_type(prop, "ShapeKey");
2761 RNA_def_property_pointer_funcs(prop, "rna_Object_active_shape_key_get", NULL, NULL, NULL);
2762 RNA_def_property_ui_text(prop, "Active Shape Key", "Current shape key");
2764 prop = RNA_def_property(srna, "active_shape_key_index", PROP_INT, PROP_NONE);
2765 RNA_def_property_int_sdna(prop, NULL, "shapenr");
2766 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE); /* XXX this is really unpredictable... */
2767 RNA_def_property_int_funcs(prop, "rna_Object_active_shape_key_index_get", "rna_Object_active_shape_key_index_set",
2768 "rna_Object_active_shape_key_index_range");
2769 RNA_def_property_ui_text(prop, "Active Shape Key Index", "Current shape key index");
2770 RNA_def_property_update(prop, 0, "rna_Object_active_shape_update");
2773 prop = RNA_def_property(srna, "use_dynamic_topology_sculpting", PROP_BOOLEAN, PROP_NONE);
2774 RNA_def_property_boolean_funcs(prop, "rna_Object_use_dynamic_topology_sculpting_get", NULL);
2775 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
2776 RNA_def_property_ui_text(prop, "Dynamic Topology Sculpting", NULL);
2778 /* Levels of Detail */
2779 prop = RNA_def_property(srna, "lod_levels", PROP_COLLECTION, PROP_NONE);
2780 RNA_def_property_collection_sdna(prop, NULL, "lodlevels", NULL);
2781 RNA_def_property_struct_type(prop, "LodLevel");
2782 RNA_def_property_ui_text(prop, "Level of Detail Levels", "A collection of detail levels to automatically switch between");
2783 RNA_def_property_update(prop, NC_OBJECT | ND_LOD, NULL);
2785 RNA_api_object(srna);
2788 static void rna_def_dupli_object(BlenderRNA *brna)
2793 srna = RNA_def_struct(brna, "DupliObject", NULL);
2794 RNA_def_struct_sdna(srna, "DupliObject");
2795 RNA_def_struct_ui_text(srna, "Object Duplicate", "An object duplicate");
2796 /* RNA_def_struct_ui_icon(srna, ICON_OBJECT_DATA); */
2798 prop = RNA_def_property(srna, "object", PROP_POINTER, PROP_NONE);
2799 RNA_def_property_pointer_sdna(prop, NULL, "ob");
2800 /* RNA_def_property_pointer_funcs(prop, "rna_DupliObject_object_get", NULL, NULL, NULL); */
2801 RNA_def_property_ui_text(prop, "Object", "Object being duplicated");
2803 prop = RNA_def_property(srna, "matrix", PROP_FLOAT, PROP_MATRIX);
2804 RNA_def_property_float_sdna(prop, NULL, "mat");
2805 RNA_def_property_multi_array(prop, 2, rna_matrix_dimsize_4x4);
2806 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE | PROP_EDITABLE);
2807 RNA_def_property_ui_text(prop, "Object Duplicate Matrix", "Object duplicate transformation matrix");
2809 prop = RNA_def_property(srna, "hide", PROP_BOOLEAN, PROP_NONE);
2810 RNA_def_property_boolean_sdna(prop, NULL, "no_draw", 0);
2811 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE | PROP_EDITABLE);
2812 RNA_def_property_ui_text(prop, "Hide", "Don't show dupli object in viewport or render");
2814 prop = RNA_def_property(srna, "index", PROP_INT, PROP_NONE);
2815 RNA_def_property_int_funcs(prop, "rna_DupliObject_index_get", NULL, NULL);
2816 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE | PROP_EDITABLE);
2817 RNA_def_property_ui_text(prop, "Index", "Index in the lowest-level dupli list");
2819 prop = RNA_def_property(srna, "persistent_id", PROP_INT, PROP_NONE);
2820 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE | PROP_EDITABLE);
2821 RNA_def_property_ui_text(prop, "Persistent ID", "Persistent identifier for inter-frame matching of objects with motion blur");
2823 prop = RNA_def_property(srna, "particle_system", PROP_POINTER, PROP_NONE);
2824 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE | PROP_EDITABLE);
2825 RNA_def_property_ui_text(prop, "Particle System", "Particle system that this dupli object was instanced from");
2827 prop = RNA_def_property(srna, "orco", PROP_FLOAT, PROP_TRANSLATION);
2828 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE | PROP_EDITABLE);
2829 RNA_def_property_ui_text(prop, "Generated Coordinates", "Generated coordinates in parent object space");
2831 prop = RNA_def_property(srna, "uv", PROP_FLOAT, PROP_NONE);
2832 RNA_def_property_array(prop, 2);
2833 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE | PROP_EDITABLE);
2834 RNA_def_property_ui_text(prop, "UV Coordinates", "UV coordinates in parent object space");
2836 prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
2837 RNA_def_property_enum_items(prop, dupli_items);
2838 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE | PROP_EDITABLE);
2839 RNA_def_property_ui_text(prop, "Dupli Type", "Duplicator type that generated this dupli object");
2842 static void rna_def_object_base(BlenderRNA *brna)
2847 srna = RNA_def_struct(brna, "ObjectBase", NULL);
2848 RNA_def_struct_sdna(srna, "Base");
2849 RNA_def_struct_ui_text(srna, "Object Base", "An object instance in a scene");
2850 RNA_def_struct_ui_icon(srna, ICON_OBJECT_DATA);
2852 prop = RNA_def_property(srna, "object", PROP_POINTER, PROP_NONE);
2853 RNA_def_property_pointer_sdna(prop, NULL, "object");
2854 RNA_def_property_ui_text(prop, "Object", "Object this base links to");
2856 /* same as object layer */
2857 prop = RNA_def_property(srna, "layers", PROP_BOOLEAN, PROP_LAYER_MEMBER);
2858 RNA_def_property_boolean_sdna(prop, NULL, "lay", 1);
2859 RNA_def_property_array(prop, 20);
2860 RNA_def_property_ui_text(prop, "Layers", "Layers the object base is on");
2861 RNA_def_property_boolean_funcs(prop, NULL, "rna_Base_layer_set");
2862 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Base_layer_update");
2864 prop = RNA_def_property(srna, "layers_local_view", PROP_BOOLEAN, PROP_LAYER_MEMBER);
2865 RNA_def_property_boolean_sdna(prop, NULL, "lay", 0x01000000);
2866 RNA_def_property_array(prop, 8);
2867 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
2868 RNA_def_property_ui_text(prop, "Local View Layers", "3D local view layers the object base is on");
2870 prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
2871 RNA_def_property_boolean_sdna(prop, NULL, "flag", BA_SELECT);
2872 RNA_def_property_ui_text(prop, "Select", "Object base selection state");
2873 RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Base_select_update");
2875 RNA_api_object_base(srna);
2878 void RNA_def_object(BlenderRNA *brna)
2880 rna_def_object(brna);
2882 RNA_define_animate_sdna(false);
2883 rna_def_object_game_settings(brna);
2884 rna_def_object_base(brna);
2885 rna_def_vertex_group(brna);
2886 rna_def_material_slot(brna);
2887 rna_def_dupli_object(brna);
2888 RNA_define_animate_sdna(true);
2889 rna_def_object_lodlevel(brna);