OCC.Core.SelectBasics module

SelectBasics module, see official documentation at https://www.opencascade.com/doc/occt-7.4.0/refman/html/package_selectbasics.html

class SelectBasics_PickResult(*args)

Bases: object

• Empty constructor defining an invalid result.

  rtype

  None* Constructor with initialization.

  param theDepth

  type theDepth

  float

  param theDistToCenter

  type theDistToCenter

  float

  param theObjPickedPnt

  type theObjPickedPnt

  gp_Pnt

  rtype

  None

Depth()

• Return depth along picking ray.

  rtype

  float

DistToGeomCenter()

• Return distance to geometry center (auxiliary value for comparing results).

  rtype

  float

HasPickedPoint()

• Return True if Picked Point lying on detected entity was set.

  rtype

  bool

Invalidate()

• Reset depth value.

  rtype

  None

IsValid()

• Return True if result was been defined.

  rtype

  bool

static Min()

• Return closest result between two Pick Results according to Depth value.

  param thePickResult1

  type thePickResult1

  SelectBasics_PickResult

  param thePickResult2

  type thePickResult2

  SelectBasics_PickResult

  rtype

  SelectBasics_PickResult

PickedPoint()

• Return picked point lying on detected entity. WARNING! Point is defined in local coordinate system and should be translated into World System before usage!

  rtype

  gp_Pnt

SetDepth()

• Set depth along picking ray.

  param theDepth

  type theDepth

  float

  rtype

  None

SetDistToGeomCenter()

• Set distance to geometry center.

  param theDistToCenter

  type theDistToCenter

  float

  rtype

  None

SetPickedPoint()

• Set picked point.

  param theObjPickedPnt

  type theObjPickedPnt

  gp_Pnt

  rtype

  None

property thisown

The membership flag

class SelectBasics_SelectingVolumeManager(*args, **kwargs)

Bases: object

Box = 1

DetectedPoint()

Parameters

theDepth –

type theDepth

float

rtype

gp_Pnt

DistToGeometryCenter()

• Calculates distance from 3d projection of user-defined selection point to the given point theCOG

  param theCOG

  type theCOG

  gp_Pnt

  rtype

  float

GetActiveSelectionType()

Return type

int

GetFarPickedPnt()

• Valid only for point and rectangular selection. Returns projection of 2d mouse picked point or projection of center of 2d rectangle (for point and rectangular selection correspondingly) onto far view frustum plane

  rtype

  gp_Pnt

GetMousePosition()

• Return mouse coordinates for Point selection mode.

  rtype

  gp_Pnt2d

GetNearPickedPnt()

• Valid only for point and rectangular selection. Returns projection of 2d mouse picked point or projection of center of 2d rectangle (for point and rectangular selection correspondingly) onto near view frustum plane

  rtype

  gp_Pnt

GetPlanes()

• Stores plane equation coefficients (in the following form: Ax + By + Cz + D = 0) to the given vector

  param thePlaneEquations

  type thePlaneEquations

  NCollection_Vector<NCollection_Vec4<float> >

  rtype

  None

IsOverlapAllowed()

Return type

bool

Overlaps()

• Returns true if selecting volume is overlapped by box theBox

  param theBoxMin

  type theBoxMin

  NCollection_Vec3<float>

  param theBoxMax

  type theBoxMax

  NCollection_Vec3<float>

  param thePickResult

  type thePickResult

  SelectBasics_PickResult

  rtype

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

  param theBoxMin

  type theBoxMin

  NCollection_Vec3<float>

  param theBoxMax

  type theBoxMax

  NCollection_Vec3<float>

  param theInside

  default value is NULL

  type theInside

  bool *

  rtype

  bool* Returns true if selecting volume is overlapped by point thePnt

  param thePnt

  type thePnt

  gp_Pnt

  param thePickResult

  type thePickResult

  SelectBasics_PickResult

  rtype

  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.

  param thePnt

  type thePnt

  gp_Pnt

  rtype

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

  param theArrayOfPts

  type theArrayOfPts

  TColgp_HArray1OfPnt

  param theSensType

  type theSensType

  int

  param thePickResult

  type thePickResult

  SelectBasics_PickResult

  rtype

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

  param theArrayOfPts

  type theArrayOfPts

  TColgp_Array1OfPnt

  param theSensType

  type theSensType

  int

  param thePickResult

  type thePickResult

  SelectBasics_PickResult

  rtype

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

  param thePt1

  type thePt1

  gp_Pnt

  param thePt2

  type thePt2

  gp_Pnt

  param thePickResult

  type thePickResult

  SelectBasics_PickResult

  rtype

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

  param thePt1

  type thePt1

  gp_Pnt

  param thePt2

  type thePt2

  gp_Pnt

  param thePt3

  type thePt3

  gp_Pnt

  param theSensType

  type theSensType

  int

  param thePickResult

  type thePickResult

  SelectBasics_PickResult

  rtype

  bool

Point = 0

Polyline = 2

Unknown = 3

property thisown

The membership flag

class SwigPyIterator(*args, **kwargs)

Bases: object

advance()

copy()

decr()

distance()

equal()

incr()

next()

previous()

property thisown

The membership flag

value()

class selectbasics

Bases: object

static MaxOwnerPriority()

• Structure to provide all-in-one result of selection of sensitive for ‘Matches’ method of Select3D_SensitiveEntity.

  rtype

  int

static MinOwnerPriority()

Return type

int

property thisown

The membership flag