include/opencascade/BRepMesh_Circle.hxx

0001 // Copyright (c) 2013 OPEN CASCADE SAS
0002 //
0003 // This file is part of Open CASCADE Technology software library.
0004 //
0005 // This library is free software; you can redistribute it and/or modify it under
0006 // the terms of the GNU Lesser General Public License version 2.1 as published
0007 // by the Free Software Foundation, with special exception defined in the file
0008 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0009 // distribution for complete text of the license and disclaimer of any warranty.
0010 //
0011 // Alternatively, this file may be used under the terms of Open CASCADE
0012 // commercial license or contractual agreement.
0013
0014 #ifndef _BRepMesh_Circle_HeaderFile
0015 #define _BRepMesh_Circle_HeaderFile
0016
0017 #include <Standard.hxx>
0018 #include <Standard_DefineAlloc.hxx>
0019 #include <gp_XY.hxx>
0020
0021 //! Describes a 2d circle with a size of only 3 double
0022 //! numbers instead of gp who needs 7 double numbers.
0023 class BRepMesh_Circle
0024 {
0025 public:
0026   DEFINE_STANDARD_ALLOC
0027
0028   //! Default constructor.
0029   BRepMesh_Circle()
0030       : myRadius(0.0)
0031   {
0032   }
0033
0034   //! Constructor.
0035   //! @param theLocation location of a circle.
0036   //! @param theRadius radius of a circle.
0037   BRepMesh_Circle(const gp_XY& theLocation, const double theRadius)
0038       : myLocation(theLocation),
0039         myRadius(theRadius)
0040   {
0041   }
0042
0043   //! Sets location of a circle.
0044   //! @param theLocation location of a circle.
0045   void SetLocation(const gp_XY& theLocation) { myLocation = theLocation; }
0046
0047   //! Sets radius of a circle.
0048   //! @param theRadius radius of a circle.
0049   void SetRadius(const double theRadius) { myRadius = theRadius; }
0050
0051   //! Returns location of a circle.
0052   const gp_XY& Location() const { return myLocation; }
0053
0054   //! Returns radius of a circle.
0055   const double& Radius() const { return myRadius; }
0056
0057 private:
0058   gp_XY  myLocation;
0059   double myRadius;
0060 };
0061
0062 #endif