src/BRepPrim/BRepPrim_Torus.hxx

   1 // Created on: 1992-11-05
   2 // Created by: Remi LEQUETTE
   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 _BRepPrim_Torus_HeaderFile
  18 #define _BRepPrim_Torus_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <Standard_Real.hxx>
  25 #include <BRepPrim_Revolution.hxx>
  26 class Standard_DomainError;
  27 class gp_Ax2;
  28 class gp_Pnt;
  29 class TopoDS_Face;
  30
  31
  32 //! Implements the torus primitive
  33 class BRepPrim_Torus  : public BRepPrim_Revolution
  34 {
  35 public:
  36
  37   DEFINE_STANDARD_ALLOC
  38
  39
  40   //! the STEP definition
  41   //! Position : center and axes
  42   //! Major, Minor : Radii
  43   //!
  44   //! Errors : Major < Resolution
  45   //! Minor < Resolution
  46   Standard_EXPORT BRepPrim_Torus(const gp_Ax2& Position, const Standard_Real Major, const Standard_Real Minor);
  47
  48   //! Torus centered at origin
  49   Standard_EXPORT BRepPrim_Torus(const Standard_Real Major, const Standard_Real Minor);
  50
  51   //! Torus at Center
  52   Standard_EXPORT BRepPrim_Torus(const gp_Pnt& Center, const Standard_Real Major, const Standard_Real Minor);
  53
  54   //! The surface normal should be directed  towards the
  55   //! outside.
  56   Standard_EXPORT virtual TopoDS_Face MakeEmptyLateralFace() const Standard_OVERRIDE;
  57
  58
  59
  60
  61 protected:
  62
  63
  64
  65
  66
  67 private:
  68
  69
  70   Standard_EXPORT void SetMeridian();
  71
  72
  73   Standard_Real myMajor;
  74   Standard_Real myMinor;
  75
  76
  77 };
  78
  79
  80
  81
  82
  83
  84
  85 #endif // _BRepPrim_Torus_HeaderFile