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:
Public Member Functions | |
| MeshVS_MeshEntityOwner (const SelectMgr_SelectableObject *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. | |
| MeshVS_EntityType | Type () const |
| Returns type of element or node data structure. | |
| Standard_Integer | ID () const |
| Returns ID of element or node data structure. | |
| Standard_Boolean | IsGroup () const |
| Returns true if owner represents group of nodes or elements. | |
| virtual Standard_Boolean | IsHilighted (const Handle< PrsMgr_PresentationManager > &PM, const Standard_Integer Mode=0) const override |
| Returns true if owner is hilighted. | |
| virtual void | HilightWithColor (const Handle< PrsMgr_PresentationManager > &thePM, const Handle< Prs3d_Drawer > &theStyle, const Standard_Integer theMode) override |
| Hilights owner with the certain color. | |
| virtual void | Unhilight (const Handle< PrsMgr_PresentationManager > &PM, const Standard_Integer Mode=0) override |
| Strip hilight of owner. | |
| 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. | |
 Public Member Functions inherited from SelectMgr_EntityOwner | |
| SelectMgr_EntityOwner (const Standard_Integer aPriority=0) | |
| Initializes the selection priority aPriority. | |
| 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. | |
| 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. | |
| 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. | |
| void | SetPriority (Standard_Integer thePriority) |
| Sets the selectable priority of the owner within range [0-9]. | |
| Standard_Boolean | HasSelectable () const |
| Returns true if there is a selectable object to serve as an owner. | |
| virtual Handle< SelectMgr_SelectableObject > | Selectable () const |
| Returns a selectable object detected in the working context. | |
| virtual void | SetSelectable (const Handle< SelectMgr_SelectableObject > &theSelObj) |
| Sets the selectable object. | |
| 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. | |
| virtual Standard_Boolean | 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). | |
| Standard_Boolean | IsSelected () const |
| void | SetSelected (const Standard_Boolean theIsSelected) |
| Set the state of the owner. | |
| Standard_Boolean | Select (const AIS_SelectionScheme theSelScheme, const Standard_Boolean theIsDetected) const |
| If the object needs to be selected, it returns true. | |
| Standard_Integer | State () const |
| Returns selection state. | |
| void | State (const Standard_Integer theStatus) |
| Set the state of the owner. The method is deprecated. Use SetSelected() instead. | |
| 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 | |
| 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. | |
| virtual void | SetZLayer (const Graphic3d_ZLayerId theLayerId) |
| Set Z layer ID and update all presentations. | |
| 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. | |
| 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. | |
| Standard_Boolean | ComesFromDecomposition () const |
| Returns TRUE if this owner points to a part of object and FALSE for entire object. | |
| void | SetComesFromDecomposition (const Standard_Boolean theIsFromDecomposition) |
| Sets flag indicating this owner points to a part of object (TRUE) or to entire object (FALSE). | |
| virtual void | DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const |
| Dumps the content of me into the stream. | |
| void | Set (const Handle< SelectMgr_SelectableObject > &theSelObj) |
| Sets the selectable object. | |
| void | Set (const Standard_Integer 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 () |
| Destructor must be virtual. | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. | |
| 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. | |
| 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. | |
| 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. | |
| Standard_Integer | GetRefCount () const noexcept |
| Get the reference counter of this object. | |
| void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object. | |
| Standard_Integer | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value. | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. | |
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. | |
| Protected Attributes inherited from SelectMgr_EntityOwner | |
| SelectMgr_SelectableObject * | mySelectable |
| raw pointer to selectable object | |
| Standard_Integer | mypriority |
| selection priority (for result with the same depth) | |
| Standard_Boolean | myIsSelected |
| flag indicating selected state | |
| Standard_Boolean | myFromDecomposition |
| flag indicating this owner points to a part of object (TRUE) or to entire object (FALSE) | |
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_SelectableObject * | 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()
|
overridevirtual |
Clears the owners matching the value of the selection mode aMode from the presentation manager object aPM.
TODO
Reimplemented from SelectMgr_EntityOwner.
◆ HilightWithColor()
|
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()
|
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()
|
overridevirtual |
Strip hilight of owner.
Reimplemented from SelectMgr_EntityOwner.
The documentation for this class was generated from the following file:
