0030349: Coding - add usage of Standard_EXPORT for some not inline methods in Select3D
[occt.git] / src / Select3D / Select3D_SensitiveCircle.hxx
1 // Created on: 1996-02-06
2 // Created by: Robert COUBLANC
3 // Copyright (c) 1996-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_SensitiveCircle_HeaderFile
18 #define _Select3D_SensitiveCircle_HeaderFile
19
20 #include <Select3D_SensitivePoly.hxx>
21 #include <TColgp_HArray1OfPnt.hxx>
22 #include <SelectMgr_SelectingVolumeManager.hxx>
23 #include <Select3D_TypeOfSensitivity.hxx>
24
25 class Geom_Circle;
26 class Standard_ConstructionError;
27 class Standard_OutOfRange;
28
29 //! A framework to define sensitive 3D arcs and circles.
30 //! In some cases this class can raise Standard_ConstructionError and
31 //! Standard_OutOfRange exceptions. For more details see Select3D_SensitivePoly.
32 class Select3D_SensitiveCircle : public Select3D_SensitivePoly
33 {
34   DEFINE_STANDARD_RTTIEXT(Select3D_SensitiveCircle, Select3D_SensitivePoly)
35 public:
36
37   //! Constructs the sensitive circle object defined by the
38   //! owner theOwnerId, the circle theCircle, the boolean
39   //! theIsFilled and the number of points theNbPnts.
40   Standard_EXPORT Select3D_SensitiveCircle (const Handle(SelectBasics_EntityOwner)& theOwnerId,
41                                             const Handle(Geom_Circle)& theCircle,
42                                             const Standard_Boolean theIsFilled = Standard_False,
43                                             const Standard_Integer theNbPnts = 12);
44
45   //! Constructs the sensitive arc object defined by the
46   //! owner theOwnerId, the circle theCircle, the parameters theU1
47   //! and theU2, the boolean theIsFilled and the number of points theNbPnts.
48   //! theU1 and theU2 define the first and last points of the arc on theCircle.
49   Standard_EXPORT Select3D_SensitiveCircle (const Handle(SelectBasics_EntityOwner)& theOwnerId,
50                                             const Handle(Geom_Circle)& theCircle,
51                                             const Standard_Real theU1,
52                                             const Standard_Real theU2,
53                                             const Standard_Boolean theIsFilled = Standard_False,
54                                             const Standard_Integer theNbPnts = 12);
55
56   //! Constructs the sensitive circle object defined by the
57   //! owner theOwnerId, the array of triangles thePnts3d, and the boolean theIsFilled.
58   //! thePnts3d is an array of consecutive triangles on the
59   //! circle. The triangle i+1 lies on the intersection of the
60   //! tangents to the circle of i and i+2. Note, that the first point of thePnts3d
61   //! must be equal to the last point of thePnts3d.
62   Standard_EXPORT Select3D_SensitiveCircle (const Handle(SelectBasics_EntityOwner)& theOwnerId,
63                                             const Handle(TColgp_HArray1OfPnt)& thePnts3d,
64                                             const Standard_Boolean theIsFilled = Standard_False);
65
66   //! Constructs the sensitive circle object defined by the
67   //! owner theOwnerId, the array of points thePnts3d, and the boolean theIsFilled.
68   //! If the length of thePnts3d is more then 1, the first point of thePnts3d
69   //! must be equal to the last point of thePnts3d.
70   Standard_EXPORT Select3D_SensitiveCircle (const Handle(SelectBasics_EntityOwner)& theOwnerId,
71                                             const TColgp_Array1OfPnt& thePnts3d,
72                                             const Standard_Boolean theIsFilled = Standard_False);
73
74   //! Checks whether the circle overlaps current selecting volume
75   Standard_EXPORT  virtual Standard_Boolean Matches (SelectBasics_SelectingVolumeManager& theMgr,
76                                                      SelectBasics_PickResult& thePickResult) Standard_OVERRIDE;
77
78
79   Standard_EXPORT void ArrayBounds (Standard_Integer & theLow, Standard_Integer & theUp) const;
80
81   Standard_EXPORT gp_Pnt GetPoint3d (const Standard_Integer thePntIdx) const;
82
83   Standard_EXPORT virtual Handle(Select3D_SensitiveEntity) GetConnected() Standard_OVERRIDE;
84
85   //! Returns center of the circle. If location
86   //! transformation is set, it will be applied
87   Standard_EXPORT virtual gp_Pnt CenterOfGeometry() const Standard_OVERRIDE;
88
89   //! Builds BVH tree for a circle's edge segments if needed
90   Standard_EXPORT virtual void BVH() Standard_OVERRIDE;
91
92 protected:
93
94   //! Calculates distance from the 3d projection of used-picked screen point
95   //! to center of the geometry
96   Standard_EXPORT virtual Standard_Real distanceToCOG (SelectBasics_SelectingVolumeManager& theMgr) Standard_OVERRIDE;
97
98 private:
99
100   //! Computes myCenter3D as the barycenter of points from mypolyg3d
101   void computeCenter3D();
102
103 private:
104
105   Select3D_TypeOfSensitivity mySensType; //!< True if type of selection is interior, false otherwise
106   gp_Pnt                     myCenter3D; //!< Center of a circle
107   Handle(Geom_Circle)        myCircle;   //!< Points of the circle
108   Standard_Real              myStart;    //!< Sensitive arc parameter
109   Standard_Real              myEnd;      //!< Sensitive arc parameter
110 };
111
112 DEFINE_STANDARD_HANDLE(Select3D_SensitiveCircle, Select3D_SensitivePoly)
113
114 #endif // _Select3D_SensitiveCircle_HeaderFile