include/opencascade/BRepPrimAPI_MakeCylinder.hxx

0001 // Created on: 1993-07-21
0002 // Created by: Remi LEQUETTE
0003 // Copyright (c) 1993-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 _BRepPrimAPI_MakeCylinder_HeaderFile
0018 #define _BRepPrimAPI_MakeCylinder_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <BRepPrim_Cylinder.hxx>
0025 #include <BRepPrimAPI_MakeOneAxis.hxx>
0026 class gp_Ax2;
0027
0028 //! Describes functions to build cylinders or portions of cylinders.
0029 //! A MakeCylinder object provides a framework for:
0030 //! -   defining the construction of a cylinder,
0031 //! -   implementing the construction algorithm, and
0032 //! -   consulting the result.
0033 class BRepPrimAPI_MakeCylinder : public BRepPrimAPI_MakeOneAxis
0034 {
0035 public:
0036   DEFINE_STANDARD_ALLOC
0037
0038   //! Make a cylinder.
0039   //! @param[in] R  cylinder radius
0040   //! @param[in] H  cylinder height
0041   Standard_EXPORT BRepPrimAPI_MakeCylinder(const double R, const double H);
0042
0043   //! Make a cylinder (part cylinder).
0044   //! @param[in] R      cylinder radius
0045   //! @param[in] H      cylinder height
0046   //! @param[in] Angle  defines the missing portion of the cylinder
0047   Standard_EXPORT BRepPrimAPI_MakeCylinder(const double R, const double H, const double Angle);
0048
0049   //! Make a cylinder of radius R and length H.
0050   //! @param[in] Axes  coordinate system for the construction of the cylinder
0051   //! @param[in] R     cylinder radius
0052   //! @param[in] H     cylinder height
0053   Standard_EXPORT BRepPrimAPI_MakeCylinder(const gp_Ax2& Axes, const double R, const double H);
0054
0055   //! Make a cylinder of radius R and length H with
0056   //! angle H.
0057   //! Constructs
0058   //! -   a cylinder of radius R and height H, or
0059   //! -   a portion of cylinder of radius R and height H, and of
0060   //! the angle Angle defining the missing portion of the cylinder.
0061   //! The cylinder is constructed about the "Z Axis" of either:
0062   //! -   the global coordinate system, or
0063   //! -   the local coordinate system Axes.
0064   //! It is limited in this coordinate system as follows:
0065   //! -   in the v parametric direction (the Z axis), by the two
0066   //! parameter values 0 and H,
0067   //! -   and in the u parametric direction (the rotation angle
0068   //! around the Z Axis), in the case of a portion of a
0069   //! cylinder, by the two parameter values 0 and Angle.
0070   //! Angle is given in radians.
0071   //! The resulting shape is composed of:
0072   //! -   a lateral cylindrical face,
0073   //! -   two planar faces in the planes z = 0 and z = H
0074   //! (in the case of a complete cylinder, these faces are circles), and
0075   //! -   in case of a portion of a cylinder, two additional
0076   //! planar faces to close the shape.(two rectangles in the
0077   //! planes u = 0 and u = Angle).
0078   //! Exceptions Standard_DomainError if:
0079   //! -   R is less than or equal to Precision::Confusion(), or
0080   //! -   H is less than or equal to Precision::Confusion().
0081   Standard_EXPORT BRepPrimAPI_MakeCylinder(const gp_Ax2& Axes,
0082                                            const double  R,
0083                                            const double  H,
0084                                            const double  Angle);
0085
0086   //! Returns the algorithm.
0087   Standard_EXPORT void* OneAxis() override;
0088
0089   //! Returns the algorithm.
0090   Standard_EXPORT BRepPrim_Cylinder& Cylinder();
0091
0092 private:
0093   BRepPrim_Cylinder myCylinder;
0094 };
0095
0096 #endif // _BRepPrimAPI_MakeCylinder_HeaderFile