A framework to supply the structure of the object to be selected. At the first pick, this structure is created by calling the appropriate algorithm and retaining this framework for further picking. This abstract framework is inherited in Application Interactive Services (AIS), notably in AIS_InteractiveObject. Consequently, 3D selection should be handled by the relevant daughter classes and their member functions in AIS. This is particularly true in the creation of new interactive objects.
More...
|
| | ~SelectMgr_SelectableObject () override |
| | Clears all selections of the object.
|
| virtual void | ComputeSelection (const occ::handle< SelectMgr_Selection > &theSelection, const int theMode)=0 |
| | Computes sensitive primitives for the given selection mode - key interface method of Selectable Object.
|
| virtual bool | AcceptShapeDecomposition () const |
| | Informs the graphic context that the interactive Object may be decomposed into sub-shapes for dynamic selection. The most used Interactive Object is AIS_Shape.
|
| void | RecomputePrimitives () |
| | Re-computes the sensitive primitives for all modes. IMPORTANT: Do not use this method to update selection primitives except implementing custom selection manager! This method does not take into account necessary BVH updates, but may invalidate the pointers it refers to. TO UPDATE SELECTION properly from outside classes, use method UpdateSelection.
|
| void | RecomputePrimitives (const int theMode) |
| | Re-computes the sensitive primitives which correspond to the <theMode>th selection mode. IMPORTANT: Do not use this method to update selection primitives except implementing custom selection manager! selection manager! This method does not take into account necessary BVH updates, but may invalidate the pointers it refers to. TO UPDATE SELECTION properly from outside classes, use method UpdateSelection.
|
| void | AddSelection (const occ::handle< SelectMgr_Selection > &aSelection, const int aMode) |
| | Adds the selection aSelection with the selection mode index aMode to this framework.
|
| void | ClearSelections (const bool update=false) |
| | Empties all the selections in the SelectableObject <update> parameter defines whether all object's selections should be flagged for further update or not. This improved method can be used to recompute an object's selection (without redisplaying the object completely) when some selection mode is activated not for the first time.
|
| const occ::handle< SelectMgr_Selection > & | Selection (const int theMode) const |
| | Returns the selection having specified selection mode or NULL.
|
| bool | HasSelection (const int theMode) const |
| | Returns true if a selection corresponding to the selection mode theMode was computed for this object.
|
| const NCollection_Sequence< occ::handle< SelectMgr_Selection > > & | Selections () const |
| | Return the sequence of selections.
|
| void | ResetTransformation () override |
| | resets local transformation to identity.
|
| void | UpdateTransformation () override |
| | Recomputes the location of the selection aSelection.
|
| virtual void | UpdateTransformations (const occ::handle< SelectMgr_Selection > &aSelection) |
| | Updates locations in all sensitive entities from <aSelection> and in corresponding entity owners.
|
| virtual void | HilightSelected (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr, const NCollection_Sequence< occ::handle< SelectMgr_EntityOwner > > &theSeq) |
| | Method which draws selected owners ( for fast presentation draw ).
|
| virtual void | ClearSelected () |
| | Method which clear all selected owners belonging to this selectable object ( for fast presentation draw ).
|
| virtual void | ClearDynamicHighlight (const occ::handle< PrsMgr_PresentationManager > &theMgr) |
| | Method that needs to be implemented when the object manages selection and dynamic highlighting on its own. Clears or invalidates dynamic highlight presentation. By default it clears immediate draw of given presentation manager.
|
| virtual void | HilightOwnerWithColor (const occ::handle< PrsMgr_PresentationManager > &thePM, const occ::handle< Prs3d_Drawer > &theStyle, const occ::handle< SelectMgr_EntityOwner > &theOwner) |
| | Method which hilight an owner belonging to this selectable object (for fast presentation draw).
|
| virtual bool | IsAutoHilight () const |
| | If returns True, the old mechanism for highlighting selected objects is used (HilightSelected Method may be empty). If returns False, the HilightSelected method will be fully responsible for highlighting selected entity owners belonging to this selectable object.
|
| virtual void | SetAutoHilight (const bool theAutoHilight) |
| | Set AutoHilight property to true or false.
|
| occ::handle< Prs3d_Presentation > | GetHilightPresentation (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr) |
| | Creates or returns existing presentation for highlighting detected object.
|
| occ::handle< Prs3d_Presentation > | GetSelectPresentation (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr) |
| | Creates or returns existing presentation for highlighting selected object.
|
| virtual void | ErasePresentations (bool theToRemove) |
| | Removes presentations returned by GetHilightPresentation() and GetSelectPresentation().
|
| void | SetZLayer (const Graphic3d_ZLayerId theLayerId) override |
| | Set Z layer ID and update all presentations of the selectable object. The layers mechanism allows drawing objects in higher layers in overlay of objects in lower layers.
|
| void | UpdateSelection (const int theMode=-1) |
| | Sets update status FULL to selections of the object. Must be used as the only method of UpdateSelection from outer classes to prevent BVH structures from being outdated.
|
| void | SetAssemblyOwner (const occ::handle< SelectMgr_EntityOwner > &theOwner, const int theMode=-1) |
| | Sets common entity owner for assembly sensitive object entities.
|
| Bnd_Box | BndBoxOfSelected (const occ::handle< NCollection_Shared< NCollection_IndexedMap< occ::handle< SelectMgr_EntityOwner > > > > &theOwners) |
| | Returns a bounding box of sensitive entities with the owners given if they are a part of activated selection.
|
| int | GlobalSelectionMode () const |
| | Returns the mode for selection of object as a whole; 0 by default.
|
| virtual occ::handle< SelectMgr_EntityOwner > | GlobalSelOwner () const |
| | Returns the owner of mode for selection of object as a whole.
|
| virtual const occ::handle< SelectMgr_EntityOwner > & | GetAssemblyOwner () const |
| | Returns common entity owner if the object is an assembly.
|
| void | DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override |
| | Dumps the content of me into the stream.
|
| NCollection_Sequence< occ::handle< PrsMgr_Presentation > > & | Presentations () |
| | Return presentations.
|
| Graphic3d_ZLayerId | ZLayer () const |
| | Get ID of Z layer for main presentation.
|
| bool | IsMutable () const |
| | Returns true if object has mutable nature (content or location are be changed regularly). Mutable object will be managed in different way than static onces (another optimizations).
|
| virtual void | SetMutable (const bool theIsMutable) |
| | Sets if the object has mutable nature (content or location will be changed regularly). This method should be called before object displaying to take effect.
|
| const occ::handle< Graphic3d_ViewAffinity > & | ViewAffinity () const |
| | Return view affinity mask.
|
| bool | HasDisplayMode () const |
| | Returns true if the Interactive Object has display mode setting overriding global setting (within Interactive Context).
|
| int | DisplayMode () const |
| | Returns the display mode setting of the Interactive Object. The range of supported display mode indexes should be specified within object definition and filtered by AccepDisplayMode().
|
| void | SetDisplayMode (const int theMode) |
| | Sets the display mode for the interactive object. An object can have its own temporary display mode, which is different from that proposed by the interactive context.
|
| void | UnsetDisplayMode () |
| | Removes display mode settings from the interactive object.
|
| bool | HasHilightMode () const |
| | Returns true if the Interactive Object is in highlight mode.
|
| int | HilightMode () const |
| | Returns highlight display mode. This is obsolete method for backward compatibility - use ::HilightAttributes() and ::DynamicHilightAttributes() instead.
|
| void | SetHilightMode (const int theMode) |
| | Sets highlight display mode. This is obsolete method for backward compatibility - use ::HilightAttributes() and ::DynamicHilightAttributes() instead.
|
| void | UnsetHilightMode () |
| | Unsets highlight display mode.
|
| virtual bool | AcceptDisplayMode (const int theMode) const |
| | Returns true if the class of objects accepts specified display mode index. The interactive context can have a default mode of representation for the set of Interactive Objects. This mode may not be accepted by a given class of objects. Consequently, this virtual method allowing us to get information about the class in question must be implemented. At least one display mode index should be accepted by this method. Although subclass can leave default implementation, it is highly desired defining exact list of supported modes instead, which is usually an enumeration for one object or objects class sharing similar list of display modes.
|
| virtual int | DefaultDisplayMode () const |
| | Returns the default display mode.
|
| bool | ToBeUpdated (bool theToIncludeHidden=false) const |
| | Returns TRUE if any active presentation has invalidation flag.
|
| void | SetToUpdate (int theMode) |
| | Flags presentation to be updated; UpdatePresentations() will recompute these presentations.
|
| void | SetToUpdate () |
| | flags all the Presentations to be Updated.
|
| bool | IsInfinite () const |
| | Returns true if the interactive object is infinite; FALSE by default. This flag affects various operations operating on bounding box of graphic presentations of this object. For instance, infinite objects are not taken in account for View FitAll. This does not necessarily means that object is actually infinite, auxiliary objects might be also marked with this flag to achieve desired behavior.
|
| void | SetInfiniteState (const bool theFlag=true) |
| | Sets if object should be considered as infinite.
|
| PrsMgr_TypeOfPresentation3d | TypeOfPresentation3d () const |
| | Returns information on whether the object accepts display in HLR mode or not.
|
| void | SetTypeOfPresentation (const PrsMgr_TypeOfPresentation3d theType) |
| | Set type of presentation.
|
| PrsMgr_DisplayStatus | DisplayStatus () const |
| | Return presentation display status; PrsMgr_DisplayStatus_None by default.
|
| const occ::handle< Prs3d_Drawer > & | Attributes () const |
| | Initializes the drawing tool theDrawer.
|
| virtual void | SetAttributes (const occ::handle< Prs3d_Drawer > &theDrawer) |
| | Initializes the drawing tool theDrawer.
|
| const occ::handle< Prs3d_Drawer > & | HilightAttributes () const |
| | Returns the hilight attributes settings. When not NULL, overrides both Prs3d_TypeOfHighlight_LocalSelected and Prs3d_TypeOfHighlight_Selected defined within AIS_InteractiveContext::HighlightStyle().
|
| virtual void | SetHilightAttributes (const occ::handle< Prs3d_Drawer > &theDrawer) |
| | Initializes the hilight drawing tool theDrawer.
|
| const occ::handle< Prs3d_Drawer > & | DynamicHilightAttributes () const |
| | Returns the hilight attributes settings. When not NULL, overrides both Prs3d_TypeOfHighlight_LocalDynamic and Prs3d_TypeOfHighlight_Dynamic defined within AIS_InteractiveContext::HighlightStyle().
|
| virtual void | SetDynamicHilightAttributes (const occ::handle< Prs3d_Drawer > &theDrawer) |
| | Initializes the dynamic hilight drawing tool.
|
| virtual void | UnsetHilightAttributes () |
| | Clears settings provided by the hilight drawing tool theDrawer.
|
| void | SynchronizeAspects () |
| | Synchronize presentation aspects after their modification.
|
| const occ::handle< Graphic3d_TransformPers > & | TransformPersistence () const |
| | Sets up Transform Persistence defining a special Local Coordinate system where this object should be located. Note that management of Transform Persistence object is more expensive than of the normal one, because it requires its position being recomputed basing on camera position within each draw call / traverse.
|
| virtual void | SetTransformPersistence (const occ::handle< Graphic3d_TransformPers > &theTrsfPers) |
| | Sets up Transform Persistence defining a special Local Coordinate system where this object should be located. Note that management of Transform Persistence object is more expensive than of the normal one, because it requires its position being recomputed basing on camera position within each draw call / traverse.
|
| const occ::handle< TopLoc_Datum3D > & | LocalTransformationGeom () const |
| | Return the local transformation. Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.
|
| void | SetLocalTransformation (const gp_Trsf &theTrsf) |
| | Sets local transformation to theTransformation. Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.
|
| void | SetLocalTransformation (const occ::handle< TopLoc_Datum3D > &theTrsf) |
| | Sets local transformation to theTransformation. Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.
|
| bool | HasTransformation () const |
| | Returns true if object has a transformation that is different from the identity.
|
| const occ::handle< TopLoc_Datum3D > & | TransformationGeom () const |
| | Return the transformation taking into account transformation of parent object(s). Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.
|
| const gp_Trsf & | LocalTransformation () const |
| | Return the local transformation. Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.
|
| const gp_Trsf & | Transformation () const |
| | Return the transformation taking into account transformation of parent object(s). Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.
|
| const gp_GTrsf & | InversedTransformation () const |
| | Return inversed transformation.
|
| const occ::handle< TopLoc_Datum3D > & | CombinedParentTransformation () const |
| | Return combined parent transformation.
|
| virtual void | RecomputeTransformation (const occ::handle< Graphic3d_Camera > &theProjector) |
| | Calculates object presentation for specific camera position. Each of the views in the viewer and every modification such as rotation, for example, entails recalculation.
|
| const occ::handle< Graphic3d_SequenceOfHClipPlane > & | ClipPlanes () const |
| | Set clip planes for graphical clipping for all display mode presentations. The composition of clip planes truncates the rendering space to convex volume. Please be aware that number of supported clip plane is limited. The planes which exceed the limit are ignored. Besides of this, some planes can be already set in view where the object is shown: the number of these planes should be subtracted from limit to predict the maximum possible number of object clipping planes.
|
| virtual void | SetClipPlanes (const occ::handle< Graphic3d_SequenceOfHClipPlane > &thePlanes) |
| | Set clip planes for graphical clipping for all display mode presentations. The composition of clip planes truncates the rendering space to convex volume. Please be aware that number of supported clip plane is limited. The planes which exceed the limit are ignored. Besides of this, some planes can be already set in view where the object is shown: the number of these planes should be subtracted from limit to predict the maximum possible number of object clipping planes.
|
| virtual void | AddClipPlane (const occ::handle< Graphic3d_ClipPlane > &thePlane) |
| | Adds clip plane for graphical clipping for all display mode presentations. The composition of clip planes truncates the rendering space to convex volume. Please be aware that number of supported clip plane is limited. The planes which exceed the limit are ignored. Besides of this, some planes can be already set in view where the object is shown: the number of these planes should be subtracted from limit to predict the maximum possible number of object clipping planes.
|
| virtual void | RemoveClipPlane (const occ::handle< Graphic3d_ClipPlane > &thePlane) |
| | Removes previously added clip plane.
|
| PrsMgr_PresentableObject * | Parent () const |
| | Returns children of the current object.
|
| const NCollection_List< occ::handle< PrsMgr_PresentableObject > > & | Children () const |
| | Returns children of the current object.
|
| virtual void | AddChild (const occ::handle< PrsMgr_PresentableObject > &theObject) |
| | Makes theObject child of current object in scene hierarchy.
|
| void | AddChildWithCurrentTransformation (const occ::handle< PrsMgr_PresentableObject > &theObject) |
| | Makes theObject child of current object in scene hierarchy with keeping the current global transformation So the object keeps the same position/orientation in the global CS.
|
| virtual void | RemoveChild (const occ::handle< PrsMgr_PresentableObject > &theObject) |
| | Removes theObject from children of current object in scene hierarchy.
|
| void | RemoveChildWithRestoreTransformation (const occ::handle< PrsMgr_PresentableObject > &theObject) |
| | Removes theObject from children of current object in scene hierarchy with keeping the current global transformation. So the object keeps the same position/orientation in the global CS.
|
| bool | HasOwnPresentations () const |
| | Returns true if object should have own presentations.
|
| virtual void | BoundingBox (Bnd_Box &theBndBox) |
| | Returns bounding box of object correspondingly to its current display mode. This method requires presentation to be already computed, since it relies on bounding box of presentation structures, which are supposed to be same/close amongst different display modes of this object.
|
| void | SetIsoOnTriangulation (const bool theIsEnabled) |
| | Returns the current facing model which is in effect.
|
| Aspect_TypeOfFacingModel | CurrentFacingModel () const |
| | Returns the current facing model which is in effect.
|
| void | SetCurrentFacingModel (const Aspect_TypeOfFacingModel theModel=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.
|
| bool | HasColor () const |
| | Returns true if the Interactive Object has color.
|
| virtual void | Color (Quantity_Color &theColor) const |
| | Returns the color setting of the Interactive Object.
|
| virtual void | SetColor (const Quantity_Color &theColor) |
| | Only the interactive object knowns which Drawer attribute is affected by the color, if any (ex: for a wire,it's the wireaspect field of the drawer, but for a vertex, only the point aspect field is affected by the color). WARNING : Do not forget to set the corresponding fields here (hasOwnColor and myDrawer->SetColor()).
|
| virtual void | UnsetColor () |
| | Removes color settings. Only the Interactive Object knows which Drawer attribute is affected by the color setting. For a wire, for example, wire aspect is the attribute affected. For a vertex, however, only point aspect is affected by the color setting.
|
| bool | HasWidth () const |
| | Returns true if the Interactive Object has width.
|
| double | Width () const |
| | Returns the width setting of the Interactive Object.
|
| virtual void | SetWidth (const double theWidth) |
| | Allows you to provide the setting aValue for width. Only the Interactive Object knows which Drawer attribute is affected by the width setting.
|
| virtual void | UnsetWidth () |
| | Reset width to default value.
|
| bool | HasMaterial () const |
| | Returns true if the Interactive Object has a setting for material.
|
| virtual Graphic3d_NameOfMaterial | Material () const |
| | Returns the current material setting as enumeration value.
|
| virtual void | SetMaterial (const Graphic3d_MaterialAspect &aName) |
| | Sets the material aMat defining this display attribute for the interactive object. Material aspect determines shading aspect, color and transparency of visible entities.
|
| virtual void | UnsetMaterial () |
| | Removes the setting for material.
|
| bool | IsTransparent () const |
| | Returns true if there is a transparency setting.
|
| virtual double | Transparency () const |
| | Returns the transparency setting. This will be between 0.0 and 1.0. At 0.0 an object will be totally opaque, and at 1.0, fully transparent.
|
| virtual void | SetTransparency (const double aValue=0.6) |
| | Attributes a setting aValue for transparency. The transparency value should be between 0.0 and 1.0. At 0.0 an object will be totally opaque, and at 1.0, fully transparent. Warning At a value of 1.0, there may be nothing visible.
|
| virtual void | UnsetTransparency () |
| | Removes the transparency setting. The object is opaque by default.
|
| virtual bool | HasPolygonOffsets () const |
| | Returns true if <myDrawer> has non-null shading aspect.
|
| virtual void | PolygonOffsets (int &aMode, float &aFactor, float &aUnits) const |
| | Retrieves current polygon offsets settings from <myDrawer>.
|
| virtual void | SetPolygonOffsets (const int aMode, const float aFactor=1.0, const float aUnits=0.0) |
| | Sets up polygon offsets for this object.
|
| virtual void | UnsetAttributes () |
| | Clears settings provided by the drawing tool aDrawer.
|
| void | ToBeUpdated (NCollection_List< int > &ListOfMode) const |
| | pointer to the parent object
|
| bool | ToPropagateVisualState () const |
| | Get value of the flag "propagate visual state" It means that the display/erase/color visual state is propagated automatically to all children; by default, the flag is true.
|
| void | SetPropagateVisualState (const bool theFlag) |
| | Change the value of the flag "propagate visual state".
|
| Public Member Functions inherited from Standard_Transient |
| | Standard_Transient () |
| | Empty constructor.
|
| | Standard_Transient (const Standard_Transient &) |
| | Copy constructor – does nothing.
|
| Standard_Transient & | operator= (const Standard_Transient &) |
| | Assignment operator, needed to avoid copying reference counter.
|
| virtual | ~Standard_Transient ()=default |
| | Destructor must be virtual.
|
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| | Returns a type descriptor about this object.
|
| bool | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| | Returns a true value if this is an instance of Type.
|
| bool | IsInstance (const char *const theTypeName) const |
| | Returns a true value if this is an instance of TypeName.
|
| bool | IsKind (const opencascade::handle< Standard_Type > &theType) const |
| | Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
|
| bool | IsKind (const char *const theTypeName) const |
| | Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
|
| Standard_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.
|
| int | GetRefCount () const noexcept |
| | Get the reference counter of this object.
|
| void | IncrementRefCounter () noexcept |
| | Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
|
| int | DecrementRefCounter () noexcept |
| | Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
|
| virtual void | Delete () const |
| | Memory deallocator for transient classes.
|
OCCT 8.0.1
1.17.0