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