Open CASCADE Technology  7.6.0.dev
Public Member Functions | Protected Attributes

SelectMgr_EntityOwner Class Reference

A framework to define classes of owners of sensitive primitives. The owner is the link between application and selection data structures. For the application to make its own objects selectable, it must define owner classes inheriting this framework. More...

#include <SelectMgr_EntityOwner.hxx>

Inheritance diagram for SelectMgr_EntityOwner:
Inheritance graph
[legend]

Public Member Functions

 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 IsHilighted (const Handle< PrsMgr_PresentationManager > &thePrsMgr, const Standard_Integer theMode=0) const
 Returns true if the presentation manager highlights selections corresponding to the selection mode. More...
 
virtual void HilightWithColor (const Handle< PrsMgr_PresentationManager > &thePrsMgr, const Handle< Prs3d_Drawer > &theStyle, const Standard_Integer theMode=0)
 Highlights selectable object's presentation with display mode 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 > &thePrsMgr, const Standard_Integer theMode=0)
 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 void Clear (const Handle< PrsMgr_PresentationManager > &thePrsMgr, const Standard_Integer theMode=0)
 Clears the owners matching the value of the selection mode aMode from the presentation manager object aPM. 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, 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...
 

Protected Attributes

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

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

Detailed Description

A framework to define classes of owners of sensitive primitives. The owner is the link between application and selection data structures. For the application to make its own objects selectable, it must define owner classes inheriting this framework.

Constructor & Destructor Documentation

◆ SelectMgr_EntityOwner() [1/3]

SelectMgr_EntityOwner::SelectMgr_EntityOwner ( const Standard_Integer  aPriority = 0)

Initializes the selection priority aPriority.

◆ SelectMgr_EntityOwner() [2/3]

SelectMgr_EntityOwner::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() [3/3]

SelectMgr_EntityOwner::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.

Member Function Documentation

◆ Clear()

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

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

TODO

Reimplemented in AIS_PointCloudOwner, MeshVS_MeshEntityOwner, and StdSelect_BRepOwner.

◆ ComesFromDecomposition()

Standard_Boolean SelectMgr_EntityOwner::ComesFromDecomposition ( ) const
inline

Returns TRUE if this owner points to a part of object and FALSE for entire object.

◆ DumpJson()

virtual void SelectMgr_EntityOwner::DumpJson ( Standard_OStream theOStream,
Standard_Integer  theDepth = -1 
) const
virtual

Dumps the content of me into the stream.

Reimplemented in StdSelect_BRepOwner.

◆ HandleMouseClick()

virtual Standard_Boolean SelectMgr_EntityOwner::HandleMouseClick ( const Graphic3d_Vec2i thePoint,
Aspect_VKeyMouse  theButton,
Aspect_VKeyFlags  theModifiers,
bool  theIsDoubleClick 
)
inlinevirtual

Handle mouse button click event. Does nothing by default and returns FALSE.

Parameters
thePointmouse cursor position
theButtonclicked button
theModifierskey modifiers
theIsDoubleClickflag indicating double mouse click
Returns
TRUE if object handled click

Reimplemented in AIS_ViewCubeOwner, and AIS_LightSourceOwner.

◆ HasLocation()

virtual Standard_Boolean SelectMgr_EntityOwner::HasLocation ( ) const
inlinevirtual

Returns TRUE if selectable has transformation.

◆ HasSelectable()

Standard_Boolean SelectMgr_EntityOwner::HasSelectable ( ) const
inline

Returns true if there is a selectable object to serve as an owner.

◆ HilightWithColor()

virtual void SelectMgr_EntityOwner::HilightWithColor ( const Handle< PrsMgr_PresentationManager > &  thePrsMgr,
const Handle< Prs3d_Drawer > &  theStyle,
const Standard_Integer  theMode = 0 
)
virtual

Highlights selectable object's presentation with display mode 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 in AIS_PointCloudOwner, StdSelect_BRepOwner, PrsDim_DimensionOwner, MeshVS_MeshEntityOwner, AIS_TrihedronOwner, AIS_ManipulatorOwner, and MeshVS_MeshOwner.

◆ IsAutoHilight()

virtual Standard_Boolean SelectMgr_EntityOwner::IsAutoHilight ( ) const
inlinevirtual

if owner is not auto hilighted, for group contains many such owners will be called one method HilightSelected of SelectableObject

◆ IsForcedHilight()

virtual Standard_Boolean SelectMgr_EntityOwner::IsForcedHilight ( ) const
inlinevirtual

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.

Reimplemented in MeshVS_MeshOwner, AIS_ViewCubeOwner, and AIS_PointCloudOwner.

◆ IsHilighted()

virtual Standard_Boolean SelectMgr_EntityOwner::IsHilighted ( const Handle< PrsMgr_PresentationManager > &  thePrsMgr,
const Standard_Integer  theMode = 0 
) const
inlinevirtual

Returns true if the presentation manager highlights selections corresponding to the selection mode.

Reimplemented in PrsDim_DimensionOwner, AIS_TrihedronOwner, AIS_ManipulatorOwner, MeshVS_MeshEntityOwner, and StdSelect_BRepOwner.

◆ IsSameSelectable()

Standard_Boolean SelectMgr_EntityOwner::IsSameSelectable ( const Handle< SelectMgr_SelectableObject > &  theOther) const
inline

Returns true if pointer to selectable object of this owner is equal to the given one.

◆ IsSelected()

Standard_Boolean SelectMgr_EntityOwner::IsSelected ( ) const
inline
Returns
Standard_True if the owner is selected.

◆ Location()

virtual TopLoc_Location SelectMgr_EntityOwner::Location ( ) const
inlinevirtual

Returns transformation of selectable.

◆ Priority()

Standard_Integer SelectMgr_EntityOwner::Priority ( ) const
inline

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.

◆ Selectable()

virtual Handle< SelectMgr_SelectableObject > SelectMgr_EntityOwner::Selectable ( ) const
inlinevirtual

Returns a selectable object detected in the working context.

◆ Set() [1/2]

void SelectMgr_EntityOwner::Set ( const Handle< SelectMgr_SelectableObject > &  theSelObj)
inline

Sets the selectable object.

Deprecated:
("Deprecated method - SetSelectable() should be used instead")

◆ Set() [2/2]

void SelectMgr_EntityOwner::Set ( const Standard_Integer  thePriority)
inline

sets the selectable priority of the owner

Deprecated:
("Deprecated method - SetPriority() should be used instead")

◆ SetComesFromDecomposition()

void SelectMgr_EntityOwner::SetComesFromDecomposition ( const Standard_Boolean  theIsFromDecomposition)
inline

Sets flag indicating this owner points to a part of object (TRUE) or to entire object (FALSE).

◆ SetLocation()

virtual void SelectMgr_EntityOwner::SetLocation ( const TopLoc_Location theLocation)
inlinevirtual

Change owner location (callback for handling change of location of selectable object).

Reimplemented in StdSelect_BRepOwner.

◆ SetPriority()

void SelectMgr_EntityOwner::SetPriority ( Standard_Integer  thePriority)
inline

Sets the selectable priority of the owner within range [0-9].

◆ SetSelectable()

virtual void SelectMgr_EntityOwner::SetSelectable ( const Handle< SelectMgr_SelectableObject > &  theSelObj)
inlinevirtual

Sets the selectable object.

◆ SetSelected()

void SelectMgr_EntityOwner::SetSelected ( const Standard_Boolean  theIsSelected)
inline

Set the state of the owner.

Parameters
theIsSelected[in] shows if owner is selected.

◆ SetZLayer()

virtual void SelectMgr_EntityOwner::SetZLayer ( const Graphic3d_ZLayerId  theLayerId)
inlinevirtual

Set Z layer ID and update all presentations.

◆ State() [1/2]

Standard_Integer SelectMgr_EntityOwner::State ( ) const
inline

Returns selection state.

Deprecated:
("Deprecated method - IsSelected() should be used instead")

◆ State() [2/2]

void SelectMgr_EntityOwner::State ( const Standard_Integer  theStatus)
inline

Set the state of the owner. The method is deprecated. Use SetSelected() instead.

◆ Unhilight()

virtual void SelectMgr_EntityOwner::Unhilight ( const Handle< PrsMgr_PresentationManager > &  thePrsMgr,
const Standard_Integer  theMode = 0 
)
inlinevirtual

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 in AIS_PointCloudOwner, PrsDim_DimensionOwner, AIS_TrihedronOwner, AIS_ManipulatorOwner, MeshVS_MeshOwner, MeshVS_MeshEntityOwner, and StdSelect_BRepOwner.

◆ UpdateHighlightTrsf()

virtual void SelectMgr_EntityOwner::UpdateHighlightTrsf ( const Handle< V3d_Viewer > &  theViewer,
const Handle< PrsMgr_PresentationManager > &  theManager,
const Standard_Integer  theDispMode 
)
inlinevirtual

Implements immediate application of location transformation of parent object to dynamic highlight structure.

Reimplemented in StdSelect_BRepOwner.

Field Documentation

◆ myFromDecomposition

Standard_Boolean SelectMgr_EntityOwner::myFromDecomposition
protected

flag indicating this owner points to a part of object (TRUE) or to entire object (FALSE)

◆ myIsSelected

Standard_Boolean SelectMgr_EntityOwner::myIsSelected
protected

flag indicating selected state

◆ mypriority

Standard_Integer SelectMgr_EntityOwner::mypriority
protected

selection priority (for result with the same depth)

◆ mySelectable

SelectMgr_SelectableObject* SelectMgr_EntityOwner::mySelectable
protected

raw pointer to selectable object


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