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:

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

virtual void	SetSelectable (const Handle< SelectMgr_SelectableObject > &theSelObj)
	Sets the selectable object. More...

virtual Standard_Boolean	IsHilighted (const Handle< PrsMgr_PresentationManager > &aPM, const Standard_Integer aMode=0) const
	Returns true if the presentation manager aPM highlights selections corresponding to the selection mode aMode. More...

virtual void	HilightWithColor (const Handle< PrsMgr_PresentationManager3d > &thePM, const Handle< Prs3d_Drawer > &theStyle, const Standard_Integer theMode=0)
	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 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 > &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_Transient &	operator= (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_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. 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_SelectableObject *	mySelectable
	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

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)

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 > &	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 in StdSelect_BRepOwner, and MeshVS_MeshEntityOwner.

◆ ComesFromDecomposition()

Standard_Boolean SelectMgr_EntityOwner::ComesFromDecomposition ( ) const

inline

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

◆ HasLocation()

virtual Standard_Boolean SelectMgr_EntityOwner::HasLocation ( ) const

overridevirtual

Implements SelectBasics_EntityOwner.

◆ 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_PresentationManager3d > &	thePM,
		const Handle< Prs3d_Drawer > &	theStyle,
		const Standard_Integer	theMode = `0`
	)

virtual

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

◆ IsAutoHilight()

virtual Standard_Boolean SelectMgr_EntityOwner::IsAutoHilight ( ) const

virtual

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

virtual

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.

Reimplemented in MeshVS_MeshOwner.

◆ IsHilighted()

virtual Standard_Boolean SelectMgr_EntityOwner::IsHilighted	(	const Handle< PrsMgr_PresentationManager > &	aPM,
		const Standard_Integer	aMode = `0`
	)		const

virtual

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

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

◆ 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

overridevirtual

Implements SelectBasics_EntityOwner.

◆ ResetLocation()

virtual void SelectMgr_EntityOwner::ResetLocation ( )

overridevirtual

Implements SelectBasics_EntityOwner.

Reimplemented in StdSelect_BRepOwner.

◆ Selectable()

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

virtual

Returns a selectable object detected in the working context.

◆ Set()

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

inline

Sets the selectable object.

◆ 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 & aLoc )

overridevirtual

Implements SelectBasics_EntityOwner.

Reimplemented in StdSelect_BRepOwner.

◆ SetSelectable()

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

virtual

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 )

virtual

Set Z layer ID and update all presentations.

◆ State() [1/2]

void SelectMgr_EntityOwner::State ( const Standard_Integer theStatus )

inline

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

◆ State() [2/2]

Standard_Integer SelectMgr_EntityOwner::State ( ) const

inline

◆ Unhilight()

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

virtual

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

thePrsMgr	presentation manager
theMode	obsolete argument for compatibility, should be ignored by implementations

Reimplemented in StdSelect_BRepOwner, MeshVS_MeshOwner, MeshVS_MeshEntityOwner, AIS_DimensionOwner, AIS_TrihedronOwner, and AIS_ManipulatorOwner.

◆ UpdateHighlightTrsf()

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

virtual

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

◆ mySelectable

SelectMgr_SelectableObject* SelectMgr_EntityOwner::mySelectable

protected

raw pointer to selectable object

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

SelectMgr_EntityOwner.hxx

SelectMgr_EntityOwner Class Reference

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SelectMgr_EntityOwner() [1/3]

◆ SelectMgr_EntityOwner() [2/3]

◆ SelectMgr_EntityOwner() [3/3]

Member Function Documentation

◆ Clear()

◆ ComesFromDecomposition()

◆ HasLocation()

◆ HasSelectable()

◆ HilightWithColor()

◆ IsAutoHilight()

◆ IsForcedHilight()

◆ IsHilighted()

◆ IsSameSelectable()

◆ IsSelected()

◆ Location()

◆ ResetLocation()

◆ Selectable()

◆ Set()

◆ SetComesFromDecomposition()

◆ SetLocation()

◆ SetSelectable()

◆ SetSelected()

◆ SetZLayer()

◆ State() [1/2]

◆ State() [2/2]

◆ Unhilight()

◆ UpdateHighlightTrsf()

Field Documentation

◆ myFromDecomposition

◆ myIsSelected

◆ mySelectable