1 // Created on: 1996-10-17
2 // Created by: Odile OLIVIER
3 // Copyright (c) 1996-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
6 // This file is part of Open CASCADE Technology software library.
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
17 #ifndef _Select3D_SensitiveWire_HeaderFile
18 #define _Select3D_SensitiveWire_HeaderFile
20 #include <Standard.hxx>
21 #include <Standard_DefineHandle.hxx>
22 #include <Standard_Type.hxx>
24 #include <Select3D_SensitiveSet.hxx>
25 #include <Handle_SelectBasics_EntityOwner.hxx>
26 #include <Standard_OStream.hxx>
27 #include <NCollection_Sequence.hxx>
29 class SelectBasics_EntityOwner;
30 class TopLoc_Location;
31 class Select3D_SensitiveEntitySequence;
34 //! A framework to define selection of a wire owner by an
35 //! elastic wire band.
36 class Select3D_SensitiveWire : public Select3D_SensitiveSet
40 //! Constructs a sensitive wire object defined by the
42 Standard_EXPORT Select3D_SensitiveWire (const Handle(SelectBasics_EntityOwner)& theOwnerId);
44 //! Adds the sensitive entity theSensitive to this framework.
45 Standard_EXPORT void Add (const Handle(Select3D_SensitiveEntity)& theSensitive);
47 //! Returns the amount of sub-entities
48 Standard_EXPORT virtual Standard_Integer NbSubElements() Standard_OVERRIDE;
50 Standard_EXPORT virtual Handle(Select3D_SensitiveEntity) GetConnected() Standard_OVERRIDE;
52 //! returns the sensitive edges stored in this wire
53 Standard_EXPORT const NCollection_Vector<Handle(Select3D_SensitiveEntity)>& GetEdges();
55 //! Sets the owner for all entities in wire
56 Standard_EXPORT void Set (const Handle(SelectBasics_EntityOwner)& theOwnerId);
58 Standard_EXPORT Handle_Select3D_SensitiveEntity GetLastDetected() const;
60 //! Returns bounding box of the wire. If location
61 //! transformation is set, it will be applied
62 Standard_EXPORT virtual Select3D_BndBox3d BoundingBox() Standard_OVERRIDE;
64 //! Returns center of the wire. If location transformation
65 //! is set, it will be applied
66 Standard_EXPORT virtual gp_Pnt CenterOfGeometry() const Standard_OVERRIDE;
68 //! Returns the length of vector of sensitive entities
69 Standard_EXPORT virtual Standard_Integer Size() const Standard_OVERRIDE;
71 //! Returns bounding box of sensitive entity with index theIdx
72 Standard_EXPORT virtual Select3D_BndBox3d Box (const Standard_Integer theIdx) const Standard_OVERRIDE;
74 //! Returns geometry center of sensitive entity index theIdx in
75 //! the vector along the given axis theAxis
76 Standard_EXPORT virtual Standard_Real Center (const Standard_Integer theIdx,
77 const Standard_Integer theAxis) const Standard_OVERRIDE;
79 //! Swaps items with indexes theIdx1 and theIdx2 in the vector
80 Standard_EXPORT virtual void Swap (const Standard_Integer theIdx1,
81 const Standard_Integer theIdx2) Standard_OVERRIDE;
83 DEFINE_STANDARD_RTTI(Select3D_SensitiveWire)
87 //! Checks whether the entity with index theIdx overlaps the current selecting volume
88 Standard_EXPORT virtual Standard_Boolean overlapsElement (SelectBasics_SelectingVolumeManager& theMgr,
89 Standard_Integer theElemIdx,
90 Standard_Real& theMatchDepth) Standard_OVERRIDE;
92 //! Calculates distance from the 3d projection of used-picked screen point to center of the geometry
93 Standard_EXPORT virtual Standard_Real distanceToCOG (SelectBasics_SelectingVolumeManager& theMgr) Standard_OVERRIDE;
97 NCollection_Vector<Handle(Select3D_SensitiveEntity)> myEntities; //!< Vector of sub-entities
98 NCollection_Vector<Standard_Integer> myEntityIndexes; //!< Indexes of entities for BVH build
99 gp_Pnt myCenter; //!< Center of the whole wire
100 mutable Select3D_BndBox3d myBndBox; //!< Bounding box of the whole wire
103 DEFINE_STANDARD_HANDLE(Select3D_SensitiveWire, Select3D_SensitiveEntity)
105 #endif // _Select3D_SensitiveWire_HeaderFile