0031459: Visualization, AIS_TextLabel - add missing getters
[occt.git] / src / PrsDim / PrsDim_RadiusDimension.hxx
1 // Copyright (c) 1995-1999 Matra Datavision
2 // Copyright (c) 1999-2014 OPEN CASCADE SAS
3 //
4 // This file is part of Open CASCADE Technology software library.
5 //
6 // This library is free software; you can redistribute it and/or modify it under
7 // the terms of the GNU Lesser General Public License version 2.1 as published
8 // by the Free Software Foundation, with special exception defined in the file
9 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
10 // distribution for complete text of the license and disclaimer of any warranty.
11 //
12 // Alternatively, this file may be used under the terms of Open CASCADE
13 // commercial license or contractual agreement.
14
15 #ifndef _PrsDim_RadiusDimension_HeaderFile
16 #define _PrsDim_RadiusDimension_HeaderFile
17
18 #include <PrsDim_Dimension.hxx>
19 #include <gp_Pnt.hxx>
20 #include <gp_Circ.hxx>
21 #include <Standard.hxx>
22 #include <Standard_Macro.hxx>
23
24 DEFINE_STANDARD_HANDLE(PrsDim_RadiusDimension, PrsDim_Dimension)
25
26 //! Radius dimension. Can be constructued:
27 //! - On generic circle.
28 //! - On generic circle with user-defined anchor point on that circle.
29 //! - On generic shape containing geometry that can be measured
30 //!   by diameter dimension: circle wire, arc, circular face, etc.
31 //! The anchor point is the location of left attachement point of
32 //! dimension on the circle. It can be user-specified, or computed as
33 //! middle point on the arc. The radius dimension always lies in the
34 //! plane of the measured circle. The dimension is considered as
35 //! invalid if the user-specified anchor point is not lying on the circle,
36 //! if the radius of the circle is less than Precision::Confusion().
37 //! In case if the dimension is built on the arbitrary shape,
38 //! it can be considered as invalid if the shape does not contain
39 //! circle geometry.
40 class PrsDim_RadiusDimension : public PrsDim_Dimension
41 {
42   DEFINE_STANDARD_RTTIEXT(PrsDim_RadiusDimension, PrsDim_Dimension)
43 public:
44
45   //! Create radius dimension for the circle geometry.
46   //! @param theCircle [in] the circle to measure.
47   Standard_EXPORT PrsDim_RadiusDimension (const gp_Circ& theCircle);
48
49   //! Create radius dimension for the circle geometry and define its
50   //! orientation by location of the first point on that circle.
51   //! @param theCircle [in] the circle to measure.
52   //! @param theAnchorPoint [in] the point to define the position
53   //!        of the dimension attachment on the circle.
54   Standard_EXPORT PrsDim_RadiusDimension (const gp_Circ& theCircle,
55                                          const gp_Pnt& theAnchorPoint);
56
57   //! Create radius dimension for the arbitrary shape (if possible).
58   //! @param theShape [in] the shape to measure.
59   Standard_EXPORT PrsDim_RadiusDimension (const TopoDS_Shape& theShape);
60
61 public:
62
63   //! @return measured geometry circle.
64   const gp_Circ& Circle() const { return myCircle; }
65
66   //! @return anchor point on circle for radius dimension.
67   const gp_Pnt& AnchorPoint() const { return myAnchorPoint; }
68
69   //! @return the measured shape.
70   const TopoDS_Shape& Shape() const { return myShape; }
71
72 public:
73
74   //! Measure radius of the circle.
75   //! The dimension will become invalid if the radius of the circle
76   //! is less than Precision::Confusion().
77   //! @param theCircle [in] the circle to measure.
78   void SetMeasuredGeometry (const gp_Circ& theCircle) { SetMeasuredGeometry (theCircle, gp_Pnt(), Standard_False); }
79
80   //! Measure radius of the circle and orient the dimension so
81   //! the dimension lines attaches to anchor point on the circle.
82   //! The dimension will become invalid if the radius of the circle
83   //! is less than Precision::Confusion().
84   //! @param theCircle [in] the circle to measure.
85   //! @param theAnchorPoint [in] the point to attach the dimension lines, should be on the circle
86   //! @param theHasAnchor   [in] should be set TRUE if theAnchorPoint should be used
87   Standard_EXPORT void SetMeasuredGeometry (const gp_Circ& theCircle,
88                                             const gp_Pnt& theAnchorPoint,
89                                             const Standard_Boolean theHasAnchor = Standard_True);
90
91   //! Measure radius on the passed shape, if applicable.
92   //! The dimension will become invalid if the passed shape is not
93   //! measurable or if measured diameter value is less than Precision::Confusion().
94   //! @param theShape [in] the shape to measure.
95   void SetMeasuredGeometry (const TopoDS_Shape& theShape) { SetMeasuredGeometry (theShape, gp_Pnt(), Standard_False); }
96
97   //! Measure radius on the passed shape, if applicable.
98   //! The dimension will become invalid if the passed shape is not
99   //! measurable or if measured diameter value is less than Precision::Confusion().
100   //! @param theShape [in] the shape to measure.
101   //! @param theAnchorPoint [in] the point to attach the dimension lines, should be on the circle
102   //! @param theHasAnchor   [in] should be set TRUE if theAnchorPoint should be used
103   Standard_EXPORT void SetMeasuredGeometry (const TopoDS_Shape& theShape,
104                                             const gp_Pnt& theAnchorPoint,
105                                             const Standard_Boolean theHasAnchor = Standard_True);
106
107   //! @return the display units string.
108   Standard_EXPORT virtual const TCollection_AsciiString& GetDisplayUnits() const Standard_OVERRIDE;
109   
110   //! @return the model units string.
111   Standard_EXPORT virtual const TCollection_AsciiString& GetModelUnits() const Standard_OVERRIDE;
112
113   Standard_EXPORT virtual void SetDisplayUnits (const TCollection_AsciiString& theUnits) Standard_OVERRIDE;
114
115   Standard_EXPORT virtual void SetModelUnits (const TCollection_AsciiString& theUnits) Standard_OVERRIDE;
116
117   Standard_EXPORT virtual void SetTextPosition (const gp_Pnt& theTextPos) Standard_OVERRIDE;
118
119   Standard_EXPORT virtual gp_Pnt GetTextPosition() const Standard_OVERRIDE;
120
121 protected:
122
123   Standard_EXPORT virtual void ComputePlane();
124
125   //! Checks if anchor point and the center of the circle are on the plane.
126   Standard_EXPORT virtual Standard_Boolean CheckPlane (const gp_Pln& thePlane) const Standard_OVERRIDE;
127
128   Standard_EXPORT virtual Standard_Real ComputeValue() const Standard_OVERRIDE;
129
130   Standard_EXPORT virtual void Compute (const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
131                                         const Handle(Prs3d_Presentation)& thePresentation,
132                                         const Standard_Integer theMode = 0) Standard_OVERRIDE;
133
134 protected:
135
136   Standard_EXPORT Standard_Boolean IsValidCircle (const gp_Circ& theCircle) const;
137
138   Standard_EXPORT Standard_Boolean IsValidAnchor (const gp_Circ& theCircle,
139                                                   const gp_Pnt& thePnt) const;
140
141 private:
142
143   gp_Circ      myCircle;
144   gp_Pnt       myAnchorPoint;
145   TopoDS_Shape myShape;
146 };
147
148 #endif // _PrsDim_RadiusDimension_HeaderFile