Open CASCADE Technology  7.2.0
Public Member Functions
AIS_LocalContext Class Reference

Defines a specific context for selection. It becomes possible to: More...

#include <AIS_LocalContext.hxx>

Inheritance diagram for AIS_LocalContext:
Inheritance graph
[legend]

Public Member Functions

 AIS_LocalContext ()
 
 AIS_LocalContext (const Handle< AIS_InteractiveContext > &aCtx, const Standard_Integer anIndex, const Standard_Boolean LoadDisplayed=Standard_True, const Standard_Boolean AcceptStandardModes=Standard_True, const Standard_Boolean AcceptErase=Standard_False, const Standard_Boolean UseBothViewers=Standard_False)
 Constructor By Default, the displayed objects are automatically loaded. More...
 
void AcceptErase (const Standard_Boolean aStatus)
 authorize or not others contexts to erase temporary displayed objects here; More...
 
Standard_Boolean AcceptErase () const
 
void SetContext (const Handle< AIS_InteractiveContext > &aCtx)
 
const Handle< AIS_SelectionSelection () const
 
void Terminate (const Standard_Boolean updateviewer=Standard_True)
 
Standard_Boolean Display (const Handle< AIS_InteractiveObject > &anInteractive, const Standard_Integer DisplayMode=0, const Standard_Boolean AllowShapeDecomposition=Standard_True, const Standard_Integer ActivationMode=0)
 returns true if done... More...
 
Standard_Boolean Load (const Handle< AIS_InteractiveObject > &anInteractive, const Standard_Boolean AllowShapeDecomposition=Standard_True, const Standard_Integer ActivationMode=0)
 loads <anInteractive> with nodisplay... returns true if done More...
 
Standard_Boolean Erase (const Handle< AIS_InteractiveObject > &anInteractive)
 returns true if done... More...
 
Standard_Boolean Remove (const Handle< AIS_InteractiveObject > &aSelectable)
 
Standard_Boolean ClearPrs (const Handle< AIS_InteractiveObject > &anInteractive, const Standard_Integer aMode)
 
void SetShapeDecomposition (const Handle< AIS_InteractiveObject > &aStoredObject, const Standard_Boolean aStatus)
 allows or forbids the shape decomposition into Activated Standard Mode for <aStoredObject> does nothing if the object doesn't inherits BasicShape from AIS More...
 
void Clear (const AIS_ClearMode atype=AIS_CM_All)
 according to <atype> , clears the different parts of the selector (filters, modeof activation, objects...) More...
 
void ActivateMode (const Handle< AIS_InteractiveObject > &aSelectable, const Standard_Integer aMode)
 optional : activation of a mode which is not 0 for a selectable... More...
 
void DeactivateMode (const Handle< AIS_InteractiveObject > &aSelectable, const Standard_Integer aMode)
 
void Deactivate (const Handle< AIS_InteractiveObject > &aSelectable)
 
void ActivateStandardMode (const TopAbs_ShapeEnum aType)
 decomposition of shapes into <aType> More...
 
void DeactivateStandardMode (const TopAbs_ShapeEnum aType)
 
const TColStd_ListOfIntegerStandardModes () const
 
void AddFilter (const Handle< SelectMgr_Filter > &aFilter)
 
void RemoveFilter (const Handle< SelectMgr_Filter > &aFilter)
 
const SelectMgr_ListOfFilterListOfFilter () const
 
const Handle< SelectMgr_OrFilter > & Filter () const
 
void SetAutomaticHilight (const Standard_Boolean aStatus)
 if <aStatus> = True , the shapes or subshapes detected by the selector will be automatically hilighted in the main viewer. Else the user has to manage the detected shape outside the Shape Selector.... More...
 
Standard_Boolean AutomaticHilight () const
 
AIS_StatusOfDetection MoveTo (const Standard_Integer theXpix, const Standard_Integer theYpix, const Handle< V3d_View > &theView, const Standard_Boolean theToRedrawImmediate)
 
Standard_Boolean HasNextDetected () const
 returns True if more than one entity was detected at the last Mouse position. More...
 
Standard_Integer HilightNextDetected (const Handle< V3d_View > &theView, const Standard_Boolean theToRedrawImmediate)
 returns True if last detected. the next detected will be first one (endless loop) More...
 
Standard_Integer HilightPreviousDetected (const Handle< V3d_View > &theView, const Standard_Boolean theToRedrawImmediate)
 
Standard_Boolean UnhilightLastDetected (const Handle< V3d_Viewer > &theViewer)
 returns True if something was done... More...
 
Standard_Boolean UnhilightLastDetected (const Handle< V3d_View > &theView)
 returns True if something was done... More...
 
AIS_StatusOfPick AddSelect (const Handle< SelectMgr_EntityOwner > &theObject)
 returns the number of selected More...
 
AIS_StatusOfPick Select (const Standard_Boolean updateviewer=Standard_True)
 
AIS_StatusOfPick ShiftSelect (const Standard_Boolean updateviewer=Standard_True)
 
AIS_StatusOfPick Select (const Standard_Integer XPMin, const Standard_Integer YPMin, const Standard_Integer XPMax, const Standard_Integer YPMax, const Handle< V3d_View > &aView, const Standard_Boolean updateviewer=Standard_True)
 
AIS_StatusOfPick ShiftSelect (const Standard_Integer XPMin, const Standard_Integer YPMin, const Standard_Integer XPMax, const Standard_Integer YPMax, const Handle< V3d_View > &aView, const Standard_Boolean updateviewer=Standard_True)
 
AIS_StatusOfPick Select (const TColgp_Array1OfPnt2d &Polyline, const Handle< V3d_View > &aView, const Standard_Boolean updateviewer=Standard_True)
 
AIS_StatusOfPick ShiftSelect (const TColgp_Array1OfPnt2d &Polyline, const Handle< V3d_View > &aView, const Standard_Boolean updateviewer=Standard_True)
 
void HilightPicked (const Standard_Boolean updateviewer=Standard_True)
 
void UnhilightPicked (const Standard_Boolean updateviewer=Standard_True)
 
void UpdateSelected (const Standard_Boolean updateviewer=Standard_True)
 
void UpdateSelected (const Handle< AIS_InteractiveObject > &anobj, const Standard_Boolean updateviewer=Standard_True)
 Part of advanced selection highlighting mechanism. If no owners belonging to anobj are selected, calls anobj->ClearSelected(), otherwise calls anobj->HilightSelected(). This method can be used to avoid redrawing the whole selection belonging to several Selectable Objects. More...
 
void SetSelected (const Handle< AIS_InteractiveObject > &anobj, const Standard_Boolean updateviewer=Standard_True)
 useful to update selection with objects coming from Collector or stack More...
 
void AddOrRemoveSelected (const Handle< AIS_InteractiveObject > &anobj, const Standard_Boolean updateviewer=Standard_True)
 useful to update selection with objects coming from Collector or stack More...
 
void AddOrRemoveSelected (const TopoDS_Shape &aShape, const Standard_Boolean updateviewer=Standard_True)
 
void AddOrRemoveSelected (const Handle< SelectMgr_EntityOwner > &theOwner, const Standard_Boolean toUpdateViewer=Standard_True)
 
void ClearSelected (const Standard_Boolean toUpdateViewer=Standard_True)
 Clears local context selection. More...
 
void ClearOutdatedSelection (const Handle< AIS_InteractiveObject > &theIO, const Standard_Boolean toClearDeactivated)
 Clears outdated selection and detection of owners for the interactive object. Use this method if selection structures of the interactive object have changed. The method unhilights and removes outdated entity owners from lists of selected and detected owners. More...
 
Standard_Boolean HasDetected () const
 
void InitDetected ()
 Initialization for iteration through mouse-detected objects in local context. More...
 
Standard_Boolean MoreDetected () const
 
void NextDetected ()
 Gets next current object during iteration through mouse-detected interactive objects. More...
 
Handle< SelectMgr_EntityOwnerDetectedCurrentOwner () const
 
const TopoDS_ShapeDetectedCurrentShape () const
 
Handle< AIS_InteractiveObjectDetectedCurrentObject () const
 
Standard_Boolean HasDetectedShape () const
 
const TopoDS_ShapeDetectedShape () const
 
Handle< AIS_InteractiveObjectDetectedInteractive () const
 
Handle< SelectMgr_EntityOwnerDetectedOwner () const
 
void InitSelected ()
 
Standard_Boolean MoreSelected () const
 
void NextSelected ()
 
Standard_Boolean HasShape () const
 returns TRUE if the detected entity is a shape coming from a Decomposition of an element. More...
 
Standard_Boolean HasSelectedShape () const
 returns true if current selection is not empty and the owner of selected object contains a shape. This method does not take into account decomposition status of detected shape. More...
 
TopoDS_Shape SelectedShape () const
 
Handle< SelectMgr_EntityOwnerSelectedOwner () const
 
Standard_Boolean IsSelected (const Handle< AIS_InteractiveObject > &aniobj) const
 
Standard_Boolean IsSelected (const Handle< SelectMgr_EntityOwner > &anOwner) const
 
Handle< AIS_InteractiveObjectSelectedInteractive () const
 
Standard_Boolean HasApplicative () const
 returns TRUE if an interactive element was associated with the current picked entity. More...
 
const Handle< Standard_Transient > & SelectedApplicative () const
 
void SetDisplayPriority (const Handle< AIS_InteractiveObject > &anObject, const Standard_Integer Prior)
 
Standard_Integer DisplayedObjects (TColStd_MapOfTransient &theMapToFill) const
 
Standard_Boolean IsIn (const Handle< AIS_InteractiveObject > &anObject) const
 
Standard_Boolean IsDisplayed (const Handle< AIS_InteractiveObject > &anObject) const
 
Standard_Boolean IsDisplayed (const Handle< AIS_InteractiveObject > &anObject, const Standard_Integer aMode) const
 
const TColStd_ListOfIntegerSelectionModes (const Handle< AIS_InteractiveObject > &anObject) const
 
void SubIntensityOn (const Handle< AIS_InteractiveObject > &anObject)
 
void SubIntensityOff (const Handle< AIS_InteractiveObject > &anObject)
 
void Hilight (const Handle< AIS_InteractiveObject > &anObject)
 
void Hilight (const Handle< AIS_InteractiveObject > &theObj, const Handle< Prs3d_Drawer > &theStyle)
 
void Unhilight (const Handle< AIS_InteractiveObject > &anObject)
 
Standard_Boolean IsHilighted (const Handle< AIS_InteractiveObject > &anObject) const
 
Standard_Boolean HighlightStyle (const Handle< AIS_InteractiveObject > &theObject, Handle< Prs3d_Drawer > &theStyle) const
 
void SetPixelTolerance (const Standard_Integer aPrecision=2)
 Define the current selection sensitivity for this local context according to the view size. More...
 
Standard_Integer PixelTolerance () const
 Returns the pixel tolerance. More...
 
void SetSelectionSensitivity (const Handle< AIS_InteractiveObject > &theObject, const Standard_Integer theMode, const Standard_Integer theNewSensitivity)
 Allows to manage sensitivity of a particular selection of interactive object theObject and changes previous sensitivity value of all sensitive entities in selection with theMode to the given theNewSensitivity. More...
 
Standard_Boolean BeginImmediateDraw ()
 Resets the transient list of presentations previously displayed in immediate mode and begins accumulation of new list by following AddToImmediateList()/Color()/Highlight() calls. More...
 
virtual void ClearImmediateDraw ()
 Resets the transient list of presentations previously displayed in immediate mode. More...
 
Standard_Boolean ImmediateAdd (const Handle< AIS_InteractiveObject > &theObj, const Standard_Integer theMode=0)
 Stores presentation theMode of object theObj in the transient list of presentations to be displayed in immediate mode. Will be taken in account in EndImmediateDraw method. More...
 
Standard_Boolean EndImmediateDraw (const Handle< V3d_Viewer > &theViewer)
 Allows rapid drawing of the view theView by avoiding an update of the whole background. More...
 
Standard_Boolean IsImmediateModeOn () const
 Returns true if Presentation Manager is accumulating transient list of presentations to be displayed in immediate mode. More...
 
TCollection_AsciiString Status () const
 
const Handle< AIS_LocalStatus > & Status (const Handle< AIS_InteractiveObject > &anObject) const
 
void LoadContextObjects ()
 
void UnloadContextObjects ()
 
void DisplaySensitive (const Handle< V3d_View > &aView)
 
void ClearSensitive (const Handle< V3d_View > &aView)
 
const Handle< StdSelect_ViewerSelector3d > & MainSelector () const
 
Handle< SelectMgr_EntityOwnerFindSelectedOwnerFromIO (const Handle< AIS_InteractiveObject > &anIObj) const
 
Handle< SelectMgr_EntityOwnerFindSelectedOwnerFromShape (const TopoDS_Shape &aShape) const
 
void RestoreActivatedModes () const
 Iterates through all interactive objects of local context and activates selection modes stored in local status. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (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_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. 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...
 

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 a specific context for selection. It becomes possible to:

Constructor & Destructor Documentation

◆ AIS_LocalContext() [1/2]

AIS_LocalContext::AIS_LocalContext ( )

◆ AIS_LocalContext() [2/2]

AIS_LocalContext::AIS_LocalContext ( const Handle< AIS_InteractiveContext > &  aCtx,
const Standard_Integer  anIndex,
const Standard_Boolean  LoadDisplayed = Standard_True,
const Standard_Boolean  AcceptStandardModes = Standard_True,
const Standard_Boolean  AcceptErase = Standard_False,
const Standard_Boolean  UseBothViewers = Standard_False 
)

Constructor By Default, the displayed objects are automatically loaded.

Member Function Documentation

◆ AcceptErase() [1/2]

void AIS_LocalContext::AcceptErase ( const Standard_Boolean  aStatus)

authorize or not others contexts to erase temporary displayed objects here;

◆ AcceptErase() [2/2]

Standard_Boolean AIS_LocalContext::AcceptErase ( ) const

◆ ActivateMode()

void AIS_LocalContext::ActivateMode ( const Handle< AIS_InteractiveObject > &  aSelectable,
const Standard_Integer  aMode 
)

optional : activation of a mode which is not 0 for a selectable...

◆ ActivateStandardMode()

void AIS_LocalContext::ActivateStandardMode ( const TopAbs_ShapeEnum  aType)

decomposition of shapes into <aType>

◆ AddFilter()

void AIS_LocalContext::AddFilter ( const Handle< SelectMgr_Filter > &  aFilter)

◆ AddOrRemoveSelected() [1/3]

void AIS_LocalContext::AddOrRemoveSelected ( const Handle< AIS_InteractiveObject > &  anobj,
const Standard_Boolean  updateviewer = Standard_True 
)

useful to update selection with objects coming from Collector or stack

◆ AddOrRemoveSelected() [2/3]

void AIS_LocalContext::AddOrRemoveSelected ( const TopoDS_Shape aShape,
const Standard_Boolean  updateviewer = Standard_True 
)

◆ AddOrRemoveSelected() [3/3]

void AIS_LocalContext::AddOrRemoveSelected ( const Handle< SelectMgr_EntityOwner > &  theOwner,
const Standard_Boolean  toUpdateViewer = Standard_True 
)

◆ AddSelect()

AIS_StatusOfPick AIS_LocalContext::AddSelect ( const Handle< SelectMgr_EntityOwner > &  theObject)

returns the number of selected

◆ AutomaticHilight()

Standard_Boolean AIS_LocalContext::AutomaticHilight ( ) const

◆ BeginImmediateDraw()

Standard_Boolean AIS_LocalContext::BeginImmediateDraw ( )

Resets the transient list of presentations previously displayed in immediate mode and begins accumulation of new list by following AddToImmediateList()/Color()/Highlight() calls.

◆ Clear()

void AIS_LocalContext::Clear ( const AIS_ClearMode  atype = AIS_CM_All)

according to <atype> , clears the different parts of the selector (filters, modeof activation, objects...)

◆ ClearImmediateDraw()

virtual void AIS_LocalContext::ClearImmediateDraw ( )
virtual

Resets the transient list of presentations previously displayed in immediate mode.

◆ ClearOutdatedSelection()

void AIS_LocalContext::ClearOutdatedSelection ( const Handle< AIS_InteractiveObject > &  theIO,
const Standard_Boolean  toClearDeactivated 
)

Clears outdated selection and detection of owners for the interactive object. Use this method if selection structures of the interactive object have changed. The method unhilights and removes outdated entity owners from lists of selected and detected owners.

Parameters
theIO[in] the interactive object.
toClearDeactivated[in] pass TRUE to treat deactivated entity owners as 'outdated' when clearing the selection.

◆ ClearPrs()

Standard_Boolean AIS_LocalContext::ClearPrs ( const Handle< AIS_InteractiveObject > &  anInteractive,
const Standard_Integer  aMode 
)

◆ ClearSelected()

void AIS_LocalContext::ClearSelected ( const Standard_Boolean  toUpdateViewer = Standard_True)

Clears local context selection.

Parameters
toUpdateViewer[in] if TRUE the viewer will be updated.

◆ ClearSensitive()

void AIS_LocalContext::ClearSensitive ( const Handle< V3d_View > &  aView)

◆ Deactivate()

void AIS_LocalContext::Deactivate ( const Handle< AIS_InteractiveObject > &  aSelectable)

◆ DeactivateMode()

void AIS_LocalContext::DeactivateMode ( const Handle< AIS_InteractiveObject > &  aSelectable,
const Standard_Integer  aMode 
)

◆ DeactivateStandardMode()

void AIS_LocalContext::DeactivateStandardMode ( const TopAbs_ShapeEnum  aType)

◆ DetectedCurrentObject()

Handle< AIS_InteractiveObject > AIS_LocalContext::DetectedCurrentObject ( ) const
Returns
current mouse-detected interactive object or null object if there is no current detected.

◆ DetectedCurrentOwner()

Handle< SelectMgr_EntityOwner > AIS_LocalContext::DetectedCurrentOwner ( ) const
Returns
current mouse-detected Owner or null object if there is no current detected.

◆ DetectedCurrentShape()

const TopoDS_Shape& AIS_LocalContext::DetectedCurrentShape ( ) const
Returns
current mouse-detected shape or empty (null) shape, if current interactive object is not a shape (AIS_Shape) or there is no current mouse-detected interactive object at all.

◆ DetectedInteractive()

Handle< AIS_InteractiveObject > AIS_LocalContext::DetectedInteractive ( ) const

◆ DetectedOwner()

Handle< SelectMgr_EntityOwner > AIS_LocalContext::DetectedOwner ( ) const

◆ DetectedShape()

const TopoDS_Shape& AIS_LocalContext::DetectedShape ( ) const

◆ Display()

Standard_Boolean AIS_LocalContext::Display ( const Handle< AIS_InteractiveObject > &  anInteractive,
const Standard_Integer  DisplayMode = 0,
const Standard_Boolean  AllowShapeDecomposition = Standard_True,
const Standard_Integer  ActivationMode = 0 
)

returns true if done...

◆ DisplayedObjects()

Standard_Integer AIS_LocalContext::DisplayedObjects ( TColStd_MapOfTransient theMapToFill) const

◆ DisplaySensitive()

void AIS_LocalContext::DisplaySensitive ( const Handle< V3d_View > &  aView)

◆ EndImmediateDraw()

Standard_Boolean AIS_LocalContext::EndImmediateDraw ( const Handle< V3d_Viewer > &  theViewer)

Allows rapid drawing of the view theView by avoiding an update of the whole background.

◆ Erase()

Standard_Boolean AIS_LocalContext::Erase ( const Handle< AIS_InteractiveObject > &  anInteractive)

returns true if done...

◆ Filter()

const Handle< SelectMgr_OrFilter >& AIS_LocalContext::Filter ( ) const

◆ FindSelectedOwnerFromIO()

Handle< SelectMgr_EntityOwner > AIS_LocalContext::FindSelectedOwnerFromIO ( const Handle< AIS_InteractiveObject > &  anIObj) const

◆ FindSelectedOwnerFromShape()

Handle< SelectMgr_EntityOwner > AIS_LocalContext::FindSelectedOwnerFromShape ( const TopoDS_Shape aShape) const

◆ HasApplicative()

Standard_Boolean AIS_LocalContext::HasApplicative ( ) const

returns TRUE if an interactive element was associated with the current picked entity.

◆ HasDetected()

Standard_Boolean AIS_LocalContext::HasDetected ( ) const

◆ HasDetectedShape()

Standard_Boolean AIS_LocalContext::HasDetectedShape ( ) const

◆ HasNextDetected()

Standard_Boolean AIS_LocalContext::HasNextDetected ( ) const

returns True if more than one entity was detected at the last Mouse position.

◆ HasSelectedShape()

Standard_Boolean AIS_LocalContext::HasSelectedShape ( ) const

returns true if current selection is not empty and the owner of selected object contains a shape. This method does not take into account decomposition status of detected shape.

◆ HasShape()

Standard_Boolean AIS_LocalContext::HasShape ( ) const

returns TRUE if the detected entity is a shape coming from a Decomposition of an element.

◆ HighlightStyle()

Standard_Boolean AIS_LocalContext::HighlightStyle ( const Handle< AIS_InteractiveObject > &  theObject,
Handle< Prs3d_Drawer > &  theStyle 
) const

◆ Hilight() [1/2]

void AIS_LocalContext::Hilight ( const Handle< AIS_InteractiveObject > &  anObject)

◆ Hilight() [2/2]

void AIS_LocalContext::Hilight ( const Handle< AIS_InteractiveObject > &  theObj,
const Handle< Prs3d_Drawer > &  theStyle 
)

◆ HilightNextDetected()

Standard_Integer AIS_LocalContext::HilightNextDetected ( const Handle< V3d_View > &  theView,
const Standard_Boolean  theToRedrawImmediate 
)

returns True if last detected. the next detected will be first one (endless loop)

◆ HilightPicked()

void AIS_LocalContext::HilightPicked ( const Standard_Boolean  updateviewer = Standard_True)

◆ HilightPreviousDetected()

Standard_Integer AIS_LocalContext::HilightPreviousDetected ( const Handle< V3d_View > &  theView,
const Standard_Boolean  theToRedrawImmediate 
)

◆ ImmediateAdd()

Standard_Boolean AIS_LocalContext::ImmediateAdd ( const Handle< AIS_InteractiveObject > &  theObj,
const Standard_Integer  theMode = 0 
)

Stores presentation theMode of object theObj in the transient list of presentations to be displayed in immediate mode. Will be taken in account in EndImmediateDraw method.

◆ InitDetected()

void AIS_LocalContext::InitDetected ( )

Initialization for iteration through mouse-detected objects in local context.

◆ InitSelected()

void AIS_LocalContext::InitSelected ( )

◆ IsDisplayed() [1/2]

Standard_Boolean AIS_LocalContext::IsDisplayed ( const Handle< AIS_InteractiveObject > &  anObject) const

◆ IsDisplayed() [2/2]

Standard_Boolean AIS_LocalContext::IsDisplayed ( const Handle< AIS_InteractiveObject > &  anObject,
const Standard_Integer  aMode 
) const

◆ IsHilighted()

Standard_Boolean AIS_LocalContext::IsHilighted ( const Handle< AIS_InteractiveObject > &  anObject) const

◆ IsImmediateModeOn()

Standard_Boolean AIS_LocalContext::IsImmediateModeOn ( ) const

Returns true if Presentation Manager is accumulating transient list of presentations to be displayed in immediate mode.

◆ IsIn()

Standard_Boolean AIS_LocalContext::IsIn ( const Handle< AIS_InteractiveObject > &  anObject) const

◆ IsSelected() [1/2]

Standard_Boolean AIS_LocalContext::IsSelected ( const Handle< AIS_InteractiveObject > &  aniobj) const

◆ IsSelected() [2/2]

Standard_Boolean AIS_LocalContext::IsSelected ( const Handle< SelectMgr_EntityOwner > &  anOwner) const

◆ ListOfFilter()

const SelectMgr_ListOfFilter& AIS_LocalContext::ListOfFilter ( ) const

◆ Load()

Standard_Boolean AIS_LocalContext::Load ( const Handle< AIS_InteractiveObject > &  anInteractive,
const Standard_Boolean  AllowShapeDecomposition = Standard_True,
const Standard_Integer  ActivationMode = 0 
)

loads <anInteractive> with nodisplay... returns true if done

◆ LoadContextObjects()

void AIS_LocalContext::LoadContextObjects ( )

◆ MainSelector()

const Handle< StdSelect_ViewerSelector3d >& AIS_LocalContext::MainSelector ( ) const

◆ MoreDetected()

Standard_Boolean AIS_LocalContext::MoreDetected ( ) const
Returns
true if there is more mouse-detected objects after the current one during iteration through mouse-detected interactive objects.

◆ MoreSelected()

Standard_Boolean AIS_LocalContext::MoreSelected ( ) const

◆ MoveTo()

AIS_StatusOfDetection AIS_LocalContext::MoveTo ( const Standard_Integer  theXpix,
const Standard_Integer  theYpix,
const Handle< V3d_View > &  theView,
const Standard_Boolean  theToRedrawImmediate 
)

◆ NextDetected()

void AIS_LocalContext::NextDetected ( )

Gets next current object during iteration through mouse-detected interactive objects.

◆ NextSelected()

void AIS_LocalContext::NextSelected ( )

◆ PixelTolerance()

Standard_Integer AIS_LocalContext::PixelTolerance ( ) const

Returns the pixel tolerance.

◆ Remove()

Standard_Boolean AIS_LocalContext::Remove ( const Handle< AIS_InteractiveObject > &  aSelectable)

◆ RemoveFilter()

void AIS_LocalContext::RemoveFilter ( const Handle< SelectMgr_Filter > &  aFilter)

◆ RestoreActivatedModes()

void AIS_LocalContext::RestoreActivatedModes ( ) const

Iterates through all interactive objects of local context and activates selection modes stored in local status.

◆ Select() [1/3]

AIS_StatusOfPick AIS_LocalContext::Select ( const Standard_Boolean  updateviewer = Standard_True)

◆ Select() [2/3]

AIS_StatusOfPick AIS_LocalContext::Select ( const Standard_Integer  XPMin,
const Standard_Integer  YPMin,
const Standard_Integer  XPMax,
const Standard_Integer  YPMax,
const Handle< V3d_View > &  aView,
const Standard_Boolean  updateviewer = Standard_True 
)

◆ Select() [3/3]

AIS_StatusOfPick AIS_LocalContext::Select ( const TColgp_Array1OfPnt2d Polyline,
const Handle< V3d_View > &  aView,
const Standard_Boolean  updateviewer = Standard_True 
)

◆ SelectedApplicative()

const Handle< Standard_Transient >& AIS_LocalContext::SelectedApplicative ( ) const

◆ SelectedInteractive()

Handle< AIS_InteractiveObject > AIS_LocalContext::SelectedInteractive ( ) const

◆ SelectedOwner()

Handle< SelectMgr_EntityOwner > AIS_LocalContext::SelectedOwner ( ) const

◆ SelectedShape()

TopoDS_Shape AIS_LocalContext::SelectedShape ( ) const

◆ Selection()

const Handle< AIS_Selection > AIS_LocalContext::Selection ( ) const

◆ SelectionModes()

const TColStd_ListOfInteger& AIS_LocalContext::SelectionModes ( const Handle< AIS_InteractiveObject > &  anObject) const

◆ SetAutomaticHilight()

void AIS_LocalContext::SetAutomaticHilight ( const Standard_Boolean  aStatus)

if <aStatus> = True , the shapes or subshapes detected by the selector will be automatically hilighted in the main viewer. Else the user has to manage the detected shape outside the Shape Selector....

◆ SetContext()

void AIS_LocalContext::SetContext ( const Handle< AIS_InteractiveContext > &  aCtx)

◆ SetDisplayPriority()

void AIS_LocalContext::SetDisplayPriority ( const Handle< AIS_InteractiveObject > &  anObject,
const Standard_Integer  Prior 
)

◆ SetPixelTolerance()

void AIS_LocalContext::SetPixelTolerance ( const Standard_Integer  aPrecision = 2)

Define the current selection sensitivity for this local context according to the view size.

◆ SetSelected()

void AIS_LocalContext::SetSelected ( const Handle< AIS_InteractiveObject > &  anobj,
const Standard_Boolean  updateviewer = Standard_True 
)

useful to update selection with objects coming from Collector or stack

◆ SetSelectionSensitivity()

void AIS_LocalContext::SetSelectionSensitivity ( const Handle< AIS_InteractiveObject > &  theObject,
const Standard_Integer  theMode,
const Standard_Integer  theNewSensitivity 
)

Allows to manage sensitivity of a particular selection of interactive object theObject and changes previous sensitivity value of all sensitive entities in selection with theMode to the given theNewSensitivity.

◆ SetShapeDecomposition()

void AIS_LocalContext::SetShapeDecomposition ( const Handle< AIS_InteractiveObject > &  aStoredObject,
const Standard_Boolean  aStatus 
)

allows or forbids the shape decomposition into Activated Standard Mode for <aStoredObject> does nothing if the object doesn't inherits BasicShape from AIS

◆ ShiftSelect() [1/3]

AIS_StatusOfPick AIS_LocalContext::ShiftSelect ( const Standard_Boolean  updateviewer = Standard_True)

◆ ShiftSelect() [2/3]

AIS_StatusOfPick AIS_LocalContext::ShiftSelect ( const Standard_Integer  XPMin,
const Standard_Integer  YPMin,
const Standard_Integer  XPMax,
const Standard_Integer  YPMax,
const Handle< V3d_View > &  aView,
const Standard_Boolean  updateviewer = Standard_True 
)

◆ ShiftSelect() [3/3]

AIS_StatusOfPick AIS_LocalContext::ShiftSelect ( const TColgp_Array1OfPnt2d Polyline,
const Handle< V3d_View > &  aView,
const Standard_Boolean  updateviewer = Standard_True 
)

◆ StandardModes()

const TColStd_ListOfInteger& AIS_LocalContext::StandardModes ( ) const

◆ Status() [1/2]

TCollection_AsciiString AIS_LocalContext::Status ( ) const

◆ Status() [2/2]

const Handle< AIS_LocalStatus >& AIS_LocalContext::Status ( const Handle< AIS_InteractiveObject > &  anObject) const

◆ SubIntensityOff()

void AIS_LocalContext::SubIntensityOff ( const Handle< AIS_InteractiveObject > &  anObject)

◆ SubIntensityOn()

void AIS_LocalContext::SubIntensityOn ( const Handle< AIS_InteractiveObject > &  anObject)

◆ Terminate()

void AIS_LocalContext::Terminate ( const Standard_Boolean  updateviewer = Standard_True)

◆ Unhilight()

void AIS_LocalContext::Unhilight ( const Handle< AIS_InteractiveObject > &  anObject)

◆ UnhilightLastDetected() [1/2]

Standard_Boolean AIS_LocalContext::UnhilightLastDetected ( const Handle< V3d_Viewer > &  theViewer)

returns True if something was done...

◆ UnhilightLastDetected() [2/2]

Standard_Boolean AIS_LocalContext::UnhilightLastDetected ( const Handle< V3d_View > &  theView)

returns True if something was done...

◆ UnhilightPicked()

void AIS_LocalContext::UnhilightPicked ( const Standard_Boolean  updateviewer = Standard_True)

◆ UnloadContextObjects()

void AIS_LocalContext::UnloadContextObjects ( )

◆ UpdateSelected() [1/2]

void AIS_LocalContext::UpdateSelected ( const Standard_Boolean  updateviewer = Standard_True)

◆ UpdateSelected() [2/2]

void AIS_LocalContext::UpdateSelected ( const Handle< AIS_InteractiveObject > &  anobj,
const Standard_Boolean  updateviewer = Standard_True 
)

Part of advanced selection highlighting mechanism. If no owners belonging to anobj are selected, calls anobj->ClearSelected(), otherwise calls anobj->HilightSelected(). This method can be used to avoid redrawing the whole selection belonging to several Selectable Objects.


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