src/BRepPrim/BRepPrim_Cylinder.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_Cylinder_HeaderFile
  18 #define _BRepPrim_Cylinder_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 //! Cylinder primitive.
  33 class BRepPrim_Cylinder  : public BRepPrim_Revolution
  34 {
  35 public:
  36
  37   DEFINE_STANDARD_ALLOC
  38
  39
  40   //! the STEP definition
  41   //! Position : center of a Face and Axis
  42   //! Radius : radius of cylinder
  43   //! Height : distance between faces
  44   //! on positive side
  45   //!
  46   //! Errors : Height < Resolution
  47   //! Radius < Resolution
  48   Standard_EXPORT BRepPrim_Cylinder(const gp_Ax2& Position, const Standard_Real Radius, const Standard_Real Height);
  49
  50   //! infinite Cylinder at origin on Z negative
  51   Standard_EXPORT BRepPrim_Cylinder(const Standard_Real Radius);
  52
  53   //! infinite Cylinder at Center on Z negative
  54   Standard_EXPORT BRepPrim_Cylinder(const gp_Pnt& Center, const Standard_Real Radius);
  55
  56   //! infinite Cylinder at Axes on Z negative
  57   Standard_EXPORT BRepPrim_Cylinder(const gp_Ax2& Axes, const Standard_Real Radius);
  58
  59   //! create a Cylinder  at origin on Z  axis, of
  60   //! height H and radius R
  61   //! Error  : Radius  < Resolution
  62   //! H < Resolution
  63   //! H negative
  64   Standard_EXPORT BRepPrim_Cylinder(const Standard_Real R, const Standard_Real H);
  65
  66   //! same as above but at a given point
  67   Standard_EXPORT BRepPrim_Cylinder(const gp_Pnt& Center, const Standard_Real R, const Standard_Real H);
  68
  69   //! The surface normal should be directed  towards the
  70   //! outside.
  71   Standard_EXPORT virtual TopoDS_Face MakeEmptyLateralFace() const Standard_OVERRIDE;
  72
  73
  74
  75
  76 protected:
  77
  78
  79
  80
  81
  82 private:
  83
  84
  85   Standard_EXPORT void SetMeridian();
  86
  87
  88   Standard_Real myRadius;
  89
  90
  91 };
  92
  93
  94
  95
  96
  97
  98
  99 #endif // _BRepPrim_Cylinder_HeaderFile