The Interactive Context allows you to manage graphic behavior and selection of Interactive Objects in one or more viewers. Class methods make this highly transparent. It is essential to remember that an Interactive Object which is already known by the Interactive Context must be modified using Context methods. You can only directly call the methods available for an Interactive Object if it has not been loaded into an Interactive Context. More...
#include <AIS_InteractiveContext.hxx>
Public Member Functions | |
object display management | |
| AIS_InteractiveContext (const Handle< V3d_Viewer > &MainViewer) | |
| Constructs the interactive context object defined by the principal viewer MainViewer. More... | |
| virtual | ~AIS_InteractiveContext () |
| Destructor. More... | |
| AIS_DisplayStatus | DisplayStatus (const Handle< AIS_InteractiveObject > &anIobj) const |
| Returns the display status of the entity anIobj. This will be one of the following: More... | |
| void | Status (const Handle< AIS_InteractiveObject > &anObj, TCollection_ExtendedString &astatus) const |
| Returns the status of the Interactive Context for the view of the Interactive Object. More... | |
| Standard_Boolean | IsDisplayed (const Handle< AIS_InteractiveObject > &anIobj) const |
| Returns true if Object is displayed in the interactive context. More... | |
| Standard_Boolean | IsDisplayed (const Handle< AIS_InteractiveObject > &aniobj, const Standard_Integer aMode) const |
| Constructs the interactive context object defined by the principal viewer MainViewer. More... | |
| void | SetAutoActivateSelection (const Standard_Boolean theIsAuto) |
| Enable or disable automatic activation of default selection mode while displaying the object. More... | |
| Standard_Boolean | GetAutoActivateSelection () const |
| Manages displaying the new object should also automatically activate default selection mode; TRUE by default. More... | |
| void | Display (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Boolean theToUpdateViewer) |
| Displays the object in this Context using default Display Mode. This will be the object's default display mode, if there is one. Otherwise, it will be the context mode. The Interactive Object's default selection mode is activated if GetAutoActivateSelection() is TRUE. In general, this is 0. More... | |
| void | Display (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Integer theDispMode, const Standard_Integer theSelectionMode, const Standard_Boolean theToUpdateViewer, const Standard_Boolean theToAllowDecomposition=Standard_True, const AIS_DisplayStatus theDispStatus=AIS_DS_None) |
| Sets status, display mode and selection mode for specified Object If theSelectionMode equals -1, theIObj will not be activated: it will be displayed but will not be selectable. More... | |
| void | Load (const Handle< AIS_InteractiveObject > &aniobj, const Standard_Integer SelectionMode=-1, const Standard_Boolean AllowDecomp=Standard_False) |
| Allows you to load the Interactive Object with a given selection mode, and/or with the desired decomposition option, whether the object is visualized or not. If AllowDecomp = Standard_True and, if the interactive object is of the "Shape" type, these "standard" selection modes will be automatically activated as a function of the modes present in the Local Context. The loaded objects will be selectable but displayable in highlighting only when detected by the Selector. More... | |
| void | Erase (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Boolean theToUpdateViewer) |
| Hides the object. The object's presentations are simply flagged as invisible and therefore excluded from redrawing. To show hidden objects, use Display(). More... | |
| void | EraseAll (const Standard_Boolean theToUpdateViewer) |
| Hides all objects. The object's presentations are simply flagged as invisible and therefore excluded from redrawing. To show all hidden objects, use DisplayAll(). More... | |
| void | DisplayAll (const Standard_Boolean theToUpdateViewer) |
| Displays all hidden objects. More... | |
| void | EraseSelected (const Standard_Boolean theToUpdateViewer) |
| Hides selected objects. The object's presentations are simply flagged as invisible and therefore excluded from redrawing. To show hidden objects, use Display(). More... | |
| void | DisplaySelected (const Standard_Boolean theToUpdateViewer) |
| Displays current objects. More... | |
| void | ClearPrs (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Integer theMode, const Standard_Boolean theToUpdateViewer) |
| Empties the graphic presentation of the mode indexed by aMode. Warning! Removes theIObj. theIObj is still active if it was previously activated. More... | |
| void | Remove (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Boolean theToUpdateViewer) |
| Removes Object from every viewer. More... | |
| void | RemoveAll (const Standard_Boolean theToUpdateViewer) |
| Removes all the objects from Context. More... | |
| void | Redisplay (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Boolean theToUpdateViewer, const Standard_Boolean theAllModes=Standard_False) |
| Recomputes the seen parts presentation of the Object. If theAllModes equals true, all presentations are present in the object even if unseen. More... | |
| void | Redisplay (const AIS_KindOfInteractive theTypeOfObject, const Standard_Integer theSignature, const Standard_Boolean theToUpdateViewer) |
| Recomputes the Prs/Selection of displayed objects of a given type and a given signature. if signature = -1 doesn't take signature criterion. More... | |
| void | RecomputePrsOnly (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Boolean theToUpdateViewer, const Standard_Boolean theAllModes=Standard_False) |
| Recomputes the displayed presentations, flags the others. Doesn't update presentations. More... | |
| void | RecomputeSelectionOnly (const Handle< AIS_InteractiveObject > &anIObj) |
| Recomputes the active selections, flags the others. Doesn't update presentations. More... | |
| void | Update (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Boolean theUpdateViewer) |
| Updates displayed interactive object by checking and recomputing its flagged as "to be recomputed" presentation and selection structures. This method does not force any recomputation on its own. The method recomputes selections even if they are loaded without activation in particular selector. More... | |
object presence management (View affinity, Layer, Priority) | |
| Standard_Integer | DisplayPriority (const Handle< AIS_InteractiveObject > &theIObj) const |
| Returns the display priority of the Object. More... | |
| void | SetDisplayPriority (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Integer thePriority) |
| Sets the display priority of the seen parts presentation of the Object. More... | |
| Graphic3d_ZLayerId | GetZLayer (const Handle< AIS_InteractiveObject > &theIObj) const |
| Get Z layer id set for displayed interactive object. More... | |
| void | SetZLayer (const Handle< AIS_InteractiveObject > &theIObj, const Graphic3d_ZLayerId theLayerId) |
| Set Z layer id for interactive object. The Z layers can be used to display temporarily presentations of some object in front of the other objects in the scene. The ids for Z layers are generated by V3d_Viewer. More... | |
| void | SetViewAffinity (const Handle< AIS_InteractiveObject > &theIObj, const Handle< V3d_View > &theView, const Standard_Boolean theIsVisible) |
| Setup object visibility in specified view. Has no effect if object is not displayed in this context. More... | |
Display Mode management | |
| Standard_Integer | DisplayMode () const |
| Returns the Display Mode setting to be used by default. More... | |
| void | SetDisplayMode (const Standard_Integer theMode, const Standard_Boolean theToUpdateViewer) |
| Sets the display mode of seen Interactive Objects (which have no overridden Display Mode). More... | |
| void | SetDisplayMode (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Integer theMode, const Standard_Boolean theToUpdateViewer) |
| Sets the display mode of seen Interactive Objects. theMode provides the display mode index of the entity theIObj. More... | |
| void | UnsetDisplayMode (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Boolean theToUpdateViewer) |
| Unsets the display mode of seen Interactive Objects. More... | |
iteration through detected entities | |
| void | InitDetected () |
| Initialization for iteration through mouse-detected objects in interactive context or in local context if it is opened. More... | |
| Standard_Boolean | MoreDetected () const |
| Return TRUE if there is more mouse-detected objects after the current one during iteration through mouse-detected interactive objects. More... | |
| void | NextDetected () |
| Gets next current object during iteration through mouse-detected interactive objects. More... | |
| Handle< SelectMgr_EntityOwner > | DetectedCurrentOwner () const |
| Returns the owner from detected list pointed by current iterator position. WARNING! This method is irrelevant to DetectedOwner() which returns last picked Owner regardless of iterator position! More... | |
immediate mode rendering | |
| Standard_Boolean | BeginImmediateDraw () |
| initializes the list of presentations to be displayed returns False if no local context is opened. More... | |
| Standard_Boolean | ImmediateAdd (const Handle< AIS_InteractiveObject > &theObj, const Standard_Integer theMode=0) |
| returns True if <anIObj> has been stored in the list. More... | |
| Standard_Boolean | EndImmediateDraw (const Handle< V3d_View > &theView) |
| returns True if the immediate display has been done. More... | |
| Standard_Boolean | EndImmediateDraw () |
| Uses the First Active View of Main Viewer! returns True if the immediate display has been done. More... | |
| Standard_Boolean | IsImmediateModeOn () const |
| initializes the list of presentations to be displayed returns False if no local context is opened. More... | |
| void | RedrawImmediate (const Handle< V3d_Viewer > &theViewer) |
| Redraws immediate structures in all views of the viewer given taking into account its visibility. More... | |
management of active Selection Modes | |
| void | SetSelectionModeActive (const Handle< AIS_InteractiveObject > &theObj, const Standard_Integer theMode, const Standard_Boolean theToActivate, const AIS_SelectionModesConcurrency theConcurrency=AIS_SelectionModesConcurrency_Multiple, const Standard_Boolean theIsForce=Standard_False) |
| Activates or deactivates the selection mode for specified object. Has no effect if selection mode was already active/deactivated. More... | |
| void | Activate (const Handle< AIS_InteractiveObject > &theObj, const Standard_Integer theMode=0, const Standard_Boolean theIsForce=Standard_False) |
| Activates the selection mode aMode whose index is given, for the given interactive entity anIobj. More... | |
| void | Activate (const Standard_Integer theMode, const Standard_Boolean theIsForce=Standard_False) |
| Activates the given selection mode for the all displayed objects. More... | |
| void | Deactivate (const Handle< AIS_InteractiveObject > &theObj) |
| Deactivates all the activated selection modes of an object. More... | |
| void | Deactivate (const Handle< AIS_InteractiveObject > &theObj, const Standard_Integer theMode) |
| Deactivates all the activated selection modes of the interactive object anIobj with a given selection mode aMode. More... | |
| void | Deactivate (const Standard_Integer theMode) |
| Deactivates the given selection mode for all displayed objects. More... | |
| void | Deactivate () |
| Deactivates all the activated selection mode at all displayed objects. More... | |
| void | ActivatedModes (const Handle< AIS_InteractiveObject > &anIobj, TColStd_ListOfInteger &theList) const |
| Returns the list of activated selection modes. More... | |
| void | EntityOwners (Handle< SelectMgr_IndexedMapOfOwner > &theOwners, const Handle< AIS_InteractiveObject > &theIObj, const Standard_Integer theMode=-1) const |
| Returns a collection containing all entity owners created for the interactive object in specified selection mode (in all active modes if the Mode == -1) More... | |
Selection Filters management | |
| const SelectMgr_ListOfFilter & | Filters () const |
| Returns the list of filters active in a local context. More... | |
| void | AddFilter (const Handle< SelectMgr_Filter > &theFilter) |
| Allows you to add the filter. More... | |
| void | RemoveFilter (const Handle< SelectMgr_Filter > &theFilter) |
| Removes a filter from context. More... | |
| void | RemoveFilters () |
| Remove all filters from context. More... | |
| SelectMgr_PickingStrategy | PickingStrategy () const |
| Return picking strategy; SelectMgr_PickingStrategy_FirstAcceptable by default. More... | |
| void | SetPickingStrategy (const SelectMgr_PickingStrategy theStrategy) |
| Setup picking strategy - which entities detected by picking line will be accepted, considering Selection Filters. By default (SelectMgr_PickingStrategy_FirstAcceptable), Selection Filters reduce the list of entities so that the context accepts topmost in remaining. More... | |
common properties | |
| const Handle< Prs3d_Drawer > & | DefaultDrawer () const |
| Returns the default attribute manager. This contains all the color and line attributes which can be used by interactive objects which do not have their own attributes. More... | |
| const Handle< V3d_Viewer > & | CurrentViewer () const |
| Returns the current viewer. More... | |
| const Handle< SelectMgr_SelectionManager > & | SelectionManager () const |
| Returns the default attribute manager. This contains all the color and line attributes which can be used by interactive objects which do not have their own attributes. More... | |
| const Handle< PrsMgr_PresentationManager3d > & | MainPrsMgr () const |
| Returns the default attribute manager. This contains all the color and line attributes which can be used by interactive objects which do not have their own attributes. More... | |
| const Handle< StdSelect_ViewerSelector3d > & | MainSelector () const |
| Returns the default attribute manager. This contains all the color and line attributes which can be used by interactive objects which do not have their own attributes. More... | |
| void | UpdateCurrentViewer () |
| Updates the current viewer. More... | |
| void | DisplayedObjects (AIS_ListOfInteractive &aListOfIO, const Standard_Boolean OnlyFromNeutral=Standard_False) const |
| Returns the list of displayed objects of a particular Type WhichKind and Signature WhichSignature. By Default, WhichSignature equals -1. This means that there is a check on type only. More... | |
| void | DisplayedObjects (const AIS_KindOfInteractive WhichKind, const Standard_Integer WhichSignature, AIS_ListOfInteractive &aListOfIO, const Standard_Boolean OnlyFromNeutral=Standard_False) const |
| gives the list of displayed objects of a particular Type and signature. by Default, <WhichSignature> = -1 means control only on <WhichKind>. More... | |
| void | ErasedObjects (AIS_ListOfInteractive &theListOfIO) const |
| Returns the list theListOfIO of erased objects (hidden objects) particular Type WhichKind and Signature WhichSignature. By Default, WhichSignature equals 1. This means that there is a check on type only. More... | |
| void | ErasedObjects (const AIS_KindOfInteractive WhichKind, const Standard_Integer WhichSignature, AIS_ListOfInteractive &theListOfIO) const |
| gives the list of erased objects (hidden objects) Type and signature by Default, <WhichSignature> = -1 means control only on <WhichKind>. More... | |
| void | ObjectsByDisplayStatus (const AIS_DisplayStatus theStatus, AIS_ListOfInteractive &theListOfIO) const |
| Returns the list theListOfIO of objects with indicated display status particular Type WhichKind and Signature WhichSignature. By Default, WhichSignature equals 1. This means that there is a check on type only. More... | |
| void | ObjectsByDisplayStatus (const AIS_KindOfInteractive WhichKind, const Standard_Integer WhichSignature, const AIS_DisplayStatus theStatus, AIS_ListOfInteractive &theListOfIO) const |
| gives the list of objects with indicated display status Type and signature by Default, <WhichSignature> = -1 means control only on <WhichKind>. More... | |
| void | ObjectsInside (AIS_ListOfInteractive &aListOfIO, const AIS_KindOfInteractive WhichKind=AIS_KOI_None, const Standard_Integer WhichSignature=-1) const |
| fills <aListOfIO> with objects of a particular Type and Signature with no consideration of display status. by Default, <WhichSignature> = -1 means control only on <WhichKind>. if <WhichKind> = AIS_KOI_None and <WhichSignature> = -1, all the objects are put into the list. More... | |
| void | RebuildSelectionStructs () |
| Rebuilds 1st level of BVH selection forcibly. More... | |
| void | Disconnect (const Handle< AIS_InteractiveObject > &theAssembly, const Handle< AIS_InteractiveObject > &theObjToDisconnect=NULL) |
| Disconnects theObjToDisconnect from theAssembly and removes dependent selection structures. More... | |
| void | ObjectsForView (AIS_ListOfInteractive &theListOfIO, const Handle< V3d_View > &theView, const Standard_Boolean theIsVisibleInView, const AIS_DisplayStatus theStatus=AIS_DS_None) const |
| Query objects visible or hidden in specified view due to affinity mask. More... | |
| Standard_Integer | PurgeDisplay () |
| Clears all the structures which don't belong to objects displayed at neutral point only effective when no Local Context is opened... returns the number of removed structures from the viewers. More... | |
debug visualization | |
| void | DisplayActiveSensitive (const Handle< V3d_View > &aView) |
| Visualization of sensitives - for debugging purposes! More... | |
| void | ClearActiveSensitive (const Handle< V3d_View > &aView) |
| Clear visualization of sensitives. More... | |
| void | DisplayActiveSensitive (const Handle< AIS_InteractiveObject > &anObject, const Handle< V3d_View > &aView) |
| Visualization of sensitives - for debugging purposes! More... | |
common object display attributes | |
| void | SetLocalAttributes (const Handle< AIS_InteractiveObject > &theIObj, const Handle< Prs3d_Drawer > &theDrawer, const Standard_Boolean theToUpdateViewer) |
| Sets the graphic attributes of the interactive object, such as visualization mode, color, and material. More... | |
| void | UnsetLocalAttributes (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Boolean theToUpdateViewer) |
| Removes the settings for local attributes of the Object and returns to defaults. More... | |
| void | SetCurrentFacingModel (const Handle< AIS_InteractiveObject > &aniobj, const Aspect_TypeOfFacingModel aModel=Aspect_TOFM_BOTH_SIDE) |
| change the current facing model apply on polygons for SetColor(), SetTransparency(), SetMaterial() methods default facing model is Aspect_TOFM_TWO_SIDE. This mean that attributes is applying both on the front and back face. More... | |
| Standard_Boolean | HasColor (const Handle< AIS_InteractiveObject > &aniobj) const |
| Returns true if a view of the Interactive Object has color. More... | |
| void | Color (const Handle< AIS_InteractiveObject > &aniobj, Quantity_Color &acolor) const |
| Returns the color of the Object in the interactive context. More... | |
| void | SetColor (const Handle< AIS_InteractiveObject > &theIObj, const Quantity_Color &theColor, const Standard_Boolean theToUpdateViewer) |
| Sets the color of the selected entity. More... | |
| void | UnsetColor (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Boolean theToUpdateViewer) |
| Removes the color selection for the selected entity. More... | |
| virtual Standard_Real | Width (const Handle< AIS_InteractiveObject > &aniobj) const |
| Returns the width of the Interactive Object in the interactive context. More... | |
| virtual void | SetWidth (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Real theValue, const Standard_Boolean theToUpdateViewer) |
| Sets the width of the Object. More... | |
| virtual void | UnsetWidth (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Boolean theToUpdateViewer) |
| Removes the width setting of the Object. More... | |
| void | SetMaterial (const Handle< AIS_InteractiveObject > &theIObj, const Graphic3d_MaterialAspect &theMaterial, const Standard_Boolean theToUpdateViewer) |
| Provides the type of material setting for the view of the Object. More... | |
| void | UnsetMaterial (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Boolean theToUpdateViewer) |
| Removes the type of material setting for viewing the Object. More... | |
| void | SetTransparency (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Real theValue, const Standard_Boolean theToUpdateViewer) |
| Provides the transparency settings for viewing the Object. The transparency value aValue may be between 0.0, opaque, and 1.0, fully transparent. More... | |
| void | UnsetTransparency (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Boolean theToUpdateViewer) |
| Removes the transparency settings for viewing the Object. More... | |
| void | SetPolygonOffsets (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Integer theMode, const Standard_ShortReal theFactor, const Standard_ShortReal theUnits, const Standard_Boolean theToUpdateViewer) |
| Sets up polygon offsets for the given AIS_InteractiveObject. It simply calls AIS_InteractiveObject::SetPolygonOffsets(). More... | |
| Standard_Boolean | HasPolygonOffsets (const Handle< AIS_InteractiveObject > &anObj) const |
| Simply calls AIS_InteractiveObject::HasPolygonOffsets(). More... | |
| void | PolygonOffsets (const Handle< AIS_InteractiveObject > &anObj, Standard_Integer &aMode, Standard_ShortReal &aFactor, Standard_ShortReal &aUnits) const |
| Retrieves current polygon offsets settings for Object. More... | |
trihedron display attributes | |
| void | SetTrihedronSize (const Standard_Real theSize, const Standard_Boolean theToUpdateViewer) |
| Sets the size aSize of the trihedron. Is used to change the default value 100 mm for display of trihedra. Use of this function in one of your own interactive objects requires a call to the Compute function of the new class. This will recalculate the presentation for every trihedron displayed. More... | |
| Standard_Real | TrihedronSize () const |
| returns the current value of trihedron size. More... | |
plane display attributes | |
| void | SetPlaneSize (const Standard_Real theSizeX, const Standard_Real theSizeY, const Standard_Boolean theToUpdateViewer) |
| Sets the plane size defined by the length in the X direction XSize and that in the Y direction YSize. More... | |
| void | SetPlaneSize (const Standard_Real theSize, const Standard_Boolean theToUpdateViewer) |
| Sets the plane size aSize. More... | |
| Standard_Boolean | PlaneSize (Standard_Real &XSize, Standard_Real &YSize) const |
| Returns true if the length in the X direction XSize is the same as that in the Y direction YSize. More... | |
tessellation deviation properties for automatic triangulation | |
| void | SetDeviationCoefficient (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Real theCoefficient, const Standard_Boolean theToUpdateViewer) |
| Sets the deviation coefficient theCoefficient. Drawings of curves or patches are made with respect to a maximal chordal deviation. A Deviation coefficient is used in the shading display mode. The shape is seen decomposed into triangles. These are used to calculate reflection of light from the surface of the object. The triangles are formed from chords of the curves in the shape. The deviation coefficient theCoefficient gives the highest value of the angle with which a chord can deviate from a tangent to a curve. If this limit is reached, a new triangle is begun. This deviation is absolute and is set through the method: SetMaximalChordialDeviation. The default value is 0.001. In drawing shapes, however, you are allowed to ask for a relative deviation. This deviation will be: SizeOfObject * DeviationCoefficient. More... | |
| void | SetDeviationAngle (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Real theAngle, const Standard_Boolean theToUpdateViewer) |
| Sets the deviation coefficient theCoefficient. Drawings of curves or patches are made with respect to a maximal chordal deviation. A Deviation coefficient is used in the shading display mode. The shape is seen decomposed into triangles. These are used to calculate reflection of light from the surface of the object. The triangles are formed from chords of the curves in the shape. The deviation coefficient theCoefficient gives the highest value of the angle with which a chord can deviate from a tangent to a curve. If this limit is reached, a new triangle is begun. This deviation is absolute and is set through the method: SetMaximalChordialDeviation. The default value is 0.001. In drawing shapes, however, you are allowed to ask for a relative deviation. This deviation will be: SizeOfObject * DeviationCoefficient. More... | |
| void | SetAngleAndDeviation (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Real theAngle, const Standard_Boolean theToUpdateViewer) |
| Calls the AIS_Shape SetAngleAndDeviation to set both Angle and Deviation coefficients. More... | |
| void | SetHLRDeviationCoefficient (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Real theCoefficient, const Standard_Boolean theToUpdateViewer) |
| Sets the deviation coefficient aCoefficient for removal of hidden lines created by different viewpoints in different presentations. The Default value is 0.02. More... | |
| void | SetHLRDeviationAngle (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Real theAngle, const Standard_Boolean theToUpdateViewer) |
| Sets the deviation coefficient theCoefficient. Drawings of curves or patches are made with respect to a maximal chordal deviation. A Deviation coefficient is used in the shading display mode. The shape is seen decomposed into triangles. These are used to calculate reflection of light from the surface of the object. The triangles are formed from chords of the curves in the shape. The deviation coefficient theCoefficient gives the highest value of the angle with which a chord can deviate from a tangent to a curve. If this limit is reached, a new triangle is begun. This deviation is absolute and is set through the method: SetMaximalChordialDeviation. The default value is 0.001. In drawing shapes, however, you are allowed to ask for a relative deviation. This deviation will be: SizeOfObject * DeviationCoefficient. More... | |
| void | SetHLRAngleAndDeviation (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Real theAngle, const Standard_Boolean theToUpdateViewer) |
| Computes a HLRAngle and a HLRDeviationCoefficient by means of the angle anAngle and sets the corresponding methods in the default drawing tool with these values. More... | |
| void | SetDeviationCoefficient (const Standard_Real theCoefficient) |
| Sets the deviation coefficient theCoefficient. Drawings of curves or patches are made with respect to a maximal chordal deviation. A Deviation coefficient is used in the shading display mode. The shape is seen decomposed into triangles. These are used to calculate reflection of light from the surface of the object. The triangles are formed from chords of the curves in the shape. The deviation coefficient theCoefficient gives the highest value of the angle with which a chord can deviate from a tangent to a curve. If this limit is reached, a new triangle is begun. This deviation is absolute and is set through the method: SetMaximalChordialDeviation. The default value is 0.001. In drawing shapes, however, you are allowed to ask for a relative deviation. This deviation will be: SizeOfObject * DeviationCoefficient. More... | |
| Standard_Real | DeviationCoefficient () const |
| Returns the deviation coefficient. Drawings of curves or patches are made with respect to a maximal chordal deviation. A Deviation coefficient is used in the shading display mode. The shape is seen decomposed into triangles. These are used to calculate reflection of light from the surface of the object. The triangles are formed from chords of the curves in the shape. The deviation coefficient gives the highest value of the angle with which a chord can deviate from a tangent to a curve. If this limit is reached, a new triangle is begun. This deviation is absolute and is set through Prs3d_Drawer::SetMaximalChordialDeviation. The default value is 0.001. In drawing shapes, however, you are allowed to ask for a relative deviation. This deviation will be: SizeOfObject * DeviationCoefficient. More... | |
| void | SetDeviationAngle (const Standard_Real anAngle) |
| default 12 degrees More... | |
| Standard_Real | DeviationAngle () const |
| Sets the deviation coefficient theCoefficient. Drawings of curves or patches are made with respect to a maximal chordal deviation. A Deviation coefficient is used in the shading display mode. The shape is seen decomposed into triangles. These are used to calculate reflection of light from the surface of the object. The triangles are formed from chords of the curves in the shape. The deviation coefficient theCoefficient gives the highest value of the angle with which a chord can deviate from a tangent to a curve. If this limit is reached, a new triangle is begun. This deviation is absolute and is set through the method: SetMaximalChordialDeviation. The default value is 0.001. In drawing shapes, however, you are allowed to ask for a relative deviation. This deviation will be: SizeOfObject * DeviationCoefficient. More... | |
| void | SetHLRDeviationCoefficient (const Standard_Real aCoefficient) |
| Sets the deviation coefficient aCoefficient for removal of hidden lines created by different viewpoints in different presentations. The Default value is 0.02. More... | |
| Standard_Real | HLRDeviationCoefficient () const |
| Returns the real number value of the hidden line removal deviation coefficient. A Deviation coefficient is used in the shading display mode. The shape is seen decomposed into triangles. These are used to calculate reflection of light from the surface of the object. The triangles are formed from chords of the curves in the shape. The deviation coefficient give the highest value of the angle with which a chord can deviate from a tangent to a curve. If this limit is reached, a new triangle is begun. To find the hidden lines, hidden line display mode entails recalculation of the view at each different projector perspective. Because hidden lines entail calculations of more than usual complexity to decompose them into these triangles, a deviation coefficient allowing greater tolerance is used. This increases efficiency in calculation. The Default value is 0.02. More... | |
| void | SetHLRAngle (const Standard_Real theAngle) |
| Sets the HLR angle. More... | |
| Standard_Real | HLRAngle () const |
| Returns the real number value of the deviation angle in hidden line removal views in this interactive context. The default value is 20*PI/180. More... | |
| void | SetHLRAngleAndDeviation (const Standard_Real theAngle) |
| compute with theAngle a HLRAngle and a HLRDeviationCoefficient and set them in myHLRAngle and in myHLRDeviationCoefficient of myDefaultDrawer; theAngle is in radian; ( 1 deg < angle in deg < 20 deg) More... | |
HLR (Hidden Line Removal) display attributes | |
| Handle< Prs3d_LineAspect > | HiddenLineAspect () const |
| Initializes hidden line aspect in the default drawing tool, or Drawer. The default values are: Color: Quantity_NOC_YELLOW Type of line: Aspect_TOL_DASH Width: 1. More... | |
| void | SetHiddenLineAspect (const Handle< Prs3d_LineAspect > &anAspect) const |
| Sets the hidden line aspect anAspect. Aspect defines display attributes for hidden lines in HLR projections. More... | |
| Standard_Boolean | DrawHiddenLine () const |
| returns Standard_True if the hidden lines are to be drawn. By default the hidden lines are not drawn. More... | |
| void | EnableDrawHiddenLine () const |
| Initializes hidden line aspect in the default drawing tool, or Drawer. The default values are: Color: Quantity_NOC_YELLOW Type of line: Aspect_TOL_DASH Width: 1. More... | |
| void | DisableDrawHiddenLine () const |
| Initializes hidden line aspect in the default drawing tool, or Drawer. The default values are: Color: Quantity_NOC_YELLOW Type of line: Aspect_TOL_DASH Width: 1. More... | |
iso-line display attributes | |
| void | SetIsoNumber (const Standard_Integer NbIsos, const AIS_TypeOfIso WhichIsos=AIS_TOI_Both) |
| Sets the number of U and V isoparameters displayed. More... | |
| Standard_Integer | IsoNumber (const AIS_TypeOfIso WhichIsos=AIS_TOI_Both) |
| Returns the number of U and V isoparameters displayed. More... | |
| void | IsoOnPlane (const Standard_Boolean SwitchOn) |
| Returns True if drawing isoparameters on planes is enabled. More... | |
| Standard_Boolean | IsoOnPlane () const |
| Returns True if drawing isoparameters on planes is enabled. if <forUIsos> = False,. More... | |
| void | IsoOnTriangulation (const Standard_Boolean theIsEnabled, const Handle< AIS_InteractiveObject > &theObject) |
| Enables or disables on-triangulation build for isolines for a particular object. In case if on-triangulation builder is disabled, default on-plane builder will compute isolines for the object given. More... | |
| void | IsoOnTriangulation (const Standard_Boolean theToSwitchOn) |
| Enables or disables on-triangulation build for isolines for default drawer. In case if on-triangulation builder is disabled, default on-plane builder will compute isolines for the object given. More... | |
| Standard_Boolean | IsoOnTriangulation () const |
| Returns true if drawing isolines on triangulation algorithm is enabled. More... | |
sub-intensity management (deprecated) | |
| const Quantity_Color & | SubIntensityColor () const |
| Sub-intensity allows temporary highlighting of particular objects with specified color in a manner of selection highlight, but without actual selection (e.g., global status and owner's selection state will not be updated). The method returns the color of such highlighting. By default, it is Quantity_NOC_GRAY40. More... | |
| void | SetSubIntensityColor (const Quantity_Color &theColor) |
| Sub-intensity allows temporary highlighting of particular objects with specified color in a manner of selection highlight, but without actual selection (e.g., global status and owner's selection state will not be updated). The method sets up the color for such highlighting. By default, this is Quantity_NOC_GRAY40. More... | |
| void | SubIntensityOn (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Boolean theToUpdateViewer) |
| Highlights, and removes highlights from, the displayed object which is displayed at Neutral Point with subintensity color. Available only for active local context. There is no effect if there is no local context. If a local context is open, the presentation of the Interactive Object activates the selection mode. More... | |
| void | SubIntensityOff (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Boolean theToUpdateViewer) |
| Removes the subintensity option for the entity. If a local context is open, the presentation of the Interactive Object activates the selection mode. More... | |
| void | SubIntensityOn (const Standard_Boolean theToUpdateViewer) |
| hilights/unhilights displayed objects which are displayed at neutral state with subintensity color. Available only for active local context. No effect if no local context. More... | |
| void | SubIntensityOff (const Standard_Boolean theToUpdateViewer) |
| Removes subintensity option for all objects. 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 Member Functions | |
internal methods | |
| void | GetDefModes (const Handle< AIS_InteractiveObject > &anIobj, Standard_Integer &Dmode, Standard_Integer &HiMod, Standard_Integer &SelMode) const |
| UNKNOWN. More... | |
| void | EraseGlobal (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Boolean theToUpdateViewer) |
| UNKNOWN. More... | |
| void | ClearGlobal (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Boolean theToUpdateViewer) |
| UNKNOWN. More... | |
| void | ClearGlobalPrs (const Handle< AIS_InteractiveObject > &theObj, const Standard_Integer theMode, const Standard_Boolean theToUpdateViewer) |
| UNKNOWN. More... | |
| void | InitAttributes () |
| UNKNOWN. More... | |
| Standard_Integer | PurgeViewer (const Handle< V3d_Viewer > &Vwr) |
| UNKNOWN. More... | |
| void | redisplayPrsModes (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Boolean theToUpdateViewer) |
| UNKNOWN. More... | |
| void | redisplayPrsRecModes (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Boolean theToUpdateViewer) |
| UNKNOWN. More... | |
| void | unhighlightOwners (const Handle< AIS_InteractiveObject > &theObject) |
| Helper function to unhighlight all entity owners currently highlighted with seleciton color. More... | |
| void | highlightWithColor (const Handle< SelectMgr_EntityOwner > &theOwner, const Handle< V3d_Viewer > &theViewer=NULL) |
| Helper function that highlights the owner given with <theStyle> without performing AutoHighlight checks, e.g. is used for dynamic highlight. More... | |
| void | highlightSelected (const Handle< SelectMgr_EntityOwner > &theOwner) |
| Helper function that highlights the owner given with <theStyle> with check for AutoHighlight, e.g. is used for selection. More... | |
| void | highlightGlobal (const Handle< AIS_InteractiveObject > &theObj, const Handle< Prs3d_Drawer > &theStyle, const Standard_Integer theDispMode) const |
| Helper function that highlights global owner of the object given with <theStyle> with check for AutoHighlight, e.g. is used for selection. If global owner is null, it simply highlights the whole object. More... | |
| void | unhighlightSelected (const Standard_Boolean theIsToHilightSubIntensity=Standard_False) |
| Helper function that unhighlights all owners that are stored in current AIS_Selection. The function updates global status and selection state of owner and interactive object. If the parameter <theIsToHilightSubIntensity> is set to true, interactive objects with sub-intensity switched on in AIS_GlobalStatus will be highlighted with context's sub-intensity color. More... | |
| void | unhighlightGlobal (const Handle< AIS_InteractiveObject > &theObj) const |
| Helper function that unhighlights global selection owner of given interactive. The function does not perform any updates of global or owner status. More... | |
| void | turnOnSubintensity (const Handle< AIS_InteractiveObject > &theObject=NULL, const Standard_Integer theDispMode=-1, const Standard_Boolean theIsDisplayedOnly=Standard_True) const |
| Helper function that turns on sub-intensity in global status and highlights given objects with sub-intensity color. More... | |
| void | highlightWithSubintensity (const Handle< AIS_InteractiveObject > &theObject, const Standard_Integer theMode) const |
| Helper function that highlights the object with sub-intensity color without any checks. More... | |
| void | highlightWithSubintensity (const Handle< SelectMgr_EntityOwner > &theOwner, const Standard_Integer theMode) const |
| Helper function that highlights the owner with sub-intensity color without any checks. More... | |
| const Handle< Prs3d_Drawer > & | getHiStyle (const Handle< AIS_InteractiveObject > &theObj, const Handle< SelectMgr_EntityOwner > &theOwner) const |
| Helper function that returns correct dynamic highlight style for the object: if custom style is defined via object's highlight drawer, it will be used. Otherwise, dynamic highlight style of interactive context will be returned. More... | |
| const Handle< Prs3d_Drawer > & | getSelStyle (const Handle< AIS_InteractiveObject > &theObj, const Handle< SelectMgr_EntityOwner > &theOwner) const |
| Helper function that returns correct selection style for the object: if custom style is defined via object's highlight drawer, it will be used. Otherwise, selection style of interactive context will be returned. More... | |
| void | setContextToObject (const Handle< AIS_InteractiveObject > &theObj) |
| Assign the context to the object or throw exception if object was already assigned to another context. More... | |
| Standard_Integer | getHilightMode (const Handle< AIS_InteractiveObject > &theObj, const Handle< Prs3d_Drawer > &theStyle, const Standard_Integer theDispMode) const |
| Return display mode for highlighting. More... | |
| void | clearDynamicHighlight () const |
| Removes dynamic highlight draw. More... | |
highlighting management | |
| const Standard_Boolean | theIsToUpdateViewer |
| Returns highlight style settings. More... | |
| const Handle< Prs3d_Drawer > & | HighlightStyle (const Prs3d_TypeOfHighlight theStyleType) const |
| Returns highlight style settings. More... | |
| void | SetHighlightStyle (const Prs3d_TypeOfHighlight theStyleType, const Handle< Prs3d_Drawer > &theStyle) |
| Setup highlight style settings. More... | |
| const Handle< Prs3d_Drawer > & | HighlightStyle () const |
| Returns current dynamic highlight style settings. By default: More... | |
| void | SetHighlightStyle (const Handle< Prs3d_Drawer > &theStyle) |
| Setup the style of dynamic highlighting. More... | |
| const Handle< Prs3d_Drawer > & | SelectionStyle () const |
| Returns current selection style settings. By default: More... | |
| void | SetSelectionStyle (const Handle< Prs3d_Drawer > &theStyle) |
| Setup the style of selection highlighting. More... | |
| Standard_Boolean | HighlightStyle (const Handle< AIS_InteractiveObject > &theObj, Handle< Prs3d_Drawer > &theStyle) const |
| Returns highlight style of the object if it is marked as highlighted via global status. More... | |
| Standard_Boolean | HighlightStyle (const Handle< SelectMgr_EntityOwner > &theOwner, Handle< Prs3d_Drawer > &theStyle) const |
| Returns highlight style of the owner if it is selected. More... | |
| Standard_Boolean | IsHilighted (const Handle< AIS_InteractiveObject > &theObj) const |
| Returns true if the object is marked as highlighted via its global status. More... | |
| Standard_Boolean | IsHilighted (const Handle< SelectMgr_EntityOwner > &theOwner) const |
| Returns true if the owner is marked as selected. More... | |
| Standard_DEPRECATED ("Deprecated method Hilight()") void Hilight(const Handle< AIS_InteractiveObject > &theObj | |
| Updates the display in the viewer to take dynamic detection into account. On dynamic detection by the mouse cursor, sensitive primitives are highlighted. The highlight color of entities detected by mouse movement is white by default. More... | |
| void | HilightWithColor (const Handle< AIS_InteractiveObject > &theObj, const Handle< Prs3d_Drawer > &theStyle, const Standard_Boolean theToUpdateViewer) |
| Changes the color of all the lines of the object in view. More... | |
| void | Unhilight (const Handle< AIS_InteractiveObject > &theIObj, const Standard_Boolean theToUpdateViewer) |
| Removes hilighting from the Object. More... | |
object local transformation management | |
| const Graphic3d_TransModeFlags & | theFlag |
| Puts the location on the initial graphic representation and the selection for the Object. More... | |
| const Graphic3d_TransModeFlags const gp_Pnt & | thePoint |
| Puts the location on the initial graphic representation and the selection for the Object. More... | |
| void | SetLocation (const Handle< AIS_InteractiveObject > &theObject, const TopLoc_Location &theLocation) |
| Puts the location on the initial graphic representation and the selection for the Object. More... | |
| void | ResetLocation (const Handle< AIS_InteractiveObject > &theObject) |
| Puts the Object back into its initial position. More... | |
| Standard_Boolean | HasLocation (const Handle< AIS_InteractiveObject > &theObject) const |
| Returns true if the Object has a location. More... | |
| TopLoc_Location | Location (const Handle< AIS_InteractiveObject > &theObject) const |
| Returns the location of the Object. More... | |
| void | SetTransformPersistence (const Handle< AIS_InteractiveObject > &theObject, const Handle< Graphic3d_TransformPers > &theTrsfPers) |
| Sets transform persistence. More... | |
| Standard_DEPRECATED ("This method is deprecated - SetTransformPersistence() taking Graphic3d_TransformPers should be called instead") void SetTransformPersistence(const Handle< AIS_InteractiveObject > &theObj | |
| Puts the location on the initial graphic representation and the selection for the Object. More... | |
| Standard_Integer | PixelTolerance () const |
| Returns the pixel tolerance, default is 2. Pixel Tolerance extends sensitivity within MoveTo() operation (picking by point) and can be adjusted by application based on user input precision (e.g. screen pixel density, input device precision, etc.). 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... | |
| AIS_StatusOfDetection | MoveTo (const Standard_Integer theXPix, const Standard_Integer theYPix, const Handle< V3d_View > &theView, const Standard_Boolean theToRedrawOnUpdate) |
| Relays mouse position in pixels theXPix and theYPix to the interactive context selectors. This is done by the view theView passing this position to the main viewer and updating it. If theToRedrawOnUpdate is set to false, callee should call RedrawImmediate() to highlight detected object. More... | |
| Standard_Boolean | ClearDetected (Standard_Boolean theToRedrawImmediate=Standard_False) |
| Clears the list of entities detected by MoveTo() and resets dynamic highlighting. More... | |
| Standard_Boolean | HasDetected () const |
| Returns true if there is a mouse-detected entity in context. More... | |
| Handle< SelectMgr_EntityOwner > | DetectedOwner () const |
| Returns the owner of the detected sensitive primitive which is currently dynamically highlighted. WARNING! This method is irrelevant to InitDetected()/MoreDetected()/NextDetected(). More... | |
| Handle< AIS_InteractiveObject > | DetectedInteractive () const |
| Returns the interactive objects last detected in context. In general this is just a wrapper for Handle(AIS_InteractiveObject)::DownCast(DetectedOwner()->Selectable()). More... | |
| Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context") 1 Standard_Boolean HasDetectedShape() const | |
| Returns true if there is a detected shape in local context. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context") 1 const TopoDS_Shape &DetectedShape() const | |
| Returns the shape detected in local context. More... | |
| Standard_Boolean | HasNextDetected () const |
| returns True if other entities were detected in the last mouse detection More... | |
| Standard_Integer | HilightNextDetected (const Handle< V3d_View > &theView, const Standard_Boolean theToRedrawImmediate=Standard_True) |
| If more than 1 object is detected by the selector, only the "best" owner is hilighted at the mouse position. This Method allows the user to hilight one after another the other detected entities. If The method select is called, the selected entity will be the hilighted one! WARNING: Loop Method. When all the detected entities have been hilighted, the next call will hilight the first one again. More... | |
| Standard_Integer | HilightPreviousDetected (const Handle< V3d_View > &theView, const Standard_Boolean theToRedrawImmediate=Standard_True) |
| Same as previous methods in reverse direction. More... | |
Selection management | |
| const Standard_Boolean | theToUpdateViewer = Standard_True) |
| Sets the graphic basic aspect to the current presentation of ALL selected objects. More... | |
| void | SetSelectedAspect (const Handle< Prs3d_BasicAspect > &theAspect, const Standard_Boolean theToUpdateViewer) |
| Sets the graphic basic aspect to the current presentation of ALL selected objects. More... | |
| AIS_StatusOfPick | AddSelect (const Handle< SelectMgr_EntityOwner > &theObject) |
| Adds object in the selection. More... | |
| AIS_StatusOfPick | AddSelect (const Handle< AIS_InteractiveObject > &theObject) |
| Adds object in the selection. More... | |
| AIS_StatusOfPick | Select (const Standard_Integer theXPMin, const Standard_Integer theYPMin, const Standard_Integer theXPMax, const Standard_Integer theYPMax, const Handle< V3d_View > &theView, const Standard_Boolean theToUpdateViewer) |
| Selects everything found in the bounding rectangle defined by the pixel minima and maxima, XPMin, YPMin, XPMax, and YPMax in the view. The objects detected are passed to the main viewer, which is then updated. More... | |
| AIS_StatusOfPick | Select (const TColgp_Array1OfPnt2d &thePolyline, const Handle< V3d_View > &theView, const Standard_Boolean theToUpdateViewer) |
| polyline selection; clears the previous picked list More... | |
| AIS_StatusOfPick | Select (const Standard_Boolean theToUpdateViewer) |
| Stores and hilights the previous detected; Unhilights the previous picked. More... | |
| AIS_StatusOfPick | ShiftSelect (const Standard_Boolean theToUpdateViewer) |
| Adds the last detected to the list of previous picked. If the last detected was already declared as picked, removes it from the Picked List. More... | |
| AIS_StatusOfPick | ShiftSelect (const TColgp_Array1OfPnt2d &thePolyline, const Handle< V3d_View > &theView, const Standard_Boolean theToUpdateViewer) |
| Adds the last detected to the list of previous picked. If the last detected was already declared as picked, removes it from the Picked List. More... | |
| AIS_StatusOfPick | ShiftSelect (const Standard_Integer theXPMin, const Standard_Integer theYPMin, const Standard_Integer theXPMax, const Standard_Integer theYPMax, const Handle< V3d_View > &theView, const Standard_Boolean theToUpdateViewer) |
| Rectangle of selection; adds new detected entities into the picked list, removes the detected entities that were already stored. More... | |
| void | FitSelected (const Handle< V3d_View > &theView, const Standard_Real theMargin, const Standard_Boolean theToUpdate) |
| Fits the view correspondingly to the bounds of selected objects. Infinite objects are ignored if infinite state of AIS_InteractiveObject is set to true. More... | |
| void | FitSelected (const Handle< V3d_View > &theView) |
| Fits the view correspondingly to the bounds of selected objects. Infinite objects are ignored if infinite state of AIS_InteractiveObject is set to true. More... | |
| void | SetToHilightSelected (const Standard_Boolean toHilight) |
| Specify whether selected object must be hilighted when mouse cursor is moved above it (in MoveTo method). By default this value is false and selected object is not hilighted in this case. More... | |
| Standard_Boolean | ToHilightSelected () const |
| Return value specified whether selected object must be hilighted when mouse cursor is moved above it. More... | |
| void | SetSelected (const Handle< SelectMgr_EntityOwner > &theOwners, const Standard_Boolean theToUpdateViewer) |
| Unhighlights previously selected owners and marks them as not selected. Marks owner given as selected and highlights it. Performs selection filters check. More... | |
| void | SetSelected (const Handle< AIS_InteractiveObject > &theObject, const Standard_Boolean theToUpdateViewer) |
| Puts the interactive object aniObj in the list of selected objects. Performs selection filters check. More... | |
| void | AddOrRemoveSelected (const Handle< AIS_InteractiveObject > &theObject, const Standard_Boolean theToUpdateViewer) |
| Allows to highlight or unhighlight the owner given depending on its selection status. More... | |
| void | HilightSelected (const Standard_Boolean theToUpdateViewer) |
| Highlights selected objects. More... | |
| void | UnhilightSelected (const Standard_Boolean theToUpdateViewer) |
| Removes highlighting from selected objects. More... | |
| void | UpdateSelected (const Standard_Boolean theToUpdateViewer) |
| Updates the list of selected objects: i.e. highlights the newly selected ones and unhighlights previously selected objects. More... | |
| void | ClearSelected (const Standard_Boolean theToUpdateViewer) |
| Empties previous selected objects in order to get the selected objects detected by the selector using UpdateSelected. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context") 1 void AddOrRemoveSelected(const TopoDS_Shape &theShape | |
| No right to Add a selected Shape (Internal Management of shape Selection). A Previous selected shape may only be removed. More... | |
| void | AddOrRemoveSelected (const Handle< SelectMgr_EntityOwner > &theOwner, const Standard_Boolean theToUpdateViewer) |
| Allows to highlight or unhighlight the owner given depending on its selection status. More... | |
| Standard_Boolean | IsSelected (const Handle< SelectMgr_EntityOwner > &theOwner) const |
| Returns true is the owner given is selected. More... | |
| Standard_Boolean | IsSelected (const Handle< AIS_InteractiveObject > &theObj) const |
| Returns true is the object given is selected. More... | |
| Handle< AIS_InteractiveObject > | FirstSelectedObject () |
| Returns the first selected object in the list of current selected. More... | |
| Standard_Integer | NbSelected () |
| Count a number of selected entities using InitSelected()+MoreSelected()+NextSelected() iterator. More... | |
| void | InitSelected () |
| Initializes a scan of the selected objects. More... | |
| Standard_Boolean | MoreSelected () const |
| Returns true if there is another object found by the scan of the list of selected objects. More... | |
| void | NextSelected () |
| Continues the scan to the next object in the list of selected objects. More... | |
| Handle< SelectMgr_EntityOwner > | SelectedOwner () const |
| Returns the owner of the selected entity. More... | |
| Handle< AIS_InteractiveObject > | SelectedInteractive () const |
| Return Handle(AIS_InteractiveObject)::DownCast (SelectedOwner()->Selectable()). More... | |
| Standard_Boolean | HasSelectedShape () const |
| Returns TRUE if the interactive context has a shape selected. More... | |
| TopoDS_Shape | SelectedShape () const |
| Returns the selected shape. Basically it is just a shape returned stored by StdSelect_BRepOwner with graphic transformation being applied: More... | |
| Standard_Boolean | HasApplicative () const |
| Returns SelectedInteractive()->HasOwner(). More... | |
| Handle< Standard_Transient > | Applicative () const |
| Returns SelectedInteractive()->GetOwner(). More... | |
Local Context management (deprecated) | |
| const Standard_Boolean | AllowShapeDecomposition = Standard_True |
| Returns true if there is an open context. More... | |
| const Standard_Boolean const Standard_Boolean | AcceptEraseOfObjects = Standard_False |
| Returns true if there is an open context. More... | |
| const Standard_Boolean const Standard_Boolean const Standard_Boolean | BothViewers = Standard_False) |
| Returns true if there is an open context. More... | |
| const Standard_Boolean | aStatus |
| Returns true if there is an open context. More... | |
| const Handle< Prs3d_Drawer > & | theDrawer |
| Returns true if there is an open context. More... | |
| const Handle< Prs3d_Drawer > const Standard_Boolean | theToUpdateViewer |
| Returns true if there is an open context. More... | |
| Standard_Integer &TheIndex | const |
| Returns true if there is an open context. More... | |
| const Standard_Integer | InWhichLocal = -1) |
| Returns true if there is an open context. More... | |
| Standard_Boolean | HasOpenedContext () const |
| Returns true if there is an open context. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context") 1 Standard_Integer HighestIndex() const | |
| Returns true if there is an open context. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context") Handle< AIS_LocalContext > LocalContext() const | |
| For advanced usage! You should use other (non-internal) methods of class AIS_InteractiveContext without trying to obtain an instance of AIS_LocalContext. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context") 1 Handle< StdSelect_ViewerSelector3d > LocalSelector() const | |
| Returns true if there is an open context. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context") 1 Standard_Integer OpenLocalContext(const Standard_Boolean UseDisplayedObjects | |
| Opens local contexts and specifies how this is to be done. The options listed above function in the following manner: More... | |
| Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context") 1 void CloseLocalContext(const Standard_Integer theIndex | |
| Allows you to close local contexts. For greater security, you should close the context with the index Index given on opening. When you close a local context, the one before, which is still on the stack, reactivates. If none is left, you return to Neutral Point. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated. Warning When the index isn't specified, the current context is closed. This option can be dangerous, as other Interactive Functions can open local contexts without necessarily warning the user. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context") 1 Standard_Integer IndexOfCurrentLocal() const | |
| returns -1 if no opened local context. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context") 1 void CloseAllContexts(const Standard_Boolean theToUpdateViewer) | |
| Allows you to close all local contexts at one go and return to Neutral Point. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated. More... | |
| void | ResetOriginalState (const Standard_Boolean theToUpdateViewer) |
| to be used only with no opened local context.. displays and activates objects in their original state before local contexts were opened... More... | |
| Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context") 1 void ClearLocalContext(const AIS_ClearMode TheMode | |
| clears Objects/Filters/Activated Modes list in the current opened local context. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context") 1 void UseDisplayedObjects() | |
| Returns true if there is an open context. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context") 1 void NotUseDisplayedObjects() | |
| when a local Context is opened, one is able to use/not use the displayed objects at neutral point at anytime. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context") 1 void SetShapeDecomposition(const Handle< AIS_InteractiveObject > &anIobj | |
| to be Used only with opened local context and if <anIobj> is of type shape... if <aStatus> = True <anIobj> will be sensitive to shape selection modes activation. = False, <anIobj> will not be sensitive any more. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context") 1 void SetTemporaryAttributes(const Handle< AIS_InteractiveObject > &theIObj | |
| Sets the temporary graphic attributes of the entity anObj. These are provided by the attribute manager aDrawer and are valid for a particular local context only. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - ::Activate() and AIS_Shape::SelectionMode() should be used instead") 1 void ActivateStandardMode(const TopAbs_ShapeEnum aStandardActivation) | |
| Provides an alternative to the Display methods when activating specific selection modes. This has the effect of activating the corresponding selection mode aStandardActivation for all objects in Local Context which accept decomposition into sub-shapes. Every new Object which has been loaded into the interactive context and which answers these decomposition criteria is automatically activated according to these modes. Warning If you have opened a local context by loading an object with the default options (<AllowShapeDecomposition>= Standard_True), all objects of the "Shape" type are also activated with the same modes. You can act on the state of these "Standard" objects by using SetShapeDecomposition(Status). More... | |
| Standard_DEPRECATED ("Local Context is deprecated - ::Deactivate() should be used instead") 1 void DeactivateStandardMode(const TopAbs_ShapeEnum aStandardActivation) | |
| Provides an alternative to the Display methods when deactivating specific selection modes. This has the effect of deactivating the corresponding selection mode aStandardActivation for all objects in Local Context which accept decomposition into sub-shapes. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - list of activated Selection Modes should be tracked on application side; see also ::ActivatedModes()") 1 const TColStd_ListOfInteger &ActivatedStandardModes() const | |
| Returns the list of activated standard selection modes available in a local context. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context") 1 Standard_Boolean IsInLocal(const Handle< AIS_InteractiveObject > &anObject | |
| returns if possible, the first local context where the object is seen More... | |
| void | SetAutomaticHilight (const Standard_Boolean aStatus) |
| Sets the highlighting status aStatus of detected and selected entities. Whether you are in Neutral Point or local context, this is automatically managed by the Interactive Context. This function allows you to disconnect the automatic mode. More... | |
| Standard_Boolean | AutomaticHilight () const |
| Returns true if the automatic highlight mode is active in an open context. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context") 1 Standard_Boolean KeepTemporary(const Handle< AIS_InteractiveObject > &anIObj | |
| Changes the status of a temporary object. It will be kept at the neutral point, i.e. put in the list of displayed objects along with its temporary attributes. These include display mode and selection mode, for example. Returns true if done. inWhichLocal gives the local context in which anIObj is displayed. By default, the index -1 refers to the last Local Context opened. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context") 1 void SetCurrentObject(const Handle< AIS_InteractiveObject > &theIObj | |
| Updates the view of the current object in open context. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context") 1 void AddOrRemoveCurrentObject(const Handle< AIS_InteractiveObject > &theObj | |
| Allows to add or remove the object given to the list of current and highlight/unhighlight it correspondingly. Is valid for global context only; for local context use method AddOrRemoveSelected. Since this method makes sence only for neutral point selection of a whole object, if 0 selection of the object is empty this method simply does nothing. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context") 1 void UpdateCurrent() | |
| Updates the list of current objects, i.e. hilights new current objects, removes hilighting from former current objects. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - local selection should be used without Local Context") 1 Standard_Boolean IsCurrent(const Handle< AIS_InteractiveObject > &theObject) const | |
| Returns true if there is a non-null interactive object in Neutral Point. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - ::InitSelected() should be called instead") 1 void InitCurrent() | |
| Initializes a scan of the current selected objects in Neutral Point. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - ::MoreSelected() should be called instead") 1 Standard_Boolean MoreCurrent() const | |
| Returns true if there is another object found by the scan of the list of current objects. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - ::NextSelected() should be called instead") 1 void NextCurrent() | |
| Continues the scan to the next object in the list of current objects. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - ::SelectedInteractive() should be called instead") 1 Handle< AIS_InteractiveObject > Current() const | |
| Returns the current interactive object. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - ::NbSelected() should be called instead") 1 Standard_Integer NbCurrents() | |
| Returns true if there is an open context. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - ::HilightSelected() should be called instead") 1 void HilightCurrents(const Standard_Boolean theToUpdateViewer) | |
| Highlights current objects. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - ::UnhilightSelected() should be called instead") 1 void UnhilightCurrents(const Standard_Boolean theToUpdateViewer) | |
| Removes highlighting from current objects. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - ::ClearSelected() should be called instead") 1 void ClearCurrents(const Standard_Boolean theToUpdateViewer) | |
| Empties previous current objects in order to get the current objects detected by the selector using UpdateCurrent. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects. More... | |
| Standard_DEPRECATED ("Local Context is deprecated - ::DetectedCurrentOwner() should be called instead") 1 const TopoDS_Shape &DetectedCurrentShape() const | |
| Standard_DEPRECATED ("Local Context is deprecated - ::DetectedCurrentOwner() should be called instead") 1 Handle< AIS_InteractiveObject > DetectedCurrentObject() const | |
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
The Interactive Context allows you to manage graphic behavior and selection of Interactive Objects in one or more viewers. Class methods make this highly transparent. It is essential to remember that an Interactive Object which is already known by the Interactive Context must be modified using Context methods. You can only directly call the methods available for an Interactive Object if it has not been loaded into an Interactive Context.
Each selectable object must specify the selection mode that is responsible for selection of object as a whole (global selection mode). Interactive context itself supports decomposed object selection with selection filters support. By default, global selection mode is equal to 0, but it might be redefined if needed.
Constructor & Destructor Documentation
◆ AIS_InteractiveContext()
| AIS_InteractiveContext::AIS_InteractiveContext | ( | const Handle< V3d_Viewer > & | MainViewer | ) |
Constructs the interactive context object defined by the principal viewer MainViewer.
◆ ~AIS_InteractiveContext()
|
virtual |
Destructor.
Member Function Documentation
◆ Activate() [1/2]
|
inline |
Activates the selection mode aMode whose index is given, for the given interactive entity anIobj.
◆ Activate() [2/2]
| void AIS_InteractiveContext::Activate | ( | const Standard_Integer | theMode, |
| const Standard_Boolean | theIsForce = Standard_False |
||
| ) |
Activates the given selection mode for the all displayed objects.
◆ ActivatedModes()
| void AIS_InteractiveContext::ActivatedModes | ( | const Handle< AIS_InteractiveObject > & | anIobj, |
| TColStd_ListOfInteger & | theList | ||
| ) | const |
Returns the list of activated selection modes.
◆ AddFilter()
| void AIS_InteractiveContext::AddFilter | ( | const Handle< SelectMgr_Filter > & | theFilter | ) |
Allows you to add the filter.
◆ AddOrRemoveSelected() [1/2]
| void AIS_InteractiveContext::AddOrRemoveSelected | ( | const Handle< AIS_InteractiveObject > & | theObject, |
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Allows to highlight or unhighlight the owner given depending on its selection status.
◆ AddOrRemoveSelected() [2/2]
| void AIS_InteractiveContext::AddOrRemoveSelected | ( | const Handle< SelectMgr_EntityOwner > & | theOwner, |
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Allows to highlight or unhighlight the owner given depending on its selection status.
◆ AddSelect() [1/2]
| AIS_StatusOfPick AIS_InteractiveContext::AddSelect | ( | const Handle< SelectMgr_EntityOwner > & | theObject | ) |
Adds object in the selection.
◆ AddSelect() [2/2]
|
inline |
Adds object in the selection.
◆ Applicative()
| Handle< Standard_Transient > AIS_InteractiveContext::Applicative | ( | ) | const |
Returns SelectedInteractive()->GetOwner().
- See also
- SelectedOwner().
◆ AutomaticHilight()
| Standard_Boolean AIS_InteractiveContext::AutomaticHilight | ( | ) | const |
Returns true if the automatic highlight mode is active in an open context.
◆ BeginImmediateDraw()
| Standard_Boolean AIS_InteractiveContext::BeginImmediateDraw | ( | ) |
initializes the list of presentations to be displayed returns False if no local context is opened.
◆ ClearActiveSensitive()
Clear visualization of sensitives.
◆ ClearDetected()
| Standard_Boolean AIS_InteractiveContext::ClearDetected | ( | Standard_Boolean | theToRedrawImmediate = Standard_False | ) |
Clears the list of entities detected by MoveTo() and resets dynamic highlighting.
- Parameters
-
theToRedrawImmediate if TRUE, the main Viewer will be redrawn on update
- Returns
- TRUE if viewer needs to be updated (e.g. there were actually dynamically highlighted entities)
◆ clearDynamicHighlight()
|
inlineprotected |
Removes dynamic highlight draw.
◆ ClearGlobal()
|
protected |
UNKNOWN.
◆ ClearGlobalPrs()
|
protected |
UNKNOWN.
◆ ClearPrs()
| void AIS_InteractiveContext::ClearPrs | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Integer | theMode, | ||
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Empties the graphic presentation of the mode indexed by aMode. Warning! Removes theIObj. theIObj is still active if it was previously activated.
◆ ClearSelected()
| void AIS_InteractiveContext::ClearSelected | ( | const Standard_Boolean | theToUpdateViewer | ) |
Empties previous selected objects in order to get the selected objects detected by the selector using UpdateSelected.
◆ Color()
| void AIS_InteractiveContext::Color | ( | const Handle< AIS_InteractiveObject > & | aniobj, |
| Quantity_Color & | acolor | ||
| ) | const |
Returns the color of the Object in the interactive context.
◆ CurrentViewer()
|
inline |
Returns the current viewer.
◆ Deactivate() [1/4]
|
inline |
Deactivates all the activated selection modes of an object.
◆ Deactivate() [2/4]
|
inline |
Deactivates all the activated selection modes of the interactive object anIobj with a given selection mode aMode.
◆ Deactivate() [3/4]
| void AIS_InteractiveContext::Deactivate | ( | const Standard_Integer | theMode | ) |
Deactivates the given selection mode for all displayed objects.
◆ Deactivate() [4/4]
| void AIS_InteractiveContext::Deactivate | ( | ) |
Deactivates all the activated selection mode at all displayed objects.
◆ DefaultDrawer()
|
inline |
Returns the default attribute manager. This contains all the color and line attributes which can be used by interactive objects which do not have their own attributes.
◆ DetectedCurrentOwner()
| Handle< SelectMgr_EntityOwner > AIS_InteractiveContext::DetectedCurrentOwner | ( | ) | const |
Returns the owner from detected list pointed by current iterator position. WARNING! This method is irrelevant to DetectedOwner() which returns last picked Owner regardless of iterator position!
- See also
- InitDetected()/MoreDetected()/NextDetected().
◆ DetectedInteractive()
| Handle< AIS_InteractiveObject > AIS_InteractiveContext::DetectedInteractive | ( | ) | const |
Returns the interactive objects last detected in context. In general this is just a wrapper for Handle(AIS_InteractiveObject)::DownCast(DetectedOwner()->Selectable()).
- See also
- DetectedOwner()
◆ DetectedOwner()
| Handle< SelectMgr_EntityOwner > AIS_InteractiveContext::DetectedOwner | ( | ) | const |
Returns the owner of the detected sensitive primitive which is currently dynamically highlighted. WARNING! This method is irrelevant to InitDetected()/MoreDetected()/NextDetected().
- See also
- HasDetected()/HasNextDetected()/HilightPreviousDetected()/HilightNextDetected().
◆ DeviationAngle()
| Standard_Real AIS_InteractiveContext::DeviationAngle | ( | ) | const |
Sets the deviation coefficient theCoefficient. Drawings of curves or patches are made with respect to a maximal chordal deviation. A Deviation coefficient is used in the shading display mode. The shape is seen decomposed into triangles. These are used to calculate reflection of light from the surface of the object. The triangles are formed from chords of the curves in the shape. The deviation coefficient theCoefficient gives the highest value of the angle with which a chord can deviate from a tangent to a curve. If this limit is reached, a new triangle is begun. This deviation is absolute and is set through the method: SetMaximalChordialDeviation. The default value is 0.001. In drawing shapes, however, you are allowed to ask for a relative deviation. This deviation will be: SizeOfObject * DeviationCoefficient.
◆ DeviationCoefficient()
| Standard_Real AIS_InteractiveContext::DeviationCoefficient | ( | ) | const |
Returns the deviation coefficient. Drawings of curves or patches are made with respect to a maximal chordal deviation. A Deviation coefficient is used in the shading display mode. The shape is seen decomposed into triangles. These are used to calculate reflection of light from the surface of the object. The triangles are formed from chords of the curves in the shape. The deviation coefficient gives the highest value of the angle with which a chord can deviate from a tangent to a curve. If this limit is reached, a new triangle is begun. This deviation is absolute and is set through Prs3d_Drawer::SetMaximalChordialDeviation. The default value is 0.001. In drawing shapes, however, you are allowed to ask for a relative deviation. This deviation will be: SizeOfObject * DeviationCoefficient.
◆ DisableDrawHiddenLine()
| void AIS_InteractiveContext::DisableDrawHiddenLine | ( | ) | const |
Initializes hidden line aspect in the default drawing tool, or Drawer. The default values are: Color: Quantity_NOC_YELLOW Type of line: Aspect_TOL_DASH Width: 1.
◆ Disconnect()
| void AIS_InteractiveContext::Disconnect | ( | const Handle< AIS_InteractiveObject > & | theAssembly, |
| const Handle< AIS_InteractiveObject > & | theObjToDisconnect = NULL |
||
| ) |
Disconnects theObjToDisconnect from theAssembly and removes dependent selection structures.
◆ Display() [1/2]
| void AIS_InteractiveContext::Display | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Displays the object in this Context using default Display Mode. This will be the object's default display mode, if there is one. Otherwise, it will be the context mode. The Interactive Object's default selection mode is activated if GetAutoActivateSelection() is TRUE. In general, this is 0.
◆ Display() [2/2]
| void AIS_InteractiveContext::Display | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Integer | theDispMode, | ||
| const Standard_Integer | theSelectionMode, | ||
| const Standard_Boolean | theToUpdateViewer, | ||
| const Standard_Boolean | theToAllowDecomposition = Standard_True, |
||
| const AIS_DisplayStatus | theDispStatus = AIS_DS_None |
||
| ) |
Sets status, display mode and selection mode for specified Object If theSelectionMode equals -1, theIObj will not be activated: it will be displayed but will not be selectable.
◆ DisplayActiveSensitive() [1/2]
Visualization of sensitives - for debugging purposes!
◆ DisplayActiveSensitive() [2/2]
| void AIS_InteractiveContext::DisplayActiveSensitive | ( | const Handle< AIS_InteractiveObject > & | anObject, |
| const Handle< V3d_View > & | aView | ||
| ) |
Visualization of sensitives - for debugging purposes!
◆ DisplayAll()
| void AIS_InteractiveContext::DisplayAll | ( | const Standard_Boolean | theToUpdateViewer | ) |
Displays all hidden objects.
◆ DisplayedObjects() [1/2]
| void AIS_InteractiveContext::DisplayedObjects | ( | AIS_ListOfInteractive & | aListOfIO, |
| const Standard_Boolean | OnlyFromNeutral = Standard_False |
||
| ) | const |
Returns the list of displayed objects of a particular Type WhichKind and Signature WhichSignature. By Default, WhichSignature equals -1. This means that there is a check on type only.
◆ DisplayedObjects() [2/2]
| void AIS_InteractiveContext::DisplayedObjects | ( | const AIS_KindOfInteractive | WhichKind, |
| const Standard_Integer | WhichSignature, | ||
| AIS_ListOfInteractive & | aListOfIO, | ||
| const Standard_Boolean | OnlyFromNeutral = Standard_False |
||
| ) | const |
gives the list of displayed objects of a particular Type and signature. by Default, <WhichSignature> = -1 means control only on <WhichKind>.
◆ DisplayMode()
|
inline |
Returns the Display Mode setting to be used by default.
◆ DisplayPriority()
| Standard_Integer AIS_InteractiveContext::DisplayPriority | ( | const Handle< AIS_InteractiveObject > & | theIObj | ) | const |
Returns the display priority of the Object.
◆ DisplaySelected()
| void AIS_InteractiveContext::DisplaySelected | ( | const Standard_Boolean | theToUpdateViewer | ) |
Displays current objects.
◆ DisplayStatus()
| AIS_DisplayStatus AIS_InteractiveContext::DisplayStatus | ( | const Handle< AIS_InteractiveObject > & | anIobj | ) | const |
Returns the display status of the entity anIobj. This will be one of the following:
- AIS_DS_Displayed displayed in main viewer
- AIS_DS_Erased hidden in main viewer
- AIS_DS_Temporary temporarily displayed
- AIS_DS_None nowhere displayed.
◆ DrawHiddenLine()
| Standard_Boolean AIS_InteractiveContext::DrawHiddenLine | ( | ) | const |
returns Standard_True if the hidden lines are to be drawn. By default the hidden lines are not drawn.
◆ EnableDrawHiddenLine()
| void AIS_InteractiveContext::EnableDrawHiddenLine | ( | ) | const |
Initializes hidden line aspect in the default drawing tool, or Drawer. The default values are: Color: Quantity_NOC_YELLOW Type of line: Aspect_TOL_DASH Width: 1.
◆ EndImmediateDraw() [1/2]
| Standard_Boolean AIS_InteractiveContext::EndImmediateDraw | ( | const Handle< V3d_View > & | theView | ) |
returns True if the immediate display has been done.
◆ EndImmediateDraw() [2/2]
| Standard_Boolean AIS_InteractiveContext::EndImmediateDraw | ( | ) |
Uses the First Active View of Main Viewer! returns True if the immediate display has been done.
◆ EntityOwners()
| void AIS_InteractiveContext::EntityOwners | ( | Handle< SelectMgr_IndexedMapOfOwner > & | theOwners, |
| const Handle< AIS_InteractiveObject > & | theIObj, | ||
| const Standard_Integer | theMode = -1 |
||
| ) | const |
Returns a collection containing all entity owners created for the interactive object in specified selection mode (in all active modes if the Mode == -1)
◆ Erase()
| void AIS_InteractiveContext::Erase | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Hides the object. The object's presentations are simply flagged as invisible and therefore excluded from redrawing. To show hidden objects, use Display().
◆ EraseAll()
| void AIS_InteractiveContext::EraseAll | ( | const Standard_Boolean | theToUpdateViewer | ) |
Hides all objects. The object's presentations are simply flagged as invisible and therefore excluded from redrawing. To show all hidden objects, use DisplayAll().
◆ ErasedObjects() [1/2]
| void AIS_InteractiveContext::ErasedObjects | ( | AIS_ListOfInteractive & | theListOfIO | ) | const |
Returns the list theListOfIO of erased objects (hidden objects) particular Type WhichKind and Signature WhichSignature. By Default, WhichSignature equals 1. This means that there is a check on type only.
◆ ErasedObjects() [2/2]
| void AIS_InteractiveContext::ErasedObjects | ( | const AIS_KindOfInteractive | WhichKind, |
| const Standard_Integer | WhichSignature, | ||
| AIS_ListOfInteractive & | theListOfIO | ||
| ) | const |
gives the list of erased objects (hidden objects) Type and signature by Default, <WhichSignature> = -1 means control only on <WhichKind>.
◆ EraseGlobal()
|
protected |
UNKNOWN.
◆ EraseSelected()
| void AIS_InteractiveContext::EraseSelected | ( | const Standard_Boolean | theToUpdateViewer | ) |
Hides selected objects. The object's presentations are simply flagged as invisible and therefore excluded from redrawing. To show hidden objects, use Display().
◆ Filters()
| const SelectMgr_ListOfFilter& AIS_InteractiveContext::Filters | ( | ) | const |
Returns the list of filters active in a local context.
◆ FirstSelectedObject()
| Handle< AIS_InteractiveObject > AIS_InteractiveContext::FirstSelectedObject | ( | ) |
Returns the first selected object in the list of current selected.
◆ FitSelected() [1/2]
| void AIS_InteractiveContext::FitSelected | ( | const Handle< V3d_View > & | theView, |
| const Standard_Real | theMargin, | ||
| const Standard_Boolean | theToUpdate | ||
| ) |
Fits the view correspondingly to the bounds of selected objects. Infinite objects are ignored if infinite state of AIS_InteractiveObject is set to true.
◆ FitSelected() [2/2]
Fits the view correspondingly to the bounds of selected objects. Infinite objects are ignored if infinite state of AIS_InteractiveObject is set to true.
◆ GetAutoActivateSelection()
|
inline |
Manages displaying the new object should also automatically activate default selection mode; TRUE by default.
◆ GetDefModes()
|
protected |
UNKNOWN.
◆ getHilightMode()
|
inlineprotected |
Return display mode for highlighting.
◆ getHiStyle()
|
inlineprotected |
Helper function that returns correct dynamic highlight style for the object: if custom style is defined via object's highlight drawer, it will be used. Otherwise, dynamic highlight style of interactive context will be returned.
- Parameters
-
theObj [in] the object to check
◆ getSelStyle()
|
inlineprotected |
Helper function that returns correct selection style for the object: if custom style is defined via object's highlight drawer, it will be used. Otherwise, selection style of interactive context will be returned.
- Parameters
-
theObj [in] the object to check
◆ GetZLayer()
| Graphic3d_ZLayerId AIS_InteractiveContext::GetZLayer | ( | const Handle< AIS_InteractiveObject > & | theIObj | ) | const |
Get Z layer id set for displayed interactive object.
◆ HasApplicative()
| Standard_Boolean AIS_InteractiveContext::HasApplicative | ( | ) | const |
Returns SelectedInteractive()->HasOwner().
- See also
- SelectedOwner().
◆ HasColor()
| Standard_Boolean AIS_InteractiveContext::HasColor | ( | const Handle< AIS_InteractiveObject > & | aniobj | ) | const |
Returns true if a view of the Interactive Object has color.
◆ HasDetected()
| Standard_Boolean AIS_InteractiveContext::HasDetected | ( | ) | const |
Returns true if there is a mouse-detected entity in context.
- See also
- DetectedOwner()/HasNextDetected()/HilightPreviousDetected()/HilightNextDetected().
◆ HasLocation()
| Standard_Boolean AIS_InteractiveContext::HasLocation | ( | const Handle< AIS_InteractiveObject > & | theObject | ) | const |
Returns true if the Object has a location.
◆ HasNextDetected()
| Standard_Boolean AIS_InteractiveContext::HasNextDetected | ( | ) | const |
returns True if other entities were detected in the last mouse detection
- See also
- HilightPreviousDetected()/HilightNextDetected().
◆ HasOpenedContext()
|
inline |
Returns true if there is an open context.
◆ HasPolygonOffsets()
| Standard_Boolean AIS_InteractiveContext::HasPolygonOffsets | ( | const Handle< AIS_InteractiveObject > & | anObj | ) | const |
Simply calls AIS_InteractiveObject::HasPolygonOffsets().
◆ HasSelectedShape()
| Standard_Boolean AIS_InteractiveContext::HasSelectedShape | ( | ) | const |
Returns TRUE if the interactive context has a shape selected.
- See also
- SelectedShape().
◆ HiddenLineAspect()
| Handle< Prs3d_LineAspect > AIS_InteractiveContext::HiddenLineAspect | ( | ) | const |
Initializes hidden line aspect in the default drawing tool, or Drawer. The default values are: Color: Quantity_NOC_YELLOW Type of line: Aspect_TOL_DASH Width: 1.
◆ highlightGlobal()
|
protected |
Helper function that highlights global owner of the object given with <theStyle> with check for AutoHighlight, e.g. is used for selection. If global owner is null, it simply highlights the whole object.
◆ highlightSelected()
|
protected |
Helper function that highlights the owner given with <theStyle> with check for AutoHighlight, e.g. is used for selection.
◆ HighlightStyle() [1/4]
|
inline |
Returns highlight style settings.
◆ HighlightStyle() [2/4]
|
inline |
Returns current dynamic highlight style settings. By default:
- the color of dynamic highlight is Quantity_NOC_CYAN1;
- the presentation for dynamic highlight is completely opaque;
- the type of highlight is Aspect_TOHM_COLOR.
◆ HighlightStyle() [3/4]
| Standard_Boolean AIS_InteractiveContext::HighlightStyle | ( | const Handle< AIS_InteractiveObject > & | theObj, |
| Handle< Prs3d_Drawer > & | theStyle | ||
| ) | const |
Returns highlight style of the object if it is marked as highlighted via global status.
- Parameters
-
theObj [in] the object to check
◆ HighlightStyle() [4/4]
| Standard_Boolean AIS_InteractiveContext::HighlightStyle | ( | const Handle< SelectMgr_EntityOwner > & | theOwner, |
| Handle< Prs3d_Drawer > & | theStyle | ||
| ) | const |
Returns highlight style of the owner if it is selected.
- Parameters
-
theOwner [in] the owner to check
◆ highlightWithColor()
|
protected |
Helper function that highlights the owner given with <theStyle> without performing AutoHighlight checks, e.g. is used for dynamic highlight.
◆ highlightWithSubintensity() [1/2]
|
protected |
Helper function that highlights the object with sub-intensity color without any checks.
- Parameters
-
theObject [in] the object that will be highlighted theMode [in] display mode
◆ highlightWithSubintensity() [2/2]
|
protected |
Helper function that highlights the owner with sub-intensity color without any checks.
- Parameters
-
theOwner [in] the owner that will be highlighted theMode [in] display mode
◆ HilightNextDetected()
| Standard_Integer AIS_InteractiveContext::HilightNextDetected | ( | const Handle< V3d_View > & | theView, |
| const Standard_Boolean | theToRedrawImmediate = Standard_True |
||
| ) |
If more than 1 object is detected by the selector, only the "best" owner is hilighted at the mouse position. This Method allows the user to hilight one after another the other detected entities. If The method select is called, the selected entity will be the hilighted one! WARNING: Loop Method. When all the detected entities have been hilighted, the next call will hilight the first one again.
- Returns
- the Rank of hilighted entity
- See also
- HasNextDetected()/HilightPreviousDetected().
◆ HilightPreviousDetected()
| Standard_Integer AIS_InteractiveContext::HilightPreviousDetected | ( | const Handle< V3d_View > & | theView, |
| const Standard_Boolean | theToRedrawImmediate = Standard_True |
||
| ) |
Same as previous methods in reverse direction.
- See also
- HasNextDetected()/HilightNextDetected().
◆ HilightSelected()
| void AIS_InteractiveContext::HilightSelected | ( | const Standard_Boolean | theToUpdateViewer | ) |
Highlights selected objects.
◆ HilightWithColor()
| void AIS_InteractiveContext::HilightWithColor | ( | const Handle< AIS_InteractiveObject > & | theObj, |
| const Handle< Prs3d_Drawer > & | theStyle, | ||
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Changes the color of all the lines of the object in view.
◆ HLRAngle()
| Standard_Real AIS_InteractiveContext::HLRAngle | ( | ) | const |
Returns the real number value of the deviation angle in hidden line removal views in this interactive context. The default value is 20*PI/180.
◆ HLRDeviationCoefficient()
| Standard_Real AIS_InteractiveContext::HLRDeviationCoefficient | ( | ) | const |
Returns the real number value of the hidden line removal deviation coefficient. A Deviation coefficient is used in the shading display mode. The shape is seen decomposed into triangles. These are used to calculate reflection of light from the surface of the object. The triangles are formed from chords of the curves in the shape. The deviation coefficient give the highest value of the angle with which a chord can deviate from a tangent to a curve. If this limit is reached, a new triangle is begun. To find the hidden lines, hidden line display mode entails recalculation of the view at each different projector perspective. Because hidden lines entail calculations of more than usual complexity to decompose them into these triangles, a deviation coefficient allowing greater tolerance is used. This increases efficiency in calculation. The Default value is 0.02.
◆ ImmediateAdd()
| Standard_Boolean AIS_InteractiveContext::ImmediateAdd | ( | const Handle< AIS_InteractiveObject > & | theObj, |
| const Standard_Integer | theMode = 0 |
||
| ) |
returns True if <anIObj> has been stored in the list.
◆ InitAttributes()
|
protected |
UNKNOWN.
◆ InitDetected()
| void AIS_InteractiveContext::InitDetected | ( | ) |
Initialization for iteration through mouse-detected objects in interactive context or in local context if it is opened.
- See also
- DetectedCurrentOwner()/MoreDetected()/NextDetected().
◆ InitSelected()
| void AIS_InteractiveContext::InitSelected | ( | ) |
Initializes a scan of the selected objects.
- See also
- SelectedOwner()/MoreSelected()/NextSelected().
◆ IsDisplayed() [1/2]
| Standard_Boolean AIS_InteractiveContext::IsDisplayed | ( | const Handle< AIS_InteractiveObject > & | anIobj | ) | const |
Returns true if Object is displayed in the interactive context.
◆ IsDisplayed() [2/2]
| Standard_Boolean AIS_InteractiveContext::IsDisplayed | ( | const Handle< AIS_InteractiveObject > & | aniobj, |
| const Standard_Integer | aMode | ||
| ) | const |
Constructs the interactive context object defined by the principal viewer MainViewer.
◆ IsHilighted() [1/2]
| Standard_Boolean AIS_InteractiveContext::IsHilighted | ( | const Handle< AIS_InteractiveObject > & | theObj | ) | const |
Returns true if the object is marked as highlighted via its global status.
- Parameters
-
theObj [in] the object to check
◆ IsHilighted() [2/2]
| Standard_Boolean AIS_InteractiveContext::IsHilighted | ( | const Handle< SelectMgr_EntityOwner > & | theOwner | ) | const |
Returns true if the owner is marked as selected.
- Parameters
-
theOwner [in] the owner to check
◆ IsImmediateModeOn()
| Standard_Boolean AIS_InteractiveContext::IsImmediateModeOn | ( | ) | const |
initializes the list of presentations to be displayed returns False if no local context is opened.
◆ IsoNumber()
| Standard_Integer AIS_InteractiveContext::IsoNumber | ( | const AIS_TypeOfIso | WhichIsos = AIS_TOI_Both | ) |
Returns the number of U and V isoparameters displayed.
◆ IsoOnPlane() [1/2]
| void AIS_InteractiveContext::IsoOnPlane | ( | const Standard_Boolean | SwitchOn | ) |
Returns True if drawing isoparameters on planes is enabled.
◆ IsoOnPlane() [2/2]
| Standard_Boolean AIS_InteractiveContext::IsoOnPlane | ( | ) | const |
Returns True if drawing isoparameters on planes is enabled. if <forUIsos> = False,.
◆ IsoOnTriangulation() [1/3]
| void AIS_InteractiveContext::IsoOnTriangulation | ( | const Standard_Boolean | theIsEnabled, |
| const Handle< AIS_InteractiveObject > & | theObject | ||
| ) |
Enables or disables on-triangulation build for isolines for a particular object. In case if on-triangulation builder is disabled, default on-plane builder will compute isolines for the object given.
◆ IsoOnTriangulation() [2/3]
| void AIS_InteractiveContext::IsoOnTriangulation | ( | const Standard_Boolean | theToSwitchOn | ) |
Enables or disables on-triangulation build for isolines for default drawer. In case if on-triangulation builder is disabled, default on-plane builder will compute isolines for the object given.
◆ IsoOnTriangulation() [3/3]
| Standard_Boolean AIS_InteractiveContext::IsoOnTriangulation | ( | ) | const |
Returns true if drawing isolines on triangulation algorithm is enabled.
◆ IsSelected() [1/2]
| Standard_Boolean AIS_InteractiveContext::IsSelected | ( | const Handle< SelectMgr_EntityOwner > & | theOwner | ) | const |
Returns true is the owner given is selected.
◆ IsSelected() [2/2]
| Standard_Boolean AIS_InteractiveContext::IsSelected | ( | const Handle< AIS_InteractiveObject > & | theObj | ) | const |
Returns true is the object given is selected.
◆ Load()
| void AIS_InteractiveContext::Load | ( | const Handle< AIS_InteractiveObject > & | aniobj, |
| const Standard_Integer | SelectionMode = -1, |
||
| const Standard_Boolean | AllowDecomp = Standard_False |
||
| ) |
Allows you to load the Interactive Object with a given selection mode, and/or with the desired decomposition option, whether the object is visualized or not. If AllowDecomp = Standard_True and, if the interactive object is of the "Shape" type, these "standard" selection modes will be automatically activated as a function of the modes present in the Local Context. The loaded objects will be selectable but displayable in highlighting only when detected by the Selector.
◆ Location()
| TopLoc_Location AIS_InteractiveContext::Location | ( | const Handle< AIS_InteractiveObject > & | theObject | ) | const |
Returns the location of the Object.
◆ MainPrsMgr()
|
inline |
Returns the default attribute manager. This contains all the color and line attributes which can be used by interactive objects which do not have their own attributes.
◆ MainSelector()
|
inline |
Returns the default attribute manager. This contains all the color and line attributes which can be used by interactive objects which do not have their own attributes.
◆ MoreDetected()
| Standard_Boolean AIS_InteractiveContext::MoreDetected | ( | ) | const |
Return TRUE if there is more mouse-detected objects after the current one during iteration through mouse-detected interactive objects.
- See also
- DetectedCurrentOwner()/InitDetected()/NextDetected().
◆ MoreSelected()
| Standard_Boolean AIS_InteractiveContext::MoreSelected | ( | ) | const |
Returns true if there is another object found by the scan of the list of selected objects.
- See also
- SelectedOwner()/InitSelected()/NextSelected().
◆ MoveTo()
| AIS_StatusOfDetection AIS_InteractiveContext::MoveTo | ( | const Standard_Integer | theXPix, |
| const Standard_Integer | theYPix, | ||
| const Handle< V3d_View > & | theView, | ||
| const Standard_Boolean | theToRedrawOnUpdate | ||
| ) |
Relays mouse position in pixels theXPix and theYPix to the interactive context selectors. This is done by the view theView passing this position to the main viewer and updating it. If theToRedrawOnUpdate is set to false, callee should call RedrawImmediate() to highlight detected object.
- See also
- PickingStrategy()
◆ NbSelected()
| Standard_Integer AIS_InteractiveContext::NbSelected | ( | ) |
Count a number of selected entities using InitSelected()+MoreSelected()+NextSelected() iterator.
- See also
- SelectedOwner()/InitSelected()/MoreSelected()/NextSelected().
◆ NextDetected()
| void AIS_InteractiveContext::NextDetected | ( | ) |
Gets next current object during iteration through mouse-detected interactive objects.
- See also
- DetectedCurrentOwner()/InitDetected()/MoreDetected().
◆ NextSelected()
| void AIS_InteractiveContext::NextSelected | ( | ) |
Continues the scan to the next object in the list of selected objects.
- See also
- SelectedOwner()/InitSelected()/MoreSelected().
◆ ObjectsByDisplayStatus() [1/2]
| void AIS_InteractiveContext::ObjectsByDisplayStatus | ( | const AIS_DisplayStatus | theStatus, |
| AIS_ListOfInteractive & | theListOfIO | ||
| ) | const |
Returns the list theListOfIO of objects with indicated display status particular Type WhichKind and Signature WhichSignature. By Default, WhichSignature equals 1. This means that there is a check on type only.
◆ ObjectsByDisplayStatus() [2/2]
| void AIS_InteractiveContext::ObjectsByDisplayStatus | ( | const AIS_KindOfInteractive | WhichKind, |
| const Standard_Integer | WhichSignature, | ||
| const AIS_DisplayStatus | theStatus, | ||
| AIS_ListOfInteractive & | theListOfIO | ||
| ) | const |
gives the list of objects with indicated display status Type and signature by Default, <WhichSignature> = -1 means control only on <WhichKind>.
◆ ObjectsForView()
| void AIS_InteractiveContext::ObjectsForView | ( | AIS_ListOfInteractive & | theListOfIO, |
| const Handle< V3d_View > & | theView, | ||
| const Standard_Boolean | theIsVisibleInView, | ||
| const AIS_DisplayStatus | theStatus = AIS_DS_None |
||
| ) | const |
Query objects visible or hidden in specified view due to affinity mask.
◆ ObjectsInside()
| void AIS_InteractiveContext::ObjectsInside | ( | AIS_ListOfInteractive & | aListOfIO, |
| const AIS_KindOfInteractive | WhichKind = AIS_KOI_None, |
||
| const Standard_Integer | WhichSignature = -1 |
||
| ) | const |
fills <aListOfIO> with objects of a particular Type and Signature with no consideration of display status. by Default, <WhichSignature> = -1 means control only on <WhichKind>. if <WhichKind> = AIS_KOI_None and <WhichSignature> = -1, all the objects are put into the list.
◆ PickingStrategy()
|
inline |
Return picking strategy; SelectMgr_PickingStrategy_FirstAcceptable by default.
- See also
- MoveTo()/Filters()
◆ PixelTolerance()
| Standard_Integer AIS_InteractiveContext::PixelTolerance | ( | ) | const |
Returns the pixel tolerance, default is 2. Pixel Tolerance extends sensitivity within MoveTo() operation (picking by point) and can be adjusted by application based on user input precision (e.g. screen pixel density, input device precision, etc.).
◆ PlaneSize()
| Standard_Boolean AIS_InteractiveContext::PlaneSize | ( | Standard_Real & | XSize, |
| Standard_Real & | YSize | ||
| ) | const |
Returns true if the length in the X direction XSize is the same as that in the Y direction YSize.
◆ PolygonOffsets()
| void AIS_InteractiveContext::PolygonOffsets | ( | const Handle< AIS_InteractiveObject > & | anObj, |
| Standard_Integer & | aMode, | ||
| Standard_ShortReal & | aFactor, | ||
| Standard_ShortReal & | aUnits | ||
| ) | const |
Retrieves current polygon offsets settings for Object.
◆ PurgeDisplay()
| Standard_Integer AIS_InteractiveContext::PurgeDisplay | ( | ) |
Clears all the structures which don't belong to objects displayed at neutral point only effective when no Local Context is opened... returns the number of removed structures from the viewers.
◆ PurgeViewer()
|
protected |
UNKNOWN.
◆ RebuildSelectionStructs()
| void AIS_InteractiveContext::RebuildSelectionStructs | ( | ) |
Rebuilds 1st level of BVH selection forcibly.
◆ RecomputePrsOnly()
| void AIS_InteractiveContext::RecomputePrsOnly | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Boolean | theToUpdateViewer, | ||
| const Standard_Boolean | theAllModes = Standard_False |
||
| ) |
Recomputes the displayed presentations, flags the others. Doesn't update presentations.
◆ RecomputeSelectionOnly()
| void AIS_InteractiveContext::RecomputeSelectionOnly | ( | const Handle< AIS_InteractiveObject > & | anIObj | ) |
Recomputes the active selections, flags the others. Doesn't update presentations.
◆ Redisplay() [1/2]
| void AIS_InteractiveContext::Redisplay | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Boolean | theToUpdateViewer, | ||
| const Standard_Boolean | theAllModes = Standard_False |
||
| ) |
Recomputes the seen parts presentation of the Object. If theAllModes equals true, all presentations are present in the object even if unseen.
◆ Redisplay() [2/2]
| void AIS_InteractiveContext::Redisplay | ( | const AIS_KindOfInteractive | theTypeOfObject, |
| const Standard_Integer | theSignature, | ||
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Recomputes the Prs/Selection of displayed objects of a given type and a given signature. if signature = -1 doesn't take signature criterion.
◆ redisplayPrsModes()
|
protected |
UNKNOWN.
◆ redisplayPrsRecModes()
|
protected |
UNKNOWN.
◆ RedrawImmediate()
| void AIS_InteractiveContext::RedrawImmediate | ( | const Handle< V3d_Viewer > & | theViewer | ) |
Redraws immediate structures in all views of the viewer given taking into account its visibility.
◆ Remove()
| void AIS_InteractiveContext::Remove | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Removes Object from every viewer.
◆ RemoveAll()
| void AIS_InteractiveContext::RemoveAll | ( | const Standard_Boolean | theToUpdateViewer | ) |
Removes all the objects from Context.
◆ RemoveFilter()
| void AIS_InteractiveContext::RemoveFilter | ( | const Handle< SelectMgr_Filter > & | theFilter | ) |
Removes a filter from context.
◆ RemoveFilters()
| void AIS_InteractiveContext::RemoveFilters | ( | ) |
Remove all filters from context.
◆ ResetLocation()
| void AIS_InteractiveContext::ResetLocation | ( | const Handle< AIS_InteractiveObject > & | theObject | ) |
Puts the Object back into its initial position.
◆ ResetOriginalState()
| void AIS_InteractiveContext::ResetOriginalState | ( | const Standard_Boolean | theToUpdateViewer | ) |
to be used only with no opened local context.. displays and activates objects in their original state before local contexts were opened...
◆ Select() [1/3]
| AIS_StatusOfPick AIS_InteractiveContext::Select | ( | const Standard_Integer | theXPMin, |
| const Standard_Integer | theYPMin, | ||
| const Standard_Integer | theXPMax, | ||
| const Standard_Integer | theYPMax, | ||
| const Handle< V3d_View > & | theView, | ||
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Selects everything found in the bounding rectangle defined by the pixel minima and maxima, XPMin, YPMin, XPMax, and YPMax in the view. The objects detected are passed to the main viewer, which is then updated.
◆ Select() [2/3]
| AIS_StatusOfPick AIS_InteractiveContext::Select | ( | const TColgp_Array1OfPnt2d & | thePolyline, |
| const Handle< V3d_View > & | theView, | ||
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
polyline selection; clears the previous picked list
◆ Select() [3/3]
| AIS_StatusOfPick AIS_InteractiveContext::Select | ( | const Standard_Boolean | theToUpdateViewer | ) |
Stores and hilights the previous detected; Unhilights the previous picked.
- See also
- MoveTo().
◆ SelectedInteractive()
| Handle< AIS_InteractiveObject > AIS_InteractiveContext::SelectedInteractive | ( | ) | const |
Return Handle(AIS_InteractiveObject)::DownCast (SelectedOwner()->Selectable()).
- See also
- SelectedOwner().
◆ SelectedOwner()
| Handle< SelectMgr_EntityOwner > AIS_InteractiveContext::SelectedOwner | ( | ) | const |
Returns the owner of the selected entity.
- See also
- InitSelected()/MoreSelected()/NextSelected().
◆ SelectedShape()
| TopoDS_Shape AIS_InteractiveContext::SelectedShape | ( | ) | const |
Returns the selected shape. Basically it is just a shape returned stored by StdSelect_BRepOwner with graphic transformation being applied:
- See also
- SelectedOwner()/HasSelectedShape().
◆ SelectionManager()
|
inline |
Returns the default attribute manager. This contains all the color and line attributes which can be used by interactive objects which do not have their own attributes.
◆ SelectionStyle()
|
inline |
Returns current selection style settings. By default:
- the color of selection is Quantity_NOC_GRAY80;
- the presentation for selection is completely opaque;
- the type of highlight is Aspect_TOHM_COLOR.
◆ SetAngleAndDeviation()
| void AIS_InteractiveContext::SetAngleAndDeviation | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Real | theAngle, | ||
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Calls the AIS_Shape SetAngleAndDeviation to set both Angle and Deviation coefficients.
◆ SetAutoActivateSelection()
|
inline |
Enable or disable automatic activation of default selection mode while displaying the object.
◆ SetAutomaticHilight()
| void AIS_InteractiveContext::SetAutomaticHilight | ( | const Standard_Boolean | aStatus | ) |
Sets the highlighting status aStatus of detected and selected entities. Whether you are in Neutral Point or local context, this is automatically managed by the Interactive Context. This function allows you to disconnect the automatic mode.
◆ SetColor()
| void AIS_InteractiveContext::SetColor | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Quantity_Color & | theColor, | ||
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Sets the color of the selected entity.
◆ setContextToObject()
|
inlineprotected |
Assign the context to the object or throw exception if object was already assigned to another context.
◆ SetCurrentFacingModel()
| void AIS_InteractiveContext::SetCurrentFacingModel | ( | const Handle< AIS_InteractiveObject > & | aniobj, |
| const Aspect_TypeOfFacingModel | aModel = Aspect_TOFM_BOTH_SIDE |
||
| ) |
change the current facing model apply on polygons for SetColor(), SetTransparency(), SetMaterial() methods default facing model is Aspect_TOFM_TWO_SIDE. This mean that attributes is applying both on the front and back face.
◆ SetDeviationAngle() [1/2]
| void AIS_InteractiveContext::SetDeviationAngle | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Real | theAngle, | ||
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Sets the deviation coefficient theCoefficient. Drawings of curves or patches are made with respect to a maximal chordal deviation. A Deviation coefficient is used in the shading display mode. The shape is seen decomposed into triangles. These are used to calculate reflection of light from the surface of the object. The triangles are formed from chords of the curves in the shape. The deviation coefficient theCoefficient gives the highest value of the angle with which a chord can deviate from a tangent to a curve. If this limit is reached, a new triangle is begun. This deviation is absolute and is set through the method: SetMaximalChordialDeviation. The default value is 0.001. In drawing shapes, however, you are allowed to ask for a relative deviation. This deviation will be: SizeOfObject * DeviationCoefficient.
◆ SetDeviationAngle() [2/2]
| void AIS_InteractiveContext::SetDeviationAngle | ( | const Standard_Real | anAngle | ) |
default 12 degrees
◆ SetDeviationCoefficient() [1/2]
| void AIS_InteractiveContext::SetDeviationCoefficient | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Real | theCoefficient, | ||
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Sets the deviation coefficient theCoefficient. Drawings of curves or patches are made with respect to a maximal chordal deviation. A Deviation coefficient is used in the shading display mode. The shape is seen decomposed into triangles. These are used to calculate reflection of light from the surface of the object. The triangles are formed from chords of the curves in the shape. The deviation coefficient theCoefficient gives the highest value of the angle with which a chord can deviate from a tangent to a curve. If this limit is reached, a new triangle is begun. This deviation is absolute and is set through the method: SetMaximalChordialDeviation. The default value is 0.001. In drawing shapes, however, you are allowed to ask for a relative deviation. This deviation will be: SizeOfObject * DeviationCoefficient.
◆ SetDeviationCoefficient() [2/2]
| void AIS_InteractiveContext::SetDeviationCoefficient | ( | const Standard_Real | theCoefficient | ) |
Sets the deviation coefficient theCoefficient. Drawings of curves or patches are made with respect to a maximal chordal deviation. A Deviation coefficient is used in the shading display mode. The shape is seen decomposed into triangles. These are used to calculate reflection of light from the surface of the object. The triangles are formed from chords of the curves in the shape. The deviation coefficient theCoefficient gives the highest value of the angle with which a chord can deviate from a tangent to a curve. If this limit is reached, a new triangle is begun. This deviation is absolute and is set through the method: SetMaximalChordialDeviation. The default value is 0.001. In drawing shapes, however, you are allowed to ask for a relative deviation. This deviation will be: SizeOfObject * DeviationCoefficient.
◆ SetDisplayMode() [1/2]
| void AIS_InteractiveContext::SetDisplayMode | ( | const Standard_Integer | theMode, |
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Sets the display mode of seen Interactive Objects (which have no overridden Display Mode).
◆ SetDisplayMode() [2/2]
| void AIS_InteractiveContext::SetDisplayMode | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Integer | theMode, | ||
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Sets the display mode of seen Interactive Objects. theMode provides the display mode index of the entity theIObj.
◆ SetDisplayPriority()
| void AIS_InteractiveContext::SetDisplayPriority | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Integer | thePriority | ||
| ) |
Sets the display priority of the seen parts presentation of the Object.
◆ SetHiddenLineAspect()
| void AIS_InteractiveContext::SetHiddenLineAspect | ( | const Handle< Prs3d_LineAspect > & | anAspect | ) | const |
Sets the hidden line aspect anAspect. Aspect defines display attributes for hidden lines in HLR projections.
◆ SetHighlightStyle() [1/2]
|
inline |
Setup highlight style settings.
◆ SetHighlightStyle() [2/2]
|
inline |
Setup the style of dynamic highlighting.
◆ SetHLRAngle()
| void AIS_InteractiveContext::SetHLRAngle | ( | const Standard_Real | theAngle | ) |
Sets the HLR angle.
◆ SetHLRAngleAndDeviation() [1/2]
| void AIS_InteractiveContext::SetHLRAngleAndDeviation | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Real | theAngle, | ||
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Computes a HLRAngle and a HLRDeviationCoefficient by means of the angle anAngle and sets the corresponding methods in the default drawing tool with these values.
◆ SetHLRAngleAndDeviation() [2/2]
| void AIS_InteractiveContext::SetHLRAngleAndDeviation | ( | const Standard_Real | theAngle | ) |
compute with theAngle a HLRAngle and a HLRDeviationCoefficient and set them in myHLRAngle and in myHLRDeviationCoefficient of myDefaultDrawer; theAngle is in radian; ( 1 deg < angle in deg < 20 deg)
◆ SetHLRDeviationAngle()
| void AIS_InteractiveContext::SetHLRDeviationAngle | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Real | theAngle, | ||
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Sets the deviation coefficient theCoefficient. Drawings of curves or patches are made with respect to a maximal chordal deviation. A Deviation coefficient is used in the shading display mode. The shape is seen decomposed into triangles. These are used to calculate reflection of light from the surface of the object. The triangles are formed from chords of the curves in the shape. The deviation coefficient theCoefficient gives the highest value of the angle with which a chord can deviate from a tangent to a curve. If this limit is reached, a new triangle is begun. This deviation is absolute and is set through the method: SetMaximalChordialDeviation. The default value is 0.001. In drawing shapes, however, you are allowed to ask for a relative deviation. This deviation will be: SizeOfObject * DeviationCoefficient.
◆ SetHLRDeviationCoefficient() [1/2]
| void AIS_InteractiveContext::SetHLRDeviationCoefficient | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Real | theCoefficient, | ||
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Sets the deviation coefficient aCoefficient for removal of hidden lines created by different viewpoints in different presentations. The Default value is 0.02.
◆ SetHLRDeviationCoefficient() [2/2]
| void AIS_InteractiveContext::SetHLRDeviationCoefficient | ( | const Standard_Real | aCoefficient | ) |
Sets the deviation coefficient aCoefficient for removal of hidden lines created by different viewpoints in different presentations. The Default value is 0.02.
◆ SetIsoNumber()
| void AIS_InteractiveContext::SetIsoNumber | ( | const Standard_Integer | NbIsos, |
| const AIS_TypeOfIso | WhichIsos = AIS_TOI_Both |
||
| ) |
Sets the number of U and V isoparameters displayed.
◆ SetLocalAttributes()
| void AIS_InteractiveContext::SetLocalAttributes | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Handle< Prs3d_Drawer > & | theDrawer, | ||
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Sets the graphic attributes of the interactive object, such as visualization mode, color, and material.
◆ SetLocation()
| void AIS_InteractiveContext::SetLocation | ( | const Handle< AIS_InteractiveObject > & | theObject, |
| const TopLoc_Location & | theLocation | ||
| ) |
Puts the location on the initial graphic representation and the selection for the Object.
◆ SetMaterial()
| void AIS_InteractiveContext::SetMaterial | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Graphic3d_MaterialAspect & | theMaterial, | ||
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Provides the type of material setting for the view of the Object.
◆ SetPickingStrategy()
|
inline |
Setup picking strategy - which entities detected by picking line will be accepted, considering Selection Filters. By default (SelectMgr_PickingStrategy_FirstAcceptable), Selection Filters reduce the list of entities so that the context accepts topmost in remaining.
This means that entities behind non-selectable (by filters) parts can be picked by user. If this behavior is undesirable, and user wants that non-selectable (by filters) parts should remain an obstacle for picking, SelectMgr_PickingStrategy_OnlyTopmost can be set instead.
Notice, that since Selection Manager operates only objects registered in it, SelectMgr_PickingStrategy_OnlyTopmost will NOT prevent picking entities behind visible by unregistered in Selection Manager presentations (e.g. deactivated). Hence, SelectMgr_PickingStrategy_OnlyTopmost changes behavior only with Selection Filters enabled.
◆ SetPlaneSize() [1/2]
| void AIS_InteractiveContext::SetPlaneSize | ( | const Standard_Real | theSizeX, |
| const Standard_Real | theSizeY, | ||
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Sets the plane size defined by the length in the X direction XSize and that in the Y direction YSize.
◆ SetPlaneSize() [2/2]
| void AIS_InteractiveContext::SetPlaneSize | ( | const Standard_Real | theSize, |
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Sets the plane size aSize.
◆ SetPolygonOffsets()
| void AIS_InteractiveContext::SetPolygonOffsets | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Integer | theMode, | ||
| const Standard_ShortReal | theFactor, | ||
| const Standard_ShortReal | theUnits, | ||
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Sets up polygon offsets for the given AIS_InteractiveObject. It simply calls AIS_InteractiveObject::SetPolygonOffsets().
◆ SetSelected() [1/2]
| void AIS_InteractiveContext::SetSelected | ( | const Handle< SelectMgr_EntityOwner > & | theOwners, |
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Unhighlights previously selected owners and marks them as not selected. Marks owner given as selected and highlights it. Performs selection filters check.
◆ SetSelected() [2/2]
| void AIS_InteractiveContext::SetSelected | ( | const Handle< AIS_InteractiveObject > & | theObject, |
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Puts the interactive object aniObj in the list of selected objects. Performs selection filters check.
◆ SetSelectedAspect()
| void AIS_InteractiveContext::SetSelectedAspect | ( | const Handle< Prs3d_BasicAspect > & | theAspect, |
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Sets the graphic basic aspect to the current presentation of ALL selected objects.
◆ SetSelectionModeActive()
| void AIS_InteractiveContext::SetSelectionModeActive | ( | const Handle< AIS_InteractiveObject > & | theObj, |
| const Standard_Integer | theMode, | ||
| const Standard_Boolean | theToActivate, | ||
| const AIS_SelectionModesConcurrency | theConcurrency = AIS_SelectionModesConcurrency_Multiple, |
||
| const Standard_Boolean | theIsForce = Standard_False |
||
| ) |
Activates or deactivates the selection mode for specified object. Has no effect if selection mode was already active/deactivated.
- Parameters
-
theObj object to activate/deactivate selection mode theMode selection mode to activate/deactivate; deactivation of -1 selection mode will effectively deactivate all selection modes; activation of -1 selection mode with AIS_SelectionModesConcurrency_Single will deactivate all selection modes, and will has no effect otherwise theToActivate activation/deactivation flag theConcurrency specifies how to handle already activated selection modes; default value (AIS_SelectionModesConcurrency_Multiple) means active selection modes should be left as is, AIS_SelectionModesConcurrency_Single can be used if only one selection mode is expected to be active and AIS_SelectionModesConcurrency_GlobalOrLocal can be used if either AIS_InteractiveObject::GlobalSelectionMode() or any combination of Local selection modes is acceptable; this value is considered only if theToActivate set to TRUE theIsForce when set to TRUE, the display status will be ignored while activating selection mode
◆ SetSelectionSensitivity()
| void AIS_InteractiveContext::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.
◆ SetSelectionStyle()
|
inline |
Setup the style of selection highlighting.
◆ SetSubIntensityColor()
|
inline |
Sub-intensity allows temporary highlighting of particular objects with specified color in a manner of selection highlight, but without actual selection (e.g., global status and owner's selection state will not be updated). The method sets up the color for such highlighting. By default, this is Quantity_NOC_GRAY40.
◆ SetToHilightSelected()
|
inline |
Specify whether selected object must be hilighted when mouse cursor is moved above it (in MoveTo method). By default this value is false and selected object is not hilighted in this case.
◆ SetTransformPersistence()
| void AIS_InteractiveContext::SetTransformPersistence | ( | const Handle< AIS_InteractiveObject > & | theObject, |
| const Handle< Graphic3d_TransformPers > & | theTrsfPers | ||
| ) |
Sets transform persistence.
◆ SetTransparency()
| void AIS_InteractiveContext::SetTransparency | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Real | theValue, | ||
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Provides the transparency settings for viewing the Object. The transparency value aValue may be between 0.0, opaque, and 1.0, fully transparent.
◆ SetTrihedronSize()
| void AIS_InteractiveContext::SetTrihedronSize | ( | const Standard_Real | theSize, |
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Sets the size aSize of the trihedron. Is used to change the default value 100 mm for display of trihedra. Use of this function in one of your own interactive objects requires a call to the Compute function of the new class. This will recalculate the presentation for every trihedron displayed.
◆ SetViewAffinity()
| void AIS_InteractiveContext::SetViewAffinity | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Handle< V3d_View > & | theView, | ||
| const Standard_Boolean | theIsVisible | ||
| ) |
Setup object visibility in specified view. Has no effect if object is not displayed in this context.
◆ SetWidth()
|
virtual |
Sets the width of the Object.
◆ SetZLayer()
| void AIS_InteractiveContext::SetZLayer | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Graphic3d_ZLayerId | theLayerId | ||
| ) |
Set Z layer id for interactive object. The Z layers can be used to display temporarily presentations of some object in front of the other objects in the scene. The ids for Z layers are generated by V3d_Viewer.
◆ ShiftSelect() [1/3]
| AIS_StatusOfPick AIS_InteractiveContext::ShiftSelect | ( | const Standard_Boolean | theToUpdateViewer | ) |
Adds the last detected to the list of previous picked. If the last detected was already declared as picked, removes it from the Picked List.
- See also
- MoveTo().
◆ ShiftSelect() [2/3]
| AIS_StatusOfPick AIS_InteractiveContext::ShiftSelect | ( | const TColgp_Array1OfPnt2d & | thePolyline, |
| const Handle< V3d_View > & | theView, | ||
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Adds the last detected to the list of previous picked. If the last detected was already declared as picked, removes it from the Picked List.
◆ ShiftSelect() [3/3]
| AIS_StatusOfPick AIS_InteractiveContext::ShiftSelect | ( | const Standard_Integer | theXPMin, |
| const Standard_Integer | theYPMin, | ||
| const Standard_Integer | theXPMax, | ||
| const Standard_Integer | theYPMax, | ||
| const Handle< V3d_View > & | theView, | ||
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Rectangle of selection; adds new detected entities into the picked list, removes the detected entities that were already stored.
◆ Standard_DEPRECATED() [1/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Deprecated method Hilight()" | ) | const & |
Updates the display in the viewer to take dynamic detection into account. On dynamic detection by the mouse cursor, sensitive primitives are highlighted. The highlight color of entities detected by mouse movement is white by default.
◆ Standard_DEPRECATED() [2/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "This method is deprecated - SetTransformPersistence() taking Graphic3d_TransformPers should be called instead" | ) | const & |
Puts the location on the initial graphic representation and the selection for the Object.
◆ Standard_DEPRECATED() [3/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - local selection should be used without Local Context" | ) | const |
Returns true if there is a detected shape in local context.
- See also
- HasDetected()/DetectedShape()
◆ Standard_DEPRECATED() [4/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - local selection should be used without Local Context" | ) | const & |
Returns the shape detected in local context.
- See also
- DetectedOwner()
◆ Standard_DEPRECATED() [5/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - local selection should be used without Local Context" | ) | const & |
No right to Add a selected Shape (Internal Management of shape Selection). A Previous selected shape may only be removed.
◆ Standard_DEPRECATED() [6/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - local selection should be used without Local Context" | ) | const |
Returns true if there is an open context.
◆ Standard_DEPRECATED() [7/36]
|
inline |
For advanced usage! You should use other (non-internal) methods of class AIS_InteractiveContext without trying to obtain an instance of AIS_LocalContext.
◆ Standard_DEPRECATED() [8/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - local selection should be used without Local Context" | ) | const |
Returns true if there is an open context.
◆ Standard_DEPRECATED() [9/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - local selection should be used without Local Context" | ) | const |
Opens local contexts and specifies how this is to be done. The options listed above function in the following manner:
- UseDisplayedObjects - allows you to load or not load the interactive objects visualized at Neutral Point in the local context which you open. If false, the local context is empty after being opened. If true, the objects at Neutral Point are loaded by their default selection mode.
- AllowShapeDecomposition - AIS_Shape allows or prevents decomposition in standard shape location mode of objects at Neutral Point which are type-"privileged". This Flag is only taken into account when UseDisplayedObjects is true.
- AcceptEraseOfObjects - authorises other local contexts to erase the interactive objects present in this context. This option is rarely used.
- BothViewers - Has no use currently defined. This method returns the index of the created local context. It should be kept and used to close the context. Opening a local context allows you to prepare an environment for temporary presentations and selections which will disappear once the local context is closed. You can open several local contexts, but only the last one will be active.
◆ Standard_DEPRECATED() [10/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - local selection should be used without Local Context" | ) | const |
Allows you to close local contexts. For greater security, you should close the context with the index Index given on opening. When you close a local context, the one before, which is still on the stack, reactivates. If none is left, you return to Neutral Point. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated. Warning When the index isn't specified, the current context is closed. This option can be dangerous, as other Interactive Functions can open local contexts without necessarily warning the user.
◆ Standard_DEPRECATED() [11/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - local selection should be used without Local Context" | ) | const |
returns -1 if no opened local context.
◆ Standard_DEPRECATED() [12/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - local selection should be used without Local Context" | ) | const |
Allows you to close all local contexts at one go and return to Neutral Point. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
◆ Standard_DEPRECATED() [13/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - local selection should be used without Local Context" | ) | const |
clears Objects/Filters/Activated Modes list in the current opened local context.
◆ Standard_DEPRECATED() [14/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - local selection should be used without Local Context" | ) |
Returns true if there is an open context.
◆ Standard_DEPRECATED() [15/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - local selection should be used without Local Context" | ) |
when a local Context is opened, one is able to use/not use the displayed objects at neutral point at anytime.
◆ Standard_DEPRECATED() [16/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - local selection should be used without Local Context" | ) | const & |
to be Used only with opened local context and if <anIobj> is of type shape... if <aStatus> = True <anIobj> will be sensitive to shape selection modes activation. = False, <anIobj> will not be sensitive any more.
◆ Standard_DEPRECATED() [17/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - local selection should be used without Local Context" | ) | const & |
Sets the temporary graphic attributes of the entity anObj. These are provided by the attribute manager aDrawer and are valid for a particular local context only. If a local context is open and if updateviewer equals Standard_False, the presentation of the Interactive Object activates the selection mode; the object is displayed but no viewer will be updated.
◆ Standard_DEPRECATED() [18/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - ::Activate() and AIS_Shape::SelectionMode() should be used instead" | ) | const |
Provides an alternative to the Display methods when activating specific selection modes. This has the effect of activating the corresponding selection mode aStandardActivation for all objects in Local Context which accept decomposition into sub-shapes. Every new Object which has been loaded into the interactive context and which answers these decomposition criteria is automatically activated according to these modes. Warning If you have opened a local context by loading an object with the default options (<AllowShapeDecomposition>= Standard_True), all objects of the "Shape" type are also activated with the same modes. You can act on the state of these "Standard" objects by using SetShapeDecomposition(Status).
◆ Standard_DEPRECATED() [19/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - ::Deactivate() should be used instead" | ) | const |
Provides an alternative to the Display methods when deactivating specific selection modes. This has the effect of deactivating the corresponding selection mode aStandardActivation for all objects in Local Context which accept decomposition into sub-shapes.
◆ Standard_DEPRECATED() [20/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - list of activated Selection Modes should be tracked on application side; see also ::ActivatedModes()" | ) | const & |
Returns the list of activated standard selection modes available in a local context.
◆ Standard_DEPRECATED() [21/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - local selection should be used without Local Context" | ) | const & |
returns if possible, the first local context where the object is seen
◆ Standard_DEPRECATED() [22/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - local selection should be used without Local Context" | ) | const & |
Changes the status of a temporary object. It will be kept at the neutral point, i.e. put in the list of displayed objects along with its temporary attributes. These include display mode and selection mode, for example. Returns true if done. inWhichLocal gives the local context in which anIObj is displayed. By default, the index -1 refers to the last Local Context opened.
◆ Standard_DEPRECATED() [23/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - local selection should be used without Local Context" | ) | const & |
Updates the view of the current object in open context. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
◆ Standard_DEPRECATED() [24/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - local selection should be used without Local Context" | ) | const & |
Allows to add or remove the object given to the list of current and highlight/unhighlight it correspondingly. Is valid for global context only; for local context use method AddOrRemoveSelected. Since this method makes sence only for neutral point selection of a whole object, if 0 selection of the object is empty this method simply does nothing.
◆ Standard_DEPRECATED() [25/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - local selection should be used without Local Context" | ) |
Updates the list of current objects, i.e. hilights new current objects, removes hilighting from former current objects. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
◆ Standard_DEPRECATED() [26/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - local selection should be used without Local Context" | ) | const & |
Returns true if there is a non-null interactive object in Neutral Point. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
◆ Standard_DEPRECATED() [27/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - ::InitSelected() should be called instead" | ) |
Initializes a scan of the current selected objects in Neutral Point. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
◆ Standard_DEPRECATED() [28/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - ::MoreSelected() should be called instead" | ) | const |
Returns true if there is another object found by the scan of the list of current objects. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
◆ Standard_DEPRECATED() [29/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - ::NextSelected() should be called instead" | ) |
Continues the scan to the next object in the list of current objects. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
◆ Standard_DEPRECATED() [30/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - ::SelectedInteractive() should be called instead" | ) | const |
Returns the current interactive object. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
◆ Standard_DEPRECATED() [31/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - ::NbSelected() should be called instead" | ) |
Returns true if there is an open context.
◆ Standard_DEPRECATED() [32/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - ::HilightSelected() should be called instead" | ) | const |
Highlights current objects. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
◆ Standard_DEPRECATED() [33/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - ::UnhilightSelected() should be called instead" | ) | const |
Removes highlighting from current objects. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
◆ Standard_DEPRECATED() [34/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - ::ClearSelected() should be called instead" | ) | const |
Empties previous current objects in order to get the current objects detected by the selector using UpdateCurrent. Objects selected when there is no open local context are called current objects; those selected in open local context, selected objects.
◆ Standard_DEPRECATED() [35/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - ::DetectedCurrentOwner() should be called instead" | ) | 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.
- See also
- DetectedCurrentOwner()/InitDetected()/MoreDetected()/NextDetected().
◆ Standard_DEPRECATED() [36/36]
| AIS_InteractiveContext::Standard_DEPRECATED | ( | "Local Context is deprecated - ::DetectedCurrentOwner() should be called instead" | ) | const |
- Returns
- current mouse-detected interactive object or null object, if there is no currently detected interactives
- See also
- DetectedCurrentOwner()/InitDetected()/MoreDetected()/NextDetected().
◆ Status()
| void AIS_InteractiveContext::Status | ( | const Handle< AIS_InteractiveObject > & | anObj, |
| TCollection_ExtendedString & | astatus | ||
| ) | const |
Returns the status of the Interactive Context for the view of the Interactive Object.
◆ SubIntensityColor()
|
inline |
Sub-intensity allows temporary highlighting of particular objects with specified color in a manner of selection highlight, but without actual selection (e.g., global status and owner's selection state will not be updated). The method returns the color of such highlighting. By default, it is Quantity_NOC_GRAY40.
◆ SubIntensityOff() [1/2]
| void AIS_InteractiveContext::SubIntensityOff | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Removes the subintensity option for the entity. If a local context is open, the presentation of the Interactive Object activates the selection mode.
◆ SubIntensityOff() [2/2]
| void AIS_InteractiveContext::SubIntensityOff | ( | const Standard_Boolean | theToUpdateViewer | ) |
Removes subintensity option for all objects.
◆ SubIntensityOn() [1/2]
| void AIS_InteractiveContext::SubIntensityOn | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Highlights, and removes highlights from, the displayed object which is displayed at Neutral Point with subintensity color. Available only for active local context. There is no effect if there is no local context. If a local context is open, the presentation of the Interactive Object activates the selection mode.
◆ SubIntensityOn() [2/2]
| void AIS_InteractiveContext::SubIntensityOn | ( | const Standard_Boolean | theToUpdateViewer | ) |
hilights/unhilights displayed objects which are displayed at neutral state with subintensity color. Available only for active local context. No effect if no local context.
◆ ToHilightSelected()
|
inline |
Return value specified whether selected object must be hilighted when mouse cursor is moved above it.
◆ TrihedronSize()
| Standard_Real AIS_InteractiveContext::TrihedronSize | ( | ) | const |
returns the current value of trihedron size.
◆ turnOnSubintensity()
|
protected |
Helper function that turns on sub-intensity in global status and highlights given objects with sub-intensity color.
- Parameters
-
theObject [in] the object. If NULL is given, than sub-intensity will be turned on for all inveractive objects of the context theDispMode [in] display mode. If -1 is given, sub-intensity will be turned on for all display modes in global status's list of modes theIsDisplayedOnly [in] is true if sub-intensity should be applied only to objects with status AIS_DS_Displayed
◆ unhighlightGlobal()
|
protected |
Helper function that unhighlights global selection owner of given interactive. The function does not perform any updates of global or owner status.
◆ unhighlightOwners()
|
protected |
Helper function to unhighlight all entity owners currently highlighted with seleciton color.
◆ unhighlightSelected()
|
protected |
Helper function that unhighlights all owners that are stored in current AIS_Selection. The function updates global status and selection state of owner and interactive object. If the parameter <theIsToHilightSubIntensity> is set to true, interactive objects with sub-intensity switched on in AIS_GlobalStatus will be highlighted with context's sub-intensity color.
◆ Unhilight()
| void AIS_InteractiveContext::Unhilight | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Removes hilighting from the Object.
◆ UnhilightSelected()
| void AIS_InteractiveContext::UnhilightSelected | ( | const Standard_Boolean | theToUpdateViewer | ) |
Removes highlighting from selected objects.
◆ UnsetColor()
| void AIS_InteractiveContext::UnsetColor | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Removes the color selection for the selected entity.
◆ UnsetDisplayMode()
| void AIS_InteractiveContext::UnsetDisplayMode | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Unsets the display mode of seen Interactive Objects.
◆ UnsetLocalAttributes()
| void AIS_InteractiveContext::UnsetLocalAttributes | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Removes the settings for local attributes of the Object and returns to defaults.
◆ UnsetMaterial()
| void AIS_InteractiveContext::UnsetMaterial | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Removes the type of material setting for viewing the Object.
◆ UnsetTransparency()
| void AIS_InteractiveContext::UnsetTransparency | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Boolean | theToUpdateViewer | ||
| ) |
Removes the transparency settings for viewing the Object.
◆ UnsetWidth()
|
virtual |
Removes the width setting of the Object.
◆ Update()
| void AIS_InteractiveContext::Update | ( | const Handle< AIS_InteractiveObject > & | theIObj, |
| const Standard_Boolean | theUpdateViewer | ||
| ) |
Updates displayed interactive object by checking and recomputing its flagged as "to be recomputed" presentation and selection structures. This method does not force any recomputation on its own. The method recomputes selections even if they are loaded without activation in particular selector.
◆ UpdateCurrentViewer()
| void AIS_InteractiveContext::UpdateCurrentViewer | ( | ) |
Updates the current viewer.
◆ UpdateSelected()
| void AIS_InteractiveContext::UpdateSelected | ( | const Standard_Boolean | theToUpdateViewer | ) |
Updates the list of selected objects: i.e. highlights the newly selected ones and unhighlights previously selected objects.
- See also
- HilightSelected().
◆ Width()
|
virtual |
Returns the width of the Interactive Object in the interactive context.
Field Documentation
◆ AcceptEraseOfObjects
| const Standard_Boolean const Standard_Boolean AIS_InteractiveContext::AcceptEraseOfObjects = Standard_False |
Returns true if there is an open context.
◆ AllowShapeDecomposition
| const Standard_Boolean AIS_InteractiveContext::AllowShapeDecomposition = Standard_True |
Returns true if there is an open context.
◆ aStatus
| const Standard_Boolean AIS_InteractiveContext::aStatus |
Returns true if there is an open context.
◆ BothViewers
| const Standard_Boolean const Standard_Boolean const Standard_Boolean AIS_InteractiveContext::BothViewers = Standard_False) |
Returns true if there is an open context.
◆ const
| Standard_Integer& TheIndex AIS_InteractiveContext::const |
Returns true if there is an open context.
◆ InWhichLocal
| const Standard_Integer AIS_InteractiveContext::InWhichLocal = -1) |
Returns true if there is an open context.
◆ mgrSelector
|
protected |
picking strategy to be applied within MoveTo()
◆ myCurDetected
|
protected |
picking strategy to be applied within MoveTo()
◆ myCurHighlighted
|
protected |
picking strategy to be applied within MoveTo()
◆ myCurLocalIndex
|
protected |
picking strategy to be applied within MoveTo()
◆ myDefaultDrawer
|
protected |
picking strategy to be applied within MoveTo()
◆ myDetectedSeq
|
protected |
picking strategy to be applied within MoveTo()
◆ myFilters
|
protected |
picking strategy to be applied within MoveTo()
◆ myIsAutoActivateSelMode
|
protected |
picking strategy to be applied within MoveTo()
◆ myLastinMain
|
protected |
picking strategy to be applied within MoveTo()
◆ myLastPicked
|
protected |
picking strategy to be applied within MoveTo()
◆ myLocalContexts
|
protected |
picking strategy to be applied within MoveTo()
◆ myMainPM
|
protected |
picking strategy to be applied within MoveTo()
◆ myMainSel
|
protected |
picking strategy to be applied within MoveTo()
◆ myMainVwr
|
protected |
picking strategy to be applied within MoveTo()
◆ myObjects
|
protected |
picking strategy to be applied within MoveTo()
◆ myPickingStrategy
|
protected |
picking strategy to be applied within MoveTo()
◆ mySelection
|
protected |
picking strategy to be applied within MoveTo()
◆ myStyles
|
protected |
picking strategy to be applied within MoveTo()
◆ myToHilightSelected
|
protected |
picking strategy to be applied within MoveTo()
◆ myWasLastMain
|
protected |
picking strategy to be applied within MoveTo()
◆ theDrawer
| const Handle< Prs3d_Drawer >& AIS_InteractiveContext::theDrawer |
Returns true if there is an open context.
◆ theFlag
| const Graphic3d_TransModeFlags& AIS_InteractiveContext::theFlag |
Puts the location on the initial graphic representation and the selection for the Object.
◆ theIsToUpdateViewer
| const Standard_Boolean AIS_InteractiveContext::theIsToUpdateViewer |
Returns highlight style settings.
◆ thePoint
| const Graphic3d_TransModeFlags const gp_Pnt& AIS_InteractiveContext::thePoint |
Puts the location on the initial graphic representation and the selection for the Object.
◆ theToUpdateViewer [1/2]
| const Standard_Boolean AIS_InteractiveContext::theToUpdateViewer = Standard_True) |
Sets the graphic basic aspect to the current presentation of ALL selected objects.
◆ theToUpdateViewer [2/2]
| const Handle< Prs3d_Drawer > const Standard_Boolean AIS_InteractiveContext::theToUpdateViewer |
Returns true if there is an open context.
The documentation for this class was generated from the following file:
