diff --git a/src/Mod/Part/App/TopoShapeFacePy.xml b/src/Mod/Part/App/TopoShapeFacePy.xml index 985d668e4c..c3809f047f 100644 --- a/src/Mod/Part/App/TopoShapeFacePy.xml +++ b/src/Mod/Part/App/TopoShapeFacePy.xml @@ -1,189 +1,212 @@ - - - - TopoShapeFace is the OpenCasCade topological face wrapper - - - - Adds a wire to the face. - - - - - Offset the face by a given amount. Returns Compound of Wires. Deprecated - use makeOffset2D instead. - - - - - -getUVNodes() --> list -Get the list of (u,v) nodes of the tessellation + + + + TopoShapeFace is the OpenCasCade topological face wrapper + + + + Adds a wire to the face. +addWire(wire) + + + + + + Offset the face by a given amount. +makeOffset(dist) -> Face +-- +Returns Compound of Wires. Deprecated - use makeOffset2D instead. + + + + + + Get the list of (u,v) nodes of the tessellation +getUVNodes() -> list +-- An exception is raised if the face is not triangulated. - - - - - Get the tangent in u and v isoparametric at the given point if defined - - - - - Vector = valueAt(pos) - Get the point at the given parameter [0|Length] if defined - - - - - Vector = normalAt(pos) - Get the normal vector at the given parameter [0|Length] if defined - - - - - Vector = d1At(pos) - Get the first derivative at the given parameter [0|Length] if defined - - - - - Vector = d2At(pos) - Get the second derivative at the given parameter [0|Length] if defined - - - - - Float = curvatureAt(pos) - Get the curvature at the given parameter [0|Length] if defined - - - - - Check if a given (u,v) pair is inside the domain of a face - - - - - Make a half-space solid by this face and a reference point. - - - - - Validate the face. - - - - - -curveonSurface(Edge) -> None or tuple -Returns the curve associated to the edge in the -parametric space of the face. Returns None if this -curve does not exist. If this curve exists then a tuple -of curve and parameter range is returned. - - - - - - Cut holes in the face. -aFace.cutHoles(list_of_wires) - - - - - - Set or get the tolerance of the vertex - - - - - - Returns a 4 tuple with the parameter range - - - - - - Returns the geometric surface of the face - - - - - - The outer wire of this face + + + + + Get the tangent in u and v isoparametric at the given point if defined +tangentAt(u,v) -> Vector + + + + + + Get the point at the given parameter [0|Length] if defined +valueAt(u,v) -> Vector + + + + + + Get the normal vector at the given parameter [0|Length] if defined +normalAt(pos) -> Vector + + + + + + Get the first derivative at the given parameter [0|Length] if defined +derivative1At(u,v) -> (vectorU,vectorV) + + + + + + Vector = d2At(pos) - Get the second derivative at the given parameter [0|Length] if defined +derivative2At(u,v) -> (vectorU,vectorV) + + + + + + Get the curvature at the given parameter [0|Length] if defined +curvatureAt(u,v) -> Float + + + + + + Check if a given (u,v) pair is inside the domain of a face +isPartOfDomain(u,v) -> bool + + + + + + Make a half-space solid by this face and a reference point. +makeHalfSpace(pos) -> Shape + + + + + + Validate the face. +validate() + + + + + + Returns the curve associated to the edge in the parametric space of the face. +curveOnSurface(Edge) -> (curve, min, max) or None +-- +If this curve exists then a tuple of curve and parameter range is returned. +Returns None if this curve does not exist. + + + + + + Cut holes in the face. +cutHoles(list_of_wires) + + + + + + Set or get the tolerance of the vertex + + + + + + Returns a 4 tuple with the parameter range + + + + + + Returns the geometric surface of the face + + + + + + The outer wire of this face deprecated -- please use OuterWire - - - - - - The outer wire of this face - - - - - - Returns the mass of the current system. - - - - - - Returns the center of mass of the current system. + + + + + + The outer wire of this face + + + + + + Returns the mass of the current system. + + + + + + Returns the center of mass of the current system. If the gravitational field is uniform, it is the center of gravity. The coordinates returned for the center of mass are expressed in the absolute Cartesian coordinate system. - - - - - - Returns the matrix of inertia. It is a symmetrical matrix. -The coefficients of the matrix are the quadratic moments of -inertia. + + + + + + Returns the matrix of inertia. It is a symmetrical matrix. +The coefficients of the matrix are the quadratic moments of +inertia. - | Ixx Ixy Ixz 0 | - | Ixy Iyy Iyz 0 | - | Ixz Iyz Izz 0 | - | 0 0 0 1 | + | Ixx Ixy Ixz 0 | + | Ixy Iyy Iyz 0 | + | Ixz Iyz Izz 0 | + | 0 0 0 1 | -The moments of inertia are denoted by Ixx, Iyy, Izz. -The products of inertia are denoted by Ixy, Ixz, Iyz. -The matrix of inertia is returned in the central coordinate -system (G, Gx, Gy, Gz) where G is the centre of mass of the -system and Gx, Gy, Gz the directions parallel to the X(1,0,0) -Y(0,1,0) Z(0,0,1) directions of the absolute cartesian +The moments of inertia are denoted by Ixx, Iyy, Izz. +The products of inertia are denoted by Ixy, Ixz, Iyz. +The matrix of inertia is returned in the central coordinate +system (G, Gx, Gy, Gz) where G is the centre of mass of the +system and Gx, Gy, Gz the directions parallel to the X(1,0,0) +Y(0,1,0) Z(0,0,1) directions of the absolute cartesian coordinate system. - - - - - - Returns Ix, Iy, Iz, the static moments of inertia of the - current system; i.e. the moments of inertia about the + + + + + + Returns Ix, Iy, Iz, the static moments of inertia of the + current system; i.e. the moments of inertia about the three axes of the Cartesian coordinate system. - - - - - - Computes the principal properties of inertia of the current system. - There is always a set of axes for which the products - of inertia of a geometric system are equal to 0; i.e. the - matrix of inertia of the system is diagonal. These axes - are the principal axes of inertia. Their origin is - coincident with the center of mass of the system. The - associated moments are called the principal moments of inertia. - This function computes the eigen values and the + + + + + + Computes the principal properties of inertia of the current system. + There is always a set of axes for which the products + of inertia of a geometric system are equal to 0; i.e. the + matrix of inertia of the system is diagonal. These axes + are the principal axes of inertia. Their origin is + coincident with the center of mass of the system. The + associated moments are called the principal moments of inertia. + This function computes the eigen values and the eigen vectors of the matrix of inertia of the system. - - - - + + + +