The algorithm is to build a Secton operation between arguments and tools. The result of Section operation consists of vertices and edges. The result of Section operation contains: More...
#include <BRepAlgoAPI_Section.hxx>
Inheritance diagram for BRepAlgoAPI_Section:
Public Member Functions | |
| BRepAlgoAPI_Section () | |
| Empty constructor. More... | |
| virtual | ~BRepAlgoAPI_Section () |
| BRepAlgoAPI_Section (const BOPAlgo_PaveFiller &PF) | |
| Empty constructor <PF> - PaveFiller object that is carried out. More... | |
| BRepAlgoAPI_Section (const TopoDS_Shape &S1, const TopoDS_Shape &S2, const Standard_Boolean PerformNow=Standard_True) | |
| Constructor with two shapes <S1> -argument <S2> -tool <PerformNow> - the flag: if <PerformNow>=True - the algorithm is performed immediatly Obsolete. More... | |
| BRepAlgoAPI_Section (const TopoDS_Shape &S1, const TopoDS_Shape &S2, const BOPAlgo_PaveFiller &aDSF, const Standard_Boolean PerformNow=Standard_True) | |
| Constructor with two shapes <S1> -argument <S2> -tool <PF> - PaveFiller object that is carried out <PerformNow> - the flag: if <PerformNow>=True - the algorithm is performed immediatly Obsolete. More... | |
| BRepAlgoAPI_Section (const TopoDS_Shape &S1, const gp_Pln &Pl, const Standard_Boolean PerformNow=Standard_True) | |
| Constructor with two shapes <S1> - argument <Pl> - tool <PerformNow> - the flag: if <PerformNow>=True - the algorithm is performed immediatly Obsolete. More... | |
| BRepAlgoAPI_Section (const TopoDS_Shape &S1, const Handle< Geom_Surface > &Sf, const Standard_Boolean PerformNow=Standard_True) | |
| Constructor with two shapes <S1> - argument <Sf> - tool <PerformNow> - the flag: if <PerformNow>=True - the algorithm is performed immediatly Obsolete. More... | |
| BRepAlgoAPI_Section (const Handle< Geom_Surface > &Sf, const TopoDS_Shape &S2, const Standard_Boolean PerformNow=Standard_True) | |
| Constructor with two shapes <Sf> - argument <S2> - tool <PerformNow> - the flag: if <PerformNow>=True - the algorithm is performed immediatly Obsolete. More... | |
| BRepAlgoAPI_Section (const Handle< Geom_Surface > &Sf1, const Handle< Geom_Surface > &Sf2, const Standard_Boolean PerformNow=Standard_True) | |
| Constructor with two shapes <Sf1> - argument <Sf2> - tool <PerformNow> - the flag: if <PerformNow>=True - the algorithm is performed immediatly Obsolete. More... | |
| void | Init1 (const TopoDS_Shape &S1) |
| initialize the argument <S1> - argument Obsolete More... | |
| void | Init1 (const gp_Pln &Pl) |
| initialize the argument <Pl> - argument Obsolete More... | |
| void | Init1 (const Handle< Geom_Surface > &Sf) |
| initialize the argument <Sf> - argument Obsolete More... | |
| void | Init2 (const TopoDS_Shape &S2) |
| initialize the tool <S2> - tool Obsolete More... | |
| void | Init2 (const gp_Pln &Pl) |
| initialize the tool <Pl> - tool Obsolete More... | |
| void | Init2 (const Handle< Geom_Surface > &Sf) |
| initialize the tool <Sf> - tool Obsolete More... | |
| void | Approximation (const Standard_Boolean B) |
| void | ComputePCurveOn1 (const Standard_Boolean B) |
| Indicates whether the P-Curve should be (or not) performed on the argument. By default, no parametric 2D curve (pcurve) is defined for the edges of the result. If ComputePCurve1 equals true, further computations performed to attach an P-Curve in the parametric space of the argument to the constructed edges. Obsolete. More... | |
| void | ComputePCurveOn2 (const Standard_Boolean B) |
| Indicates whether the P-Curve should be (or not) performed on the tool. By default, no parametric 2D curve (pcurve) is defined for the edges of the result. If ComputePCurve1 equals true, further computations performed to attach an P-Curve in the parametric space of the tool to the constructed edges. Obsolete. More... | |
| virtual void | Build () |
| Performs the algorithm Filling interference Data Structure (if it is necessary) Building the result of the operation. More... | |
| Standard_Boolean | HasAncestorFaceOn1 (const TopoDS_Shape &E, TopoDS_Shape &F) const |
| get the face of the first part giving section edge <E>. Returns True on the 3 following conditions : 1/ <E> is an edge returned by the Shape() metwod. 2/ First part of section performed is a shape. 3/ <E> is built on a intersection curve (i.e <E> is not the result of common edges) When False, F remains untouched. Obsolete More... | |
| Standard_Boolean | HasAncestorFaceOn2 (const TopoDS_Shape &E, TopoDS_Shape &F) const |
| Identifies the ancestor faces of the intersection edge E resulting from the last computation performed in this framework, that is, the faces of the two original shapes on which the edge E lies: More... | |
 Public Member Functions inherited from BRepAlgoAPI_BooleanOperation | |
| const TopoDS_Shape & | Shape1 () const |
| Returns the first argument involved in this Boolean operation. Obsolete. More... | |
| const TopoDS_Shape & | Shape2 () const |
| Returns the second argument involved in this Boolean operation. Obsolete. More... | |
| void | SetTools (const TopTools_ListOfShape &theLS) |
| Sets the tools. More... | |
| const TopTools_ListOfShape & | Tools () const |
| Gets the tools. More... | |
| void | SetOperation (const BOPAlgo_Operation anOp) |
| Sets the type of Boolean operation. More... | |
| BOPAlgo_Operation | Operation () const |
| Returns the type of Boolean Operation. More... | |
| virtual | ~BRepAlgoAPI_BooleanOperation () |
| Standard_Boolean | BuilderCanWork () const |
| Returns True if there was no errors occured obsolete. More... | |
| Standard_Boolean | FuseEdges () const |
| Returns the flag of edge refining. More... | |
| void | RefineEdges () |
| Fuse C1 edges. More... | |
| const TopTools_ListOfShape & | SectionEdges () |
| Returns a list of section edges. The edges represent the result of intersection between arguments of Boolean Operation. They are computed during operation execution. More... | |
| virtual const TopTools_ListOfShape & | Modified (const TopoDS_Shape &aS) |
| Returns the list of shapes modified from the shape <S>. More... | |
| virtual Standard_Boolean | IsDeleted (const TopoDS_Shape &aS) |
| Returns true if the shape S has been deleted. The result shape of the operation does not contain the shape S. More... | |
| virtual const TopTools_ListOfShape & | Generated (const TopoDS_Shape &S) |
| Returns the list of shapes generated from the shape <S>. For use in BRepNaming. More... | |
| virtual Standard_Boolean | HasModified () const |
| Returns true if there is at least one modified shape. For use in BRepNaming. More... | |
| virtual Standard_Boolean | HasGenerated () const |
| Returns true if there is at least one generated shape. For use in BRepNaming. More... | |
| virtual Standard_Boolean | HasDeleted () const |
| Returns true if there is at least one deleted shape. For use in BRepNaming. More... | |
| Public Member Functions inherited from BRepAlgoAPI_BuilderAlgo | |
| BRepAlgoAPI_BuilderAlgo () | |
| Empty constructor. More... | |
| virtual | ~BRepAlgoAPI_BuilderAlgo () |
| BRepAlgoAPI_BuilderAlgo (const BOPAlgo_PaveFiller &thePF) | |
| Empty constructor. More... | |
| void | SetFuzzyValue (const Standard_Real theFuzz) |
| Sets the additional tolerance. More... | |
| Standard_Real | FuzzyValue () const |
| Returns the additional tolerance. More... | |
| void | SetArguments (const TopTools_ListOfShape &theLS) |
| Sets the arguments. More... | |
| const TopTools_ListOfShape & | Arguments () const |
| Gets the arguments. More... | |
| Public Member Functions inherited from BRepAlgoAPI_Algo | |
| Standard_Integer | ErrorStatus () const |
| Returns error status of the algorithm ==0 - no errors occured !=0 - is in the event of various error conditions. More... | |
| Standard_Integer | WarningStatus () const |
| Returns warning status of the algorithm ==0 - no warning occured !=0 - is in the event of various warning conditions. More... | |
| const BOPCol_BaseAllocator & | Allocator () const |
| void | SetRunParallel (const Standard_Boolean theFlag) |
| Set the flag of parallel processing if <theFlag> is true the parallel processing is switched on if <theFlag> is false the parallel processing is switched off. More... | |
| Standard_Boolean | RunParallel () const |
| Returns the flag of parallel processing. More... | |
| void | SetProgressIndicator (const Handle< Message_ProgressIndicator > &theObj) |
| Set the Progress Indicator object. More... | |
| virtual const TopoDS_Shape & | Shape () const |
| Returns a shape built by the shape construction algorithm. Raises exception StdFail_NotDone if the shape was not built. More... | |
| Public Member Functions inherited from BRepBuilderAPI_MakeShape | |
| virtual void | Delete () |
| virtual | ~BRepBuilderAPI_MakeShape () |
| operator TopoDS_Shape () const | |
| 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... | |
Protected Member Functions | |
| void | Init (const Standard_Boolean PerformNow) |
| virtual void | SetAttributes () |
| Protected Member Functions inherited from BRepAlgoAPI_BooleanOperation | |
| BRepAlgoAPI_BooleanOperation () | |
| Empty constructor. More... | |
| BRepAlgoAPI_BooleanOperation (const BOPAlgo_PaveFiller &PF) | |
| Empty constructor <PF> - PaveFiller object that is carried out. More... | |
| BRepAlgoAPI_BooleanOperation (const TopoDS_Shape &S1, const TopoDS_Shape &S2, const BOPAlgo_Operation anOperation) | |
| Constructor with two arguments <S1>, <S2> -arguments <anOperation> - the type of the operation Obsolete. More... | |
| BRepAlgoAPI_BooleanOperation (const TopoDS_Shape &S1, const TopoDS_Shape &S2, const BOPAlgo_PaveFiller &PF, const BOPAlgo_Operation anOperation) | |
| Constructor with two arguments <S1>, <S2> -arguments <anOperation> - the type of the operation <PF> - PaveFiller object that is carried out Obsolete. More... | |
| virtual void | Clear () |
| const TopTools_ListOfShape & | RefinedList (const TopTools_ListOfShape &theL) |
| Returns the list of shapes generated from the shape <S>. For use in BRepNaming. More... | |
| Protected Member Functions inherited from BRepAlgoAPI_Algo | |
| BRepAlgoAPI_Algo () | |
| Empty constructor. More... | |
| virtual | ~BRepAlgoAPI_Algo () |
| BRepAlgoAPI_Algo (const BOPCol_BaseAllocator &theAllocator) | |
| Empty constructor. More... | |
| void | UserBreak () const |
| Breaks the execution if the break signal is indicated by myProgressIndicator. More... | |
| 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... | |
Additional Inherited Members | |
| Protected Attributes inherited from BRepAlgoAPI_BooleanOperation | |
| TopTools_ListOfShape | myTools |
| BOPAlgo_Operation | myOperation |
| Standard_Boolean | myBuilderCanWork |
| Protected Attributes inherited from BRepAlgoAPI_BuilderAlgo | |
| Standard_Integer | myEntryType |
| BOPAlgo_PPaveFiller | myDSFiller |
| BOPAlgo_PBuilder | myBuilder |
| Standard_Real | myFuzzyValue |
| TopTools_ListOfShape | myArguments |
| Protected Attributes inherited from BRepAlgoAPI_Algo | |
| BOPCol_BaseAllocator | myAllocator |
| Standard_Integer | myErrorStatus |
| Standard_Integer | myWarningStatus |
| Standard_Boolean | myRunParallel |
| Handle< Message_ProgressIndicator > | myProgressIndicator |
| Protected Attributes inherited from BRepBuilderAPI_MakeShape | |
| TopoDS_Shape | myShape |
| TopTools_ListOfShape | myGenerated |
Detailed Description
The algorithm is to build a Secton operation between arguments and tools. The result of Section operation consists of vertices and edges. The result of Section operation contains:
- new vertices that are subjects of V/V, E/E, E/F, F/F interferences
- vertices that are subjects of V/E, V/F interferences
- new edges that are subjects of F/F interferences
- edges that are Common Blocks
Constructor & Destructor Documentation
| BRepAlgoAPI_Section::BRepAlgoAPI_Section | ( | ) |
Empty constructor.
|
virtual |
| BRepAlgoAPI_Section::BRepAlgoAPI_Section | ( | const BOPAlgo_PaveFiller & | PF | ) |
Empty constructor <PF> - PaveFiller object that is carried out.
| BRepAlgoAPI_Section::BRepAlgoAPI_Section | ( | const TopoDS_Shape & | S1, |
| const TopoDS_Shape & | S2, | ||
| const Standard_Boolean | PerformNow = Standard_True |
||
| ) |
Constructor with two shapes <S1> -argument <S2> -tool <PerformNow> - the flag: if <PerformNow>=True - the algorithm is performed immediatly Obsolete.
| BRepAlgoAPI_Section::BRepAlgoAPI_Section | ( | const TopoDS_Shape & | S1, |
| const TopoDS_Shape & | S2, | ||
| const BOPAlgo_PaveFiller & | aDSF, | ||
| const Standard_Boolean | PerformNow = Standard_True |
||
| ) |
Constructor with two shapes <S1> -argument <S2> -tool <PF> - PaveFiller object that is carried out <PerformNow> - the flag: if <PerformNow>=True - the algorithm is performed immediatly Obsolete.
| BRepAlgoAPI_Section::BRepAlgoAPI_Section | ( | const TopoDS_Shape & | S1, |
| const gp_Pln & | Pl, | ||
| const Standard_Boolean | PerformNow = Standard_True |
||
| ) |
Constructor with two shapes <S1> - argument <Pl> - tool <PerformNow> - the flag: if <PerformNow>=True - the algorithm is performed immediatly Obsolete.
| BRepAlgoAPI_Section::BRepAlgoAPI_Section | ( | const TopoDS_Shape & | S1, |
| const Handle< Geom_Surface > & | Sf, | ||
| const Standard_Boolean | PerformNow = Standard_True |
||
| ) |
Constructor with two shapes <S1> - argument <Sf> - tool <PerformNow> - the flag: if <PerformNow>=True - the algorithm is performed immediatly Obsolete.
| BRepAlgoAPI_Section::BRepAlgoAPI_Section | ( | const Handle< Geom_Surface > & | Sf, |
| const TopoDS_Shape & | S2, | ||
| const Standard_Boolean | PerformNow = Standard_True |
||
| ) |
Constructor with two shapes <Sf> - argument <S2> - tool <PerformNow> - the flag: if <PerformNow>=True - the algorithm is performed immediatly Obsolete.
| BRepAlgoAPI_Section::BRepAlgoAPI_Section | ( | const Handle< Geom_Surface > & | Sf1, |
| const Handle< Geom_Surface > & | Sf2, | ||
| const Standard_Boolean | PerformNow = Standard_True |
||
| ) |
Constructor with two shapes <Sf1> - argument <Sf2> - tool <PerformNow> - the flag: if <PerformNow>=True - the algorithm is performed immediatly Obsolete.
Member Function Documentation
| void BRepAlgoAPI_Section::Approximation | ( | const Standard_Boolean | B | ) |
|
virtual |
Performs the algorithm Filling interference Data Structure (if it is necessary) Building the result of the operation.
Reimplemented from BRepAlgoAPI_BooleanOperation.
| void BRepAlgoAPI_Section::ComputePCurveOn1 | ( | const Standard_Boolean | B | ) |
Indicates whether the P-Curve should be (or not) performed on the argument. By default, no parametric 2D curve (pcurve) is defined for the edges of the result. If ComputePCurve1 equals true, further computations performed to attach an P-Curve in the parametric space of the argument to the constructed edges. Obsolete.
| void BRepAlgoAPI_Section::ComputePCurveOn2 | ( | const Standard_Boolean | B | ) |
Indicates whether the P-Curve should be (or not) performed on the tool. By default, no parametric 2D curve (pcurve) is defined for the edges of the result. If ComputePCurve1 equals true, further computations performed to attach an P-Curve in the parametric space of the tool to the constructed edges. Obsolete.
| Standard_Boolean BRepAlgoAPI_Section::HasAncestorFaceOn1 | ( | const TopoDS_Shape & | E, |
| TopoDS_Shape & | F | ||
| ) | const |
get the face of the first part giving section edge <E>. Returns True on the 3 following conditions : 1/ <E> is an edge returned by the Shape() metwod. 2/ First part of section performed is a shape. 3/ <E> is built on a intersection curve (i.e <E> is not the result of common edges) When False, F remains untouched. Obsolete
| Standard_Boolean BRepAlgoAPI_Section::HasAncestorFaceOn2 | ( | const TopoDS_Shape & | E, |
| TopoDS_Shape & | F | ||
| ) | const |
Identifies the ancestor faces of the intersection edge E resulting from the last computation performed in this framework, that is, the faces of the two original shapes on which the edge E lies:
- HasAncestorFaceOn1 gives the ancestor face in the first shape, and
- HasAncestorFaceOn2 gives the ancestor face in the second shape. These functions return true if an ancestor face F is found, or false if not. An ancestor face is identifiable for the edge E if the following conditions are satisfied:
- the first part on which this algorithm performed its last computation is a shape, that is, it was not given as a surface or a plane at the time of construction of this algorithm or at a later time by the Init1 function,
- E is one of the elementary edges built by the last computation of this section algorithm. To use these functions properly, you have to test the returned Boolean value before using the ancestor face: F is significant only if the returned Boolean value equals true. Obsolete
|
protected |
| void BRepAlgoAPI_Section::Init1 | ( | const TopoDS_Shape & | S1 | ) |
initialize the argument <S1> - argument Obsolete
| void BRepAlgoAPI_Section::Init1 | ( | const gp_Pln & | Pl | ) |
initialize the argument <Pl> - argument Obsolete
| void BRepAlgoAPI_Section::Init1 | ( | const Handle< Geom_Surface > & | Sf | ) |
initialize the argument <Sf> - argument Obsolete
| void BRepAlgoAPI_Section::Init2 | ( | const TopoDS_Shape & | S2 | ) |
initialize the tool <S2> - tool Obsolete
| void BRepAlgoAPI_Section::Init2 | ( | const gp_Pln & | Pl | ) |
initialize the tool <Pl> - tool Obsolete
| void BRepAlgoAPI_Section::Init2 | ( | const Handle< Geom_Surface > & | Sf | ) |
initialize the tool <Sf> - tool Obsolete
|
protectedvirtual |
Reimplemented from BRepAlgoAPI_BooleanOperation.
The documentation for this class was generated from the following file:
