Open CASCADE Technology  7.3.1.dev
Public Member Functions | Protected Attributes
MeshVS_MeshOwner Class Reference

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:
Inheritance graph
[legend]

Public Member Functions

 MeshVS_MeshOwner (const SelectMgr_SOPtr &theSelObj, const Handle< MeshVS_DataSource > &theDS, const Standard_Integer thePriority=0)
 
const Handle< MeshVS_DataSource > & GetDataSource () const
 
const Handle< TColStd_HPackedMapOfInteger > & GetSelectedNodes () const
 Returns ids of selected mesh nodes. More...
 
const Handle< TColStd_HPackedMapOfInteger > & GetSelectedElements () const
 Returns ids of selected mesh elements. More...
 
virtual void AddSelectedEntities (const Handle< TColStd_HPackedMapOfInteger > &Nodes, const Handle< TColStd_HPackedMapOfInteger > &Elems)
 Saves ids of selected mesh entities. More...
 
virtual void ClearSelectedEntities ()
 Clears ids of selected mesh entities. More...
 
const Handle< TColStd_HPackedMapOfInteger > & GetDetectedNodes () const
 Returns ids of hilighted mesh nodes. More...
 
const Handle< TColStd_HPackedMapOfInteger > & GetDetectedElements () const
 Returns ids of hilighted mesh elements. More...
 
void SetDetectedEntities (const Handle< TColStd_HPackedMapOfInteger > &Nodes, const Handle< TColStd_HPackedMapOfInteger > &Elems)
 Saves ids of hilighted mesh entities. More...
 
virtual void HilightWithColor (const Handle< PrsMgr_PresentationManager3d > &thePM, const Handle< Prs3d_Drawer > &theColor, const Standard_Integer theMode=0) override
 Highlights selectable object's presentation with mode theMode 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. More...
 
virtual void Unhilight (const Handle< PrsMgr_PresentationManager > &PM, const Standard_Integer 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. More...
 
virtual Standard_Boolean IsForcedHilight () const override
 if this method returns TRUE the owner will allways call method Hilight for SelectableObject when the owner is detected. By default it always return FALSE. More...
 
- Public Member Functions inherited from SelectMgr_EntityOwner
 SelectMgr_EntityOwner (const Standard_Integer aPriority=0)
 Initializes the selection priority aPriority. More...
 
 SelectMgr_EntityOwner (const Handle< SelectMgr_SelectableObject > &aSO, const Standard_Integer aPriority=0)
 Constructs a framework with the selectable object anSO being attributed the selection priority aPriority. More...
 
 SelectMgr_EntityOwner (const Handle< SelectMgr_EntityOwner > &theOwner, const Standard_Integer aPriority=0)
 Constructs a framework from existing one anSO being attributed the selection priority aPriority. More...
 
Standard_Boolean HasSelectable () const
 Returns true if there is a selectable object to serve as an owner. More...
 
virtual Handle< SelectMgr_SelectableObjectSelectable () const
 Returns a selectable object detected in the working context. More...
 
virtual void SetSelectable (const Handle< SelectMgr_SelectableObject > &theSelObj)
 Sets the selectable object. More...
 
virtual Standard_Boolean IsHilighted (const Handle< PrsMgr_PresentationManager > &aPM, const Standard_Integer aMode=0) const
 Returns true if the presentation manager aPM highlights selections corresponding to the selection mode aMode. More...
 
virtual void Clear (const Handle< PrsMgr_PresentationManager > &aPM, const Standard_Integer aMode=0)
 Clears the owners matching the value of the selection mode aMode from the presentation manager object aPM. More...
 
virtual Standard_Boolean HasLocation () const override
 
virtual void SetLocation (const TopLoc_Location &aLoc) override
 
virtual void ResetLocation () override
 
virtual TopLoc_Location Location () const override
 
void SetSelected (const Standard_Boolean theIsSelected)
 Set the state of the owner. More...
 
Standard_Boolean IsSelected () const
 
void State (const Standard_Integer theStatus)
 Set the state of the owner. The method is deprecated. Use SetSelected() instead. More...
 
Standard_Integer State () const
 
virtual Standard_Boolean IsAutoHilight () const
 if owner is not auto hilighted, for group contains many such owners will be called one method HilightSelected of SelectableObject More...
 
virtual void SetZLayer (const Graphic3d_ZLayerId theLayerId)
 Set Z layer ID and update all presentations. More...
 
virtual void UpdateHighlightTrsf (const Handle< V3d_Viewer > &theViewer, const Handle< PrsMgr_PresentationManager3d > &theManager, const Standard_Integer theDispMode)
 Implements immediate application of location transformation of parent object to dynamic highlight structure. More...
 
Standard_Boolean IsSameSelectable (const Handle< SelectMgr_SelectableObject > &theOther) const
 Returns true if pointer to selectable object of this owner is equal to the given one. More...
 
Standard_Boolean ComesFromDecomposition () const
 Returns TRUE if this owner points to a part of object and FALSE for entire object. More...
 
void SetComesFromDecomposition (const Standard_Boolean theIsFromDecomposition)
 Sets flag indicating this owner points to a part of object (TRUE) or to entire object (FALSE). More...
 
void Set (const Handle< SelectMgr_SelectableObject > &theSelObj)
 Sets the selectable object. More...
 
- Public Member Functions inherited from SelectBasics_EntityOwner
void SetPriority (const Standard_Integer thePriority)
 sets the selectable priority of the owner More...
 
Standard_Integer Priority () const
 
void Set (const Standard_Integer thePriority)
 sets the selectable priority of the owner 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 Attributes

Handle< TColStd_HPackedMapOfIntegermySelectedNodes
 
Handle< TColStd_HPackedMapOfIntegermySelectedElems
 
- Protected Attributes inherited from SelectMgr_EntityOwner
SelectMgr_SelectableObjectmySelectable
 raw pointer to selectable object More...
 
Standard_Boolean myIsSelected
 flag indicating selected state More...
 
Standard_Boolean myFromDecomposition
 flag indicating this owner points to a part of object (TRUE) or to entire object (FALSE) More...
 
- Protected Attributes inherited from SelectBasics_EntityOwner
Standard_Integer mypriority
 

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...
 
- Protected Member Functions inherited from SelectBasics_EntityOwner
 SelectBasics_EntityOwner (const Standard_Integer thePriority)
 
 SelectBasics_EntityOwner ()
 

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_SOPtr theSelObj,
const Handle< MeshVS_DataSource > &  theDS,
const Standard_Integer  thePriority = 0 
)

Member Function Documentation

◆ AddSelectedEntities()

virtual void MeshVS_MeshOwner::AddSelectedEntities ( const Handle< TColStd_HPackedMapOfInteger > &  Nodes,
const 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 Handle< MeshVS_DataSource >& MeshVS_MeshOwner::GetDataSource ( ) const

◆ GetDetectedElements()

const Handle< TColStd_HPackedMapOfInteger >& MeshVS_MeshOwner::GetDetectedElements ( ) const

Returns ids of hilighted mesh elements.

◆ GetDetectedNodes()

const Handle< TColStd_HPackedMapOfInteger >& MeshVS_MeshOwner::GetDetectedNodes ( ) const

Returns ids of hilighted mesh nodes.

◆ GetSelectedElements()

const Handle< TColStd_HPackedMapOfInteger >& MeshVS_MeshOwner::GetSelectedElements ( ) const

Returns ids of selected mesh elements.

◆ GetSelectedNodes()

const Handle< TColStd_HPackedMapOfInteger >& MeshVS_MeshOwner::GetSelectedNodes ( ) const

Returns ids of selected mesh nodes.

◆ HilightWithColor()

virtual void MeshVS_MeshOwner::HilightWithColor ( const Handle< PrsMgr_PresentationManager3d > &  thePM,
const Handle< Prs3d_Drawer > &  theStyle,
const Standard_Integer  theMode = 0 
)
overridevirtual

Highlights selectable object's presentation with mode theMode 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()

virtual Standard_Boolean MeshVS_MeshOwner::IsForcedHilight ( ) const
overridevirtual

if this method returns TRUE the owner will allways 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 Handle< TColStd_HPackedMapOfInteger > &  Nodes,
const Handle< TColStd_HPackedMapOfInteger > &  Elems 
)

Saves ids of hilighted mesh entities.

◆ Unhilight()

virtual void MeshVS_MeshOwner::Unhilight ( const Handle< PrsMgr_PresentationManager > &  thePrsMgr,
const Standard_Integer  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
thePrsMgrpresentation manager
theModeobsolete argument for compatibility, should be ignored by implementations

Reimplemented from SelectMgr_EntityOwner.

Field Documentation

◆ mySelectedElems

Handle< TColStd_HPackedMapOfInteger > MeshVS_MeshOwner::mySelectedElems
protected

◆ mySelectedNodes

Handle< TColStd_HPackedMapOfInteger > MeshVS_MeshOwner::mySelectedNodes
protected

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