Docs: add a doc-string for rotation_mode

Based on the report #135332, it's not obvious that rotation modes that
aren't selected aren't used, note this in the doc-string.

Ref !136103
This commit is contained in:
Campbell Barton
2025-03-18 22:39:30 +11:00
parent 5fc3303a35
commit 3f9c08d960
3 changed files with 15 additions and 3 deletions

View File

@@ -3064,7 +3064,11 @@ static void rna_def_object(BlenderRNA *brna)
RNA_def_property_enum_sdna(prop, nullptr, "rotmode");
RNA_def_property_enum_items(prop, rna_enum_object_rotation_mode_items);
RNA_def_property_enum_funcs(prop, nullptr, "rna_Object_rotation_mode_set", nullptr);
RNA_def_property_ui_text(prop, "Rotation Mode", "");
RNA_def_property_ui_text(
prop,
"Rotation Mode",
/* This description is shared by other "rotation_mode" properties. */
"The kind of rotation to apply, values from other rotation modes aren't used");
RNA_def_property_update(prop, NC_OBJECT | ND_TRANSFORM, "rna_Object_internal_update");
prop = RNA_def_property(srna, "scale", PROP_FLOAT, PROP_XYZ);

View File

@@ -865,7 +865,11 @@ static void rna_def_pose_channel(BlenderRNA *brna)
/* XXX... disabled, since proxy-locked layers are currently
* used for ensuring proxy-syncing too */
RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
RNA_def_property_ui_text(prop, "Rotation Mode", "");
RNA_def_property_ui_text(
prop,
"Rotation Mode",
/* This description is shared by other "rotation_mode" properties. */
"The kind of rotation to apply, values from other rotation modes aren't used");
RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_update");
/* Curved bones settings - Applied on top of rest-pose values. */

View File

@@ -3096,7 +3096,11 @@ static void rna_def_view3d_cursor(BlenderRNA *brna)
RNA_def_property_enum_sdna(prop, nullptr, "rotation_mode");
RNA_def_property_enum_items(prop, rna_enum_object_rotation_mode_items);
RNA_def_property_enum_funcs(prop, nullptr, "rna_View3DCursor_rotation_mode_set", nullptr);
RNA_def_property_ui_text(prop, "Rotation Mode", "");
RNA_def_property_ui_text(
prop,
"Rotation Mode",
/* This description is shared by other "rotation_mode" properties. */
"The kind of rotation to apply, values from other rotation modes aren't used");
RNA_def_property_update(prop, NC_WINDOW, nullptr);
/* Matrix access to avoid having to check current rotation mode. */