0023987: 2D fillets
[occt.git] / src / ChFi2d / ChFi2d_ChamferAPI.hxx
1 // Created on: 2013-05-20
2 // Created by: Mikhail PONIKAROV
3 // Copyright (c) 2003-2012 OPEN CASCADE SAS
4 //
5 // The content of this file is subject to the Open CASCADE Technology Public
6 // License Version 6.5 (the "License"). You may not use the content of this file
7 // except in compliance with the License. Please obtain a copy of the License
8 // at http://www.opencascade.org and read it completely before using this file.
9 //
10 // The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
11 // main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
12 //
13 // The Original Code and all software distributed under the License is
14 // distributed on an "AS IS" basis, without warranty of any kind, and the
15 // Initial Developer hereby disclaims all such warranties, including without
16 // limitation, any warranties of merchantability, fitness for a particular
17 // purpose or non-infringement. Please see the License for the specific terms
18 // and conditions governing the rights and limitations under the License.
19
20 #ifndef _CHAMFERAPI_H_
21 #define _CHAMFERAPI_H_
22
23 #include <TopoDS_Edge.hxx>
24 #include <TopoDS_Wire.hxx>
25 #include <Geom_Curve.hxx>
26
27 //! A class making a chamfer between two linear edges.
28 class ChFi2d_ChamferAPI
29 {
30 public:
31
32   //! An empty constructor.
33   Standard_EXPORT ChFi2d_ChamferAPI();
34
35   //! A constructor accepting a wire consisting of two linear edges.
36   Standard_EXPORT ChFi2d_ChamferAPI(const TopoDS_Wire& theWire);
37
38   //! A constructor accepting two linear edges.
39   Standard_EXPORT ChFi2d_ChamferAPI(const TopoDS_Edge& theEdge1, const TopoDS_Edge& theEdge2);
40
41   //! Initializes the class by a wire consisting of two libear edges.
42   Standard_EXPORT void Init(const TopoDS_Wire& theWire);
43
44   //! Initializes the class by two linear edges.
45   Standard_EXPORT void Init(const TopoDS_Edge& theEdge1, const TopoDS_Edge& theEdge2);
46
47   //! Constructs a chamfer edge.
48   //! Returns true if the edge is constructed.
49   Standard_EXPORT Standard_Boolean Perform();
50
51   // Returns the result (chamfer edge, modified edge1, modified edge2).
52   Standard_EXPORT TopoDS_Edge Result(TopoDS_Edge& theEdge1, TopoDS_Edge& theEdge2,
53                                      const Standard_Real theLength1, const Standard_Real theLength2);
54
55 private:
56
57   TopoDS_Edge myEdge1, myEdge2;
58   Handle(Geom_Curve) myCurve1, myCurve2;
59   Standard_Real myStart1, myEnd1, myStart2, myEnd2;
60   Standard_Boolean myCommonStart1, myCommonStart2;
61 };
62
63 #endif // _CHAMFERAPI_H_