include/opencascade/BRepPrim_Torus.hxx

0001 // Created on: 1992-11-05
0002 // Created by: Remi LEQUETTE
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 _BRepPrim_Torus_HeaderFile
0018 #define _BRepPrim_Torus_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <BRepPrim_Revolution.hxx>
0025 class gp_Ax2;
0026 class gp_Pnt;
0027 class TopoDS_Face;
0028
0029 //! Implements the torus primitive
0030 class BRepPrim_Torus : public BRepPrim_Revolution
0031 {
0032 public:
0033   DEFINE_STANDARD_ALLOC
0034
0035   //! the STEP definition
0036   //! Position : center and axes
0037   //! Major, Minor : Radii
0038   //!
0039   //! Errors : Major < Resolution
0040   //! Minor < Resolution
0041   Standard_EXPORT BRepPrim_Torus(const gp_Ax2&       Position,
0042                                  const Standard_Real Major,
0043                                  const Standard_Real Minor);
0044
0045   //! Torus centered at origin
0046   Standard_EXPORT BRepPrim_Torus(const Standard_Real Major, const Standard_Real Minor);
0047
0048   //! Torus at Center
0049   Standard_EXPORT BRepPrim_Torus(const gp_Pnt&       Center,
0050                                  const Standard_Real Major,
0051                                  const Standard_Real Minor);
0052
0053   //! The surface normal should be directed  towards the
0054   //! outside.
0055   Standard_EXPORT virtual TopoDS_Face MakeEmptyLateralFace() const Standard_OVERRIDE;
0056
0057 protected:
0058 private:
0059   Standard_EXPORT void SetMeridian();
0060
0061   Standard_Real myMajor; //!< distance from the center of the pipe to the center of the torus
0062   Standard_Real myMinor; //!< radius of the pipe
0063 };
0064
0065 #endif // _BRepPrim_Torus_HeaderFile