4 * ***** BEGIN GPL LICENSE BLOCK *****
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 * Contributor(s): Blender Foundation (2008).
22 * ***** END GPL LICENSE BLOCK *****
25 /** \file blender/makesrna/intern/rna_object.c
33 #include "RNA_access.h"
34 #include "RNA_define.h"
35 #include "RNA_enum_types.h"
37 #include "rna_internal.h"
39 #include "DNA_action_types.h"
40 #include "DNA_customdata_types.h"
41 #include "DNA_controller_types.h"
42 #include "DNA_group_types.h"
43 #include "DNA_material_types.h"
44 #include "DNA_mesh_types.h"
45 #include "DNA_object_force.h"
46 #include "DNA_object_types.h"
47 #include "DNA_property_types.h"
48 #include "DNA_scene_types.h"
49 #include "DNA_meta_types.h"
51 #include "BKE_tessmesh.h"
52 #include "BKE_group.h" /* needed for object_in_group() */
54 #include "BLO_sys_types.h" /* needed for intptr_t used in ED_mesh.h */
60 EnumPropertyItem object_mode_items[] = {
61 {OB_MODE_OBJECT, "OBJECT", ICON_OBJECT_DATAMODE, "Object", ""},
62 {OB_MODE_EDIT, "EDIT", ICON_EDITMODE_HLT, "Edit", ""},
63 {OB_MODE_SCULPT, "SCULPT", ICON_SCULPTMODE_HLT, "Sculpt", ""},
64 {OB_MODE_VERTEX_PAINT, "VERTEX_PAINT", ICON_VPAINT_HLT, "Vertex Paint", ""},
65 {OB_MODE_WEIGHT_PAINT, "WEIGHT_PAINT", ICON_WPAINT_HLT, "Weight Paint", ""},
66 {OB_MODE_TEXTURE_PAINT, "TEXTURE_PAINT", ICON_TPAINT_HLT, "Texture Paint", ""},
67 {OB_MODE_PARTICLE_EDIT, "PARTICLE_EDIT", ICON_PARTICLEMODE, "Particle Edit", ""},
68 {OB_MODE_POSE, "POSE", ICON_POSE_HLT, "Pose", ""},
69 {0, NULL, 0, NULL, NULL}};
71 static EnumPropertyItem parent_type_items[] = {
72 {PAROBJECT, "OBJECT", 0, "Object", "The object is parented to an object"},
73 {PARCURVE, "CURVE", 0, "Curve", "The object is parented to a curve"},
74 {PARKEY, "KEY", 0, "Key", ""},
75 {PARSKEL, "ARMATURE", 0, "Armature", ""},
76 {PARSKEL, "LATTICE", 0, "Lattice", "The object is parented to a lattice"}, // PARSKEL reuse will give issues
77 {PARVERT1, "VERTEX", 0, "Vertex", "The object is parented to a vertex"},
78 {PARVERT3, "VERTEX_3", 0, "3 Vertices", ""},
79 {PARBONE, "BONE", 0, "Bone", "The object is parented to a bone"},
80 {0, NULL, 0, NULL, NULL}};
82 static EnumPropertyItem collision_bounds_items[] = {
83 {OB_BOUND_BOX, "BOX", 0, "Box", ""},
84 {OB_BOUND_SPHERE, "SPHERE", 0, "Sphere", ""},
85 {OB_BOUND_CYLINDER, "CYLINDER", 0, "Cylinder", ""},
86 {OB_BOUND_CONE, "CONE", 0, "Cone", ""},
87 {OB_BOUND_POLYT, "CONVEX_HULL", 0, "Convex Hull", ""},
88 {OB_BOUND_POLYH, "TRIANGLE_MESH", 0, "Triangle Mesh", ""},
89 {OB_BOUND_CAPSULE, "CAPSULE", 0, "Capsule", ""},
90 //{OB_DYN_MESH, "DYNAMIC_MESH", 0, "Dynamic Mesh", ""},
91 {0, NULL, 0, NULL, NULL}};
93 EnumPropertyItem metaelem_type_items[] = {
94 {MB_BALL, "BALL", ICON_META_BALL, "Ball", ""},
95 {MB_TUBE, "CAPSULE", ICON_META_CAPSULE, "Capsule", ""},
96 {MB_PLANE, "PLANE", ICON_META_PLANE, "Plane", ""},
97 {MB_ELIPSOID, "ELLIPSOID", ICON_META_ELLIPSOID, "Ellipsoid", ""}, // NOTE: typo at original definition!
98 {MB_CUBE, "CUBE", ICON_META_CUBE, "Cube", ""},
99 {0, NULL, 0, NULL, NULL}};
101 /* used for 2 enums */
102 #define OBTYPE_CU_CURVE {OB_CURVE, "CURVE", 0, "Curve", ""}
103 #define OBTYPE_CU_SURF {OB_SURF, "SURFACE", 0, "Surface", ""}
104 #define OBTYPE_CU_FONT {OB_FONT, "FONT", 0, "Font", ""}
106 EnumPropertyItem object_type_items[] = {
107 {OB_MESH, "MESH", 0, "Mesh", ""},
110 {OB_MBALL, "META", 0, "Meta", ""},
112 {0, "", 0, NULL, NULL},
113 {OB_ARMATURE, "ARMATURE", 0, "Armature", ""},
114 {OB_LATTICE, "LATTICE", 0, "Lattice", ""},
115 {OB_EMPTY, "EMPTY", 0, "Empty", ""},
116 {0, "", 0, NULL, NULL},
117 {OB_CAMERA, "CAMERA", 0, "Camera", ""},
118 {OB_LAMP, "LAMP", 0, "Lamp", ""},
119 {0, NULL, 0, NULL, NULL}};
121 EnumPropertyItem object_type_curve_items[] = {
125 {0, NULL, 0, NULL, NULL}};
130 #include "BLI_math.h"
132 #include "DNA_key_types.h"
133 #include "DNA_constraint_types.h"
134 #include "DNA_lattice_types.h"
136 #include "BKE_armature.h"
137 #include "BKE_bullet.h"
138 #include "BKE_constraint.h"
139 #include "BKE_context.h"
140 #include "BKE_curve.h"
141 #include "BKE_depsgraph.h"
142 #include "BKE_effect.h"
144 #include "BKE_object.h"
145 #include "BKE_material.h"
146 #include "BKE_mesh.h"
147 #include "BKE_particle.h"
148 #include "BKE_scene.h"
149 #include "BKE_deform.h"
151 #include "BLI_editVert.h" /* for EditMesh->mat_nr */
154 #include "ED_object.h"
155 #include "ED_particle.h"
156 #include "ED_curve.h"
157 #include "ED_lattice.h"
159 static void rna_Object_internal_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
161 DAG_id_tag_update(ptr->id.data, OB_RECALC_OB);
164 static void rna_Object_matrix_world_update(Main *bmain, Scene *scene, PointerRNA *ptr)
166 /* dont use compat so we get predictable rotation */
167 object_apply_mat4(ptr->id.data, ((Object *)ptr->id.data)->obmat, FALSE, TRUE);
168 rna_Object_internal_update(bmain, scene, ptr);
171 static void rna_Object_matrix_local_get(PointerRNA *ptr, float values[16])
173 Object *ob= ptr->id.data;
176 float invmat[4][4]; /* for inverse of parent's matrix */
177 invert_m4_m4(invmat, ob->parent->obmat);
178 mul_m4_m4m4((float(*)[4])values, ob->obmat, invmat);
181 copy_m4_m4((float(*)[4])values, ob->obmat);
185 static void rna_Object_matrix_local_set(PointerRNA *ptr, const float values[16])
187 Object *ob= ptr->id.data;
189 /* localspace matrix is truly relative to the parent, but parameters
190 * stored in object are relative to parentinv matrix. Undo the parent
191 * inverse part before updating obmat and calling apply_obmat() */
194 invert_m4_m4(invmat, ob->parentinv);
195 mul_m4_m4m4(ob->obmat, (float(*)[4])values, invmat);
198 copy_m4_m4(ob->obmat, (float(*)[4])values);
201 /* dont use compat so we get predictable rotation */
202 object_apply_mat4(ob, ob->obmat, FALSE, FALSE);
205 static void rna_Object_matrix_basis_get(PointerRNA *ptr, float values[16])
207 Object *ob= ptr->id.data;
208 object_to_mat4(ob, (float(*)[4])values);
211 static void rna_Object_matrix_basis_set(PointerRNA *ptr, const float values[16])
213 Object *ob= ptr->id.data;
214 object_apply_mat4(ob, (float(*)[4])values, FALSE, FALSE);
217 void rna_Object_internal_update_data(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
219 DAG_id_tag_update(ptr->id.data, OB_RECALC_DATA);
220 WM_main_add_notifier(NC_OBJECT|ND_DRAW, ptr->id.data);
223 void rna_Object_active_shape_update(Main *bmain, Scene *scene, PointerRNA *ptr)
225 Object *ob= ptr->id.data;
227 if(scene->obedit == ob) {
228 /* exit/enter editmode to get new shape */
231 EDBM_LoadEditBMesh(scene, ob);
232 EDBM_MakeEditBMesh(scene->toolsettings, scene, ob);
246 rna_Object_internal_update_data(bmain, scene, ptr);
249 static void rna_Object_dependency_update(Main *bmain, Scene *scene, PointerRNA *ptr)
251 DAG_id_tag_update(ptr->id.data, OB_RECALC_OB);
252 DAG_scene_sort(bmain, scene);
253 WM_main_add_notifier(NC_OBJECT|ND_PARENT, ptr->id.data);
256 /* when changing the selection flag the scene needs updating */
257 static void rna_Object_select_update(Main *UNUSED(bmain), Scene *scene, PointerRNA *ptr)
259 Object *ob= (Object*)ptr->id.data;
260 short mode = ob->flag & SELECT ? BA_SELECT : BA_DESELECT;
261 ED_base_object_select(object_in_scene(ob, scene), mode);
264 static void rna_Base_select_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
266 Base *base= (Base*)ptr->data;
267 short mode = base->flag & BA_SELECT ? BA_SELECT : BA_DESELECT;
268 ED_base_object_select(base, mode);
271 static void rna_Object_layer_update__internal(Main *bmain, Scene *scene, Base *base, Object *ob)
273 /* try to avoid scene sort */
275 /* pass - unlikely but when running scripts on startup it happens */
277 else if((ob->lay & scene->lay) && (base->lay & scene->lay)) {
280 else if((ob->lay & scene->lay)==0 && (base->lay & scene->lay)==0) {
284 DAG_scene_sort(bmain, scene);
288 static void rna_Object_layer_update(Main *bmain, Scene *scene, PointerRNA *ptr)
290 Object *ob= (Object*)ptr->id.data;
293 base= scene ? object_in_scene(ob, scene) : NULL;
297 SWAP(int, base->lay, ob->lay);
299 rna_Object_layer_update__internal(bmain, scene, base, ob);
302 WM_main_add_notifier(NC_SCENE|ND_LAYER_CONTENT, scene);
305 static void rna_Base_layer_update(Main *bmain, Scene *scene, PointerRNA *ptr)
307 Base *base= (Base*)ptr->data;
308 Object *ob= (Object*)base->object;
310 rna_Object_layer_update__internal(bmain, scene, base, ob);
313 WM_main_add_notifier(NC_SCENE|ND_LAYER_CONTENT, scene);
316 static void rna_Object_data_set(PointerRNA *ptr, PointerRNA value)
318 Object *ob= (Object*)ptr->data;
321 if (id == NULL || ob->mode & OB_MODE_EDIT)
324 if (ob->type == OB_EMPTY) {
326 id_us_min((ID*)ob->data);
330 if (id && GS(id->name) == ID_IM) {
335 else if(ob->type == OB_MESH) {
336 set_mesh(ob, (Mesh*)id);
340 id_us_min((ID*)ob->data);
345 test_object_materials(id);
347 if(GS(id->name)==ID_CU)
349 else if(ob->type==OB_ARMATURE)
350 armature_rebuild_pose(ob, ob->data);
354 static StructRNA *rna_Object_data_typef(PointerRNA *ptr)
356 Object *ob= (Object*)ptr->data;
359 case OB_EMPTY: return &RNA_Image;
360 case OB_MESH: return &RNA_Mesh;
361 case OB_CURVE: return &RNA_Curve;
362 case OB_SURF: return &RNA_Curve;
363 case OB_FONT: return &RNA_Curve;
364 case OB_MBALL: return &RNA_MetaBall;
365 case OB_LAMP: return &RNA_Lamp;
366 case OB_CAMERA: return &RNA_Camera;
367 case OB_LATTICE: return &RNA_Lattice;
368 case OB_ARMATURE: return &RNA_Armature;
369 default: return &RNA_ID;
373 static void rna_Object_parent_set(PointerRNA *ptr, PointerRNA value)
375 Object *ob= (Object*)ptr->data;
376 Object *par= (Object*)value.data;
378 ED_object_parent(ob, par, ob->partype, ob->parsubstr);
381 static void rna_Object_parent_type_set(PointerRNA *ptr, int value)
383 Object *ob= (Object*)ptr->data;
385 ED_object_parent(ob, ob->parent, value, ob->parsubstr);
388 static EnumPropertyItem *rna_Object_parent_type_itemf(bContext *UNUSED(C), PointerRNA *ptr, PropertyRNA *UNUSED(prop), int *free)
390 Object *ob= (Object*)ptr->data;
391 EnumPropertyItem *item= NULL;
394 RNA_enum_items_add_value(&item, &totitem, parent_type_items, PAROBJECT);
397 Object *par= ob->parent;
399 if(par->type == OB_CURVE)
400 RNA_enum_items_add_value(&item, &totitem, parent_type_items, PARCURVE);
401 else if(par->type == OB_LATTICE)
402 RNA_enum_items_add_value(&item, &totitem, &parent_type_items[4], PARSKEL); // special hack: prevents this overriding others
403 else if(par->type == OB_ARMATURE) {
404 RNA_enum_items_add_value(&item, &totitem, &parent_type_items[3], PARSKEL); // special hack: prevents this being overrided
405 RNA_enum_items_add_value(&item, &totitem, parent_type_items, PARBONE);
407 else if(par->type == OB_MESH) {
408 RNA_enum_items_add_value(&item, &totitem, parent_type_items, PARVERT1);
409 RNA_enum_items_add_value(&item, &totitem, parent_type_items, PARVERT3);
413 RNA_enum_item_end(&item, &totitem);
419 static EnumPropertyItem *rna_Object_collision_bounds_itemf(bContext *UNUSED(C), PointerRNA *ptr, PropertyRNA *UNUSED(prop), int *free)
421 Object *ob= (Object*)ptr->data;
422 EnumPropertyItem *item= NULL;
425 RNA_enum_items_add_value(&item, &totitem, collision_bounds_items, OB_BOUND_POLYH);
426 RNA_enum_items_add_value(&item, &totitem, collision_bounds_items, OB_BOUND_POLYT);
428 if(ob->body_type!=OB_BODY_TYPE_SOFT) {
429 RNA_enum_items_add_value(&item, &totitem, collision_bounds_items, OB_BOUND_CONE);
430 RNA_enum_items_add_value(&item, &totitem, collision_bounds_items, OB_BOUND_CYLINDER);
431 RNA_enum_items_add_value(&item, &totitem, collision_bounds_items, OB_BOUND_SPHERE);
432 RNA_enum_items_add_value(&item, &totitem, collision_bounds_items, OB_BOUND_BOX);
433 RNA_enum_items_add_value(&item, &totitem, collision_bounds_items, OB_BOUND_CAPSULE);
436 RNA_enum_item_end(&item, &totitem);
442 static void rna_Object_parent_bone_set(PointerRNA *ptr, const char *value)
444 Object *ob= (Object*)ptr->data;
446 ED_object_parent(ob, ob->parent, ob->partype, value);
449 static void rna_Object_dup_group_set(PointerRNA *ptr, PointerRNA value)
451 Object *ob= (Object *)ptr->data;
452 Group *grp = (Group *)value.data;
454 /* must not let this be set if the object belongs in this group already,
455 * thus causing a cycle/infinite-recursion leading to crashes on load [#25298]
457 if (object_in_group(ob, grp) == 0)
460 BKE_report(NULL, RPT_ERROR, "Cannot set dupli-group as object belongs in group being instanced thus causing a cycle");
463 void rna_VertexGroup_name_set(PointerRNA *ptr, const char *value)
465 Object *ob= (Object *)ptr->id.data;
466 bDeformGroup *dg= (bDeformGroup *)ptr->data;
467 BLI_strncpy(dg->name, value, sizeof(dg->name));
468 defgroup_unique_name(dg, ob);
471 static int rna_VertexGroup_index_get(PointerRNA *ptr)
473 Object *ob= (Object*)ptr->id.data;
475 return BLI_findindex(&ob->defbase, ptr->data);
478 static PointerRNA rna_Object_active_vertex_group_get(PointerRNA *ptr)
480 Object *ob= (Object*)ptr->id.data;
481 return rna_pointer_inherit_refine(ptr, &RNA_VertexGroup, BLI_findlink(&ob->defbase, ob->actdef-1));
484 static int rna_Object_active_vertex_group_index_get(PointerRNA *ptr)
486 Object *ob= (Object*)ptr->id.data;
487 return MAX2(ob->actdef-1, 0);
490 static void rna_Object_active_vertex_group_index_set(PointerRNA *ptr, int value)
492 Object *ob= (Object*)ptr->id.data;
496 static void rna_Object_active_vertex_group_index_range(PointerRNA *ptr, int *min, int *max)
498 Object *ob= (Object*)ptr->id.data;
501 *max= BLI_countlist(&ob->defbase)-1;
505 void rna_object_vgroup_name_index_get(PointerRNA *ptr, char *value, int index)
507 Object *ob= (Object*)ptr->id.data;
510 dg= BLI_findlink(&ob->defbase, index-1);
512 if(dg) BLI_strncpy(value, dg->name, sizeof(dg->name));
513 else BLI_strncpy(value, "", sizeof(dg->name));
516 int rna_object_vgroup_name_index_length(PointerRNA *ptr, int index)
518 Object *ob= (Object*)ptr->id.data;
521 dg= BLI_findlink(&ob->defbase, index-1);
522 return (dg)? strlen(dg->name): 0;
525 void rna_object_vgroup_name_index_set(PointerRNA *ptr, const char *value, short *index)
527 Object *ob= (Object*)ptr->id.data;
528 *index= defgroup_name_index(ob, value) + 1;
531 void rna_object_vgroup_name_set(PointerRNA *ptr, const char *value, char *result, int maxlen)
533 Object *ob= (Object*)ptr->id.data;
534 bDeformGroup *dg= defgroup_find_name(ob, value);
536 BLI_strncpy(result, value, maxlen);
543 void rna_object_uvlayer_name_set(PointerRNA *ptr, const char *value, char *result, int maxlen)
545 Object *ob= (Object*)ptr->id.data;
547 CustomDataLayer *layer;
550 if(ob->type == OB_MESH && ob->data) {
553 for(a=0; a<me->fdata.totlayer; a++) {
554 layer= &me->fdata.layers[a];
556 if(layer->type == CD_MTFACE && strcmp(layer->name, value) == 0) {
557 BLI_strncpy(result, value, maxlen);
563 BLI_strncpy(result, "", maxlen);
566 void rna_object_vcollayer_name_set(PointerRNA *ptr, const char *value, char *result, int maxlen)
568 Object *ob= (Object*)ptr->id.data;
570 CustomDataLayer *layer;
573 if(ob->type == OB_MESH && ob->data) {
576 for(a=0; a<me->fdata.totlayer; a++) {
577 layer= &me->fdata.layers[a];
579 if(layer->type == CD_MCOL && strcmp(layer->name, value) == 0) {
580 BLI_strncpy(result, value, maxlen);
586 BLI_strncpy(result, "", maxlen);
589 static int rna_Object_active_material_index_get(PointerRNA *ptr)
591 Object *ob= (Object*)ptr->id.data;
592 return MAX2(ob->actcol-1, 0);
595 static void rna_Object_active_material_index_set(PointerRNA *ptr, int value)
597 Object *ob= (Object*)ptr->id.data;
600 if(ob->type==OB_MESH) {
604 me->edit_btmesh->mat_nr= value;
608 static void rna_Object_active_material_index_range(PointerRNA *ptr, int *min, int *max)
610 Object *ob= (Object*)ptr->id.data;
612 *max= MAX2(ob->totcol-1, 0);
615 /* returns active base material */
616 static PointerRNA rna_Object_active_material_get(PointerRNA *ptr)
618 Object *ob= (Object*)ptr->id.data;
621 ma= (ob->totcol)? give_current_material(ob, ob->actcol): NULL;
622 return rna_pointer_inherit_refine(ptr, &RNA_Material, ma);
625 static void rna_Object_active_material_set(PointerRNA *ptr, PointerRNA value)
627 Object *ob= (Object*)ptr->id.data;
629 DAG_id_tag_update(value.data, 0);
630 assign_material(ob, value.data, ob->actcol);
633 static void rna_Object_active_particle_system_index_range(PointerRNA *ptr, int *min, int *max)
635 Object *ob= (Object*)ptr->id.data;
637 *max= BLI_countlist(&ob->particlesystem)-1;
641 static int rna_Object_active_particle_system_index_get(PointerRNA *ptr)
643 Object *ob= (Object*)ptr->id.data;
644 return psys_get_current_num(ob);
647 static void rna_Object_active_particle_system_index_set(PointerRNA *ptr, int value)
649 Object *ob= (Object*)ptr->id.data;
650 psys_set_current_num(ob, value);
653 static void rna_Object_particle_update(Main *UNUSED(bmain), Scene *scene, PointerRNA *ptr)
655 Object *ob= (Object*)ptr->id.data;
657 PE_current_changed(scene, ob);
660 /* rotation - axis-angle */
661 static void rna_Object_rotation_axis_angle_get(PointerRNA *ptr, float *value)
663 Object *ob= ptr->data;
665 /* for now, assume that rotation mode is axis-angle */
666 value[0]= ob->rotAngle;
667 copy_v3_v3(&value[1], ob->rotAxis);
670 /* rotation - axis-angle */
671 static void rna_Object_rotation_axis_angle_set(PointerRNA *ptr, const float *value)
673 Object *ob= ptr->data;
675 /* for now, assume that rotation mode is axis-angle */
676 ob->rotAngle= value[0];
677 copy_v3_v3(ob->rotAxis, (float *)&value[1]);
679 // TODO: validate axis?
682 static void rna_Object_rotation_mode_set(PointerRNA *ptr, int value)
684 Object *ob= ptr->data;
686 /* use API Method for conversions... */
687 BKE_rotMode_change_values(ob->quat, ob->rot, ob->rotAxis, &ob->rotAngle, ob->rotmode, (short)value);
689 /* finally, set the new rotation type */
693 static void rna_Object_dimensions_get(PointerRNA *ptr, float *value)
695 Object *ob= ptr->data;
696 object_get_dimensions(ob, value);
699 static void rna_Object_dimensions_set(PointerRNA *ptr, const float *value)
701 Object *ob= ptr->data;
702 object_set_dimensions(ob, value);
705 static int rna_Object_location_editable(PointerRNA *ptr, int index)
707 Object *ob= (Object *)ptr->data;
709 /* only if the axis in question is locked, not editable... */
710 if ((index == 0) && (ob->protectflag & OB_LOCK_LOCX))
712 else if ((index == 1) && (ob->protectflag & OB_LOCK_LOCY))
714 else if ((index == 2) && (ob->protectflag & OB_LOCK_LOCZ))
717 return PROP_EDITABLE;
720 static int rna_Object_scale_editable(PointerRNA *ptr, int index)
722 Object *ob= (Object *)ptr->data;
724 /* only if the axis in question is locked, not editable... */
725 if ((index == 0) && (ob->protectflag & OB_LOCK_SCALEX))
727 else if ((index == 1) && (ob->protectflag & OB_LOCK_SCALEY))
729 else if ((index == 2) && (ob->protectflag & OB_LOCK_SCALEZ))
732 return PROP_EDITABLE;
735 static int rna_Object_rotation_euler_editable(PointerRNA *ptr, int index)
737 Object *ob= (Object *)ptr->data;
739 /* only if the axis in question is locked, not editable... */
740 if ((index == 0) && (ob->protectflag & OB_LOCK_ROTX))
742 else if ((index == 1) && (ob->protectflag & OB_LOCK_ROTY))
744 else if ((index == 2) && (ob->protectflag & OB_LOCK_ROTZ))
747 return PROP_EDITABLE;
750 static int rna_Object_rotation_4d_editable(PointerRNA *ptr, int index)
752 Object *ob= (Object *)ptr->data;
754 /* only consider locks if locking components individually... */
755 if (ob->protectflag & OB_LOCK_ROT4D) {
756 /* only if the axis in question is locked, not editable... */
757 if ((index == 0) && (ob->protectflag & OB_LOCK_ROTW))
759 else if ((index == 1) && (ob->protectflag & OB_LOCK_ROTX))
761 else if ((index == 2) && (ob->protectflag & OB_LOCK_ROTY))
763 else if ((index == 3) && (ob->protectflag & OB_LOCK_ROTZ))
767 return PROP_EDITABLE;
771 static PointerRNA rna_MaterialSlot_material_get(PointerRNA *ptr)
773 Object *ob= (Object*)ptr->id.data;
775 int index= (Material**)ptr->data - ob->mat;
777 ma= give_current_material(ob, index+1);
778 return rna_pointer_inherit_refine(ptr, &RNA_Material, ma);
781 static void rna_MaterialSlot_material_set(PointerRNA *ptr, PointerRNA value)
783 Object *ob= (Object*)ptr->id.data;
784 int index= (Material**)ptr->data - ob->mat;
786 assign_material(ob, value.data, index+1);
789 static int rna_MaterialSlot_link_get(PointerRNA *ptr)
791 Object *ob= (Object*)ptr->id.data;
792 int index= (Material**)ptr->data - ob->mat;
794 return ob->matbits[index] != 0;
797 static void rna_MaterialSlot_link_set(PointerRNA *ptr, int value)
799 Object *ob= (Object*)ptr->id.data;
800 int index= (Material**)ptr->data - ob->mat;
803 ob->matbits[index]= 1;
804 ob->colbits |= (1<<index);
807 ob->matbits[index]= 0;
808 ob->colbits &= ~(1<<index);
812 static int rna_MaterialSlot_name_length(PointerRNA *ptr)
814 Object *ob= (Object*)ptr->id.data;
816 int index= (Material**)ptr->data - ob->mat;
818 ma= give_current_material(ob, index+1);
821 return strlen(ma->id.name+2);
826 static void rna_MaterialSlot_name_get(PointerRNA *ptr, char *str)
828 Object *ob= (Object*)ptr->id.data;
830 int index= (Material**)ptr->data - ob->mat;
832 ma= give_current_material(ob, index+1);
835 strcpy(str, ma->id.name+2);
840 static void rna_MaterialSlot_update(Main *bmain, Scene *scene, PointerRNA *ptr)
842 rna_Object_internal_update(bmain, scene, ptr);
843 WM_main_add_notifier(NC_OBJECT|ND_OB_SHADING, ptr->id.data);
846 /* why does this have to be so complicated?, can't all this crap be
847 * moved to in BGE conversion function? - Campbell *
849 * logic from check_body_type()
851 static int rna_GameObjectSettings_physics_type_get(PointerRNA *ptr)
853 Object *ob= (Object*)ptr->id.data;
855 /* determine the body_type setting based on flags */
856 if (!(ob->gameflag & OB_COLLISION)) {
857 if (ob->gameflag & OB_OCCLUDER) {
858 ob->body_type = OB_BODY_TYPE_OCCLUDER;
860 ob->body_type = OB_BODY_TYPE_NO_COLLISION;
862 } else if (ob->gameflag & OB_SENSOR) {
863 ob->body_type = OB_BODY_TYPE_SENSOR;
864 } else if (!(ob->gameflag & OB_DYNAMIC)) {
865 ob->body_type = OB_BODY_TYPE_STATIC;
866 } else if (!(ob->gameflag & (OB_RIGID_BODY|OB_SOFT_BODY))) {
867 ob->body_type = OB_BODY_TYPE_DYNAMIC;
868 } else if (ob->gameflag & OB_RIGID_BODY) {
869 ob->body_type = OB_BODY_TYPE_RIGID;
871 ob->body_type = OB_BODY_TYPE_SOFT;
872 /* create the structure here because we display soft body buttons in the main panel */
874 ob->bsoft = bsbNew();
877 return ob->body_type;
880 static void rna_GameObjectSettings_physics_type_set(PointerRNA *ptr, int value)
882 Object *ob= (Object*)ptr->id.data;
883 ob->body_type= value;
885 switch (ob->body_type) {
886 case OB_BODY_TYPE_SENSOR:
887 ob->gameflag |= OB_SENSOR|OB_COLLISION|OB_GHOST;
888 ob->gameflag &= ~(OB_OCCLUDER|OB_DYNAMIC|OB_RIGID_BODY|OB_SOFT_BODY|OB_ACTOR|OB_ANISOTROPIC_FRICTION|OB_DO_FH|OB_ROT_FH|OB_COLLISION_RESPONSE);
890 case OB_BODY_TYPE_OCCLUDER:
891 ob->gameflag |= OB_OCCLUDER;
892 ob->gameflag &= ~(OB_SENSOR|OB_COLLISION|OB_DYNAMIC);
894 case OB_BODY_TYPE_NO_COLLISION:
895 ob->gameflag &= ~(OB_SENSOR|OB_COLLISION|OB_OCCLUDER|OB_DYNAMIC);
897 case OB_BODY_TYPE_STATIC:
898 ob->gameflag |= OB_COLLISION;
899 ob->gameflag &= ~(OB_DYNAMIC|OB_RIGID_BODY|OB_SOFT_BODY|OB_OCCLUDER|OB_SENSOR);
901 case OB_BODY_TYPE_DYNAMIC:
902 ob->gameflag |= OB_COLLISION|OB_DYNAMIC|OB_ACTOR;
903 ob->gameflag &= ~(OB_RIGID_BODY|OB_SOFT_BODY|OB_OCCLUDER|OB_SENSOR);
905 case OB_BODY_TYPE_RIGID:
906 ob->gameflag |= OB_COLLISION|OB_DYNAMIC|OB_RIGID_BODY|OB_ACTOR;
907 ob->gameflag &= ~(OB_SOFT_BODY|OB_OCCLUDER|OB_SENSOR);
910 case OB_BODY_TYPE_SOFT:
911 ob->gameflag |= OB_COLLISION|OB_DYNAMIC|OB_SOFT_BODY|OB_ACTOR;
912 ob->gameflag &= ~(OB_RIGID_BODY|OB_OCCLUDER|OB_SENSOR);
914 /* assume triangle mesh, if no bounds chosen for soft body */
915 if ((ob->gameflag & OB_BOUNDS) && (ob->boundtype<OB_BOUND_POLYH))
917 ob->boundtype=OB_BOUND_POLYH;
919 /* create a BulletSoftBody structure if not already existing */
921 ob->bsoft = bsbNew();
926 static PointerRNA rna_Object_active_particle_system_get(PointerRNA *ptr)
928 Object *ob= (Object*)ptr->id.data;
929 ParticleSystem *psys= psys_get_current(ob);
930 return rna_pointer_inherit_refine(ptr, &RNA_ParticleSystem, psys);
933 static PointerRNA rna_Object_game_settings_get(PointerRNA *ptr)
935 return rna_pointer_inherit_refine(ptr, &RNA_GameObjectSettings, ptr->id.data);
939 static unsigned int rna_Object_layer_validate__internal(const int *values, unsigned int lay)
943 /* ensure we always have some layer selected */
951 for(i=0; i<20; i++) {
952 if(values[i]) lay |= (1<<i);
959 static void rna_Object_layer_set(PointerRNA *ptr, const int *values)
961 Object *ob= (Object*)ptr->data;
964 lay= rna_Object_layer_validate__internal(values, ob->lay);
969 static void rna_Base_layer_set(PointerRNA *ptr, const int *values)
971 Base *base= (Base*)ptr->data;
974 lay= rna_Object_layer_validate__internal(values, base->lay);
978 /* rna_Base_layer_update updates the objects layer */
981 static void rna_GameObjectSettings_state_get(PointerRNA *ptr, int *values)
983 Object *ob= (Object*)ptr->data;
985 int all_states = (ob->scaflag & OB_ALLSTATE?1:0);
987 memset(values, 0, sizeof(int)*OB_MAX_STATES);
988 for(i=0; i<OB_MAX_STATES; i++)
989 values[i] = (ob->state & (1<<i)) | all_states;
992 static void rna_GameObjectSettings_state_set(PointerRNA *ptr, const int *values)
994 Object *ob= (Object*)ptr->data;
997 /* ensure we always have some state selected */
998 for(i=0; i<OB_MAX_STATES; i++)
1005 for(i=0; i<OB_MAX_STATES; i++) {
1006 if(values[i]) ob->state |= (1<<i);
1007 else ob->state &= ~(1<<i);
1011 static void rna_GameObjectSettings_used_state_get(PointerRNA *ptr, int *values)
1013 Object *ob= (Object*)ptr->data;
1016 memset(values, 0, sizeof(int)*OB_MAX_STATES);
1017 for (cont=ob->controllers.first; cont; cont=cont->next) {
1020 for (i=0; i<OB_MAX_STATES; i++) {
1021 if (cont->state_mask & (1<<i))
1027 static void rna_Object_active_shape_key_index_range(PointerRNA *ptr, int *min, int *max)
1029 Object *ob= (Object*)ptr->id.data;
1030 Key *key= ob_get_key(ob);
1034 *max= BLI_countlist(&key->block)-1;
1035 if(*max < 0) *max= 0;
1042 static int rna_Object_active_shape_key_index_get(PointerRNA *ptr)
1044 Object *ob= (Object*)ptr->id.data;
1046 return MAX2(ob->shapenr-1, 0);
1049 static void rna_Object_active_shape_key_index_set(PointerRNA *ptr, int value)
1051 Object *ob= (Object*)ptr->id.data;
1053 ob->shapenr= value+1;
1056 static PointerRNA rna_Object_active_shape_key_get(PointerRNA *ptr)
1058 Object *ob= (Object*)ptr->id.data;
1059 Key *key= ob_get_key(ob);
1064 return PointerRNA_NULL;
1066 kb= BLI_findlink(&key->block, ob->shapenr-1);
1067 RNA_pointer_create((ID *)key, &RNA_ShapeKey, kb, &keyptr);
1071 static PointerRNA rna_Object_field_get(PointerRNA *ptr)
1073 Object *ob= (Object*)ptr->id.data;
1077 ob->pd= object_add_collision_fields(0);
1079 return rna_pointer_inherit_refine(ptr, &RNA_FieldSettings, ob->pd);
1082 static PointerRNA rna_Object_collision_get(PointerRNA *ptr)
1084 Object *ob= (Object*)ptr->id.data;
1086 if(ob->type != OB_MESH)
1087 return PointerRNA_NULL;
1091 ob->pd= object_add_collision_fields(0);
1093 return rna_pointer_inherit_refine(ptr, &RNA_CollisionSettings, ob->pd);
1096 static PointerRNA rna_Object_active_constraint_get(PointerRNA *ptr)
1098 Object *ob= (Object*)ptr->id.data;
1099 bConstraint *con= constraints_get_active(&ob->constraints);
1100 return rna_pointer_inherit_refine(ptr, &RNA_Constraint, con);
1103 static void rna_Object_active_constraint_set(PointerRNA *ptr, PointerRNA value)
1105 Object *ob= (Object*)ptr->id.data;
1106 constraints_set_active(&ob->constraints, (bConstraint *)value.data);
1109 static bConstraint *rna_Object_constraints_new(Object *object, int type)
1111 WM_main_add_notifier(NC_OBJECT|ND_CONSTRAINT|NA_ADDED, object);
1112 return add_ob_constraint(object, NULL, type);
1115 static void rna_Object_constraints_remove(Object *object, ReportList *reports, bConstraint *con)
1117 if(BLI_findindex(&object->constraints, con) == -1) {
1118 BKE_reportf(reports, RPT_ERROR, "Constraint '%s' not found in object '%s'.", con->name, object->id.name+2);
1122 remove_constraint(&object->constraints, con);
1123 ED_object_constraint_update(object);
1124 ED_object_constraint_set_active(object, NULL);
1125 WM_main_add_notifier(NC_OBJECT|ND_CONSTRAINT|NA_REMOVED, object);
1128 static ModifierData *rna_Object_modifier_new(Object *object, bContext *C, ReportList *reports, const char *name, int type)
1130 return ED_object_modifier_add(reports, CTX_data_main(C), CTX_data_scene(C), object, name, type);
1133 static void rna_Object_modifier_remove(Object *object, bContext *C, ReportList *reports, ModifierData *md)
1135 ED_object_modifier_remove(reports, CTX_data_main(C), CTX_data_scene(C), object, md);
1138 static void rna_Object_boundbox_get(PointerRNA *ptr, float *values)
1140 Object *ob= (Object*)ptr->id.data;
1141 BoundBox *bb= object_get_boundbox(ob);
1143 memcpy(values, bb->vec, sizeof(bb->vec));
1146 fill_vn(values, sizeof(bb->vec)/sizeof(float), 0.0f);
1151 static bDeformGroup *rna_Object_vgroup_new(Object *ob, const char *name)
1153 bDeformGroup *defgroup = ED_vgroup_add_name(ob, name);
1155 WM_main_add_notifier(NC_OBJECT|ND_DRAW, ob);
1160 static void rna_Object_vgroup_remove(Object *ob, bDeformGroup *defgroup)
1162 ED_vgroup_delete(ob, defgroup);
1164 WM_main_add_notifier(NC_OBJECT|ND_DRAW, ob);
1167 static void rna_VertexGroup_vertex_add(ID *id, bDeformGroup *def, ReportList *reports, int index_len, int *index, float weight, int assignmode)
1169 Object *ob = (Object *)id;
1171 if(ED_vgroup_object_is_edit_mode(ob)) {
1172 BKE_reportf(reports, RPT_ERROR, "VertexGroup.add(): Can't be called while object is in edit mode.");
1177 ED_vgroup_vert_add(ob, def, *index++, weight, assignmode); /* XXX, not efficient calling within loop*/
1179 WM_main_add_notifier(NC_GEOM|ND_DATA, (ID *)ob->data);
1182 static void rna_VertexGroup_vertex_remove(ID *id, bDeformGroup *dg, ReportList *reports, int index_len, int *index)
1184 Object *ob = (Object *)id;
1186 if(ED_vgroup_object_is_edit_mode(ob)) {
1187 BKE_reportf(reports, RPT_ERROR, "VertexGroup.remove(): Can't be called while object is in edit mode.");
1192 ED_vgroup_vert_remove(ob, dg, *index++);
1194 WM_main_add_notifier(NC_GEOM|ND_DATA, (ID *)ob->data);
1197 static float rna_VertexGroup_weight(ID *id, bDeformGroup *dg, ReportList *reports, int index)
1199 float weight = ED_vgroup_vert_weight((Object *)id, dg, index);
1202 BKE_reportf(reports, RPT_ERROR, "Vertex not in group");
1207 /* generic poll functions */
1208 int rna_Lattice_object_poll(PointerRNA *UNUSED(ptr), PointerRNA value)
1210 return ((Object *)value.id.data)->type == OB_LATTICE;
1213 int rna_Curve_object_poll(PointerRNA *UNUSED(ptr), PointerRNA value)
1215 return ((Object *)value.id.data)->type == OB_CURVE;
1218 int rna_Armature_object_poll(PointerRNA *UNUSED(ptr), PointerRNA value)
1220 return ((Object *)value.id.data)->type == OB_ARMATURE;
1223 int rna_Mesh_object_poll(PointerRNA *UNUSED(ptr), PointerRNA value)
1225 return ((Object *)value.id.data)->type == OB_MESH;
1228 int rna_Camera_object_poll(PointerRNA *UNUSED(ptr), PointerRNA value)
1230 return ((Object *)value.id.data)->type == OB_CAMERA;
1235 static int rna_matrix_dimsize_4x4[]= {4, 4};
1237 static void rna_def_vertex_group(BlenderRNA *brna)
1243 static EnumPropertyItem assign_mode_items[] = {
1244 {WEIGHT_REPLACE, "REPLACE", 0, "Replace", "Replace"},
1245 {WEIGHT_ADD, "ADD", 0, "Add", "Add"},
1246 {WEIGHT_SUBTRACT, "SUBTRACT", 0, "Subtract", "Subtract"},
1247 {0, NULL, 0, NULL, NULL}
1250 srna= RNA_def_struct(brna, "VertexGroup", NULL);
1251 RNA_def_struct_sdna(srna, "bDeformGroup");
1252 RNA_def_struct_ui_text(srna, "Vertex Group", "Group of vertices, used for armature deform and other purposes");
1253 RNA_def_struct_ui_icon(srna, ICON_GROUP_VERTEX);
1255 prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
1256 RNA_def_property_ui_text(prop, "Name", "Vertex group name");
1257 RNA_def_struct_name_property(srna, prop);
1258 RNA_def_property_string_funcs(prop, NULL, NULL, "rna_VertexGroup_name_set");
1259 RNA_def_property_update(prop, NC_GEOM|ND_DATA|NA_RENAME, "rna_Object_internal_update_data"); /* update data because modifiers may use [#24761] */
1261 prop= RNA_def_property(srna, "index", PROP_INT, PROP_UNSIGNED);
1262 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1263 RNA_def_property_int_funcs(prop, "rna_VertexGroup_index_get", NULL, NULL);
1264 RNA_def_property_ui_text(prop, "Index", "Index number of the vertex group");
1266 func= RNA_def_function(srna, "add", "rna_VertexGroup_vertex_add");
1267 RNA_def_function_ui_description(func, "Add vertices to the group.");
1268 RNA_def_function_flag(func, FUNC_USE_REPORTS|FUNC_USE_SELF_ID);
1269 /* TODO, see how array size of 0 works, this shouldnt be used */
1270 prop= RNA_def_int_array(func, "index", 1, NULL, 0, 0, "", "Index List.", 0, 0);
1271 RNA_def_property_flag(prop, PROP_DYNAMIC|PROP_REQUIRED);
1272 prop= RNA_def_float(func, "weight", 0, 0.0f, 1.0f, "", "Vertex weight.", 0.0f, 1.0f);
1273 RNA_def_property_flag(prop, PROP_REQUIRED);
1274 prop= RNA_def_enum(func, "type", assign_mode_items, 0, "", "Vertex assign mode.");
1275 RNA_def_property_flag(prop, PROP_REQUIRED);
1277 func= RNA_def_function(srna, "remove", "rna_VertexGroup_vertex_remove");
1278 RNA_def_function_ui_description(func, "Remove a vertex from the group.");
1279 RNA_def_function_flag(func, FUNC_USE_REPORTS|FUNC_USE_SELF_ID);
1280 /* TODO, see how array size of 0 works, this shouldnt be used */
1281 prop= RNA_def_int_array(func, "index", 1, NULL, 0, 0, "", "Index List.", 0, 0);
1282 RNA_def_property_flag(prop, PROP_DYNAMIC|PROP_REQUIRED);
1284 func= RNA_def_function(srna, "weight", "rna_VertexGroup_weight");
1285 RNA_def_function_ui_description(func, "Get a vertex weight from the group.");
1286 RNA_def_function_flag(func, FUNC_USE_REPORTS|FUNC_USE_SELF_ID);
1287 prop=RNA_def_int(func, "index", 0, 0, INT_MAX, "Index", "The index of the vertex.", 0, INT_MAX);
1288 RNA_def_property_flag(prop, PROP_REQUIRED);
1289 prop= RNA_def_float(func, "weight", 0, 0.0f, 1.0f, "", "Vertex weight.", 0.0f, 1.0f);
1290 RNA_def_function_return(func, prop);
1293 static void rna_def_material_slot(BlenderRNA *brna)
1298 static EnumPropertyItem link_items[] = {
1299 {1, "OBJECT", 0, "Object", ""},
1300 {0, "DATA", 0, "Data", ""},
1301 {0, NULL, 0, NULL, NULL}};
1303 /* NOTE: there is no MaterialSlot equivalent in DNA, so the internal
1304 * pointer data points to ob->mat + index, and we manually implement
1305 * get/set for the properties. */
1307 srna= RNA_def_struct(brna, "MaterialSlot", NULL);
1308 RNA_def_struct_ui_text(srna, "Material Slot", "Material slot in an object");
1309 RNA_def_struct_ui_icon(srna, ICON_MATERIAL_DATA);
1311 prop= RNA_def_property(srna, "material", PROP_POINTER, PROP_NONE);
1312 RNA_def_property_struct_type(prop, "Material");
1313 RNA_def_property_flag(prop, PROP_EDITABLE);
1314 RNA_def_property_pointer_funcs(prop, "rna_MaterialSlot_material_get", "rna_MaterialSlot_material_set", NULL, NULL);
1315 RNA_def_property_ui_text(prop, "Material", "Material datablock used by this material slot");
1316 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_MaterialSlot_update");
1318 prop= RNA_def_property(srna, "link", PROP_ENUM, PROP_NONE);
1319 RNA_def_property_enum_items(prop, link_items);
1320 RNA_def_property_enum_funcs(prop, "rna_MaterialSlot_link_get", "rna_MaterialSlot_link_set", NULL);
1321 RNA_def_property_ui_text(prop, "Link", "Link material to object or the object's data");
1322 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_MaterialSlot_update");
1324 prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
1325 RNA_def_property_string_funcs(prop, "rna_MaterialSlot_name_get", "rna_MaterialSlot_name_length", NULL);
1326 RNA_def_property_ui_text(prop, "Name", "Material slot name");
1327 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1328 RNA_def_struct_name_property(srna, prop);
1331 static void rna_def_object_game_settings(BlenderRNA *brna)
1336 static EnumPropertyItem body_type_items[] = {
1337 {OB_BODY_TYPE_NO_COLLISION, "NO_COLLISION", 0, "No Collision", "Disable collision for this object"},
1338 {OB_BODY_TYPE_STATIC, "STATIC", 0, "Static", "Stationary object"},
1339 {OB_BODY_TYPE_DYNAMIC, "DYNAMIC", 0, "Dynamic", "Linear physics"},
1340 {OB_BODY_TYPE_RIGID, "RIGID_BODY", 0, "Rigid Body", "Linear and angular physics"},
1341 {OB_BODY_TYPE_SOFT, "SOFT_BODY", 0, "Soft Body", "Soft body"},
1342 {OB_BODY_TYPE_OCCLUDER, "OCCLUDE", 0, "Occlude", "Occluder for optimizing scene rendering"},
1343 {OB_BODY_TYPE_SENSOR, "SENSOR", 0, "Sensor", "Collision Sensor, detects static and dynamic objects but not the other collision sensor objects"},
1344 {0, NULL, 0, NULL, NULL}};
1346 srna= RNA_def_struct(brna, "GameObjectSettings", NULL);
1347 RNA_def_struct_sdna(srna, "Object");
1348 RNA_def_struct_nested(brna, srna, "Object");
1349 RNA_def_struct_ui_text(srna, "Game Object Settings", "Game engine related settings for the object");
1350 RNA_def_struct_ui_icon(srna, ICON_GAME);
1354 prop= RNA_def_property(srna, "sensors", PROP_COLLECTION, PROP_NONE);
1355 RNA_def_property_struct_type(prop, "Sensor");
1356 RNA_def_property_ui_text(prop, "Sensors", "Game engine sensor to detect events");
1358 prop= RNA_def_property(srna, "controllers", PROP_COLLECTION, PROP_NONE);
1359 RNA_def_property_struct_type(prop, "Controller");
1360 RNA_def_property_ui_text(prop, "Controllers", "Game engine controllers to process events, connecting sensor to actuators");
1362 prop= RNA_def_property(srna, "actuators", PROP_COLLECTION, PROP_NONE);
1363 RNA_def_property_struct_type(prop, "Actuator");
1364 RNA_def_property_ui_text(prop, "Actuators", "Game engine actuators to act on events");
1366 prop= RNA_def_property(srna, "properties", PROP_COLLECTION, PROP_NONE);
1367 RNA_def_property_collection_sdna(prop, NULL, "prop", NULL);
1368 RNA_def_property_struct_type(prop, "GameProperty"); /* rna_property.c */
1369 RNA_def_property_ui_text(prop, "Properties", "Game engine properties");
1371 prop= RNA_def_property(srna, "show_sensors", PROP_BOOLEAN, PROP_NONE);
1372 RNA_def_property_boolean_sdna(prop, NULL, "scaflag", OB_SHOWSENS);
1373 RNA_def_property_ui_text(prop, "Show Sensors", "Shows sensors for this object in the user interface");
1375 prop= RNA_def_property(srna, "show_controllers", PROP_BOOLEAN, PROP_NONE);
1376 RNA_def_property_boolean_sdna(prop, NULL, "scaflag", OB_SHOWCONT);
1377 RNA_def_property_ui_text(prop, "Show Controllers", "Shows controllers for this object in the user interface");
1379 prop= RNA_def_property(srna, "show_actuators", PROP_BOOLEAN, PROP_NONE);
1380 RNA_def_property_boolean_sdna(prop, NULL, "scaflag", OB_SHOWACT);
1381 RNA_def_property_ui_text(prop, "Show Actuators", "Shows actuators for this object in the user interface");
1385 prop= RNA_def_property(srna, "physics_type", PROP_ENUM, PROP_NONE);
1386 RNA_def_property_enum_sdna(prop, NULL, "body_type");
1387 RNA_def_property_enum_items(prop, body_type_items);
1388 RNA_def_property_enum_funcs(prop, "rna_GameObjectSettings_physics_type_get", "rna_GameObjectSettings_physics_type_set", NULL);
1389 RNA_def_property_ui_text(prop, "Physics Type", "Selects the type of physical representation");
1390 RNA_def_property_update(prop, NC_LOGIC, NULL);
1392 prop= RNA_def_property(srna, "use_actor", PROP_BOOLEAN, PROP_NONE);
1393 RNA_def_property_boolean_sdna(prop, NULL, "gameflag", OB_ACTOR);
1394 RNA_def_property_ui_text(prop, "Actor", "Object is detected by the Near and Radar sensor");
1396 prop= RNA_def_property(srna, "use_ghost", PROP_BOOLEAN, PROP_NONE);
1397 RNA_def_property_boolean_sdna(prop, NULL, "gameflag", OB_GHOST);
1398 RNA_def_property_ui_text(prop, "Ghost", "Object does not restitute collisions, like a ghost");
1400 prop= RNA_def_property(srna, "mass", PROP_FLOAT, PROP_NONE);
1401 RNA_def_property_range(prop, 0.01, 10000.0);
1402 RNA_def_property_ui_text(prop, "Mass", "Mass of the object");
1404 prop= RNA_def_property(srna, "radius", PROP_FLOAT, PROP_NONE|PROP_UNIT_LENGTH);
1405 RNA_def_property_float_sdna(prop, NULL, "inertia");
1406 RNA_def_property_range(prop, 0.01, 10.0);
1407 RNA_def_property_ui_text(prop, "Radius", "Radius of bounding sphere and material physics");
1408 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
1410 prop= RNA_def_property(srna, "use_sleep", PROP_BOOLEAN, PROP_NONE);
1411 RNA_def_property_boolean_sdna(prop, NULL, "gameflag", OB_COLLISION_RESPONSE);
1412 RNA_def_property_ui_text(prop, "No Sleeping", "Disable auto (de)activation in physics simulation");
1414 prop= RNA_def_property(srna, "damping", PROP_FLOAT, PROP_NONE);
1415 RNA_def_property_float_sdna(prop, NULL, "damping");
1416 RNA_def_property_range(prop, 0.0, 1.0);
1417 RNA_def_property_ui_text(prop, "Damping", "General movement damping");
1419 prop= RNA_def_property(srna, "rotation_damping", PROP_FLOAT, PROP_NONE);
1420 RNA_def_property_float_sdna(prop, NULL, "rdamping");
1421 RNA_def_property_range(prop, 0.0, 1.0);
1422 RNA_def_property_ui_text(prop, "Rotation Damping", "General rotation damping");
1424 prop= RNA_def_property(srna, "velocity_min", PROP_FLOAT, PROP_NONE);
1425 RNA_def_property_float_sdna(prop, NULL, "min_vel");
1426 RNA_def_property_range(prop, 0.0, 1000.0);
1427 RNA_def_property_ui_text(prop, "Velocity Min", "Clamp velocity to this minimum speed (except when totally still)");
1429 prop= RNA_def_property(srna, "velocity_max", PROP_FLOAT, PROP_NONE);
1430 RNA_def_property_float_sdna(prop, NULL, "max_vel");
1431 RNA_def_property_range(prop, 0.0, 1000.0);
1432 RNA_def_property_ui_text(prop, "Velocity Max", "Clamp velocity to this maximum speed");
1435 prop= RNA_def_property(srna, "lock_location_x", PROP_BOOLEAN, PROP_NONE);
1436 RNA_def_property_boolean_sdna(prop, NULL, "gameflag2", OB_LOCK_RIGID_BODY_X_AXIS);
1437 RNA_def_property_ui_text(prop, "Lock X Axis", "Disable simulation of linear motion along the X axis");
1439 prop= RNA_def_property(srna, "lock_location_y", PROP_BOOLEAN, PROP_NONE);
1440 RNA_def_property_boolean_sdna(prop, NULL, "gameflag2", OB_LOCK_RIGID_BODY_Y_AXIS);
1441 RNA_def_property_ui_text(prop, "Lock Y Axis", "Disable simulation of linear motion along the Y axis");
1443 prop= RNA_def_property(srna, "lock_location_z", PROP_BOOLEAN, PROP_NONE);
1444 RNA_def_property_boolean_sdna(prop, NULL, "gameflag2", OB_LOCK_RIGID_BODY_Z_AXIS);
1445 RNA_def_property_ui_text(prop, "Lock Z Axis", "Disable simulation of linear motion along the Z axis");
1449 prop= RNA_def_property(srna, "lock_rotation_x", PROP_BOOLEAN, PROP_NONE);
1450 RNA_def_property_boolean_sdna(prop, NULL, "gameflag2", OB_LOCK_RIGID_BODY_X_ROT_AXIS);
1451 RNA_def_property_ui_text(prop, "Lock X Rotation Axis", "Disable simulation of angular motion along the X axis");
1453 prop= RNA_def_property(srna, "lock_rotation_y", PROP_BOOLEAN, PROP_NONE);
1454 RNA_def_property_boolean_sdna(prop, NULL, "gameflag2", OB_LOCK_RIGID_BODY_Y_ROT_AXIS);
1455 RNA_def_property_ui_text(prop, "Lock Y Rotation Axis", "Disable simulation of angular motion along the Y axis");
1457 prop= RNA_def_property(srna, "lock_rotation_z", PROP_BOOLEAN, PROP_NONE);
1458 RNA_def_property_boolean_sdna(prop, NULL, "gameflag2", OB_LOCK_RIGID_BODY_Z_ROT_AXIS);
1459 RNA_def_property_ui_text(prop, "Lock Z Rotation Axis", "Disable simulation of angular motion along the Z axis");
1461 /* is this used anywhere ? */
1462 prop= RNA_def_property(srna, "use_activity_culling", PROP_BOOLEAN, PROP_NONE);
1463 RNA_def_property_boolean_negative_sdna(prop, NULL, "gameflag2", OB_NEVER_DO_ACTIVITY_CULLING);
1464 RNA_def_property_ui_text(prop, "Lock Z Rotation Axis", "Disable simulation of angular motion along the Z axis");
1467 prop= RNA_def_property(srna, "use_material_physics_fh", PROP_BOOLEAN, PROP_NONE);
1468 RNA_def_property_boolean_sdna(prop, NULL, "gameflag", OB_DO_FH);
1469 RNA_def_property_ui_text(prop, "Use Material Force Field", "React to force field physics settings in materials");
1471 prop= RNA_def_property(srna, "use_rotate_from_normal", PROP_BOOLEAN, PROP_NONE);
1472 RNA_def_property_boolean_sdna(prop, NULL, "gameflag", OB_ROT_FH);
1473 RNA_def_property_ui_text(prop, "Rotate From Normal", "Use face normal to rotate object, so that it points away from the surface");
1475 prop= RNA_def_property(srna, "form_factor", PROP_FLOAT, PROP_NONE);
1476 RNA_def_property_float_sdna(prop, NULL, "formfactor");
1477 RNA_def_property_range(prop, 0.0, 1.0);
1478 RNA_def_property_ui_text(prop, "Form Factor", "Form factor scales the inertia tensor");
1480 prop= RNA_def_property(srna, "use_anisotropic_friction", PROP_BOOLEAN, PROP_NONE);
1481 RNA_def_property_boolean_sdna(prop, NULL, "gameflag", OB_ANISOTROPIC_FRICTION);
1482 RNA_def_property_ui_text(prop, "Anisotropic Friction", "Enable anisotropic friction");
1484 prop= RNA_def_property(srna, "friction_coefficients", PROP_FLOAT, PROP_NONE);
1485 RNA_def_property_float_sdna(prop, NULL, "anisotropicFriction");
1486 RNA_def_property_range(prop, 0.0, 1.0);
1487 RNA_def_property_ui_text(prop, "Friction Coefficients", "Relative friction coefficient in the in the X, Y and Z directions, when anisotropic friction is enabled");
1489 prop= RNA_def_property(srna, "use_collision_bounds", PROP_BOOLEAN, PROP_NONE);
1490 RNA_def_property_boolean_sdna(prop, NULL, "gameflag", OB_BOUNDS);
1491 RNA_def_property_ui_text(prop, "Use Collision Bounds", "Specify a collision bounds type other than the default");
1493 prop= RNA_def_property(srna, "collision_bounds_type", PROP_ENUM, PROP_NONE);
1494 RNA_def_property_enum_sdna(prop, NULL, "boundtype");
1495 RNA_def_property_enum_items(prop, collision_bounds_items);
1496 RNA_def_property_enum_funcs(prop, NULL, NULL, "rna_Object_collision_bounds_itemf");
1497 RNA_def_property_ui_text(prop, "Collision Bounds", "Selects the collision type");
1498 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
1500 prop= RNA_def_property(srna, "use_collision_compound", PROP_BOOLEAN, PROP_NONE);
1501 RNA_def_property_boolean_sdna(prop, NULL, "gameflag", OB_CHILD);
1502 RNA_def_property_ui_text(prop, "Collision Compound", "Add children to form a compound collision object");
1504 prop= RNA_def_property(srna, "collision_margin", PROP_FLOAT, PROP_NONE|PROP_UNIT_LENGTH);
1505 RNA_def_property_float_sdna(prop, NULL, "margin");
1506 RNA_def_property_range(prop, 0.0, 1.0);
1507 RNA_def_property_ui_text(prop, "Collision Margin", "Extra margin around object for collision detection, small amount required for stability");
1509 prop= RNA_def_property(srna, "soft_body", PROP_POINTER, PROP_NONE);
1510 RNA_def_property_pointer_sdna(prop, NULL, "bsoft");
1511 RNA_def_property_ui_text(prop, "Soft Body Settings", "Settings for Bullet soft body simulation");
1515 prop= RNA_def_property(srna, "states_visible", PROP_BOOLEAN, PROP_LAYER_MEMBER);
1516 RNA_def_property_boolean_sdna(prop, NULL, "state", 1);
1517 RNA_def_property_array(prop, OB_MAX_STATES);
1518 RNA_def_property_ui_text(prop, "State", "State determining which controllers are displayed");
1519 RNA_def_property_boolean_funcs(prop, "rna_GameObjectSettings_state_get", "rna_GameObjectSettings_state_set");
1521 prop= RNA_def_property(srna, "used_states", PROP_BOOLEAN, PROP_LAYER_MEMBER);
1522 RNA_def_property_array(prop, OB_MAX_STATES);
1523 RNA_def_property_ui_text(prop, "Used State", "States which are being used by controllers");
1524 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1525 RNA_def_property_boolean_funcs(prop, "rna_GameObjectSettings_used_state_get", NULL);
1527 prop= RNA_def_property(srna, "states_initial", PROP_BOOLEAN, PROP_NONE);
1528 RNA_def_property_boolean_sdna(prop, NULL, "init_state", 1);
1529 RNA_def_property_array(prop, OB_MAX_STATES);
1530 RNA_def_property_ui_text(prop, "Initial State", "Initial state when the game starts");
1532 prop= RNA_def_property(srna, "show_debug_state", PROP_BOOLEAN, PROP_NONE);
1533 RNA_def_property_boolean_sdna(prop, NULL, "scaflag", OB_DEBUGSTATE);
1534 RNA_def_property_ui_text(prop, "Debug State", "Print state debug info in the game engine");
1535 RNA_def_property_ui_icon(prop, ICON_INFO, 0);
1537 prop= RNA_def_property(srna, "use_all_states", PROP_BOOLEAN, PROP_NONE);
1538 RNA_def_property_boolean_sdna(prop, NULL, "scaflag", OB_ALLSTATE);
1539 RNA_def_property_ui_text(prop, "All", "Set all state bits");
1541 prop= RNA_def_property(srna, "show_state_panel", PROP_BOOLEAN, PROP_NONE);
1542 RNA_def_property_boolean_sdna(prop, NULL, "scaflag", OB_SHOWSTATE);
1543 RNA_def_property_ui_text(prop, "States", "Show state panel");
1544 RNA_def_property_ui_icon(prop, ICON_DISCLOSURE_TRI_RIGHT, 1);
1547 static void rna_def_object_constraints(BlenderRNA *brna, PropertyRNA *cprop)
1555 RNA_def_property_srna(cprop, "ObjectConstraints");
1556 srna= RNA_def_struct(brna, "ObjectConstraints", NULL);
1557 RNA_def_struct_sdna(srna, "Object");
1558 RNA_def_struct_ui_text(srna, "Object Constraints", "Collection of object constraints");
1561 /* Collection active property */
1562 prop= RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
1563 RNA_def_property_struct_type(prop, "Constraint");
1564 RNA_def_property_pointer_funcs(prop, "rna_Object_active_constraint_get", "rna_Object_active_constraint_set", NULL, NULL);
1565 RNA_def_property_flag(prop, PROP_EDITABLE);
1566 RNA_def_property_ui_text(prop, "Active Constraint", "Active Object constraint");
1569 /* Constraint collection */
1570 func= RNA_def_function(srna, "new", "rna_Object_constraints_new");
1571 RNA_def_function_ui_description(func, "Add a new constraint to this object");
1573 parm= RNA_def_enum(func, "type", constraint_type_items, 1, "", "Constraint type to add.");
1574 RNA_def_property_flag(parm, PROP_REQUIRED);
1576 parm= RNA_def_pointer(func, "constraint", "Constraint", "", "New constraint.");
1577 RNA_def_function_return(func, parm);
1579 func= RNA_def_function(srna, "remove", "rna_Object_constraints_remove");
1580 RNA_def_function_ui_description(func, "Remove a constraint from this object.");
1581 RNA_def_function_flag(func, FUNC_USE_REPORTS);
1582 /* constraint to remove */
1583 parm= RNA_def_pointer(func, "constraint", "Constraint", "", "Removed constraint.");
1584 RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
1587 /* object.modifiers */
1588 static void rna_def_object_modifiers(BlenderRNA *brna, PropertyRNA *cprop)
1595 RNA_def_property_srna(cprop, "ObjectModifiers");
1596 srna= RNA_def_struct(brna, "ObjectModifiers", NULL);
1597 RNA_def_struct_sdna(srna, "Object");
1598 RNA_def_struct_ui_text(srna, "Object Modifiers", "Collection of object modifiers");
1601 prop= RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
1602 RNA_def_property_struct_type(prop, "EditBone");
1603 RNA_def_property_pointer_sdna(prop, NULL, "act_edbone");
1604 RNA_def_property_flag(prop, PROP_EDITABLE);
1605 RNA_def_property_ui_text(prop, "Active EditBone", "Armatures active edit bone");
1606 //RNA_def_property_update(prop, 0, "rna_Armature_act_editbone_update");
1607 RNA_def_property_pointer_funcs(prop, NULL, "rna_Armature_act_edit_bone_set", NULL, NULL);
1610 // RNA_def_property_collection_active(prop, prop_act);
1614 func= RNA_def_function(srna, "new", "rna_Object_modifier_new");
1615 RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
1616 RNA_def_function_ui_description(func, "Add a new modifier.");
1617 parm= RNA_def_string(func, "name", "Name", 0, "", "New name for the bone.");
1618 RNA_def_property_flag(parm, PROP_REQUIRED);
1619 /* modifier to add */
1620 parm= RNA_def_enum(func, "type", modifier_type_items, 1, "", "Modifier type to add.");
1621 RNA_def_property_flag(parm, PROP_REQUIRED);
1623 parm= RNA_def_pointer(func, "modifier", "Modifier", "", "Newly created modifier.");
1624 RNA_def_function_return(func, parm);
1627 func= RNA_def_function(srna, "remove", "rna_Object_modifier_remove");
1628 RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
1629 RNA_def_function_ui_description(func, "Remove an existing modifier from the object.");
1630 /* target to remove*/
1631 parm= RNA_def_pointer(func, "modifier", "Modifier", "", "Modifier to remove.");
1632 RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
1635 /* object.particle_systems */
1636 static void rna_def_object_particle_systems(BlenderRNA *brna, PropertyRNA *cprop)
1642 // FunctionRNA *func;
1643 // PropertyRNA *parm;
1645 RNA_def_property_srna(cprop, "ParticleSystems");
1646 srna= RNA_def_struct(brna, "ParticleSystems", NULL);
1647 RNA_def_struct_sdna(srna, "Object");
1648 RNA_def_struct_ui_text(srna, "Particle Systems", "Collection of particle systems");
1650 prop= RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
1651 RNA_def_property_struct_type(prop, "ParticleSystem");
1652 RNA_def_property_pointer_funcs(prop, "rna_Object_active_particle_system_get", NULL, NULL, NULL);
1653 RNA_def_property_ui_text(prop, "Active Particle System", "Active particle system being displayed");
1654 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
1656 prop= RNA_def_property(srna, "active_index", PROP_INT, PROP_UNSIGNED);
1657 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
1658 RNA_def_property_int_funcs(prop, "rna_Object_active_particle_system_index_get", "rna_Object_active_particle_system_index_set", "rna_Object_active_particle_system_index_range");
1659 RNA_def_property_ui_text(prop, "Active Particle System Index", "Index of active particle system slot");
1660 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Object_particle_update");
1664 /* object.vertex_groups */
1665 static void rna_def_object_vertex_groups(BlenderRNA *brna, PropertyRNA *cprop)
1674 RNA_def_property_srna(cprop, "VertexGroups");
1675 srna= RNA_def_struct(brna, "VertexGroups", NULL);
1676 RNA_def_struct_sdna(srna, "Object");
1677 RNA_def_struct_ui_text(srna, "Vertex Groups", "Collection of vertex groups");
1679 prop= RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
1680 RNA_def_property_struct_type(prop, "VertexGroup");
1681 RNA_def_property_pointer_funcs(prop, "rna_Object_active_vertex_group_get", "rna_Object_active_vertex_group_set", NULL, NULL);
1682 RNA_def_property_ui_text(prop, "Active Vertex Group", "Vertex groups of the object");
1683 RNA_def_property_update(prop, NC_GEOM|ND_DATA, "rna_Object_internal_update_data");
1685 prop= RNA_def_property(srna, "active_index", PROP_INT, PROP_NONE);
1686 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
1687 RNA_def_property_int_sdna(prop, NULL, "actdef");
1688 RNA_def_property_int_funcs(prop, "rna_Object_active_vertex_group_index_get", "rna_Object_active_vertex_group_index_set", "rna_Object_active_vertex_group_index_range");
1689 RNA_def_property_ui_text(prop, "Active Vertex Group Index", "Active index in vertex group array");
1690 RNA_def_property_update(prop, NC_GEOM|ND_DATA, "rna_Object_internal_update_data");
1692 /* vertex groups */ // add_vertex_group
1693 func= RNA_def_function(srna, "new", "rna_Object_vgroup_new");
1694 RNA_def_function_ui_description(func, "Add vertex group to object.");
1695 RNA_def_string(func, "name", "Group", 0, "", "Vertex group name."); /* optional */
1696 parm= RNA_def_pointer(func, "group", "VertexGroup", "", "New vertex group.");
1697 RNA_def_function_return(func, parm);
1699 func= RNA_def_function(srna, "remove", "rna_Object_vgroup_remove");
1700 RNA_def_function_ui_description(func, "Delete vertex group from object.");
1701 parm= RNA_def_pointer(func, "group", "VertexGroup", "", "Vertex group to remove.");
1702 RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
1706 static void rna_def_object(BlenderRNA *brna)
1711 static EnumPropertyItem empty_drawtype_items[] = {
1712 {OB_PLAINAXES, "PLAIN_AXES", 0, "Plain Axes", ""},
1713 {OB_ARROWS, "ARROWS", 0, "Arrows", ""},
1714 {OB_SINGLE_ARROW, "SINGLE_ARROW", 0, "Single Arrow", ""},
1715 {OB_CIRCLE, "CIRCLE", 0, "Circle", ""},
1716 {OB_CUBE, "CUBE", 0, "Cube", ""},
1717 {OB_EMPTY_SPHERE, "SPHERE", 0, "Sphere", ""},
1718 {OB_EMPTY_CONE, "CONE", 0, "Cone", ""},
1719 {OB_EMPTY_IMAGE, "IMAGE", 0, "Image", ""},
1720 {0, NULL, 0, NULL, NULL}};
1722 static EnumPropertyItem track_items[] = {
1723 {OB_POSX, "POS_X", 0, "+X", ""},
1724 {OB_POSY, "POS_Y", 0, "+Y", ""},
1725 {OB_POSZ, "POS_Z", 0, "+Z", ""},
1726 {OB_NEGX, "NEG_X", 0, "-X", ""},
1727 {OB_NEGY, "NEG_Y", 0, "-Y", ""},
1728 {OB_NEGZ, "NEG_Z", 0, "-Z", ""},
1729 {0, NULL, 0, NULL, NULL}};
1731 static EnumPropertyItem up_items[] = {
1732 {OB_POSX, "X", 0, "X", ""},
1733 {OB_POSY, "Y", 0, "Y", ""},
1734 {OB_POSZ, "Z", 0, "Z", ""},
1735 {0, NULL, 0, NULL, NULL}};
1737 static EnumPropertyItem drawtype_items[] = {
1738 {OB_BOUNDBOX, "BOUNDS", 0, "Bounds", "Draw the bounding box of the object"},
1739 {OB_WIRE, "WIRE", 0, "Wire", "Draw the object as a wireframe"},
1740 {OB_SOLID, "SOLID", 0, "Solid", "Draw the object as a solid (If solid drawing is enabled in the viewport)"},
1741 // disabled {OB_SHADED, "SHADED", 0, "Shaded", ""},
1742 {OB_TEXTURE, "TEXTURED", 0, "Textured", "Draw the object with textures (If textures are enabled in the viewport)"},
1743 {0, NULL, 0, NULL, NULL}};
1745 static EnumPropertyItem boundtype_items[] = {
1746 {OB_BOUND_BOX, "BOX", 0, "Box", "Draw bounds as box"},
1747 {OB_BOUND_SPHERE, "SPHERE", 0, "Sphere", "Draw bounds as sphere"},
1748 {OB_BOUND_CYLINDER, "CYLINDER", 0, "Cylinder", "Draw bounds as cylinder"},
1749 {OB_BOUND_CONE, "CONE", 0, "Cone", "Draw bounds as cone"},
1750 {OB_BOUND_POLYH, "POLYHEDRON", 0, "Polyhedron", "Draw bounds as polyhedron"},
1751 {OB_BOUND_CAPSULE, "CAPSULE", 0, "Capsule", "Draw bounds as capsule"},
1752 {0, NULL, 0, NULL, NULL}};
1754 static EnumPropertyItem dupli_items[] = {
1755 {0, "NONE", 0, "None", ""},
1756 {OB_DUPLIFRAMES, "FRAMES", 0, "Frames", "Make copy of object for every frame"},
1757 {OB_DUPLIVERTS, "VERTS", 0, "Verts", "Duplicate child objects on all vertices"},
1758 {OB_DUPLIFACES, "FACES", 0, "Faces", "Duplicate child objects on all faces"},
1759 {OB_DUPLIGROUP, "GROUP", 0, "Group", "Enable group instancing"},
1760 {0, NULL, 0, NULL, NULL}};
1762 // XXX: this RNA enum define is currently duplicated for objects, since there is some text here which is not applicable
1763 static EnumPropertyItem prop_rotmode_items[] = {
1764 {ROT_MODE_QUAT, "QUATERNION", 0, "Quaternion (WXYZ)", "No Gimbal Lock"},
1765 {ROT_MODE_XYZ, "XYZ", 0, "XYZ Euler", "XYZ Rotation Order. Prone to Gimbal Lock. (Default)"},
1766 {ROT_MODE_XZY, "XZY", 0, "XZY Euler", "XZY Rotation Order. Prone to Gimbal Lock"},
1767 {ROT_MODE_YXZ, "YXZ", 0, "YXZ Euler", "YXZ Rotation Order. Prone to Gimbal Lock"},
1768 {ROT_MODE_YZX, "YZX", 0, "YZX Euler", "YZX Rotation Order. Prone to Gimbal Lock"},
1769 {ROT_MODE_ZXY, "ZXY", 0, "ZXY Euler", "ZXY Rotation Order. Prone to Gimbal Lock"},
1770 {ROT_MODE_ZYX, "ZYX", 0, "ZYX Euler", "ZYX Rotation Order. Prone to Gimbal Lock"},
1771 {ROT_MODE_AXISANGLE, "AXIS_ANGLE", 0, "Axis Angle", "Axis Angle (W+XYZ). Defines a rotation around some axis defined by 3D-Vector"},
1772 {0, NULL, 0, NULL, NULL}};
1774 static float default_quat[4] = {1,0,0,0}; /* default quaternion values */
1775 static float default_axisAngle[4] = {0,0,1,0}; /* default axis-angle rotation values */
1776 static float default_scale[3] = {1,1,1}; /* default scale values */
1777 static int boundbox_dimsize[]= {8, 3};
1779 srna= RNA_def_struct(brna, "Object", "ID");
1780 RNA_def_struct_ui_text(srna, "Object", "Object datablock defining an object in a scene");
1781 RNA_def_struct_clear_flag(srna, STRUCT_ID_REFCOUNT);
1782 RNA_def_struct_ui_icon(srna, ICON_OBJECT_DATA);
1784 prop= RNA_def_property(srna, "data", PROP_POINTER, PROP_NONE);
1785 RNA_def_property_struct_type(prop, "ID");
1786 RNA_def_property_pointer_funcs(prop, NULL, "rna_Object_data_set", "rna_Object_data_typef", NULL);
1787 RNA_def_property_flag(prop, PROP_EDITABLE|PROP_NEVER_UNLINK);
1788 RNA_def_property_ui_text(prop, "Data", "Object data");
1789 RNA_def_property_update(prop, 0, "rna_Object_internal_update_data");
1791 prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
1792 RNA_def_property_enum_sdna(prop, NULL, "type");
1793 RNA_def_property_enum_items(prop, object_type_items);
1794 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1795 RNA_def_property_ui_text(prop, "Type", "Type of Object");
1797 prop= RNA_def_property(srna, "mode", PROP_ENUM, PROP_NONE);
1798 RNA_def_property_enum_sdna(prop, NULL, "mode");
1799 RNA_def_property_enum_items(prop, object_mode_items);
1800 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1801 RNA_def_property_ui_text(prop, "Mode", "Object interaction mode");
1803 prop= RNA_def_property(srna, "layers", PROP_BOOLEAN, PROP_LAYER_MEMBER);
1804 RNA_def_property_boolean_sdna(prop, NULL, "lay", 1);
1805 RNA_def_property_array(prop, 20);
1806 RNA_def_property_ui_text(prop, "Layers", "Layers the object is on");
1807 RNA_def_property_boolean_funcs(prop, NULL, "rna_Object_layer_set");
1808 RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
1809 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Object_layer_update");
1811 prop= RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
1812 RNA_def_property_boolean_sdna(prop, NULL, "flag", SELECT);
1813 RNA_def_property_ui_text(prop, "Select", "Object selection state");
1814 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Object_select_update");
1816 /* for data access */
1817 prop= RNA_def_property(srna, "bound_box", PROP_FLOAT, PROP_NONE);
1818 RNA_def_property_multi_array(prop, 2, boundbox_dimsize);
1819 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1820 RNA_def_property_float_funcs(prop, "rna_Object_boundbox_get", NULL, NULL);
1821 RNA_def_property_ui_text(prop, "Bound Box", "Objects bound box in object-space coordinates, all values are -1.0 when not available.");
1824 prop= RNA_def_property(srna, "parent", PROP_POINTER, PROP_NONE);
1825 RNA_def_property_pointer_funcs(prop, NULL, "rna_Object_parent_set", NULL, NULL);
1826 RNA_def_property_flag(prop, PROP_EDITABLE|PROP_ID_SELF_CHECK);
1827 RNA_def_property_ui_text(prop, "Parent", "Parent Object");
1828 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Object_dependency_update");
1830 prop= RNA_def_property(srna, "parent_type", PROP_ENUM, PROP_NONE);
1831 RNA_def_property_enum_bitflag_sdna(prop, NULL, "partype");
1832 RNA_def_property_enum_items(prop, parent_type_items);
1833 RNA_def_property_enum_funcs(prop, NULL, "rna_Object_parent_type_set", "rna_Object_parent_type_itemf");
1834 RNA_def_property_ui_text(prop, "Parent Type", "Type of parent relation");
1835 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Object_dependency_update");
1837 prop= RNA_def_property(srna, "parent_vertices", PROP_INT, PROP_UNSIGNED);
1838 RNA_def_property_int_sdna(prop, NULL, "par1");
1839 RNA_def_property_array(prop, 3);
1840 RNA_def_property_ui_text(prop, "Parent Vertices", "Indices of vertices in cases of a vertex parenting relation");
1841 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Object_internal_update");
1843 prop= RNA_def_property(srna, "parent_bone", PROP_STRING, PROP_NONE);
1844 RNA_def_property_string_sdna(prop, NULL, "parsubstr");
1845 RNA_def_property_string_funcs(prop, NULL, NULL, "rna_Object_parent_bone_set");
1846 RNA_def_property_ui_text(prop, "Parent Bone", "Name of parent bone in case of a bone parenting relation");
1847 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Object_dependency_update");
1849 /* Track and Up flags */
1850 // XXX: these have been saved here for a bit longer (after old track was removed), since some other tools still refer to this
1851 prop= RNA_def_property(srna, "track_axis", PROP_ENUM, PROP_NONE);
1852 RNA_def_property_enum_sdna(prop, NULL, "trackflag");
1853 RNA_def_property_enum_items(prop, track_items);
1854 RNA_def_property_ui_text(prop, "Track Axis", "Axis that points in 'forward' direction (applies to DupliFrame when parent 'Follow' is enabled)");
1855 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Object_internal_update");
1857 prop= RNA_def_property(srna, "up_axis", PROP_ENUM, PROP_NONE);
1858 RNA_def_property_enum_sdna(prop, NULL, "upflag");
1859 RNA_def_property_enum_items(prop, up_items);
1860 RNA_def_property_ui_text(prop, "Up Axis", "Axis that points in the upward direction (applies to DupliFrame when parent 'Follow' is enabled)");
1861 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Object_internal_update");
1864 prop= RNA_def_property(srna, "proxy", PROP_POINTER, PROP_NONE);
1865 RNA_def_property_ui_text(prop, "Proxy", "Library object this proxy object controls");
1867 prop= RNA_def_property(srna, "proxy_group", PROP_POINTER, PROP_NONE);
1868 RNA_def_property_ui_text(prop, "Proxy Group", "Library group duplicator object this proxy object controls");
1871 prop= RNA_def_property(srna, "material_slots", PROP_COLLECTION, PROP_NONE);
1872 RNA_def_property_collection_sdna(prop, NULL, "mat", "totcol");
1873 RNA_def_property_struct_type(prop, "MaterialSlot");
1874 RNA_def_property_collection_funcs(prop, NULL, NULL, NULL, "rna_iterator_array_get", NULL, NULL, NULL); /* don't dereference pointer! */
1875 RNA_def_property_ui_text(prop, "Material Slots", "Material slots in the object");
1877 prop= RNA_def_property(srna, "active_material", PROP_POINTER, PROP_NONE);
1878 RNA_def_property_struct_type(prop, "Material");
1879 RNA_def_property_pointer_funcs(prop, "rna_Object_active_material_get", "rna_Object_active_material_set", NULL, NULL);
1880 RNA_def_property_flag(prop, PROP_EDITABLE);
1881 RNA_def_property_ui_text(prop, "Active Material", "Active material being displayed");
1882 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_MaterialSlot_update");
1884 prop= RNA_def_property(srna, "active_material_index", PROP_INT, PROP_UNSIGNED);
1885 RNA_def_property_int_sdna(prop, NULL, "actcol");
1886 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
1887 RNA_def_property_int_funcs(prop, "rna_Object_active_material_index_get", "rna_Object_active_material_index_set", "rna_Object_active_material_index_range");
1888 RNA_def_property_ui_text(prop, "Active Material Index", "Index of active material slot");
1889 RNA_def_property_update(prop, NC_MATERIAL|ND_SHADING, NULL);
1892 prop= RNA_def_property(srna, "location", PROP_FLOAT, PROP_TRANSLATION);
1893 RNA_def_property_float_sdna(prop, NULL, "loc");
1894 RNA_def_property_editable_array_func(prop, "rna_Object_location_editable");
1895 RNA_def_property_ui_range(prop, -FLT_MAX, FLT_MAX, 1, 3);
1896 RNA_def_property_ui_text(prop, "Location", "Location of the object");
1897 RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Object_internal_update");
1899 prop= RNA_def_property(srna, "rotation_quaternion", PROP_FLOAT, PROP_QUATERNION);
1900 RNA_def_property_float_sdna(prop, NULL, "quat");
1901 RNA_def_property_editable_array_func(prop, "rna_Object_rotation_4d_editable");
1902 RNA_def_property_float_array_default(prop, default_quat);
1903 RNA_def_property_ui_text(prop, "Quaternion Rotation", "Rotation in Quaternions");
1904 RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Object_internal_update");
1906 /* XXX: for axis-angle, it would have been nice to have 2 separate fields for UI purposes, but
1907 * having a single one is better for Keyframing and other property-management situations...
1909 prop= RNA_def_property(srna, "rotation_axis_angle", PROP_FLOAT, PROP_AXISANGLE);
1910 RNA_def_property_array(prop, 4);
1911 RNA_def_property_float_funcs(prop, "rna_Object_rotation_axis_angle_get", "rna_Object_rotation_axis_angle_set", NULL);
1912 RNA_def_property_editable_array_func(prop, "rna_Object_rotation_4d_editable");
1913 RNA_def_property_float_array_default(prop, default_axisAngle);
1914 RNA_def_property_ui_text(prop, "Axis-Angle Rotation", "Angle of Rotation for Axis-Angle rotation representation");
1915 RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Object_internal_update");
1917 prop= RNA_def_property(srna, "rotation_euler", PROP_FLOAT, PROP_EULER);
1918 RNA_def_property_float_sdna(prop, NULL, "rot");
1919 RNA_def_property_editable_array_func(prop, "rna_Object_rotation_euler_editable");
1920 RNA_def_property_ui_text(prop, "Euler Rotation", "Rotation in Eulers");
1921 RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Object_internal_update");
1923 prop= RNA_def_property(srna, "rotation_mode", PROP_ENUM, PROP_NONE);
1924 RNA_def_property_enum_sdna(prop, NULL, "rotmode");
1925 RNA_def_property_enum_items(prop, prop_rotmode_items); // XXX move to using a single define of this someday
1926 RNA_def_property_enum_funcs(prop, NULL, "rna_Object_rotation_mode_set", NULL);
1927 RNA_def_property_ui_text(prop, "Rotation Mode", "");
1928 RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Object_internal_update");
1930 prop= RNA_def_property(srna, "scale", PROP_FLOAT, PROP_XYZ);
1931 RNA_def_property_float_sdna(prop, NULL, "size");
1932 RNA_def_property_editable_array_func(prop, "rna_Object_scale_editable");
1933 RNA_def_property_ui_range(prop, -FLT_MAX, FLT_MAX, 1, 3);
1934 RNA_def_property_float_array_default(prop, default_scale);
1935 RNA_def_property_ui_text(prop, "Scale", "Scaling of the object");
1936 RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Object_internal_update");
1938 prop= RNA_def_property(srna, "dimensions", PROP_FLOAT, PROP_XYZ_LENGTH);
1939 RNA_def_property_array(prop, 3);
1940 RNA_def_property_float_funcs(prop, "rna_Object_dimensions_get", "rna_Object_dimensions_set", NULL);
1941 RNA_def_property_ui_range(prop, -FLT_MAX, FLT_MAX, 1, 3);
1942 RNA_def_property_ui_text(prop, "Dimensions", "Absolute bounding box dimensions of the object");
1943 RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Object_internal_update");
1946 /* delta transforms */
1947 prop= RNA_def_property(srna, "delta_location", PROP_FLOAT, PROP_TRANSLATION);
1948 RNA_def_property_float_sdna(prop, NULL, "dloc");
1949 RNA_def_property_ui_text(prop, "Delta Location", "Extra translation added to the location of the object");
1950 RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Object_internal_update");
1952 prop= RNA_def_property(srna, "delta_rotation_euler", PROP_FLOAT, PROP_EULER);
1953 RNA_def_property_float_sdna(prop, NULL, "drot");
1954 RNA_def_property_ui_text(prop, "Delta Rotation (Euler)", "Extra rotation added to the rotation of the object (when using Euler rotations)");
1955 RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Object_internal_update");
1957 prop= RNA_def_property(srna, "delta_rotation_quaternion", PROP_FLOAT, PROP_QUATERNION);
1958 RNA_def_property_float_sdna(prop, NULL, "dquat");
1959 RNA_def_property_float_array_default(prop, default_quat);
1960 RNA_def_property_ui_text(prop, "Delta Rotation (Quaternion)", "Extra rotation added to the rotation of the object (when using Quaternion rotations)");
1961 RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Object_internal_update");
1963 #if 0 // XXX not supported well yet...
1964 prop= RNA_def_property(srna, "delta_rotation_axis_angle", PROP_FLOAT, PROP_AXISANGLE);
1965 RNA_def_property_float_sdna(prop, NULL, "dquat"); // FIXME: this is not a single field any more! (drotAxis and drotAngle)
1966 RNA_def_property_float_array_default(prop, default_axisAngle);
1967 RNA_def_property_ui_text(prop, "Delta Rotation (Axis Angle)", "Extra rotation added to the rotation of the object (when using Axis-Angle rotations)");
1968 RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Object_internal_update");
1971 prop= RNA_def_property(srna, "delta_scale", PROP_FLOAT, PROP_XYZ);
1972 RNA_def_property_float_sdna(prop, NULL, "dsize");
1973 RNA_def_property_ui_text(prop, "Delta Scale", "Extra scaling added to the scale of the object");
1974 RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Object_internal_update");
1976 /* transform locks */
1977 prop= RNA_def_property(srna, "lock_location", PROP_BOOLEAN, PROP_XYZ);
1978 RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_LOCX);
1979 RNA_def_property_array(prop, 3);
1980 RNA_def_property_ui_text(prop, "Lock Location", "Lock editing of location in the interface");
1981 RNA_def_property_ui_icon(prop, ICON_UNLOCKED, 1);
1982 RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Object_internal_update");
1984 prop= RNA_def_property(srna, "lock_rotation", PROP_BOOLEAN, PROP_XYZ);
1985 RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_ROTX);
1986 RNA_def_property_array(prop, 3);
1987 RNA_def_property_ui_text(prop, "Lock Rotation", "Lock editing of rotation in the interface");
1988 RNA_def_property_ui_icon(prop, ICON_UNLOCKED, 1);
1989 RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Object_internal_update");
1991 // XXX this is sub-optimal - it really should be included above, but due to technical reasons we can't do this!
1992 prop= RNA_def_property(srna, "lock_rotation_w", PROP_BOOLEAN, PROP_NONE);
1993 RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_ROTW);
1994 RNA_def_property_ui_icon(prop, ICON_UNLOCKED, 1);
1995 RNA_def_property_ui_text(prop, "Lock Rotation (4D Angle)", "Lock editing of 'angle' component of four-component rotations in the interface");
1996 // XXX this needs a better name
1997 prop= RNA_def_property(srna, "lock_rotations_4d", PROP_BOOLEAN, PROP_NONE);
1998 RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_ROT4D);
1999 RNA_def_property_ui_text(prop, "Lock Rotations (4D)", "Lock editing of four component rotations by components (instead of as Eulers)");
2001 prop= RNA_def_property(srna, "lock_scale", PROP_BOOLEAN, PROP_XYZ);
2002 RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_SCALEX);
2003 RNA_def_property_array(prop, 3);
2004 RNA_def_property_ui_text(prop, "Lock Scale", "Lock editing of scale in the interface");
2005 RNA_def_property_ui_icon(prop, ICON_UNLOCKED, 1);
2006 RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Object_internal_update");
2009 prop= RNA_def_property(srna, "matrix_world", PROP_FLOAT, PROP_MATRIX);
2010 RNA_def_property_float_sdna(prop, NULL, "obmat");
2011 RNA_def_property_multi_array(prop, 2, rna_matrix_dimsize_4x4);
2012 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
2013 RNA_def_property_ui_text(prop, "Matrix World", "Worldspace transformation matrix");
2014 RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Object_matrix_world_update");
2016 prop= RNA_def_property(srna, "matrix_local", PROP_FLOAT, PROP_MATRIX);
2017 RNA_def_property_multi_array(prop, 2, rna_matrix_dimsize_4x4);
2018 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
2019 RNA_def_property_ui_text(prop, "Local Matrix", "Parent relative transformation matrix");
2020 RNA_def_property_float_funcs(prop, "rna_Object_matrix_local_get", "rna_Object_matrix_local_set", NULL);
2021 RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, NULL);
2023 prop= RNA_def_property(srna, "matrix_basis", PROP_FLOAT, PROP_MATRIX);
2024 RNA_def_property_multi_array(prop, 2, rna_matrix_dimsize_4x4);
2025 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
2026 RNA_def_property_ui_text(prop, "Input Matrix", "Matrix access to location, rotation and scale (including deltas), before constraints and parenting are applied.");
2027 RNA_def_property_float_funcs(prop, "rna_Object_matrix_basis_get", "rna_Object_matrix_basis_set", NULL);
2028 RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Object_internal_update");
2031 prop= RNA_def_property(srna, "constraints", PROP_COLLECTION, PROP_NONE);
2032 RNA_def_property_struct_type(prop, "Constraint");
2033 RNA_def_property_ui_text(prop, "Constraints", "Constraints affecting the transformation of the object");
2034 // RNA_def_property_collection_funcs(prop, 0, 0, 0, 0, 0, 0, 0, "constraints__add", "constraints__remove");
2035 rna_def_object_constraints(brna, prop);
2037 prop= RNA_def_property(srna, "modifiers", PROP_COLLECTION, PROP_NONE);
2038 RNA_def_property_struct_type(prop, "Modifier");
2039 RNA_def_property_ui_text(prop, "Modifiers", "Modifiers affecting the geometric data of the object");
2040 rna_def_object_modifiers(brna, prop);
2043 prop= RNA_def_property(srna, "game", PROP_POINTER, PROP_NONE);
2044 RNA_def_property_flag(prop, PROP_NEVER_NULL);
2045 RNA_def_property_struct_type(prop, "GameObjectSettings");
2046 RNA_def_property_pointer_funcs(prop, "rna_Object_game_settings_get", NULL, NULL, NULL);
2047 RNA_def_property_ui_text(prop, "Game Settings", "Game engine related settings for the object");
2050 prop= RNA_def_property(srna, "vertex_groups", PROP_COLLECTION, PROP_NONE);
2051 RNA_def_property_collection_sdna(prop, NULL, "defbase", NULL);
2052 RNA_def_property_struct_type(prop, "VertexGroup");
2053 RNA_def_property_ui_text(prop, "Vertex Groups", "Vertex groups of the object");
2054 rna_def_object_vertex_groups(brna, prop);
2057 prop= RNA_def_property(srna, "empty_draw_type", PROP_ENUM, PROP_NONE);
2058 RNA_def_property_enum_sdna(prop, NULL, "empty_drawtype");
2059 RNA_def_property_enum_items(prop, empty_drawtype_items);
2060 RNA_def_property_ui_text(prop, "Empty Display Type", "Viewport display style for empties");
2061 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
2063 prop= RNA_def_property(srna, "empty_draw_size", PROP_FLOAT, PROP_DISTANCE);
2064 RNA_def_property_float_sdna(prop, NULL, "empty_drawsize");
2065 RNA_def_property_range(prop, 0.0001f, 1000.0f);
2066 RNA_def_property_ui_range(prop, 0.01, 100, 1, 2);
2067 RNA_def_property_ui_text(prop, "Empty Display Size", "Size of display for empties in the viewport");
2068 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
2070 prop= RNA_def_property(srna, "empty_image_offset", PROP_FLOAT, PROP_DISTANCE);
2071 RNA_def_property_float_sdna(prop, NULL, "ima_ofs");
2072 RNA_def_property_ui_text(prop, "Origin Offset", "Origin offset distance");
2073 RNA_def_property_ui_range(prop, -FLT_MAX, FLT_MAX, 0.1f, 2);
2074 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
2077 prop= RNA_def_property(srna, "pass_index", PROP_INT, PROP_UNSIGNED);
2078 RNA_def_property_int_sdna(prop, NULL, "index");
2079 RNA_def_property_ui_text(prop, "Pass Index", "Index # for the IndexOB render pass");
2080 RNA_def_property_update(prop, NC_OBJECT, NULL);
2082 prop= RNA_def_property(srna, "color", PROP_FLOAT, PROP_COLOR);
2083 RNA_def_property_float_sdna(prop, NULL, "col");
2084 RNA_def_property_ui_text(prop, "Color", "Object color and alpha, used when faces have the ObColor mode enabled");
2085 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
2088 prop= RNA_def_property(srna, "field", PROP_POINTER, PROP_NONE);
2089 RNA_def_property_pointer_sdna(prop, NULL, "pd");
2090 RNA_def_property_struct_type(prop, "FieldSettings");
2091 RNA_def_property_pointer_funcs(prop, "rna_Object_field_get", NULL, NULL, NULL);
2092 RNA_def_property_ui_text(prop, "Field Settings", "Settings for using the objects as a field in physics simulation");
2094 prop= RNA_def_property(srna, "collision", PROP_POINTER, PROP_NONE);
2095 RNA_def_property_pointer_sdna(prop, NULL, "pd");
2096 RNA_def_property_struct_type(prop, "CollisionSettings");
2097 RNA_def_property_pointer_funcs(prop, "rna_Object_collision_get", NULL, NULL, NULL);
2098 RNA_def_property_ui_text(prop, "Collision Settings", "Settings for using the objects as a collider in physics simulation");
2100 prop= RNA_def_property(srna, "soft_body", PROP_POINTER, PROP_NONE);
2101 RNA_def_property_pointer_sdna(prop, NULL, "soft");
2102 RNA_def_property_struct_type(prop, "SoftBodySettings");
2103 RNA_def_property_ui_text(prop, "Soft Body Settings", "Settings for soft body simulation");
2105 prop= RNA_def_property(srna, "particle_systems", PROP_COLLECTION, PROP_NONE);
2106 RNA_def_property_collection_sdna(prop, NULL, "particlesystem", NULL);
2107 RNA_def_property_struct_type(prop, "ParticleSystem");
2108 RNA_def_property_ui_text(prop, "Particle Systems", "Particle systems emitted from the object");
2109 rna_def_object_particle_systems(brna, prop);
2112 prop= RNA_def_property(srna, "hide", PROP_BOOLEAN, PROP_NONE);
2113 RNA_def_property_boolean_sdna(prop, NULL, "restrictflag", OB_RESTRICT_VIEW);
2114 RNA_def_property_ui_text(prop, "Restrict View", "Restrict visibility in the viewport");
2115 RNA_def_property_ui_icon(prop, ICON_RESTRICT_VIEW_OFF, 1);
2116 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
2118 prop= RNA_def_property(srna, "hide_select", PROP_BOOLEAN, PROP_NONE);
2119 RNA_def_property_boolean_sdna(prop, NULL, "restrictflag", OB_RESTRICT_SELECT);
2120 RNA_def_property_ui_text(prop, "Restrict Select", "Restrict selection in the viewport");
2121 RNA_def_property_ui_icon(prop, ICON_RESTRICT_SELECT_OFF, 1);
2122 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
2124 prop= RNA_def_property(srna, "hide_render", PROP_BOOLEAN, PROP_NONE);
2125 RNA_def_property_boolean_sdna(prop, NULL, "restrictflag", OB_RESTRICT_RENDER);
2126 RNA_def_property_ui_text(prop, "Restrict Render", "Restrict renderability");
2127 RNA_def_property_ui_icon(prop, ICON_RESTRICT_RENDER_OFF, 1);
2128 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
2131 rna_def_animdata_common(srna);
2133 rna_def_animviz_common(srna);
2134 rna_def_motionpath_common(srna);
2137 // XXX: evil old crap
2138 prop= RNA_def_property(srna, "use_slow_parent", PROP_BOOLEAN, PROP_NONE);
2139 RNA_def_property_boolean_sdna(prop, NULL, "partype", PARSLOW);
2140 RNA_def_property_ui_text(prop, "Slow Parent", "Create a delay in the parent relationship");
2141 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Object_internal_update");
2143 prop= RNA_def_property(srna, "dupli_type", PROP_ENUM, PROP_NONE);
2144 RNA_def_property_enum_bitflag_sdna(prop, NULL, "transflag");
2145 RNA_def_property_enum_items(prop, dupli_items);
2146 RNA_def_property_ui_text(prop, "Dupli Type", "If not None, object duplication method to use");
2147 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Object_dependency_update");
2149 prop= RNA_def_property(srna, "use_dupli_frames_speed", PROP_BOOLEAN, PROP_NONE);
2150 RNA_def_property_boolean_negative_sdna(prop, NULL, "transflag", OB_DUPLINOSPEED);
2151 RNA_def_property_ui_text(prop, "Dupli Frames Speed", "Set dupliframes to use the frame"); // TODO, better descriptio!
2152 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Object_internal_update");
2154 prop= RNA_def_property(srna, "use_dupli_vertices_rotation", PROP_BOOLEAN, PROP_NONE);
2155 RNA_def_property_boolean_sdna(prop, NULL, "transflag", OB_DUPLIROT);
2156 RNA_def_property_ui_text(prop, "Dupli Verts Rotation", "Rotate dupli according to vertex normal");
2157 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
2159 prop= RNA_def_property(srna, "use_dupli_faces_scale", PROP_BOOLEAN, PROP_NONE);
2160 RNA_def_property_boolean_sdna(prop, NULL, "transflag", OB_DUPLIFACES_SCALE);
2161 RNA_def_property_ui_text(prop, "Dupli Faces Inherit Scale", "Scale dupli based on face size");
2162 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Object_internal_update");
2164 prop= RNA_def_property(srna, "dupli_faces_scale", PROP_FLOAT, PROP_NONE);
2165 RNA_def_property_float_sdna(prop, NULL, "dupfacesca");
2166 RNA_def_property_range(prop, 0.001f, 10000.0f);
2167 RNA_def_property_ui_text(prop, "Dupli Faces Scale", "Scale the DupliFace objects");
2168 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
2170 prop= RNA_def_property(srna, "dupli_group", PROP_POINTER, PROP_NONE);
2171 RNA_def_property_pointer_sdna(prop, NULL, "dup_group");
2172 RNA_def_property_flag(prop, PROP_EDITABLE);
2173 RNA_def_property_pointer_funcs(prop, NULL, "rna_Object_dup_group_set", NULL, NULL);
2174 RNA_def_property_ui_text(prop, "Dupli Group", "Instance an existing group");
2175 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Object_dependency_update");
2177 prop= RNA_def_property(srna, "dupli_frames_start", PROP_INT, PROP_NONE|PROP_UNIT_TIME);
2178 RNA_def_property_int_sdna(prop, NULL, "dupsta");
2179 RNA_def_property_range(prop, MINAFRAME, MAXFRAME);
2180 RNA_def_property_ui_text(prop, "Dupli Frames Start", "Start frame for DupliFrames");
2181 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Object_internal_update");
2183 prop= RNA_def_property(srna, "dupli_frames_end", PROP_INT, PROP_NONE|PROP_UNIT_TIME);
2184 RNA_def_property_int_sdna(prop, NULL, "dupend");
2185 RNA_def_property_range(prop, MINAFRAME, MAXFRAME);
2186 RNA_def_property_ui_text(prop, "Dupli Frames End", "End frame for DupliFrames");
2187 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Object_internal_update");
2189 prop= RNA_def_property(srna, "dupli_frames_on", PROP_INT, PROP_NONE|PROP_UNIT_TIME);
2190 RNA_def_property_int_sdna(prop, NULL, "dupon");
2191 RNA_def_property_range(prop, MINFRAME, MAXFRAME);
2192 RNA_def_property_ui_range(prop, 1, 1500, 1, 0);
2193 RNA_def_property_ui_text(prop, "Dupli Frames On", "Number of frames to use between DupOff frames");
2194 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Object_internal_update");
2196 prop= RNA_def_property(srna, "dupli_frames_off", PROP_INT, PROP_NONE|PROP_UNIT_TIME);
2197 RNA_def_property_int_sdna(prop, NULL, "dupoff");
2198 RNA_def_property_range(prop, 0, MAXFRAME);
2199 RNA_def_property_ui_range(prop, 0, 1500, 1, 0);
2200 RNA_def_property_ui_text(prop, "Dupli Frames Off", "Recurring frames to exclude from the Dupliframes");
2201 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Object_internal_update");
2203 prop= RNA_def_property(srna, "dupli_list", PROP_COLLECTION, PROP_NONE);
2204 RNA_def_property_collection_sdna(prop, NULL, "duplilist", NULL);
2205 RNA_def_property_struct_type(prop, "DupliObject");
2206 RNA_def_property_ui_text(prop, "Dupli list", "Object duplis");
2208 prop= RNA_def_property(srna, "is_duplicator", PROP_BOOLEAN, PROP_NONE);
2209 RNA_def_property_boolean_sdna(prop, NULL, "transflag", OB_DUPLI);
2210 RNA_def_property_clear_flag(prop, PROP_EDITABLE);
2213 prop= RNA_def_property(srna, "time_offset", PROP_FLOAT, PROP_NONE|PROP_UNIT_TIME);
2214 RNA_def_property_float_sdna(prop, NULL, "sf");
2215 RNA_def_property_range(prop, MINAFRAMEF, MAXFRAMEF);
2216 RNA_def_property_ui_text(prop, "Time Offset", "Animation offset in frames for F-Curve and dupligroup instances");
2217 RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Object_internal_update");
2219 prop= RNA_def_property(srna, "use_time_offset_edit", PROP_BOOLEAN, PROP_NONE);
2220 RNA_def_property_boolean_sdna(prop, NULL, "ipoflag", OB_OFFS_OB);
2221 RNA_def_property_ui_text(prop, "Time Offset Edit", "Use time offset when inserting keys and display time offset for F-Curve and action views");
2223 prop= RNA_def_property(srna, "use_time_offset_parent", PROP_BOOLEAN, PROP_NONE);
2224 RNA_def_property_boolean_sdna(prop, NULL, "ipoflag", OB_OFFS_PARENT);
2225 RNA_def_property_ui_text(prop, "Time Offset Parent", "Apply the time offset to this objects parent relationship");
2226 RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Object_internal_update");
2228 prop= RNA_def_property(srna, "use_time_offset_particle", PROP_BOOLEAN, PROP_NONE);
2229 RNA_def_property_boolean_sdna(prop, NULL, "ipoflag", OB_OFFS_PARTICLE);
2230 RNA_def_property_ui_text(prop, "Time Offset Particle", "Let the time offset work on the particle effect");
2231 RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Object_internal_update");
2233 prop= RNA_def_property(srna, "use_time_offset_add_parent", PROP_BOOLEAN, PROP_NONE);
2234 RNA_def_property_boolean_sdna(prop, NULL, "ipoflag", OB_OFFS_PARENTADD);
2235 RNA_def_property_ui_text(prop, "Time Offset Add Parent", "Add the parents time offset value");
2236 RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Object_internal_update");
2239 prop= RNA_def_property(srna, "draw_type", PROP_ENUM, PROP_NONE);
2240 RNA_def_property_enum_sdna(prop, NULL, "dt");
2241 RNA_def_property_enum_items(prop, drawtype_items);
2242 RNA_def_property_ui_text(prop, "Maximum Draw Type", "Maximum draw type to display object with in viewport");
2243 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
2245 prop= RNA_def_property(srna, "show_bounds", PROP_BOOLEAN, PROP_NONE);
2246 RNA_def_property_boolean_sdna(prop, NULL, "dtx", OB_BOUNDBOX);
2247 RNA_def_property_ui_text(prop, "Draw Bounds", "Displays the object's bounds");
2248 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
2250 prop= RNA_def_property(srna, "draw_bounds_type", PROP_ENUM, PROP_NONE);
2251 RNA_def_property_enum_sdna(prop, NULL, "boundtype");
2252 RNA_def_property_enum_items(prop, boundtype_items);
2253 RNA_def_property_ui_text(prop, "Draw Bounds Type", "Object boundary display type");
2254 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
2256 prop= RNA_def_property(srna, "show_name", PROP_BOOLEAN, PROP_NONE);
2257 RNA_def_property_boolean_sdna(prop, NULL, "dtx", OB_DRAWNAME);
2258 RNA_def_property_ui_text(prop, "Draw Name", "Displays the object's name");
2259 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
2261 prop= RNA_def_property(srna, "show_axis", PROP_BOOLEAN, PROP_NONE);
2262 RNA_def_property_boolean_sdna(prop, NULL, "dtx", OB_AXIS);
2263 RNA_def_property_ui_text(prop, "Draw Axis", "Displays the object's origin and axis");
2264 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
2266 prop= RNA_def_property(srna, "show_texture_space", PROP_BOOLEAN, PROP_NONE);
2267 RNA_def_property_boolean_sdna(prop, NULL, "dtx", OB_TEXSPACE);
2268 RNA_def_property_ui_text(prop, "Draw Texture Space", "Displays the object's texture space");
2269 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
2271 prop= RNA_def_property(srna, "show_wire", PROP_BOOLEAN, PROP_NONE);
2272 RNA_def_property_boolean_sdna(prop, NULL, "dtx", OB_DRAWWIRE);
2273 RNA_def_property_ui_text(prop, "Draw Wire", "Adds the object's wireframe over solid drawing");
2274 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
2276 prop= RNA_def_property(srna, "show_transparent", PROP_BOOLEAN, PROP_NONE);
2277 RNA_def_property_boolean_sdna(prop, NULL, "dtx", OB_DRAWTRANSP);
2278 RNA_def_property_ui_text(prop, "Draw Transparent", "Displays material transparency in the object");
2279 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
2281 prop= RNA_def_property(srna, "show_x_ray", PROP_BOOLEAN, PROP_NONE);
2282 RNA_def_property_boolean_sdna(prop, NULL, "dtx", OB_DRAWXRAY);
2283 RNA_def_property_ui_text(prop, "X-Ray", "Makes the object draw in front of others");
2284 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
2287 prop= RNA_def_property(srna, "grease_pencil", PROP_POINTER, PROP_NONE);
2288 RNA_def_property_pointer_sdna(prop, NULL, "gpd");
2289 RNA_def_property_flag(prop, PROP_EDITABLE);
2290 RNA_def_property_struct_type(prop, "GreasePencil");
2291 RNA_def_property_ui_text(prop, "Grease Pencil Data", "Grease Pencil datablock");
2294 prop= RNA_def_property(srna, "pose_library", PROP_POINTER, PROP_NONE);
2295 RNA_def_property_pointer_sdna(prop, NULL, "poselib");
2296 RNA_def_property_flag(prop, PROP_EDITABLE);
2297 RNA_def_property_struct_type(prop, "Action");
2298 RNA_def_property_ui_text(prop, "Pose Library", "Action used as a pose library for armatures");
2300 prop= RNA_def_property(srna, "pose", PROP_POINTER, PROP_NONE);
2301 RNA_def_property_pointer_sdna(prop, NULL, "pose");
2302 RNA_def_property_struct_type(prop, "Pose");
2303 RNA_def_property_ui_text(prop, "Pose", "Current pose for armatures");
2306 prop= RNA_def_property(srna, "show_only_shape_key", PROP_BOOLEAN, PROP_NONE);
2307 RNA_def_property_boolean_sdna(prop, NULL, "shapeflag", OB_SHAPE_LOCK);
2308 RNA_def_property_ui_text(prop, "Shape Key Lock", "Always show the current Shape for this Object");
2309 RNA_def_property_ui_icon(prop, ICON_UNPINNED, 1);
2310 RNA_def_property_update(prop, 0, "rna_Object_internal_update_data");
2312 prop= RNA_def_property(srna, "use_shape_key_edit_mode", PROP_BOOLEAN, PROP_NONE);
2313 RNA_def_property_boolean_sdna(prop, NULL, "shapeflag", OB_SHAPE_EDIT_MODE);
2314 RNA_def_property_ui_text(prop, "Shape Key Edit Mode", "Apply shape keys in edit mode (for Meshes only)");
2315 RNA_def_property_ui_icon(prop, ICON_EDITMODE_HLT, 0);
2316 RNA_def_property_update(prop, 0, "rna_Object_internal_update_data");
2318 prop= RNA_def_property(srna, "active_shape_key", PROP_POINTER, PROP_NONE);
2319 RNA_def_property_struct_type(prop, "ShapeKey");
2320 RNA_def_property_pointer_funcs(prop, "rna_Object_active_shape_key_get", NULL, NULL, NULL);
2321 RNA_def_property_ui_text(prop, "Active Shape Key", "Current shape key");
2323 prop= RNA_def_property(srna, "active_shape_key_index", PROP_INT, PROP_NONE);
2324 RNA_def_property_int_sdna(prop, NULL, "shapenr");
2325 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE); // XXX this is really unpredictable...
2326 RNA_def_property_int_funcs(prop, "rna_Object_active_shape_key_index_get", "rna_Object_active_shape_key_index_set", "rna_Object_active_shape_key_index_range");
2327 RNA_def_property_ui_text(prop, "Active Shape Key Index", "Current shape key index");
2328 RNA_def_property_update(prop, 0, "rna_Object_active_shape_update");
2330 RNA_api_object(srna);
2333 static void rna_def_dupli_object(BlenderRNA *brna)
2338 srna= RNA_def_struct(brna, "DupliObject", NULL);
2339 RNA_def_struct_sdna(srna, "DupliObject");
2340 RNA_def_struct_ui_text(srna, "Object Duplicate", "An object duplicate");
2341 /* RNA_def_struct_ui_icon(srna, ICON_OBJECT_DATA); */
2343 prop= RNA_def_property(srna, "object", PROP_POINTER, PROP_NONE);
2344 RNA_def_property_pointer_sdna(prop, NULL, "ob");
2345 /* RNA_def_property_pointer_funcs(prop, "rna_DupliObject_object_get", NULL, NULL, NULL); */
2346 RNA_def_property_ui_text(prop, "Object", "Object being duplicated");
2348 prop= RNA_def_property(srna, "matrix_original", PROP_FLOAT, PROP_MATRIX);
2349 RNA_def_property_float_sdna(prop, NULL, "omat");
2350 RNA_def_property_multi_array(prop, 2, rna_matrix_dimsize_4x4);
2351 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
2352 RNA_def_property_ui_text(prop, "Object Matrix", "The original matrix of this object before it was duplicated");
2354 prop= RNA_def_property(srna, "matrix", PROP_FLOAT, PROP_MATRIX);
2355 RNA_def_property_float_sdna(prop, NULL, "mat");
2356 RNA_def_property_multi_array(prop, 2, rna_matrix_dimsize_4x4);
2357 RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
2358 RNA_def_property_ui_text(prop, "Object Duplicate Matrix", "Object duplicate transformation matrix");
2360 /* TODO: DupliObject has more properties that can be wrapped */
2363 static void rna_def_object_base(BlenderRNA *brna)
2368 srna= RNA_def_struct(brna, "ObjectBase", NULL);
2369 RNA_def_struct_sdna(srna, "Base");
2370 RNA_def_struct_ui_text(srna, "Object Base", "An object instance in a scene");
2371 RNA_def_struct_ui_icon(srna, ICON_OBJECT_DATA);
2373 prop= RNA_def_property(srna, "object", PROP_POINTER, PROP_NONE);
2374 RNA_def_property_pointer_sdna(prop, NULL, "object");
2375 RNA_def_property_ui_text(prop, "Object", "Object this base links to");
2377 /* same as object layer */
2378 prop= RNA_def_property(srna, "layers", PROP_BOOLEAN, PROP_LAYER_MEMBER);
2379 RNA_def_property_boolean_sdna(prop, NULL, "lay", 1);
2380 RNA_def_property_array(prop, 20);
2381 RNA_def_property_ui_text(prop, "Layers", "Layers the object base is on");
2382 RNA_def_property_boolean_funcs(prop, NULL, "rna_Base_layer_set");
2383 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Base_layer_update");
2385 prop= RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
2386 RNA_def_property_boolean_sdna(prop, NULL, "flag", BA_SELECT);
2387 RNA_def_property_ui_text(prop, "Select", "Object base selection state");
2388 RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Base_select_update");
2390 RNA_api_object_base(srna);
2393 void RNA_def_object(BlenderRNA *brna)
2395 rna_def_object(brna);
2396 rna_def_object_game_settings(brna);
2397 rna_def_object_base(brna);
2398 rna_def_vertex_group(brna);
2399 rna_def_material_slot(brna);
2400 rna_def_dupli_object(brna);