[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [17938] branches/blender2.5/blender/source /blender: added "description" and "readonly" properties to RNA Structs ( also accessible via python)
Campbell Barton
ideasman42 at gmail.com
Fri Dec 19 05:06:50 CET 2008
Revision: 17938
http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=17938
Author: campbellbarton
Date: 2008-12-19 05:06:24 +0100 (Fri, 19 Dec 2008)
Log Message:
-----------
added "description" and "readonly" properties to RNA Structs (also accessible via python)
Many descriptions are not written, grep for DOC_BROKEN if you have some spare time to write struct descriptions.
Modified Paths:
--------------
branches/blender2.5/blender/source/blender/makesrna/RNA_access.h
branches/blender2.5/blender/source/blender/makesrna/RNA_define.h
branches/blender2.5/blender/source/blender/makesrna/RNA_types.h
branches/blender2.5/blender/source/blender/makesrna/intern/makesrna.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_ID.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_access.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_actuator.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_armature.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_brush.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_camera.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_color.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_constraint.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_controller.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_curve.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_define.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_group.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_image.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_internal_types.h
branches/blender2.5/blender/source/blender/makesrna/intern/rna_ipo.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_key.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_lamp.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_lattice.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_main.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_material.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_mesh.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_meta.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_modifier.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_nodetree.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_object.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_packedfile.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_property.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_radio.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_rna.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_scene.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_screen.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_sensor.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_sequence.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_vfont.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_wm.c
branches/blender2.5/blender/source/blender/makesrna/intern/rna_world.c
branches/blender2.5/blender/source/blender/windowmanager/intern/wm_operators.c
Modified: branches/blender2.5/blender/source/blender/makesrna/RNA_access.h
===================================================================
--- branches/blender2.5/blender/source/blender/makesrna/RNA_access.h 2008-12-19 03:26:41 UTC (rev 17937)
+++ branches/blender2.5/blender/source/blender/makesrna/RNA_access.h 2008-12-19 04:06:24 UTC (rev 17938)
@@ -187,6 +187,7 @@
const char *RNA_struct_identifier(PointerRNA *ptr);
const char *RNA_struct_ui_name(PointerRNA *ptr);
+const char *RNA_struct_ui_description(PointerRNA *ptr);
PropertyRNA *RNA_struct_name_property(PointerRNA *ptr);
PropertyRNA *RNA_struct_iterator_property(PointerRNA *ptr);
@@ -332,3 +333,4 @@
#endif /* RNA_ACCESS */
+
Modified: branches/blender2.5/blender/source/blender/makesrna/RNA_define.h
===================================================================
--- branches/blender2.5/blender/source/blender/makesrna/RNA_define.h 2008-12-19 03:26:41 UTC (rev 17937)
+++ branches/blender2.5/blender/source/blender/makesrna/RNA_define.h 2008-12-19 04:06:24 UTC (rev 17938)
@@ -39,13 +39,14 @@
/* Struct */
-StructRNA *RNA_def_struct(BlenderRNA *brna, const char *identifier, const char *from, const char *name);
+StructRNA *RNA_def_struct(BlenderRNA *brna, const char *identifier, const char *from);
void RNA_def_struct_sdna(StructRNA *srna, const char *structname);
void RNA_def_struct_sdna_from(StructRNA *srna, const char *structname, const char *propname);
void RNA_def_struct_name_property(StructRNA *srna, PropertyRNA *prop);
void RNA_def_struct_flag(StructRNA *srna, int flag);
void RNA_def_struct_funcs(StructRNA *srna, const char *notify, const char *refine);
-void RNA_def_struct_identifier(StructRNA *srna, const char *identifier, const char *name);
+void RNA_def_struct_identifier(StructRNA *srna, const char *identifier);
+void RNA_def_struct_ui_text(StructRNA *srna, const char *name, const char *description);
/* Property */
@@ -92,3 +93,4 @@
#endif /* RNA_DEFINE_H */
+
Modified: branches/blender2.5/blender/source/blender/makesrna/RNA_types.h
===================================================================
--- branches/blender2.5/blender/source/blender/makesrna/RNA_types.h 2008-12-19 03:26:41 UTC (rev 17937)
+++ branches/blender2.5/blender/source/blender/makesrna/RNA_types.h 2008-12-19 04:06:24 UTC (rev 17938)
@@ -144,3 +144,4 @@
#endif /* RNA_TYPES */
+
Modified: branches/blender2.5/blender/source/blender/makesrna/intern/makesrna.c
===================================================================
--- branches/blender2.5/blender/source/blender/makesrna/intern/makesrna.c 2008-12-19 03:26:41 UTC (rev 17937)
+++ branches/blender2.5/blender/source/blender/makesrna/intern/makesrna.c 2008-12-19 04:06:24 UTC (rev 17938)
@@ -861,6 +861,8 @@
rna_print_c_string(f, srna->identifier);
fprintf(f, ", %d, ", srna->flag);
rna_print_c_string(f, srna->name);
+ fprintf(f, ", ");
+ rna_print_c_string(f, srna->description);
fprintf(f, ",\n");
prop= srna->nameproperty;
Modified: branches/blender2.5/blender/source/blender/makesrna/intern/rna_ID.c
===================================================================
--- branches/blender2.5/blender/source/blender/makesrna/intern/rna_ID.c 2008-12-19 03:26:41 UTC (rev 17937)
+++ branches/blender2.5/blender/source/blender/makesrna/intern/rna_ID.c 2008-12-19 04:06:24 UTC (rev 17938)
@@ -106,7 +106,9 @@
/* this is struct is used for holding the virtual
* PropertyRNA's for ID properties */
- srna= RNA_def_struct(brna, "IDProperty", NULL, "ID Property");
+ srna= RNA_def_struct(brna, "IDProperty", NULL);
+ RNA_def_struct_ui_text(srna, "ID Property", "stores arbitrary properties");
+
/* IDP_STRING */
prop= RNA_def_property(srna, "string", PROP_STRING, PROP_NONE);
@@ -146,7 +148,8 @@
/* ID property groups > level 0, since level 0 group is merged
* with native RNA properties. the builtin_properties will take
* care of the properties here */
- srna= RNA_def_struct(brna, "IDPropertyGroup", NULL, "ID Property Group");
+ srna= RNA_def_struct(brna, "IDPropertyGroup", NULL);
+ RNA_def_struct_ui_text(srna, "ID Property Group", "a collection of properties");
}
static void rna_def_ID(BlenderRNA *brna)
@@ -154,7 +157,9 @@
StructRNA *srna;
PropertyRNA *prop;
- srna= RNA_def_struct(brna, "ID", NULL, "ID");
+ srna= RNA_def_struct(brna, "ID", NULL);
+ RNA_def_struct_ui_text(srna, "ID", "Used as a basis for dealing with many types with unique names, garbage collection and linked libraries");
+
RNA_def_struct_flag(srna, STRUCT_ID);
RNA_def_struct_funcs(srna, NULL, "rna_ID_refine");
@@ -186,7 +191,8 @@
StructRNA *srna;
PropertyRNA *prop;
- srna= RNA_def_struct(brna, "Library", "ID", "Library");
+ srna= RNA_def_struct(brna, "Library", "ID");
+ RNA_def_struct_ui_text(srna, "Library", "reference to an external blend file");
prop= RNA_def_property(srna, "filename", PROP_STRING, PROP_FILEPATH);
RNA_def_property_string_sdna(prop, NULL, "name");
@@ -195,8 +201,11 @@
}
void RNA_def_ID(BlenderRNA *brna)
{
+ StructRNA *srna;
/* simple built-in unknown type */
- RNA_def_struct(brna, "UnknownType", NULL, "Unknown Type");
+ srna= RNA_def_struct(brna, "UnknownType", NULL);
+ RNA_def_struct_ui_text(srna, "Unknown Type", "");
+
rna_def_ID(brna);
rna_def_ID_properties(brna);
Modified: branches/blender2.5/blender/source/blender/makesrna/intern/rna_access.c
===================================================================
--- branches/blender2.5/blender/source/blender/makesrna/intern/rna_access.c 2008-12-19 03:26:41 UTC (rev 17937)
+++ branches/blender2.5/blender/source/blender/makesrna/intern/rna_access.c 2008-12-19 04:06:24 UTC (rev 17938)
@@ -240,6 +240,11 @@
return ptr->type->name;
}
+const char *RNA_struct_ui_description(PointerRNA *ptr)
+{
+ return ptr->type->description;
+}
+
PropertyRNA *RNA_struct_name_property(PointerRNA *ptr)
{
return ptr->type->nameproperty;
Modified: branches/blender2.5/blender/source/blender/makesrna/intern/rna_actuator.c
===================================================================
--- branches/blender2.5/blender/source/blender/makesrna/intern/rna_actuator.c 2008-12-19 03:26:41 UTC (rev 17937)
+++ branches/blender2.5/blender/source/blender/makesrna/intern/rna_actuator.c 2008-12-19 04:06:24 UTC (rev 17938)
@@ -62,7 +62,9 @@
{ACT_STATE, "STATE", "State", ""},
{0, NULL, NULL, NULL}};
- srna= RNA_def_struct(brna, "Actuator", NULL , "Actuator");
+ srna= RNA_def_struct(brna, "Actuator", NULL);
+ RNA_def_struct_ui_text(srna, "Actuator", "logic brick to apply actions in the game engine");
+
RNA_def_struct_sdna(srna, "bActuator");
prop= RNA_def_property(srna, "actuator_name", PROP_STRING, PROP_NONE);
Modified: branches/blender2.5/blender/source/blender/makesrna/intern/rna_armature.c
===================================================================
--- branches/blender2.5/blender/source/blender/makesrna/intern/rna_armature.c 2008-12-19 03:26:41 UTC (rev 17937)
+++ branches/blender2.5/blender/source/blender/makesrna/intern/rna_armature.c 2008-12-19 04:06:24 UTC (rev 17938)
@@ -96,7 +96,8 @@
StructRNA *srna;
PropertyRNA *prop;
- srna= RNA_def_struct(brna, "Bone", NULL, "Bone");
+ srna= RNA_def_struct(brna, "Bone", NULL);
+ RNA_def_struct_ui_text(srna, "Bone", "member of the 'Armature' type");
/* pointers/collections */
/* parent (pointer) */
@@ -251,7 +252,9 @@
{ARM_GHOST_KEYS, "KEYS", "On Keyframes", "Draw Ghosts of poses on Keyframes."},
{0, NULL, NULL, NULL}};
- srna= RNA_def_struct(brna, "Armature", "ID", "Armature");
+ srna= RNA_def_struct(brna, "Armature", "ID");
+ RNA_def_struct_ui_text(srna, "Armature", "'Object' containing a hierarchy of 'Bones', often used to rig characters");
+
RNA_def_struct_sdna(srna, "bArmature");
/* Collections */
Modified: branches/blender2.5/blender/source/blender/makesrna/intern/rna_brush.c
===================================================================
--- branches/blender2.5/blender/source/blender/makesrna/intern/rna_brush.c 2008-12-19 03:26:41 UTC (rev 17937)
+++ branches/blender2.5/blender/source/blender/makesrna/intern/rna_brush.c 2008-12-19 04:06:24 UTC (rev 17938)
@@ -50,7 +50,8 @@
{BRUSH_BLEND_ADD_ALPHA, "ADD_ALPHA", "Add Alpha", "Add alpha while painting."},
{0, NULL, NULL, NULL}};
- srna= RNA_def_struct(brna, "Brush", "ID", "Brush");
+ srna= RNA_def_struct(brna, "Brush", "ID");
+ RNA_def_struct_ui_text(srna, "Brush", "stores brush setting for painting in the image view, sculpting and projection painting");
/* enums */
prop= RNA_def_property(srna, "blend", PROP_ENUM, PROP_NONE);
Modified: branches/blender2.5/blender/source/blender/makesrna/intern/rna_camera.c
===================================================================
--- branches/blender2.5/blender/source/blender/makesrna/intern/rna_camera.c 2008-12-19 03:26:41 UTC (rev 17937)
+++ branches/blender2.5/blender/source/blender/makesrna/intern/rna_camera.c 2008-12-19 04:06:24 UTC (rev 17938)
@@ -48,7 +48,8 @@
{CAM_ANGLETOGGLE, "DEGREES", "Degrees", ""},
{0, NULL, NULL, NULL}};
- srna= RNA_def_struct(brna, "Camera", "ID", "Camera");
+ srna= RNA_def_struct(brna, "Camera", "ID");
+ RNA_def_struct_ui_text(srna, "Camera", "'Object' data where camera settings are stored and animated");
/* Enums */
prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
Modified: branches/blender2.5/blender/source/blender/makesrna/intern/rna_color.c
===================================================================
--- branches/blender2.5/blender/source/blender/makesrna/intern/rna_color.c 2008-12-19 03:26:41 UTC (rev 17937)
+++ branches/blender2.5/blender/source/blender/makesrna/intern/rna_color.c 2008-12-19 04:06:24 UTC (rev 17938)
@@ -121,25 +121,26 @@
{0, NULL, NULL, NULL}
};
- srna= RNA_def_struct(brna, "CurveMapPoint", NULL, "CurveMapPoint");
+ srna= RNA_def_struct(brna, "CurveMapPoint", NULL);
+ RNA_def_struct_ui_text(srna, "CurveMapPoint", "member of 'CurveMap' where these points make up a curve");
/* not editable for now, need to have CurveMapping to do curvemapping_changed */
- prop= RNA_def_property(srna, "location", PROP_FLOAT, PROP_VECTOR);
+ prop= RNA_def_property(srna, "location", PROP_FLOAT, PROP_VECTOR);
RNA_def_property_float_sdna(prop, NULL, "x");
RNA_def_property_array(prop, 2);
RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
- RNA_def_property_ui_text(prop, "Location", "");
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list