Class that implements OCCT selection algorithm. More...

#include <IVtkOCC_ViewerSelector.hxx>

Inheritance diagram for IVtkOCC_ViewerSelector:

[legend]

Public Member Functions
	IVtkOCC_ViewerSelector ()

	~IVtkOCC_ViewerSelector () override

void	Pick (const int theXPix, const int theYPix, const IVtk_IView::Handle &theView)
	Implements point picking.

void	Pick (const int theXMin, const int theYMin, const int theXMax, const int theYMax, const IVtk_IView::Handle &theView)
	Picking by rectangle.

void	Pick (double **thePoly, const int theNbPoints, const IVtk_IView::Handle &theView)
	Implements point picking.

void	Activate (const occ::handle< SelectMgr_Selection > &theSelection)
	Activates the given selection.

void	Deactivate (const occ::handle< SelectMgr_Selection > &theSelection)
	Deactivate the given selection.

Public Member Functions inherited from SelectMgr_ViewerSelector
	SelectMgr_ViewerSelector ()
	Constructs an empty selector object.

int	CustomPixelTolerance () const
	Returns custom pixel tolerance value.

void	SetPixelTolerance (const int theTolerance)
	Sets the pixel tolerance <theTolerance>.

double	Sensitivity () const
	Returns the largest sensitivity of picking.

int	PixelTolerance () const
	Returns the largest pixel tolerance.

virtual void	SortResult () const
	Sorts the detected entities by priority and distance.

occ::handle< SelectMgr_EntityOwner >	OnePicked () const
	Returns the picked element with the highest priority, and which is the closest to the last successful mouse position.

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).

void	SetPickClosest (bool theToPreferClosest)
	Set flag determining precedence of picked depth over entity priority in sorted results.

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.

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

void	SetDepthTolerance (SelectMgr_TypeOfDepthTolerance theType, double theTolerance)
	Set the tolerance for considering two entities having a similar depth (distance from eye to entity).

int	NbPicked () const
	Returns the number of detected owners.

void	ClearPicked ()
	Clears picking results.

void	Clear ()
	Empties all the tables, removes all selections...

occ::handle< SelectMgr_EntityOwner >	Picked (const int theRank) const
	Returns the entity Owner for the object picked at specified position.

const SelectMgr_SortCriterion &	PickedData (const int theRank) const
	Returns the Entity for the object picked at specified position.

const occ::handle< Select3D_SensitiveEntity > &	PickedEntity (const int theRank) const
	Returns the Entity for the object picked at specified position.

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

bool	RemovePicked (const occ::handle< SelectMgr_SelectableObject > &theObject)
	Remove picked entities associated with specified object.

bool	Contains (const occ::handle< SelectMgr_SelectableObject > &theObject) const

const occ::handle< Select3D_BVHBuilder3d >	EntitySetBuilder ()
	Returns the default builder used to construct BVH of entity set.

void	SetEntitySetBuilder (const occ::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.

bool	Modes (const occ::handle< SelectMgr_SelectableObject > &theSelectableObject, NCollection_List< int > &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.

bool	IsActive (const occ::handle< SelectMgr_SelectableObject > &theSelectableObject, const int theMode) const
	Returns true if the selectable object aSelectableObject having the selection mode aMode is active in this selector.

bool	IsInside (const occ::handle< SelectMgr_SelectableObject > &theSelectableObject, const int theMode) const
	Returns true if the selectable object aSelectableObject having the selection mode aMode is in this selector.

SelectMgr_StateOfSelection	Status (const occ::handle< SelectMgr_Selection > &theSelection) const
	Returns the selection status Status of the selection aSelection.

TCollection_AsciiString	Status (const occ::handle< SelectMgr_SelectableObject > &theSelectableObject) const

void	ActiveOwners (NCollection_List< occ::handle< SelectMgr_EntityOwner > > &theOwners) const
	Returns the list of active entity owners.

void	AddSelectableObject (const occ::handle< SelectMgr_SelectableObject > &theObject)
	Adds new object to the map of selectable objects.

void	AddSelectionToObject (const occ::handle< SelectMgr_SelectableObject > &theObject, const occ::handle< SelectMgr_Selection > &theSelection)
	Adds new selection to the object and builds its BVH tree.

void	MoveSelectableObject (const occ::handle< SelectMgr_SelectableObject > &theObject)
	Moves existing object from set of not transform persistence objects to set of transform persistence objects (or vice versa).

void	RemoveSelectableObject (const occ::handle< SelectMgr_SelectableObject > &theObject)
	Removes selectable object from map of selectable ones.

void	RemoveSelectionOfObject (const occ::handle< SelectMgr_SelectableObject > &theObject, const occ::handle< SelectMgr_Selection > &theSelection)
	Removes selection of the object and marks its BVH tree for rebuild.

void	RebuildObjectsTree (const bool theIsForce=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.

void	RebuildSensitivesTree (const occ::handle< SelectMgr_SelectableObject > &theObject, const bool theIsForce=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.

SelectMgr_SelectingVolumeManager &	GetManager ()
	Returns instance of selecting volume manager of the viewer selector.

const SelectMgr_SelectableObjectSet &	SelectableObjects () const
	Return map of selectable objects.

void	ResetSelectionActivationStatus ()
	Marks all added sensitive entities of all objects as non-selectable.

void	AllowOverlapDetection (const bool 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.

void	Pick (const int theXPix, const int theYPix, const occ::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.

void	Pick (const int theXPMin, const int theYPMin, const int theXPMax, const int theYPMax, const occ::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.

void	Pick (const NCollection_Array1< gp_Pnt2d > &thePolyline, const occ::handle< V3d_View > &theView)
	pick action - input pixel values for polyline selection for selection.

void	Pick (const gp_Ax1 &theAxis, const occ::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 persistence are skipped).

bool	ToPixMap (Image_PixMap &theImage, const occ::handle< V3d_View > &theView, const StdSelect_TypeOfSelectionImage theType, const int 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.

void	DisplaySensitive (const occ::handle< V3d_View > &theView)
	Displays sensitives in view <theView>.

void	ClearSensitive (const occ::handle< V3d_View > &theView)

void	DisplaySensitive (const occ::handle< SelectMgr_Selection > &theSel, const gp_Trsf &theTrsf, const occ::handle< V3d_View > &theView, const bool theToClearOthers=true)

void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
	Dumps the content of me into the stream.

void	SetToPrebuildBVH (bool theToPrebuild, int theThreadsNum=-1)
	Enables/disables building BVH for sensitives in separate threads.

void	QueueBVHBuild (const occ::handle< Select3D_SensitiveEntity > &theEntity)
	Queues a sensitive entity to build its BVH.

void	WaitForBVHBuild ()
	Waits BVH threads finished building.

bool	ToPrebuildBVH () const
	Returns TRUE if building BVH for sensitives in separate threads is enabled.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()=default
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

bool	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.

bool	IsKind (const char *const 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.

Standard_Transient *	This () 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.

int	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

virtual void	Delete () const
	Memory deallocator for transient classes.

Static Public Member Functions
static occ::handle< Graphic3d_Camera >	ConvertVtkToOccCamera (const IVtk_IView::Handle &theView)
	Converts VTK camera defined for input view to OCC camera.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Protected Member Functions inherited from SelectMgr_ViewerSelector
void	TraverseSensitives (const int theViewId=-1)
	Traverses BVH containing all added selectable objects and finds candidates for further search of overlap.

void	traverseObject (const occ::handle< SelectMgr_SelectableObject > &theObject, const SelectMgr_SelectingVolumeManager &theMgr, const occ::handle< Graphic3d_Camera > &theCamera, const NCollection_Mat4< double > &theProjectionMat, const NCollection_Mat4< double > &theWorldViewMat, const NCollection_Vec2< int > &theWinSize)
	Internal function that checks if there is possible overlap between some entity of selectable object theObject and current selecting volume.

void	checkOverlap (const occ::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.

void	updateZLayers (const occ::handle< V3d_View > &theView)
	Update z-layers order map.

Protected Attributes inherited from SelectMgr_ViewerSelector
double	myDepthTolerance

SelectMgr_TypeOfDepthTolerance	myDepthTolType

bool	myToPreferClosest

NCollection_IndexedDataMap< occ::handle< SelectMgr_EntityOwner >, SelectMgr_SortCriterion >	mystored

SelectMgr_SelectingVolumeManager	mySelectingVolumeMgr

SelectMgr_SelectableObjectSet	mySelectableObjects

SelectMgr_ToleranceMap	myTolerances

NCollection_DataMap< Graphic3d_ZLayerId, int >	myZLayerOrderMap

occ::handle< Select3D_BVHBuilder3d >	myEntitySetBuilder

gp_Pnt	myCameraEye

gp_Dir	myCameraDir

double	myCameraScale

bool	myToPrebuildBVH

occ::handle< SelectMgr_BVHThreadPool >	myBVHThreadPool

NCollection_Array1< int >	myIndexes

bool	myIsSorted

bool	myIsLeftChildQueuedFirst

NCollection_DataMap< occ::handle< SelectMgr_SelectableObject >, occ::handle< SelectMgr_SensitiveEntitySet > >	myMapOfObjectSensitives

NCollection_Sequence< occ::handle< Graphic3d_Structure > >	myStructs
	list of debug presentations

Detailed Description

Class that implements OCCT selection algorithm.

Inspired by StdSelect_ViewerSelector3d class from OCCT 6.5.1

Constructor & Destructor Documentation

◆ IVtkOCC_ViewerSelector()

IVtkOCC_ViewerSelector::IVtkOCC_ViewerSelector ( )

◆ ~IVtkOCC_ViewerSelector()

IVtkOCC_ViewerSelector::~IVtkOCC_ViewerSelector ( )

override

Member Function Documentation

◆ Activate()

void IVtkOCC_ViewerSelector::Activate ( const occ::handle< SelectMgr_Selection > & theSelection )

Activates the given selection.

◆ ConvertVtkToOccCamera()

static occ::handle< Graphic3d_Camera > IVtkOCC_ViewerSelector::ConvertVtkToOccCamera ( const IVtk_IView::Handle & theView )

static

Converts VTK camera defined for input view to OCC camera.

◆ Deactivate()

void IVtkOCC_ViewerSelector::Deactivate ( const occ::handle< SelectMgr_Selection > & theSelection )

Deactivate the given selection.

◆ Pick() [1/3]

void IVtkOCC_ViewerSelector::Pick	(	const int	theXMin,
		const int	theYMin,
		const int	theXMax,
		const int	theYMax,
		const IVtk_IView::Handle &	theView )

Picking by rectangle.

Parameters

[in]	theXMin,theYMin,theXMax,theYMax	Rectangle coords
[in]	theView	ICamera interface to calculate projections

◆ Pick() [2/3]

void IVtkOCC_ViewerSelector::Pick	(	const int	theXPix,
		const int	theYPix,
		const IVtk_IView::Handle &	theView )

Implements point picking.