EIC code displayed by LXR master/​include/​opencascade/​SelectMgr_SelectableObject.hxx	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2026-09-13 09:17:41

 // Created on: 1995-02-20
 // Created by: Mister rmi
 // Copyright (c) 1995-1999 Matra Datavision
 // Copyright (c) 1999-2014 OPEN CASCADE SAS
 //
 // This file is part of Open CASCADE Technology software library.
 //
 // This library is free software; you can redistribute it and/or modify it under
 // the terms of the GNU Lesser General Public License version 2.1 as published
 // by the Free Software Foundation, with special exception defined in the file
 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
 // distribution for complete text of the license and disclaimer of any warranty.
 //
 // Alternatively, this file may be used under the terms of Open CASCADE
 // commercial license or contractual agreement.
 
 #ifndef _SelectMgr_SelectableObject_HeaderFile
 #define _SelectMgr_SelectableObject_HeaderFile
 
 #include <PrsMgr_PresentableObject.hxx>
 #include <NCollection_IndexedMap.hxx>
 #include <NCollection_Shared.hxx>
 #include <NCollection_Sequence.hxx>
 #include <SelectMgr_Selection.hxx>
 
 class SelectMgr_EntityOwner;
 
 //! 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.
 //!
 //! Key interface methods to be implemented by every Selectable Object:
 //! * Presentable Object (PrsMgr_PresentableObject)
 //!   Consider defining an enumeration of supported Display Mode indexes for particular Interactive
 //!   Object or class of Interactive Objects.
 //!   - AcceptDisplayMode() accepting display modes implemented by this object;
 //!   - Compute() computing presentation for the given display mode index;
 //! * Selectable Object (SelectMgr_SelectableObject)
 //!   Consider defining an enumeration of supported Selection Mode indexes for particular
 //!   Interactive Object or class of Interactive Objects.
 //!   - ComputeSelection() computing selectable entities for the given selection mode index.
 class SelectMgr_SelectableObject : public PrsMgr_PresentableObject
 {
   DEFINE_STANDARD_RTTIEXT(SelectMgr_SelectableObject, PrsMgr_PresentableObject)
   friend class SelectMgr_SelectionManager;
 
 public:
   //! Clears all selections of the object
   Standard_EXPORT ~SelectMgr_SelectableObject() override;
 
   //! Computes sensitive primitives for the given selection mode - key interface method of
   //! Selectable Object.
   //! @param theSelection selection to fill
   //! @param theMode selection mode to create sensitive primitives
   virtual void ComputeSelection(const occ::handle<SelectMgr_Selection>& theSelection,
                                 const int                               theMode) = 0;
 
   //! 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.
   virtual bool AcceptShapeDecomposition() const { return false; }
 
   //! 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.
   Standard_EXPORT void RecomputePrimitives();
 
   //! 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.
   Standard_EXPORT void RecomputePrimitives(const int theMode);
 
   //! Adds the selection aSelection with the selection mode
   //! index aMode to this framework.
   Standard_EXPORT void AddSelection(const occ::handle<SelectMgr_Selection>& aSelection,
                                     const int                               aMode);
 
   //! 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.
   Standard_EXPORT void ClearSelections(const bool update = false);
 
   //! Returns the selection having specified selection mode or NULL.
   Standard_EXPORT const occ::handle<SelectMgr_Selection>& Selection(const int theMode) const;
 
   //! Returns true if a selection corresponding to the selection mode theMode was computed for this
   //! object.
   bool HasSelection(const int theMode) const { return !Selection(theMode).IsNull(); }
 
   //! Return the sequence of selections.
   const NCollection_Sequence<occ::handle<SelectMgr_Selection>>& Selections() const
   {
     return myselections;
   }
 
   Standard_EXPORT void ResetTransformation() override;
 
   //! Recomputes the location of the selection aSelection.
   Standard_EXPORT void UpdateTransformation() override;
 
   //! Updates locations in all sensitive entities from <aSelection>
   //! and in corresponding entity owners.
   Standard_EXPORT virtual void UpdateTransformations(
     const occ::handle<SelectMgr_Selection>& aSelection);
 
   //! Method which draws selected owners ( for fast presentation draw )
   Standard_EXPORT virtual void HilightSelected(
     const occ::handle<PrsMgr_PresentationManager>&                  thePrsMgr,
     const NCollection_Sequence<occ::handle<SelectMgr_EntityOwner>>& theSeq);
 
   //! Method which clear all selected owners belonging
   //! to this selectable object ( for fast presentation draw )
   Standard_EXPORT virtual void ClearSelected();
 
   //! 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.
   Standard_EXPORT virtual void ClearDynamicHighlight(
     const occ::handle<PrsMgr_PresentationManager>& theMgr);
 
   //! Method which hilight an owner belonging to
   //! this selectable object (for fast presentation draw)
   Standard_EXPORT virtual void HilightOwnerWithColor(
     const occ::handle<PrsMgr_PresentationManager>& thePM,
     const occ::handle<Prs3d_Drawer>&               theStyle,
     const occ::handle<SelectMgr_EntityOwner>&      theOwner);
 
   //! 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 bool IsAutoHilight() const { return myAutoHilight; }
 
   //! Set AutoHilight property to true or false.
   virtual void SetAutoHilight(const bool theAutoHilight) { myAutoHilight = theAutoHilight; }
 
   //! Creates or returns existing presentation for highlighting detected object.
   //! @param thePrsMgr presentation manager to create new presentation
   //! @return existing or newly created presentation (when thePrsMgr is not NULL)
   Standard_EXPORT occ::handle<Prs3d_Presentation> GetHilightPresentation(
     const occ::handle<PrsMgr_PresentationManager>& thePrsMgr);
 
   //! Creates or returns existing presentation for highlighting selected object.
   //! @param thePrsMgr presentation manager to create new presentation
   //! @return existing or newly created presentation (when thePrsMgr is not NULL)
   Standard_EXPORT occ::handle<Prs3d_Presentation> GetSelectPresentation(
     const occ::handle<PrsMgr_PresentationManager>& thePrsMgr);
 
   //! Removes presentations returned by GetHilightPresentation() and GetSelectPresentation().
   Standard_EXPORT virtual void ErasePresentations(bool theToRemove);
 
   //! 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.
   Standard_EXPORT void SetZLayer(const Graphic3d_ZLayerId theLayerId) override;
 
   //! 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 UpdateSelection(const int theMode = -1) { updateSelection(theMode); }
 
   //! Sets common entity owner for assembly sensitive object entities
   Standard_EXPORT void SetAssemblyOwner(const occ::handle<SelectMgr_EntityOwner>& theOwner,
                                         const int                                 theMode = -1);
 
   //! Returns a bounding box of sensitive entities with the owners given if they are a part of
   //! activated selection
   Standard_EXPORT Bnd_Box BndBoxOfSelected(
     const occ::handle<
       NCollection_Shared<NCollection_IndexedMap<occ::handle<SelectMgr_EntityOwner>>>>& theOwners);
 
   //! Returns the mode for selection of object as a whole; 0 by default.
   int GlobalSelectionMode() const { return myGlobalSelMode; }
 
   //! Returns the owner of mode for selection of object as a whole
   Standard_EXPORT virtual occ::handle<SelectMgr_EntityOwner> GlobalSelOwner() const;
 
   //! Returns common entity owner if the object is an assembly
   Standard_EXPORT virtual const occ::handle<SelectMgr_EntityOwner>& GetAssemblyOwner() const;
 
   //! Dumps the content of me into the stream
   Standard_EXPORT void DumpJson(Standard_OStream& theOStream, int theDepth = -1) const override;
 
 protected:
   //! Protected empty constructor.
   Standard_EXPORT SelectMgr_SelectableObject(
     const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d = PrsMgr_TOP_AllView);
 
   //! Override global selection mode.
   void setGlobalSelMode(const int theMode) { myGlobalSelMode = theMode > 0 ? theMode : 0; }
 
   //! Update clipping planes state.
   Standard_EXPORT void UpdateClipping() override;
 
   //! 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.
   Standard_EXPORT virtual void updateSelection(const int theMode);
 
 protected:
   NCollection_Sequence<occ::handle<SelectMgr_Selection>> myselections; //!< list of selections
                                                                        // clang-format off
   occ::handle<Prs3d_Presentation>    mySelectionPrs;  //!< optional presentation for highlighting selected object
   occ::handle<Prs3d_Presentation>    myHilightPrs;    //!< optional presentation for highlighting detected object
                                                                        // clang-format on
   int  myGlobalSelMode;                                                //!< global selection mode
   bool myAutoHilight; //!< auto-highlighting flag defining
 };
 
 #endif // _SelectMgr_SelectableObject_HeaderFile

This page was automatically generated by the 2.3.7 LXR engine. The LXR team