Describes functions to build pipes. A pipe is built a basis shape (called the profile) along a wire (called the spine) by sweeping. The profile must not contain solids. A MakePipe object provides a framework for: More...
#include <BRepOffsetAPI_MakePipe.hxx>
Public Member Functions | |
| BRepOffsetAPI_MakePipe (const TopoDS_Wire &Spine, const TopoDS_Shape &Profile) | |
| Constructs a pipe by sweeping the shape Profile along the wire Spine.The angle made by the spine with the profile is maintained along the length of the pipe. Warning Spine must be G1 continuous; that is, on the connection vertex of two edges of the wire, the tangent vectors on the left and on the right must have the same direction, though not necessarily the same magnitude. Exceptions Standard_DomainError if the profile is a solid or a composite solid. | |
| BRepOffsetAPI_MakePipe (const TopoDS_Wire &Spine, const TopoDS_Shape &Profile, const GeomFill_Trihedron aMode, const Standard_Boolean ForceApproxC1=Standard_False) | |
| the same as previous but with setting of mode of sweep and the flag that indicates attempt to approximate a C1-continuous surface if a swept surface proved to be C0. | |
| const BRepFill_Pipe & | Pipe () const |
| virtual void | Build (const Message_ProgressRange &theRange=Message_ProgressRange()) override |
| Builds the resulting shape (redefined from MakeShape). | |
| TopoDS_Shape | FirstShape () override |
| Returns the TopoDS Shape of the bottom of the prism. | |
| TopoDS_Shape | LastShape () override |
| Returns the TopoDS Shape of the top of the prism. | |
| virtual const TopTools_ListOfShape & | Generated (const TopoDS_Shape &S) override |
| Returns the list of shapes generated from the shape | |
| TopoDS_Shape | Generated (const TopoDS_Shape &SSpine, const TopoDS_Shape &SProfile) |
| Standard_Real | ErrorOnSurface () const |
 Public Member Functions inherited from BRepBuilderAPI_MakeShape | |
| virtual const TopoDS_Shape & | Shape () |
| Returns a shape built by the shape construction algorithm. Raises exception StdFail_NotDone if the shape was not built. | |
| operator TopoDS_Shape () | |
| virtual const TopTools_ListOfShape & | Modified (const TopoDS_Shape &S) |
| Returns the list of shapes modified from the shape | |
| virtual Standard_Boolean | IsDeleted (const TopoDS_Shape &S) |
| Returns true if the shape S has been deleted. | |
| Public Member Functions inherited from BRepBuilderAPI_Command | |
| virtual | ~BRepBuilderAPI_Command () |
| virtual Standard_Boolean | IsDone () const |
| void | Check () const |
| Raises NotDone if done is false. | |
Additional Inherited Members | |
| Protected Member Functions inherited from BRepBuilderAPI_MakeShape | |
| BRepBuilderAPI_MakeShape () | |
| Protected Member Functions inherited from BRepBuilderAPI_Command | |
| BRepBuilderAPI_Command () | |
| Set done to False. | |
| void | Done () |
| Set done to true. | |
| void | NotDone () |
| Set done to false. | |
| Protected Attributes inherited from BRepBuilderAPI_MakeShape | |
| TopoDS_Shape | myShape |
| TopTools_ListOfShape | myGenerated |
Detailed Description
Describes functions to build pipes. A pipe is built a basis shape (called the profile) along a wire (called the spine) by sweeping. The profile must not contain solids. A MakePipe object provides a framework for:
- defining the construction of a pipe,
- implementing the construction algorithm, and
- consulting the result. Warning The MakePipe class implements pipe constructions with G1 continuous spines only.
Constructor & Destructor Documentation
◆ BRepOffsetAPI_MakePipe() [1/2]
| BRepOffsetAPI_MakePipe::BRepOffsetAPI_MakePipe | ( | const TopoDS_Wire & | Spine, |
| const TopoDS_Shape & | Profile | ||
| ) |
Constructs a pipe by sweeping the shape Profile along the wire Spine.The angle made by the spine with the profile is maintained along the length of the pipe. Warning Spine must be G1 continuous; that is, on the connection vertex of two edges of the wire, the tangent vectors on the left and on the right must have the same direction, though not necessarily the same magnitude. Exceptions Standard_DomainError if the profile is a solid or a composite solid.
◆ BRepOffsetAPI_MakePipe() [2/2]
| BRepOffsetAPI_MakePipe::BRepOffsetAPI_MakePipe | ( | const TopoDS_Wire & | Spine, |
| const TopoDS_Shape & | Profile, | ||
| const GeomFill_Trihedron | aMode, | ||
| const Standard_Boolean | ForceApproxC1 = Standard_False |
||
| ) |
the same as previous but with setting of mode of sweep and the flag that indicates attempt to approximate a C1-continuous surface if a swept surface proved to be C0.
Member Function Documentation
◆ Build()
|
overridevirtual |
Builds the resulting shape (redefined from MakeShape).
Reimplemented from BRepBuilderAPI_MakeShape.
◆ ErrorOnSurface()
| Standard_Real BRepOffsetAPI_MakePipe::ErrorOnSurface | ( | ) | const |
◆ FirstShape()
|
overridevirtual |
Returns the TopoDS Shape of the bottom of the prism.
Implements BRepPrimAPI_MakeSweep.
◆ Generated() [1/2]
|
overridevirtual |
Returns the list of shapes generated from the shape .
Reimplemented from BRepBuilderAPI_MakeShape.
◆ Generated() [2/2]
| TopoDS_Shape BRepOffsetAPI_MakePipe::Generated | ( | const TopoDS_Shape & | SSpine, |
| const TopoDS_Shape & | SProfile | ||
| ) |
◆ LastShape()
|
overridevirtual |
Returns the TopoDS Shape of the top of the prism.
Implements BRepPrimAPI_MakeSweep.
◆ Pipe()
| const BRepFill_Pipe & BRepOffsetAPI_MakePipe::Pipe | ( | ) | const |
The documentation for this class was generated from the following file:
