[occt.git] / src / BRepPrimAPI / BRepPrimAPI_MakeHalfSpace.hxx

// Created on: 1995-03-08
// Created by: Bruno DUMORTIER
// Copyright (c) 1995-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _BRepPrimAPI_MakeHalfSpace_HeaderFile
#define _BRepPrimAPI_MakeHalfSpace_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>

#include <TopoDS_Solid.hxx>
#include <BRepBuilderAPI_MakeShape.hxx>
class StdFail_NotDone;
class TopoDS_Face;
class gp_Pnt;
class TopoDS_Shell;
class TopoDS_Solid;


//! Describes functions to build half-spaces.
//! A half-space is an infinite solid, limited by a surface. It
//! is built from a face or a shell, which bounds it, and with
//! a reference point, which specifies the side of the
//! surface where the matter of the half-space is located.
//! A half-space is a tool commonly used in topological
//! operations to cut another shape.
//! A MakeHalfSpace object provides a framework for:
//! -   defining and implementing the construction of a half-space, and
//! -   consulting the result.
class BRepPrimAPI_MakeHalfSpace  : public BRepBuilderAPI_MakeShape
{
public:

  DEFINE_STANDARD_ALLOC

  
  //! Make a HalfSpace defined with a Face and a Point.
  Standard_EXPORT BRepPrimAPI_MakeHalfSpace(const TopoDS_Face& Face, const gp_Pnt& RefPnt);
  
  //! Make a HalfSpace defined with a Shell and a Point.
  Standard_EXPORT BRepPrimAPI_MakeHalfSpace(const TopoDS_Shell& Shell, const gp_Pnt& RefPnt);
  
  //! Returns the constructed half-space as a solid.
  Standard_EXPORT const TopoDS_Solid& Solid() const;
Standard_EXPORT operator TopoDS_Solid() const;


protected:


private:


  TopoDS_Solid mySolid;


};


#endif // _BRepPrimAPI_MakeHalfSpace_HeaderFile
Commit	Line	Data
42cf5bc1	1	// Created on: 1995-03-08
	2	// Created by: Bruno DUMORTIER
	3	// Copyright (c) 1995-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_MakeHalfSpace_HeaderFile
	18	#define _BRepPrimAPI_MakeHalfSpace_HeaderFile
	19
	20	#include <Standard.hxx>
	21	#include <Standard_DefineAlloc.hxx>
	22	#include <Standard_Handle.hxx>
	23
	24	#include <TopoDS_Solid.hxx>
	25	#include <BRepBuilderAPI_MakeShape.hxx>
	26	class StdFail_NotDone;
	27	class TopoDS_Face;
	28	class gp_Pnt;
	29	class TopoDS_Shell;
	30	class TopoDS_Solid;
	31
	32
	33	//! Describes functions to build half-spaces.
	34	//! A half-space is an infinite solid, limited by a surface. It
	35	//! is built from a face or a shell, which bounds it, and with
	36	//! a reference point, which specifies the side of the
	37	//! surface where the matter of the half-space is located.
	38	//! A half-space is a tool commonly used in topological
	39	//! operations to cut another shape.
	40	//! A MakeHalfSpace object provides a framework for:
	41	//! - defining and implementing the construction of a half-space, and
	42	//! - consulting the result.
	43	class BRepPrimAPI_MakeHalfSpace : public BRepBuilderAPI_MakeShape
	44	{
	45	public:
	46
	47	DEFINE_STANDARD_ALLOC
	48
	49
	50	//! Make a HalfSpace defined with a Face and a Point.
	51	Standard_EXPORT BRepPrimAPI_MakeHalfSpace(const TopoDS_Face& Face, const gp_Pnt& RefPnt);
	52
	53	//! Make a HalfSpace defined with a Shell and a Point.
	54	Standard_EXPORT BRepPrimAPI_MakeHalfSpace(const TopoDS_Shell& Shell, const gp_Pnt& RefPnt);
	55
	56	//! Returns the constructed half-space as a solid.
	57	Standard_EXPORT const TopoDS_Solid& Solid() const;
	58	Standard_EXPORT operator TopoDS_Solid() const;
	59
	60
	61
	62
	63	protected:
	64
65
66
67
68
69	private:
70
71
72
73	TopoDS_Solid mySolid;
74
75
76	};
77
78
79
80
81
82
83
84	#endif // _BRepPrimAPI_MakeHalfSpace_HeaderFile