Open CASCADE Technology  6.9.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
 Returns true if owner is hilighted. More...
 
virtual void Hilight ()
 Hilights owner. More...
 
virtual void Hilight (const Handle< PrsMgr_PresentationManager > &PM, const Standard_Integer Mode=0)
 Hilights owner. More...
 
virtual void HilightWithColor (const Handle< PrsMgr_PresentationManager3d > &PM, const Quantity_NameOfColor theColor, const Standard_Integer Mode=0)
 Hilights owner with the certain color. More...
 
virtual void Unhilight (const Handle< PrsMgr_PresentationManager > &PM, const Standard_Integer Mode=0)
 Strip hilight of owner. More...
 
virtual void Clear (const Handle< PrsMgr_PresentationManager > &PM, const Standard_Integer Mode=0)
 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_Boolean HasSelectable () const
 Returns true if there is a selectable object to serve as an owner. More...
 
virtual Handle
< SelectMgr_SelectableObject
Selectable () const
 Returns a selectable object detected in the working context. More...
 
void Set (const Handle< SelectMgr_SelectableObject > &aSO)
 Sets the selectable object anSO to be used by the second constructor above. More...
 
virtual Standard_Boolean HasLocation () const
 
virtual void SetLocation (const TopLoc_Location &aLoc)
 
virtual void ResetLocation ()
 
virtual TopLoc_Location Location () const
 
void SetSelected (const Standard_Boolean theIsSelected)
 Set the state of the owner. More...
 
Standard_Boolean IsSelected () const
 
void State (const Standard_Integer aStatus)
 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 Standard_Boolean IsForcedHilight () const
 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...
 
virtual void SetZLayer (const Graphic3d_ZLayerId theLayerId)
 Set Z layer ID and update all presentations. More...
 
- Public Member Functions inherited from SelectBasics_EntityOwner
void Set (const Standard_Integer aPriority)
 sets the selectable priority of the owner More...
 
Standard_Integer Priority () const
 
- Public Member Functions inherited from MMgt_TShared
virtual void Delete () const
 Memory deallocator for transient classes. 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 const
Handle_Standard_Type & 
DynamicType () const
 Returns a type information object about this object. More...
 
Standard_Boolean IsInstance (const 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 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...
 
virtual Handle_Standard_Transient This () const
 Returns a Handle which references this object. Must never be called to objects created in stack. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 

Additional Inherited Members

- Protected Member Functions inherited from SelectBasics_EntityOwner
 SelectBasics_EntityOwner (const Standard_Integer aPriority=0)
 
- Protected Attributes inherited from SelectBasics_EntityOwner
Standard_Integer mypriority
 

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 ( 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

virtual void MeshVS_MeshEntityOwner::Clear ( const Handle< PrsMgr_PresentationManager > &  aPM,
const Standard_Integer  aMode = 0 
)
virtual

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

Reimplemented from SelectMgr_EntityOwner.

virtual void MeshVS_MeshEntityOwner::Hilight ( )
virtual

Hilights owner.

Reimplemented from SelectMgr_EntityOwner.

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

Hilights owner.

Reimplemented from SelectMgr_EntityOwner.

virtual void MeshVS_MeshEntityOwner::HilightWithColor ( const Handle< PrsMgr_PresentationManager3d > &  PM,
const Quantity_NameOfColor  theColor,
const Standard_Integer  Mode = 0 
)
virtual

Hilights owner with the certain color.

Reimplemented from SelectMgr_EntityOwner.

Standard_Integer MeshVS_MeshEntityOwner::ID ( ) const

Returns ID of element or node data structure.

Standard_Boolean MeshVS_MeshEntityOwner::IsGroup ( ) const

Returns true if owner represents group of nodes or elements.

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

Returns true if owner is hilighted.

Reimplemented from SelectMgr_EntityOwner.

Standard_Address MeshVS_MeshEntityOwner::Owner ( ) const

Returns an address of element or node data structure.

MeshVS_EntityType MeshVS_MeshEntityOwner::Type ( ) const

Returns type of element or node data structure.

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

Strip hilight of owner.

Reimplemented from SelectMgr_EntityOwner.


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