Open CASCADE Technology 6.6.0
Public Member Functions
SelectMgr_SelectionManager Class Reference

A framework to manage selection from the point of
view of viewer selectors. These can be added and
removed, and selection modes can be activated and
deactivated. In addition, objects may be known to all
selectors or only to some.

#include <SelectMgr_SelectionManager.hxx>

Inheritance diagram for SelectMgr_SelectionManager:
Inheritance graph
[legend]

Public Member Functions

 SelectMgr_SelectionManager ()
 Constructs an empty selection manager object.

void Add (const Handle< SelectMgr_ViewerSelector > &aSelector)
 Adds the viewer selector aSelector to this framework.

void Remove (const Handle< SelectMgr_ViewerSelector > &aSelector)
Standard_Boolean Contains (const Handle< SelectMgr_ViewerSelector > &aSelector) const
 Returns true if this framework contains the viewer selector aSelector.

Standard_Boolean Contains (const Handle< SelectMgr_SelectableObject > &aSelectableObject) const
 Returns true if this framework contains the
selectable object aSelectableObject.

void Load (const Handle< SelectMgr_SelectableObject > &anObject, const Standard_Integer aMode=-1)
 Loads and computes one mode of
selection if <aMode> notequal -1 ;
if <anObject> already has a
selection with this mode, it's emptied and the sensitive
entities are computed for this mode else one Selection
is created with this mode before computing.

void Load (const Handle< SelectMgr_SelectableObject > &anObject, const Handle< SelectMgr_ViewerSelector > &aSelector, const Standard_Integer aMode=-1)
 Local object available for
<aSelector> Only. the sensitive entities for selection
of mode <aMode> are computed if <aMode> not equal -1.
if <aMode> =-1 oc compute is done

void Remove (const Handle< SelectMgr_SelectableObject > &anObject)
 removes the object from All the ViewerSelectors where it was;

void Remove (const Handle< SelectMgr_SelectableObject > &anObject, const Handle< SelectMgr_ViewerSelector > &aSelector)
 removes the object from aSelector;

void Activate (const Handle< SelectMgr_SelectableObject > &anObject, const Standard_Integer aMode=0, const Standard_Boolean AutomaticProj=Standard_True)
 Activates the selection mode aMode in a selector
for the selectable object anObject.

void Activate (const Handle< SelectMgr_SelectableObject > &anObject, const Standard_Integer aMode, const Handle< SelectMgr_ViewerSelector > &aSelector, const Standard_Boolean AutomaticProj=Standard_True)
 Activates the selection mode aMode in the selector
aSelector for the selectable object anObject.

void Deactivate (const Handle< SelectMgr_SelectableObject > &anObject)
 Deactivate all the activated modes in any
Selector for <anObject>

void Deactivate (const Handle< SelectMgr_SelectableObject > &anObject, const Standard_Integer aMode)
 Deactivates the Mode <aMode> in every Selector where
it was activated

void Deactivate (const Handle< SelectMgr_SelectableObject > &anObject, const Standard_Integer aMode, const Handle< SelectMgr_ViewerSelector > &aSelector)
 Deactivates the selection mode aMode in the
selector aSelector for the selectable object anObject.

void Deactivate (const Handle< SelectMgr_SelectableObject > &anObject, const Handle< SelectMgr_ViewerSelector > &aSelector)
 Deactivates all selection modes in the selector
aSelector for the selectable object anObject.

void Sleep (const Handle< SelectMgr_ViewerSelector > &aSelector)
 Ensures that no object in the selector aSelector will be active.

void Sleep (const Handle< SelectMgr_SelectableObject > &anObject)
 the objet is temporarily deactivated everywhere it was activated.

void Sleep (const Handle< SelectMgr_SelectableObject > &anObject, const Handle< SelectMgr_ViewerSelector > &aSelector)
 Different from Deactivate; this method
deactivates the activated modes of an object,
but just for a time; when the Awake Method is called
the sleeping modes are reactivated.

void Awake (const Handle< SelectMgr_ViewerSelector > &aSelector, const Standard_Boolean AutomaticProj=Standard_True)
 activates all the deactivated objects in a selector.

void Awake (const Handle< SelectMgr_SelectableObject > &anObject, const Standard_Boolean AutomaticProj=Standard_True)
void Awake (const Handle< SelectMgr_SelectableObject > &anObject, const Handle< SelectMgr_ViewerSelector > &aSelector, const Standard_Boolean AutomaticProj=Standard_True)
 activates all the deactivated modes
of an object in a selector

Standard_Boolean IsActivated (const Handle< SelectMgr_SelectableObject > &anObject) const
 Returns true if the selection is active for the selectable object anObject.

Standard_Boolean IsActivated (const Handle< SelectMgr_SelectableObject > &anObject, const Standard_Integer aMode) const
 Returns true if the selection mode aMode is active for the selectable object anObject.

Standard_Boolean IsActivated (const Handle< SelectMgr_SelectableObject > &anObject, const Handle< SelectMgr_ViewerSelector > &aSelector, const Standard_Integer aMode) const
 Returns true if the selection mode aMode is active for the selectable
object anObject in the viewer selector aSelector.

void RecomputeSelection (const Handle< SelectMgr_SelectableObject > &anIObj, const Standard_Boolean ForceUpdate=Standard_False, const Standard_Integer aMode=-1)
 computes Selections in <anIObj> if they are
activated in at least one Selector.
puts a recompute flag in each selection which is not active.
if <aMode>=-1 all the selection modes will have to be
recomputed.
if <ForceUpdate> = True, all selections are recomputed,
even if they are not active.

void Update (const Handle< SelectMgr_SelectableObject > &anObject, const Standard_Boolean ForceUpdate=Standard_True)
 updates the selectionModes of <anObject>
According to
. the stored type of update in each selection
mode,
. the activation status of each selection mode
if <ForceUpdate> == True Recompute

void Update (const Handle< SelectMgr_SelectableObject > &anObject, const Handle< SelectMgr_ViewerSelector > &aSelector, const Standard_Boolean ForceUpdate=Standard_True)
void SetUpdateMode (const Handle< SelectMgr_SelectableObject > &anObject, const SelectMgr_TypeOfUpdate aType)
void SetUpdateMode (const Handle< SelectMgr_SelectableObject > &anObject, const Standard_Integer aSelMode, const SelectMgr_TypeOfUpdate aType)
TCollection_AsciiString Status () const
TCollection_AsciiString Status (const Handle< SelectMgr_SelectableObject > &anObject) const

Constructor & Destructor Documentation

SelectMgr_SelectionManager::SelectMgr_SelectionManager ( )

Member Function Documentation

void SelectMgr_SelectionManager::Activate ( const Handle< SelectMgr_SelectableObject > &  anObject,
const Standard_Integer  aMode = 0,
const Standard_Boolean  AutomaticProj = Standard_True 
)
void SelectMgr_SelectionManager::Activate ( const Handle< SelectMgr_SelectableObject > &  anObject,
const Standard_Integer  aMode,
const Handle< SelectMgr_ViewerSelector > &  aSelector,
const Standard_Boolean  AutomaticProj = Standard_True 
)
void SelectMgr_SelectionManager::Add ( const Handle< SelectMgr_ViewerSelector > &  aSelector)
void SelectMgr_SelectionManager::Awake ( const Handle< SelectMgr_ViewerSelector > &  aSelector,
const Standard_Boolean  AutomaticProj = Standard_True 
)
void SelectMgr_SelectionManager::Awake ( const Handle< SelectMgr_SelectableObject > &  anObject,
const Standard_Boolean  AutomaticProj = Standard_True 
)
void SelectMgr_SelectionManager::Awake ( const Handle< SelectMgr_SelectableObject > &  anObject,
const Handle< SelectMgr_ViewerSelector > &  aSelector,
const Standard_Boolean  AutomaticProj = Standard_True 
)
Standard_Boolean SelectMgr_SelectionManager::Contains ( const Handle< SelectMgr_SelectableObject > &  aSelectableObject) const
Standard_Boolean SelectMgr_SelectionManager::Contains ( const Handle< SelectMgr_ViewerSelector > &  aSelector) const
void SelectMgr_SelectionManager::Deactivate ( const Handle< SelectMgr_SelectableObject > &  anObject)
void SelectMgr_SelectionManager::Deactivate ( const Handle< SelectMgr_SelectableObject > &  anObject,
const Standard_Integer  aMode 
)
void SelectMgr_SelectionManager::Deactivate ( const Handle< SelectMgr_SelectableObject > &  anObject,
const Standard_Integer  aMode,
const Handle< SelectMgr_ViewerSelector > &  aSelector 
)
void SelectMgr_SelectionManager::Deactivate ( const Handle< SelectMgr_SelectableObject > &  anObject,
const Handle< SelectMgr_ViewerSelector > &  aSelector 
)
Standard_Boolean SelectMgr_SelectionManager::IsActivated ( const Handle< SelectMgr_SelectableObject > &  anObject,
const Handle< SelectMgr_ViewerSelector > &  aSelector,
const Standard_Integer  aMode 
) const
Standard_Boolean SelectMgr_SelectionManager::IsActivated ( const Handle< SelectMgr_SelectableObject > &  anObject) const
Standard_Boolean SelectMgr_SelectionManager::IsActivated ( const Handle< SelectMgr_SelectableObject > &  anObject,
const Standard_Integer  aMode 
) const
void SelectMgr_SelectionManager::Load ( const Handle< SelectMgr_SelectableObject > &  anObject,
const Standard_Integer  aMode = -1 
)
void SelectMgr_SelectionManager::Load ( const Handle< SelectMgr_SelectableObject > &  anObject,
const Handle< SelectMgr_ViewerSelector > &  aSelector,
const Standard_Integer  aMode = -1 
)
void SelectMgr_SelectionManager::RecomputeSelection ( const Handle< SelectMgr_SelectableObject > &  anIObj,
const Standard_Boolean  ForceUpdate = Standard_False,
const Standard_Integer  aMode = -1 
)
void SelectMgr_SelectionManager::Remove ( const Handle< SelectMgr_SelectableObject > &  anObject,
const Handle< SelectMgr_ViewerSelector > &  aSelector 
)
void SelectMgr_SelectionManager::Remove ( const Handle< SelectMgr_ViewerSelector > &  aSelector)
void SelectMgr_SelectionManager::Remove ( const Handle< SelectMgr_SelectableObject > &  anObject)
void SelectMgr_SelectionManager::SetUpdateMode ( const Handle< SelectMgr_SelectableObject > &  anObject,
const Standard_Integer  aSelMode,
const SelectMgr_TypeOfUpdate  aType 
)
void SelectMgr_SelectionManager::SetUpdateMode ( const Handle< SelectMgr_SelectableObject > &  anObject,
const SelectMgr_TypeOfUpdate  aType 
)
void SelectMgr_SelectionManager::Sleep ( const Handle< SelectMgr_SelectableObject > &  anObject,
const Handle< SelectMgr_ViewerSelector > &  aSelector 
)
void SelectMgr_SelectionManager::Sleep ( const Handle< SelectMgr_SelectableObject > &  anObject)
void SelectMgr_SelectionManager::Sleep ( const Handle< SelectMgr_ViewerSelector > &  aSelector)
TCollection_AsciiString SelectMgr_SelectionManager::Status ( const Handle< SelectMgr_SelectableObject > &  anObject) const
TCollection_AsciiString SelectMgr_SelectionManager::Status ( ) const
void SelectMgr_SelectionManager::Update ( const Handle< SelectMgr_SelectableObject > &  anObject,
const Standard_Boolean  ForceUpdate = Standard_True 
)
void SelectMgr_SelectionManager::Update ( const Handle< SelectMgr_SelectableObject > &  anObject,
const Handle< SelectMgr_ViewerSelector > &  aSelector,
const Standard_Boolean  ForceUpdate = Standard_True 
)

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines