# OCC.BOPAlgo module

class `BOPAlgo_Algo`(*args, **kwargs)

  Bases: `object`

  `Allocator`()

    Return type: | BOPCol_BaseAllocator

  `ErrorStatus`()

    Return type: | int

  static `GetParallelMode`(*args)

    Return type: | bool

  `Perform`()

    Return type: | void

  `RunParallel`()
    - Returns the flag of parallel processing

    Return type: | bool

  static `SetParallelMode`(*args)

    Parameters: | theNewMode (bool) –
    Return type: | void

  `SetProgressIndicator`()
    - Set the Progress Indicator object.

    Parameters: | theObj (Handle_Message_ProgressIndicator &) –
    Return type: | None

  `SetRunParallel`()
    - 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

    Parameters: | theFlag (bool) –
    Return type: | None

  `WarningStatus`()

    Return type: | int

  `thisown`

    The membership flag

`BOPAlgo_Algo_GetParallelMode`(*args)

  Return type: | bool

`BOPAlgo_Algo_SetParallelMode`(*args)

  Parameters: | theNewMode (bool) –
  Return type: | void

class `BOPAlgo_ArgumentAnalyzer`(*args)

  Bases: `OCC.BOPAlgo.BOPAlgo_Algo`

  - empty constructor

  Return type: | None

  `FuzzyValue`()
    - Returns the additional tolerance

    Return type: | float

  `GetArgumentTypeMode`()

    BOPAlgo_ArgumentAnalyzer_GetArgumentTypeMode(BOPAlgo_ArgumentAnalyzer self) -> Standard_Boolean

  `GetCheckResult`()
    - returns a result of test

    Return type: | BOPAlgo_ListOfCheckResult

  `GetContinuityMode`()

    BOPAlgo_ArgumentAnalyzer_GetContinuityMode(BOPAlgo_ArgumentAnalyzer self) -> Standard_Boolean

  `GetCurveOnSurfaceMode`()

    BOPAlgo_ArgumentAnalyzer_GetCurveOnSurfaceMode(BOPAlgo_ArgumentAnalyzer self) -> Standard_Boolean

  `GetMergeEdgeMode`()

    BOPAlgo_ArgumentAnalyzer_GetMergeEdgeMode(BOPAlgo_ArgumentAnalyzer self) -> Standard_Boolean

  `GetMergeVertexMode`()

    BOPAlgo_ArgumentAnalyzer_GetMergeVertexMode(BOPAlgo_ArgumentAnalyzer self) -> Standard_Boolean

  `GetRebuildFaceMode`()

    BOPAlgo_ArgumentAnalyzer_GetRebuildFaceMode(BOPAlgo_ArgumentAnalyzer self) -> Standard_Boolean

  `GetSelfInterMode`()

    BOPAlgo_ArgumentAnalyzer_GetSelfInterMode(BOPAlgo_ArgumentAnalyzer self) -> Standard_Boolean

  `GetShape1`()
    - returns object shape;

    Return type: | TopoDS_Shape

  `GetShape2`()
    - returns tool shape

    Return type: | TopoDS_Shape

  `GetSmallEdgeMode`()

    BOPAlgo_ArgumentAnalyzer_GetSmallEdgeMode(BOPAlgo_ArgumentAnalyzer self) -> Standard_Boolean

  `GetStopOnFirstFaulty`()

    BOPAlgo_ArgumentAnalyzer_GetStopOnFirstFaulty(BOPAlgo_ArgumentAnalyzer self) -> Standard_Boolean

  `GetTangentMode`()

    BOPAlgo_ArgumentAnalyzer_GetTangentMode(BOPAlgo_ArgumentAnalyzer self) -> Standard_Boolean

  `HasFaulty`()
    - result of test

    Return type: | bool

  `OperationType`()
    - returns ref

    Return type: | BOPAlgo_Operation

  `SetArgumentTypeMode`()

    BOPAlgo_ArgumentAnalyzer_SetArgumentTypeMode(BOPAlgo_ArgumentAnalyzer self, Standard_Boolean value)

  `SetContinuityMode`()

    BOPAlgo_ArgumentAnalyzer_SetContinuityMode(BOPAlgo_ArgumentAnalyzer self, Standard_Boolean value)

  `SetCurveOnSurfaceMode`()

    BOPAlgo_ArgumentAnalyzer_SetCurveOnSurfaceMode(BOPAlgo_ArgumentAnalyzer self, Standard_Boolean value)

  `SetFuzzyValue`()
    - Sets the additional tolerance

    Parameters: | theFuzz (float) –
    Return type: | None

  `SetMergeEdgeMode`()

    BOPAlgo_ArgumentAnalyzer_SetMergeEdgeMode(BOPAlgo_ArgumentAnalyzer self, Standard_Boolean value)

  `SetMergeVertexMode`()

    BOPAlgo_ArgumentAnalyzer_SetMergeVertexMode(BOPAlgo_ArgumentAnalyzer self, Standard_Boolean value)

  `SetRebuildFaceMode`()

    BOPAlgo_ArgumentAnalyzer_SetRebuildFaceMode(BOPAlgo_ArgumentAnalyzer self, Standard_Boolean value)

  `SetSelfInterMode`()

    BOPAlgo_ArgumentAnalyzer_SetSelfInterMode(BOPAlgo_ArgumentAnalyzer self, Standard_Boolean value)

  `SetShape1`()
    - sets object shape

    Parameters: | TheShape (TopoDS_Shape &) –
    Return type: | None

  `SetShape2`()
    - sets tool shape

    Parameters: | TheShape (TopoDS_Shape &) –
    Return type: | None

  `SetSmallEdgeMode`()

    BOPAlgo_ArgumentAnalyzer_SetSmallEdgeMode(BOPAlgo_ArgumentAnalyzer self, Standard_Boolean value)

  `SetStopOnFirstFaulty`()

    BOPAlgo_ArgumentAnalyzer_SetStopOnFirstFaulty(BOPAlgo_ArgumentAnalyzer self, Standard_Boolean value)

  `SetTangentMode`()

    BOPAlgo_ArgumentAnalyzer_SetTangentMode(BOPAlgo_ArgumentAnalyzer self, Standard_Boolean value)

  `thisown`

    The membership flag

class `BOPAlgo_BOP`(*args)

  Bases: `OCC.BOPAlgo.BOPAlgo_Builder`

  - Empty constructor

  Return type: | None
  Parameters: | theAllocator (BOPCol_BaseAllocator &) –
  Return type: | None

  `AddTool`()
    - Adds Tool argument of the operation

    Parameters: | theShape (TopoDS_Shape &) –
    Return type: | void

  `Operation`()

    Return type: | BOPAlgo_Operation

  `SetOperation`()

    Parameters: | theOperation (BOPAlgo_Operation) –
    Return type: | None

  `SetTools`()

    Parameters: | theShapes (BOPCol_ListOfShape &) – theShapes –
    Return type: | void
    Return type: | void

  `thisown`

    The membership flag

class `BOPAlgo_Builder`(*args)

  Bases: `OCC.BOPAlgo.BOPAlgo_BuilderShape`

  Return type: | None
  Parameters: | theAllocator (BOPCol_BaseAllocator &) –
  Return type: | None

  `AddArgument`()

    Parameters: | theShape (TopoDS_Shape &) –
    Return type: | void

  `Arguments`()

    Return type: | BOPCol_ListOfShape

  `Clear`()

    Return type: | void

  `FuzzyValue`()
    - Returns the additional tolerance

    Return type: | float

  `Images`()

    Return type: | BOPCol_DataMapOfShapeListOfShape

  `IsInterferred`()

    Parameters: | theS (TopoDS_Shape &) –
    Return type: | bool

  `Origins`()
    - Returns myOrigins.

    Return type: | BOPCol_DataMapOfShapeShape

  `PDS`()

    Return type: | BOPDS_PDS

  `PPaveFiller`()

    Return type: | BOPAlgo_PPaveFiller

  `PerformWithFiller`()

    Parameters: | theFiller (BOPAlgo_PaveFiller &) –
    Return type: | void

  `SetArguments`()

    Parameters: | theLS (BOPCol_ListOfShape &) – theLS –
    Return type: | None
    Return type: | void

  `SetFuzzyValue`()
    - Sets the additional tolerance

    Parameters: | theFuzz (float) –
    Return type: | None

  `ShapesSD`()
    - Returns myShapesSD.

    Return type: | BOPCol_DataMapOfShapeShape

  `Splits`()
    - Returns mySplits.

    Return type: | BOPCol_DataMapOfShapeListOfShape

  `thisown`

    The membership flag

class `BOPAlgo_BuilderArea`(*args, **kwargs)

  Bases: `OCC.BOPAlgo.BOPAlgo_Algo`

  `Areas`()

    Return type: | BOPCol_ListOfShape

  `Loops`()

    Return type: | BOPCol_ListOfShape

  `SetContext`()

    Parameters: | theContext (Handle_IntTools_Context &) –
    Return type: | None

  `SetShapes`()

    Parameters: | theLS (BOPCol_ListOfShape &) –
    Return type: | None

  `Shapes`()

    Return type: | BOPCol_ListOfShape

  `thisown`

    The membership flag

class `BOPAlgo_BuilderFace`(*args)

  Bases: `OCC.BOPAlgo.BOPAlgo_BuilderArea`

  Return type: | None
  Parameters: | theAllocator (BOPCol_BaseAllocator &) –
  Return type: | None

  `Face`()
    - Returns the face generatix

    Return type: | TopoDS_Face

  `Orientation`()

    Return type: | TopAbs_Orientation

  `SetFace`()
    - Sets the face generatix

    Parameters: | theFace (TopoDS_Face &) –
    Return type: | None

  `thisown`

    The membership flag

class `BOPAlgo_BuilderShape`(*args, **kwargs)

  Bases: `OCC.BOPAlgo.BOPAlgo_Algo`

  `Generated`()
    - Returns the list of shapes generated from the shape theS.

    Parameters: | theS (TopoDS_Shape &) –
    Return type: | TopTools_ListOfShape

  `HasDeleted`()
    - Returns true if the at least one shape(or subshape) of arguments has been deleted.

    Return type: | bool

  `HasGenerated`()
    - Returns true if the at least one shape(or subshape) of arguments has generated shapes.

    Return type: | bool

  `HasModified`()
    - Returns true if the at least one shape(or subshape) of arguments has modified shapes.

    Return type: | bool

  `ImagesResult`()

    Return type: | BOPCol_IndexedDataMapOfShapeListOfShape

  `IsDeleted`()
    - Returns true if the shape theS has been deleted.

    Parameters: | theS (TopoDS_Shape &) –
    Return type: | bool

  `Modified`()
    - Returns the list of shapes modified from the shape theS.

    Parameters: | theS (TopoDS_Shape &) –
    Return type: | TopTools_ListOfShape

  `Shape`()
    - Returns the result of algorithm

    Return type: | TopoDS_Shape

  `thisown`

    The membership flag

class `BOPAlgo_BuilderSolid`(*args)

  Bases: `OCC.BOPAlgo.BOPAlgo_BuilderArea`

  Return type: | None
  Parameters: | theAllocator (BOPCol_BaseAllocator &) –
  Return type: | None

  `SetSolid`()
    - Sets the source solid <theSolid>

    Parameters: | theSolid (TopoDS_Solid &) –
    Return type: | None

  `Solid`()
    - Returns the source solid

    Return type: | TopoDS_Solid

  `thisown`

    The membership flag

class `BOPAlgo_CheckResult`(*args)

  Bases: `object`

  - empty constructor

  Return type: | None

  `AddFaultyShape1`()
    - adds faulty sub-shapes from object to a list

    Parameters: | TheShape (TopoDS_Shape &) –
    Return type: | None

  `AddFaultyShape2`()
    - adds faulty sub-shapes from tool to a list

    Parameters: | TheShape (TopoDS_Shape &) –
    Return type: | None

  `GetCheckStatus`()
    - gets status of faulty

    Return type: | BOPAlgo_CheckStatus

  `GetFaultyShapes1`()
    - returns list of faulty shapes for object

    Return type: | BOPCol_ListOfShape

  `GetFaultyShapes2`()
    - returns list of faulty shapes for tool

    Return type: | BOPCol_ListOfShape

  `GetMaxDistance1`()
    - Returns the distance for the first shape

    Return type: | float

  `GetMaxDistance2`()
    - Returns the distance for the second shape

    Return type: | float

  `GetMaxParameter1`()
    - Returns the parameter for the fircst shape

    Return type: | float

  `GetMaxParameter2`()
    - Returns the parameter for the second shape

    Return type: | float

  `GetShape1`()
    - returns ancestor shape (object) for faulties

    Return type: | TopoDS_Shape

  `GetShape2`()
    - returns ancestor shape (tool) for faulties

    Return type: | TopoDS_Shape

  `SetCheckStatus`()
    - set status of faulty

    Parameters: | TheStatus (BOPAlgo_CheckStatus) –
    Return type: | None

  `SetMaxDistance1`()
    - Sets max distance for the first shape

    Parameters: | theDist (float) –
    Return type: | None

  `SetMaxDistance2`()
    - Sets max distance for the second shape

    Parameters: | theDist (float) –
    Return type: | None

  `SetMaxParameter1`()
    - Sets the parameter for the first shape

    Parameters: | thePar (float) –
    Return type: | None

  `SetMaxParameter2`()
    - Sets the parameter for the second shape

    Parameters: | thePar (float) –
    Return type: | None

  `SetShape1`()
    - sets ancestor shape (object) for faulty sub-shapes

    Parameters: | TheShape (TopoDS_Shape &) –
    Return type: | None

  `SetShape2`()
    - sets ancestor shape (tool) for faulty sub-shapes

    Parameters: | TheShape (TopoDS_Shape &) –
    Return type: | None

  `thisown`

    The membership flag

class `BOPAlgo_CheckerSI`(*args)

  Bases: `OCC.BOPAlgo.BOPAlgo_PaveFiller`

  Return type: | None

  `NonDestructive`()
    - Returns the flag that defines the mode of the treatment: true when the copy of the argument is used false when the argument itself is used

    Return type: | bool

  `SetLevelOfCheck`()
    - Sets the level of checking shape on self-interference. It defines which interferferences will be checked: 0 - only V/V; 1 - V/V and V/E; 2 - V/V, V/E and E/E; 3 - V/V, V/E, E/E and V/F; 4 - V/V, V/E, E/E, V/F and E/F; 5 - all interferences, default value.

    Parameters: | theLevel (int) –
    Return type: | None

  `SetNonDestructive`()
    - Sets the flag <theFlag> that defines the mode of the treatment: the copy of the argument when theFlag is true the argument itself when theFlag is false

    Parameters: | theFlag (bool) –
    Return type: | None

  `thisown`

    The membership flag

class `BOPAlgo_MakerVolume`(*args)

  Bases: `OCC.BOPAlgo.BOPAlgo_Builder`

  - Empty contructor.

  Return type: | None

  - Empty contructor.

  Parameters: | theAllocator (BOPCol_BaseAllocator &) –
  Return type: | None

  `Box`()
    - Returns the solid box <mySBox>.

    Return type: | TopoDS_Solid

  `Faces`()
    - Returns the processed faces <myFaces>.

    Return type: | BOPCol_ListOfShape

  `IsIntersect`()
    - Returns the flag <myIntersect>.

    Return type: | bool

  `SetIntersect`()
    - Sets the flag myIntersect: if <bIntersect> is True the shapes from <myArguments> will be intersected. if <bIntersect> is False no intersection will be done.

    Parameters: | bIntersect (bool) –
    Return type: | None

  `thisown`

    The membership flag

class `BOPAlgo_PaveFiller`(*args)

  Bases: `OCC.BOPAlgo.BOPAlgo_Algo`

  Return type: | None
  Parameters: | theAllocator (BOPCol_BaseAllocator &) –
  Return type: | None

  `Arguments`()

    Return type: | BOPCol_ListOfShape

  `Context`()

    Return type: | Handle_IntTools_Context

  `DS`()

    Return type: | BOPDS_DS

  `FuzzyValue`()
    - Returns the additional tolerance

    Return type: | float

  `PDS`()

    Return type: | BOPDS_PDS

  `SetArguments`()

    Parameters: | theLS (TopTools_ListOfShape &) – theLS –
    Return type: | None
    Return type: | None

  `SetFuzzyValue`()
    - Sets the additional tolerance

    Parameters: | theFuzz (float) –
    Return type: | None

  `SetSectionAttribute`()

    Parameters: | theSecAttr (BOPAlgo_SectionAttribute &) –
    Return type: | None

  `thisown`

    The membership flag

class `BOPAlgo_Section`(*args)

  Bases: `OCC.BOPAlgo.BOPAlgo_Builder`

  - Empty constructor

  Return type: | None

  - Empty constructor //! protected methods

  Parameters: | theAllocator (BOPCol_BaseAllocator &) –
  Return type: | None

  `BuildSection`()

    Return type: | void

  `thisown`

    The membership flag

class `BOPAlgo_SectionAttribute`(*args)

  Bases: `object`

  - Initializes me by flags

  Parameters: | Aproximation (bool) – default value is Standard_True PCurveOnS1 (bool) – default value is Standard_True PCurveOnS2 (bool) – default value is Standard_True
  Return type: | None

  `Approximation`()
    - Modifier

    Parameters: | theFlag (bool) –
    Return type: | None

    - Selector

    Return type: | bool

  `PCurveOnS1`()
    - Modifier

    Parameters: | theFlag (bool) –
    Return type: | None

    - Selector

    Return type: | bool

  `PCurveOnS2`()
    - Modifier

    Parameters: | theFlag (bool) –
    Return type: | None

    - Selector

    Return type: | bool

  `thisown`

    The membership flag

class `BOPAlgo_ShellSplitter`(*args)

  Bases: `OCC.BOPAlgo.BOPAlgo_Algo`

  - empty constructor

  Return type: | None

  - constructor

  Parameters: | theAllocator (BOPCol_BaseAllocator &) –
  Return type: | None

  `AddStartElement`()
    - adds a face <theS> to process

    Parameters: | theS (TopoDS_Shape &) –
    Return type: | None

  `Shells`()
    - returns the loops

    Return type: | BOPCol_ListOfShape

  static `SplitBlock`(*args)

    Parameters: | theCB (BOPTools_ConnexityBlock &) –
    Return type: | void

  `StartElements`()
    - return the faces to process

    Return type: | BOPCol_ListOfShape

  `thisown`

    The membership flag

`BOPAlgo_ShellSplitter_SplitBlock`(*args)

  Parameters: | theCB (BOPTools_ConnexityBlock &) –
  Return type: | void

class `BOPAlgo_Tools`

  Bases: `object`

  static `FillMap`(*args)

    Parameters: | tneN1 (int) – tneN2 (int) – theMILI (BOPDS_IndexedDataMapOfPaveBlockListOfInteger &) – theAllocator (BOPCol_BaseAllocator &) – tnePB1 (Handle_BOPDS_PaveBlock &) – tnePB2 (Handle_BOPDS_PaveBlock &) – theMILI – theAllocator – tnePB1 – tneF (int) – theMILI – theAllocator –
    Return type: | void
    Return type: | void
    Return type: | void

  static `MakeBlocks`(*args)

    Parameters: | theMILI (BOPDS_IndexedDataMapOfPaveBlockListOfPaveBlock &) – theMBlocks (BOPDS_DataMapOfIntegerListOfPaveBlock &) – theAllocator (BOPCol_BaseAllocator &) –
    Return type: | void

  static `MakeBlocksCnx`(*args)

    Parameters: | theMILI (BOPCol_IndexedDataMapOfIntegerListOfInteger &) – theMBlocks (BOPCol_DataMapOfIntegerListOfInteger &) – theAllocator (BOPCol_BaseAllocator &) –
    Return type: | void

  static `PerformCommonBlocks`(*args)

    Parameters: | theMBlocks (BOPDS_IndexedDataMapOfPaveBlockListOfInteger &) – theAllocator (BOPCol_BaseAllocator &) – pDS (BOPDS_PDS &) – theMBlocks – theAllocator – pDS –
    Return type: | void
    Return type: | void

  `thisown`

    The membership flag

`BOPAlgo_Tools_FillMap`(*args)

  Parameters: | tneN1 (int) – tneN2 (int) – theMILI (BOPDS_IndexedDataMapOfPaveBlockListOfInteger &) – theAllocator (BOPCol_BaseAllocator &) – tnePB1 (Handle_BOPDS_PaveBlock &) – tnePB2 (Handle_BOPDS_PaveBlock &) – theMILI – theAllocator – tnePB1 – tneF (int) – theMILI – theAllocator –
  Return type: | void
  Return type: | void
  Return type: | void

`BOPAlgo_Tools_MakeBlocks`(*args)

  Parameters: | theMILI (BOPDS_IndexedDataMapOfPaveBlockListOfPaveBlock &) – theMBlocks (BOPDS_DataMapOfIntegerListOfPaveBlock &) – theAllocator (BOPCol_BaseAllocator &) –
  Return type: | void

`BOPAlgo_Tools_MakeBlocksCnx`(*args)

  Parameters: | theMILI (BOPCol_IndexedDataMapOfIntegerListOfInteger &) – theMBlocks (BOPCol_DataMapOfIntegerListOfInteger &) – theAllocator (BOPCol_BaseAllocator &) –
  Return type: | void

`BOPAlgo_Tools_PerformCommonBlocks`(*args)

  Parameters: | theMBlocks (BOPDS_IndexedDataMapOfPaveBlockListOfInteger &) – theAllocator (BOPCol_BaseAllocator &) – pDS (BOPDS_PDS &) – theMBlocks – theAllocator – pDS –
  Return type: | void
  Return type: | void

class `BOPAlgo_WireEdgeSet`(*args)

  Bases: `object`

  Return type: | None
  Parameters: | theAllocator (BOPCol_BaseAllocator &) –
  Return type: | None

  `AddShape`()

    Parameters: | sS (TopoDS_Shape &) –
    Return type: | None

  `AddStartElement`()

    Parameters: | sS (TopoDS_Shape &) –
    Return type: | None

  `Clear`()

    Return type: | None

  `Face`()

    Return type: | TopoDS_Face

  `SetFace`()

    Parameters: | aF (TopoDS_Face &) –
    Return type: | None

  `Shapes`()

    Return type: | BOPCol_ListOfShape

  `StartElements`()

    Return type: | BOPCol_ListOfShape

  `thisown`

    The membership flag

class `BOPAlgo_WireSplitter`(*args)

  Bases: `OCC.BOPAlgo.BOPAlgo_Algo`

  Return type: | None
  Parameters: | theAllocator (BOPCol_BaseAllocator &) –
  Return type: | None

  static `MakeWire`(*args)

    Parameters: | theLE (BOPCol_ListOfShape &) – theW (TopoDS_Wire &) –
    Return type: | void

  `SetWES`()

    Parameters: | theWES (BOPAlgo_WireEdgeSet &) –
    Return type: | None

  static `SplitBlock`(*args)

    Parameters: | theF (TopoDS_Face &) – theCB (BOPTools_ConnexityBlock &) –
    Return type: | void

  `WES`()

    Return type: | BOPAlgo_WireEdgeSet

  `thisown`

    The membership flag

`BOPAlgo_WireSplitter_MakeWire`(*args)

  Parameters: | theLE (BOPCol_ListOfShape &) – theW (TopoDS_Wire &) –
  Return type: | void

`BOPAlgo_WireSplitter_SplitBlock`(*args)

  Parameters: | theF (TopoDS_Face &) – theCB (BOPTools_ConnexityBlock &) –
  Return type: | void

class `SwigPyIterator`(*args, **kwargs)

  Bases: `object`

  `advance`()
  `copy`()
  `decr`()
  `distance`()
  `equal`()
  `incr`()
  `next`()
  `previous`()
  `thisown`

    The membership flag

  `value`()

`register_handle`(handle, base_object)

  Inserts the handle into the base object to prevent memory corruption in certain cases