RNA Armature: Improve the description of AxisRollFromMatrix

The roll value may not be as expected when a matrix is not orthogonal
or has a negative determinant.

This can lead to confusion as seen in T82930.

Therefore, make it clear that this is a limitation and that a value for
the roll is somewhat indeterminable in these cases.

This fixes T82930
This commit is contained in:
Germano Cavalcante 2020-11-25 11:43:16 -03:00
parent f67f895770
commit 8330e19cb2
Notes: blender-bot 2023-02-14 10:32:59 +01:00
Referenced by issue #82930, bpy.types.Bone.AxisRollFromMatrix() returns bad roll value
1 changed files with 3 additions and 1 deletions

View File

@ -196,7 +196,9 @@ void RNA_api_bone(StructRNA *srna)
func = RNA_def_function(srna, "AxisRollFromMatrix", "rna_Bone_AxisRollFromMatrix");
RNA_def_function_ui_description(func,
"Convert a rotational matrix to the axis + roll representation");
"Convert a rotational matrix to the axis + roll representation. "
"Note that the resulting value of the roll may not be as "
"expected if the matrix has shear or negative determinant.");
RNA_def_function_flag(func, FUNC_NO_SELF);
parm = RNA_def_property(func, "matrix", PROP_FLOAT, PROP_MATRIX);
RNA_def_property_multi_array(parm, 2, rna_matrix_dimsize_3x3);