# OCC.SelectBasics module

class `Handle_SelectBasics_EntityOwner`(*args)

  Bases: `OCC.MMgt.Handle_MMgt_TShared`

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

    The membership flag

class `Handle_SelectBasics_SensitiveEntity`(*args)

  Bases: `OCC.MMgt.Handle_MMgt_TShared`

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

    The membership flag

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

  Bases: `OCC.MMgt.MMgt_TShared`

  `GetHandle`()
  `HasLocation`()

    Return type: | bool

  `Location`()

    Return type: | TopLoc_Location

  `Priority`()

    Return type: | int

  `ResetLocation`()

    Return type: | void

  `Set`()
    - sets the selectable priority of the owner

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

  `SetLocation`()

    Parameters: | aLoc (TopLoc_Location &) –
    Return type: | void

  `thisown`

    The membership flag

class `SelectBasics_PickResult`(*args)

  Bases: `object`

  Return type: | None
  Parameters: | theDepth (float) – theDistToCenter (float) –
  Return type: | None

  `Depth`()

    Return type: | inline float

  `DistToGeomCenter`()

    Return type: | inline float

  `thisown`

    The membership flag

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

  Bases: `object`

  `Box` = 1
  `DetectedPoint`()

    Parameters: | theDepth (float) –
    Return type: | gp_Pnt

  `DistToGeometryCenter`()
    - Calculates distance from 3d projection of user-defined selection point to the given point theCOG

    Parameters: | theCOG (gp_Pnt) –
    Return type: | float

  `GetActiveSelectionType`()

    Return type: | int

  `IsOverlapAllowed`()

    Return type: | bool

  `Overlaps`()
    - Returns true if selecting volume is overlapped by box theBox

    Parameters: | theBoxMin (NCollection_Vec3<float> &) – theBoxMax (NCollection_Vec3<float> &) – theDepth (float &) –
    Return type: | bool

    - Returns true if selecting volume is overlapped by axis-aligned bounding box with minimum corner at point theMinPt and maximum at point theMaxPt

    Parameters: | theBoxMin (NCollection_Vec3<float> &) – theBoxMax (NCollection_Vec3<float> &) – theInside (bool *) – default value is NULL
    Return type: | bool

    - Returns true if selecting volume is overlapped by point thePnt

    Parameters: | thePnt (gp_Pnt) – theDepth (float &) –
    Return type: | bool

    - Returns true if selecting volume is overlapped by point thePnt. Does not perform depth calculation, so this method is defined as helper function for inclusion test.

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

    - Returns true if selecting volume is overlapped by planar convex polygon, which points are stored in theArrayOfPts, taking into account sensitivity type theSensType

    Parameters: | theArrayOfPts (Handle_TColgp_HArray1OfPnt) – theSensType (int) – theDepth (float &) –
    Return type: | bool

    - Returns true if selecting volume is overlapped by line segment with start point at thePt1 and end point at thePt2

    Parameters: | thePt1 (gp_Pnt) – thePt2 (gp_Pnt) – theDepth (float &) –
    Return type: | bool

    - Returns true if selecting volume is overlapped by triangle with vertices thePt1, thePt2 and thePt3, taking into account sensitivity type theSensType

    Parameters: | thePt1 (gp_Pnt) – thePt2 (gp_Pnt) – thePt3 (gp_Pnt) – theSensType (int) – theDepth (float &) –
    Return type: | bool

  `Point` = 0
  `Polyline` = 2
  `Unknown` = 3
  `thisown`

    The membership flag

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

  Bases: `OCC.MMgt.MMgt_TShared`

  `BVH`()
    - Builds BVH tree for sensitive if it is needed

    Return type: | void

  `BoundingBox`()
    - Returns bounding box of sensitive entity

    Return type: | Select3D_BndBox3d

  `Clear`()
    - Clears up all the resources and memory allocated

    Return type: | void

  `GetHandle`()
  `HasInitLocation`()
    - Returns true if the shape corresponding to the entity has init location.

    Return type: | bool

  `InvInitLocation`()
    - Returns inversed location transformation matrix if the shape corresponding to this entity has init location set. Otherwise, returns identity matrix.

    Return type: | gp_Trsf

  `Matches`()
    - Checks whether the sensitive entity is overlapped by current selecting volume

    Parameters: | theMgr (SelectBasics_SelectingVolumeManager &) – thePickResult (SelectBasics_PickResult &) –
    Return type: | bool

  `NbSubElements`()
    - Returns the number of sub-entities or elements in sensitive entity. Is used to determine if entity is complex and needs to pre-build BVH at the creation of sensitive entity step or is light-weighted so the tree can be build on demand with unnoticeable delay

    Return type: | int

  `OwnerId`()
    - Returns pointer to owner of the entity

    Return type: | Handle_SelectBasics_EntityOwner

  `SensitivityFactor`()
    - allows a better sensitivity for a specific entity in selection algorithms useful for small sized entities.

    Return type: | int

  `Set`()
    - Sets owner of the entity

    Parameters: | theOwnerId (Handle_SelectBasics_EntityOwner &) –
    Return type: | void

  `SetSensitivityFactor`()
    - Allows to manage the sensitivity of the entity

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

  `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

class `selectbasics`

  Bases: `object`

  static `MaxOwnerPriority`(*args)
    - Structure to provide all-in-one result of selection of sensitive for ‘Matches’ method of SelectBasics_SensitiveEntity.

    Return type: | int

  static `MinOwnerPriority`(*args)

    Return type: | int

  `thisown`

    The membership flag

`selectbasics_MaxOwnerPriority`(*args)
  - Structure to provide all-in-one result of selection of sensitive for ‘Matches’ method of SelectBasics_SensitiveEntity.

  Return type: | int

`selectbasics_MinOwnerPriority`(*args)

  Return type: | int