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