OCC Main Page | Visualization | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

Visualization
TKV3d
SelectMgr


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>


Public Member Functions

Standard_EXPORT SelectMgr_SelectionManager ()
 Constructs an empty selection manager object.
.
Standard_EXPORT void Add (const Handle(SelectMgr_ViewerSelector)&aSelector)
 Adds the viewer selector aSelector to this framework.
.
Standard_EXPORT void Remove (const Handle(SelectMgr_ViewerSelector)&aSelector)
Standard_EXPORT Standard_Boolean Contains (const Handle(SelectMgr_ViewerSelector)&aSelector) const
 Returns true if this framework contains the viewer selector aSelector.
.
Standard_EXPORT Standard_Boolean Contains (const Handle(SelectMgr_SelectableObject)&aSelectableObject) const
 Returns true if this framework contains the
selectable object aSelectableObject.
.
Standard_EXPORT 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.
.
Standard_EXPORT 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
.
Standard_EXPORT void Remove (const Handle(SelectMgr_SelectableObject)&anObject)
 removes the object from All the ViewerSelectors where it was;

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

Standard_EXPORT 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.
.
Standard_EXPORT 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.
.
Standard_EXPORT void Deactivate (const Handle(SelectMgr_SelectableObject)&anObject)
 Deactivate all the activated modes in any
Selector for <anobject>
.
Standard_EXPORT void Deactivate (const Handle(SelectMgr_SelectableObject)&anObject, const Standard_Integer aMode)
 Deactivates the Mode <amode> in every Selector where
it was activated
.
Standard_EXPORT 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.
.
Standard_EXPORT 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.
.
Standard_EXPORT void Sleep (const Handle(SelectMgr_ViewerSelector)&aSelector)
 Ensures that no object in the selector aSelector will be active.
.
Standard_EXPORT void Sleep (const Handle(SelectMgr_SelectableObject)&anObject)
 the objet is temporarily deactivated everywhere it was activated.

Standard_EXPORT 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.
.
Standard_EXPORT void Awake (const Handle(SelectMgr_ViewerSelector)&aSelector, const Standard_Boolean AutomaticProj=Standard_True)
 activates all the deactivated objects in a selector.

Standard_EXPORT void Awake (const Handle(SelectMgr_SelectableObject)&anObject, const Standard_Boolean AutomaticProj=Standard_True)
Standard_EXPORT 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_EXPORT Standard_Boolean IsActivated (const Handle(SelectMgr_SelectableObject)&anObject) const
 Returns true if the selection is active for the selectable object anObject.
.
Standard_EXPORT 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_EXPORT 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.
.
Standard_EXPORT 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.

Standard_EXPORT 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

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

Private Member Functions

Standard_EXPORT void LoadMode (const Handle(SelectMgr_SelectableObject)&anObject, const Standard_Integer aMode)

Private Attributes

TColStd_MapOfTransient myselectors
TColStd_MapOfTransient myglobal
SelectMgr_DataMapOfObjectSelectors mylocal


Constructor & Destructor Documentation

Standard_EXPORT SelectMgr_SelectionManager::SelectMgr_SelectionManager  ) 
 


Member Function Documentation

Standard_EXPORT void SelectMgr_SelectionManager::Activate const Handle(SelectMgr_SelectableObject)&  anObject,
const Standard_Integer  aMode,
const Handle(SelectMgr_ViewerSelector)&  aSelector,
const Standard_Boolean  AutomaticProj = Standard_True
 

Standard_EXPORT void SelectMgr_SelectionManager::Activate const Handle(SelectMgr_SelectableObject)&  anObject,
const Standard_Integer  aMode = 0,
const Standard_Boolean  AutomaticProj = Standard_True
 

Standard_EXPORT void SelectMgr_SelectionManager::Add const Handle(SelectMgr_ViewerSelector)&  aSelector  ) 
 

Standard_EXPORT void SelectMgr_SelectionManager::Awake const Handle(SelectMgr_SelectableObject)&  anObject,
const Handle(SelectMgr_ViewerSelector)&  aSelector,
const Standard_Boolean  AutomaticProj = Standard_True
 

Standard_EXPORT void SelectMgr_SelectionManager::Awake const Handle(SelectMgr_SelectableObject)&  anObject,
const Standard_Boolean  AutomaticProj = Standard_True
 

Standard_EXPORT void SelectMgr_SelectionManager::Awake const Handle(SelectMgr_ViewerSelector)&  aSelector,
const Standard_Boolean  AutomaticProj = Standard_True
 

Standard_EXPORT Standard_Boolean SelectMgr_SelectionManager::Contains const Handle(SelectMgr_SelectableObject)&  aSelectableObject  )  const
 

Standard_EXPORT Standard_Boolean SelectMgr_SelectionManager::Contains const Handle(SelectMgr_ViewerSelector)&  aSelector  )  const
 

Standard_EXPORT void SelectMgr_SelectionManager::Deactivate const Handle(SelectMgr_SelectableObject)&  anObject,
const Handle(SelectMgr_ViewerSelector)&  aSelector
 

Standard_EXPORT void SelectMgr_SelectionManager::Deactivate const Handle(SelectMgr_SelectableObject)&  anObject,
const Standard_Integer  aMode,
const Handle(SelectMgr_ViewerSelector)&  aSelector
 

Standard_EXPORT void SelectMgr_SelectionManager::Deactivate const Handle(SelectMgr_SelectableObject)&  anObject,
const Standard_Integer  aMode
 

Standard_EXPORT void SelectMgr_SelectionManager::Deactivate const Handle(SelectMgr_SelectableObject)&  anObject  ) 
 

Standard_EXPORT const SelectMgr_SelectionManager::Handle Standard_Type   )  const
 

Standard_EXPORT Standard_Boolean SelectMgr_SelectionManager::IsActivated const Handle(SelectMgr_SelectableObject)&  anObject,
const Handle(SelectMgr_ViewerSelector)&  aSelector,
const Standard_Integer  aMode
const
 

Standard_EXPORT Standard_Boolean SelectMgr_SelectionManager::IsActivated const Handle(SelectMgr_SelectableObject)&  anObject,
const Standard_Integer  aMode
const
 

Standard_EXPORT Standard_Boolean SelectMgr_SelectionManager::IsActivated const Handle(SelectMgr_SelectableObject)&  anObject  )  const
 

Standard_EXPORT void SelectMgr_SelectionManager::Load const Handle(SelectMgr_SelectableObject)&  anObject,
const Handle(SelectMgr_ViewerSelector)&  aSelector,
const Standard_Integer  aMode = -1
 

Standard_EXPORT void SelectMgr_SelectionManager::Load const Handle(SelectMgr_SelectableObject)&  anObject,
const Standard_Integer  aMode = -1
 

Standard_EXPORT void SelectMgr_SelectionManager::LoadMode const Handle(SelectMgr_SelectableObject)&  anObject,
const Standard_Integer  aMode
[private]
 

Standard_EXPORT void SelectMgr_SelectionManager::RecomputeSelection const Handle(SelectMgr_SelectableObject)&  anIObj,
const Standard_Boolean  ForceUpdate = Standard_False,
const Standard_Integer  aMode = -1
 

Standard_EXPORT void SelectMgr_SelectionManager::Remove const Handle(SelectMgr_SelectableObject)&  anObject,
const Handle(SelectMgr_ViewerSelector)&  aSelector
 

Standard_EXPORT void SelectMgr_SelectionManager::Remove const Handle(SelectMgr_SelectableObject)&  anObject  ) 
 

Standard_EXPORT void SelectMgr_SelectionManager::Remove const Handle(SelectMgr_ViewerSelector)&  aSelector  ) 
 

Standard_EXPORT void SelectMgr_SelectionManager::SetUpdateMode const Handle(SelectMgr_SelectableObject)&  anObject,
const Standard_Integer  aSelMode,
const SelectMgr_TypeOfUpdate  aType
 

Standard_EXPORT void SelectMgr_SelectionManager::SetUpdateMode const Handle(SelectMgr_SelectableObject)&  anObject,
const SelectMgr_TypeOfUpdate  aType
 

Standard_EXPORT void SelectMgr_SelectionManager::Sleep const Handle(SelectMgr_SelectableObject)&  anObject,
const Handle(SelectMgr_ViewerSelector)&  aSelector
 

Standard_EXPORT void SelectMgr_SelectionManager::Sleep const Handle(SelectMgr_SelectableObject)&  anObject  ) 
 

Standard_EXPORT void SelectMgr_SelectionManager::Sleep const Handle(SelectMgr_ViewerSelector)&  aSelector  ) 
 

Standard_EXPORT TCollection_AsciiString SelectMgr_SelectionManager::Status const Handle(SelectMgr_SelectableObject)&  anObject  )  const
 

Standard_EXPORT TCollection_AsciiString SelectMgr_SelectionManager::Status  )  const
 

Standard_EXPORT void SelectMgr_SelectionManager::Update const Handle(SelectMgr_SelectableObject)&  anObject,
const Handle(SelectMgr_ViewerSelector)&  aSelector,
const Standard_Boolean  ForceUpdate = Standard_True
 

Standard_EXPORT void SelectMgr_SelectionManager::Update const Handle(SelectMgr_SelectableObject)&  anObject,
const Standard_Boolean  ForceUpdate = Standard_True
 


Field Documentation

TColStd_MapOfTransient SelectMgr_SelectionManager::myglobal [private]
 

SelectMgr_DataMapOfObjectSelectors SelectMgr_SelectionManager::mylocal [private]
 

TColStd_MapOfTransient SelectMgr_SelectionManager::myselectors [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 13:56:16 2008 for OpenCASCADE by  doxygen 1.4.1