The custom mesh owner used for advanced mesh selection. This class provides methods to store information: 1) IDs of hilighted mesh nodes and elements 2) IDs of mesh nodes and elements selected on the mesh. More...

#include <MeshVS_MeshOwner.hxx>

Inheritance diagram for MeshVS_MeshOwner:

[legend]

Public Member Functions
	MeshVS_MeshOwner (const SelectMgr_SelectableObject *theSelObj, const occ::handle< MeshVS_DataSource > &theDS, const int thePriority=0)

const occ::handle< MeshVS_DataSource > &	GetDataSource () const

const occ::handle< TColStd_HPackedMapOfInteger > &	GetSelectedNodes () const
	Returns ids of selected mesh nodes.

const occ::handle< TColStd_HPackedMapOfInteger > &	GetSelectedElements () const
	Returns ids of selected mesh elements.

virtual void	AddSelectedEntities (const occ::handle< TColStd_HPackedMapOfInteger > &Nodes, const occ::handle< TColStd_HPackedMapOfInteger > &Elems)
	Saves ids of selected mesh entities.

virtual void	ClearSelectedEntities ()
	Clears ids of selected mesh entities.

const occ::handle< TColStd_HPackedMapOfInteger > &	GetDetectedNodes () const
	Returns ids of hilighted mesh nodes.

const occ::handle< TColStd_HPackedMapOfInteger > &	GetDetectedElements () const
	Returns ids of hilighted mesh elements.

void	SetDetectedEntities (const occ::handle< TColStd_HPackedMapOfInteger > &Nodes, const occ::handle< TColStd_HPackedMapOfInteger > &Elems)
	Saves ids of hilighted mesh entities.

void	HilightWithColor (const occ::handle< PrsMgr_PresentationManager > &thePM, const occ::handle< Prs3d_Drawer > &theColor, const int theMode) override
	Highlights selectable object's presentation with display mode in presentation manager with given highlight style. Also a check for auto-highlight is performed - if selectable object manages highlighting on its own, execution will be passed to SelectMgr_SelectableObject::HilightOwnerWithColor method.

void	Unhilight (const occ::handle< PrsMgr_PresentationManager > &PM, const int Mode=0) override
	Removes highlighting from the owner of a detected selectable object in the presentation manager. This object could be the owner of a sensitive primitive.

bool	IsForcedHilight () const override
	if this method returns TRUE the owner will always call method Hilight for SelectableObject when the owner is detected. By default it always return FALSE.

Public Member Functions inherited from SelectMgr_EntityOwner
	SelectMgr_EntityOwner (const int aPriority=0)
	Initializes the selection priority aPriority.

	SelectMgr_EntityOwner (const occ::handle< SelectMgr_SelectableObject > &aSO, const int aPriority=0)
	Constructs a framework with the selectable object anSO being attributed the selection priority aPriority.

	SelectMgr_EntityOwner (const occ::handle< SelectMgr_EntityOwner > &theOwner, const int aPriority=0)
	Constructs a framework from existing one anSO being attributed the selection priority aPriority.

int	Priority () const
	Return selection priority (within range [0-9]) for results with the same depth; 0 by default. Example - selection of shapes: the owners are selectable objects (presentations) a user can give vertex priority [3], edges [2] faces [1] shape [0], so that if during selection one vertex one edge and one face are simultaneously detected, the vertex will only be hilighted.

void	SetPriority (int thePriority)
	Sets the selectable priority of the owner within range [0-9].

bool	HasSelectable () const
	Returns true if there is a selectable object to serve as an owner.

virtual occ::handle< SelectMgr_SelectableObject >	Selectable () const
	Returns a selectable object detected in the working context.

virtual void	SetSelectable (const occ::handle< SelectMgr_SelectableObject > &theSelObj)
	Sets the selectable object.

virtual bool	HandleMouseClick (const NCollection_Vec2< int > &thePoint, Aspect_VKeyMouse theButton, Aspect_VKeyFlags theModifiers, bool theIsDoubleClick)
	Handle mouse button click event. Does nothing by default and returns FALSE.

virtual bool	IsHilighted (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr, const int theMode=0) const
	Returns true if the presentation manager highlights selections corresponding to the selection mode.

virtual void	Clear (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr, const int theMode=0)
	Clears the owners matching the value of the selection mode aMode from the presentation manager object aPM.

virtual bool	HasLocation () const
	Returns TRUE if selectable has transformation.

virtual TopLoc_Location	Location () const
	Returns transformation of selectable.

virtual void	SetLocation (const TopLoc_Location &theLocation)
	Change owner location (callback for handling change of location of selectable object).

bool	IsSelected () const

void	SetSelected (const bool theIsSelected)
	Set the state of the owner.

bool	Select (const AIS_SelectionScheme theSelScheme, const bool theIsDetected) const
	If the object needs to be selected, it returns true.

int	State () const
	Returns selection state.

void	State (const int theStatus)
	Set the state of the owner. The method is deprecated. Use SetSelected() instead.

virtual bool	IsAutoHilight () const
	if owner is not auto hilighted, for group contains many such owners will be called one method HilightSelected of SelectableObject

virtual void	SetZLayer (const Graphic3d_ZLayerId theLayerId)
	Set Z layer ID and update all presentations.

virtual void	UpdateHighlightTrsf (const occ::handle< V3d_Viewer > &theViewer, const occ::handle< PrsMgr_PresentationManager > &theManager, const int theDispMode)
	Implements immediate application of location transformation of parent object to dynamic highlight structure.

bool	IsSameSelectable (const occ::handle< SelectMgr_SelectableObject > &theOther) const
	Returns true if pointer to selectable object of this owner is equal to the given one.

bool	ComesFromDecomposition () const
	Returns TRUE if this owner points to a part of object and FALSE for entire object.

void	SetComesFromDecomposition (const bool theIsFromDecomposition)
	Sets flag indicating this owner points to a part of object (TRUE) or to entire object (FALSE).

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

void	Set (const occ::handle< SelectMgr_SelectableObject > &theSelObj)
	Sets the selectable object.

void	Set (const int thePriority)
	sets the selectable priority of the owner

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.

Protected Attributes
occ::handle< TColStd_HPackedMapOfInteger >	mySelectedNodes

occ::handle< TColStd_HPackedMapOfInteger >	mySelectedElems

Protected Attributes inherited from SelectMgr_EntityOwner
SelectMgr_SelectableObject *	mySelectable
	raw pointer to selectable object

int	mypriority
	selection priority (for result with the same depth)

bool	myIsSelected
	flag indicating selected state

bool	myFromDecomposition
	flag indicating this owner points to a part of object (TRUE) or to entire object (FALSE)

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

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.

Detailed Description

The custom mesh owner used for advanced mesh selection. This class provides methods to store information: 1) IDs of hilighted mesh nodes and elements 2) IDs of mesh nodes and elements selected on the mesh.

Constructor & Destructor Documentation

◆ MeshVS_MeshOwner()

MeshVS_MeshOwner::MeshVS_MeshOwner	(	const SelectMgr_SelectableObject *	theSelObj,
		const occ::handle< MeshVS_DataSource > &	theDS,
		const int	thePriority = 0 )

Member Function Documentation

◆ AddSelectedEntities()

virtual void MeshVS_MeshOwner::AddSelectedEntities	(	const occ::handle< TColStd_HPackedMapOfInteger > &	Nodes,
		const occ::handle< TColStd_HPackedMapOfInteger > &	Elems )

virtual

Saves ids of selected mesh entities.

◆ ClearSelectedEntities()

virtual void MeshVS_MeshOwner::ClearSelectedEntities ( )

virtual

Clears ids of selected mesh entities.

◆ GetDataSource()

const occ::handle< MeshVS_DataSource > & MeshVS_MeshOwner::GetDataSource ( ) const

◆ GetDetectedElements()

const occ::handle< TColStd_HPackedMapOfInteger > & MeshVS_MeshOwner::GetDetectedElements ( ) const

Returns ids of hilighted mesh elements.

◆ GetDetectedNodes()

const occ::handle< TColStd_HPackedMapOfInteger > & MeshVS_MeshOwner::GetDetectedNodes ( ) const

Returns ids of hilighted mesh nodes.

◆ GetSelectedElements()

const occ::handle< TColStd_HPackedMapOfInteger > & MeshVS_MeshOwner::GetSelectedElements ( ) const

Returns ids of selected mesh elements.

◆ GetSelectedNodes()

const occ::handle< TColStd_HPackedMapOfInteger > & MeshVS_MeshOwner::GetSelectedNodes ( ) const

Returns ids of selected mesh nodes.

◆ HilightWithColor()

void MeshVS_MeshOwner::HilightWithColor	(	const occ::handle< PrsMgr_PresentationManager > &	thePrsMgr,
		const occ::handle< Prs3d_Drawer > &	theStyle,
		const int	theMode )

overridevirtual

Highlights selectable object's presentation with display mode in presentation manager with given highlight style. Also a check for auto-highlight is performed - if selectable object manages highlighting on its own, execution will be passed to SelectMgr_SelectableObject::HilightOwnerWithColor method.

Reimplemented from SelectMgr_EntityOwner.

◆ IsForcedHilight()

bool MeshVS_MeshOwner::IsForcedHilight ( ) const

overridevirtual

if this method returns TRUE the owner will always call method Hilight for SelectableObject when the owner is detected. By default it always return FALSE.

Reimplemented from SelectMgr_EntityOwner.

◆ SetDetectedEntities()

void MeshVS_MeshOwner::SetDetectedEntities	(	const occ::handle< TColStd_HPackedMapOfInteger > &	Nodes,
		const occ::handle< TColStd_HPackedMapOfInteger > &	Elems )

Saves ids of hilighted mesh entities.

◆ Unhilight()

void MeshVS_MeshOwner::Unhilight	(	const occ::handle< PrsMgr_PresentationManager > &	thePrsMgr,
		const int	theMode = 0 )

overridevirtual

Removes highlighting from the owner of a detected selectable object in the presentation manager. This object could be the owner of a sensitive primitive.

Parameters

thePrsMgr	presentation manager
theMode	obsolete argument for compatibility, should be ignored by implementations

Reimplemented from SelectMgr_EntityOwner.

Field Documentation

◆ mySelectedElems

occ::handle<TColStd_HPackedMapOfInteger> MeshVS_MeshOwner::mySelectedElems

protected

◆ mySelectedNodes

occ::handle<TColStd_HPackedMapOfInteger> MeshVS_MeshOwner::mySelectedNodes

protected

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

MeshVS_MeshOwner.hxx

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MeshVS_MeshOwner()

Member Function Documentation

◆ AddSelectedEntities()

◆ ClearSelectedEntities()

◆ GetDataSource()

◆ GetDetectedElements()

◆ GetDetectedNodes()

◆ GetSelectedElements()

◆ GetSelectedNodes()

◆ HilightWithColor()

◆ IsForcedHilight()

◆ SetDetectedEntities()

◆ Unhilight()

Field Documentation

◆ mySelectedElems

◆ mySelectedNodes