b46d8246d36854f843f5ea349c3682d4335fe591
[occt.git] / src / Select3D / Select3D_SensitiveFace.hxx
1 // Created on: 1995-03-27
2 // Created by: Robert COUBLANC
3 // Copyright (c) 1995-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
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.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _Select3D_SensitiveFace_HeaderFile
18 #define _Select3D_SensitiveFace_HeaderFile
19
20 #include <Select3D_TypeOfSensitivity.hxx>
21 #include <Select3D_SensitiveSet.hxx>
22 #include <TColgp_HArray1OfPnt.hxx>
23 #include <SelectBasics_SelectingVolumeManager.hxx>
24
25 class Standard_ConstructionError;
26 class Standard_OutOfRange;
27
28 //! Sensitive Entity to make a face selectable.
29 //! In some cases this class can raise Standard_ConstructionError and
30 //! Standard_OutOfRange exceptions. For more details see Select3D_SensitivePoly.
31 class Select3D_SensitiveFace : public Select3D_SensitiveEntity
32 {
33   DEFINE_STANDARD_RTTIEXT(Select3D_SensitiveFace, Select3D_SensitiveEntity)
34 public:
35
36   //! Constructs a sensitive face object defined by the
37   //! owner theOwnerId, the array of points thePoints, and
38   //! the sensitivity type theType.
39   //! The array of points is the outer polygon of the geometric face.
40   Standard_EXPORT Select3D_SensitiveFace (const Handle(SelectBasics_EntityOwner)& theOwnerId,
41                                           const TColgp_Array1OfPnt& thePoints,
42                                           const Select3D_TypeOfSensitivity theType);
43
44   //! Constructs a sensitive face object defined by the
45   //! owner theOwnerId, the array of points thePoints, and
46   //! the sensitivity type theType.
47   //! The array of points is the outer polygon of the geometric face.
48   Standard_EXPORT Select3D_SensitiveFace (const Handle(SelectBasics_EntityOwner)& theOwnerId,
49                                           const Handle(TColgp_HArray1OfPnt)& thePoints,
50                                           const Select3D_TypeOfSensitivity theType);
51
52   //! Initializes the given array theHArrayOfPnt by 3d
53   //! coordinates of vertices of the face
54   Standard_EXPORT void GetPoints (Handle(TColgp_HArray1OfPnt)& theHArrayOfPnt);
55
56   //! Checks whether the face overlaps current selecting volume
57   Standard_EXPORT virtual Standard_Boolean Matches (SelectBasics_SelectingVolumeManager& theMgr,
58                                                     SelectBasics_PickResult& thePickResult) Standard_OVERRIDE;
59
60   Standard_EXPORT virtual Handle(Select3D_SensitiveEntity) GetConnected() Standard_OVERRIDE;
61
62   //! Returns bounding box of the face. If location transformation
63   //! is set, it will be applied
64   Standard_EXPORT virtual Select3D_BndBox3d BoundingBox() Standard_OVERRIDE;
65
66   //! Returns center of the face. If location transformation
67   //! is set, it will be applied
68   Standard_EXPORT virtual gp_Pnt CenterOfGeometry() const Standard_OVERRIDE;
69
70   //! Builds BVH tree for the face
71   Standard_EXPORT virtual void BVH() Standard_OVERRIDE;
72
73   //! Returns the amount of sub-entities (points or planar convex polygons)
74   Standard_EXPORT virtual Standard_Integer NbSubElements() Standard_OVERRIDE;
75
76 private:
77
78   Select3D_TypeOfSensitivity    mySensType;       //!< Type of sensitivity: interior or boundary
79   Handle(Select3D_SensitiveSet) myFacePoints;     //!< Wrapper for overlap detection created depending on sensitivity type
80 };
81
82 DEFINE_STANDARD_HANDLE(Select3D_SensitiveFace, Select3D_SensitiveEntity)
83
84 #endif // _Select3D_SensitiveFace_HeaderFile