OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    SelectMgr_SortCriterion Class Reference

    This class provides data and criterion for sorting candidate entities in the process of interactive selection by mouse click. More...

    #include <SelectMgr_SortCriterion.hxx>

    Public Member Functions

     SelectMgr_SortCriterion ()
     Empty constructor.
    bool IsCloserDepth (const SelectMgr_SortCriterion &theOther) const
     Compare with another item by depth, priority and minDist.
    bool IsHigherPriority (const SelectMgr_SortCriterion &theOther) const
     Compare with another item using old logic (OCCT version <= 6.3.1) with priority considered preceding depth.

    Data Fields

    occ::handle< Select3D_SensitiveEntityEntity
     detected entity
    gp_Pnt Point
     3D point
    NCollection_Vec3< float > Normal
     surface normal or 0 vector if undefined
    double Depth
     distance from the view plane to the entity
    double MinDist
     distance from the clicked point to the entity on the view plane
    double Tolerance
     tolerance used for selecting candidates
    int SelectionPriority
     selection priority
    int DisplayPriority
     display priority
    int ZLayerPosition
     ZLayer rendering order index, stronger than a depth.
    int NbOwnerMatches
     overall number of entities collected for the same owner
    bool IsPreferPriority
     flag to signal comparison to be done over priority

    Detailed Description

    This class provides data and criterion for sorting candidate entities in the process of interactive selection by mouse click.

    Constructor & Destructor Documentation

    ◆ SelectMgr_SortCriterion()

    SelectMgr_SortCriterion::SelectMgr_SortCriterion ( )
    inline

    Empty constructor.

    Member Function Documentation

    ◆ IsCloserDepth()

    bool SelectMgr_SortCriterion::IsCloserDepth ( const SelectMgr_SortCriterion & theOther) const
    inline

    Compare with another item by depth, priority and minDist.

    ◆ IsHigherPriority()

    bool SelectMgr_SortCriterion::IsHigherPriority ( const SelectMgr_SortCriterion & theOther) const
    inline

    Compare with another item using old logic (OCCT version <= 6.3.1) with priority considered preceding depth.

    Field Documentation

    ◆ Depth

    double SelectMgr_SortCriterion::Depth

    distance from the view plane to the entity

    ◆ DisplayPriority

    int SelectMgr_SortCriterion::DisplayPriority

    display priority

    ◆ Entity

    occ::handle<Select3D_SensitiveEntity> SelectMgr_SortCriterion::Entity

    detected entity

    ◆ IsPreferPriority

    bool SelectMgr_SortCriterion::IsPreferPriority

    flag to signal comparison to be done over priority

    ◆ MinDist

    double SelectMgr_SortCriterion::MinDist

    distance from the clicked point to the entity on the view plane

    ◆ NbOwnerMatches

    int SelectMgr_SortCriterion::NbOwnerMatches

    overall number of entities collected for the same owner

    ◆ Normal

    NCollection_Vec3<float> SelectMgr_SortCriterion::Normal

    surface normal or 0 vector if undefined

    ◆ Point

    gp_Pnt SelectMgr_SortCriterion::Point

    3D point

    ◆ SelectionPriority

    int SelectMgr_SortCriterion::SelectionPriority

    selection priority

    ◆ Tolerance

    double SelectMgr_SortCriterion::Tolerance

    tolerance used for selecting candidates

    ◆ ZLayerPosition

    int SelectMgr_SortCriterion::ZLayerPosition

    ZLayer rendering order index, stronger than a depth.


    The documentation for this class was generated from the following file: