src/BRepPrimAPI/BRepPrimAPI_MakeHalfSpace.cdl

   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 class MakeHalfSpace from BRepPrimAPI  inherits MakeShape from BRepBuilderAPI
  18
  19         ---Purpose: Describes functions to build half-spaces.
  20         -- A half-space is an infinite solid, limited by a surface. It
  21         -- is built from a face or a shell, which bounds it, and with
  22         -- a reference point, which specifies the side of the
  23         -- surface where the matter of the half-space is located.
  24         -- A half-space is a tool commonly used in topological
  25         -- operations to cut another shape.
  26         -- A MakeHalfSpace object provides a framework for:
  27         -- -   defining and implementing the construction of a half-space, and
  28         -- -   consulting the result.
  29
  30 uses
  31     Shape      from TopoDS,
  32     Vertex     from TopoDS,
  33     Face       from TopoDS,
  34     Shell      from TopoDS,
  35     Solid      from TopoDS,
  36     Pnt        from gp,
  37     MakeShape from BRepBuilderAPI
  38
  39 raises
  40     NotDone from StdFail
  41 is
  42
  43     Create(Face   : Face from TopoDS;
  44            RefPnt : Pnt  from gp)
  45     returns MakeHalfSpace from BRepPrimAPI;
  46         ---Purpose: Make a HalfSpace defined with a Face and a Point.
  47         ---Level: Public
  48
  49     Create(Shell  : Shell from TopoDS;
  50            RefPnt : Pnt   from gp)
  51     returns MakeHalfSpace from BRepPrimAPI;
  52         ---Purpose: Make a HalfSpace defined with a Shell and a Point.
  53         ---Level: Public
  54
  55
  56     ----------------------------------------------
  57     -- Results
  58     ----------------------------------------------
  59
  60     Solid(me) returns Solid from TopoDS
  61         ---Purpose: Returns the constructed half-space as a solid.
  62         ---C++: return const &
  63         ---C++: alias "Standard_EXPORT operator TopoDS_Solid() const;"
  64     raises
  65         NotDone from StdFail
  66     is static;
  67
  68 fields
  69
  70     mySolid : Solid from TopoDS;
  71
  72 end MakeHalfSpace;