# OCC.Geom2dHatch module

class `Geom2dHatch_Classifier`(*args)

  Bases: `object`

  Return type: | None
  Parameters: | F (Geom2dHatch_Elements &) – P (gp_Pnt2d) – Tol (float) –
  Return type: | None

  `Edge`()

    Return type: | Geom2dAdaptor_Curve

  `EdgeParameter`()

    Return type: | float

  `NoWires`()

    Return type: | bool

  `Perform`()

    Parameters: | F (Geom2dHatch_Elements &) – P (gp_Pnt2d) – Tol (float) –
    Return type: | None

  `Position`()

    Return type: | IntRes2d_Position

  `Rejected`()

    Return type: | bool

  `State`()

    Return type: | TopAbs_State

  `thisown`

    The membership flag

class `Geom2dHatch_DataMapIteratorOfHatchings`(*args)

  Bases: `OCC.TCollection.TCollection_BasicMapIterator`

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

  `Initialize`()

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

  `Key`()

    Return type: | int

  `Value`()

    Return type: | Geom2dHatch_Hatching

  `thisown`

    The membership flag

class `Geom2dHatch_DataMapIteratorOfMapOfElements`(*args)

  Bases: `OCC.TCollection.TCollection_BasicMapIterator`

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

  `Initialize`()

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

  `Key`()

    Return type: | int

  `Value`()

    Return type: | Geom2dHatch_Element

  `thisown`

    The membership flag

class `Geom2dHatch_DataMapNodeOfHatchings`(*args)

  Bases: `OCC.TCollection.TCollection_MapNode`

  Parameters: | K (int &) – I (Geom2dHatch_Hatching &) – n (TCollection_MapNodePtr &) –
  Return type: | None

  `GetHandle`()
  `GetKey`()

    Geom2dHatch_DataMapNodeOfHatchings_GetKey(Geom2dHatch_DataMapNodeOfHatchings self) -> Standard_Integer

  `SetKey`()

    Geom2dHatch_DataMapNodeOfHatchings_SetKey(Geom2dHatch_DataMapNodeOfHatchings self, Standard_Integer value)

  `Value`()

    Return type: | Geom2dHatch_Hatching

  `thisown`

    The membership flag

class `Geom2dHatch_DataMapNodeOfMapOfElements`(*args)

  Bases: `OCC.TCollection.TCollection_MapNode`

  Parameters: | K (int &) – I (Geom2dHatch_Element &) – n (TCollection_MapNodePtr &) –
  Return type: | None

  `GetHandle`()
  `GetKey`()

    Geom2dHatch_DataMapNodeOfMapOfElements_GetKey(Geom2dHatch_DataMapNodeOfMapOfElements self) -> Standard_Integer

  `SetKey`()

    Geom2dHatch_DataMapNodeOfMapOfElements_SetKey(Geom2dHatch_DataMapNodeOfMapOfElements self, Standard_Integer value)

  `Value`()

    Return type: | Geom2dHatch_Element

  `thisown`

    The membership flag

class `Geom2dHatch_Element`(*args)

  Bases: `object`

  Return type: | None

  - Magic constructor.

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

  - Creates an element.

  Parameters: | Curve (Geom2dAdaptor_Curve &) – Orientation (TopAbs_Orientation) – default value is TopAbs_FORWARD
  Return type: | None

  `ChangeCurve`()
    - Returns the curve associated to the element.

    Return type: | Geom2dAdaptor_Curve

  `Curve`()
    - Returns the curve associated to the element.

    Return type: | Geom2dAdaptor_Curve

  `Orientation`()
    - Sets the orientation of the element.

    Parameters: | Orientation (TopAbs_Orientation) –
    Return type: | None

    - Returns the orientation of the element.

    Return type: | TopAbs_Orientation

  `thisown`

    The membership flag

class `Geom2dHatch_Elements`(*args)

  Bases: `object`

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

  `Bind`()

    Parameters: | K (int) – I (Geom2dHatch_Element &) –
    Return type: | bool

  `ChangeFind`()

    Parameters: | K (int) –
    Return type: | Geom2dHatch_Element

  `Clear`()

    Return type: | None

  `CurrentEdge`()

    Parameters: | E (Geom2dAdaptor_Curve &) – Or (TopAbs_Orientation &) –
    Return type: | None

  `Find`()

    Parameters: | K (int) –
    Return type: | Geom2dHatch_Element

  `InitEdges`()

    Return type: | None

  `InitWires`()

    Return type: | None

  `IsBound`()

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

  `MoreEdges`()

    Return type: | bool

  `MoreWires`()

    Return type: | bool

  `NextEdge`()

    Return type: | None

  `NextWire`()

    Return type: | None

  `OtherSegment`()

    Parameters: | P (gp_Pnt2d) – L (gp_Lin2d) – Par (float &) –
    Return type: | bool

  `Reject`()

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

  `RejectEdge`()

    Parameters: | L (gp_Lin2d) – Par (float) –
    Return type: | bool

  `RejectWire`()

    Parameters: | L (gp_Lin2d) – Par (float) –
    Return type: | bool

  `Segment`()

    Parameters: | P (gp_Pnt2d) – L (gp_Lin2d) – Par (float &) –
    Return type: | bool

  `UnBind`()

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

  `thisown`

    The membership flag

class `Geom2dHatch_FClass2dOfClassifier`(*args)

  Bases: `object`

  Return type: | None

  `ClosestIntersection`()

    Return type: | int

  `Compare`()

    Parameters: | E (Geom2dAdaptor_Curve &) – Or (TopAbs_Orientation) –
    Return type: | None

  `Intersector`()

    Return type: | Geom2dHatch_Intersector

  `IsHeadOrEnd`()

    Return type: | bool

  `Parameter`()

    Return type: | float

  `Reset`()

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

  `State`()

    Return type: | TopAbs_State

  `thisown`

    The membership flag

class `Geom2dHatch_Hatcher`(*args)

  Bases: `object`

  - Returns an empty hatcher.

  Parameters: | Intersector (Geom2dHatch_Intersector &) – Confusion2d (float) – Confusion3d (float) – KeepPnt (bool) – default value is Standard_False KeepSeg (bool) – default value is Standard_False
  Return type: | None

  `AddElement`()
    - Adds an element to the hatcher and returns its index.

    Parameters: | Curve (Geom2dAdaptor_Curve &) – Orientation (TopAbs_Orientation) – default value is TopAbs_FORWARD
    Return type: | int

  `AddHatching`()
    - Adds a hatching to the hatcher and returns its index.

    Parameters: | Curve (Geom2dAdaptor_Curve &) –
    Return type: | int

  `ChangeIntersector`()
    - Returns the associated intersector.

    Return type: | Geom2dHatch_Intersector

  `Clear`()
    - Removes all the hatchings and all the elements.

    Return type: | None

  `ClrElements`()
    - Removes all the elements from the hatcher.

    Return type: | None

  `ClrHatchings`()
    - Removes all the hatchings from the hatcher.

    Return type: | None

  `ComputeDomains`()
    - Computes the domains of all the hatchings.

    Return type: | None

    - Computes the domains of the IndH-th hatching.

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

  `Confusion2d`()
    - Sets the confusion tolerance.

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

    - Returns the 2d confusion tolerance, i.e. the value under which two points are considered identical in the parametric space of the hatching.

    Return type: | float

  `Confusion3d`()
    - Sets the confusion tolerance.

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

    - Returns the 3d confusion tolerance, i.e. the value under which two points are considered identical in the 3d space of the hatching.

    Return type: | float

  `Domain`()
    - Returns the IDom-th domain of the IndH-th hatching.

    Parameters: | IndH (int) – IDom (int) –
    Return type: | HatchGen_Domain

  `Dump`()
    - Dump the hatcher.

    Return type: | None

  `ElementCurve`()
    - Returns the curve associated to the IndE-th element.

    Parameters: | IndE (int) –
    Return type: | Geom2dAdaptor_Curve

  `HatchingCurve`()
    - Returns the curve associated to the IndH-th hatching.

    Parameters: | IndH (int) –
    Return type: | Geom2dAdaptor_Curve

  `Intersector`()
    - Sets the associated intersector.

    Parameters: | Intersector (Geom2dHatch_Intersector &) –
    Return type: | None

    - Returns the associated intersector.

    Return type: | Geom2dHatch_Intersector

  `KeepPoints`()
    - Sets the above flag.

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

    - Returns the flag about the points consideration.

    Return type: | bool

  `KeepSegments`()
    - Sets the above flag.

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

    - Returns the flag about the segments consideration.

    Return type: | bool

  `NbDomains`()
    - Returns the number of domains of the IndH-th hatching. Only ONE ‘INFINITE’ domain means that the hatching is fully included in the contour defined by the elements.

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

  `NbPoints`()
    - Returns the number of intersection points of the IndH-th hatching.

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

  `Point`()
    - Returns the IndP-th intersection point of the IndH-th hatching.

    Parameters: | IndH (int) – IndP (int) –
    Return type: | HatchGen_PointOnHatching

  `RemElement`()
    - Removes the IndE-th element from the hatcher.

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

  `RemHatching`()
    - Removes the IndH-th hatching from the hatcher.

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

  `Status`()
    - Returns the status about the IndH-th hatching.

    Parameters: | IndH (int) –
    Return type: | HatchGen_ErrorStatus

  `Trim`()
    - Trims all the hatchings of the hatcher by all the elements of the hatcher.

    Return type: | None

    - Adds a hatching to the hatcher and trims it by the elements already given and returns its index.

    Parameters: | Curve (Geom2dAdaptor_Curve &) –
    Return type: | int

    - Trims the IndH-th hatching by the elements already given.

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

  `TrimDone`()
    - Returns the fact that the intersections were computed for the IndH-th hatching.

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

  `TrimFailed`()
    - Returns the fact that the intersections failed for the IndH-th hatching.

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

  `thisown`

    The membership flag

class `Geom2dHatch_Hatching`(*args)

  Bases: `object`

  Return type: | None

  - Creates a hatching.

  Parameters: | Curve (Geom2dAdaptor_Curve &) –
  Return type: | None

  `AddDomain`()
    - Adds a domain to the hatching.

    Parameters: | Domain (HatchGen_Domain &) –
    Return type: | None

  `AddPoint`()
    - Adds an intersection point to the hatching.

    Parameters: | Point (HatchGen_PointOnHatching &) – Confusion (float) –
    Return type: | None

  `ChangeCurve`()
    - Returns the curve associated to the hatching.

    Return type: | Geom2dAdaptor_Curve

  `ChangePoint`()
    - Returns the Index-th intersection point of the hatching. The exception OutOfRange is raised if Index < 1 or Index > NbPoints.

    Parameters: | Index (int) –
    Return type: | HatchGen_PointOnHatching

  `ClassificationPoint`()
    - Returns a point on the curve. This point will be used for the classification.

    Return type: | gp_Pnt2d

  `ClrDomains`()
    - Removes all the domains of the hatching.

    Return type: | None

  `ClrPoints`()
    - Removes all the intersection points of the hatching.

    Return type: | None

  `Curve`()
    - Returns the curve associated to the hatching.

    Return type: | Geom2dAdaptor_Curve

  `Domain`()
    - Returns the Index-th domain of the hatching. The exception OutOfRange is raised if Index < 1 or Index > NbDomains.

    Parameters: | Index (int) –
    Return type: | HatchGen_Domain

  `IsDone`()
    - Sets the flag about the domains computation to the given value.

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

    - Returns the flag about the domains computation.

    Return type: | bool

  `NbDomains`()
    - Returns the number of domains of the hatching.

    Return type: | int

  `NbPoints`()
    - Returns the number of intersection points of the hatching.

    Return type: | int

  `Point`()
    - Returns the Index-th intersection point of the hatching. The exception OutOfRange is raised if Index < 1 or Index > NbPoints.

    Parameters: | Index (int) –
    Return type: | HatchGen_PointOnHatching

  `RemDomain`()
    - Removes the Index-th domain of the hatching. The exception OutOfRange is raised if Index < 1 or Index > NbDomains.

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

  `RemPoint`()
    - Removes the Index-th intersection point of the hatching. The exception OutOfRange is raised if Index < 1 or Index > NbPoints.

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

  `Status`()
    - Sets the error status.

    Parameters: | Status (HatchGen_ErrorStatus) –
    Return type: | None

    - Returns the error status.

    Return type: | HatchGen_ErrorStatus

  `TrimDone`()
    - Sets the flag about the trimming computations to the given value.

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

    - Returns the flag about the trimming computations.

    Return type: | bool

  `TrimFailed`()
    - Sets the flag about the trimming failure to the given value.

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

    - Returns the flag about the trimming failure.

    Return type: | bool

  `thisown`

    The membership flag

class `Geom2dHatch_Hatchings`(*args)

  Bases: `OCC.TCollection.TCollection_BasicMap`

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

  `Assign`()

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

  `Bind`()

    Parameters: | K (int &) – I (Geom2dHatch_Hatching &) –
    Return type: | bool

  `ChangeFind`()

    Parameters: | K (int &) –
    Return type: | Geom2dHatch_Hatching

  `ChangeFind1`()

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

  `Clear`()

    Return type: | None

  `Find`()

    Parameters: | K (int &) –
    Return type: | Geom2dHatch_Hatching

  `Find1`()

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

  `IsBound`()

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

  `ReSize`()

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

  `Set`()

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

  `UnBind`()

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

  `thisown`

    The membership flag

class `Geom2dHatch_Intersector`(*args)

  Bases: `OCC.Geom2dInt.Geom2dInt_GInter`

  - Creates an intersector.

  Parameters: | Confusion (float) – Tangency (float) –
  Return type: | None
  Return type: | None

  `ConfusionTolerance`()
    - Returns the confusion tolerance of the intersector.

    Return type: | float

  `Intersect`()
    - Intersects the curves C1 and C2. The results are retreived by the usual methods described in IntRes2d_Intersection. Creates an intersector.

    Parameters: | C1 (Geom2dAdaptor_Curve &) – C2 (Geom2dAdaptor_Curve &) –
    Return type: | None

  `LocalGeometry`()
    - Returns in <T>, <N> and <C> the tangent, normal and curvature of the edge <E> at parameter value <U>.

    Parameters: | E (Geom2dAdaptor_Curve &) – U (float) – T (gp_Dir2d) – N (gp_Dir2d) – C (float &) –
    Return type: | None

  `Perform`()
    - Performs the intersection between the 2d line segment (<L>, <P>) and the Curve <E>. The line segment is the part of the 2d line <L> of parameter range [0, <P>] (P is positive and can be RealLast()). Tol is the Tolerance on the segment. The order is relevant, the first argument is the segment, the second the Edge.

    Parameters: | L (gp_Lin2d) – P (float) – Tol (float) – E (Geom2dAdaptor_Curve &) –
    Return type: | None

  `SetConfusionTolerance`()
    - Sets the confusion tolerance of the intersector.

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

  `SetTangencyTolerance`()
    - Sets the tangency tolerance of the intersector.

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

  `TangencyTolerance`()
    - Returns the tangency tolerance of the intersector.

    Return type: | float

  `thisown`

    The membership flag

class `Geom2dHatch_MapOfElements`(*args)

  Bases: `OCC.TCollection.TCollection_BasicMap`

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

  `Assign`()

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

  `Bind`()

    Parameters: | K (int &) – I (Geom2dHatch_Element &) –
    Return type: | bool

  `ChangeFind`()

    Parameters: | K (int &) –
    Return type: | Geom2dHatch_Element

  `ChangeFind1`()

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

  `Clear`()

    Return type: | None

  `Find`()

    Parameters: | K (int &) –
    Return type: | Geom2dHatch_Element

  `Find1`()

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

  `IsBound`()

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

  `ReSize`()

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

  `Set`()

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

  `UnBind`()

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

  `thisown`

    The membership flag

class `Handle_Geom2dHatch_DataMapNodeOfHatchings`(*args)

  Bases: `OCC.TCollection.Handle_TCollection_MapNode`

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

    The membership flag

class `Handle_Geom2dHatch_DataMapNodeOfMapOfElements`(*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`()

`register_handle`(handle, base_object)

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