0024002: Overall code and build procedure refactoring -- automatic
[occt.git] / src / BRepPrimAPI / BRepPrimAPI_MakeBox.hxx
1 // Created on: 1993-07-21
2 // Created by: Remi LEQUETTE
3 // Copyright (c) 1993-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 _BRepPrimAPI_MakeBox_HeaderFile
18 #define _BRepPrimAPI_MakeBox_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <BRepPrim_Wedge.hxx>
25 #include <BRepBuilderAPI_MakeShape.hxx>
26 #include <Standard_Real.hxx>
27 class Standard_DomainError;
28 class Standard_OutOfRange;
29 class StdFail_NotDone;
30 class gp_Pnt;
31 class gp_Ax2;
32 class BRepPrim_Wedge;
33 class TopoDS_Shell;
34 class TopoDS_Solid;
35 class TopoDS_Face;
36
37
38 //! Describes functions to build parallelepiped boxes.
39 //! A MakeBox object provides a framework for:
40 //! -   defining the construction of a box,
41 //! -   implementing the construction algorithm, and
42 //! -   consulting the result.
43 class BRepPrimAPI_MakeBox  : public BRepBuilderAPI_MakeShape
44 {
45 public:
46
47   DEFINE_STANDARD_ALLOC
48
49   
50   //! Make a box with a corner at 0,0,0 and the other dx,dy,dz
51   Standard_EXPORT BRepPrimAPI_MakeBox(const Standard_Real dx, const Standard_Real dy, const Standard_Real dz);
52   
53   //! Make a box with a corner at P and size dx, dy, dz.
54   Standard_EXPORT BRepPrimAPI_MakeBox(const gp_Pnt& P, const Standard_Real dx, const Standard_Real dy, const Standard_Real dz);
55   
56   //! Make a box with corners P1,P2.
57   Standard_EXPORT BRepPrimAPI_MakeBox(const gp_Pnt& P1, const gp_Pnt& P2);
58   
59   //! Ax2 is the left corner and the axis.
60   //! Constructs a box such that its sides are parallel to the axes of
61   //! -   the global coordinate system, or
62   //! -   the local coordinate system Axis. and
63   //! -   with a corner at (0, 0, 0) and of size (dx, dy, dz), or
64   //! -   with a corner at point P and of size (dx, dy, dz), or
65   //! -   with corners at points P1 and P2.
66   //! Exceptions
67   //! Standard_DomainError if: dx, dy, dz are less than or equal to
68   //! Precision::Confusion(), or
69   //! -   the vector joining the points P1 and P2 has a
70   //! component projected onto the global coordinate
71   //! system less than or equal to Precision::Confusion().
72   //! In these cases, the box would be flat.
73   Standard_EXPORT BRepPrimAPI_MakeBox(const gp_Ax2& Axes, const Standard_Real dx, const Standard_Real dy, const Standard_Real dz);
74   
75   //! Returns the internal algorithm.
76   Standard_EXPORT BRepPrim_Wedge& Wedge();
77   
78   //! Stores the solid in myShape.
79   Standard_EXPORT virtual void Build() Standard_OVERRIDE;
80   
81   //! Returns the constructed box as a shell.
82   Standard_EXPORT const TopoDS_Shell& Shell();
83 Standard_EXPORT operator TopoDS_Shell();
84   
85   //! Returns the constructed box as a solid.
86   Standard_EXPORT const TopoDS_Solid& Solid();
87 Standard_EXPORT operator TopoDS_Solid();
88   
89   //! Returns ZMin face
90   Standard_EXPORT const TopoDS_Face& BottomFace();
91   
92   //! Returns XMin face
93   Standard_EXPORT const TopoDS_Face& BackFace();
94   
95   //! Returns XMax face
96   Standard_EXPORT const TopoDS_Face& FrontFace();
97   
98   //! Returns YMin face
99   Standard_EXPORT const TopoDS_Face& LeftFace();
100   
101   //! Returns YMax face
102   Standard_EXPORT const TopoDS_Face& RightFace();
103   
104   //! Returns ZMax face
105   Standard_EXPORT const TopoDS_Face& TopFace();
106
107
108
109
110 protected:
111
112
113
114
115
116 private:
117
118
119
120   BRepPrim_Wedge myWedge;
121
122
123 };
124
125
126
127
128
129
130
131 #endif // _BRepPrimAPI_MakeBox_HeaderFile