From 61776befc3f88c373e47ccbdf8c75e2ca0f4e987 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Thu, 9 Dec 2021 00:55:11 +1100 Subject: Cleanup: move public doc-strings into headers for 'editors' Ref T92709 --- source/blender/editors/transform/transform_orientations.h | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) (limited to 'source/blender/editors/transform/transform_orientations.h') diff --git a/source/blender/editors/transform/transform_orientations.h b/source/blender/editors/transform/transform_orientations.h index 1da369c8307..6e0e3d9f8c7 100644 --- a/source/blender/editors/transform/transform_orientations.h +++ b/source/blender/editors/transform/transform_orientations.h @@ -25,6 +25,10 @@ struct TransInfo; +/** + * Sets the matrix of the specified space orientation. + * If the matrix cannot be obtained, an orientation different from the one informed is returned. + */ short transform_orientation_matrix_get(struct bContext *C, struct TransInfo *t, short orient_index, @@ -33,12 +37,19 @@ short transform_orientation_matrix_get(struct bContext *C, const char *transform_orientations_spacename_get(struct TransInfo *t, const short orient_type); void transform_orientations_current_set(struct TransInfo *t, const short orient_index); -/* Those two fill in mat and return non-zero on success */ +/** + * Those two fill in mat and return non-zero on success. + */ bool transform_orientations_create_from_axis(float mat[3][3], const float x[3], const float y[3], const float z[3]); bool createSpaceNormal(float mat[3][3], const float normal[3]); +/** + * \note To recreate an orientation from the matrix: + * - (plane == mat[1]) + * - (normal == mat[2]) + */ bool createSpaceNormalTangent(float mat[3][3], const float normal[3], const float tangent[3]); struct TransformOrientation *addMatrixSpace(struct bContext *C, -- cgit v1.2.3