include/opencascade/BRepPrim_Cylinder.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_Cylinder_HeaderFile
0018 #define _BRepPrim_Cylinder_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 //! Cylinder primitive.
0030 class BRepPrim_Cylinder : public BRepPrim_Revolution
0031 {
0032 public:
0033   DEFINE_STANDARD_ALLOC
0034
0035   //! the STEP definition
0036   //! Position : center of a Face and Axis
0037   //! Radius : radius of cylinder
0038   //! Height : distance between faces
0039   //! on positive side
0040   //!
0041   //! Errors : Height < Resolution
0042   //! Radius < Resolution
0043   Standard_EXPORT BRepPrim_Cylinder(const gp_Ax2& Position,
0044                                     const double  Radius,
0045                                     const double  Height);
0046
0047   //! infinite Cylinder at origin on Z negative
0048   Standard_EXPORT BRepPrim_Cylinder(const double Radius);
0049
0050   //! infinite Cylinder at Center on Z negative
0051   Standard_EXPORT BRepPrim_Cylinder(const gp_Pnt& Center, const double Radius);
0052
0053   //! infinite Cylinder at Axes on Z negative
0054   Standard_EXPORT BRepPrim_Cylinder(const gp_Ax2& Axes, const double Radius);
0055
0056   //! create a Cylinder at origin on Z axis, of
0057   //! height H and radius R
0058   //! Error : Radius < Resolution
0059   //! H < Resolution
0060   //! H negative
0061   Standard_EXPORT BRepPrim_Cylinder(const double R, const double H);
0062
0063   //! same as above but at a given point
0064   Standard_EXPORT BRepPrim_Cylinder(const gp_Pnt& Center, const double R, const double H);
0065
0066   //! The surface normal should be directed towards the
0067   //! outside.
0068   Standard_EXPORT TopoDS_Face MakeEmptyLateralFace() const override;
0069
0070 private:
0071   Standard_EXPORT void SetMeridian();
0072
0073   double myRadius; //!< cylinder radius
0074 };
0075
0076 #endif // _BRepPrim_Cylinder_HeaderFile