Open CASCADE Technology  7.4.0
Public Member Functions

MeshVS_MeshEntityOwner Class Reference

The custom owner. This class provides methods to store owner information: 1) An address of element or node data structure 2) Type of node or element owner assigned 3) ID of node or element owner assigned. More...

#include <MeshVS_MeshEntityOwner.hxx>

Inheritance diagram for MeshVS_MeshEntityOwner:
Inheritance graph
[legend]

Public Member Functions

 MeshVS_MeshEntityOwner (const SelectMgr_SOPtr &SelObj, const Standard_Integer ID, const Standard_Address MeshEntity, const MeshVS_EntityType &Type, const Standard_Integer Priority=0, const Standard_Boolean IsGroup=Standard_False)
 
Standard_Address Owner () const
 Returns an address of element or node data structure. More...
 
MeshVS_EntityType Type () const
 Returns type of element or node data structure. More...
 
Standard_Integer ID () const
 Returns ID of element or node data structure. More...
 
Standard_Boolean IsGroup () const
 Returns true if owner represents group of nodes or elements. More...
 
virtual Standard_Boolean IsHilighted (const Handle< PrsMgr_PresentationManager > &PM, const Standard_Integer Mode=0) const override
 Returns true if owner is hilighted. More...
 
virtual void HilightWithColor (const Handle< PrsMgr_PresentationManager3d > &thePM, const Handle< Prs3d_Drawer > &theStyle, const Standard_Integer theMode=0) override
 Hilights owner with the certain color. More...
 
virtual void Unhilight (const Handle< PrsMgr_PresentationManager > &PM, const Standard_Integer Mode=0) override
 Strip hilight of owner. More...
 
virtual void Clear (const Handle< PrsMgr_PresentationManager > &PM, const Standard_Integer Mode=0) override
 Clears the owners matching the value of the selection mode aMode from the presentation manager object aPM. 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_Integer 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. More...
 
void SetPriority (Standard_Integer thePriority)
 Sets the selectable priority of the owner within range [0-9]. 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 HandleMouseClick (const Graphic3d_Vec2i &thePoint, Aspect_VKeyMouse theButton, Aspect_VKeyFlags theModifiers, bool theIsDoubleClick)
 Handle mouse button click event. Does nothing by default and returns FALSE. More...
 
virtual Standard_Boolean HasLocation () const
 Returns TRUE if selectable has transformation. More...
 
virtual TopLoc_Location Location () const
 Returns transformation of selectable. More...
 
virtual void SetLocation (const TopLoc_Location &theLocation)
 Change owner location (callback for handling change of location of selectable object). More...
 
Standard_Boolean IsSelected () const
 
void SetSelected (const Standard_Boolean theIsSelected)
 Set the state of the owner. More...
 
Standard_Integer State () const
 Returns selection state. More...
 
void State (const Standard_Integer theStatus)
 Set the state of the owner. The method is deprecated. Use SetSelected() instead. More...
 
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 Standard_Boolean IsForcedHilight () const
 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. 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_PresentationManager > &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...
 
virtual void DumpJson (Standard_OStream &theOStream, const Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream. More...
 
void Set (const Handle< SelectMgr_SelectableObject > &theSelObj)
 Sets the selectable object. More...
 
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...
 

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 Attributes inherited from SelectMgr_EntityOwner
SelectMgr_SelectableObjectmySelectable
 raw pointer to selectable object More...
 
Standard_Integer mypriority
 selection priority (for result with the same depth) 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...
 

Detailed Description

The custom owner. This class provides methods to store owner information: 1) An address of element or node data structure 2) Type of node or element owner assigned 3) ID of node or element owner assigned.

Constructor & Destructor Documentation

◆ MeshVS_MeshEntityOwner()

MeshVS_MeshEntityOwner::MeshVS_MeshEntityOwner ( const SelectMgr_SOPtr SelObj,
const Standard_Integer  ID,
const Standard_Address  MeshEntity,
const MeshVS_EntityType Type,
const Standard_Integer  Priority = 0,
const Standard_Boolean  IsGroup = Standard_False 
)

Member Function Documentation

◆ Clear()

virtual void MeshVS_MeshEntityOwner::Clear ( const Handle< PrsMgr_PresentationManager > &  thePrsMgr,
const Standard_Integer  theMode = 0 
)
overridevirtual

Clears the owners matching the value of the selection mode aMode from the presentation manager object aPM.

TODO

Reimplemented from SelectMgr_EntityOwner.

◆ HilightWithColor()

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

Hilights owner with the certain color.

Reimplemented from SelectMgr_EntityOwner.

◆ ID()

Standard_Integer MeshVS_MeshEntityOwner::ID ( ) const

Returns ID of element or node data structure.

◆ IsGroup()

Standard_Boolean MeshVS_MeshEntityOwner::IsGroup ( ) const

Returns true if owner represents group of nodes or elements.

◆ IsHilighted()

virtual Standard_Boolean MeshVS_MeshEntityOwner::IsHilighted ( const Handle< PrsMgr_PresentationManager > &  PM,
const Standard_Integer  Mode = 0 
) const
overridevirtual

Returns true if owner is hilighted.

Reimplemented from SelectMgr_EntityOwner.

◆ Owner()

Standard_Address MeshVS_MeshEntityOwner::Owner ( ) const

Returns an address of element or node data structure.

◆ Type()

MeshVS_EntityType MeshVS_MeshEntityOwner::Type ( ) const

Returns type of element or node data structure.

◆ Unhilight()

virtual void MeshVS_MeshEntityOwner::Unhilight ( const Handle< PrsMgr_PresentationManager > &  PM,
const Standard_Integer  Mode = 0 
)
overridevirtual

Strip hilight of owner.

Reimplemented from SelectMgr_EntityOwner.


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