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 Standard_Integer aPriority)
	Constructs an owner specification framework defined by the priority aPriority. More...

	StdSelect_BRepOwner (const TopoDS_Shape &aShape, const Standard_Integer aPriority=0, const Standard_Boolean ComesFromDecomposition=Standard_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. More...

	StdSelect_BRepOwner (const TopoDS_Shape &aShape, const Handle< SelectMgr_SelectableObject > &theOrigin, const Standard_Integer aPriority=0, const Standard_Boolean FromDecomposition=Standard_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. More...

Standard_Boolean	HasShape () const
	returns False if no shape was set More...

const TopoDS_Shape &	Shape () const
	Returns the shape. More...

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

void	SetHilightMode (const Standard_Integer 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. More...

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

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

virtual Standard_Boolean	IsHilighted (const Handle< PrsMgr_PresentationManager > &aPM, const Standard_Integer aMode=0) const override
	Returns true if an object with the selection mode aMode is highlighted in the presentation manager aPM. More...

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 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 > &aPM, const Standard_Integer aMode=0) override
	Removes highlighting from the type of shape identified the selection mode aMode in the presentation manager aPM. More...

virtual void	Clear (const Handle< PrsMgr_PresentationManager > &aPM, const Standard_Integer aMode=0) override
	Clears the presentation manager object aPM of all shapes with the selection mode aMode. More...

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

virtual void	UpdateHighlightTrsf (const Handle< V3d_Viewer > &theViewer, const Handle< PrsMgr_PresentationManager3d > &theManager, const Standard_Integer theDispMode) override
	Implements immediate application of location transformation of parent object to dynamic highlight structure. More...

virtual void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
	Dumps the content of me into the stream. 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_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_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	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	HasLocation () const
	Returns TRUE if selectable has transformation. More...

virtual TopLoc_Location	Location () const
	Returns transformation of selectable. 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...

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

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
TopoDS_Shape	myShape

Handle< StdSelect_Shape >	myPrsSh

Standard_Integer	myCurMode

Protected Attributes inherited from SelectMgr_EntityOwner
SelectMgr_SelectableObject *	mySelectable
	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

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 Standard_Integer aPriority )

Constructs an owner specification framework defined by the priority aPriority.

◆ StdSelect_BRepOwner() [2/3]

StdSelect_BRepOwner::StdSelect_BRepOwner	(	const TopoDS_Shape &	aShape,
		const Standard_Integer	aPriority = `0`,
		const Standard_Boolean	ComesFromDecomposition = `Standard_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 Handle< SelectMgr_SelectableObject > &	theOrigin,
		const Standard_Integer	aPriority = `0`,
		const Standard_Boolean	FromDecomposition = `Standard_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()

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

overridevirtual

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

Reimplemented from SelectMgr_EntityOwner.

◆ DumpJson()

virtual void StdSelect_BRepOwner::DumpJson	(	Standard_OStream &	theOStream,
		Standard_Integer	theDepth = `-1`
	)		const

overridevirtual

Dumps the content of me into the stream.

Reimplemented from SelectMgr_EntityOwner.

◆ HasHilightMode()

Standard_Boolean StdSelect_BRepOwner::HasHilightMode ( ) const

inline

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

◆ HasShape()

Standard_Boolean StdSelect_BRepOwner::HasShape ( ) const

inline

returns False if no shape was set

◆ HilightMode()

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

virtual void StdSelect_BRepOwner::HilightWithColor	(	const Handle< PrsMgr_PresentationManager3d > &	thePrsMgr,
		const Handle< Prs3d_Drawer > &	theStyle,
		const Standard_Integer	theMode = `0`
	)

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

virtual Standard_Boolean StdSelect_BRepOwner::IsHilighted	(	const Handle< PrsMgr_PresentationManager > &	aPM,
		const Standard_Integer	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 Standard_Integer 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()

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

virtual void StdSelect_BRepOwner::Unhilight	(	const Handle< PrsMgr_PresentationManager > &	aPM,
		const Standard_Integer	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()

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

overridevirtual

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

Reimplemented from SelectMgr_EntityOwner.

Field Documentation

◆ myCurMode

Standard_Integer StdSelect_BRepOwner::myCurMode

protected

◆ myPrsSh

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