Describes algorithms for offsetting wires from a set of wires contained in a planar face. A MakeOffset object provides a framework for: More...
#include <BRepOffsetAPI_MakeOffset.hxx>
Public Member Functions | |
| BRepOffsetAPI_MakeOffset () | |
| Constructs an algorithm for creating an empty offset. More... | |
| BRepOffsetAPI_MakeOffset (const TopoDS_Face &Spine, const GeomAbs_JoinType Join=GeomAbs_Arc, const Standard_Boolean IsOpenResult=Standard_False) | |
| Constructs an algorithm for creating an algorithm to build parallels to the spine Spine. More... | |
| void | Init (const TopoDS_Face &Spine, const GeomAbs_JoinType Join=GeomAbs_Arc, const Standard_Boolean IsOpenResult=Standard_False) |
| Initializes the algorithm to construct parallels to the spine Spine. Join defines the type of parallel generated by the salient vertices of the spine. The default type is GeomAbs_Arc where the vertices generate sections of a circle. If join type is GeomAbs_Intersection, the edges that intersect in a salient vertex generate the edges prolonged until intersection. More... | |
| BRepOffsetAPI_MakeOffset (const TopoDS_Wire &Spine, const GeomAbs_JoinType Join=GeomAbs_Arc, const Standard_Boolean IsOpenResult=Standard_False) | |
| void | Init (const GeomAbs_JoinType Join=GeomAbs_Arc, const Standard_Boolean IsOpenResult=Standard_False) |
| Initialize the evaluation of Offsetting. More... | |
| void | AddWire (const TopoDS_Wire &Spine) |
| Initializes the algorithm to construct parallels to the wire Spine. More... | |
| void | Perform (const Standard_Real Offset, const Standard_Real Alt=0.0) |
| 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. More... | |
| virtual void | Build (const Message_ProgressRange &theRange=Message_ProgressRange()) override |
| Builds the resulting shape (redefined from MakeShape). More... | |
| virtual const TopTools_ListOfShape & | Generated (const TopoDS_Shape &S) override |
| returns a list of the created shapes from the shape | |
 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. More... | |
| 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. More... | |
| Public Member Functions inherited from BRepBuilderAPI_Command | |
| virtual | ~BRepBuilderAPI_Command () |
| virtual Standard_Boolean | IsDone () const |
| void | Check () const |
| Raises NotDone if done is false. More... | |
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. More... | |
| void | Done () |
| Set done to true. More... | |
| void | NotDone () |
| Set done to false. More... | |
| Protected Attributes inherited from BRepBuilderAPI_MakeShape | |
| TopoDS_Shape | myShape |
| TopTools_ListOfShape | myGenerated |
Detailed Description
Describes algorithms for offsetting wires from a set of wires contained in a planar face. A MakeOffset object provides a framework for:
- defining the construction of an offset,
- implementing the construction algorithm, and
- consulting the result.
Constructor & Destructor Documentation
◆ BRepOffsetAPI_MakeOffset() [1/3]
| BRepOffsetAPI_MakeOffset::BRepOffsetAPI_MakeOffset | ( | ) |
Constructs an algorithm for creating an empty offset.
◆ BRepOffsetAPI_MakeOffset() [2/3]
| BRepOffsetAPI_MakeOffset::BRepOffsetAPI_MakeOffset | ( | const TopoDS_Face & | Spine, |
| const GeomAbs_JoinType | Join = GeomAbs_Arc, |
||
| const Standard_Boolean | IsOpenResult = Standard_False |
||
| ) |
Constructs an algorithm for creating an algorithm to build parallels to the spine Spine.
◆ BRepOffsetAPI_MakeOffset() [3/3]
| BRepOffsetAPI_MakeOffset::BRepOffsetAPI_MakeOffset | ( | const TopoDS_Wire & | Spine, |
| const GeomAbs_JoinType | Join = GeomAbs_Arc, |
||
| const Standard_Boolean | IsOpenResult = Standard_False |
||
| ) |
Member Function Documentation
◆ AddWire()
| void BRepOffsetAPI_MakeOffset::AddWire | ( | const TopoDS_Wire & | Spine | ) |
Initializes the algorithm to construct parallels to the wire Spine.
◆ Build()
|
overridevirtual |
Builds the resulting shape (redefined from MakeShape).
Reimplemented from BRepBuilderAPI_MakeShape.
◆ Generated()
|
overridevirtual |
returns a list of the created shapes from the shape .
Reimplemented from BRepBuilderAPI_MakeShape.
◆ Init() [1/2]
| void BRepOffsetAPI_MakeOffset::Init | ( | const GeomAbs_JoinType | Join = GeomAbs_Arc, |
| const Standard_Boolean | IsOpenResult = Standard_False |
||
| ) |
Initialize the evaluation of Offsetting.
◆ Init() [2/2]
| void BRepOffsetAPI_MakeOffset::Init | ( | const TopoDS_Face & | Spine, |
| const GeomAbs_JoinType | Join = GeomAbs_Arc, |
||
| const Standard_Boolean | IsOpenResult = Standard_False |
||
| ) |
Initializes the algorithm to construct parallels to the spine Spine. Join defines the type of parallel generated by the salient vertices of the spine. The default type is GeomAbs_Arc where the vertices generate sections of a circle. If join type is GeomAbs_Intersection, the edges that intersect in a salient vertex generate the edges prolonged until intersection.
◆ Perform()
| void BRepOffsetAPI_MakeOffset::Perform | ( | const Standard_Real | Offset, |
| const Standard_Real | Alt = 0.0 |
||
| ) |
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.
The documentation for this class was generated from the following file:
