Open CASCADE Technology Reference Manual 8.0.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes
AIS_ManipulatorOwner Class Reference

Entity owner for selection management of AIS_Manipulator object. More...

#include <AIS_ManipulatorOwner.hxx>

Inheritance diagram for AIS_ManipulatorOwner:
Inheritance graph
[legend]

Public Member Functions

 AIS_ManipulatorOwner (const occ::handle< SelectMgr_SelectableObject > &theSelObject, const int theIndex, const AIS_ManipulatorMode theMode, const int thePriority=0)
 
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.
 
bool IsHilighted (const occ::handle< PrsMgr_PresentationManager > &thePM, const int theMode) const override
 Returns true if the presentation manager highlights selections corresponding to the selection mode.
 
void Unhilight (const occ::handle< PrsMgr_PresentationManager > &thePM, const int theMode) override
 Removes highlighting from the owner of a detected selectable object in the presentation manager. This object could be the owner of a sensitive primitive.
 
AIS_ManipulatorMode Mode () const
 
int Index () const
 
- 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_SelectableObjectSelectable () 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 void Clear (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr, const int theMode=0)
 Clears the owners matching the value of the selection mode aMode from the presentation manager object aPM.
 
virtual bool HasLocation () const
 Returns TRUE if selectable has transformation.
 
virtual TopLoc_Location Location () const
 Returns transformation of selectable.
 
virtual void SetLocation (const TopLoc_Location &theLocation)
 Change owner location (callback for handling change of location of selectable object).
 
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.
 
virtual void UpdateHighlightTrsf (const occ::handle< V3d_Viewer > &theViewer, const occ::handle< PrsMgr_PresentationManager > &theManager, const int theDispMode)
 Implements immediate application of location transformation of parent object to dynamic highlight structure.
 
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).
 
virtual void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
 Dumps the content of me into the stream.
 
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_Transientoperator= (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_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.
 
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

int myIndex
 index of manipulator axis.
 
AIS_ManipulatorMode myMode
 manipulation (highlight) mode.
 
- Protected Attributes inherited from SelectMgr_EntityOwner
SelectMgr_SelectableObjectmySelectable
 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 charget_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

Entity owner for selection management of AIS_Manipulator object.

Constructor & Destructor Documentation

◆ AIS_ManipulatorOwner()

AIS_ManipulatorOwner::AIS_ManipulatorOwner ( const occ::handle< SelectMgr_SelectableObject > & theSelObject,
const int theIndex,
const AIS_ManipulatorMode theMode,
const int thePriority = 0 )

Member Function Documentation

◆ HilightWithColor()

void AIS_ManipulatorOwner::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.

◆ Index()

int AIS_ManipulatorOwner::Index ( ) const
inline
Returns
index of manipulator axis.

◆ IsHilighted()

bool AIS_ManipulatorOwner::IsHilighted ( const occ::handle< PrsMgr_PresentationManager > & thePrsMgr,
const int theMode ) const
overridevirtual

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

Reimplemented from SelectMgr_EntityOwner.

◆ Mode()

AIS_ManipulatorMode AIS_ManipulatorOwner::Mode ( ) const
inline

◆ Unhilight()

void AIS_ManipulatorOwner::Unhilight ( const occ::handle< PrsMgr_PresentationManager > & thePrsMgr,
const int theMode )
overridevirtual

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

Field Documentation

◆ myIndex

int AIS_ManipulatorOwner::myIndex
protected

index of manipulator axis.

◆ myMode

AIS_ManipulatorMode AIS_ManipulatorOwner::myMode
protected

manipulation (highlight) mode.


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