0024623: Visualization - improve selection mechanism
[occt.git] / src / Select3D / Select3D_SensitiveGroup.hxx
diff --git a/src/Select3D/Select3D_SensitiveGroup.hxx b/src/Select3D/Select3D_SensitiveGroup.hxx
new file mode 100644 (file)
index 0000000..bb6b681
--- /dev/null
@@ -0,0 +1,149 @@
+// Created on: 1998-04-16
+// Created by: Robert COUBLANC
+// Copyright (c) 1998-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 _Select3D_SensitiveGroup_HeaderFile
+#define _Select3D_SensitiveGroup_HeaderFile
+
+#include <Standard.hxx>
+#include <Standard_DefineHandle.hxx>
+#include <Standard_Type.hxx>
+
+#include <Select3D_EntitySequence.hxx>
+#include <Select3D_SensitiveEntity.hxx>
+#include <Select3D_SensitiveSet.hxx>
+#include <Handle_SelectBasics_EntityOwner.hxx>
+#include <SelectMgr_SelectingVolumeManager.hxx>
+
+class SelectBasics_EntityOwner;
+class TopLoc_Location;
+
+
+//! A framework to define selection of a sensitive group
+//!          by a sensitive entity which is a set of 3D sensitive entities.
+//!          Remark: 2 modes are possible for rectangle selection
+//!          the group is considered selected
+//!          1) when all the entities inside are selected in the rectangle
+//!          2) only one entity inside is selected by the rectangle
+//!          By default the "Match All entities" mode is set.
+class Select3D_SensitiveGroup : public Select3D_SensitiveSet
+{
+public:
+
+  //! Constructs an empty sensitive group object.
+  //! This is a set of sensitive 3D entities. The sensitive
+  //! entities will be defined using the function Add to fill
+  //! the entity owner OwnerId. If MatchAll is false, nothing can be added.
+  Standard_EXPORT Select3D_SensitiveGroup (const Handle(SelectBasics_EntityOwner)& theOwnerId,
+                                           const Standard_Boolean theIsMustMatchAll = Standard_True);
+
+  //! Constructs a sensitive group object defined by the list
+  //! TheList and the entity owner OwnerId. If MatchAll is false, nothing is done.
+  Standard_EXPORT Select3D_SensitiveGroup (const Handle(SelectBasics_EntityOwner)& theOwnerId,
+                                           Select3D_EntitySequence& theEntities,
+                                           const Standard_Boolean theIsMustMatchAll = Standard_True);
+
+  //! Adds the list of sensitive entities LL to the empty
+  //! sensitive group object created at construction time.
+  Standard_EXPORT void Add (Select3D_EntitySequence& theEntities);
+
+  //! Adds the sensitive entity aSensitive to the non-empty
+  //! sensitive group object created at construction time.
+  Standard_EXPORT void Add (const Handle(Select3D_SensitiveEntity)& theSensitive);
+
+  Standard_EXPORT void Remove (const Handle(Select3D_SensitiveEntity)& theSensitive);
+
+  //! Removes all sensitive entities from the list used at the
+  //! time of construction, or added using the function Add.
+  Standard_EXPORT void Clear();
+
+  //! Returns true if the sensitive entity aSensitive is in
+  //! the list used at the time of construction, or added using the function Add.
+  Standard_EXPORT Standard_Boolean IsIn (const Handle(Select3D_SensitiveEntity)& theSensitive) const;
+
+  //! Sets the requirement that all sensitive entities in the
+  //! list used at the time of construction, or added using
+  //! the function Add must be matched.
+  void SetMatchType (const Standard_Boolean theIsMustMatchAll);
+
+  //! Returns true if all sensitive entities in the list used
+  //! at the time of construction, or added using the function Add must be matched.
+  Standard_Boolean MustMatchAll() const;
+
+  //! Checks whether the group overlaps current selecting volume
+  Standard_EXPORT virtual Standard_Boolean Matches (SelectBasics_SelectingVolumeManager& theMgr,
+                                                    SelectBasics_PickResult& thePickResult) Standard_OVERRIDE;
+
+  //! Returns the amount of sub-entities
+  Standard_EXPORT virtual Standard_Integer NbSubElements() Standard_OVERRIDE;
+
+  Standard_EXPORT virtual Handle(Select3D_SensitiveEntity) GetConnected() Standard_OVERRIDE;
+
+  //! Sets the owner for all entities in group
+  Standard_EXPORT void Set (const Handle(SelectBasics_EntityOwner)& theOwnerId);
+
+  //! Gets group content
+  const Select3D_EntitySequence& GetEntities() const;
+
+  //! Returns bounding box of the group. If location transformation
+  //! is set, it will be applied
+  Standard_EXPORT virtual Select3D_BndBox3d BoundingBox() Standard_OVERRIDE;
+
+  //! Returns center of entity set. If location transformation
+  //! is set, it will be applied
+  Standard_EXPORT virtual gp_Pnt CenterOfGeometry() const Standard_OVERRIDE;
+
+  //! Returns bounding box of sensitive entity with index theIdx
+  Standard_EXPORT virtual Select3D_BndBox3d Box (const Standard_Integer theIdx) const Standard_OVERRIDE;
+
+  //! Returns geometry center of sensitive entity index theIdx in
+  //! the vector along the given axis theAxis
+  Standard_EXPORT virtual Standard_Real Center (const Standard_Integer theIdx,
+                                                const Standard_Integer theAxis) const Standard_OVERRIDE;
+
+  //! Swaps items with indexes theIdx1 and theIdx2 in the vector
+  Standard_EXPORT virtual void Swap (const Standard_Integer theIdx1,
+                                     const Standard_Integer theIdx2) Standard_OVERRIDE;
+
+  //! Returns the length of vector of sensitive entities
+  Standard_EXPORT virtual Standard_Integer Size() const Standard_OVERRIDE;
+
+  DEFINE_STANDARD_RTTI(Select3D_SensitiveGroup)
+
+private:
+
+  //! Checks whether the entity with index theIdx overlaps the current selecting volume
+  virtual Standard_Boolean overlapsElement (SelectBasics_SelectingVolumeManager& theMgr,
+                                            Standard_Integer theElemIdx,
+                                            Standard_Real& theMatchDepth) Standard_OVERRIDE;
+
+  //! Calculates distance from the 3d projection of used-picked screen point to center of the geometry
+  virtual Standard_Real distanceToCOG (SelectBasics_SelectingVolumeManager& theMgr) Standard_OVERRIDE;
+
+private:
+
+  Select3D_EntitySequence              myEntities;           //!< Grouped sensitive entities
+  Standard_Boolean                     myMustMatchAll;       //!< Determines whether all entities in the group should be overlapped or not
+  gp_Pnt                               myCenter;             //!< Center of geometry of the group
+  mutable Select3D_BndBox3d            myBndBox;             //!< Bounding box of the group
+  NCollection_Vector<Standard_Integer> myBVHPrimIndexes;     //!< Vector of sub-entities indexes for BVH tree build
+};
+
+DEFINE_STANDARD_HANDLE(Select3D_SensitiveGroup, Select3D_SensitiveEntity)
+
+#include <Select3D_SensitiveGroup.lxx>
+
+#endif // _Select3D_SensitiveGroup_HeaderFile