From 0273d7e1a8544bb65a7b8919531d322dd38f0882 Mon Sep 17 00:00:00 2001 From: marioalexis Date: Fri, 24 Jun 2022 02:20:26 -0300 Subject: [PATCH] Base: Minor changes in some Python docstrings --- src/Base/MatrixPy.xml | 27 ++++++++++++++------------- src/Base/PlacementPy.xml | 2 +- 2 files changed, 15 insertions(+), 14 deletions(-) diff --git a/src/Base/MatrixPy.xml b/src/Base/MatrixPy.xml index f9f81f06fa..0e4122d010 100644 --- a/src/Base/MatrixPy.xml +++ b/src/Base/MatrixPy.xml @@ -18,12 +18,12 @@ This is the Matrix export class Base.Matrix class.\n A 4x4 Matrix. -In particular, this matrix can represent an affine transformation, that is, given a -3D vector `x`, apply the transformation y = M*x + b, where the matrix `M` is a linear -map and the vector `b` is a translation. -`y` can be obtained using a linear transformation represented by the 4x4 matrix `A` -conformed by the augmented 3x4 matrix (M|b), augmented by row with (0,0,0,1), therefore: -(y, 1) = A*(x, 1).\n +In particular, this matrix can represent an affine transformation, that is, +given a 3D vector `x`, apply the transformation y = M*x + b, where the matrix +`M` is a linear map and the vector `b` is a translation. +`y` can be obtained using a linear transformation represented by the 4x4 matrix +`A` conformed by the augmented 3x4 matrix (M|b), augmented by row with +(0,0,0,1), therefore: (y, 1) = A*(x, 1).\n The following constructors are supported:\n Matrix() Empty constructor.\n @@ -34,8 +34,9 @@ Matrix(*coef) Define from 16 coefficients of the 4x4 matrix. coef : sequence of float\n The sequence can have up to 16 elements which complete the matrix by rows.\n Matrix(vector1, vector2, vector3, vector4) -Define from four 3D vectors which represent the columns of the 3x4 submatrix, useful -to represent an affine transformation. The fourth row is made up by (0,0,0,1). +Define from four 3D vectors which represent the columns of the 3x4 submatrix, +useful to represent an affine transformation. The fourth row is made up by +(0,0,0,1). vector1 : Base.Vector vector2 : Base.Vector vector3 : Base.Vector @@ -115,7 +116,7 @@ matrix2 : Base.Matrix col(index) -> Base.Vector\n Return the vector of a column, that is, the vector generated by the three -first elements of the specified column. +first elements of the specified column.\n index : int\n Required column index. @@ -161,21 +162,21 @@ vector : Base.Vector rotateX(angle) -> None\n -Rotate around X axis. +Rotate around X axis.\n angle : float\n Angle in radians. rotateY(angle) -> None\n -Rotate around Y axis. +Rotate around Y axis.\n angle : float\n Angle in radians. rotateZ(angle) -> None\n -Rotate around Z axis. +Rotate around Z axis.\n angle : float\n Angle in radians. @@ -192,7 +193,7 @@ vector : Base.Vector multVec(vector) -> Base.Vector\n -Compute the transformed vector using the matrix. +Compute the transformed vector using the matrix.\n vector : Base.Vector diff --git a/src/Base/PlacementPy.xml b/src/Base/PlacementPy.xml index b6f599fbc9..658bd6f26a 100644 --- a/src/Base/PlacementPy.xml +++ b/src/Base/PlacementPy.xml @@ -37,7 +37,7 @@ base : Base.Vector rotation : Base.Rotation center : Base.Vector\n Placement(base, axis, angle) -define position and rotation +define position and rotation. base : Base.Vector axis : Base.Vector angle : float