From 941ea7050762f14adf4e32adec78ef21166a5f4e Mon Sep 17 00:00:00 2001 From: marioalexis Date: Fri, 27 May 2022 02:31:31 -0300 Subject: [PATCH] Base: Improve docstrings in PlacementPy.xml --- src/Base/PlacementPy.xml | 154 +++++++++++++++++++++------------------ 1 file changed, 82 insertions(+), 72 deletions(-) diff --git a/src/Base/PlacementPy.xml b/src/Base/PlacementPy.xml index 484c770d6a..9121889bf0 100644 --- a/src/Base/PlacementPy.xml +++ b/src/Base/PlacementPy.xml @@ -15,140 +15,150 @@ FatherNamespace="Base"> - Placement -A placement defines an orientation (rotation) and a position (base) in 3D space. -It is used when no scaling or other distortion is needed. - -The following constructors are supported: -Placement() -- empty constructor -Placement(Placement) -- copy constructor -Placement(Matrix) -- 4D matrix consisting of rotation and translation -Placement(Base, Rotation) -- define position and rotation -Placement(Base, Rotation,Center) -- define position and rotation with center -Placement(Base, Axis, Angle) -- define position and rotation - + Base.Placement class\n +A Placement defines an orientation (rotation) and a position (base) in 3D space. +It is used when no scaling or other distortion is needed.\n +The following constructors are supported:\n +Placement() +Empty constructor.\n +Placement(placement) +Copy constructor. +placement : Base.Placement\n +Placement(matrix) +Define from a 4D matrix consisting of rotation and translation. +matrix : Base.Matrix\n +Placement(base, rotation) +Define from position and rotation. +base : Base.Vector +rotation : Base.Rotation\n +Placement(base, rotation, center) +Define from position and rotation with center. +base : Base.Vector +rotation : Base.Rotation +center : Base.Vector\n +Placement(base, axis, angle) +define position and rotation +base : Base.Vector +axis : Base.Vector +angle : float Placement - - copy() - Returns a copy of this Placement - + copy() -> Base.Placement\n +Returns a copy of this placement. - - move(Vector) - Move the placement along the vector - + move(vector) -> None\n +Move the placement along a vector.\n +vector : Base.Vector\n Vector by which to move the placement. - - translate(Vector) - alias to move(), to be compatible with TopoShape.translate() - + translate(vector) -> None\n +Alias to move(), to be compatible with TopoShape.translate().\n +vector : Base.Vector\n Vector by which to move the placement. - - rotate(center,axis,degree) - rotate the current placement around center and axis with degree - This method is compatible with TopoShape.rotate() - + rotate(center, axis, angle) -> None\n +Rotate the current placement around center and axis with the given angle. +This method is compatible with TopoShape.rotate().\n +center : Base.Vector, sequence of float\n Rotation center. +axis : Base.Vector, sequence of float\n Rotation axis. +angle : float\n Rotation angle in degrees. - - multiply(Placement) - Multiply this placement with another placement - + multiply(placement) -> Base.Placement\n +Right multiply this placement with another placement. +Also available as `*` operator.\n +placement : Base.Placement\n Placement by which to multiply this placement. - - multVector(Vector) -> Vector - Compute the transformed vector using the placement - + multVec(vector) -> Base.Vector\n +Compute the transformed vector using the placement.\n +vector : Base.Vector\n Vector to be transformed. - - toMatrix() - convert the placement to a matrix representation - + toMatrix() -> Base.Matrix\n +Compute the matrix representation of the placement. - - inverse() -> Placement - compute the inverse placement - + inverse() -> Base.Placement\n +Compute the inverse placement. - - pow(t, shorten = true): raise this placement to real power using ScLERP interpolation. - If 'shorten' is true, ensures rotation quaternion is net positive, to make the path shorter. - Also available as ** operator. - + pow(t, shorten=True) -> Base.Placement\n +Raise this placement to real power using ScLERP interpolation. +Also available as `**` operator.\n +t : float\n Real power. +shorten : bool\n If True, ensures rotation quaternion is net positive to make + the path shorter. - - sclerp(placement2, t, shorten = True): interpolate between self and placement2. - Interpolation is a continuous motion along a helical path, made of equal transforms if discretized. - t = 0.0 - return self. t = 1.0 - return placement2. t can also be outside of 0..1 range, for extrapolation. - If quaternions of rotations of the two placements differ in sign, the interpolation will - take a long path. If 'shorten' is true, the signs are harmonized before interpolation, and the - interpolation takes the shorter path. - + sclerp(placement2, t, shorten=True) -> Base.Placement\n +Screw Linear Interpolation (ScLERP) between this placement and `placement2`. +Interpolation is a continuous motion along a helical path parametrized by `t` +made of equal transforms if discretized. +If quaternions of rotations of the two placements differ in sign, the interpolation +will take a long path.\n +placement2 : Base.Placement +t : float\n Parameter of helical path. t=0 returns this placement, t=1 returns + `placement2`. t can also be outside of [0, 1] range for extrapolation. +shorten : bool\n If True, the signs are harmonized before interpolation and the interpolation + takes the shorter path. - - slerp(placement2, t, shorten = True): interpolate between self and placement2. - This function performs independent interpolation of rotation and movement. - Result of such interpolation might be not what application expects, thus this - tool might be considered for simple cases or for interpolating between small intervals. - - For more complex cases you better use the advanced sclerp() function. - + slerp(placement2, t) -> Base.Placement\n +Spherical Linear Interpolation (SLERP) between this placement and `placement2`. +This function performs independent interpolation of rotation and movement. +Result of such interpolation might be not what application expects, thus this tool +might be considered for simple cases or for interpolating between small intervals. +For more complex cases you better use the advanced sclerp() function.\n +placement2 : Base.Placement +t : float\n Parameter of the path. t=0 returns this placement, t=1 returns `placement2`. - - isIdentity() -> Bool - returns True if the placement has no displacement and no rotation - + isIdentity() -> bool\n +Returns True if the placement has no displacement and no rotation. +Matrix representation is the 4D identity matrix. - Vector to the Base Position of the Placement + Vector to the Base Position of the Placement. - Orientation of the placement expressed as rotation + Orientation of the placement expressed as rotation. - Set/get matrix representation of this placement + Set/get matrix representation of the placement.