include/opencascade/BRepPrimAPI_MakeHalfSpace.hxx

0001 // Created on: 1995-03-08
0002 // Created by: Bruno DUMORTIER
0003 // Copyright (c) 1995-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_MakeHalfSpace_HeaderFile
0018 #define _BRepPrimAPI_MakeHalfSpace_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 #include <TopoDS_Solid.hxx>
0024 #include <BRepBuilderAPI_MakeShape.hxx>
0025 class TopoDS_Face;
0026 class gp_Pnt;
0027 class TopoDS_Shell;
0028
0029 //! Describes functions to build half-spaces.
0030 //! A half-space is an infinite solid, limited by a surface. It
0031 //! is built from a face or a shell, which bounds it, and with
0032 //! a reference point, which specifies the side of the
0033 //! surface where the matter of the half-space is located.
0034 //! A half-space is a tool commonly used in topological
0035 //! operations to cut another shape.
0036 //! A MakeHalfSpace object provides a framework for:
0037 //! -   defining and implementing the construction of a half-space, and
0038 //! -   consulting the result.
0039 class BRepPrimAPI_MakeHalfSpace : public BRepBuilderAPI_MakeShape
0040 {
0041 public:
0042   DEFINE_STANDARD_ALLOC
0043
0044   //! Make a HalfSpace defined with a Face and a Point.
0045   Standard_EXPORT BRepPrimAPI_MakeHalfSpace(const TopoDS_Face& Face, const gp_Pnt& RefPnt);
0046
0047   //! Make a HalfSpace defined with a Shell and a Point.
0048   Standard_EXPORT BRepPrimAPI_MakeHalfSpace(const TopoDS_Shell& Shell, const gp_Pnt& RefPnt);
0049
0050   //! Returns the constructed half-space as a solid.
0051   Standard_EXPORT const TopoDS_Solid& Solid() const;
0052   Standard_EXPORT                     operator TopoDS_Solid() const;
0053
0054 private:
0055   TopoDS_Solid mySolid;
0056 };
0057
0058 #endif // _BRepPrimAPI_MakeHalfSpace_HeaderFile