include/opencascade/gce_MakeCirc.hxx

0001 // Created on: 1992-08-26
0002 // Created by: Remi GILET
0003 // Copyright (c) 1992-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _gce_MakeCirc_HeaderFile
0018 #define _gce_MakeCirc_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 #include <gp_Circ.hxx>
0024 #include <gce_Root.hxx>
0025 class gp_Ax2;
0026 class gp_Pnt;
0027 class gp_Dir;
0028 class gp_Pln;
0029 class gp_Ax1;
0030
0031 //! This class implements construction algorithms for `gp_Circ`.
0032 //! Supported constructions include:
0033 //! - circle from axis and radius;
0034 //! - circle coaxial to another one, through point or at signed offset;
0035 //! - circle through three points;
0036 //! - circle from center and normal/plane;
0037 //! - circle from center and axis-defining point;
0038 //! - circle from axis and radius.
0039 class gce_MakeCirc : public gce_Root
0040 {
0041 public:
0042   DEFINE_STANDARD_ALLOC
0043
0044   //! Creates a circle from axis placement and radius.
0045   //! @note Construction fails with `gce_NegativeRadius` if `Radius` is negative.
0046   //! @param[in] A2 local coordinate system
0047   //! @param[in] Radius radius value
0048   Standard_EXPORT gce_MakeCirc(const gp_Ax2& A2, const double Radius);
0049
0050   //! Creates a circle coaxial to input circle at signed distance.
0051   //! @note If `Dist` is positive, the result encloses `Circ`.
0052   //! @note If `Dist` is negative, the result is enclosed by `Circ`.
0053   //! @param[in] Circ source circle
0054   //! @param[in] Dist signed distance
0055   Standard_EXPORT gce_MakeCirc(const gp_Circ& Circ, const double Dist);
0056
0057   //! Creates a circle coaxial to input circle and passing through a point.
0058   //! @param[in] Circ source circle
0059   //! @param[in] Point reference point
0060   Standard_EXPORT gce_MakeCirc(const gp_Circ& Circ, const gp_Pnt& Point);
0061
0062   //! Creates a circle passing through three points.
0063   //! @param[in] P1 first point
0064   //! @param[in] P2 second point
0065   //! @param[in] P3 third point
0066   Standard_EXPORT gce_MakeCirc(const gp_Pnt& P1, const gp_Pnt& P2, const gp_Pnt& P3);
0067
0068   //! Creates a circle from center, plane normal and radius.
0069   //! @param[in] Center center point
0070   //! @param[in] Norm input value
0071   //! @param[in] Radius radius value
0072   Standard_EXPORT gce_MakeCirc(const gp_Pnt& Center, const gp_Dir& Norm, const double Radius);
0073
0074   //! Creates a circle from center, reference plane and radius.
0075   //! @param[in] Center center point
0076   //! @param[in] Plane reference plane
0077   //! @param[in] Radius radius value
0078   Standard_EXPORT gce_MakeCirc(const gp_Pnt& Center, const gp_Pln& Plane, const double Radius);
0079
0080   //! Creates a circle from center, axis-defining point and radius.
0081   //! @param[in] Center center point
0082   //! @param[in] Ptaxis point defining axis direction
0083   //! @param[in] Radius radius value
0084   Standard_EXPORT gce_MakeCirc(const gp_Pnt& Center, const gp_Pnt& Ptaxis, const double Radius);
0085
0086   //! Creates a circle from axis and radius.
0087   //! @note Construction fails with `gce_NegativeRadius` if `Radius` is negative.
0088   //! @param[in] Axis axis definition
0089   //! @param[in] Radius radius value
0090   Standard_EXPORT gce_MakeCirc(const gp_Ax1& Axis, const double Radius);
0091
0092   //! Returns the constructed circle.
0093   //! Exceptions StdFail_NotDone if no circle is constructed.
0094   //! @return resulting circle
0095   Standard_EXPORT const gp_Circ& Value() const;
0096
0097   //! Alias for Value() returning a copy.
0098   //! @return resulting object
0099   gp_Circ Operator() const { return Value(); }
0100
0101   //! Conversion operator returning the constructed object.
0102   //! @return resulting object
0103   operator gp_Circ() const { return Operator(); }
0104
0105 private:
0106   gp_Circ TheCirc;
0107 };
0108
0109 #endif // _gce_MakeCirc_HeaderFile