1 // Copyright (c) 1995-1999 Matra Datavision
2 // Copyright (c) 1999-2014 OPEN CASCADE SAS
4 // This file is part of Open CASCADE Technology software library.
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.
12 // Alternatively, this file may be used under the terms of Open CASCADE
13 // commercial license or contractual agreement.
15 #ifndef _AIS_RadiusDimension_HeaderFile
16 #define _AIS_RadiusDimension_HeaderFile
19 #include <AIS_Dimension.hxx>
21 #include <gp_Circ.hxx>
22 #include <Standard.hxx>
23 #include <Standard_Macro.hxx>
25 DEFINE_STANDARD_HANDLE (AIS_RadiusDimension,AIS_Dimension)
27 //! Radius dimension. Can be constructued:
28 //! - On generic circle.
29 //! - On generic circle with user-defined anchor point on that circle.
30 //! - On generic shape containing geometry that can be measured
31 //! by diameter dimension: circle wire, arc, circular face, etc.
32 //! The anchor point is the location of left attachement point of
33 //! dimension on the circle. It can be user-specified, or computed as
34 //! middle point on the arc. The radius dimension always lies in the
35 //! plane of the measured circle. The dimension is considered as
36 //! invalid if the user-specified anchor point is not lying on the circle,
37 //! if the radius of the circle is less than Precision::Confusion().
38 //! In case if the dimension is built on the arbitrary shape,
39 //! it can be considered as invalid if the shape does not contain
41 class AIS_RadiusDimension : public AIS_Dimension
45 //! Create radius dimension for the circle geometry.
46 //! @param theCircle [in] the circle to measure.
47 Standard_EXPORT AIS_RadiusDimension (const gp_Circ& theCircle);
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 AIS_RadiusDimension (const gp_Circ& theCircle,
55 const gp_Pnt& theAnchorPoint);
57 //! Create radius dimension for the arbitrary shape (if possible).
58 //! @param theShape [in] the shape to measure.
59 Standard_EXPORT AIS_RadiusDimension (const TopoDS_Shape& theShape);
63 //! @return measured geometry circle.
64 const gp_Circ& Circle() const
69 //! @return anchor point on circle for radius dimension.
70 const gp_Pnt& AnchorPoint() const
75 //! @return the measured shape.
76 const TopoDS_Shape& Shape() const
83 //! Measure radius of the circle.
84 //! The dimension will become invalid if the radius of the circle
85 //! is less than Precision::Confusion().
86 //! @param theCircle [in] the circle to measure.
87 Standard_EXPORT void SetMeasuredGeometry (const gp_Circ& theCircle);
89 //! Measure radius of the circle and orient the dimension so
90 //! the dimension lines attaches to anchor point on the circle.
91 //! The dimension will become invalid if the radius of the circle
92 //! is less than Precision::Confusion().
93 //! @param theCircle [in] the circle to measure.
94 //! @param theAnchorPoint [in] the point to attach the dimension lines.
95 Standard_EXPORT void SetMeasuredGeometry (const gp_Circ& theCircle,
96 const gp_Pnt& theAnchorPoint);
98 //! Measure radius on the passed shape, if applicable.
99 //! The dimension will become invalid if the passed shape is not
100 //! measurable or if measured diameter value is less than Precision::Confusion().
101 //! @param theShape [in] the shape to measure.
102 Standard_EXPORT void SetMeasuredGeometry (const TopoDS_Shape& theShape);
104 //! @return the display units string.
105 Standard_EXPORT virtual const TCollection_AsciiString& GetDisplayUnits() const;
107 //! @return the model units string.
108 Standard_EXPORT virtual const TCollection_AsciiString& GetModelUnits() const;
110 Standard_EXPORT virtual void SetDisplayUnits (const TCollection_AsciiString& theUnits);
112 Standard_EXPORT virtual void SetModelUnits (const TCollection_AsciiString& theUnits);
114 Standard_EXPORT virtual void SetTextPosition (const gp_Pnt& theTextPos);
116 Standard_EXPORT virtual const gp_Pnt GetTextPosition() const;
120 DEFINE_STANDARD_RTTI (AIS_RadiusDimension)
124 Standard_EXPORT virtual void ComputePlane();
126 //! Checks if anchor point and the center of the circle are on the plane.
127 Standard_EXPORT virtual Standard_Boolean CheckPlane (const gp_Pln& thePlane) const;
129 Standard_EXPORT virtual Standard_Real ComputeValue() const;
131 Standard_EXPORT virtual void Compute (const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
132 const Handle(Prs3d_Presentation)& thePresentation,
133 const Standard_Integer theMode = 0);
137 Standard_EXPORT Standard_Boolean IsValidCircle (const gp_Circ& theCircle) const;
139 Standard_EXPORT Standard_Boolean IsValidAnchor (const gp_Circ& theCircle,
140 const gp_Pnt& thePnt) const;
145 gp_Pnt myAnchorPoint;
146 TopoDS_Shape myShape;
149 #endif // _AIS_RadiusDimension_HeaderFile