summaryrefslogtreecommitdiff
path: root/inc/BRepPrimAPI_MakeTorus.hxx
blob: 82086468edfabf75d646241d22f40904407d34a2 (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
120
121
122
// 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_MakeTorus_HeaderFile
#define _BRepPrimAPI_MakeTorus_HeaderFile

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

#ifndef _BRepPrim_Torus_HeaderFile
#include <BRepPrim_Torus.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_Torus;


//! Describes functions to build tori or portions of tori. <br>
//! A MakeTorus object provides a framework for: <br>
//! -   defining the construction of a torus, <br>
//! -   implementing the construction algorithm, and <br>
//! -   consulting the result. <br>
class BRepPrimAPI_MakeTorus  : 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 torus of radii R1 R2. <br>
  Standard_EXPORT   BRepPrimAPI_MakeTorus(const Standard_Real R1,const Standard_Real R2);
  //! Make a section of a torus of radii R1 R2. <br>
  Standard_EXPORT   BRepPrimAPI_MakeTorus(const Standard_Real R1,const Standard_Real R2,const Standard_Real angle);
  //! Make  a torus of  radii R2, R2  with angles on the <br>
//!          small circle. <br>
  Standard_EXPORT   BRepPrimAPI_MakeTorus(const Standard_Real R1,const Standard_Real R2,const Standard_Real angle1,const Standard_Real angle2);
  //! Make  a torus of  radii R2, R2  with angles on the <br>
//!          small circle. <br>
  Standard_EXPORT   BRepPrimAPI_MakeTorus(const Standard_Real R1,const Standard_Real R2,const Standard_Real angle1,const Standard_Real angle2,const Standard_Real angle);
  //! Make a torus of radii R1 R2. <br>
  Standard_EXPORT   BRepPrimAPI_MakeTorus(const gp_Ax2& Axes,const Standard_Real R1,const Standard_Real R2);
  //! Make a section of a torus of radii R1 R2. <br>
  Standard_EXPORT   BRepPrimAPI_MakeTorus(const gp_Ax2& Axes,const Standard_Real R1,const Standard_Real R2,const Standard_Real angle);
  //! Make a torus of radii R1 R2. <br>
  Standard_EXPORT   BRepPrimAPI_MakeTorus(const gp_Ax2& Axes,const Standard_Real R1,const Standard_Real R2,const Standard_Real angle1,const Standard_Real angle2);
  //! Make a section of a torus of radii R1 R2. <br>//! For all algorithms The resulting shape is composed of <br>
//!   -      a lateral toroidal face, <br>
//!   -      two conical faces (defined  by the equation v = angle1 and <br>
//!      v = angle2) if the sphere is truncated in the v parametric <br>
//!      direction (they may be cylindrical faces in some <br>
//!      particular conditions), and in case of a portion <br>
//!      of torus, two planar faces to close the shape.(in the planes <br>
//!      u = 0 and u = angle). <br>
//! Notes: <br>
//!   -      The u parameter corresponds to a rotation angle around the Z axis. <br>
//!   -      The circle whose radius is equal to the minor radius, <br>
//!      located in the plane defined by the X axis and the Z axis, <br>
//!      centered on the X axis, on its positive side, and positioned <br>
//!      at a distance from the origin equal to the major radius, is <br>
//!      the reference circle of the torus. The rotation around an <br>
//!      axis parallel to the Y axis and passing through the center <br>
//!      of the reference circle gives the v parameter on the <br>
//!      reference circle. The X axis gives the origin of the v <br>
//! parameter. Near 0, as v increases, the Z coordinate decreases. <br>
  Standard_EXPORT   BRepPrimAPI_MakeTorus(const gp_Ax2& Axes,const Standard_Real R1,const Standard_Real R2,const Standard_Real angle1,const Standard_Real angle2,const Standard_Real angle);
  //! Returns the algorithm. <br>
  Standard_EXPORT     Standard_Address OneAxis() ;
  //! Returns the algorithm. <br>
//! <br>
  Standard_EXPORT     BRepPrim_Torus& Torus() ;





protected:





private:



BRepPrim_Torus myTorus;


};





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


#endif