Open CASCADE Technology  7.3.0
Public Member Functions

AIS_DimensionOwner Class Reference

The owner is the entity which makes it possible to link the sensitive primitives and the reference shapes that you want to detect. It stocks the various pieces of information which make it possible to find objects. An owner has a priority which you can modulate, so as to make one entity more selectable than another. You might want to make edges more selectable than faces, for example. In that case, you could attribute sa higher priority to the one compared to the other. An edge, could have priority 5, for example, and a face, priority 4. The default priority is 5. More...

#include <AIS_DimensionOwner.hxx>

Inheritance diagram for AIS_DimensionOwner:
Inheritance graph
[legend]

Public Member Functions

 AIS_DimensionOwner (const Handle< SelectMgr_SelectableObject > &theSelObject, const AIS_DimensionSelectionMode theSelMode, const Standard_Integer thePriority=0)
 Initializes the dimension owner, theSO, and attributes it the priority, thePriority. More...
 
AIS_DimensionSelectionMode SelectionMode () const
 
virtual void HilightWithColor (const Handle< PrsMgr_PresentationManager3d > &thePM, const Handle< Prs3d_Drawer > &theStyle, 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 Standard_Boolean IsHilighted (const Handle< PrsMgr_PresentationManager > &thePM, const Standard_Integer theMode=0) const override
 Returns true if an object with the selection mode aMode is highlighted in the presentation manager aPM. More...
 
virtual void Unhilight (const Handle< PrsMgr_PresentationManager > &thePM, const Standard_Integer theMode=0) override
 Removes highlighting from the selected part of dimension. 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 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 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...
 
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...
 

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=0)
 
- 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
 

Detailed Description

The owner is the entity which makes it possible to link the sensitive primitives and the reference shapes that you want to detect. It stocks the various pieces of information which make it possible to find objects. An owner has a priority which you can modulate, so as to make one entity more selectable than another. You might want to make edges more selectable than faces, for example. In that case, you could attribute sa higher priority to the one compared to the other. An edge, could have priority 5, for example, and a face, priority 4. The default priority is 5.

Constructor & Destructor Documentation

◆ AIS_DimensionOwner()

AIS_DimensionOwner::AIS_DimensionOwner ( const Handle< SelectMgr_SelectableObject > &  theSelObject,
const AIS_DimensionSelectionMode  theSelMode,
const Standard_Integer  thePriority = 0 
)

Initializes the dimension owner, theSO, and attributes it the priority, thePriority.

Member Function Documentation

◆ HilightWithColor()

virtual void AIS_DimensionOwner::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.

◆ IsHilighted()

virtual Standard_Boolean AIS_DimensionOwner::IsHilighted ( const Handle< PrsMgr_PresentationManager > &  thePM,
const Standard_Integer  theMode = 0 
) const
overridevirtual

Returns true if an object with the selection mode aMode is highlighted in the presentation manager aPM.

Reimplemented from SelectMgr_EntityOwner.

◆ SelectionMode()

AIS_DimensionSelectionMode AIS_DimensionOwner::SelectionMode ( ) const

◆ Unhilight()

virtual void AIS_DimensionOwner::Unhilight ( const Handle< PrsMgr_PresentationManager > &  thePM,
const Standard_Integer  theMode = 0 
)
overridevirtual

Removes highlighting from the selected part of dimension.

Reimplemented from SelectMgr_EntityOwner.


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