Defines Specific Owners for Sensitive Primitives (Sensitive Segments,Circles...). Used in Dynamic Selection Mechanism. A BRepOwner has an Owner (the shape it represents) and Users (One or More Transient entities). The highlight-unhighlight methods are empty and must be redefined by each User. More...

#include <StdSelect_BRepOwner.hxx>

Inheritance diagram for StdSelect_BRepOwner:

[legend]

Public Member Functions
	StdSelect_BRepOwner (const int aPriority)
	Constructs an owner specification framework defined by the priority aPriority.

	StdSelect_BRepOwner (const TopoDS_Shape &aShape, const int aPriority=0, const bool ComesFromDecomposition=false)
	Constructs an owner specification framework defined by the shape aShape and the priority aPriority. aShape and aPriority are stored in this framework. If more than one owner are detected during dynamic selection, the one with the highest priority is the one stored.

	StdSelect_BRepOwner (const TopoDS_Shape &aShape, const occ::handle< SelectMgr_SelectableObject > &theOrigin, const int aPriority=0, const bool FromDecomposition=false)
	Constructs an owner specification framework defined by the shape aShape, the selectable object theOrigin and the priority aPriority. aShape, theOrigin and aPriority are stored in this framework. If more than one owner are detected during dynamic selection, the one with the highest priority is the one stored.

bool	HasShape () const
	returns False if no shape was set

const TopoDS_Shape &	Shape () const
	Returns the shape.

bool	HasHilightMode () const
	Returns true if this framework has a highlight mode defined for it.

void	SetHilightMode (const int theMode)
	Sets the highlight mode for this framework. This defines the type of display used to highlight the owner of the shape when it is detected by the selector. The default type of display is wireframe, defined by the index 0.

void	ResetHilightMode ()
	Resets the higlight mode for this framework. This defines the type of display used to highlight the owner of the shape when it is detected by the selector. The default type of display is wireframe, defined by the index 0.

int	HilightMode () const
	Returns the highlight mode for this framework. This defines the type of display used to highlight the owner of the shape when it is detected by the selector. The default type of display is wireframe, defined by the index 0.

bool	IsHilighted (const occ::handle< PrsMgr_PresentationManager > &aPM, const int aMode=0) const override
	Returns true if an object with the selection mode aMode is highlighted in the presentation manager aPM.

void	HilightWithColor (const occ::handle< PrsMgr_PresentationManager > &thePM, const occ::handle< Prs3d_Drawer > &theStyle, const int theMode) override
	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.

void	Unhilight (const occ::handle< PrsMgr_PresentationManager > &aPM, const int aMode=0) override
	Removes highlighting from the type of shape identified the selection mode aMode in the presentation manager aPM.

void	Clear (const occ::handle< PrsMgr_PresentationManager > &aPM, const int aMode=0) override
	Clears the presentation manager object aPM of all shapes with the selection mode aMode.

void	SetLocation (const TopLoc_Location &aLoc) override
	Change owner location (callback for handling change of location of selectable object).

void	UpdateHighlightTrsf (const occ::handle< V3d_Viewer > &theViewer, const occ::handle< PrsMgr_PresentationManager > &theManager, const int theDispMode) override
	Implements immediate application of location transformation of parent object to dynamic highlight structure.

void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
	Dumps the content of me into the stream.

Public Member Functions inherited from SelectMgr_EntityOwner
	SelectMgr_EntityOwner (const int aPriority=0)
	Initializes the selection priority aPriority.

	SelectMgr_EntityOwner (const occ::handle< SelectMgr_SelectableObject > &aSO, const int aPriority=0)
	Constructs a framework with the selectable object anSO being attributed the selection priority aPriority.

	SelectMgr_EntityOwner (const occ::handle< SelectMgr_EntityOwner > &theOwner, const int aPriority=0)
	Constructs a framework from existing one anSO being attributed the selection priority aPriority.

int	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 (int thePriority)
	Sets the selectable priority of the owner within range [0-9].

bool	HasSelectable () const
	Returns true if there is a selectable object to serve as an owner.

virtual occ::handle< SelectMgr_SelectableObject >	Selectable () const
	Returns a selectable object detected in the working context.

virtual void	SetSelectable (const occ::handle< SelectMgr_SelectableObject > &theSelObj)
	Sets the selectable object.

virtual bool	HandleMouseClick (const NCollection_Vec2< int > &thePoint, Aspect_VKeyMouse theButton, Aspect_VKeyFlags theModifiers, bool theIsDoubleClick)
	Handle mouse button click event. Does nothing by default and returns FALSE.

virtual bool	HasLocation () const
	Returns TRUE if selectable has transformation.

virtual TopLoc_Location	Location () const
	Returns transformation of selectable.

bool	IsSelected () const

void	SetSelected (const bool theIsSelected)
	Set the state of the owner.

bool	Select (const AIS_SelectionScheme theSelScheme, const bool theIsDetected) const
	If the object needs to be selected, it returns true.

int	State () const
	Returns selection state.

void	State (const int theStatus)
	Set the state of the owner. The method is deprecated. Use SetSelected() instead.

virtual bool	IsAutoHilight () const
	if owner is not auto hilighted, for group contains many such owners will be called one method HilightSelected of SelectableObject

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

bool	IsSameSelectable (const occ::handle< SelectMgr_SelectableObject > &theOther) const
	Returns true if pointer to selectable object of this owner is equal to the given one.

bool	ComesFromDecomposition () const
	Returns TRUE if this owner points to a part of object and FALSE for entire object.

void	SetComesFromDecomposition (const bool theIsFromDecomposition)
	Sets flag indicating this owner points to a part of object (TRUE) or to entire object (FALSE).

void	Set (const occ::handle< SelectMgr_SelectableObject > &theSelObj)
	Sets the selectable object.

void	Set (const int 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 ()=default
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

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

bool	IsKind (const char *const 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.

int	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Attributes
TopoDS_Shape	myShape

occ::handle< StdSelect_Shape >	myPrsSh

int	myCurMode

Protected Attributes inherited from SelectMgr_EntityOwner
SelectMgr_SelectableObject *	mySelectable
	raw pointer to selectable object

int	mypriority
	selection priority (for result with the same depth)

bool	myIsSelected
	flag indicating selected state

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

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.

Detailed Description

Defines Specific Owners for Sensitive Primitives (Sensitive Segments,Circles...). Used in Dynamic Selection Mechanism. A BRepOwner has an Owner (the shape it represents) and Users (One or More Transient entities). The highlight-unhighlight methods are empty and must be redefined by each User.

Constructor & Destructor Documentation

◆ StdSelect_BRepOwner() [1/3]

StdSelect_BRepOwner::StdSelect_BRepOwner ( const int aPriority )

Constructs an owner specification framework defined by the priority aPriority.

◆ StdSelect_BRepOwner() [2/3]

StdSelect_BRepOwner::StdSelect_BRepOwner	(	const TopoDS_Shape &	aShape,
		const int	aPriority = 0,
		const bool	ComesFromDecomposition = false )

Constructs an owner specification framework defined by the shape aShape and the priority aPriority. aShape and aPriority are stored in this framework. If more than one owner are detected during dynamic selection, the one with the highest priority is the one stored.

◆ StdSelect_BRepOwner() [3/3]

StdSelect_BRepOwner::StdSelect_BRepOwner	(	const TopoDS_Shape &	aShape,
		const occ::handle< SelectMgr_SelectableObject > &	theOrigin,
		const int	aPriority = 0,
		const bool	FromDecomposition = false )

Constructs an owner specification framework defined by the shape aShape, the selectable object theOrigin and the priority aPriority. aShape, theOrigin and aPriority are stored in this framework. If more than one owner are detected during dynamic selection, the one with the highest priority is the one stored.

Member Function Documentation

◆ Clear()

void StdSelect_BRepOwner::Clear	(	const occ::handle< PrsMgr_PresentationManager > &	aPM,
		const int	aMode = 0 )

overridevirtual

Clears the presentation manager object aPM of all shapes with the selection mode aMode.

Reimplemented from SelectMgr_EntityOwner.

◆ DumpJson()

void StdSelect_BRepOwner::DumpJson	(	Standard_OStream &	theOStream,
		int	theDepth = -1 ) const

overridevirtual

Dumps the content of me into the stream.

Reimplemented from SelectMgr_EntityOwner.

◆ HasHilightMode()

bool StdSelect_BRepOwner::HasHilightMode ( ) const

inline

Returns true if this framework has a highlight mode defined for it.

◆ HasShape()

bool StdSelect_BRepOwner::HasShape ( ) const

inline

returns False if no shape was set

◆ HilightMode()

int StdSelect_BRepOwner::HilightMode ( ) const

inline

Returns the highlight mode for this framework. This defines the type of display used to highlight the owner of the shape when it is detected by the selector. The default type of display is wireframe, defined by the index 0.

◆ HilightWithColor()

void StdSelect_BRepOwner::HilightWithColor	(	const occ::handle< PrsMgr_PresentationManager > &	thePrsMgr,
		const occ::handle< Prs3d_Drawer > &	theStyle,
		const int	theMode )

overridevirtual

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

◆ IsHilighted()

bool StdSelect_BRepOwner::IsHilighted	(	const occ::handle< PrsMgr_PresentationManager > &	aPM,
		const int	aMode = 0 ) const

overridevirtual

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

Reimplemented from SelectMgr_EntityOwner.

◆ ResetHilightMode()

void StdSelect_BRepOwner::ResetHilightMode ( )

inline

Resets the higlight mode for this framework. This defines the type of display used to highlight the owner of the shape when it is detected by the selector. The default type of display is wireframe, defined by the index 0.

◆ SetHilightMode()

void StdSelect_BRepOwner::SetHilightMode ( const int theMode )

inline

Sets the highlight mode for this framework. This defines the type of display used to highlight the owner of the shape when it is detected by the selector. The default type of display is wireframe, defined by the index 0.

◆ SetLocation()

void StdSelect_BRepOwner::SetLocation ( const TopLoc_Location & theLocation )

overridevirtual

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

Reimplemented from SelectMgr_EntityOwner.

◆ Shape()

const TopoDS_Shape & StdSelect_BRepOwner::Shape ( ) const

inline

Returns the shape.

◆ Unhilight()

void StdSelect_BRepOwner::Unhilight	(	const occ::handle< PrsMgr_PresentationManager > &	aPM,
		const int	aMode = 0 )

overridevirtual

Removes highlighting from the type of shape identified the selection mode aMode in the presentation manager aPM.

Reimplemented from SelectMgr_EntityOwner.

◆ UpdateHighlightTrsf()

void StdSelect_BRepOwner::UpdateHighlightTrsf	(	const occ::handle< V3d_Viewer > &	theViewer,
		const occ::handle< PrsMgr_PresentationManager > &	theManager,
		const int	theDispMode )

overridevirtual

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

Reimplemented from SelectMgr_EntityOwner.

Field Documentation

◆ myCurMode

int StdSelect_BRepOwner::myCurMode

protected

◆ myPrsSh

occ::handle<StdSelect_Shape> StdSelect_BRepOwner::myPrsSh

protected

◆ myShape

TopoDS_Shape StdSelect_BRepOwner::myShape

protected

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

StdSelect_BRepOwner.hxx

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StdSelect_BRepOwner() [1/3]

◆ StdSelect_BRepOwner() [2/3]

◆ StdSelect_BRepOwner() [3/3]

Member Function Documentation

◆ Clear()

◆ DumpJson()

◆ HasHilightMode()

◆ HasShape()

◆ HilightMode()

◆ HilightWithColor()

◆ IsHilighted()

◆ ResetHilightMode()

◆ SetHilightMode()

◆ SetLocation()

◆ Shape()

◆ Unhilight()

◆ UpdateHighlightTrsf()

Field Documentation

◆ myCurMode

◆ myPrsSh

◆ myShape