include/opencascade/BRepPrimAPI_MakeWedge.hxx

0001 // Created on: 1993-07-22
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_MakeWedge_HeaderFile
0018 #define _BRepPrimAPI_MakeWedge_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <BRepPrim_Wedge.hxx>
0025 #include <BRepBuilderAPI_MakeShape.hxx>
0026 class gp_Ax2;
0027 class TopoDS_Shell;
0028 class TopoDS_Solid;
0029
0030 //! Describes functions to build wedges, i.e. boxes with inclined faces.
0031 //! A MakeWedge object provides a framework for:
0032 //! -   defining the construction of a wedge,
0033 //! -   implementing the construction algorithm, and
0034 //! -   consulting the result.
0035 class BRepPrimAPI_MakeWedge : public BRepBuilderAPI_MakeShape
0036 {
0037 public:
0038   DEFINE_STANDARD_ALLOC
0039
0040   //! Make a STEP right angular wedge. (ltx >= 0)
0041   Standard_EXPORT BRepPrimAPI_MakeWedge(const Standard_Real dx,
0042                                         const Standard_Real dy,
0043                                         const Standard_Real dz,
0044                                         const Standard_Real ltx);
0045
0046   //! Make a STEP right angular wedge. (ltx >= 0)
0047   Standard_EXPORT BRepPrimAPI_MakeWedge(const gp_Ax2&       Axes,
0048                                         const Standard_Real dx,
0049                                         const Standard_Real dy,
0050                                         const Standard_Real dz,
0051                                         const Standard_Real ltx);
0052
0053   //! Make a wedge. The face at dy is xmin,zmin xmax,zmax
0054   Standard_EXPORT BRepPrimAPI_MakeWedge(const Standard_Real dx,
0055                                         const Standard_Real dy,
0056                                         const Standard_Real dz,
0057                                         const Standard_Real xmin,
0058                                         const Standard_Real zmin,
0059                                         const Standard_Real xmax,
0060                                         const Standard_Real zmax);
0061
0062   //! Make a wedge. The face at dy is xmin,zmin xmax,zmax
0063   Standard_EXPORT BRepPrimAPI_MakeWedge(const gp_Ax2&       Axes,
0064                                         const Standard_Real dx,
0065                                         const Standard_Real dy,
0066                                         const Standard_Real dz,
0067                                         const Standard_Real xmin,
0068                                         const Standard_Real zmin,
0069                                         const Standard_Real xmax,
0070                                         const Standard_Real zmax);
0071
0072   //! Returns the internal algorithm.
0073   Standard_EXPORT BRepPrim_Wedge& Wedge();
0074
0075   //! Stores the solid in myShape.
0076   Standard_EXPORT virtual void Build(
0077     const Message_ProgressRange& theRange = Message_ProgressRange()) Standard_OVERRIDE;
0078
0079   //! Returns the constructed box in the form of a shell.
0080   Standard_EXPORT const TopoDS_Shell& Shell();
0081   Standard_EXPORT                     operator TopoDS_Shell();
0082
0083   //! Returns the constructed box in the form of a solid.
0084   Standard_EXPORT const TopoDS_Solid& Solid();
0085   Standard_EXPORT                     operator TopoDS_Solid();
0086
0087 protected:
0088 private:
0089   BRepPrim_Wedge myWedge;
0090 };
0091
0092 #endif // _BRepPrimAPI_MakeWedge_HeaderFile