[bindings] remove redundant signatures. batch1
This commit is contained in:
@@ -51,16 +51,12 @@ class Axis(PyObjectBase):
|
||||
|
||||
def copy(self) -> Axis:
|
||||
"""
|
||||
copy() -> Base.Axis
|
||||
|
||||
Returns a copy of this Axis.
|
||||
"""
|
||||
...
|
||||
|
||||
def move(self, vector: Vector, /) -> None:
|
||||
"""
|
||||
move(vector) -> None
|
||||
|
||||
Move the axis base along the given vector.
|
||||
|
||||
vector : Base.Vector
|
||||
@@ -70,8 +66,6 @@ class Axis(PyObjectBase):
|
||||
|
||||
def multiply(self, placement: Placement, /) -> Axis:
|
||||
"""
|
||||
multiply(placement) -> Base.Axis
|
||||
|
||||
Multiply this axis by a placement.
|
||||
|
||||
placement : Base.Placement
|
||||
@@ -81,8 +75,6 @@ class Axis(PyObjectBase):
|
||||
|
||||
def reversed(self) -> Axis:
|
||||
"""
|
||||
reversed() -> Base.Axis
|
||||
|
||||
Compute the reversed axis. This returns a new Base.Axis with
|
||||
the original direction reversed.
|
||||
"""
|
||||
|
||||
@@ -121,8 +121,6 @@ class BoundBox(PyObjectBase):
|
||||
|
||||
def setVoid(self) -> None:
|
||||
"""
|
||||
setVoid() -> None
|
||||
|
||||
Invalidate the bounding box.
|
||||
"""
|
||||
...
|
||||
@@ -130,8 +128,6 @@ class BoundBox(PyObjectBase):
|
||||
@constmethod
|
||||
def isValid(self) -> bool:
|
||||
"""
|
||||
isValid() -> bool
|
||||
|
||||
Checks if the bounding box is valid.
|
||||
"""
|
||||
...
|
||||
@@ -150,9 +146,6 @@ class BoundBox(PyObjectBase):
|
||||
|
||||
def add(self, *args: Any, **kwargs: Any) -> None:
|
||||
"""
|
||||
add(minMax) -> None
|
||||
add(x, y, z) -> None
|
||||
|
||||
Increase the maximum values or decrease the minimum values of this BoundBox by
|
||||
replacing the current values with the given values, so the bounding box can grow
|
||||
but not shrink.
|
||||
@@ -171,8 +164,6 @@ class BoundBox(PyObjectBase):
|
||||
@constmethod
|
||||
def getPoint(self, index: int, /) -> Vector:
|
||||
"""
|
||||
getPoint(index) -> Base.Vector
|
||||
|
||||
Get the point of the given index.
|
||||
The index must be in the range of [0, 7].
|
||||
|
||||
@@ -183,8 +174,6 @@ class BoundBox(PyObjectBase):
|
||||
@constmethod
|
||||
def getEdge(self, index: int, /) -> Tuple[Vector, ...]:
|
||||
"""
|
||||
getEdge(index) -> tuple of Base.Vector
|
||||
|
||||
Get the edge points of the given index.
|
||||
The index must be in the range of [0, 11].
|
||||
|
||||
@@ -203,9 +192,6 @@ class BoundBox(PyObjectBase):
|
||||
@constmethod
|
||||
def closestPoint(self, *args: Any, **kwargs: Any) -> Vector:
|
||||
"""
|
||||
closestPoint(point) -> Base.Vector
|
||||
closestPoint(x, y, z) -> Base.Vector
|
||||
|
||||
Get the closest point of the bounding box to the given point.
|
||||
|
||||
point : Base.Vector, tuple
|
||||
@@ -234,9 +220,6 @@ class BoundBox(PyObjectBase):
|
||||
|
||||
def intersect(self, *args: Any) -> bool:
|
||||
"""
|
||||
intersect(boundBox2) -> bool
|
||||
intersect(base, dir) -> bool
|
||||
|
||||
Checks if the given object intersects with this bounding box. That can be
|
||||
another bounding box or a line specified by base and direction.
|
||||
|
||||
@@ -248,8 +231,6 @@ class BoundBox(PyObjectBase):
|
||||
|
||||
def intersected(self, boundBox2: "BoundBox", /) -> "BoundBox":
|
||||
"""
|
||||
intersected(boundBox2) -> Base.BoundBox
|
||||
|
||||
Returns the intersection of this and the given bounding box.
|
||||
|
||||
boundBox2 : Base.BoundBox
|
||||
@@ -258,8 +239,6 @@ class BoundBox(PyObjectBase):
|
||||
|
||||
def united(self, boundBox2: "BoundBox", /) -> "BoundBox":
|
||||
"""
|
||||
united(boundBox2) -> Base.BoundBox
|
||||
|
||||
Returns the union of this and the given bounding box.
|
||||
|
||||
boundBox2 : Base.BoundBox
|
||||
@@ -268,8 +247,6 @@ class BoundBox(PyObjectBase):
|
||||
|
||||
def enlarge(self, variation: float, /) -> None:
|
||||
"""
|
||||
enlarge(variation) -> None
|
||||
|
||||
Decrease the minimum values and increase the maximum values by the given value.
|
||||
A negative value shrinks the bounding box.
|
||||
|
||||
@@ -279,8 +256,6 @@ class BoundBox(PyObjectBase):
|
||||
|
||||
def getIntersectionPoint(self, base: Vector, dir: Vector, epsilon: float = 0.0001, /) -> Vector:
|
||||
"""
|
||||
getIntersectionPoint(base, dir, epsilon=0.0001) -> Base.Vector
|
||||
|
||||
Calculate the intersection point of a line with the bounding box.
|
||||
The base point must lie inside the bounding box, if not an exception is thrown.
|
||||
|
||||
@@ -307,9 +282,6 @@ class BoundBox(PyObjectBase):
|
||||
|
||||
def move(self, *args: Any, **kwargs: Any) -> None:
|
||||
"""
|
||||
move(displacement) -> None
|
||||
move(x, y, z) -> None
|
||||
|
||||
Move the bounding box by the given values.
|
||||
|
||||
displacement : Base.Vector, tuple
|
||||
@@ -337,9 +309,6 @@ class BoundBox(PyObjectBase):
|
||||
|
||||
def scale(self, *args: Any, **kwargs: Any) -> None:
|
||||
"""
|
||||
scale(factor) -> None
|
||||
scale(x, y, z) -> None
|
||||
|
||||
Scale the bounding box by the given values.
|
||||
|
||||
factor : Base.Vector, tuple
|
||||
@@ -355,8 +324,6 @@ class BoundBox(PyObjectBase):
|
||||
|
||||
def transformed(self, matrix: Matrix, /) -> "BoundBox":
|
||||
"""
|
||||
transformed(matrix) -> Base.BoundBox
|
||||
|
||||
Returns a new BoundBox containing the transformed rectangular cuboid
|
||||
represented by this BoundBox.
|
||||
|
||||
@@ -367,8 +334,6 @@ class BoundBox(PyObjectBase):
|
||||
|
||||
def isCutPlane(self, base: Vector, normal: Vector, /) -> bool:
|
||||
"""
|
||||
isCutPlane(base, normal) -> bool
|
||||
|
||||
Check if the plane specified by base and normal intersects (cuts) this bounding
|
||||
box.
|
||||
|
||||
@@ -391,9 +356,6 @@ class BoundBox(PyObjectBase):
|
||||
|
||||
def isInside(self, *args: Any) -> bool:
|
||||
"""
|
||||
isInside(object) -> bool
|
||||
isInside(x, y, z) -> bool
|
||||
|
||||
Check if a point or a bounding box is inside this bounding box.
|
||||
|
||||
object : Base.Vector, Base.BoundBox
|
||||
|
||||
@@ -45,8 +45,6 @@ class CoordinateSystem(PyObjectBase):
|
||||
|
||||
def setAxes(self, axis: Union[AxisPy, Vector], xDir: Vector, /) -> None:
|
||||
"""
|
||||
setAxes(axis, xDir) -> None
|
||||
|
||||
Set axis or Z-direction, and X-direction.
|
||||
The X-direction is determined from the orthonormal compononent of `xDir`
|
||||
with respect to `axis` direction.
|
||||
@@ -59,8 +57,6 @@ class CoordinateSystem(PyObjectBase):
|
||||
@constmethod
|
||||
def displacement(self, coordSystem2: "CoordinateSystem", /) -> Placement:
|
||||
"""
|
||||
displacement(coordSystem2) -> Base.Placement
|
||||
|
||||
Computes the placement from this to the passed coordinate system `coordSystem2`.
|
||||
|
||||
coordSystem2 : Base.CoordinateSystem
|
||||
@@ -69,8 +65,6 @@ class CoordinateSystem(PyObjectBase):
|
||||
|
||||
def transformTo(self, vector: Vector, /) -> Vector:
|
||||
"""
|
||||
transformTo(vector) -> Base.Vector
|
||||
|
||||
Computes the coordinates of the point in coordinates of this coordinate system.
|
||||
|
||||
vector : Base.Vector
|
||||
@@ -79,8 +73,6 @@ class CoordinateSystem(PyObjectBase):
|
||||
|
||||
def transform(self, trans: Union[Rotation, Placement], /) -> None:
|
||||
"""
|
||||
transform(trans) -> None
|
||||
|
||||
Applies a transformation on this coordinate system.
|
||||
|
||||
trans : Base.Rotation, Base.Placement
|
||||
@@ -89,8 +81,6 @@ class CoordinateSystem(PyObjectBase):
|
||||
|
||||
def setPlacement(self, placement: Placement, /) -> None:
|
||||
"""
|
||||
setPlacement(placement) -> None
|
||||
|
||||
Set placement to the coordinate system.
|
||||
|
||||
placement : Base.Placement
|
||||
|
||||
@@ -118,9 +118,6 @@ class Matrix(PyObjectBase):
|
||||
|
||||
def move(self, *args) -> None:
|
||||
"""
|
||||
move(vector) -> None
|
||||
move(x, y, z) -> None
|
||||
|
||||
Move the matrix along a vector, equivalent to left multiply the matrix
|
||||
by a pure translation transformation.
|
||||
|
||||
@@ -148,10 +145,6 @@ class Matrix(PyObjectBase):
|
||||
|
||||
def scale(self, *args) -> None:
|
||||
"""
|
||||
scale(vector) -> None
|
||||
scale(x, y, z) -> None
|
||||
scale(factor) -> None
|
||||
|
||||
Scale the first three rows of the matrix.
|
||||
|
||||
vector : Base.Vector
|
||||
@@ -169,8 +162,6 @@ class Matrix(PyObjectBase):
|
||||
@constmethod
|
||||
def hasScale(self, tol: float = 0, /) -> ScaleType:
|
||||
"""
|
||||
hasScale(tol=0) -> ScaleType
|
||||
|
||||
Return an enum value of ScaleType. Possible values are:
|
||||
Uniform, NonUniformLeft, NonUniformRight, NoScaling or Other
|
||||
if it's not a scale matrix.
|
||||
@@ -182,8 +173,6 @@ class Matrix(PyObjectBase):
|
||||
@constmethod
|
||||
def decompose(self) -> Tuple["Matrix", "Matrix", "Matrix", "Matrix"]:
|
||||
"""
|
||||
decompose() -> Base.Matrix, Base.Matrix, Base.Matrix, Base.Matrix
|
||||
|
||||
Return a tuple of matrices representing shear, scale, rotation and move.
|
||||
So that matrix = move * rotation * scale * shear.
|
||||
"""
|
||||
@@ -192,8 +181,6 @@ class Matrix(PyObjectBase):
|
||||
@no_args
|
||||
def nullify(self) -> None:
|
||||
"""
|
||||
nullify() -> None
|
||||
|
||||
Make this the null matrix.
|
||||
"""
|
||||
...
|
||||
@@ -202,8 +189,6 @@ class Matrix(PyObjectBase):
|
||||
@constmethod
|
||||
def isNull(self) -> bool:
|
||||
"""
|
||||
isNull() -> bool
|
||||
|
||||
Check if this is the null matrix.
|
||||
"""
|
||||
...
|
||||
@@ -211,8 +196,6 @@ class Matrix(PyObjectBase):
|
||||
@no_args
|
||||
def unity(self) -> None:
|
||||
"""
|
||||
unity() -> None
|
||||
|
||||
Make this matrix to unity (4D identity matrix).
|
||||
"""
|
||||
...
|
||||
@@ -220,16 +203,12 @@ class Matrix(PyObjectBase):
|
||||
@constmethod
|
||||
def isUnity(self, tol: float = 0.0, /) -> bool:
|
||||
"""
|
||||
isUnity([tol=0.0]) -> bool
|
||||
|
||||
Check if this is the unit matrix (4D identity matrix).
|
||||
"""
|
||||
...
|
||||
|
||||
def transform(self, vector: Vector, matrix2: "Matrix", /) -> None:
|
||||
"""
|
||||
transform(vector, matrix2) -> None
|
||||
|
||||
Transform the matrix around a given point.
|
||||
Equivalent to left multiply the matrix by T*M*T_inv, where M is `matrix2`, T the
|
||||
translation generated by `vector` and T_inv the inverse translation.
|
||||
@@ -244,8 +223,6 @@ class Matrix(PyObjectBase):
|
||||
@constmethod
|
||||
def col(self, index: int, /) -> Vector:
|
||||
"""
|
||||
col(index) -> Base.Vector
|
||||
|
||||
Return the vector of a column, that is, the vector generated by the three
|
||||
first elements of the specified column.
|
||||
|
||||
@@ -256,8 +233,6 @@ class Matrix(PyObjectBase):
|
||||
|
||||
def setCol(self, index: int, vector: Vector, /) -> None:
|
||||
"""
|
||||
setCol(index, vector) -> None
|
||||
|
||||
Set the vector of a column, that is, the three first elements of the specified
|
||||
column by index.
|
||||
|
||||
@@ -270,8 +245,6 @@ class Matrix(PyObjectBase):
|
||||
@constmethod
|
||||
def row(self, index: int, /) -> Vector:
|
||||
"""
|
||||
row(index) -> Base.Vector
|
||||
|
||||
Return the vector of a row, that is, the vector generated by the three
|
||||
first elements of the specified row.
|
||||
|
||||
@@ -282,8 +255,6 @@ class Matrix(PyObjectBase):
|
||||
|
||||
def setRow(self, index: int, vector: Vector, /) -> None:
|
||||
"""
|
||||
setRow(index, vector) -> None
|
||||
|
||||
Set the vector of a row, that is, the three first elements of the specified
|
||||
row by index.
|
||||
|
||||
@@ -297,16 +268,12 @@ class Matrix(PyObjectBase):
|
||||
@constmethod
|
||||
def diagonal(self) -> Vector:
|
||||
"""
|
||||
diagonal() -> Base.Vector
|
||||
|
||||
Return the diagonal of the 3x3 leading principal submatrix as vector.
|
||||
"""
|
||||
...
|
||||
|
||||
def setDiagonal(self, vector: Vector, /) -> None:
|
||||
"""
|
||||
setDiagonal(vector) -> None
|
||||
|
||||
Set the diagonal of the 3x3 leading principal submatrix.
|
||||
|
||||
vector : Base.Vector
|
||||
@@ -315,8 +282,6 @@ class Matrix(PyObjectBase):
|
||||
|
||||
def rotateX(self, angle: float, /) -> None:
|
||||
"""
|
||||
rotateX(angle) -> None
|
||||
|
||||
Rotate around X axis.
|
||||
|
||||
angle : float
|
||||
@@ -326,8 +291,6 @@ class Matrix(PyObjectBase):
|
||||
|
||||
def rotateY(self, angle: float, /) -> None:
|
||||
"""
|
||||
rotateY(angle) -> None
|
||||
|
||||
Rotate around Y axis.
|
||||
|
||||
angle : float
|
||||
@@ -337,8 +300,6 @@ class Matrix(PyObjectBase):
|
||||
|
||||
def rotateZ(self, angle: float, /) -> None:
|
||||
"""
|
||||
rotateZ(angle) -> None
|
||||
|
||||
Rotate around Z axis.
|
||||
|
||||
angle : float
|
||||
@@ -357,9 +318,6 @@ class Matrix(PyObjectBase):
|
||||
@constmethod
|
||||
def multiply(self, obj: Union["Matrix", Vector], /) -> Union["Matrix", Vector]:
|
||||
"""
|
||||
multiply(matrix) -> Base.Matrix
|
||||
multiply(vector) -> Base.Vector
|
||||
|
||||
Right multiply the matrix by the given object.
|
||||
If the argument is a vector, this is augmented to the 4D vector (`vector`, 1).
|
||||
|
||||
@@ -371,8 +329,6 @@ class Matrix(PyObjectBase):
|
||||
@constmethod
|
||||
def multVec(self, vector: Vector, /) -> Vector:
|
||||
"""
|
||||
multVec(vector) -> Base.Vector
|
||||
|
||||
Compute the transformed vector using the matrix.
|
||||
|
||||
vector : Base.Vector
|
||||
@@ -382,8 +338,6 @@ class Matrix(PyObjectBase):
|
||||
@no_args
|
||||
def invert(self) -> None:
|
||||
"""
|
||||
invert() -> None
|
||||
|
||||
Compute the inverse matrix in-place, if possible.
|
||||
"""
|
||||
...
|
||||
@@ -392,8 +346,6 @@ class Matrix(PyObjectBase):
|
||||
@constmethod
|
||||
def inverse(self) -> "Matrix":
|
||||
"""
|
||||
inverse() -> Base.Matrix
|
||||
|
||||
Compute the inverse matrix, if possible.
|
||||
"""
|
||||
...
|
||||
@@ -401,8 +353,6 @@ class Matrix(PyObjectBase):
|
||||
@no_args
|
||||
def transpose(self) -> None:
|
||||
"""
|
||||
transpose() -> None
|
||||
|
||||
Transpose the matrix in-place.
|
||||
"""
|
||||
...
|
||||
@@ -411,8 +361,6 @@ class Matrix(PyObjectBase):
|
||||
@constmethod
|
||||
def transposed(self) -> "Matrix":
|
||||
"""
|
||||
transposed() -> Base.Matrix
|
||||
|
||||
Returns a transposed copy of this matrix.
|
||||
"""
|
||||
...
|
||||
@@ -421,8 +369,6 @@ class Matrix(PyObjectBase):
|
||||
@constmethod
|
||||
def determinant(self) -> float:
|
||||
"""
|
||||
determinant() -> float
|
||||
|
||||
Compute the determinant of the matrix.
|
||||
"""
|
||||
...
|
||||
@@ -430,8 +376,6 @@ class Matrix(PyObjectBase):
|
||||
@constmethod
|
||||
def isOrthogonal(self, tol: float = 1e-6, /) -> float:
|
||||
"""
|
||||
isOrthogonal(tol=1e-6) -> float
|
||||
|
||||
Checks if the matrix is orthogonal, i.e. M * M^T = k*I and returns
|
||||
the multiple of the identity matrix. If it's not orthogonal 0 is returned.
|
||||
|
||||
@@ -443,8 +387,6 @@ class Matrix(PyObjectBase):
|
||||
@constmethod
|
||||
def submatrix(self, dim: int, /) -> "Matrix":
|
||||
"""
|
||||
submatrix(dim) -> Base.Matrix
|
||||
|
||||
Get the leading principal submatrix of the given dimension.
|
||||
The (4 - `dim`) remaining dimensions are completed with the
|
||||
corresponding identity matrix.
|
||||
@@ -458,8 +400,6 @@ class Matrix(PyObjectBase):
|
||||
@constmethod
|
||||
def analyze(self) -> str:
|
||||
"""
|
||||
analyze() -> str
|
||||
|
||||
Analyzes the type of transformation.
|
||||
"""
|
||||
...
|
||||
|
||||
@@ -26,8 +26,6 @@ class Persistence(BaseClass):
|
||||
@constmethod
|
||||
def dumpContent(self, Compression: int = 3) -> bytearray:
|
||||
"""
|
||||
dumpContent(Compression=3) -> bytearray
|
||||
|
||||
Dumps the content of the object, both the XML representation and the additional
|
||||
data files required, into a byte representation.
|
||||
|
||||
@@ -39,8 +37,6 @@ class Persistence(BaseClass):
|
||||
def restoreContent(self, obj: object, /) -> None:
|
||||
# TODO: Starting with Python 3.12, collections.abc.Buffer can be used for type hinting
|
||||
"""
|
||||
restoreContent(obj) -> None
|
||||
|
||||
Restore the content of the object from a byte representation as stored by `dumpContent`.
|
||||
It could be restored from any Python object implementing the buffer protocol.
|
||||
|
||||
|
||||
@@ -89,16 +89,12 @@ class Placement(PyObjectBase):
|
||||
@constmethod
|
||||
def copy(self) -> "Placement":
|
||||
"""
|
||||
copy() -> Base.Placement
|
||||
|
||||
Returns a copy of this placement.
|
||||
"""
|
||||
...
|
||||
|
||||
def move(self, vector: Vector, /) -> None:
|
||||
"""
|
||||
move(vector) -> None
|
||||
|
||||
Move the placement along a vector.
|
||||
|
||||
vector : Base.Vector
|
||||
@@ -108,8 +104,6 @@ class Placement(PyObjectBase):
|
||||
|
||||
def translate(self, vector: Vector, /) -> None:
|
||||
"""
|
||||
translate(vector) -> None
|
||||
|
||||
Alias to move(), to be compatible with TopoShape.translate().
|
||||
|
||||
vector : Base.Vector
|
||||
@@ -126,8 +120,6 @@ class Placement(PyObjectBase):
|
||||
@overload
|
||||
def rotate(self, center: Vector, axis: Vector, angle: float, *, comp: bool = False) -> None:
|
||||
"""
|
||||
rotate(center, axis, angle, comp) -> None
|
||||
|
||||
Rotate the current placement around center and axis with the given angle.
|
||||
This method is compatible with TopoShape.rotate() if the (optional) keyword
|
||||
argument comp is True (default=False).
|
||||
@@ -149,8 +141,6 @@ class Placement(PyObjectBase):
|
||||
@constmethod
|
||||
def multiply(self, placement: "Placement", /) -> "Placement":
|
||||
"""
|
||||
multiply(placement) -> Base.Placement
|
||||
|
||||
Right multiply this placement with another placement.
|
||||
Also available as `*` operator.
|
||||
|
||||
@@ -162,8 +152,6 @@ class Placement(PyObjectBase):
|
||||
@constmethod
|
||||
def multVec(self, vector: Vector, /) -> Vector:
|
||||
"""
|
||||
multVec(vector) -> Base.Vector
|
||||
|
||||
Compute the transformed vector using the placement.
|
||||
|
||||
vector : Base.Vector
|
||||
@@ -174,8 +162,6 @@ class Placement(PyObjectBase):
|
||||
@constmethod
|
||||
def toMatrix(self) -> MatrixPy:
|
||||
"""
|
||||
toMatrix() -> Base.Matrix
|
||||
|
||||
Compute the matrix representation of the placement.
|
||||
"""
|
||||
...
|
||||
@@ -183,8 +169,6 @@ class Placement(PyObjectBase):
|
||||
@constmethod
|
||||
def inverse(self) -> "Placement":
|
||||
"""
|
||||
inverse() -> Base.Placement
|
||||
|
||||
Compute the inverse placement.
|
||||
"""
|
||||
...
|
||||
@@ -192,8 +176,6 @@ class Placement(PyObjectBase):
|
||||
@constmethod
|
||||
def pow(self, t: float, shorten: bool = True, /) -> "Placement":
|
||||
"""
|
||||
pow(t, shorten=True) -> Base.Placement
|
||||
|
||||
Raise this placement to real power using ScLERP interpolation.
|
||||
Also available as `**` operator.
|
||||
|
||||
@@ -208,8 +190,6 @@ class Placement(PyObjectBase):
|
||||
@constmethod
|
||||
def sclerp(self, placement2: "Placement", t: float, shorten: bool = True, /) -> "Placement":
|
||||
"""
|
||||
sclerp(placement2, t, shorten=True) -> Base.Placement
|
||||
|
||||
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.
|
||||
@@ -229,8 +209,6 @@ class Placement(PyObjectBase):
|
||||
@constmethod
|
||||
def slerp(self, placement2: "Placement", t: float, /) -> "Placement":
|
||||
"""
|
||||
slerp(placement2, t) -> Base.Placement
|
||||
|
||||
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
|
||||
@@ -246,8 +224,6 @@ class Placement(PyObjectBase):
|
||||
@constmethod
|
||||
def isIdentity(self, tol: float = 0.0, /) -> bool:
|
||||
"""
|
||||
isIdentity([tol=0.0]) -> bool
|
||||
|
||||
Returns True if the placement has no displacement and no rotation.
|
||||
Matrix representation is the 4D identity matrix.
|
||||
tol : float
|
||||
@@ -259,8 +235,6 @@ class Placement(PyObjectBase):
|
||||
@constmethod
|
||||
def isSame(self, other: "Placement", tol: float = 0.0, /) -> bool:
|
||||
"""
|
||||
isSame(Base.Placement, [tol=0.0]) -> bool
|
||||
|
||||
Checks whether this and the given placement are the same.
|
||||
The default tolerance is set to 0.0
|
||||
"""
|
||||
|
||||
@@ -66,8 +66,6 @@ class Quantity(PyObjectBase):
|
||||
@constmethod
|
||||
def toStr(self, decimals: int = ..., /) -> str:
|
||||
"""
|
||||
toStr([decimals])
|
||||
|
||||
Returns a string representation rounded to number of decimals. If no decimals are specified then
|
||||
the internal precision is used
|
||||
"""
|
||||
|
||||
@@ -132,8 +132,6 @@ class Rotation(PyObjectBase):
|
||||
|
||||
def invert(self) -> None:
|
||||
"""
|
||||
invert() -> None
|
||||
|
||||
Sets the rotation to its inverse.
|
||||
"""
|
||||
...
|
||||
@@ -141,16 +139,12 @@ class Rotation(PyObjectBase):
|
||||
@constmethod
|
||||
def inverted(self) -> "Rotation":
|
||||
"""
|
||||
inverted() -> Base.Rotation
|
||||
|
||||
Returns the inverse of the rotation.
|
||||
"""
|
||||
...
|
||||
|
||||
def isSame(self, rotation: "Rotation", tol: float = 0, /) -> bool:
|
||||
"""
|
||||
isSame(rotation, tol=0) -> bool
|
||||
|
||||
Checks if `rotation` perform the same transformation as this rotation.
|
||||
|
||||
rotation : Base.Rotation
|
||||
@@ -163,8 +157,6 @@ class Rotation(PyObjectBase):
|
||||
@constmethod
|
||||
def multiply(self, rotation: "Rotation", /) -> "Rotation":
|
||||
"""
|
||||
multiply(rotation) -> Base.Rotation
|
||||
|
||||
Right multiply this rotation with another rotation.
|
||||
|
||||
rotation : Base.Rotation
|
||||
@@ -175,8 +167,6 @@ class Rotation(PyObjectBase):
|
||||
@constmethod
|
||||
def multVec(self, vector: Vector, /) -> Vector:
|
||||
"""
|
||||
multVec(vector) -> Base.Vector
|
||||
|
||||
Compute the transformed vector using the rotation.
|
||||
|
||||
vector : Base.Vector
|
||||
@@ -187,8 +177,6 @@ class Rotation(PyObjectBase):
|
||||
@constmethod
|
||||
def slerp(self, rotation2: "Rotation", t: float, /) -> "Rotation":
|
||||
"""
|
||||
slerp(rotation2, t) -> Base.Rotation
|
||||
|
||||
Spherical Linear Interpolation (SLERP) of this rotation and `rotation2`.
|
||||
|
||||
t : float
|
||||
@@ -198,8 +186,6 @@ class Rotation(PyObjectBase):
|
||||
|
||||
def setYawPitchRoll(self, angle1: float, angle2: float, angle3: float, /) -> None:
|
||||
"""
|
||||
setYawPitchRoll(angle1, angle2, angle3) -> None
|
||||
|
||||
Set the Euler angles of this rotation as yaw-pitch-roll in XY'Z'' convention.
|
||||
|
||||
angle1 : float
|
||||
@@ -214,8 +200,6 @@ class Rotation(PyObjectBase):
|
||||
@constmethod
|
||||
def getYawPitchRoll(self) -> Tuple[float, float, float]:
|
||||
"""
|
||||
getYawPitchRoll() -> tuple
|
||||
|
||||
Get the Euler angles of this rotation as yaw-pitch-roll in XY'Z'' convention.
|
||||
The angles are given in degrees.
|
||||
"""
|
||||
@@ -223,8 +207,6 @@ class Rotation(PyObjectBase):
|
||||
|
||||
def setEulerAngles(self, seq: str, angle1: float, angle2: float, angle3: float, /) -> None:
|
||||
"""
|
||||
setEulerAngles(seq, angle1, angle2, angle3) -> None
|
||||
|
||||
Set the Euler angles in a given sequence for this rotation.
|
||||
The angles must be given in degrees.
|
||||
|
||||
@@ -239,8 +221,6 @@ class Rotation(PyObjectBase):
|
||||
@constmethod
|
||||
def toEulerAngles(self, seq: str = "", /) -> List[float]:
|
||||
"""
|
||||
toEulerAngles(seq) -> list
|
||||
|
||||
Get the Euler angles in a given sequence for this rotation.
|
||||
|
||||
seq : str
|
||||
@@ -252,8 +232,6 @@ class Rotation(PyObjectBase):
|
||||
@constmethod
|
||||
def toMatrix(self) -> Matrix:
|
||||
"""
|
||||
toMatrix() -> Base.Matrix
|
||||
|
||||
Convert the rotation to a 4D matrix representation.
|
||||
"""
|
||||
...
|
||||
@@ -261,8 +239,6 @@ class Rotation(PyObjectBase):
|
||||
@constmethod
|
||||
def isNull(self) -> bool:
|
||||
"""
|
||||
isNull() -> bool
|
||||
|
||||
Returns True if all values in the quaternion representation are zero.
|
||||
"""
|
||||
...
|
||||
@@ -270,8 +246,6 @@ class Rotation(PyObjectBase):
|
||||
@constmethod
|
||||
def isIdentity(self, tol: float = 0, /) -> bool:
|
||||
"""
|
||||
isIdentity(tol=0) -> bool
|
||||
|
||||
Returns True if the rotation equals the 4D identity matrix.
|
||||
tol : float
|
||||
Tolerance used to check for identity.
|
||||
|
||||
@@ -38,8 +38,6 @@ class Type(PyObjectBase):
|
||||
@staticmethod
|
||||
def fromName(name: str, /) -> "Type":
|
||||
"""
|
||||
fromName(name) -> Base.BaseType
|
||||
|
||||
Returns a type object by name.
|
||||
|
||||
name : str
|
||||
@@ -49,8 +47,6 @@ class Type(PyObjectBase):
|
||||
@staticmethod
|
||||
def fromKey(key: int, /) -> "Type":
|
||||
"""
|
||||
fromKey(key) -> Base.BaseType
|
||||
|
||||
Returns a type id object by key.
|
||||
|
||||
key : int
|
||||
@@ -60,8 +56,6 @@ class Type(PyObjectBase):
|
||||
@staticmethod
|
||||
def getNumTypes() -> int:
|
||||
"""
|
||||
getNumTypes() -> int
|
||||
|
||||
Returns the number of type ids created so far.
|
||||
"""
|
||||
...
|
||||
@@ -69,8 +63,6 @@ class Type(PyObjectBase):
|
||||
@staticmethod
|
||||
def getBadType() -> "Type":
|
||||
"""
|
||||
getBadType() -> Base.BaseType
|
||||
|
||||
Returns an invalid type id.
|
||||
"""
|
||||
...
|
||||
@@ -78,8 +70,6 @@ class Type(PyObjectBase):
|
||||
@staticmethod
|
||||
def getAllDerivedFrom(type: str, /) -> List[str]:
|
||||
"""
|
||||
getAllDerivedFrom(type) -> list
|
||||
|
||||
Returns all descendants from the given type id.
|
||||
|
||||
type : str, Base.BaseType
|
||||
@@ -89,8 +79,6 @@ class Type(PyObjectBase):
|
||||
@constmethod
|
||||
def getParent(self) -> "Type":
|
||||
"""
|
||||
getParent() -> Base.BaseType
|
||||
|
||||
Returns the parent type id.
|
||||
"""
|
||||
...
|
||||
@@ -98,8 +86,6 @@ class Type(PyObjectBase):
|
||||
@constmethod
|
||||
def isBad(self) -> bool:
|
||||
"""
|
||||
isBad() -> bool
|
||||
|
||||
Checks if the type id is invalid.
|
||||
"""
|
||||
...
|
||||
@@ -107,8 +93,6 @@ class Type(PyObjectBase):
|
||||
@constmethod
|
||||
def isDerivedFrom(self, type: str, /) -> bool:
|
||||
"""
|
||||
isDerivedFrom(type) -> bool
|
||||
|
||||
Returns true if given type id is a father of this type id.
|
||||
|
||||
type : str, Base.BaseType
|
||||
@@ -118,16 +102,12 @@ class Type(PyObjectBase):
|
||||
@constmethod
|
||||
def getAllDerived(self) -> List[object]:
|
||||
"""
|
||||
getAllDerived() -> list
|
||||
|
||||
Returns all descendants from this type id.
|
||||
"""
|
||||
...
|
||||
|
||||
def createInstance(self) -> object:
|
||||
"""
|
||||
createInstance() -> object
|
||||
|
||||
Creates an instance of this type id.
|
||||
"""
|
||||
...
|
||||
@@ -135,8 +115,6 @@ class Type(PyObjectBase):
|
||||
@staticmethod
|
||||
def createInstanceByName(name: str, load: bool = False, /) -> object:
|
||||
"""
|
||||
createInstanceByName(name, load=False) -> object
|
||||
|
||||
Creates an instance of the named type id.
|
||||
|
||||
name : str
|
||||
|
||||
@@ -89,8 +89,6 @@ class Vector(PyObjectBase):
|
||||
@constmethod
|
||||
def __reduce__(self) -> tuple:
|
||||
"""
|
||||
__reduce__() -> tuple
|
||||
|
||||
Serialization of Vector objects.
|
||||
"""
|
||||
...
|
||||
@@ -98,8 +96,6 @@ class Vector(PyObjectBase):
|
||||
@constmethod
|
||||
def add(self, vector2: "Vector", /) -> "Vector":
|
||||
"""
|
||||
add(vector2) -> Base.Vector
|
||||
|
||||
Returns the sum of this vector and `vector2`.
|
||||
|
||||
vector2 : Base.Vector
|
||||
@@ -109,8 +105,6 @@ class Vector(PyObjectBase):
|
||||
@constmethod
|
||||
def sub(self, vector2: "Vector", /) -> "Vector":
|
||||
"""
|
||||
sub(vector2) -> Base.Vector
|
||||
|
||||
Returns the difference of this vector and `vector2`.
|
||||
|
||||
vector2 : Base.Vector
|
||||
@@ -120,16 +114,12 @@ class Vector(PyObjectBase):
|
||||
@constmethod
|
||||
def negative(self) -> "Vector":
|
||||
"""
|
||||
negative() -> Base.Vector
|
||||
|
||||
Returns the negative (opposite) of this vector.
|
||||
"""
|
||||
...
|
||||
|
||||
def scale(self, x: float, y: float, z: float, /) -> "Vector":
|
||||
"""
|
||||
scale(x, y, z) -> Base.Vector
|
||||
|
||||
Scales in-place this vector by the given factor in each component.
|
||||
|
||||
x : float
|
||||
@@ -143,8 +133,6 @@ class Vector(PyObjectBase):
|
||||
|
||||
def multiply(self, factor: float, /) -> "Vector":
|
||||
"""
|
||||
multiply(factor) -> Base.Vector
|
||||
|
||||
Multiplies in-place each component of this vector by a single factor.
|
||||
Equivalent to scale(factor, factor, factor).
|
||||
|
||||
@@ -155,8 +143,6 @@ class Vector(PyObjectBase):
|
||||
@constmethod
|
||||
def dot(self, vector2: "Vector", /) -> float:
|
||||
"""
|
||||
dot(vector2) -> float
|
||||
|
||||
Returns the scalar product (dot product) between this vector and `vector2`.
|
||||
|
||||
vector2 : Base.Vector
|
||||
@@ -166,8 +152,6 @@ class Vector(PyObjectBase):
|
||||
@constmethod
|
||||
def cross(self, vector2: "Vector", /) -> "Vector":
|
||||
"""
|
||||
cross(vector2) -> Base.Vector
|
||||
|
||||
Returns the vector product (cross product) between this vector and `vector2`.
|
||||
|
||||
vector2 : Base.Vector
|
||||
@@ -177,8 +161,6 @@ class Vector(PyObjectBase):
|
||||
@constmethod
|
||||
def isOnLineSegment(self, vector1: "Vector", vector2: "Vector", /) -> bool:
|
||||
"""
|
||||
isOnLineSegment(vector1, vector2) -> bool
|
||||
|
||||
Checks if this vector is on the line segment generated by `vector1` and `vector2`.
|
||||
|
||||
vector1 : Base.Vector
|
||||
@@ -189,8 +171,6 @@ class Vector(PyObjectBase):
|
||||
@constmethod
|
||||
def getAngle(self, vector2: "Vector", /) -> float:
|
||||
"""
|
||||
getAngle(vector2) -> float
|
||||
|
||||
Returns the angle in radians between this vector and `vector2`.
|
||||
|
||||
vector2 : Base.Vector
|
||||
@@ -199,8 +179,6 @@ class Vector(PyObjectBase):
|
||||
|
||||
def normalize(self) -> "Vector":
|
||||
"""
|
||||
normalize() -> Base.Vector
|
||||
|
||||
Normalizes in-place this vector to the length of 1.0.
|
||||
"""
|
||||
...
|
||||
@@ -208,8 +186,6 @@ class Vector(PyObjectBase):
|
||||
@constmethod
|
||||
def isEqual(self, vector2: "Vector", tol: float = 0, /) -> bool:
|
||||
"""
|
||||
isEqual(vector2, tol=0) -> bool
|
||||
|
||||
Checks if the distance between the points represented by this vector
|
||||
and `vector2` is less or equal to the given tolerance.
|
||||
|
||||
@@ -221,8 +197,6 @@ class Vector(PyObjectBase):
|
||||
@constmethod
|
||||
def isParallel(self, vector2: "Vector", tol: float = 0, /) -> bool:
|
||||
"""
|
||||
isParallel(vector2, tol=0) -> bool
|
||||
|
||||
Checks if this vector and `vector2` are
|
||||
parallel less or equal to the given tolerance.
|
||||
|
||||
@@ -234,8 +208,6 @@ class Vector(PyObjectBase):
|
||||
@constmethod
|
||||
def isNormal(self, vector2: "Vector", tol: float = 0, /) -> bool:
|
||||
"""
|
||||
isNormal(vector2, tol=0) -> bool
|
||||
|
||||
Checks if this vector and `vector2` are
|
||||
normal less or equal to the given tolerance.
|
||||
|
||||
@@ -246,8 +218,6 @@ class Vector(PyObjectBase):
|
||||
|
||||
def projectToLine(self, point: "Vector", dir: "Vector", /) -> "Vector":
|
||||
"""
|
||||
projectToLine(point, dir) -> Base.Vector
|
||||
|
||||
Projects `point` on a line that goes through the origin with the direction `dir`.
|
||||
The result is the vector from `point` to the projected point.
|
||||
The operation is equivalent to dir_n.cross(dir_n.cross(point)), where `dir_n` is
|
||||
@@ -262,8 +232,6 @@ class Vector(PyObjectBase):
|
||||
|
||||
def projectToPlane(self, base: "Vector", normal: "Vector", /) -> "Vector":
|
||||
"""
|
||||
projectToPlane(base, normal) -> Base.Vector
|
||||
|
||||
Projects in-place this vector on a plane defined by a base point
|
||||
represented by `base` and a normal defined by `normal`.
|
||||
|
||||
@@ -275,8 +243,6 @@ class Vector(PyObjectBase):
|
||||
@constmethod
|
||||
def distanceToPoint(self, point2: "Vector", /) -> float:
|
||||
"""
|
||||
distanceToPoint(point2) -> float
|
||||
|
||||
Returns the distance to another point represented by `point2`.
|
||||
.
|
||||
point : Base.Vector
|
||||
@@ -286,8 +252,6 @@ class Vector(PyObjectBase):
|
||||
@constmethod
|
||||
def distanceToLine(self, base: "Vector", dir: "Vector", /) -> float:
|
||||
"""
|
||||
distanceToLine(base, dir) -> float
|
||||
|
||||
Returns the distance between the point represented by this vector
|
||||
and a line defined by a base point represented by `base` and a
|
||||
direction `dir`.
|
||||
@@ -300,8 +264,6 @@ class Vector(PyObjectBase):
|
||||
@constmethod
|
||||
def distanceToLineSegment(self, point1: "Vector", point2: "Vector", /) -> "Vector":
|
||||
"""
|
||||
distanceToLineSegment(point1, point2) -> Base.Vector
|
||||
|
||||
Returns the vector between the point represented by this vector and the point
|
||||
on the line segment with the shortest distance. The line segment is defined by
|
||||
`point1` and `point2`.
|
||||
@@ -314,8 +276,6 @@ class Vector(PyObjectBase):
|
||||
@constmethod
|
||||
def distanceToPlane(self, base: "Vector", normal: "Vector", /) -> float:
|
||||
"""
|
||||
distanceToPlane(base, normal) -> float
|
||||
|
||||
Returns the distance between this vector and a plane defined by a
|
||||
base point represented by `base` and a normal defined by `normal`.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user