summaryrefslogtreecommitdiff
path: root/inc/BRepPrimAPI_MakeCylinder.hxx
blob: f8ac559dd19068691830b4014e606fa5e11296d8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _BRepPrimAPI_MakeCylinder_HeaderFile
#define _BRepPrimAPI_MakeCylinder_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_Macro_HeaderFile
#include <Standard_Macro.hxx>
#endif

#ifndef _BRepPrim_Cylinder_HeaderFile
#include <BRepPrim_Cylinder.hxx>
#endif
#ifndef _BRepPrimAPI_MakeOneAxis_HeaderFile
#include <BRepPrimAPI_MakeOneAxis.hxx>
#endif
#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
#ifndef _Standard_Address_HeaderFile
#include <Standard_Address.hxx>
#endif
class Standard_DomainError;
class gp_Ax2;
class BRepPrim_Cylinder;


//! Describes functions to build cylinders or portions of  cylinders. <br>
//! A MakeCylinder object provides a framework for: <br>
//! -   defining the construction of a cylinder, <br>
//! -   implementing the construction algorithm, and <br>
//! -   consulting the result. <br>
class BRepPrimAPI_MakeCylinder  : public BRepPrimAPI_MakeOneAxis {
public:

  void* operator new(size_t,void* anAddress) 
  {
    return anAddress;
  }
  void* operator new(size_t size) 
  {
    return Standard::Allocate(size); 
  }
  void  operator delete(void *anAddress) 
  {
    if (anAddress) Standard::Free((Standard_Address&)anAddress); 
  }

  //! Make a cylinder of radius R and length H. <br>
  Standard_EXPORT   BRepPrimAPI_MakeCylinder(const Standard_Real R,const Standard_Real H);
  //! Make a cylinder   of  radius R  and  length H with <br>
//!          angle  H. <br>
  Standard_EXPORT   BRepPrimAPI_MakeCylinder(const Standard_Real R,const Standard_Real H,const Standard_Real Angle);
  //! Make a cylinder of radius R and length H. <br>
  Standard_EXPORT   BRepPrimAPI_MakeCylinder(const gp_Ax2& Axes,const Standard_Real R,const Standard_Real H);
  //! Make a cylinder   of  radius R  and  length H with <br>
//!          angle  H. <br>//! Constructs <br>
//! -   a cylinder of radius R and height H, or <br>
//! -   a portion of cylinder of radius R and height H, and of <br>
//!   the angle Angle defining the missing portion of the cylinder. <br>
//! The cylinder is constructed about the "Z Axis" of either: <br>
//! -   the global coordinate system, or <br>
//! -   the local coordinate system Axes. <br>
//! It is limited in this coordinate system as follows: <br>
//! -   in the v parametric direction (the Z axis), by the two <br>
//!   parameter values 0 and H, <br>
//! -   and in the u parametric direction (the rotation angle <br>
//!   around the Z Axis), in the case of a portion of a <br>
//!   cylinder, by the two parameter values 0 and Angle. <br>
//!   Angle is given in radians. <br>
//! The resulting shape is composed of: <br>
//! -   a lateral cylindrical face, <br>
//! -   two planar faces in the planes z = 0 and z = H <br>
//!   (in the case of a complete cylinder, these faces are circles), and <br>
//! -   in case of a portion of a cylinder, two additional <br>
//!   planar faces to close the shape.(two rectangles in the <br>
//!   planes u = 0 and u = Angle). <br>
//! Exceptions Standard_DomainError if: <br>
//! -   R is less than or equal to Precision::Confusion(), or <br>
//! -   H is less than or equal to Precision::Confusion(). <br>
  Standard_EXPORT   BRepPrimAPI_MakeCylinder(const gp_Ax2& Axes,const Standard_Real R,const Standard_Real H,const Standard_Real Angle);
  //! Returns the algorithm. <br>
  Standard_EXPORT     Standard_Address OneAxis() ;
  //! Returns the algorithm. <br>
//! <br>
  Standard_EXPORT     BRepPrim_Cylinder& Cylinder() ;





protected:





private:



BRepPrim_Cylinder myCylinder;


};





// other Inline functions and methods (like "C++: function call" methods)


#endif