Provides a tool to make cylindrical holes on a shape. More...

#include <BRepFeat_MakeCylindricalHole.hxx>

Inheritance diagram for BRepFeat_MakeCylindricalHole:

[legend]

Public Member Functions
	BRepFeat_MakeCylindricalHole ()
	Empty constructor.

void	Init (const gp_Ax1 &Axis)
	Sets the axis of the hole(s).

void	Init (const TopoDS_Shape &S, const gp_Ax1 &Axis)
	Sets the shape and axis on which hole(s) will be performed.

void	Perform (const double Radius)
	Performs every hole of radius <Radius>. This command has the same effect as a cut operation with an infinite cylinder defined by the given axis and <Radius>.

void	Perform (const double Radius, const double PFrom, const double PTo, const bool WithControl=true)
	Performs every hole of radius <Radius> located between PFrom and PTo on the given axis. If <WithControl> is set to false no control are done on the resulting shape after the operation is performed.

void	PerformThruNext (const double Radius, const bool WithControl=true)
	Performs the first hole of radius <Radius>, in the direction of the defined axis. First hole signify first encountered after the origin of the axis. If <WithControl> is set to false no control are done on the resulting shape after the operation is performed.

void	PerformUntilEnd (const double Radius, const bool WithControl=true)
	Performs every hole of radius <Radius> located after the origin of the given axis. If <WithControl> is set to false no control are done on the resulting shape after the operation is performed.

void	PerformBlind (const double Radius, const double Length, const bool WithControl=true)
	Performs a blind hole of radius <Radius> and length <Length>. The length is measured from the origin of the given axis. If <WithControl> is set to false no control are done after the operation is performed.

BRepFeat_Status	Status () const
	Returns the status after a hole is performed.

void	Build ()
	Builds the resulting shape (redefined from MakeShape). Invalidates the given parts of tools if any, and performs the result of the local operation.

Public Member Functions inherited from BRepFeat_Builder
	BRepFeat_Builder ()

	~BRepFeat_Builder () override

void	Clear () override
	Clears internal fields and arguments.

void	Init (const TopoDS_Shape &theShape)
	Initializes the object of local boolean operation.

void	Init (const TopoDS_Shape &theShape, const TopoDS_Shape &theTool)
	Initializes the arguments of local boolean operation.

void	SetOperation (const int theFuse)
	Sets the operation of local boolean operation. If theFuse = 0 than the operation is CUT, otherwise FUSE.

void	SetOperation (const int theFuse, const bool theFlag)
	Sets the operation of local boolean operation. If theFlag = TRUE it means that no selection of parts of the tool is needed, t.e. no second part. In that case if theFuse = 0 than operation is COMMON, otherwise CUT21. If theFlag = FALSE SetOperation(theFuse) function is called.

void	PartsOfTool (NCollection_List< TopoDS_Shape > &theLT)
	Collects parts of the tool.

void	KeepParts (const NCollection_List< TopoDS_Shape > &theIm)
	Initializes parts of the tool for second step of algorithm. Collects shapes and all sub-shapes into myShapes map.

void	KeepPart (const TopoDS_Shape &theS)
	Adds shape theS and all its sub-shapes into myShapes map.

void	PerformResult (const Message_ProgressRange &theRange=Message_ProgressRange())
	Main function to build the result of the local operation required.

void	RebuildFaces ()
	Rebuilds faces in accordance with the kept parts of the tool.

void	RebuildEdge (const TopoDS_Shape &theE, const TopoDS_Face &theF, const NCollection_Map< TopoDS_Shape, TopTools_ShapeMapHasher > &theME, NCollection_List< TopoDS_Shape > &aLEIm)
	Rebuilds edges in accordance with the kept parts of the tool.

void	CheckSolidImages ()
	Collects the images of the object, that contains in the images of the tool.

void	FillRemoved ()
	Collects the removed parts of the tool into myRemoved map.

void	FillRemoved (const TopoDS_Shape &theS, NCollection_Map< TopoDS_Shape, TopTools_ShapeMapHasher > &theM)
	Adds the shape S and its sub-shapes into myRemoved map.

Public Member Functions inherited from BOPAlgo_BOP
	BOPAlgo_BOP ()
	Empty constructor.

	~BOPAlgo_BOP () override

	BOPAlgo_BOP (const occ::handle< NCollection_BaseAllocator > &theAllocator)

void	SetOperation (const BOPAlgo_Operation theOperation)

BOPAlgo_Operation	Operation () const

void	Perform (const Message_ProgressRange &theRange=Message_ProgressRange()) override
	The main method to implement the operation Providing the range allows to enable Progress indicator User break functionalities.

Public Member Functions inherited from BOPAlgo_ToolsProvider
	BOPAlgo_ToolsProvider ()
	Empty constructor.

	BOPAlgo_ToolsProvider (const occ::handle< NCollection_BaseAllocator > &theAllocator)

virtual void	AddTool (const TopoDS_Shape &theShape)
	Adds Tool argument of the operation.

virtual void	SetTools (const NCollection_List< TopoDS_Shape > &theShapes)
	Adds the Tool arguments of the operation.

const NCollection_List< TopoDS_Shape > &	Tools () const
	Returns the Tool arguments of the operation.

Public Member Functions inherited from BOPAlgo_Builder
	BOPAlgo_Builder ()
	Empty constructor.

	~BOPAlgo_Builder () override

	BOPAlgo_Builder (const occ::handle< NCollection_BaseAllocator > &theAllocator)

BOPAlgo_PPaveFiller	PPaveFiller ()
	Returns the PaveFiller, algorithm for sub-shapes intersection.

BOPDS_PDS	PDS ()
	Returns the Data Structure, holder of intersection information.

occ::handle< IntTools_Context >	Context () const
	Returns the Context, tool for cashing heavy algorithms.

virtual void	AddArgument (const TopoDS_Shape &theShape)
	Sets the list of arguments for the operation.

virtual void	SetArguments (const NCollection_List< TopoDS_Shape > &theLS)
	Sets the list of arguments for the operation.

const NCollection_List< TopoDS_Shape > &	Arguments () const
	Returns the list of arguments.

void	SetNonDestructive (const bool theFlag)
	Returns the flag that defines the mode of treatment. In non-destructive mode the argument shapes are not modified. Instead a copy of a sub-shape is created in the result if it is needed to be updated.

bool	NonDestructive () const
	Returns the flag that defines the mode of treatment. In non-destructive mode the argument shapes are not modified. Instead a copy of a sub-shape is created in the result if it is needed to be updated.

void	SetGlue (const BOPAlgo_GlueEnum theGlue)
	Sets the glue option for the algorithm.

BOPAlgo_GlueEnum	Glue () const
	Returns the glue option of the algorithm.

void	SetCheckInverted (const bool theCheck)
	Enables/Disables the check of the input solids for inverted status.

bool	CheckInverted () const
	Returns the flag defining whether the check for input solids on inverted status should be performed or not.

void	Perform (const Message_ProgressRange &theRange=Message_ProgressRange()) override
	Performs the operation with the prepared filler. The intersection will not be performed in this case.

virtual void	PerformWithFiller (const BOPAlgo_PaveFiller &theFiller, const Message_ProgressRange &theRange=Message_ProgressRange())
	Performs the operation with the prepared filler. The intersection will not be performed in this case.

virtual void	BuildBOP (const NCollection_List< TopoDS_Shape > &theObjects, const TopAbs_State theObjState, const NCollection_List< TopoDS_Shape > &theTools, const TopAbs_State theToolsState, const Message_ProgressRange &theRange, occ::handle< Message_Report > theReport=nullptr)
	Builds the result of Boolean operation of given type basing on the result of Builder operation (GF or any other).

void	BuildBOP (const NCollection_List< TopoDS_Shape > &theObjects, const NCollection_List< TopoDS_Shape > &theTools, const BOPAlgo_Operation theOperation, const Message_ProgressRange &theRange, occ::handle< Message_Report > theReport=nullptr)
	Builds the result of Boolean operation of given type basing on the result of Builder operation (GF or any other).

const NCollection_DataMap< TopoDS_Shape, NCollection_List< TopoDS_Shape >, TopTools_ShapeMapHasher > &	Images () const
	Returns the map of origins.

const NCollection_DataMap< TopoDS_Shape, NCollection_List< TopoDS_Shape >, TopTools_ShapeMapHasher > &	Origins () const
	Returns the map of origins.

const NCollection_DataMap< TopoDS_Shape, TopoDS_Shape, TopTools_ShapeMapHasher > &	ShapesSD () const
	Returns the map of Same Domain (SD) shapes - coinciding shapes from different arguments.

Public Member Functions inherited from BOPAlgo_BuilderShape
const TopoDS_Shape &	Shape () const

const NCollection_List< TopoDS_Shape > &	Modified (const TopoDS_Shape &theS)
	Returns the list of shapes Generated from the shape theS.

const NCollection_List< TopoDS_Shape > &	Generated (const TopoDS_Shape &theS)
	Returns the list of shapes Generated from the shape theS.

bool	IsDeleted (const TopoDS_Shape &theS)
	Returns true if the shape theS has been deleted. In this case the shape will have no Modified elements, but can have Generated elements.

bool	HasModified () const
	Returns true if any of the input shapes has been modified during operation.

bool	HasGenerated () const
	Returns true if any of the input shapes has generated shapes during operation.

bool	HasDeleted () const
	Returns true if any of the input shapes has been deleted during operation.

occ::handle< BRepTools_History >	History ()
	History Tool.

void	SetToFillHistory (const bool theHistFlag)
	Returns flag of history availability.

bool	HasHistory () const
	Returns flag of history availability.

Public Member Functions inherited from BOPAlgo_Options
	BOPAlgo_Options ()
	Empty constructor.

	BOPAlgo_Options (const occ::handle< NCollection_BaseAllocator > &theAllocator)
	Constructor with allocator.

virtual	~BOPAlgo_Options ()
	Destructor.

const occ::handle< NCollection_BaseAllocator > &	Allocator () const
	Returns allocator.

void	AddError (const occ::handle< Message_Alert > &theAlert)
	Adds the alert as error (fail)

void	AddWarning (const occ::handle< Message_Alert > &theAlert)
	Adds the alert as warning.

bool	HasErrors () const
	Returns true if algorithm has failed.

bool	HasError (const occ::handle< Standard_Type > &theType) const
	Returns true if algorithm has generated error of specified type.

bool	HasWarnings () const
	Returns true if algorithm has generated some warning alerts.

bool	HasWarning (const occ::handle< Standard_Type > &theType) const
	Returns true if algorithm has generated warning of specified type.

const occ::handle< Message_Report > &	GetReport () const
	Returns report collecting all errors and warnings.

void	DumpErrors (Standard_OStream &theOS) const
	Dumps the error status into the given stream.

void	DumpWarnings (Standard_OStream &theOS) const
	Dumps the warning statuses into the given stream.

void	ClearWarnings ()
	Clears the warnings of the algorithm.

void	SetFuzzyValue (const double theFuzz)
	Sets the additional tolerance.

double	FuzzyValue () const
	Returns the additional tolerance.

void	SetUseOBB (const bool theUseOBB)
	Enables/Disables the usage of OBB.

bool	UseOBB () const
	Returns the flag defining usage of OBB.

void	SetRunParallel (const bool 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.

bool	RunParallel () const
	Returns the flag of parallel processing.

Additional Inherited Members
Static Public Member Functions inherited from BOPAlgo_Options
static bool	GetParallelMode ()
	Gets the global parallel mode.

static void	SetParallelMode (const bool theNewMode)
	Sets the global parallel mode.

Protected Types inherited from BOPAlgo_BOP
enum	BOPAlgo_PIOperation { PIOperation_BuildShape = BOPAlgo_ToolsProvider::PIOperation_Last , PIOperation_Last }
	Extend list of operations to be supported by the Progress Indicator. More...

Protected Types inherited from BOPAlgo_Builder
enum	BOPAlgo_PIOperation { PIOperation_TreatVertices = 0 , PIOperation_TreatEdges , PIOperation_TreatWires , PIOperation_TreatFaces , PIOperation_TreatShells , PIOperation_TreatSolids , PIOperation_TreatCompsolids , PIOperation_TreatCompounds , PIOperation_FillHistory , PIOperation_PostTreat , PIOperation_Last }
	Compute number of shapes of certain type participating in operation. More...

Protected Member Functions inherited from BRepFeat_Builder
void	Prepare () override
	Prepares builder of local operation.

void	FillIn3DParts (NCollection_DataMap< TopoDS_Shape, TopoDS_Shape, TopTools_ShapeMapHasher > &theDraftSolids, const Message_ProgressRange &theRange) override
	Function is redefined to avoid the usage of removed faces.

bool	CheckArgsForOpenSolid () override
	Avoid the check for open solids and always use the splits of solids for building the result shape.

Protected Member Functions inherited from BOPAlgo_BOP
void	CheckData () override
	Checks input data.

void	PerformInternal1 (const BOPAlgo_PaveFiller &thePF, const Message_ProgressRange &theRange) override
	Performs calculations using prepared Filler object <thePF>

void	BuildResult (const TopAbs_ShapeEnum theType) override
	Builds the result of operation. The method is called for each of the arguments type and adds into the result the splits of the arguments of that type.

void	BuildShape (const Message_ProgressRange &theRange)

void	BuildRC (const Message_ProgressRange &theRange)

void	BuildSolid (const Message_ProgressRange &theRange)

bool	TreatEmptyShape ()
	Treatment of the cases with empty shapes. It returns TRUE if there is nothing to do, i.e. all shapes in one of the groups are empty shapes.

void	fillPIConstants (const double theWhole, BOPAlgo_PISteps &theSteps) const override
	Fill PI steps.

Protected Member Functions inherited from BOPAlgo_Builder
void	PrepareHistory (const Message_ProgressRange &theRange)
	Prepare history information for the input shapes taking into account possible operation-specific modifications. For instance, in the CellsBuilder operation, additionally to splitting input shapes the splits of the shapes (or the shapes themselves) may be unified during removal of internal boundaries. In this case each split should be linked to the unified shape.

virtual const NCollection_List< TopoDS_Shape > *	LocModified (const TopoDS_Shape &theS)
	Prepare history information for the input shapes taking into account possible operation-specific modifications. For instance, in the CellsBuilder operation, additionally to splitting input shapes the splits of the shapes (or the shapes themselves) may be unified during removal of internal boundaries. In this case each split should be linked to the unified shape.

virtual const NCollection_List< TopoDS_Shape > &	LocGenerated (const TopoDS_Shape &theS)
	Returns the list of shapes generated from the shape theS. Similarly to LocModified must be redefined for specific operations, obtaining Generated elements differently.

virtual void	PerformInternal (const BOPAlgo_PaveFiller &thePF, const Message_ProgressRange &theRange)
	Performs the building of the result. To build the result of any other operation it will be necessary to override this method.

void	CheckData () override
	Checks if the intersection algorithm has Errors/Warnings.

void	CheckFiller ()
	Checks if the intersection algorithm has Errors/Warnings.

void	FillImagesVertices (const Message_ProgressRange &theRange)

void	FillImagesEdges (const Message_ProgressRange &theRange)

void	FillImagesContainers (const TopAbs_ShapeEnum theType, const Message_ProgressRange &theRange)
	Builds the image of the given container using the splits of its sub-shapes.

void	FillImagesContainer (const TopoDS_Shape &theS, const TopAbs_ShapeEnum theType)
	Builds the image of the given container using the splits of its sub-shapes.

void	FillImagesFaces (const Message_ProgressRange &theRange)
	Builds the splits of faces using the information from the intersection stage stored in Data Structure.

virtual void	BuildSplitFaces (const Message_ProgressRange &theRange)
	Builds the splits of faces using the information from the intersection stage stored in Data Structure.

void	FillSameDomainFaces (const Message_ProgressRange &theRange)
	Looks for the same domain faces among the splits of the faces. Updates the map of images with SD faces.

void	FillInternalVertices (const Message_ProgressRange &theRange)
	Classifies the alone vertices on faces relatively its splits and adds them as INTERNAL into the splits.

void	FillImagesSolids (const Message_ProgressRange &theRange)
	Builds the draft solid by rebuilding the shells of the solid with the splits of faces.

void	BuildDraftSolid (const TopoDS_Shape &theSolid, TopoDS_Shape &theDraftSolid, NCollection_List< TopoDS_Shape > &theLIF)
	Builds the draft solid by rebuilding the shells of the solid with the splits of faces.

void	BuildSplitSolids (NCollection_DataMap< TopoDS_Shape, TopoDS_Shape, TopTools_ShapeMapHasher > &theDraftSolids, const Message_ProgressRange &theRange)
	Builds the splits of the solids using their draft versions and faces located inside.

void	FillInternalShapes (const Message_ProgressRange &theRange)
	Classifies the vertices and edges from the arguments relatively splits of solids and makes them INTERNAL for solids.

void	FillImagesCompounds (const Message_ProgressRange &theRange)
	Builds the image of the given compound.

void	FillImagesCompound (const TopoDS_Shape &theS, NCollection_Map< TopoDS_Shape, TopTools_ShapeMapHasher > &theMF)
	Builds the image of the given compound.

virtual void	PostTreat (const Message_ProgressRange &theRange)

NbShapes	getNbShapes () const
	Compute number of shapes of certain type participating in operation.

void	fillPIConstants (const double theWhole, BOPAlgo_PISteps &theSteps) const override
	Filling steps for constant operations.

void	fillPISteps (BOPAlgo_PISteps &theSteps) const override
	Filling steps for all other operations.

Protected Member Functions inherited from BOPAlgo_BuilderShape
	BOPAlgo_BuilderShape ()
	Constructor with allocator.

	BOPAlgo_BuilderShape (const occ::handle< NCollection_BaseAllocator > &theAllocator)
	Constructor with allocator.

Protected Member Functions inherited from BOPAlgo_Algo
	BOPAlgo_Algo ()
	Default constructor.

	~BOPAlgo_Algo () override

	BOPAlgo_Algo (const occ::handle< NCollection_BaseAllocator > &theAllocator)

virtual void	CheckResult ()
	Checks the obtained result.

void	analyzeProgress (const double theWhole, BOPAlgo_PISteps &theSteps) const
	Fills the values for constant operations - the operations having constant relative running time.

Protected Member Functions inherited from BOPAlgo_Options
bool	UserBreak (const Message_ProgressScope &thePS)
	Adds error to the report if the break signal was caught. Returns true in this case, false otherwise.

Protected Attributes inherited from BRepFeat_Builder
NCollection_Map< TopoDS_Shape, TopTools_ShapeMapHasher >	myShapes

NCollection_Map< TopoDS_Shape, TopTools_ShapeMapHasher >	myRemoved

int	myFuse

Protected Attributes inherited from BOPAlgo_BOP
BOPAlgo_Operation	myOperation

int	myDims [2]

TopoDS_Shape	myRC

Protected Attributes inherited from BOPAlgo_ToolsProvider
NCollection_List< TopoDS_Shape >	myTools

NCollection_Map< TopoDS_Shape, TopTools_ShapeMapHasher >	myMapTools

Protected Attributes inherited from BOPAlgo_Builder
NCollection_List< TopoDS_Shape >	myArguments
	Arguments of the operation.

NCollection_Map< TopoDS_Shape, TopTools_ShapeMapHasher >	myMapFence
	Fence map providing the uniqueness of the shapes in the list of arguments.

BOPAlgo_PPaveFiller	myPaveFiller
	Pave Filler - algorithm for sub-shapes intersection.

BOPDS_PDS	myDS
	Data Structure - holder of intersection information.

occ::handle< IntTools_Context >	myContext
	Context - tool for cashing heavy algorithms such as Projectors and Classifiers.

int	myEntryPoint
	EntryPoint - controls the deletion of the PaveFiller, which could live longer than the Builder.

NCollection_DataMap< TopoDS_Shape, NCollection_List< TopoDS_Shape >, TopTools_ShapeMapHasher >	myImages
	Images - map of Images of the sub-shapes of arguments.

NCollection_DataMap< TopoDS_Shape, TopoDS_Shape, TopTools_ShapeMapHasher >	myShapesSD
	ShapesSD - map of SD Shapes.

NCollection_DataMap< TopoDS_Shape, NCollection_List< TopoDS_Shape >, TopTools_ShapeMapHasher >	myOrigins
	Origins - map of Origins, back map of Images.

NCollection_DataMap< TopoDS_Shape, NCollection_List< TopoDS_Shape >, TopTools_ShapeMapHasher >	myInParts
	InParts - map of own and acquired IN faces of the arguments solids.

bool	myNonDestructive
	Safe processing option allows avoiding modification of the input shapes.

BOPAlgo_GlueEnum	myGlue
	Gluing option allows speeding up the intersection of the input shapes.

bool	myCheckInverted
	Check inverted option allows disabling the check of input solids on inverted status.

Protected Attributes inherited from BOPAlgo_BuilderShape
TopoDS_Shape	myShape
	Result of the operation.

NCollection_List< TopoDS_Shape >	myHistShapes
	Storer for the history shapes.

NCollection_Map< TopoDS_Shape, TopTools_ShapeMapHasher >	myMapShape
	cached map of all arguments shapes

bool	myFillHistory
	Controls the history filling.

occ::handle< BRepTools_History >	myHistory
	History tool.

Protected Attributes inherited from BOPAlgo_Options
occ::handle< NCollection_BaseAllocator >	myAllocator
	Enables/Disables the usage of OBB.

occ::handle< Message_Report >	myReport
	Enables/Disables the usage of OBB.

bool	myRunParallel
	Enables/Disables the usage of OBB.

double	myFuzzyValue
	Enables/Disables the usage of OBB.

bool	myUseOBB
	Enables/Disables the usage of OBB.

Detailed Description

Provides a tool to make cylindrical holes on a shape.

Constructor & Destructor Documentation

◆ BRepFeat_MakeCylindricalHole()

BRepFeat_MakeCylindricalHole::BRepFeat_MakeCylindricalHole ( )

Empty constructor.

Member Function Documentation

◆ Build()

void BRepFeat_MakeCylindricalHole::Build ( )

Builds the resulting shape (redefined from MakeShape). Invalidates the given parts of tools if any, and performs the result of the local operation.

◆ Init() [1/2]

void BRepFeat_MakeCylindricalHole::Init ( const gp_Ax1 & Axis )

Sets the axis of the hole(s).

◆ Init() [2/2]

void BRepFeat_MakeCylindricalHole::Init	(	const TopoDS_Shape &	S,
		const gp_Ax1 &	Axis )

Sets the shape and axis on which hole(s) will be performed.

◆ Perform() [1/2]

void BRepFeat_MakeCylindricalHole::Perform ( const double Radius )

Performs every hole of radius <Radius>. This command has the same effect as a cut operation with an infinite cylinder defined by the given axis and <Radius>.

◆ Perform() [2/2]

void BRepFeat_MakeCylindricalHole::Perform	(	const double	Radius,
		const double	PFrom,
		const double	PTo,
		const bool	WithControl = true )

Performs every hole of radius <Radius> located between PFrom and PTo on the given axis. If <WithControl> is set to false no control are done on the resulting shape after the operation is performed.

◆ PerformBlind()

void BRepFeat_MakeCylindricalHole::PerformBlind	(	const double	Radius,
		const double	Length,
		const bool	WithControl = true )

Performs a blind hole of radius <Radius> and length <Length>. The length is measured from the origin of the given axis. If <WithControl> is set to false no control are done after the operation is performed.

◆ PerformThruNext()

void BRepFeat_MakeCylindricalHole::PerformThruNext	(	const double	Radius,
		const bool	WithControl = true )

Performs the first hole of radius <Radius>, in the direction of the defined axis. First hole signify first encountered after the origin of the axis. If <WithControl> is set to false no control are done on the resulting shape after the operation is performed.

◆ PerformUntilEnd()

void BRepFeat_MakeCylindricalHole::PerformUntilEnd	(	const double	Radius,
		const bool	WithControl = true )

Performs every hole of radius <Radius> located after the origin of the given axis. If <WithControl> is set to false no control are done on the resulting shape after the operation is performed.

◆ Status()

BRepFeat_Status BRepFeat_MakeCylindricalHole::Status ( ) const

Returns the status after a hole is performed.

The documentation for this class was generated from the following file:

BRepFeat_MakeCylindricalHole.hxx

Public Member Functions

Additional Inherited Members