BRepOffsetAPI

Cancels the results of all taper-adding transformations performed by this algorithm on the initial shape. These results will have been defined by successive calls to the function Add.

Initializes, or reinitializes this taper-adding algorithm with the shape S. S will be referred to as the initial shape of this algorithm.

Adds the face F, the direction Direction, the angle Angle, the plane NeutralPlane, and the flag Flag to the framework created at construction time, and with this data, defines the taper-adding transformation. F is a face, which belongs to the initial shape of this algorithm or to the shape loaded by the function Init. Only planar, cylindrical or conical faces can be tapered:

• If the face F is planar, it is tapered by inclining it through the angle Angle about the line of intersection between the plane NeutralPlane and F. Direction indicates the side of NeutralPlane from which matter is removed if Angle is positive or added if Angle is negative.
• If F is cylindrical or conical, it is transformed in the same way on a single face, resulting in a conical face if F is cylindrical, and a conical or cylindrical face if it is already conical. The taper-adding transformation is propagated from the face F along the series of planar, cylindrical or conical faces containing F, which are tangential to one another. Use the function AddDone to check if this taper-adding transformation is successful. Warning Nothing is done if:
• the face F does not belong to the initial shape of this algorithm, or
• the face F is not planar, cylindrical or conical. Exceptions
• Standard_NullObject if the initial shape is not defined, i.e. if this algorithm has not been initialized with the non-empty constructor or the Init function.
• Standard_ConstructionError if the previous call to Add has failed. The function AddDone ought to have been used to check for this, and the function Remove to cancel the results of the unsuccessful taper-adding transformation and to retrieve the previous shape.

Returns true if the previous taper-adding transformation performed by this algorithm in the last call to Add, was successful. If AddDone returns false:

• the function ProblematicShape returns the face on which the error occurred,
• the function Remove has to be used to cancel the results of the unsuccessful taper-adding transformation and to retrieve the previous shape. Exceptions Standard_NullObject if the initial shape has not been defined, i.e. if this algorithm has not been initialized with the non-empty constructor or the .Init function.

Cancels the taper-adding transformation previously performed by this algorithm on the face F and the series of tangential faces which contain F, and retrieves the shape before the last taper-adding transformation. Warning You will have to use this function if the previous call to Add fails. Use the function AddDone to check it. Exceptions.

• Standard_NullObject if the initial shape has not been defined, i.e. if this algorithm has not been initialized with the non-empty constructor or the Init function.
• Standard_NoSuchObject if F has not been added or has already been removed.

Returns the shape on which an error occurred after an unsuccessful call to Add or when IsDone returns false. Exceptions Standard_NullObject if the initial shape has not been defined, i.e. if this algorithm has not been initialized with the non-empty constructor or the Init function.

Returns an error status when an error has occurred (Face, Edge or Vertex recomputation problem). Otherwise returns Draft_NoError. The method may be called if AddDone returns false, or when IsDone returns false.

Returns all the faces which have been added together with the face <F>.

Returns all the faces on which a modification has been given.

Builds the resulting shape (redefined from MakeShape).

Returns the list of shapes generated from the shape .

Returns the list of shapes modified from the shape .

Returns the modified shape corresponding to . S can correspond to the entire initial shape or to its subshape. Raises exceptions Standard_NoSuchObject if S is not the initial shape or a subshape of the initial shape to which the transformation has been applied.

Constructs the draft surface object defined by the shape Shape, the direction Dir, and the angle Angle. Shape must be a TopoDS_Wire, Topo_DS_Face or TopoDS_Shell with free boundaries. Exceptions Standard_NotDone if Shape is not a TopoDS_Wire, Topo_DS_Face or TopoDS_Shell with free boundaries.

Sets the options of this draft tool. If a transition has to be performed, it can be defined by the mode Style as RightCorner or RoundCorner, RightCorner being a corner defined by a sharp angle, and RoundCorner being a rounded corner. AngleMin is an angular tolerance used to detect whether a transition has to be performed or not. AngleMax sets the maximum value within which a RightCorner transition can be performed. AngleMin and AngleMax are expressed in radians.

Sets the direction of the draft for this object. If IsInternal is true, the draft is internal to the argument Shape used in the constructor.

Returns the shell resulting from performance of the draft along the wire.

Returns the list of shapes generated from the shape .

Builds the resulting shape (redefined from MakeShape).

Returns the shapes created from a subshape <SpineShape> of the spine and a subshape <ProfShape> on the profile.

Return the face Top if <Solid> is True in the constructor.

Return the face Bottom if <Solid> is True in the constructor.

Constructs a wire filling object defined by.

• the energy minimizing criterion Degree
• the number of points on the curve NbPntsOnCur
• the number of iterations NbIter
• the Boolean Anisotropie
• the 2D tolerance Tol2d
• the 3D tolerance Tol3d
• the angular tolerance TolAng
• the tolerance for curvature TolCur
• the highest polynomial degree MaxDeg
• the greatest number of segments MaxSeg. If the Boolean Anistropie is true, the algorithm's performance is better in cases where the ratio of the length U and the length V indicate a great difference between the two. In other words, when the surface is, for example, extremely long.

Sets the values of Tolerances used to control the constraint. Tol2d: Tol3d: it is the maximum distance allowed between the support surface and the constraints TolAng: it is the maximum angle allowed between the normal of the surface and the constraints TolCurv: it is the maximum difference of curvature allowed between the surface and the constraint.

Sets the parameters used for resolution. The default values of these parameters have been chosen for a good ratio quality/performance. Degree: it is the order of energy criterion to minimize for computing the deformation of the surface. The default value is 3 The recommended value is i+2 where i is the maximum order of the constraints. NbPtsOnCur: it is the average number of points for discretisation of the edges. NbIter: it is the maximum number of iterations of the process. For each iteration the number of discretisation points is increased. Anisotropie:

Sets the parameters used to approximate the filling surface. These include:

• MaxDeg - the highest degree which the polynomial defining the filling surface can have
• MaxSegments - the greatest number of segments which the filling surface can have.

Loads the initial surface Surf to begin the construction of the surface. This optional function is useful if the surface resulting from construction for the algorithm is likely to be complex.
The support surface of the face under construction is computed by a deformation of Surf which satisfies the given constraints. The set of bounding edges defines the wire of the face. If no initial surface is given, the algorithm computes it automatically. If the set of edges is not connected (Free constraint), missing edges are automatically computed.
Important: the initial surface must have orthogonal local coordinates, i.e. partial derivatives dS/du and dS/dv must be orthogonal at each point of surface. If this condition breaks, distortions of resulting surface are possible.

Builds the resulting faces.

Tests whether computation of the filling plate has been completed.

Returns the list of shapes generated from the shape .

Converts each wire of the face into contour consisting only of arcs and segments. New 3D curves are built too.

Set approximation flag for conversion input contours into ones consisting of 2D circular arcs and 2D linear segments only.

Initializes the algorithm to construct parallels to the wire Spine.

Computes a parallel to the spine at distance Offset and at an altitude Alt from the plane of the spine in relation to the normal to the spine. Exceptions: StdFail_NotDone if the offset is not built.

Builds the resulting shape (redefined from MakeShape).

returns a list of the created shapes from the shape .

Constructor does nothing.

Constructs a shape parallel to the shape S, where.

• S may be a face, a shell, a solid or a compound of these shape kinds;
• Offset is the offset value. The offset shape is constructed:
• outside S, if Offset is positive,
• inside S, if Offset is negative;
• Tol defines the coincidence tolerance criterion for generated shapes;
• Mode defines the construction type of parallels applied to the free edges of shape S; currently, only one construction type is implemented, namely the one where the free edges do not generate parallels; this corresponds to the default value BRepOffset_Skin;
• Intersection specifies how the algorithm must work in order to limit the parallels to two adjacent shapes:
• if Intersection is false (default value), the intersection is calculated with the parallels to the two adjacent shapes,
• if Intersection is true, the intersection is calculated by taking all generated parallels into account; this computation method is more general as it avoids some self-intersections generated in the offset shape from features of small dimensions on shape S, however this method has not been completely implemented and therefore is not recommended for use;
• SelfInter tells the algorithm whether a computation to eliminate self-intersections must be applied to the resulting shape; however, as this functionality is not yet implemented, it is recommended to use the default value (false);
• Join defines how to fill the holes that may appear between parallels to the two adjacent faces. It may take values GeomAbs_Arc or GeomAbs_Intersection:
• if Join is equal to GeomAbs_Arc, then pipes are generated between two free edges of two adjacent parallels, and spheres are generated on "images" of vertices; it is the default value,
• if Join is equal to GeomAbs_Intersection, then the parallels to the two adjacent faces are enlarged and intersected, so that there are no free edges on parallels to faces. RemoveIntEdges flag defines whether to remove the INTERNAL edges from the result or not. Warnings

1. All the faces of the shape S should be based on the surfaces with continuity at least C1.
2. The offset value should be sufficiently small to avoid self-intersections in resulting shape. Otherwise these self-intersections may appear inside an offset face if its initial surface is not plane or sphere or cylinder, also some non-adjacent offset faces may intersect each other. Also, some offset surfaces may "turn inside out".
3. The algorithm may fail if the shape S contains vertices where more than 3 edges converge.
4. Since 3d-offset algorithm involves intersection of surfaces, it is under limitations of surface intersection algorithm.
5. A result cannot be generated if the underlying geometry of S is BSpline with continuity C0. Exceptions Geom_UndefinedDerivative if the underlying geometry of S is BSpline with continuity C0.

Does nothing.

Returns the list of shapes generated from the shape .

Returns the list of shapes Modified from the shape .

Returns true if the shape has been removed from the result.

Returns offset join type.

Builds the resulting shape (redefined from MakeShape).

Returns the TopoDS Shape of the bottom of the prism.

Returns the TopoDS Shape of the top of the prism.

Constructs the shell-generating framework defined by the wire Spine. Sets an sweep's mode If no mode are set, the mode use in MakePipe is used.

Sets a Discrete trihedron to perform the sweeping.

Removes the section Profile from this framework.

Returns true if this tool object is ready to build the shape, i.e. has a definition for the wire section Profile.

Get a status, when Simulate or Build failed. It can be BRepBuilderAPI_PipeDone, BRepBuilderAPI_PipeNotDone, BRepBuilderAPI_PlaneNotIntersectGuide, BRepBuilderAPI_ImpossibleContact.

Sets the following tolerance values.

• 3D tolerance Tol3d
• boundary tolerance BoundTol
• angular tolerance TolAngular.

Define the maximum V degree of resulting surface.

Define the maximum number of spans in V-direction on resulting surface.

Set the flag that indicates attempt to approximate a C1-continuous surface if a swept surface proved to be C0.

Sets the transition mode to manage discontinuities on the swept shape caused by fractures on the spine. The transition mode can be BRepBuilderAPI_Transformed (default value), BRepBuilderAPI_RightCorner, BRepBuilderAPI_RoundCorner:

• RepBuilderAPI_Transformed: discontinuities are treated by modification of the sweeping mode. The pipe is "transformed" at the fractures of the spine. This mode assumes building a self-intersected shell.
• BRepBuilderAPI_RightCorner: discontinuities are treated like right corner. Two pieces of the pipe corresponding to two adjacent segments of the spine are extended and intersected at a fracture of the spine.
• BRepBuilderAPI_RoundCorner: discontinuities are treated like round corner. The corner is treated as rotation of the profile around an axis which passes through the point of the spine's fracture. This axis is based on cross product of directions tangent to the adjacent segments of the spine at their common point.
  Warnings The mode BRepBuilderAPI_RightCorner provides a valid result if intersection of two pieces of the pipe (corresponding to two adjacent segments of the spine) in the neighborhood of the spine?s fracture is connected and planar. This condition can be violated if the spine is non-linear in some neighborhood of the fracture or if the profile was set with a scaling law. The last mode, BRepBuilderAPI_RoundCorner, will assuredly provide a good result only if a profile was set with option WithCorrection = True, i.e. it is strictly orthogonal to the spine.

Simulates the resulting shape by calculating its cross-sections. The spine is divided by this cross-sections into (NumberOfSection - 1) equal parts, the number of cross-sections is NumberOfSection. The cross-sections are wires and they are returned in the list Result. This gives a rapid preview of the resulting shape, which will be obtained using the settings you have provided. Raises NotDone if <me> it is not Ready.

Builds the resulting shape (redefined from MakeShape).

Transforms the sweeping Shell in Solid. If a propfile is not closed returns False.

Returns the TopoDS Shape of the bottom of the sweep.

Returns the TopoDS Shape of the top of the sweep.

Returns a list of new shapes generated from the shape S by the shell-generating algorithm. This function is redefined from BRepOffsetAPI_MakeShape::Generated. S can be an edge or a vertex of a given Profile (see methods Add).

Sets the build history flag. If set to True, the pipe shell will store the history of the sections and the spine, which can be used for further modifications or analysis.

Returns the build history flag. If True, the pipe shell stores the history of the sections and the spine.

Returns the list of original profiles.

Returns the spine.

Constructor does nothing.

Constructs solid using simple algorithm. According to its nature it is not possible to set list of the closing faces. This algorithm does not support faces removing. It is caused by fact that intersections are not computed during offset creation. Non-closed shell or face is expected as input.

Constructs a hollowed solid from the solid S by removing the set of faces ClosingFaces from S, where: Offset defines the thickness of the walls. Its sign indicates which side of the surface of the solid the hollowed shape is built on;.

• Tol defines the tolerance criterion for coincidence in generated shapes;
• Mode defines the construction type of parallels applied to free edges of shape S. Currently, only one construction type is implemented, namely the one where the free edges do not generate parallels; this corresponds to the default value BRepOffset_Skin; Intersection specifies how the algorithm must work in order to limit the parallels to two adjacent shapes:
• if Intersection is false (default value), the intersection is calculated with the parallels to the two adjacent shapes,
• if Intersection is true, the intersection is calculated by taking account of all parallels generated; this computation method is more general as it avoids self-intersections generated in the offset shape from features of small dimensions on shape S, however this method has not been completely implemented and therefore is not recommended for use;
• SelfInter tells the algorithm whether a computation to eliminate self-intersections needs to be applied to the resulting shape. However, as this functionality is not yet implemented, you should use the default value (false);
• Join defines how to fill the holes that may appear between parallels to the two adjacent faces. It may take values GeomAbs_Arc or GeomAbs_Intersection:
• if Join is equal to GeomAbs_Arc, then pipes are generated between two free edges of two adjacent parallels, and spheres are generated on "images" of vertices; it is the default value,
• if Join is equal to GeomAbs_Intersection, then the parallels to the two adjacent faces are enlarged and intersected, so that there are no free edges on parallels to faces. RemoveIntEdges flag defines whether to remove the INTERNAL edges from the result or not. Warnings Since the algorithm of MakeThickSolid is based on MakeOffsetShape algorithm, the warnings are the same as for MakeOffsetShape.

Does nothing.

Returns the list of shapes modified from the shape .

General constructor. StartShape and EndShape may be a wire or a face.

This is called by Shape(). It does nothing but may be redefined.

Initializes the empty constructor framework with the shape S.

Adds the shape ToProj to the framework for calculation of the projection by Compute3d. ToProj is an edge or a wire and will be projected onto the basis shape. Exceptions Standard_ConstructionError if ToProj is not added.

Sets the parameters used for computation Tol3 is the required tolerance between the 3d projected curve and its 2d representation InternalContinuity is the order of constraints used for approximation MaxDeg and MaxSeg are the maximum degree and the maximum number of segment for BSpline resulting of an approximation.

Sets the maximum distance between target shape and shape to project. If this condition is not satisfied then corresponding part of solution is discarded. if MaxDist < 0 then this method does not affect the algorithm.

Manage limitation of projected edges.

Returns true if a 3D curve is computed. If not, false is returned and an initial 3D curve is kept to build the resulting edges.

Builds the result of the projection as a compound of wires. Tries to build oriented wires.

Returns true if the object was correctly built by the shape construction algorithm. If at the construction time of the shape, the algorithm cannot be completed, or the original data is corrupted, IsDone returns false and therefore protects the use of functions to access the result of the construction (typically the Shape function).

Performs the projection. The construction of the result is performed by Build. Exceptions StdFail_NotDone if the projection was not performed.

Returns the initial face corresponding to the projected edge E. Exceptions StdFail_NotDone if no face was found. Standard_NoSuchObject if a face corresponding to E has already been found.

Returns the list of shapes generated from the shape .

Returns the initial edge corresponding to the edge E resulting from the computation of the projection. Exceptions StdFail_NotDone if no edge was found. Standard_NoSuchObject if an edge corresponding to E has already been found.

build the result as a list of wire if possible in - a first returns a wire only if there is only a wire.

Initializes an algorithm for building a shell or a solid passing through a set of sections, where:

• isSolid is set to true if the construction algorithm is required to build a solid or to false if it is required to build a shell (the default value),
• ruled is set to true if the faces generated between the edges of two consecutive wires are ruled surfaces or to false (the default value) if they are smoothed out by approximation,
• pres3d defines the precision criterion used by the approximation algorithm; the default value is 1.0e-6. Use AddWire and AddVertex to define the successive sections of the shell or solid to be built.

Initializes this algorithm for building a shell or a solid passing through a set of sections, where:

• isSolid is set to true if this construction algorithm is required to build a solid or to false if it is required to build a shell. false is the default value;
• ruled is set to true if the faces generated between the edges of two consecutive wires are ruled surfaces or to false (the default value) if they are smoothed out by approximation,
• pres3d defines the precision criterion used by the approximation algorithm; the default value is 1.0e-6. Use AddWire and AddVertex to define the successive sections of the shell or solid to be built.

Adds the wire wire to the set of sections through which the shell or solid is built. Use the Build function to construct the shape.

Adds the vertex Vertex (punctual section) to the set of sections through which the shell or solid is built. A vertex may be added to the set of sections only as first or last section. At least one wire must be added to the set of sections by the method AddWire. Use the Build function to construct the shape.

Sets/unsets the option to compute origin and orientation on wires to avoid twisted results and update wires to have same number of edges.

Define the approximation algorithm.

Define the type of parametrization used in the approximation.

Define the Continuity used in the approximation.

define the Weights associed to the criterium used in the optimization.
if Wi <= 0

Define the maximal U degree of result surface.

returns the type of parametrization used in the approximation

returns the Continuity used in the approximation

returns the maximal U degree of result surface

Define the approximation algorithm.

returns the Weights associed to the criterium used in the optimization.

This is called by Shape(). It does nothing but may be redefined.

Returns the TopoDS Shape of the bottom of the loft if solid.

Returns the TopoDS Shape of the top of the loft if solid.

if Ruled Returns the Face generated by each edge except the last wire if smoothed Returns the Face generated by each edge of the first wire

Sets the mutable input state. If true then the input profile can be modified inside the thrusection operation. Default value is true.

Returns a list of new shapes generated from the shape S by the shell-generating algorithm. This function is redefined from BRepBuilderAPI_MakeShape::Generated. S can be an edge or a vertex of a given Profile (see methods AddWire and AddVertex).

Returns the list of original wires.

Returns the current mutable input state.

Returns the status of thrusection operation.