7d4d45aa07aee32579531bc8b926891c106e6cd0
[occt.git] / src / GC / GC_MakeArcOfCircle.hxx
1 // Created on: 1992-09-28
2 // Created by: Remi GILET
3 // Copyright (c) 1992-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 _GC_MakeArcOfCircle_HeaderFile
18 #define _GC_MakeArcOfCircle_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <GC_Root.hxx>
25 #include <Geom_TrimmedCurve.hxx>
26
27 class gp_Circ;
28 class gp_Pnt;
29 class gp_Vec;
30
31
32 //! Implements construction algorithms for an
33 //! arc of circle in 3D space. The result is a Geom_TrimmedCurve curve.
34 //! A MakeArcOfCircle object provides a framework for:
35 //! -   defining the construction of the arc of circle,
36 //! -   implementing the construction algorithm, and
37 //! -   consulting the results. In particular, the
38 //! Value function returns the constructed arc of circle.
39 class GC_MakeArcOfCircle  : public GC_Root
40 {
41 public:
42
43   DEFINE_STANDARD_ALLOC
44
45   
46   //! Make an arc of circle (TrimmedCurve from Geom) from
47   //! a circle between two angles Alpha1 and Alpha2
48   //! given in radiians.
49   Standard_EXPORT GC_MakeArcOfCircle(const gp_Circ& Circ, const Standard_Real Alpha1, const Standard_Real Alpha2, const Standard_Boolean Sense);
50   
51   //! Make an arc of circle (TrimmedCurve from Geom) from
52   //! a circle between point <P> and the angle Alpha
53   //! given in radians.
54   Standard_EXPORT GC_MakeArcOfCircle(const gp_Circ& Circ, const gp_Pnt& P, const Standard_Real Alpha, const Standard_Boolean Sense);
55   
56   //! Make an arc of circle (TrimmedCurve from Geom) from
57   //! a circle between two points P1 and P2.
58   Standard_EXPORT GC_MakeArcOfCircle(const gp_Circ& Circ, const gp_Pnt& P1, const gp_Pnt& P2, const Standard_Boolean Sense);
59   
60   //! Make an arc of circle (TrimmedCurve from Geom) from
61   //! three points P1,P2,P3 between two points P1 and P2.
62   Standard_EXPORT GC_MakeArcOfCircle(const gp_Pnt& P1, const gp_Pnt& P2, const gp_Pnt& P3);
63   
64   //! Make an arc of circle (TrimmedCurve from Geom) from
65   //! two points P1,P2 and the tangente to the solution at
66   //! the point P1.
67   //! The orientation of the arc is:
68   //! -   the sense determined by the order of the points P1, P3 and P2;
69   //! -   the sense defined by the vector V; or
70   //! -   for other syntaxes:
71   //! -   the sense of Circ if Sense is true, or
72   //! -   the opposite sense if Sense is false.
73   //! Note: Alpha1, Alpha2 and Alpha are angle values, given in radians.
74   //! Warning
75   //! If an error occurs (that is, when IsDone returns
76   //! false), the Status function returns:
77   //! -   gce_ConfusedPoints if:
78   //! -   any 2 of the 3 points P1, P2 and P3 are coincident, or
79   //! -   P1 and P2 are coincident; or
80   //! -   gce_IntersectionError if:
81   //! -   P1, P2 and P3 are collinear and not coincident, or
82   //! -   the vector defined by the points P1 and
83   //! P2 is collinear with the vector V.
84   Standard_EXPORT GC_MakeArcOfCircle(const gp_Pnt& P1, const gp_Vec& V, const gp_Pnt& P2);
85   
86   //! Returns the constructed arc of circle.
87   //! Exceptions StdFail_NotDone if no arc of circle is constructed.
88   Standard_EXPORT const Handle(Geom_TrimmedCurve)& Value() const;
89
90   operator const Handle(Geom_TrimmedCurve)& () const { return Value(); }
91   operator const Handle(Geom_Curve)& () const { return Value(); }
92
93 private:
94   Handle(Geom_TrimmedCurve) TheArc;
95 };
96
97 #endif // _GC_MakeArcOfCircle_HeaderFile