# OCC.BOPDS module

class `BOPDS_CommonBlock`(*args)

  Bases: `OCC.MMgt.MMgt_TShared`

  - Empty contructor

  Return type: | None

  - Contructor <theAllocator> - the allocator to manage the memory

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

  `AddFace`()
    - Modifier Adds the index of the face <aF> to the list of indices of faces of the common block

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

  `AddFaces`()
    - Modifier Adds the list of indices of faces <aLF> to the list of indices of faces of the common block

    Parameters: | aLF (BOPCol_ListOfInteger &) –
    Return type: | None

  `AddPaveBlock`()
    - Modifier Adds the pave block <aPB> to the list of pave blocks of the common block

    Parameters: | aPB (Handle_BOPDS_PaveBlock &) –
    Return type: | None

  `AddPaveBlocks`()
    - Modifier Adds the list of pave blocks <aLPB> to the list of pave blocks of the common block

    Parameters: | aLPB (BOPDS_ListOfPaveBlock &) –
    Return type: | None

  `Contains`()
    - Query Returns true if the common block contains a pave block that is equal to <thePB>

    Parameters: | thePB (Handle_BOPDS_PaveBlock &) –
    Return type: | bool

    - Query Returns true if the common block contains the face with index equal to <theF>

    Parameters: | theF (int) –
    Return type: | bool

  `Dump`()

    Return type: | None

  `Edge`()
    - Selector Returns the index of the edge of all pave blocks of the common block

    Return type: | int

  `Faces`()
    - Selector Returns the list of indices of faces of the common block

    Return type: | BOPCol_ListOfInteger

  `GetHandle`()
  `IsPaveBlockOnEdge`()
    - Query Returns true if the common block contains a pave block that belongs to the edge with index <theIx>

    Parameters: | theIndex (int) –
    Return type: | bool

  `IsPaveBlockOnFace`()
    - Query Returns true if the common block contains a pave block that belongs to the face with index <theIx>

    Parameters: | theIndex (int) –
    Return type: | bool

  `PaveBlock1`()
    - Selector Returns the first pave block of the common block

    Return type: | Handle_BOPDS_PaveBlock

  `PaveBlockOnEdge`()
    - Selector Returns the pave block that belongs to the edge with index <theIx>

    Parameters: | theIndex (int) –
    Return type: | Handle_BOPDS_PaveBlock

  `PaveBlocks`()
    - Selector Returns the list of pave blocks of the common block

    Return type: | BOPDS_ListOfPaveBlock

  `SetEdge`()
    - Modifier Assign the index <theEdge> as the edge index to all pave blocks of the common block

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

  `thisown`

    The membership flag

class `BOPDS_CoupleOfPaveBlocks`(*args)

  Bases: `object`

  - /** * Constructor */

  Return type: | None

  - /** * Constructor * @param thePB1 * first pave block * @param thePB2 * secondt pave block */

  Parameters: | thePB1 (Handle_BOPDS_PaveBlock &) – thePB2 (Handle_BOPDS_PaveBlock &) –
  Return type: | None

  `Index`()
    - /** * Returns the index * returns * index */

    Return type: | int

  `IndexInterf`()
    - /** * Returns the index of an interference * returns * index of an interference */

    Return type: | int

  `PaveBlock1`()
    - /** * Returns the first pave block * returns * the first pave block */

    Return type: | Handle_BOPDS_PaveBlock

  `PaveBlock2`()
    - /** * Returns the second pave block * returns * the second pave block */

    Return type: | Handle_BOPDS_PaveBlock

  `PaveBlocks`()
    - /** * Returns pave blocks * @param thePB1 * the first pave block * @param thePB2 * the second pave block */

    Parameters: | thePB1 (Handle_BOPDS_PaveBlock &) – thePB2 (Handle_BOPDS_PaveBlock &) –
    Return type: | None

  `SetIndex`()
    - /** * Sets an index * @param theIndex * index */

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

  `SetIndexInterf`()
    - /** * Sets an index of an interference * @param theIndex * index of an interference */

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

  `SetPaveBlock1`()
    - /** * Sets the first pave block * @param thePB * the first pave block */

    Parameters: | thePB (Handle_BOPDS_PaveBlock &) –
    Return type: | None

  `SetPaveBlock2`()
    - /** * Sets the second pave block * @param thePB * the second pave block */

    Parameters: | thePB (Handle_BOPDS_PaveBlock &) –
    Return type: | None

  `SetPaveBlocks`()
    - /** * Sets pave blocks * @param thePB1 * first pave block * @param thePB2 * secondt pave block */

    Parameters: | thePB1 (Handle_BOPDS_PaveBlock &) – thePB2 (Handle_BOPDS_PaveBlock &) –
    Return type: | None

  `thisown`

    The membership flag

class `BOPDS_Curve`(*args)

  Bases: `object`

  - Empty contructor

  Return type: | None

  - Contructor <theAllocator> - the allocator to manage the memory

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

  `Box`()
    - Selector Returns the bounding box of the curve

    Return type: | Bnd_Box

  `ChangeBox`()
    - Selector/Modifier Returns the bounding box of the curve

    Return type: | Bnd_Box

  `ChangePaveBlock1`()
    - Selector/Modifier Returns initial pave block of the curve

    Return type: | Handle_BOPDS_PaveBlock

  `ChangePaveBlocks`()
    - Selector/Modifier Returns the list of pave blocks of the curve

    Return type: | BOPDS_ListOfPaveBlock

  `ChangeTechnoVertices`()
    - Selector/Modifier Returns list of indices of technologic vertices of the curve

    Return type: | BOPCol_ListOfInteger

  `Curve`()
    - Selector Returns the curve

    Return type: | IntTools_Curve

  `HasEdge`()
    - Query Returns true if at least one pave block of the curve has edge

    Return type: | bool

  `InitPaveBlock1`()
    - Creates initial pave block of the curve

    Return type: | None

  `PaveBlocks`()
    - Selector Returns the list of pave blocks of the curve

    Return type: | BOPDS_ListOfPaveBlock

  `SetBox`()
    - Modifier Sets the bounding box <theBox> of the curve

    Parameters: | theBox (Bnd_Box &) –
    Return type: | None

  `SetCurve`()
    - Modifier Sets the curve <theC>

    Parameters: | theC (IntTools_Curve &) –
    Return type: | None

  `SetPaveBlocks`()

    Parameters: | theLPB (BOPDS_ListOfPaveBlock &) –
    Return type: | None

  `TechnoVertices`()
    - Selector Returns list of indices of technologic vertices of the curve

    Return type: | BOPCol_ListOfInteger

  `thisown`

    The membership flag

class `BOPDS_DS`(*args)

  Bases: `object`

  - Empty contructor

  Return type: | None

  - Contructor theAllocator - the allocator to manage the memory

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

  `AddInterf`()
    - Modifier Adds the information about an interference between shapes with indices theI1, theI2 to the summary table of interferences

    Parameters: | theI1 (int) – theI2 (int) –
    Return type: | None

  `AddShapeSD`()
    - Modifier Adds the information about same domain shapes with indices theIndex, theIndexSD

    Parameters: | theIndex (int) – theIndexSD (int) –
    Return type: | None

  `Allocator`()
    - Selector

    Return type: | BOPCol_BaseAllocator

  `AloneVertices`()
    - Selector Returns the indices of alone vertices for the face with index theIndex

    Parameters: | theF (int) – theLI (BOPCol_ListOfInteger &) –
    Return type: | None

  `Append`()
    - Modifier Appends the information about the shape [theSI] to the data structure Returns the index of theSI in the data structure

    Parameters: | theSI (BOPDS_ShapeInfo &) –
    Return type: | int

    - Modifier Appends the default information about the shape [theS] to the data structure Returns the index of theS in the data structure

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

  `Arguments`()
    - Selector Returns the arguments of an operation

    Return type: | BOPCol_ListOfShape

  `ChangeFaceInfo`()
    - Selector/Modifier Returns the state of face with index theIndex

    Parameters: | theIndex (int) –
    Return type: | BOPDS_FaceInfo

  `ChangePaveBlocks`()
    - Selector/Modifier Returns the pave blocks for the shape with index theIndex

    Parameters: | theIndex (int) –
    Return type: | BOPDS_ListOfPaveBlock

  `ChangePaveBlocksPool`()
    - Selector/Modifier Returns the information about pave blocks on source edges

    Return type: | BOPDS_VectorOfListOfPaveBlock

  `ChangeShapeInfo`()
    - Selector/Modifier Returns the information about the shape with index theIndex

    Parameters: | theIndex (int) –
    Return type: | BOPDS_ShapeInfo

  `Clear`()
    - Clears the contents

    Return type: | None

  `CommonBlock`()
    - Selector Returns the common block

    Parameters: | thePB (Handle_BOPDS_PaveBlock &) –
    Return type: | Handle_BOPDS_CommonBlock

  `Dump`()

    Return type: | None

  `FaceInfo`()
    - Selector Returns the state of face with index theIndex

    Parameters: | theIndex (int) –
    Return type: | BOPDS_FaceInfo

  `FaceInfoIn`()
    - Selector Returns the state In [theMPB,theMVP] of face with index theIndex

    Parameters: | theIndex (int) – theMPB (BOPDS_IndexedMapOfPaveBlock &) – theMVP (BOPCol_MapOfInteger &) –
    Return type: | None

  `FaceInfoOn`()
    - Selector Returns the state On [theMPB,theMVP] of face with index theIndex

    Parameters: | theIndex (int) – theMPB (BOPDS_IndexedMapOfPaveBlock &) – theMVP (BOPCol_MapOfInteger &) –
    Return type: | None

  `FaceInfoPool`()
    - Selector Returns the information about state of faces

    Return type: | BOPDS_VectorOfFaceInfo

  `FuzzyValue`()
    - Returns the extended tolerance

    Return type: | float

  `HasFaceInfo`()
    - Query Returns true if the shape with index theIndex has the information about state of face

    Parameters: | theIndex (int) –
    Return type: | bool

  `HasInterf`()
    - Query Returns true if the shape with index theI is interferred

    Parameters: | theI (int) –
    Return type: | bool

    - Query Returns true if the shapes with indices theI1, theI2 are interferred

    Parameters: | theI1 (int) – theI2 (int) –
    Return type: | bool

  `HasInterfShapeSubShapes`()
    - Query Returns true if the shape with index theI1 is interfered with any sub-shape of the shape with index theI2 (theFlag=true) all sub-shapes of the shape with index theI2 (theFlag=false)

    Parameters: | theI1 (int) – theI2 (int) – theFlag (bool) – default value is Standard_True
    Return type: | bool

  `HasInterfSubShapes`()
    - Query Returns true if the shapes with indices theI1, theI2 have interferred sub-shapes

    Parameters: | theI1 (int) – theI2 (int) –
    Return type: | bool

  `HasPaveBlocks`()
    - Query Returns true if the shape with index theIndex has the information about pave blocks

    Parameters: | theIndex (int) –
    Return type: | bool

  `HasShapeSD`()
    - Query Returns true if the shape with index theIndex has the same domain shape. In this case theIndexSD will contain the index of same domain shape found //! interferences

    Parameters: | theIndex (int) – theIndexSD (int &) –
    Return type: | bool

  `Index`()
    - Selector Returns the index of the shape theS

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

  `Init`()
    - Initializes the data structure for the arguments

    Return type: | None

  `InterfEE`()
    - Selector/Modifier Returns the collection of interferences Edge/Edge

    Return type: | BOPDS_VectorOfInterfEE

  `InterfEF`()
    - Selector/Modifier Returns the collection of interferences Edge/Face

    Return type: | BOPDS_VectorOfInterfEF

  `InterfEZ`()
    - Selector/Modifier Returns the collection of interferences Edge/Solid

    Return type: | BOPDS_VectorOfInterfEZ

  `InterfFF`()
    - Selector/Modifier Returns the collection of interferences Face/Face

    Return type: | BOPDS_VectorOfInterfFF

  `InterfFZ`()
    - Selector/Modifier Returns the collection of interferences Face/Solid

    Return type: | BOPDS_VectorOfInterfFZ

  `InterfVE`()
    - Selector/Modifier Returns the collection of interferences Vertex/Edge

    Return type: | BOPDS_VectorOfInterfVE

  `InterfVF`()
    - Selector/Modifier Returns the collection of interferences Vertex/Face

    Return type: | BOPDS_VectorOfInterfVF

  `InterfVV`()
    - Selector/Modifier Returns the collection of interferences Vertex/Vertex

    Return type: | BOPDS_VectorOfInterfVV

  `InterfVZ`()
    - Selector/Modifier Returns the collection of interferences Vertex/Solid

    Return type: | BOPDS_VectorOfInterfVZ

  `InterfZZ`()
    - Selector/Modifier Returns the collection of interferences Solid/Solid

    Return type: | BOPDS_VectorOfInterfZZ

  `Interferences`()
    - Selector Returns the table of interferences //! debug

    Return type: | BOPDS_MapOfPassKey

  `IsCommonBlock`()
    - Query Returns true if the pave block is common block

    Parameters: | thePB (Handle_BOPDS_PaveBlock &) –
    Return type: | bool

  `IsCommonBlockOnEdge`()
    - Query Returns true if common block contains more then one pave block

    Parameters: | thePB (Handle_BOPDS_PaveBlock &) –
    Return type: | bool

  `IsNewShape`()
    - Returns true if the shape of index ‘i’ is not the source shape/sub-shape

    Parameters: | theIndex (int) –
    Return type: | bool

  `IsSubShape`()

    Parameters: | theI1 (int) – theI2 (int) –
    Return type: | bool

  `IsToSort`()

    Parameters: | theCB (Handle_BOPDS_CommonBlock &) – theI (int &) –
    Return type: | bool

  static `NbInterfTypes`(*args)
    - Returns the number of types of the interferences

    Return type: | int

  `NbRanges`()
    - Selector Returns the number of index ranges

    Return type: | int

  `NbShapes`()
    - Selector Returns the total number of shapes stored

    Return type: | int

  `NbSourceShapes`()
    - Selector Returns the total number of source shapes stored

    Return type: | int

  `PaveBlocks`()
    - Selector Returns the pave blocks for the shape with index theIndex

    Parameters: | theIndex (int) –
    Return type: | BOPDS_ListOfPaveBlock

  `PaveBlocksPool`()
    - Selector Returns the information about pave blocks on source edges

    Return type: | BOPDS_VectorOfListOfPaveBlock

  `Paves`()
    - Fills theLP with sorted paves of the shape with index theIndex

    Parameters: | theIndex (int) – theLP (BOPDS_ListOfPave &) –
    Return type: | None

  `Range`()
    - Selector Returns the index range ‘i’

    Parameters: | theIndex (int) –
    Return type: | BOPDS_IndexRange

  `Rank`()
    - Selector Returns the rank of the shape of index ‘i’

    Parameters: | theIndex (int) –
    Return type: | int

  `RealPaveBlock`()
    - Selector Returns the real first pave block

    Parameters: | thePB (Handle_BOPDS_PaveBlock &) –
    Return type: | Handle_BOPDS_PaveBlock

  `RefineFaceInfoOn`()
    - Refine the state On for the all faces having state information //! ++

    Return type: | None

  `SetArguments`()
    - Modifier Sets the arguments [theLS] of an operation

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

  `SetCommonBlock`()
    - Modifier Sets the common block <theCB>

    Parameters: | thePB (Handle_BOPDS_PaveBlock &) – theCB (Handle_BOPDS_CommonBlock &) –
    Return type: | None

  `SetDefaultTolerances`()
    - Reverts the tolerance values of unchanged entities to default values.

    Return type: | None

  `SetFuzzyValue`()
    - Sets the extended tolerance

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

  `Shape`()
    - Selector Returns the shape with index theIndex

    Parameters: | theIndex (int) –
    Return type: | TopoDS_Shape

  `ShapeInfo`()
    - Selector Returns the information about the shape with index theIndex

    Parameters: | theIndex (int) –
    Return type: | BOPDS_ShapeInfo

  `ShapesSD`()
    - Selector Returns the collection same domain shapes

    Return type: | BOPCol_DataMapOfIntegerInteger

  `SharedEdges`()
    - Returns the indices of edges that are shared for the faces with indices theF1, theF2 //! same domain shapes

    Parameters: | theF1 (int) – theF2 (int) – theLI (BOPCol_ListOfInteger &) – theAllocator (BOPCol_BaseAllocator &) –
    Return type: | None

  `SortPaveBlocks`()

    Parameters: | theCB (Handle_BOPDS_CommonBlock &) –
    Return type: | None

  `UpdateCommonBlock`()
    - Update the common block theCB

    Parameters: | theCB (Handle_BOPDS_CommonBlock &) –
    Return type: | None

  `UpdateEdgeTolerance`()
    - Updates tolerance of the sub-shapes of the shape with index <theIndex>.

    Parameters: | theIndex (int) – theTolerance (float) –
    Return type: | None

  `UpdateFaceInfoIn`()
    - Update the state In of face with index theIndex

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

  `UpdateFaceInfoOn`()
    - Update the state On of face with index theIndex

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

  `UpdatePaveBlock`()
    - Update the pave block thePB

    Parameters: | thePB (Handle_BOPDS_PaveBlock &) –
    Return type: | None

  `UpdatePaveBlocks`()
    - Update the pave blocks for the all shapes in data structure

    Return type: | None

  `VerticesOnIn`()
    - Returns the indices of vertices and pave blocks that are On/In for the faces with indices theF1, theF2

    Parameters: | theF1 (int) – theF2 (int) – theMI (BOPCol_MapOfInteger &) – aMPB (BOPDS_IndexedMapOfPaveBlock &) –
    Return type: | None

  `thisown`

    The membership flag

`BOPDS_DS_NbInterfTypes`(*args)
  - Returns the number of types of the interferences

  Return type: | int

class `BOPDS_FaceInfo`(*args)

  Bases: `object`

  - Empty contructor

  Return type: | None

  - Contructor theAllocator - the allocator to manage the memory

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

  `ChangePaveBlocksIn`()
    - Selector/Modifier Returns the pave blocks of the face that have state In

    Return type: | BOPDS_IndexedMapOfPaveBlock

  `ChangePaveBlocksOn`()
    - Selector/Modifier Returns the pave blocks of the face that have state On

    Return type: | BOPDS_IndexedMapOfPaveBlock

  `ChangePaveBlocksSc`()

    Return type: | BOPDS_IndexedMapOfPaveBlock

  `ChangeVerticesIn`()
    - Selector/Modifier Returns the list of indices for vertices of the face that have state In //! On

    Return type: | BOPCol_MapOfInteger

  `ChangeVerticesOn`()
    - Selector/Modifier Returns the list of indices for vertices of the face that have state On //! Sections

    Return type: | BOPCol_MapOfInteger

  `ChangeVerticesSc`()
    - Selector/Modifier Returns the list of indices for section vertices of the face //! Others

    Return type: | BOPCol_MapOfInteger

  `Clear`()
    - Clears the contents

    Return type: | None

  `Index`()
    - Selector Returns the index of the face //! In

    Return type: | int

  `PaveBlocksIn`()
    - Selector Returns the pave blocks of the face that have state In

    Return type: | BOPDS_IndexedMapOfPaveBlock

  `PaveBlocksOn`()
    - Selector Returns the pave blocks of the face that have state On

    Return type: | BOPDS_IndexedMapOfPaveBlock

  `PaveBlocksSc`()
    - Selector Returns the pave blocks of the face that are pave blocks of section edges

    Return type: | BOPDS_IndexedMapOfPaveBlock

  `SetIndex`()
    - Modifier Sets the index of the face <theI>

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

  `VerticesIn`()
    - Selector Returns the list of indices for vertices of the face that have state In

    Return type: | BOPCol_MapOfInteger

  `VerticesOn`()
    - Selector Returns the list of indices for vertices of the face that have state On

    Return type: | BOPCol_MapOfInteger

  `VerticesSc`()
    - Selector Returns the list of indices for section vertices of the face

    Return type: | BOPCol_MapOfInteger

  `thisown`

    The membership flag

class `BOPDS_IndexRange`(*args)

  Bases: `object`

  - Empty contructor

  Return type: | None

  `Contains`()
    - Query Returns true if the range contains <theIndex>

    Parameters: | theIndex (int) –
    Return type: | bool

  `Dump`()

    Return type: | None

  `First`()
    - Selector Returns the first index of the range

    Return type: | int

  `Indices`()
    - Selector Returns the first index of the range <theI1> Returns the second index of the range <theI2>

    Parameters: | theI1 (int &) – theI2 (int &) –
    Return type: | None

  `Last`()
    - Selector Returns the second index of the range

    Return type: | int

  `SetFirst`()
    - Modifier Sets the first index <theI1> of the range

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

  `SetIndices`()
    - Modifier Sets the first index of the range <theI1> Sets the second index of the range <theI2>

    Parameters: | theI1 (int) – theI2 (int) –
    Return type: | None

  `SetLast`()
    - Modifier Sets the second index <theI2> of the range

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

  `thisown`

    The membership flag

class `BOPDS_InterfEE`(*args)

  Bases: `object`

  - /** * Constructor */

  Return type: | None

  - /** * Constructor * @param theAllocator * allocator to manage the memory */

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

  `CommonPart`()
    - /** * Selector * Returns the info of common part * returns * common part */

    Return type: | IntTools_CommonPrt

  `SetCommonPart`()
    - /** * Modifier * Sets the info of common part * @param theCP * common part */

    Parameters: | theCP (IntTools_CommonPrt &) –
    Return type: | None

  `thisown`

    The membership flag

class `BOPDS_InterfEF`(*args)

  Bases: `object`

  - /** * Constructor */

  Return type: | None

  - /** * Constructor * @param theAllocator * allocator to manage the memory //* * Constructor * @param theAllocator * allocator to manage the memory */

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

  `CommonPart`()
    - /** * Selector * Returns the info of common part * returns * common part */

    Return type: | IntTools_CommonPrt

  `SetCommonPart`()
    - /** * Modifier * Sets the info of common part * @param theCP * common part */

    Parameters: | theCP (IntTools_CommonPrt &) –
    Return type: | None

  `thisown`

    The membership flag

class `BOPDS_InterfEZ`(*args)

  Bases: `object`

  - /** * Constructor */

  Return type: | None

  - /** * Constructor * @param theAllocator * allocator to manage the memory */

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

  `thisown`

    The membership flag

class `BOPDS_InterfFF`(*args)

  Bases: `object`

  - /** * Constructor */

  Return type: | None

  `ChangeCurves`()
    - /** * Selector/Modifier * Returns the intersection curves * returns * intersection curves */

    Return type: | BOPDS_VectorOfCurve

  `ChangePoints`()
    - /** * Selector/Modifier * Returns the intersection points * returns * intersection points */

    Return type: | BOPDS_VectorOfPoint

  `Curves`()
    - /** * Selector * Returns the intersection curves * returns * intersection curves */

    Return type: | BOPDS_VectorOfCurve

  `Init`()
    - /** * Initializer * @param theNbCurves * number of intersection curves * @param theNbPoints * number of intersection points */

    Parameters: | theNbCurves (int) – theNbPoints (int) –
    Return type: | None

  `Points`()
    - /** * Selector * Returns the intersection points * returns * intersection points */

    Return type: | BOPDS_VectorOfPoint

  `SetTangentFaces`()
    - /** * Modifier * Sets the flag of whether the faces are tangent * @param theFlag * the flag */

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

  `SetTolR2D`()
    - /** * Modifier * Sets the value of 2D tolerance * @param theTol * 2D tolerance */

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

  `SetTolR3D`()
    - /** * Modifier * Sets the value of 3D tolerance * @param theTol * 3D tolerance */

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

  `TangentFaces`()
    - /** * Selector * Returns the flag whether the faces are tangent * returns * the flag */

    Return type: | bool

  `TolR2D`()
    - /** * Selector * Returns the value of 2D tolerance * returns * 2D tolerance */

    Return type: | float

  `TolR3D`()
    - /** * Selector * Returns the value of 3D tolerance * returns * 3D tolerance */

    Return type: | float

  `thisown`

    The membership flag

class `BOPDS_InterfFZ`(*args)

  Bases: `object`

  - /** * Constructor */

  Return type: | None

  - /** * Constructor * @param theAllocator * allocator to manage the memory */

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

  `thisown`

    The membership flag

class `BOPDS_InterfVE`(*args)

  Bases: `object`

  - /** * Constructor */

  Return type: | None

  - /** * Constructor * @param theAllocator * allocator to manage the memory */

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

  `Parameter`()
    - /** * Selector * Returrns the value of parameter * of the point of the vertex * on the curve of the edge * returns * value of parameter */

    Return type: | float

  `SetParameter`()
    - /** * Modifier * Sets the value of parameter * of the point of the vertex * on the curve of the edge * @param theT * value of parameter */

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

  `thisown`

    The membership flag

class `BOPDS_InterfVF`(*args)

  Bases: `object`

  - /** * Constructor */

  Return type: | None

  - /** * Constructor * @param theAllocator * allocator to manage the memory */

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

  `SetUV`()
    - /** * Modifier * Sets the value of parameters * of the point of the vertex * on the surface of of the face * @param theU * value of U parameter * @param theV * value of U parameter */

    Parameters: | theU (float) – theV (float) –
    Return type: | None

  `UV`()
    - /** * Selector * Returns the value of parameters * of the point of the vertex * on the surface of of the face * @param theU * value of U parameter * @param theV * value of U parameter */

    Parameters: | theU (float &) – theV (float &) –
    Return type: | None

  `thisown`

    The membership flag

class `BOPDS_InterfVV`(*args)

  Bases: `object`

  - /** * Constructor */

  Return type: | None

  - /** * Constructor * @param theAllocator * allocator to manage the memory */

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

  `thisown`

    The membership flag

class `BOPDS_InterfVZ`(*args)

  Bases: `object`

  - /** * Constructor */

  Return type: | None

  - /** * Constructor * @param theAllocator * allocator to manage the memory */

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

  `thisown`

    The membership flag

class `BOPDS_InterfZZ`(*args)

  Bases: `object`

  - /** * Constructor */

  Return type: | None

  - /** * Constructor * @param theAllocator * allocator to manage the memory */

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

  `thisown`

    The membership flag

class `BOPDS_Iterator`(*args)

  Bases: `object`

  - Empty contructor

  Return type: | None

  - Contructor theAllocator - the allocator to manage the memory

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

  `BlockLength`()
    - Returns the block length

    Return type: | int

  `DS`()
    - Selector Returns the data structure

    Return type: | BOPDS_DS

  `ExpectedLength`()
    - Returns the number of intersections founded

    Return type: | int

  `Initialize`()
    - Initializes the iterator theType1 - the first type of shape theType2 - the second type of shape

    Parameters: | theType1 (TopAbs_ShapeEnum) – theType2 (TopAbs_ShapeEnum) –
    Return type: | None

  `More`()
    - Returns true if still there are pairs of intersected shapes

    Return type: | bool

  `Next`()
    - Moves iterations ahead

    Return type: | None

  `Prepare`()
    - Perform the intersection algorithm and prepare the results to be used

    Return type: | void

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

    Return type: | bool

  `SetDS`()
    - Modifier Sets the data structure <pDS> to process

    Parameters: | pDS (BOPDS_PDS &) –
    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

  `Value`()
    - Returns indices (DS) of intersected shapes theIndex1 - the index of the first shape theIndex2 - the index of the second shape theWithSubShape - flag. True if the sub-shapes of shapes are intersected

    Parameters: | theIndex1 (int &) – theIndex2 (int &) – theWithSubShape (bool) –
    Return type: | None

  `thisown`

    The membership flag

class `BOPDS_IteratorSI`(*args)

  Bases: `OCC.BOPDS.BOPDS_Iterator`

  - Empty contructor

  Return type: | None

  - Contructor theAllocator - the allocator to manage the memory

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

  `UpdateByLevelOfCheck`()
    - Updates the lists of possible intersections according to the value of <theLevel>. 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; other - all interferences.

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

  `thisown`

    The membership flag

class `BOPDS_PassKey`(*args)

  Bases: `object`

  - Empty contructor

  Return type: | None

  - Contructor theAllocator - the allocator to manage the memory

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

  - Copy Contructor

  Parameters: | Other (BOPDS_PassKey &) –
  Return type: | None

  `Clear`()
    - Clear the contents

    Return type: | None

  `Dump`()

    Parameters: | aHex (int) – default value is 0
    Return type: | None

  `HashCode`()
    - Query Returns hash code

    Parameters: | theUpper (int) –
    Return type: | int

  `Id`()
    - Selector Returns Id of index <theIndex>

    Parameters: | theIndex (int) –
    Return type: | int

  `Ids`()
    - Selector Returns the first two Ids <theI1>,<theI2>

    Parameters: | theI1 (int &) – theI2 (int &) –
    Return type: | None

  `IsEqual`()
    - Query Returns true if the PassKey is equal to <the theOther>

    Parameters: | theOther (BOPDS_PassKey &) –
    Return type: | bool

  `NbIds`()
    - Selector Returns the number of Ids>

    Return type: | int

  `Set`()

    Parameters: | Other (BOPDS_PassKey &) –
    Return type: | BOPDS_PassKey

  `SetIds`()
    - Modifier Sets one Id <theI1>

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

    - Modifier Sets two Id <theI1>,<theI2>

    Parameters: | theI1 (int) – theI2 (int) –
    Return type: | None

    - Modifier Sets three Id <theI1>,<theI2>,<theI3>

    Parameters: | theI1 (int) – theI2 (int) – theI3 (int) –
    Return type: | None

    - Modifier Sets four Id <theI1>,<theI2>,<theI3>,<theI4>

    Parameters: | theI1 (int) – theI2 (int) – theI3 (int) – theI4 (int) –
    Return type: | None

    - Modifier Sets the list of Id <theLI>

    Parameters: | theLI (BOPCol_ListOfInteger &) –
    Return type: | None

  `thisown`

    The membership flag

class `BOPDS_PassKeyBoolean`(*args)

  Bases: `OCC.BOPDS.BOPDS_PassKey`

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

  `Flag`()

    Return type: | bool

  `Set`()

    Parameters: | & (BOPDS_PassKeyBoolean) –
    Return type: | BOPDS_PassKeyBoolean

  `SetFlag`()

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

  `thisown`

    The membership flag

class `BOPDS_PassKeyMapHasher`

  Bases: `object`

  static `HashCode`(*args)

    Parameters: | aPKey (BOPDS_PassKey &) – Upper (int) –
    Return type: | int

  static `IsEqual`(*args)

    Parameters: | aPKey1 (BOPDS_PassKey &) – aPKey2 (BOPDS_PassKey &) –
    Return type: | bool

  `thisown`

    The membership flag

`BOPDS_PassKeyMapHasher_HashCode`(*args)

  Parameters: | aPKey (BOPDS_PassKey &) – Upper (int) –
  Return type: | int

`BOPDS_PassKeyMapHasher_IsEqual`(*args)

  Parameters: | aPKey1 (BOPDS_PassKey &) – aPKey2 (BOPDS_PassKey &) –
  Return type: | bool

class `BOPDS_Pave`(*args)

  Bases: `object`

  - Empty contructor

  Return type: | None

  `Contents`()
    - Selector Returns the index of vertex <theIndex> Returns the parameter of vertex <theParameter>

    Parameters: | theIndex (int &) – theParameter (float &) –
    Return type: | None

  `Dump`()

    Return type: | None

  `Index`()
    - Selector Returns the index of vertex

    Return type: | int

  `IsEqual`()
    - Query Returns true if thr parameter od this is equal to the parameter of <theOther>

    Parameters: | theOther (BOPDS_Pave &) –
    Return type: | bool

  `IsLess`()
    - Query Returns true if thr parameter od this is less than the parameter of <theOther>

    Parameters: | theOther (BOPDS_Pave &) –
    Return type: | bool

  `Parameter`()
    - Selector Returns the parameter of vertex

    Return type: | float

  `SetIndex`()
    - Modifier Sets the index of vertex <theIndex>

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

  `SetParameter`()
    - Modifier Sets the parameter of vertex <theParameter>

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

  `thisown`

    The membership flag

class `BOPDS_PaveBlock`(*args)

  Bases: `OCC.MMgt.MMgt_TShared`

  - Empty contructor

  Return type: | None

  - Contructor <theAllocator> - the allocator to manage the memory

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

  `AppendExtPave`()
    - Modifier Appends extra paves <theLP>

    Parameters: | theLP (BOPDS_Pave &) –
    Return type: | None

  `AppendExtPave1`()
    - Modifier Appends extra pave <thePave>

    Parameters: | thePave (BOPDS_Pave &) –
    Return type: | None

  `ChangeExtPaves`()
    - Selector / Modifier Returns the extra paves

    Return type: | BOPDS_ListOfPave

  `ContainsParameter`()
    - Query Returns true if the extra paves contain the pave with given value of the parameter <thePrm> <theTol> - the value of the tolerance to compare <theInd> - index of the found pave

    Parameters: | thePrm (float) – theTol (float) – theInd (int &) –
    Return type: | bool

  `Dump`()

    Return type: | None

  `Edge`()
    - Selector Returns the index of edge of pave block

    Return type: | int

  `ExtPaves`()
    - Selector Returns the extra paves

    Return type: | BOPDS_ListOfPave

  `GetHandle`()
  `HasEdge`()
    - Query Returns true if the pave block has edge

    Return type: | bool

    - Query Returns true if the pave block has edge Returns the index of edge <theEdge>

    Parameters: | theEdge (int &) –
    Return type: | bool

  `HasSameBounds`()
    - Query Returns true if the pave block has pave indices that equal to the pave indices of the pave block <theOther>

    Parameters: | theOther (Handle_BOPDS_PaveBlock &) –
    Return type: | bool

  `HasShrunkData`()
    - Query Returns true if the pave block contains the shrunk data

    Return type: | bool

  `Indices`()
    - Selector Returns the pave indices <theIndex1,theIndex2> of the pave block

    Parameters: | theIndex1 (int &) – theIndex2 (int &) –
    Return type: | None

  `IsSplitEdge`()
    - Query Returns true if the edge is equal to the original edge of the pave block

    Return type: | bool

  `IsToUpdate`()
    - Query Returns true if the pave block contains extra paves

    Return type: | bool

  `OriginalEdge`()
    - Selector Returns the index of original edge of pave block

    Return type: | int

  `Pave1`()
    - Selector Returns the first pave

    Return type: | BOPDS_Pave

  `Pave2`()
    - Selector Returns the second pave

    Return type: | BOPDS_Pave

  `Range`()
    - Selector Returns the parametric range <theT1,theT2> of the pave block

    Parameters: | theT1 (float &) – theT2 (float &) –
    Return type: | None

  `SetEdge`()
    - Modifier Sets the index of edge of pave block <theEdge>

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

  `SetOriginalEdge`()
    - Modifier Sets the index of original edge of the pave block <theEdge>

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

  `SetPave1`()
    - Modifier Sets the first pave <thePave>

    Parameters: | thePave (BOPDS_Pave &) –
    Return type: | None

  `SetPave2`()
    - Modifier Sets the second pave <thePave>

    Parameters: | thePave (BOPDS_Pave &) –
    Return type: | None

  `SetShrunkData`()
    - Modifier Sets the shrunk data for the pave block <theTS1>, <theTS2> - shrunk range <theBox> - the bounding box

    Parameters: | theTS1 (float) – theTS2 (float) – theBox (Bnd_Box &) –
    Return type: | None

  `ShrunkData`()
    - Selector Returns the shrunk data for the pave block <theTS1>, <theTS2> - shrunk range <theBox> - the bounding box

    Parameters: | theTS1 (float &) – theTS2 (float &) – theBox (Bnd_Box &) –
    Return type: | None

  `Update`()
    - Modifier Updates the pave block. The extra paves are used to create new pave blocks <theLPB>. <theFlag> - if true, the first pave and the second pave are used to produce new pave blocks.

    Parameters: | theLPB (BOPDS_ListOfPaveBlock &) – theFlag (bool) – default value is Standard_True
    Return type: | None

  `thisown`

    The membership flag

class `BOPDS_PaveMapHasher`

  Bases: `object`

  static `HashCode`(*args)

    Parameters: | aPave (BOPDS_Pave &) – Upper (int) –
    Return type: | int

  static `IsEqual`(*args)

    Parameters: | aPave1 (BOPDS_Pave &) – aPave2 (BOPDS_Pave &) –
    Return type: | bool

  `thisown`

    The membership flag

`BOPDS_PaveMapHasher_HashCode`(*args)

  Parameters: | aPave (BOPDS_Pave &) – Upper (int) –
  Return type: | int

`BOPDS_PaveMapHasher_IsEqual`(*args)

  Parameters: | aPave1 (BOPDS_Pave &) – aPave2 (BOPDS_Pave &) –
  Return type: | bool

class `BOPDS_Point`(*args)

  Bases: `object`

  - Empty contructor

  Return type: | None

  `Index`()
    - Selector Returns index of the vertex

    Return type: | int

  `Pnt`()
    - Selector Returns 3D point

    Return type: | gp_Pnt

  `Pnt2D1`()
    - Selector Returns 2D point on the first face <thePnt>

    Return type: | gp_Pnt2d

  `Pnt2D2`()
    - Selector Returns 2D point on the second face <thePnt>

    Return type: | gp_Pnt2d

  `SetIndex`()
    - Modifier Sets the index of the vertex <theIndex>

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

  `SetPnt`()
    - Modifier Sets 3D point <thePnt>

    Parameters: | thePnt (gp_Pnt) –
    Return type: | None

  `SetPnt2D1`()
    - Modifier Sets 2D point on the first face <thePnt>

    Parameters: | thePnt (gp_Pnt2d) –
    Return type: | None

  `SetPnt2D2`()
    - Modifier Sets 2D point on the second face <thePnt>

    Parameters: | thePnt (gp_Pnt2d) –
    Return type: | None

  `thisown`

    The membership flag

class `BOPDS_ShapeInfo`(*args)

  Bases: `object`

  - Empty contructor

  Return type: | None

  - Contructor theAllocator - the allocator to manage the memory

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

  `Box`()
    - Selector Returns the boundung box of the shape

    Return type: | Bnd_Box

  `ChangeBox`()
    - Selector/Modifier Returns the boundung box of the shape

    Return type: | Bnd_Box

  `ChangeSubShapes`()
    - Selector/ Modifier Returns the list of indices of sub-shapes

    Return type: | BOPCol_ListOfInteger

  `Dump`()

    Return type: | None

  `Flag`()
    - Returns the flag

    Return type: | int

  `HasBRep`()
    - Query Returns true if the shape has boundary representation

    Return type: | bool

  `HasFlag`()
    - Query Returns true if there is flag.

    Return type: | bool

    - Query Returns true if there is flag. Returns the the flag theFlag

    Parameters: | theFlag (int &) –
    Return type: | bool

  `HasReference`()

    Return type: | bool

  `HasSubShape`()
    - Query Returns true if the shape has sub-shape with index theI

    Parameters: | theI (int) –
    Return type: | bool

  `IsInterfering`()
    - Returns true if the shape can be participant of an interference //! Flag

    Return type: | bool

  `Reference`()
    - Selector Returns the index of a reference information

    Return type: | int

  `SetBox`()
    - Modifier Sets the boundung box of the shape theBox

    Parameters: | theBox (Bnd_Box &) –
    Return type: | None

  `SetFlag`()
    - Modifier Sets the flag

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

  `SetReference`()
    - Modifier Sets the index of a reference information

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

  `SetShape`()
    - Modifier Sets the shape <theS>

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

  `SetShapeType`()
    - Modifier Sets the type of shape theType

    Parameters: | theType (TopAbs_ShapeEnum) –
    Return type: | None

  `Shape`()
    - Selector Returns the shape

    Return type: | TopoDS_Shape

  `ShapeType`()
    - Selector Returns the type of shape

    Return type: | TopAbs_ShapeEnum

  `SubShapes`()
    - Selector Returns the list of indices of sub-shapes

    Return type: | BOPCol_ListOfInteger

  `thisown`

    The membership flag

class `BOPDS_SubIterator`(*args)

  Bases: `object`

  - Empty contructor

  Return type: | None

  - Contructor theAllocator - the allocator to manage the memory

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

  `DS`()
    - Selector Returns the data structure

    Return type: | BOPDS_DS

  `Initialize`()
    - Initializes the iterator

    Return type: | None

  `More`()
    - Returns true if still there are pairs of intersected shapes

    Return type: | bool

  `Next`()
    - Moves iterations ahead

    Return type: | None

  `Prepare`()
    - Perform the intersection algorithm and prepare the results to be used

    Return type: | void

  `SetDS`()
    - Modifier Sets the data structure <pDS> to process

    Parameters: | pDS (BOPDS_PDS &) –
    Return type: | None

  `SetSubSet1`()
    - Modifier Sets the first set of indices <theLI> to process

    Parameters: | theLI (BOPCol_ListOfInteger &) –
    Return type: | None

  `SetSubSet2`()
    - Modifier Sets the second set of indices <theLI> to process

    Parameters: | theLI (BOPCol_ListOfInteger &) –
    Return type: | None

  `SubSet1`()
    - Selector Returns the first set of indices to process

    Return type: | BOPCol_ListOfInteger

  `SubSet2`()
    - Selector Returns the second set of indices to process

    Return type: | BOPCol_ListOfInteger

  `Value`()
    - Returns indices (DS) of intersected shapes theIndex1 - the index of the first shape theIndex2 - the index of the second shape

    Parameters: | theIndex1 (int &) – theIndex2 (int &) –
    Return type: | None

  `thisown`

    The membership flag

class `BOPDS_Tools`

  Bases: `object`

  static `HasBRep`(*args)
    - Returns true if the type <theT> correspond to a shape having boundary representation

    Parameters: | theT (TopAbs_ShapeEnum) –
    Return type: | bool

  static `IsInterfering`(*args)
    - Returns true if the type <theT> can be participant of an interference

    Parameters: | theT (TopAbs_ShapeEnum) –
    Return type: | bool

  static `TypeToInteger`(*args)
    - Converts the conmbination of two types of shape <theT1>,<theT2> to the one integer value, that is returned

    Parameters: | theT1 (TopAbs_ShapeEnum) – theT2 (TopAbs_ShapeEnum) –
    Return type: | int

    - Converts the type of shape <theT>, to integer value, that is returned

    Parameters: | theT (TopAbs_ShapeEnum) –
    Return type: | int

  `thisown`

    The membership flag

`BOPDS_Tools_HasBRep`(*args)
  - Returns true if the type <theT> correspond to a shape having boundary representation

  Parameters: | theT (TopAbs_ShapeEnum) –
  Return type: | bool

`BOPDS_Tools_IsInterfering`(*args)
  - Returns true if the type <theT> can be participant of an interference

  Parameters: | theT (TopAbs_ShapeEnum) –
  Return type: | bool

`BOPDS_Tools_TypeToInteger`(*args)
  - Converts the conmbination of two types of shape <theT1>,<theT2> to the one integer value, that is returned

  Parameters: | theT1 (TopAbs_ShapeEnum) – theT2 (TopAbs_ShapeEnum) –
  Return type: | int

  - Converts the type of shape <theT>, to integer value, that is returned

  Parameters: | theT (TopAbs_ShapeEnum) –
  Return type: | int

class `Handle_BOPDS_CommonBlock`(*args)

  Bases: `OCC.MMgt.Handle_MMgt_TShared`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

class `Handle_BOPDS_PaveBlock`(*args)

  Bases: `OCC.MMgt.Handle_MMgt_TShared`

  static `DownCast`()
  `GetObject`()
  `IsNull`()
  `Nullify`()
  `thisown`

    The membership flag

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