Open CASCADE Technology  7.7.0.dev
Public Member Functions | Protected Member Functions | Protected Attributes

SelectMgr_ViewerSelector Class Reference

A framework to define finding, sorting the sensitive primitives in a view. Services are also provided to define the return of the owners of those primitives selected. The primitives are sorted by criteria such as priority of the primitive or its depth in the view relative to that of other primitives. Note that in 3D, the inheriting framework StdSelect_ViewerSelector3d is only to be used if you do not want to use the services provided by AIS. Two tools are available to find and select objects found at a given position in the view. If you want to select the owners of all the objects detected at point x,y,z you use the Init - More - Next - Picked loop. If, on the other hand, you want to select only one object detected at that point, you use the Init - More - OnePicked loop. In this iteration, More is used to see if an object was picked and OnePicked, to get the object closest to the pick position. Viewer selectors are driven by SelectMgr_SelectionManager, and manipulate the SelectMgr_Selection objects given to them by the selection manager. More...

#include <SelectMgr_ViewerSelector.hxx>

Inheritance diagram for SelectMgr_ViewerSelector:
Inheritance graph
[legend]

Public Member Functions

 SelectMgr_ViewerSelector ()
 Constructs an empty selector object. More...
 
Standard_Integer CustomPixelTolerance () const
 Returns custom pixel tolerance value. More...
 
void SetPixelTolerance (const Standard_Integer theTolerance)
 Sets the pixel tolerance <theTolerance>. More...
 
Standard_Real Sensitivity () const
 Returns the largest sensitivity of picking. More...
 
Standard_Integer PixelTolerance () const
 Returns the largest pixel tolerance. More...
 
virtual void SortResult () const
 Sorts the detected entities by priority and distance. More...
 
Handle< SelectMgr_EntityOwnerOnePicked () const
 Returns the picked element with the highest priority, and which is the closest to the last successful mouse position. More...
 
bool ToPickClosest () const
 Return the flag determining precedence of picked depth (distance from eye to entity) over entity priority in sorted results; TRUE by default. When flag is TRUE, priority will be considered only if entities have the same depth within the tolerance. When flag is FALSE, entities with higher priority will be in front regardless of their depth (like x-ray). More...
 
void SetPickClosest (bool theToPreferClosest)
 Set flag determining precedence of picked depth over entity priority in sorted results. More...
 
SelectMgr_TypeOfDepthTolerance DepthToleranceType () const
 Return the type of tolerance for considering two entities having a similar depth (distance from eye to entity); SelectMgr_TypeOfDepthTolerance_SensitivityFactor by default. More...
 
Standard_Real DepthTolerance () const
 Return the tolerance for considering two entities having a similar depth (distance from eye to entity). More...
 
void SetDepthTolerance (SelectMgr_TypeOfDepthTolerance theType, Standard_Real theTolerance)
 Set the tolerance for considering two entities having a similar depth (distance from eye to entity). More...
 
Standard_Integer NbPicked () const
 Returns the number of detected owners. More...
 
void ClearPicked ()
 Clears picking results. More...
 
void Clear ()
 Empties all the tables, removes all selections... More...
 
Handle< SelectMgr_EntityOwnerPicked (const Standard_Integer theRank) const
 Returns the entity Owner for the object picked at specified position. More...
 
const SelectMgr_SortCriterionPickedData (const Standard_Integer theRank) const
 Returns the Entity for the object picked at specified position. More...
 
const Handle< Select3D_SensitiveEntity > & PickedEntity (const Standard_Integer theRank) const
 Returns the Entity for the object picked at specified position. More...
 
gp_Pnt PickedPoint (const Standard_Integer theRank) const
 Returns the 3D point (intersection of picking axis with the object nearest to eye) for the object picked at specified position. More...
 
Standard_Boolean RemovePicked (const Handle< SelectMgr_SelectableObject > &theObject)
 Remove picked entities associated with specified object. More...
 
Standard_Boolean Contains (const Handle< SelectMgr_SelectableObject > &theObject) const
 
const Handle< Select3D_BVHBuilder3dEntitySetBuilder ()
 Returns the default builder used to construct BVH of entity set. More...
 
void SetEntitySetBuilder (const Handle< Select3D_BVHBuilder3d > &theBuilder)
 Sets the default builder used to construct BVH of entity set. The new builder will be also assigned for already defined objects, but computed BVH trees will not be invalidated. More...
 
Standard_Boolean Modes (const Handle< SelectMgr_SelectableObject > &theSelectableObject, TColStd_ListOfInteger &theModeList, const SelectMgr_StateOfSelection theWantedState=SelectMgr_SOS_Any) const
 Returns the list of selection modes ModeList found in this selector for the selectable object aSelectableObject. Returns true if aSelectableObject is referenced inside this selector; returns false if the object is not present in this selector. More...
 
Standard_Boolean IsActive (const Handle< SelectMgr_SelectableObject > &theSelectableObject, const Standard_Integer theMode) const
 Returns true if the selectable object aSelectableObject having the selection mode aMode is active in this selector. More...
 
Standard_Boolean IsInside (const Handle< SelectMgr_SelectableObject > &theSelectableObject, const Standard_Integer theMode) const
 Returns true if the selectable object aSelectableObject having the selection mode aMode is in this selector. More...
 
SelectMgr_StateOfSelection Status (const Handle< SelectMgr_Selection > &theSelection) const
 Returns the selection status Status of the selection aSelection. More...
 
TCollection_AsciiString Status (const Handle< SelectMgr_SelectableObject > &theSelectableObject) const
 
void ActiveOwners (NCollection_List< Handle< SelectMgr_EntityOwner >> &theOwners) const
 Returns the list of active entity owners. More...
 
void AddSelectableObject (const Handle< SelectMgr_SelectableObject > &theObject)
 Adds new object to the map of selectable objects. More...
 
void AddSelectionToObject (const Handle< SelectMgr_SelectableObject > &theObject, const Handle< SelectMgr_Selection > &theSelection)
 Adds new selection to the object and builds its BVH tree. More...
 
void MoveSelectableObject (const Handle< SelectMgr_SelectableObject > &theObject)
 Moves existing object from set of not transform persistence objects to set of transform persistence objects (or vice versa). More...
 
void RemoveSelectableObject (const Handle< SelectMgr_SelectableObject > &theObject)
 Removes selectable object from map of selectable ones. More...
 
void RemoveSelectionOfObject (const Handle< SelectMgr_SelectableObject > &theObject, const Handle< SelectMgr_Selection > &theSelection)
 Removes selection of the object and marks its BVH tree for rebuild. More...
 
void RebuildObjectsTree (const Standard_Boolean theIsForce=Standard_False)
 Marks BVH of selectable objects for rebuild. Parameter theIsForce set as true guarantees that 1st level BVH for the viewer selector will be rebuilt during this call. More...
 
void RebuildSensitivesTree (const Handle< SelectMgr_SelectableObject > &theObject, const Standard_Boolean theIsForce=Standard_False)
 Marks BVH of sensitive entities of particular selectable object for rebuild. Parameter theIsForce set as true guarantees that 2nd level BVH for the object given will be rebuilt during this call. More...
 
SelectMgr_SelectingVolumeManagerGetManager ()
 Returns instance of selecting volume manager of the viewer selector. More...
 
const SelectMgr_SelectableObjectSetSelectableObjects () const
 Return map of selectable objects. More...
 
void ResetSelectionActivationStatus ()
 Marks all added sensitive entities of all objects as non-selectable. More...
 
void AllowOverlapDetection (const Standard_Boolean theIsToAllow)
 Is used for rectangular selection only If theIsToAllow is false, only fully included sensitives will be detected, otherwise the algorithm will mark both included and overlapped entities as matched. More...
 
void Pick (const Standard_Integer theXPix, const Standard_Integer theYPix, const Handle< V3d_View > &theView)
 Picks the sensitive entity at the pixel coordinates of the mouse <theXPix> and <theYPix>. The selector looks for touched areas and owners. More...
 
void Pick (const Standard_Integer theXPMin, const Standard_Integer theYPMin, const Standard_Integer theXPMax, const Standard_Integer theYPMax, const Handle< V3d_View > &theView)
 Picks the sensitive entity according to the minimum and maximum pixel values <theXPMin>, <theYPMin>, <theXPMax> and <theYPMax> defining a 2D area for selection in the 3D view aView. More...
 
void Pick (const TColgp_Array1OfPnt2d &thePolyline, const Handle< V3d_View > &theView)
 pick action - input pixel values for polyline selection for selection. More...
 
void Pick (const gp_Ax1 &theAxis, const Handle< V3d_View > &theView)
 Picks the sensitive entity according to the input axis. This is geometric intersection 3D objects by axis (camera parameters are ignored and objects with transform persistance are skipped). More...
 
Standard_Boolean ToPixMap (Image_PixMap &theImage, const Handle< V3d_View > &theView, const StdSelect_TypeOfSelectionImage theType, const Standard_Integer thePickedIndex=1)
 Dump of detection results into image. This method performs axis picking for each pixel in the image and generates a color depending on picking results and selection image type. More...
 
void DisplaySensitive (const Handle< V3d_View > &theView)
 Displays sensitives in view <theView>. More...
 
void ClearSensitive (const Handle< V3d_View > &theView)
 
void DisplaySensitive (const Handle< SelectMgr_Selection > &theSel, const gp_Trsf &theTrsf, const Handle< V3d_View > &theView, const Standard_Boolean theToClearOthers=Standard_True)
 
void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream. More...
 
void SetToPrebuildBVH (Standard_Boolean theToPrebuild, Standard_Integer theThreadsNum=-1)
 Enables/disables building BVH for sensitives in separate threads. More...
 
void QueueBVHBuild (const Handle< Select3D_SensitiveEntity > &theEntity)
 Queues a sensitive entity to build its BVH. More...
 
void WaitForBVHBuild ()
 Waits BVH threads finished building. More...
 
Standard_Boolean ToPrebuildBVH () const
 Returns TRUE if building BVH for sensitives in separate threads is enabled. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Protected Member Functions

void TraverseSensitives (const Standard_Integer theViewId=-1)
 Traverses BVH containing all added selectable objects and finds candidates for further search of overlap. More...
 
void traverseObject (const Handle< SelectMgr_SelectableObject > &theObject, const SelectMgr_SelectingVolumeManager &theMgr, const Handle< Graphic3d_Camera > &theCamera, const Graphic3d_Mat4d &theProjectionMat, const Graphic3d_Mat4d &theWorldViewMat, const Graphic3d_Vec2i &theWinSize)
 Internal function that checks if there is possible overlap between some entity of selectable object theObject and current selecting volume. More...
 
void checkOverlap (const Handle< Select3D_SensitiveEntity > &theEntity, const gp_GTrsf &theInversedTrsf, SelectMgr_SelectingVolumeManager &theMgr)
 Internal function that checks if a particular sensitive entity theEntity overlaps current selecting volume precisely. More...
 
void updateZLayers (const Handle< V3d_View > &theView)
 Update z-layers order map. More...
 

Protected Attributes

Standard_Real myDepthTolerance
 
SelectMgr_TypeOfDepthTolerance myDepthTolType
 
Standard_Boolean myToPreferClosest
 
SelectMgr_IndexedDataMapOfOwnerCriterion mystored
 
SelectMgr_SelectingVolumeManager mySelectingVolumeMgr
 
SelectMgr_SelectableObjectSet mySelectableObjects
 
SelectMgr_ToleranceMap myTolerances
 
NCollection_DataMap< Graphic3d_ZLayerId, Standard_IntegermyZLayerOrderMap
 
Handle< Select3D_BVHBuilder3dmyEntitySetBuilder
 
gp_Pnt myCameraEye
 
gp_Dir myCameraDir
 
Standard_Real myCameraScale
 
Standard_Boolean myToPrebuildBVH
 
Handle< SelectMgr_BVHThreadPoolmyBVHThreadPool
 
TColStd_Array1OfInteger myIndexes
 
Standard_Boolean myIsSorted
 
Standard_Boolean myIsLeftChildQueuedFirst
 
SelectMgr_MapOfObjectSensitives myMapOfObjectSensitives
 
Graphic3d_SequenceOfStructure myStructs
 list of debug presentations More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

A framework to define finding, sorting the sensitive primitives in a view. Services are also provided to define the return of the owners of those primitives selected. The primitives are sorted by criteria such as priority of the primitive or its depth in the view relative to that of other primitives. Note that in 3D, the inheriting framework StdSelect_ViewerSelector3d is only to be used if you do not want to use the services provided by AIS. Two tools are available to find and select objects found at a given position in the view. If you want to select the owners of all the objects detected at point x,y,z you use the Init - More - Next - Picked loop. If, on the other hand, you want to select only one object detected at that point, you use the Init - More - OnePicked loop. In this iteration, More is used to see if an object was picked and OnePicked, to get the object closest to the pick position. Viewer selectors are driven by SelectMgr_SelectionManager, and manipulate the SelectMgr_Selection objects given to them by the selection manager.

Tolerances are applied to the entities in the following way:

  1. tolerance value stored in mytolerance will be used to calculate initial selecting frustum, which will be applied for intersection testing during BVH traverse;
  2. if tolerance of sensitive entity is less than mytolerance, the frustum for intersection detection will be resized according to its sensitivity.

Constructor & Destructor Documentation

◆ SelectMgr_ViewerSelector()

SelectMgr_ViewerSelector::SelectMgr_ViewerSelector ( )

Constructs an empty selector object.

Member Function Documentation

◆ ActiveOwners()

void SelectMgr_ViewerSelector::ActiveOwners ( NCollection_List< Handle< SelectMgr_EntityOwner >> &  theOwners) const

Returns the list of active entity owners.

◆ AddSelectableObject()

void SelectMgr_ViewerSelector::AddSelectableObject ( const Handle< SelectMgr_SelectableObject > &  theObject)

Adds new object to the map of selectable objects.

◆ AddSelectionToObject()

void SelectMgr_ViewerSelector::AddSelectionToObject ( const Handle< SelectMgr_SelectableObject > &  theObject,
const Handle< SelectMgr_Selection > &  theSelection 
)

Adds new selection to the object and builds its BVH tree.

◆ AllowOverlapDetection()

void SelectMgr_ViewerSelector::AllowOverlapDetection ( const Standard_Boolean  theIsToAllow)

Is used for rectangular selection only If theIsToAllow is false, only fully included sensitives will be detected, otherwise the algorithm will mark both included and overlapped entities as matched.

◆ checkOverlap()

void SelectMgr_ViewerSelector::checkOverlap ( const Handle< Select3D_SensitiveEntity > &  theEntity,
const gp_GTrsf theInversedTrsf,
SelectMgr_SelectingVolumeManager theMgr 
)
protected

Internal function that checks if a particular sensitive entity theEntity overlaps current selecting volume precisely.

◆ Clear()

void SelectMgr_ViewerSelector::Clear ( )
inline

Empties all the tables, removes all selections...

◆ ClearPicked()

void SelectMgr_ViewerSelector::ClearPicked ( )

Clears picking results.

◆ ClearSensitive()

void SelectMgr_ViewerSelector::ClearSensitive ( const Handle< V3d_View > &  theView)

◆ Contains()

Standard_Boolean SelectMgr_ViewerSelector::Contains ( const Handle< SelectMgr_SelectableObject > &  theObject) const

◆ CustomPixelTolerance()

Standard_Integer SelectMgr_ViewerSelector::CustomPixelTolerance ( ) const
inline

Returns custom pixel tolerance value.

◆ DepthTolerance()

Standard_Real SelectMgr_ViewerSelector::DepthTolerance ( ) const
inline

Return the tolerance for considering two entities having a similar depth (distance from eye to entity).

◆ DepthToleranceType()

SelectMgr_TypeOfDepthTolerance SelectMgr_ViewerSelector::DepthToleranceType ( ) const
inline

Return the type of tolerance for considering two entities having a similar depth (distance from eye to entity); SelectMgr_TypeOfDepthTolerance_SensitivityFactor by default.

◆ DisplaySensitive() [1/2]

void SelectMgr_ViewerSelector::DisplaySensitive ( const Handle< SelectMgr_Selection > &  theSel,
const gp_Trsf theTrsf,
const Handle< V3d_View > &  theView,
const Standard_Boolean  theToClearOthers = Standard_True 
)

◆ DisplaySensitive() [2/2]

void SelectMgr_ViewerSelector::DisplaySensitive ( const Handle< V3d_View > &  theView)

Displays sensitives in view <theView>.

◆ DumpJson()

void SelectMgr_ViewerSelector::DumpJson ( Standard_OStream theOStream,
Standard_Integer  theDepth = -1 
) const

Dumps the content of me into the stream.

◆ EntitySetBuilder()

const Handle< Select3D_BVHBuilder3d > SelectMgr_ViewerSelector::EntitySetBuilder ( )
inline

Returns the default builder used to construct BVH of entity set.

◆ GetManager()

SelectMgr_SelectingVolumeManager& SelectMgr_ViewerSelector::GetManager ( )
inline

Returns instance of selecting volume manager of the viewer selector.

◆ IsActive()

Standard_Boolean SelectMgr_ViewerSelector::IsActive ( const Handle< SelectMgr_SelectableObject > &  theSelectableObject,
const Standard_Integer  theMode 
) const

Returns true if the selectable object aSelectableObject having the selection mode aMode is active in this selector.

◆ IsInside()

Standard_Boolean SelectMgr_ViewerSelector::IsInside ( const Handle< SelectMgr_SelectableObject > &  theSelectableObject,
const Standard_Integer  theMode 
) const

Returns true if the selectable object aSelectableObject having the selection mode aMode is in this selector.

◆ Modes()

Standard_Boolean SelectMgr_ViewerSelector::Modes ( const Handle< SelectMgr_SelectableObject > &  theSelectableObject,
TColStd_ListOfInteger theModeList,
const SelectMgr_StateOfSelection  theWantedState = SelectMgr_SOS_Any 
) const

Returns the list of selection modes ModeList found in this selector for the selectable object aSelectableObject. Returns true if aSelectableObject is referenced inside this selector; returns false if the object is not present in this selector.

◆ MoveSelectableObject()

void SelectMgr_ViewerSelector::MoveSelectableObject ( const Handle< SelectMgr_SelectableObject > &  theObject)

Moves existing object from set of not transform persistence objects to set of transform persistence objects (or vice versa).

◆ NbPicked()

Standard_Integer SelectMgr_ViewerSelector::NbPicked ( ) const
inline

Returns the number of detected owners.

◆ OnePicked()

Handle< SelectMgr_EntityOwner > SelectMgr_ViewerSelector::OnePicked ( ) const
inline

Returns the picked element with the highest priority, and which is the closest to the last successful mouse position.

◆ Pick() [1/4]

void SelectMgr_ViewerSelector::Pick ( const gp_Ax1 theAxis,
const Handle< V3d_View > &  theView 
)

Picks the sensitive entity according to the input axis. This is geometric intersection 3D objects by axis (camera parameters are ignored and objects with transform persistance are skipped).

◆ Pick() [2/4]

void SelectMgr_ViewerSelector::Pick ( const Standard_Integer  theXPix,
const Standard_Integer  theYPix,
const Handle< V3d_View > &  theView 
)

Picks the sensitive entity at the pixel coordinates of the mouse <theXPix> and <theYPix>. The selector looks for touched areas and owners.

◆ Pick() [3/4]

void SelectMgr_ViewerSelector::Pick ( const Standard_Integer  theXPMin,
const Standard_Integer  theYPMin,
const Standard_Integer  theXPMax,
const Standard_Integer  theYPMax,
const Handle< V3d_View > &  theView 
)

Picks the sensitive entity according to the minimum and maximum pixel values <theXPMin>, <theYPMin>, <theXPMax> and <theYPMax> defining a 2D area for selection in the 3D view aView.

◆ Pick() [4/4]

void SelectMgr_ViewerSelector::Pick ( const TColgp_Array1OfPnt2d thePolyline,
const Handle< V3d_View > &  theView 
)

pick action - input pixel values for polyline selection for selection.

◆ Picked()

Handle< SelectMgr_EntityOwner > SelectMgr_ViewerSelector::Picked ( const Standard_Integer  theRank) const

Returns the entity Owner for the object picked at specified position.

Parameters
theRankrank of detected object within range 1...NbPicked()

◆ PickedData()

const SelectMgr_SortCriterion& SelectMgr_ViewerSelector::PickedData ( const Standard_Integer  theRank) const

Returns the Entity for the object picked at specified position.

Parameters
theRankrank of detected object within range 1...NbPicked()

◆ PickedEntity()

const Handle< Select3D_SensitiveEntity >& SelectMgr_ViewerSelector::PickedEntity ( const Standard_Integer  theRank) const
inline

Returns the Entity for the object picked at specified position.

Parameters
theRankrank of detected object within range 1...NbPicked()

◆ PickedPoint()

gp_Pnt SelectMgr_ViewerSelector::PickedPoint ( const Standard_Integer  theRank) const
inline

Returns the 3D point (intersection of picking axis with the object nearest to eye) for the object picked at specified position.

Parameters
theRankrank of detected object within range 1...NbPicked()

◆ PixelTolerance()

Standard_Integer SelectMgr_ViewerSelector::PixelTolerance ( ) const
inline

Returns the largest pixel tolerance.

◆ QueueBVHBuild()

void SelectMgr_ViewerSelector::QueueBVHBuild ( const Handle< Select3D_SensitiveEntity > &  theEntity)

Queues a sensitive entity to build its BVH.

◆ RebuildObjectsTree()

void SelectMgr_ViewerSelector::RebuildObjectsTree ( const Standard_Boolean  theIsForce = Standard_False)

Marks BVH of selectable objects for rebuild. Parameter theIsForce set as true guarantees that 1st level BVH for the viewer selector will be rebuilt during this call.

◆ RebuildSensitivesTree()

void SelectMgr_ViewerSelector::RebuildSensitivesTree ( const Handle< SelectMgr_SelectableObject > &  theObject,
const Standard_Boolean  theIsForce = Standard_False 
)

Marks BVH of sensitive entities of particular selectable object for rebuild. Parameter theIsForce set as true guarantees that 2nd level BVH for the object given will be rebuilt during this call.

◆ RemovePicked()

Standard_Boolean SelectMgr_ViewerSelector::RemovePicked ( const Handle< SelectMgr_SelectableObject > &  theObject)

Remove picked entities associated with specified object.

◆ RemoveSelectableObject()

void SelectMgr_ViewerSelector::RemoveSelectableObject ( const Handle< SelectMgr_SelectableObject > &  theObject)

Removes selectable object from map of selectable ones.

◆ RemoveSelectionOfObject()

void SelectMgr_ViewerSelector::RemoveSelectionOfObject ( const Handle< SelectMgr_SelectableObject > &  theObject,
const Handle< SelectMgr_Selection > &  theSelection 
)

Removes selection of the object and marks its BVH tree for rebuild.

◆ ResetSelectionActivationStatus()

void SelectMgr_ViewerSelector::ResetSelectionActivationStatus ( )

Marks all added sensitive entities of all objects as non-selectable.

◆ SelectableObjects()

const SelectMgr_SelectableObjectSet& SelectMgr_ViewerSelector::SelectableObjects ( ) const
inline

Return map of selectable objects.

◆ Sensitivity()

Standard_Real SelectMgr_ViewerSelector::Sensitivity ( ) const
inline

Returns the largest sensitivity of picking.

◆ SetDepthTolerance()

void SelectMgr_ViewerSelector::SetDepthTolerance ( SelectMgr_TypeOfDepthTolerance  theType,
Standard_Real  theTolerance 
)
inline

Set the tolerance for considering two entities having a similar depth (distance from eye to entity).

Parameters
theType[in] type of tolerance value
theTolerance[in] tolerance value in 3D scale (SelectMgr_TypeOfDepthTolerance_Uniform) or in pixels (SelectMgr_TypeOfDepthTolerance_UniformPixels); value is ignored in case of SelectMgr_TypeOfDepthTolerance_SensitivityFactor

◆ SetEntitySetBuilder()

void SelectMgr_ViewerSelector::SetEntitySetBuilder ( const Handle< Select3D_BVHBuilder3d > &  theBuilder)

Sets the default builder used to construct BVH of entity set. The new builder will be also assigned for already defined objects, but computed BVH trees will not be invalidated.

◆ SetPickClosest()

void SelectMgr_ViewerSelector::SetPickClosest ( bool  theToPreferClosest)
inline

Set flag determining precedence of picked depth over entity priority in sorted results.

◆ SetPixelTolerance()

void SelectMgr_ViewerSelector::SetPixelTolerance ( const Standard_Integer  theTolerance)

Sets the pixel tolerance <theTolerance>.

◆ SetToPrebuildBVH()

void SelectMgr_ViewerSelector::SetToPrebuildBVH ( Standard_Boolean  theToPrebuild,
Standard_Integer  theThreadsNum = -1 
)

Enables/disables building BVH for sensitives in separate threads.

◆ SortResult()

virtual void SelectMgr_ViewerSelector::SortResult ( ) const
virtual

Sorts the detected entities by priority and distance.

◆ Status() [1/2]

TCollection_AsciiString SelectMgr_ViewerSelector::Status ( const Handle< SelectMgr_SelectableObject > &  theSelectableObject) const

◆ Status() [2/2]

SelectMgr_StateOfSelection SelectMgr_ViewerSelector::Status ( const Handle< SelectMgr_Selection > &  theSelection) const

Returns the selection status Status of the selection aSelection.

◆ ToPickClosest()

bool SelectMgr_ViewerSelector::ToPickClosest ( ) const
inline

Return the flag determining precedence of picked depth (distance from eye to entity) over entity priority in sorted results; TRUE by default. When flag is TRUE, priority will be considered only if entities have the same depth within the tolerance. When flag is FALSE, entities with higher priority will be in front regardless of their depth (like x-ray).

◆ ToPixMap()

Standard_Boolean SelectMgr_ViewerSelector::ToPixMap ( Image_PixMap theImage,
const Handle< V3d_View > &  theView,
const StdSelect_TypeOfSelectionImage  theType,
const Standard_Integer  thePickedIndex = 1 
)

Dump of detection results into image. This method performs axis picking for each pixel in the image and generates a color depending on picking results and selection image type.

Parameters
theImageresult image, should be initialized
theView3D view defining camera position
theTypetype of image to define
thePickedIndexindex of picked entity (1 means topmost)

◆ ToPrebuildBVH()

Standard_Boolean SelectMgr_ViewerSelector::ToPrebuildBVH ( ) const
inline

Returns TRUE if building BVH for sensitives in separate threads is enabled.

◆ traverseObject()

void SelectMgr_ViewerSelector::traverseObject ( const Handle< SelectMgr_SelectableObject > &  theObject,
const SelectMgr_SelectingVolumeManager theMgr,
const Handle< Graphic3d_Camera > &  theCamera,
const Graphic3d_Mat4d theProjectionMat,
const Graphic3d_Mat4d theWorldViewMat,
const Graphic3d_Vec2i theWinSize 
)
protected

Internal function that checks if there is possible overlap between some entity of selectable object theObject and current selecting volume.

Parameters
theObject[in] the selectable object for traversal.
theMgr[in] the (un)transformed copy of the selecting volume manager representing active selection frustum.
theCamera,theProjectionMat,theWorldViewMat[in] the source camera and matrices for theMgr given.
theViewportWidth,theViewportHeight[in] viewport (window) dimensions for evaluating object's transformation persistence.

◆ TraverseSensitives()

void SelectMgr_ViewerSelector::TraverseSensitives ( const Standard_Integer  theViewId = -1)
protected

Traverses BVH containing all added selectable objects and finds candidates for further search of overlap.

◆ updateZLayers()

void SelectMgr_ViewerSelector::updateZLayers ( const Handle< V3d_View > &  theView)
protected

Update z-layers order map.

◆ WaitForBVHBuild()

void SelectMgr_ViewerSelector::WaitForBVHBuild ( )

Waits BVH threads finished building.

Field Documentation

◆ myBVHThreadPool

Handle< SelectMgr_BVHThreadPool > SelectMgr_ViewerSelector::myBVHThreadPool
protected

◆ myCameraDir

gp_Dir SelectMgr_ViewerSelector::myCameraDir
protected

◆ myCameraEye

gp_Pnt SelectMgr_ViewerSelector::myCameraEye
protected

◆ myCameraScale

Standard_Real SelectMgr_ViewerSelector::myCameraScale
protected

◆ myDepthTolerance

Standard_Real SelectMgr_ViewerSelector::myDepthTolerance
protected

◆ myDepthTolType

SelectMgr_TypeOfDepthTolerance SelectMgr_ViewerSelector::myDepthTolType
protected

◆ myEntitySetBuilder

Handle< Select3D_BVHBuilder3d > SelectMgr_ViewerSelector::myEntitySetBuilder
protected

◆ myIndexes

TColStd_Array1OfInteger SelectMgr_ViewerSelector::myIndexes
mutableprotected

◆ myIsLeftChildQueuedFirst

Standard_Boolean SelectMgr_ViewerSelector::myIsLeftChildQueuedFirst
protected

◆ myIsSorted

Standard_Boolean SelectMgr_ViewerSelector::myIsSorted
mutableprotected

◆ myMapOfObjectSensitives

SelectMgr_MapOfObjectSensitives SelectMgr_ViewerSelector::myMapOfObjectSensitives
protected

◆ mySelectableObjects

SelectMgr_SelectableObjectSet SelectMgr_ViewerSelector::mySelectableObjects
mutableprotected

◆ mySelectingVolumeMgr

SelectMgr_SelectingVolumeManager SelectMgr_ViewerSelector::mySelectingVolumeMgr
protected

◆ mystored

SelectMgr_IndexedDataMapOfOwnerCriterion SelectMgr_ViewerSelector::mystored
protected

◆ myStructs

Graphic3d_SequenceOfStructure SelectMgr_ViewerSelector::myStructs
protected

list of debug presentations

◆ myTolerances

SelectMgr_ToleranceMap SelectMgr_ViewerSelector::myTolerances
protected

◆ myToPrebuildBVH

Standard_Boolean SelectMgr_ViewerSelector::myToPrebuildBVH
protected

◆ myToPreferClosest

Standard_Boolean SelectMgr_ViewerSelector::myToPreferClosest
protected

◆ myZLayerOrderMap

NCollection_DataMap<Graphic3d_ZLayerId, Standard_Integer> SelectMgr_ViewerSelector::myZLayerOrderMap
protected

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