# OCC.BRepClass3d module

class `BRepClass3d_DataMapIteratorOfMapOfInter`(*args)

  Bases: `OCC.TCollection.TCollection_BasicMapIterator`

  Return type: | None
  Parameters: | aMap (BRepClass3d_MapOfInter &) –
  Return type: | None

  `Initialize`()

    Parameters: | aMap (BRepClass3d_MapOfInter &) –
    Return type: | None

  `Key`()

    Return type: | TopoDS_Shape

  `Value`()

    Return type: | Standard_Address

  `thisown`

    The membership flag

class `BRepClass3d_DataMapNodeOfMapOfInter`(*args)

  Bases: `OCC.TCollection.TCollection_MapNode`

  Parameters: | K (TopoDS_Shape &) – I (Standard_Address &) – n (TCollection_MapNodePtr &) –
  Return type: | None

  `GetHandle`()
  `Key`()

    Return type: | TopoDS_Shape

  `Value`()

    Return type: | Standard_Address

  `thisown`

    The membership flag

class `BRepClass3d_Intersector3d`(*args)

  Bases: `object`

  - Empty constructor.

  Return type: | None

  `Face`()
    - Returns the significant face used to determine the intersection.

    Return type: | TopoDS_Face

  `HasAPoint`()
    - True is returned if a point has been found.

    Return type: | bool

  `IsDone`()
    - True is returned when the intersection have been computed.

    Return type: | bool

  `Perform`()
    - Perform the intersection between the segment L(0) … L(Prm) and the Shape <Sh>. //! Only the point with the smallest parameter on the line is returned. //! The Tolerance <Tol> is used to determine if the first point of the segment is near the face. In that case, the parameter of the intersection point on the line can be a negative value (greater than -Tol).

    Parameters: | L (gp_Lin) – Prm (float) – Tol (float) – F (TopoDS_Face &) –
    Return type: | None

  `Pnt`()
    - Returns the geometric point of the intersection between the line and the surface.

    Return type: | gp_Pnt

  `State`()
    - Returns the state of the point on the face. The values can be either TopAbs_IN ( the point is in the face) or TopAbs_ON ( the point is on a boudary of the face).

    Return type: | TopAbs_State

  `Transition`()
    - Returns the transition of the line on the surface.

    Return type: | IntCurveSurface_TransitionOnCurve

  `UParameter`()
    - Returns the U parameter of the intersection point on the surface.

    Return type: | float

  `VParameter`()
    - Returns the V parameter of the intersection point on the surface.

    Return type: | float

  `WParameter`()
    - Returns the parameter of the intersection point on the line.

    Return type: | float

  `thisown`

    The membership flag

class `BRepClass3d_MapOfInter`(*args)

  Bases: `OCC.TCollection.TCollection_BasicMap`

  Parameters: | NbBuckets (int) – default value is 1
  Return type: | None

  `Assign`()

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

  `Bind`()

    Parameters: | K (TopoDS_Shape &) – I (Standard_Address &) –
    Return type: | bool

  `ChangeFind`()

    Parameters: | K (TopoDS_Shape &) –
    Return type: | Standard_Address

  `ChangeFind1`()

    Parameters: | K (TopoDS_Shape &) –
    Return type: | Standard_Address

  `Clear`()

    Return type: | None

  `Find`()

    Parameters: | K (TopoDS_Shape &) –
    Return type: | Standard_Address

  `Find1`()

    Parameters: | K (TopoDS_Shape &) –
    Return type: | Standard_Address

  `IsBound`()

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

  `ReSize`()

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

  `Set`()

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

  `UnBind`()

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

  `thisown`

    The membership flag

class `BRepClass3d_SClassifier`(*args)

  Bases: `object`

  - Empty constructor.

  Return type: | None

  - Constructor to classify the point P with the tolerance Tol on the solid S.

  Parameters: | S (BRepClass3d_SolidExplorer &) – P (gp_Pnt) – Tol (float) –
  Return type: | None

  `Face`()
    - Returns the face used to determine the classification. When the state is ON, this is the face containing the point. //! When Rejected() returns True, Face() has no signification.

    Return type: | TopoDS_Face

  `IsOnAFace`()
    - Returns True when the point is a point of a face.

    Return type: | bool

  `Perform`()
    - Classify the point P with the tolerance Tol on the solid S.

    Parameters: | S (BRepClass3d_SolidExplorer &) – P (gp_Pnt) – Tol (float) –
    Return type: | None

  `PerformInfinitePoint`()
    - Classify an infinite point with the tolerance Tol on the solid S.

    Parameters: | S (BRepClass3d_SolidExplorer &) – Tol (float) –
    Return type: | None

  `Rejected`()
    - Returns True if the classification has been computed by rejection. The State is then OUT.

    Return type: | bool

  `State`()
    - Returns the result of the classification.

    Return type: | TopAbs_State

  `thisown`

    The membership flag

class `BRepClass3d_SolidClassifier`(*args)

  Bases: `OCC.BRepClass3d.BRepClass3d_SClassifier`

  - empty constructor

  Return type: | None

  - Constructor from a Shape.

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

  - Constructor to classify the point P with the tolerance Tol on the solid S.

  Parameters: | S (TopoDS_Shape &) – P (gp_Pnt) – Tol (float) –
  Return type: | None

  `Destroy`()

    Return type: | None

  `Load`()

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

  `Perform`()
    - Classify the point P with the tolerance Tol on the solid S.

    Parameters: | P (gp_Pnt) – Tol (float) –
    Return type: | None

  `PerformInfinitePoint`()
    - Classify an infinite point with the tolerance Tol on the solid S. Useful for compute the orientation of a solid.

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

  `thisown`

    The membership flag

class `BRepClass3d_SolidExplorer`(*args)

  Bases: `object`

  Return type: | None

  - Raise if called.

  Parameters: | Oth (BRepClass3d_SolidExplorer &) – S (TopoDS_Shape &) –
  Return type: | None
  Return type: | None

  `Box`()

    Return type: | Bnd_Box

  `CurrentFace`()
    - Returns the current face.

    Return type: | TopoDS_Face

  `CurrentShell`()
    - Returns the current shell.

    Return type: | TopoDS_Shell

  `Delete`()

    Return type: | void

  `Destroy`()

    Return type: | None

  `DumpSegment`()

    Parameters: | P (gp_Pnt) – L (gp_Lin) – Par (float) – S (TopAbs_State) –
    Return type: | void

  static `FindAPointInTheFace`(*args)
    - compute a point P in the face F. Param is a Real in ]0,1[ and is used to initialise the algorithm. For different values , different points are returned.

    Parameters: | F (TopoDS_Face &) – P (gp_Pnt) – Param (float &) – F – P – u (float &) – v (float &) – Param – F – P – u – v – Param – theVecD1U (gp_Vec) – theVecD1V (gp_Vec) – F – P – u – v – F – P – F – u – v –
    Return type: | bool
    Return type: | bool
    Return type: | bool
    Return type: | bool
    Return type: | bool
    Return type: | bool

  `GetFaceSegmentIndex`()
    - Returns the index of face for which last segment is calculated.

    Return type: | int

  `InitFace`()
    - Starts an exploration of the faces of the current shell.

    Return type: | None

  `InitShape`()

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

  `InitShell`()
    - Starts an exploration of the shells.

    Return type: | None

  `Intersector`()

    Parameters: | F (TopoDS_Face &) –
    Return type: | IntCurvesFace_Intersector

  `MoreFace`()
    - Returns True if current face in current shell.

    Return type: | bool

  `MoreShell`()
    - Returns True if there is a current shell.

    Return type: | bool

  `NextFace`()
    - Sets the explorer to the next Face of the current shell.

    Return type: | None

  `NextShell`()
    - Sets the explorer to the next shell.

    Return type: | None

  `OtherSegment`()
    - Returns in <L>, <Par> a segment having at least one intersection with the shape boundary to compute intersections. //! The First Call to this method returns a line which point to a point of the first face of the shape. The Second Call provide a line to the second face and so on.

    Parameters: | P (gp_Pnt) – L (gp_Lin) – Par (float &) –
    Return type: | int

  `PointInTheFace`()

    Parameters: | F (TopoDS_Face &) – P (gp_Pnt) – u (float &) – v (float &) – Param (float &) – Index (int &) – F – P – u – v – Param – Index – surf (Handle_BRepAdaptor_HSurface &) – u1 (float) – v1 (float) – u2 (float) – v2 (float) –
    Return type: | bool
    Return type: | bool

    - <Index> gives point index to search from and returns point index of succeseful search

    Parameters: | F (TopoDS_Face &) – P (gp_Pnt) – u (float &) – v (float &) – Param (float &) – Index (int &) – surf (Handle_BRepAdaptor_HSurface &) – u1 (float) – v1 (float) – u2 (float) – v2 (float) – theVecD1U (gp_Vec) – theVecD1V (gp_Vec) –
    Return type: | bool

  `Reject`()
    - Should return True if P outside of bounding vol. of the shape

    Parameters: | P (gp_Pnt) –
    Return type: | bool

  `RejectFace`()
    - returns True if the face is rejected.

    Parameters: | L (gp_Lin) –
    Return type: | bool

  `RejectShell`()
    - Returns True if the Shell is rejected.

    Parameters: | L (gp_Lin) –
    Return type: | bool

  `Segment`()
    - Returns in <L>, <Par> a segment having at least one intersection with the shape boundary to compute intersections.

    Parameters: | P (gp_Pnt) – L (gp_Lin) – Par (float &) –
    Return type: | int

  `thisown`

    The membership flag

`BRepClass3d_SolidExplorer_FindAPointInTheFace`(*args)
  - compute a point P in the face F. Param is a Real in ]0,1[ and is used to initialise the algorithm. For different values , different points are returned.

  Parameters: | F (TopoDS_Face &) – P (gp_Pnt) – Param (float &) – F – P – u (float &) – v (float &) – Param – F – P – u – v – Param – theVecD1U (gp_Vec) – theVecD1V (gp_Vec) – F – P – u – v – F – P – F – u – v –
  Return type: | bool
  Return type: | bool
  Return type: | bool
  Return type: | bool
  Return type: | bool
  Return type: | bool

class `BRepClass3d_SolidPassiveClassifier`(*args)

  Bases: `object`

  Return type: | None

  `Compare`()

    Parameters: | F (TopoDS_Face &) – Or (TopAbs_Orientation) –
    Return type: | None

  `HasIntersection`()

    Return type: | bool

  `Intersector`()

    Return type: | BRepClass3d_Intersector3d

  `Parameter`()

    Return type: | float

  `Reset`()

    Parameters: | L (gp_Lin) – P (float) – Tol (float) –
    Return type: | None

  `State`()

    Return type: | TopAbs_State

  `thisown`

    The membership flag

class `Handle_BRepClass3d_DataMapNodeOfMapOfInter`(*args)

  Bases: `OCC.TCollection.Handle_TCollection_MapNode`

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

class `brepclass3d`

  Bases: `object`

  static `OuterShell`(*args)
    - Returns the outer most shell of <S>. Returns a Null shell if <S> has no outer shell. If <S> has only one shell, then it will return, without checking orientation.

    Parameters: | S (TopoDS_Solid &) –
    Return type: | TopoDS_Shell

  `thisown`

    The membership flag

`brepclass3d_OuterShell`(*args)
  - Returns the outer most shell of <S>. Returns a Null shell if <S> has no outer shell. If <S> has only one shell, then it will return, without checking orientation.

  Parameters: | S (TopoDS_Solid &) –
  Return type: | TopoDS_Shell

`register_handle`(handle, base_object)

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